Package org.testng

Interface ITestListener

All Superinterfaces:
ITestNGListener
All Known Subinterfaces:
IResultListener, IResultListener2
All Known Implementing Classes:
DotTestListener, ExitCodeListener, ExitCodeListener, JUnitXMLReporter, TestHTMLReporter, TestListenerAdapter, TextReporter, VerboseReporter
public interface ITestListener extends ITestNGListener
A listener for test running.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    onFinish(ITestContext context)
    Invoked after all the test methods belonging to the classes inside the <test> tag have run and all their Configuration methods have been called.
    default void
    onStart(ITestContext context)
    Invoked before running all the test methods belonging to the classes inside the <test> tag and calling all their Configuration methods.
    default void
    onTestFailedButWithinSuccessPercentage(ITestResult result)
    Invoked each time a method fails but has been annotated with successPercentage and this failure still keeps it within the success percentage requested.
    default void
    onTestFailedWithTimeout(ITestResult result)
    Invoked each time a test fails due to a timeout.
    default void
    onTestFailure(ITestResult result)
    Invoked each time a test fails.
    default void
    onTestSkipped(ITestResult result)
    Invoked each time a test is skipped.
    default void
    onTestStart(ITestResult result)
    Invoked each time before a test will be invoked.
    default void
    onTestSuccess(ITestResult result)
    Invoked each time a test succeeds.

  • Method Details

    • onTestStart

      default void onTestStart(ITestResult result)
      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.
      Parameters:
      result - the partially filled ITestResult
      See Also:

    • onTestSuccess

      default void onTestSuccess(ITestResult result)
      Invoked each time a test succeeds.
      Parameters:
      result - ITestResult containing information about the run test
      See Also:

    • onTestFailure

      default void onTestFailure(ITestResult result)
      Invoked each time a test fails.
      Parameters:
      result - ITestResult containing information about the run test
      See Also:

    • onTestSkipped

      default void onTestSkipped(ITestResult result)
      Invoked each time a test is skipped.
      Parameters:
      result - ITestResult containing information about the run test
      See Also:

    • onTestFailedButWithinSuccessPercentage

      default void onTestFailedButWithinSuccessPercentage(ITestResult result)
      Invoked each time a method fails but has been annotated with successPercentage and this failure still keeps it within the success percentage requested.
      Parameters:
      result - ITestResult containing information about the run test
      See Also:

    • onTestFailedWithTimeout

      default void onTestFailedWithTimeout(ITestResult result)
      Invoked each time a test fails due to a timeout.
      Parameters:
      result - ITestResult containing information about the run test

    • onStart

      default void onStart(ITestContext context)
      Invoked before running all the test methods belonging to the classes inside the <test> tag and calling all their Configuration methods.
      Parameters:
      context - The test context

    • onFinish

      default void onFinish(ITestContext context)
      Invoked after all the test methods belonging to the classes inside the <test> tag have run and all their Configuration methods have been called.
      Parameters:
      context - The test context