Package org.testng.reporters

Class VerboseReporter

java.lang.Object
org.testng.reporters.VerboseReporter
All Implemented Interfaces:
IConfigurationListener, ITestListener, ITestNGListener
public class VerboseReporter extends Object implements IConfigurationListener, ITestListener
Reporter printing out detailed messages about what TestNG is going to run and what is the status of what has been just run.

To see messages from this reporter, either run Ant in verbose mode ('ant -v') or set verbose level to 5 or higher

Since:
6.4

  • Field Details

    • LISTENER_PREFIX

      public static final String LISTENER_PREFIX
      Default prefix for messages printed out by this reporter
      See Also:

    • suiteName

      private String suiteName

    • prefix

      private final String prefix

  • Constructor Details

    • VerboseReporter

      public VerboseReporter(String prefix)
      Create VerboseReporter with custom prefix
      Parameters:
      prefix - prefix for messages printed out by this reporter

  • Method Details

    • beforeConfiguration

      public void beforeConfiguration(ITestResult tr)
      Description copied from interface: IConfigurationListener
      Invoked before a configuration method is invoked.
      Specified by:
      beforeConfiguration in interface IConfigurationListener
      Parameters:
      tr - The test result

    • onConfigurationFailure

      public void onConfigurationFailure(ITestResult tr)
      Description copied from interface: IConfigurationListener
      Invoked whenever a configuration method failed.
      Specified by:
      onConfigurationFailure in interface IConfigurationListener
      Parameters:
      tr - The test result

    • onConfigurationSkip

      public void onConfigurationSkip(ITestResult tr)
      Description copied from interface: IConfigurationListener
      Invoked whenever a configuration method was skipped.
      Specified by:
      onConfigurationSkip in interface IConfigurationListener
      Parameters:
      tr - The test result

    • onConfigurationSuccess

      public void onConfigurationSuccess(ITestResult tr)
      Description copied from interface: IConfigurationListener
      Invoked whenever a configuration method succeeded.
      Specified by:
      onConfigurationSuccess in interface IConfigurationListener
      Parameters:
      tr - The test result

    • onTestStart

      public void onTestStart(ITestResult tr)
      Description copied from interface: ITestListener
      Invoked each time before a test will be invoked. The ITestResult is only partially filled with the references to class, method, start millis and status.
      Specified by:
      onTestStart in interface ITestListener
      Parameters:
      tr - the partially filled ITestResult
      See Also:

    • onTestFailure

      public void onTestFailure(ITestResult tr)
      Description copied from interface: ITestListener
      Invoked each time a test fails.
      Specified by:
      onTestFailure in interface ITestListener
      Parameters:
      tr - ITestResult containing information about the run test
      See Also:

    • onTestFailedButWithinSuccessPercentage

      public void onTestFailedButWithinSuccessPercentage(ITestResult tr)
      Description copied from interface: ITestListener
      Invoked each time a method fails but has been annotated with successPercentage and this failure still keeps it within the success percentage requested.
      Specified by:
      onTestFailedButWithinSuccessPercentage in interface ITestListener
      Parameters:
      tr - ITestResult containing information about the run test
      See Also:

    • onTestSkipped

      public void onTestSkipped(ITestResult tr)
      Description copied from interface: ITestListener
      Invoked each time a test is skipped.
      Specified by:
      onTestSkipped in interface ITestListener
      Parameters:
      tr - ITestResult containing information about the run test
      See Also:

    • onTestSuccess

      public void onTestSuccess(ITestResult tr)
      Description copied from interface: ITestListener
      Invoked each time a test succeeds.
      Specified by:
      onTestSuccess in interface ITestListener
      Parameters:
      tr - ITestResult containing information about the run test
      See Also:

    • onStart

      public void onStart(ITestContext ctx)
      Description copied from interface: ITestListener
      Invoked before running all the test methods belonging to the classes inside the <test> tag and calling all their Configuration methods.
      Specified by:
      onStart in interface ITestListener
      Parameters:
      ctx - The test context

    • onFinish

      public void onFinish(ITestContext context)
      Description copied from interface: ITestListener
      Invoked after all the test methods belonging to the classes inside the <test> tag have run and all their Configuration methods have been called.
      Specified by:
      onFinish in interface ITestListener
      Parameters:
      context - The test context

    • resultsToMethods

      private ITestNGMethod[] resultsToMethods(Collection<ITestResult> results)

    • logResults

      private void logResults(ITestContext context)
      Print out test summary

    • logTestResult

      private void logTestResult(VerboseReporter.Status st, ITestResult itr, boolean isConfMethod)
      Log meaningful message for passed in arguments. Message itself is of form: $status: "$suiteName" - $methodDeclaration ($actualArguments) finished in $x ms ($run of $totalRuns)
      Parameters:
      st - status of passed in itr
      itr - test result to be described
      isConfMethod - is itr describing configuration method

    • log

      protected void log(String message)

    • getMethodDeclaration

      private String getMethodDeclaration(ITestNGMethod method, ITestResult tr)
      Parameters:
      method - method to be described
      Returns:
      FQN of a class + method declaration for a method passed in ie. test.triangle.CheckCount.testCheckCount(java.lang.String)

    • toString

      public String toString()
      Overrides:
      toString in class Object