Package org.testng

Class TestListenerAdapter

java.lang.Object

org.testng.TestListenerAdapter

All Implemented Interfaces:

IConfigurationListener, IResultListener, IResultListener2, ITestListener, ITestNGListener

public class TestListenerAdapter
extends Object
implements 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.

Field Summary

Fields

Modifier and Type	Field	Description
private Collection<ITestNGMethod>	m_allTestMethods
private Collection<ITestResult>	m_failedButWSPerTests
private final Collection<ITestResult>	m_failedConfs
private Collection<ITestResult>	m_failedTests
private final Collection<ITestResult>	m_passedConfs
private Collection<ITestResult>	m_passedTests
private final Collection<ITestResult>	m_skippedConfs
private Collection<ITestResult>	m_skippedTests
private final Collection<ITestContext>	m_testContexts
private final Collection<ITestResult>	m_timedOutTests

Constructor Summary

Constructors

Constructor	Description
TestListenerAdapter()

Method Summary

Modifier and Type	Method	Description
void	beforeConfiguration(ITestResult tr)	Invoked before a configuration method is invoked.
protected ITestNGMethod[]	getAllTestMethods()
List<ITestResult>	getConfigurationFailures()
List<ITestResult>	getConfigurationSkips()
List<ITestResult>	getFailedButWithinSuccessPercentageTests()
List<ITestResult>	getFailedTests()
List<ITestResult>	getPassedTests()
List<ITestResult>	getSkippedTests()
List<ITestContext>	getTestContexts()
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(List<ITestNGMethod> allTestMethods)
void	setFailedButWithinSuccessPercentageTests(List<ITestResult> failedButWithinSuccessPercentageTests)
void	setFailedTests(List<ITestResult> failedTests)
void	setPassedTests(List<ITestResult> passedTests)
void	setSkippedTests(List<ITestResult> skippedTests)
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

Field Details

m_allTestMethods

private Collection<ITestNGMethod> m_allTestMethods

m_passedTests

private Collection<ITestResult> m_passedTests

m_failedTests

private Collection<ITestResult> m_failedTests

m_skippedTests

private Collection<ITestResult> m_skippedTests

m_failedButWSPerTests

private Collection<ITestResult> m_failedButWSPerTests

m_testContexts

private final Collection<ITestContext> m_testContexts

m_failedConfs

private final Collection<ITestResult> m_failedConfs

m_skippedConfs

private final Collection<ITestResult> m_skippedConfs

m_passedConfs

private final Collection<ITestResult> m_passedConfs

m_timedOutTests

private final Collection<ITestResult> m_timedOutTests

Constructor Details

TestListenerAdapter

public TestListenerAdapter()

Method Details

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:

• ITestResult.SUCCESS

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:

• ITestResult.FAILURE

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:

• 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 interface ITestListener

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 interface ITestListener

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 interface ITestListener

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 interface ITestListener

Parameters:

testContext - The test context

getFailedButWithinSuccessPercentageTests

public List<ITestResult> getFailedButWithinSuccessPercentageTests()

Returns:

Returns the failedButWithinSuccessPercentageTests.

getFailedTests

public List<ITestResult> getFailedTests()

Returns:

Returns the failedTests.

getPassedTests

public List<ITestResult> getPassedTests()

Returns:

Returns the passedTests.

getSkippedTests

public List<ITestResult> getSkippedTests()

Returns:

Returns the skippedTests.

getTimedoutTests

public Collection<ITestResult> getTimedoutTests()

Returns:

Returns the tests that failed due to a timeout

setAllTestMethods

public void setAllTestMethods(List<ITestNGMethod> allTestMethods)

Parameters:

allTestMethods - The allTestMethods to set.

setFailedButWithinSuccessPercentageTests

public void setFailedButWithinSuccessPercentageTests(List<ITestResult> failedButWithinSuccessPercentageTests)

Parameters:

failedButWithinSuccessPercentageTests - The failedButWithinSuccessPercentageTests to set.

setFailedTests

public void setFailedTests(List<ITestResult> failedTests)

Parameters:

failedTests - The failedTests to set.

setPassedTests

public void setPassedTests(List<ITestResult> passedTests)

Parameters:

passedTests - The passedTests to set.

setSkippedTests

public void setSkippedTests(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. The ITestResult is only partially filled with the references to class, method, start millis and status.

Specified by:

onTestStart in interface ITestListener

Parameters:

result - the partially filled ITestResult

See Also:

• ITestResult.STARTED

getTestContexts

public List<ITestContext> getTestContexts()

getConfigurationFailures

public List<ITestResult> getConfigurationFailures()

onConfigurationFailure

public void onConfigurationFailure(ITestResult itr)

Description copied from interface: IConfigurationListener

Invoked whenever a configuration method failed.

Specified by:

onConfigurationFailure in interface IConfigurationListener

Parameters:

itr - The test result

See Also:

• IConfigurationListener.onConfigurationFailure(org.testng.ITestResult)

getConfigurationSkips

public 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 interface IConfigurationListener

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 interface IConfigurationListener

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 interface IConfigurationListener

Parameters:

itr - The test result

See Also:

• IConfigurationListener.onConfigurationSuccess(org.testng.ITestResult)

toString

public String toString()

Overrides:

toString in class Object