Package org.testng
Class TestListenerAdapter
- java.lang.Object
-
- org.testng.TestListenerAdapter
-
- All Implemented Interfaces:
IConfigurationListener
,org.testng.internal.IResultListener
,org.testng.internal.IResultListener2
,ITestListener
,ITestNGListener
public class TestListenerAdapter extends java.lang.Object implements org.testng.internal.IResultListener2
A simple ITestListener adapter that stores all the tests that were run. You can retrieve these results with the following methods: getPassedTests() getFailedTests() getSkippedTests()If you extend this class in order to override any of these methods, remember to call their super equivalent if you want this list of tests to be maintained.
-
-
Constructor Summary
Constructors Constructor Description TestListenerAdapter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
beforeConfiguration(ITestResult tr)
Invoked before a configuration method is invoked.protected ITestNGMethod[]
getAllTestMethods()
java.util.List<ITestResult>
getConfigurationFailures()
java.util.List<ITestResult>
getConfigurationSkips()
java.util.List<ITestResult>
getFailedButWithinSuccessPercentageTests()
java.util.List<ITestResult>
getFailedTests()
java.util.List<ITestResult>
getPassedTests()
java.util.List<ITestResult>
getSkippedTests()
java.util.List<ITestContext>
getTestContexts()
java.util.Collection<ITestResult>
getTimedoutTests()
void
onConfigurationFailure(ITestResult itr)
Invoked whenever a configuration method failed.void
onConfigurationSkip(ITestResult itr)
Invoked whenever a configuration method was skipped.void
onConfigurationSuccess(ITestResult itr)
Invoked whenever a configuration method succeeded.void
onFinish(ITestContext testContext)
Invoked after all the test methods belonging to the classes inside the <test> tag have run and all their Configuration methods have been called.void
onStart(ITestContext testContext)
Invoked before running all the test methods belonging to the classes inside the <test> tag and calling all their Configuration methods.void
onTestFailedButWithinSuccessPercentage(ITestResult tr)
Invoked each time a method fails but has been annotated with successPercentage and this failure still keeps it within the success percentage requested.void
onTestFailedWithTimeout(ITestResult tr)
Invoked each time a test fails due to a timeout.void
onTestFailure(ITestResult tr)
Invoked each time a test fails.void
onTestSkipped(ITestResult tr)
Invoked each time a test is skipped.void
onTestStart(ITestResult result)
Invoked each time before a test will be invoked.void
onTestSuccess(ITestResult tr)
Invoked each time a test succeeds.void
setAllTestMethods(java.util.List<ITestNGMethod> allTestMethods)
void
setFailedButWithinSuccessPercentageTests(java.util.List<ITestResult> failedButWithinSuccessPercentageTests)
void
setFailedTests(java.util.List<ITestResult> failedTests)
void
setPassedTests(java.util.List<ITestResult> passedTests)
void
setSkippedTests(java.util.List<ITestResult> skippedTests)
java.lang.String
toString()
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.testng.IConfigurationListener
beforeConfiguration, onConfigurationFailure, onConfigurationSkip, onConfigurationSuccess
-
-
-
-
Method Detail
-
onTestSuccess
public void onTestSuccess(ITestResult tr)
Description copied from interface:ITestListener
Invoked each time a test succeeds.- Specified by:
onTestSuccess
in interfaceITestListener
- Parameters:
tr
-ITestResult
containing information about the run test- See Also:
ITestResult.SUCCESS
-
onTestFailure
public void onTestFailure(ITestResult tr)
Description copied from interface:ITestListener
Invoked each time a test fails.- Specified by:
onTestFailure
in interfaceITestListener
- Parameters:
tr
-ITestResult
containing information about the run test- See Also:
ITestResult.FAILURE
-
onTestSkipped
public void onTestSkipped(ITestResult tr)
Description copied from interface:ITestListener
Invoked each time a test is skipped.- Specified by:
onTestSkipped
in interfaceITestListener
- Parameters:
tr
-ITestResult
containing information about the run test- See Also:
ITestResult.SKIP
-
onTestFailedWithTimeout
public void onTestFailedWithTimeout(ITestResult tr)
Description copied from interface:ITestListener
Invoked each time a test fails due to a timeout.- Specified by:
onTestFailedWithTimeout
in interfaceITestListener
- Parameters:
tr
-ITestResult
containing information about the run test
-
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 interfaceITestListener
- Parameters:
tr
-ITestResult
containing information about the run test- See Also:
ITestResult.SUCCESS_PERCENTAGE_FAILURE
-
getAllTestMethods
protected ITestNGMethod[] getAllTestMethods()
-
onStart
public void onStart(ITestContext testContext)
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 interfaceITestListener
- Parameters:
testContext
- The test context
-
onFinish
public void onFinish(ITestContext testContext)
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 interfaceITestListener
- Parameters:
testContext
- The test context
-
getFailedButWithinSuccessPercentageTests
public java.util.List<ITestResult> getFailedButWithinSuccessPercentageTests()
- Returns:
- Returns the failedButWithinSuccessPercentageTests.
-
getFailedTests
public java.util.List<ITestResult> getFailedTests()
- Returns:
- Returns the failedTests.
-
getPassedTests
public java.util.List<ITestResult> getPassedTests()
- Returns:
- Returns the passedTests.
-
getSkippedTests
public java.util.List<ITestResult> getSkippedTests()
- Returns:
- Returns the skippedTests.
-
getTimedoutTests
public java.util.Collection<ITestResult> getTimedoutTests()
- Returns:
- Returns the tests that failed due to a timeout
-
setAllTestMethods
public void setAllTestMethods(java.util.List<ITestNGMethod> allTestMethods)
- Parameters:
allTestMethods
- The allTestMethods to set.
-
setFailedButWithinSuccessPercentageTests
public void setFailedButWithinSuccessPercentageTests(java.util.List<ITestResult> failedButWithinSuccessPercentageTests)
- Parameters:
failedButWithinSuccessPercentageTests
- The failedButWithinSuccessPercentageTests to set.
-
setFailedTests
public void setFailedTests(java.util.List<ITestResult> failedTests)
- Parameters:
failedTests
- The failedTests to set.
-
setPassedTests
public void setPassedTests(java.util.List<ITestResult> passedTests)
- Parameters:
passedTests
- The passedTests to set.
-
setSkippedTests
public void setSkippedTests(java.util.List<ITestResult> skippedTests)
- Parameters:
skippedTests
- The skippedTests to set.
-
onTestStart
public void onTestStart(ITestResult result)
Description copied from interface:ITestListener
Invoked each time before a test will be invoked. TheITestResult
is only partially filled with the references to class, method, start millis and status.- Specified by:
onTestStart
in interfaceITestListener
- Parameters:
result
- the partially filledITestResult
- See Also:
ITestResult.STARTED
-
getTestContexts
public java.util.List<ITestContext> getTestContexts()
-
getConfigurationFailures
public java.util.List<ITestResult> getConfigurationFailures()
-
onConfigurationFailure
public void onConfigurationFailure(ITestResult itr)
Description copied from interface:IConfigurationListener
Invoked whenever a configuration method failed.- Specified by:
onConfigurationFailure
in interfaceIConfigurationListener
- Parameters:
itr
- The test result- See Also:
IConfigurationListener.onConfigurationFailure(org.testng.ITestResult)
-
getConfigurationSkips
public java.util.List<ITestResult> getConfigurationSkips()
-
beforeConfiguration
public void beforeConfiguration(ITestResult tr)
Description copied from interface:IConfigurationListener
Invoked before a configuration method is invoked.- Specified by:
beforeConfiguration
in interfaceIConfigurationListener
- Parameters:
tr
- The test result
-
onConfigurationSkip
public void onConfigurationSkip(ITestResult itr)
Description copied from interface:IConfigurationListener
Invoked whenever a configuration method was skipped.- Specified by:
onConfigurationSkip
in interfaceIConfigurationListener
- Parameters:
itr
- The test result- See Also:
IConfigurationListener.onConfigurationSkip(org.testng.ITestResult)
-
onConfigurationSuccess
public void onConfigurationSuccess(ITestResult itr)
Description copied from interface:IConfigurationListener
Invoked whenever a configuration method succeeded.- Specified by:
onConfigurationSuccess
in interfaceIConfigurationListener
- Parameters:
itr
- The test result- See Also:
IConfigurationListener.onConfigurationSuccess(org.testng.ITestResult)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-