Package org.apache.maven.surefire.testng

Class TestNGReporter

java.lang.Object
org.apache.maven.surefire.testng.TestNGReporter
All Implemented Interfaces:
TestOutputReceiver<OutputReportEntry>, RunModeSetter, org.testng.ISuiteListener, org.testng.ITestListener, org.testng.ITestNGListener
Direct Known Subclasses:
ConfigurationAwareTestNGReporter
public class TestNGReporter extends Object implements TestOutputReceiver<OutputReportEntry>, org.testng.ITestListener, org.testng.ISuiteListener, RunModeSetter
Listens for and provides and adaptor layer so that TestNG tests can report their status to the current RunListener.

  • Field Details

  • Constructor Details

    • TestNGReporter

      public TestNGReporter(TestReportListener<TestOutputReportEntry> reportManager)
      Constructs a new instance that will listen to test updates from a TestNG class instance.

      It is assumed that the requisite TestNG.addListener(ITestListener) method call has already associated with this instance before the test suite is run.
      Parameters:
      reportManager - Instance to report suite status to

  • Method Details

    • getRunListener

      protected final RunListener getRunListener()

    • onTestStart

      public void onTestStart(org.testng.ITestResult result)
      Specified by:
      onTestStart in interface org.testng.ITestListener

    • onTestSuccess

      public void onTestSuccess(org.testng.ITestResult result)
      Specified by:
      onTestSuccess in interface org.testng.ITestListener

    • onTestFailure

      public void onTestFailure(org.testng.ITestResult result)
      Specified by:
      onTestFailure in interface org.testng.ITestListener

    • onTestSkipped

      public void onTestSkipped(org.testng.ITestResult result)
      Specified by:
      onTestSkipped in interface org.testng.ITestListener

    • onTestFailedButWithinSuccessPercentage

      public void onTestFailedButWithinSuccessPercentage(org.testng.ITestResult result)
      Specified by:
      onTestFailedButWithinSuccessPercentage in interface org.testng.ITestListener

    • onStart

      public void onStart(org.testng.ITestContext context)
      Specified by:
      onStart in interface org.testng.ITestListener

    • onFinish

      public void onFinish(org.testng.ITestContext context)
      Specified by:
      onFinish in interface org.testng.ITestListener

    • onStart

      public void onStart(org.testng.ISuite suite)
      Specified by:
      onStart in interface org.testng.ISuiteListener

    • onFinish

      public void onFinish(org.testng.ISuite suite)
      Specified by:
      onFinish in interface org.testng.ISuiteListener

    • groupString

      private static String groupString(String[] groups, String defaultValue)
      Creates a string out of the list of testng groups in the form of 
      "group1,group2,group3"
      .
      Parameters:
      groups - The groups being run
      defaultValue - The default to use if no groups
      Returns:
      a string describing the groups

    • onConfigurationFailure

      public void onConfigurationFailure(org.testng.ITestResult result)

    • onConfigurationSkip

      public void onConfigurationSkip(org.testng.ITestResult result)

    • onConfigurationSuccess

      public void onConfigurationSuccess(org.testng.ITestResult result)

    • testName

      private static String testName(org.testng.ITestResult result)
      Acquire a better representation of the test name that includes parameters and the invocation count, if there are any parameters
      Parameters:
      result - the test result to extract from
      Returns:
      a descriptive name for the test

    • setRunMode

      public void setRunMode(RunMode runMode)
      Specified by:
      setRunMode in interface RunModeSetter

    • writeTestOutput

      public void writeTestOutput(OutputReportEntry reportEntry)
      Description copied from interface: TestOutputReceiver
      Forwards process output from the running test-case into the reporting system
      Specified by:
      writeTestOutput in interface TestOutputReceiver<OutputReportEntry>
      Parameters:
      reportEntry - wraps test output with descriptive information of the output