Package org.testng

Class TestRunner

java.lang.Object

org.testng.TestRunner

All Implemented Interfaces:

IAttributes, IConfigEavesdropper, ITestResultNotifier, ITestContext, IThreadWorkerFactory<ITestNGMethod>

public class TestRunner
extends Object
implements ITestContext, ITestResultNotifier, IThreadWorkerFactory<ITestNGMethod>, IConfigEavesdropper

This class takes care of running one Test.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	TestRunner.ConfigurationListener
static enum	TestRunner.PriorityWeight

Field Summary

Fields

Modifier and Type	Field	Description
private final Comparator<ITestNGMethod>	comparator
private static final String	DEFAULT_PROP_OUTPUT_DIR
private ITestListener	exitCodeListener
private final DataProviderHolder	holder
private static final Logger	LOGGER
private ITestNGMethod[]	m_afterSuiteMethods
private ITestNGMethod[]	m_afterXmlTestMethods
private ITestNGMethod[]	m_allJunitTestMethods
private IAnnotationFinder	m_annotationFinder
private final IAttributes	m_attributes
private ITestNGMethod[]	m_beforeSuiteMethods
private ITestNGMethod[]	m_beforeXmlTestMethods
private final Map<Class<? extends IClassListener>,IClassListener>	m_classListeners
private final Map<Class<?>,ITestClass>	m_classMap	A map to keep track of Class invalid input: '<'-> IClass.
private ClassMethodMap	m_classMethodMap
private final IResultMap	m_configsToBeInvoked
private IConfiguration	m_configuration
private final Set<IConfigurationListener>	m_configurationListeners
private final IConfigurationListener	m_confListener
private Date	m_endDate
private final List<ITestNGMethod>	m_excludedMethods
private final IResultMap	m_failedButWithinSuccessPercentageTests
private final IResultMap	m_failedConfigurations
private final IResultMap	m_failedTests
private ConfigurationGroupMethods	m_groupMethods
private String	m_host
private IInjectorFactory	m_injectorFactory
private Collection<IInvokedMethodListener>	m_invokedMethodListeners
private IInvoker	m_invoker
private final Map<String,List<String>>	m_metaGroups
private List<IMethodInterceptor>	m_methodInterceptors
private ITestObjectFactory	m_objectFactory
private String	m_outputDirectory	Where the reports will be created.
private final IResultMap	m_passedConfigurations
private final IResultMap	m_passedTests
private final RunInfo	m_runInfo
private final IResultMap	m_skippedConfigurations
private final IResultMap	m_skippedTests
private Date	m_startDate
private ISuite	m_suite
private List<XmlClass>	m_testClassesFromXml
private TestNGClassFinder	m_testClassFinder
private final List<ITestListener>	m_testListeners	ITestListeners support.
private String	m_testName
private final XmlMethodSelector	m_xmlMethodSelector
private XmlTest	m_xmlTest
private final IContainer<ITestNGMethod>	testMethodsContainer
private final Set<IExecutionVisualiser>	visualisers
private static final AtomicBoolean	warnOnce

Constructor Summary

Constructors

Modifier	Constructor	Description
	TestRunner(IConfiguration configuration, ISuite suite, XmlTest test, boolean skipFailedInvocationCounts, Collection<IInvokedMethodListener> invokedMethodListeners, List<IClassListener> classListeners, Comparator<ITestNGMethod> comparator, SuiteRunner suiteRunner)
	TestRunner(IConfiguration configuration, ISuite suite, XmlTest test, boolean skipFailedInvocationCounts, Collection<IInvokedMethodListener> invokedMethodListeners, List<IClassListener> classListeners, SuiteRunner suiteRunner)
protected	TestRunner(IConfiguration configuration, ISuite suite, XmlTest test, String outputDirectory, IAnnotationFinder finder, boolean skipFailedInvocationCounts, Collection<IInvokedMethodListener> invokedMethodListeners, List<IClassListener> classListeners, Comparator<ITestNGMethod> comparator, DataProviderHolder otherHolder, SuiteRunner suiteRunner)

Method Summary

Modifier and Type	Method	Description
(package private) void	addConfigurationListener(IConfigurationListener icl)
void	addFailedButWithinSuccessPercentageTest(ITestNGMethod testMethod, ITestResult result)
void	addFailedTest(ITestNGMethod testMethod, ITestResult result)
void	addListener(ITestNGListener listener)
private void	addMetaGroup(String name, List<String> groupNames)
(package private) void	addMethodInterceptor(IMethodInterceptor methodInterceptor)
void	addPassedTest(ITestNGMethod tm, ITestResult tr)
void	addSkippedTest(ITestNGMethod tm, ITestResult tr)
(package private) void	addTestListener(ITestListener listener)
private void	afterRun()
private void	beforeRun()	Before run preparements.
private ITestNGMethod[]	computeAndGetAllTestMethods()
private Map<String,String>	createGroups(List<String> groups)
List<IWorker<ITestNGMethod>>	createWorkers(List<ITestNGMethod> methods)	Create a list of workers to run the methods passed in parameter.
private void	dumpInvokedMethods()
private void	fireEvent(boolean isStart)	Trigger the start/finish event.
private void	forgetHeavyReferencesIfNeeded()
ITestNGMethod[]	getAfterSuiteMethods()
ITestNGMethod[]	getAfterTestConfigurationMethods()
private List<XmlPackage>	getAllPackages()	Returns all packages to use for the current test.
ITestNGMethod[]	getAllTestMethods()
Object	getAttribute(String name)
Set<String>	getAttributeNames()
ITestNGMethod[]	getBeforeSuiteMethods()
ITestNGMethod[]	getBeforeTestConfigurationMethods()
List<IConfigurationListener>	getConfigurationListeners()
IResultMap	getConfigurationsScheduledForInvocation()
XmlTest	getCurrentXmlTest()
Date	getEndDate()
String[]	getExcludedGroups()
Collection<ITestNGMethod>	getExcludedMethods()
ITestListener	getExitCodeListener()
IResultMap	getFailedButWithinSuccessPercentageTests()
IResultMap	getFailedConfigurations()
IResultMap	getFailedTests()
Set<ITestResult>	getFailedTests(ITestNGMethod tm)
String	getHost()
String[]	getIncludedGroups()
IInjectorFactory	getInjectorFactory()
IInvoker	getInvoker()
String	getName()
String	getOutputDirectory()
IResultMap	getPassedConfigurations()
IResultMap	getPassedTests()
Set<ITestResult>	getPassedTests(ITestNGMethod tm)
IResultMap	getSkippedConfigurations()
IResultMap	getSkippedTests()
Set<ITestResult>	getSkippedTests(ITestNGMethod tm)
Date	getStartDate()
ISuite	getSuite()
XmlTest	getTest()
Collection<ITestClass>	getTestClasses()
List<ITestListener>	getTestListeners()
static int	getVerbose()
private void	init()
private void	init(IConfiguration configuration, ISuite suite, XmlTest test, String outputDirectory, IAnnotationFinder annotationFinder, boolean skipFailedInvocationCounts, Collection<IInvokedMethodListener> invokedMethodListeners, List<IClassListener> classListeners, SuiteRunner suiteRunner)
private void	initListeners()
private void	initMetaGroups(XmlTest xmlTest)	Initialize meta groups
private void	initMethods()
private void	initRunInfo(XmlTest xmlTest)
private ITestNGMethod[]	intercept(ITestNGMethod[] methods)	Apply the method interceptor (if applicable) to the list of methods.
private void	invokeTestConfigurations(ITestNGMethod[] testConfigurationMethods)
private static void	log(String s)
private void	logFailedTest(ITestResult tr, boolean withinSuccessPercentage)
private void	logStart()	Logs the beginning of the beforeRun() .
private static Stream<Method>	methods(Stream<ITestNGMethod> methods)
private static Stream<Method>	methods(IResultMap resultMap)
private static Comparator<ITestNGMethod>	newComparator(boolean needPrioritySort)
private static BlockingQueue<Runnable>	newQueue(boolean needPrioritySort)
private void	privateRun(XmlTest xmlTest)	Main method that create a graph of methods and then pass it to the graph executor to run them.
private void	privateRunJUnit()
Object	removeAttribute(String name)	Remove the attribute
void	run()	The main entry method for TestRunner.
private void	runJUnitWorkers(List<? extends IWorker<ITestNGMethod>> workers)
void	setAttribute(String name, Object value)	Set a custom attribute.
private void	setExitCodeListener(ITestListener exitCodeListener)
void	setOutputDirectory(String od)
void	setTestName(String name)
void	setVerbose(int n)
private boolean	sortOnPriority(ITestNGMethod[] interceptedOrder)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_PROP_OUTPUT_DIR

private static final String DEFAULT_PROP_OUTPUT_DIR

See Also:

• Constant Field Values

LOGGER

private static final Logger LOGGER

comparator

private final Comparator<ITestNGMethod> comparator

m_suite

private ISuite m_suite

m_xmlTest

private XmlTest m_xmlTest

m_testName

private String m_testName

m_injectorFactory

private IInjectorFactory m_injectorFactory

m_objectFactory

private ITestObjectFactory m_objectFactory

m_testClassesFromXml

private List<XmlClass> m_testClassesFromXml

m_invoker

private IInvoker m_invoker

m_annotationFinder

private IAnnotationFinder m_annotationFinder

m_testListeners

private final List<ITestListener> m_testListeners

ITestListeners support.

m_configurationListeners

private final Set<IConfigurationListener> m_configurationListeners

visualisers

private final Set<IExecutionVisualiser> visualisers

m_confListener

private final IConfigurationListener m_confListener

m_invokedMethodListeners

private Collection<IInvokedMethodListener> m_invokedMethodListeners

m_classListeners

private final Map<Class<? extends IClassListener>,IClassListener> m_classListeners

holder

private final DataProviderHolder holder

m_startDate

private Date m_startDate

m_endDate

private Date m_endDate

testMethodsContainer

private final IContainer<ITestNGMethod> testMethodsContainer

m_classMap

private final Map<Class<?>,ITestClass> m_classMap

A map to keep track of Class invalid input: '<'-> IClass.

m_outputDirectory

private String m_outputDirectory

Where the reports will be created.

m_xmlMethodSelector

private final XmlMethodSelector m_xmlMethodSelector

exitCodeListener

private ITestListener exitCodeListener

m_beforeSuiteMethods

private ITestNGMethod[] m_beforeSuiteMethods

m_afterSuiteMethods

private ITestNGMethod[] m_afterSuiteMethods

m_beforeXmlTestMethods

private ITestNGMethod[] m_beforeXmlTestMethods

m_afterXmlTestMethods

private ITestNGMethod[] m_afterXmlTestMethods

m_excludedMethods

private final List<ITestNGMethod> m_excludedMethods

m_groupMethods

private ConfigurationGroupMethods m_groupMethods

m_metaGroups

private final Map<String,List<String>> m_metaGroups

m_passedTests

private final IResultMap m_passedTests

m_failedTests

private final IResultMap m_failedTests

m_failedButWithinSuccessPercentageTests

private final IResultMap m_failedButWithinSuccessPercentageTests

m_skippedTests

private final IResultMap m_skippedTests

m_runInfo

private final RunInfo m_runInfo

m_host

private String m_host

m_methodInterceptors

private List<IMethodInterceptor> m_methodInterceptors

m_classMethodMap

private ClassMethodMap m_classMethodMap

m_testClassFinder

private TestNGClassFinder m_testClassFinder

m_configuration

private IConfiguration m_configuration

m_allJunitTestMethods

private ITestNGMethod[] m_allJunitTestMethods

warnOnce

private static final AtomicBoolean warnOnce

m_passedConfigurations

private final IResultMap m_passedConfigurations

m_skippedConfigurations

private final IResultMap m_skippedConfigurations

m_failedConfigurations

private final IResultMap m_failedConfigurations

m_configsToBeInvoked

private final IResultMap m_configsToBeInvoked

m_attributes

private final IAttributes m_attributes

Constructor Details

TestRunner

protected TestRunner(IConfiguration configuration,
 ISuite suite,
 XmlTest test,
 String outputDirectory,
 IAnnotationFinder finder,
 boolean skipFailedInvocationCounts,
 Collection<IInvokedMethodListener> invokedMethodListeners,
 List<IClassListener> classListeners,
 Comparator<ITestNGMethod> comparator,
 DataProviderHolder otherHolder,
 SuiteRunner suiteRunner)

TestRunner

public TestRunner(IConfiguration configuration,
 ISuite suite,
 XmlTest test,
 boolean skipFailedInvocationCounts,
 Collection<IInvokedMethodListener> invokedMethodListeners,
 List<IClassListener> classListeners,
 Comparator<ITestNGMethod> comparator,
 SuiteRunner suiteRunner)

TestRunner

public TestRunner(IConfiguration configuration,
 ISuite suite,
 XmlTest test,
 boolean skipFailedInvocationCounts,
 Collection<IInvokedMethodListener> invokedMethodListeners,
 List<IClassListener> classListeners,
 SuiteRunner suiteRunner)

Method Details

init

private void init(IConfiguration configuration,
 ISuite suite,
 XmlTest test,
 String outputDirectory,
 IAnnotationFinder annotationFinder,
 boolean skipFailedInvocationCounts,
 Collection<IInvokedMethodListener> invokedMethodListeners,
 List<IClassListener> classListeners,
 SuiteRunner suiteRunner)

getAllPackages

private List<XmlPackage> getAllPackages()

Returns all packages to use for the current test. This includes the test from the test suite. Never returns null.

getInvoker

public IInvoker getInvoker()

getBeforeSuiteMethods

public ITestNGMethod[] getBeforeSuiteMethods()

getAfterSuiteMethods

public ITestNGMethod[] getAfterSuiteMethods()

getBeforeTestConfigurationMethods

public ITestNGMethod[] getBeforeTestConfigurationMethods()

getAfterTestConfigurationMethods

public ITestNGMethod[] getAfterTestConfigurationMethods()

init

private void init()

initListeners

private void initListeners()

initMetaGroups

private void initMetaGroups(XmlTest xmlTest)

Initialize meta groups

initRunInfo

private void initRunInfo(XmlTest xmlTest)

initMethods

private void initMethods()

computeAndGetAllTestMethods

private ITestNGMethod[] computeAndGetAllTestMethods()

getTestClasses

public Collection<ITestClass> getTestClasses()

setTestName

public void setTestName(String name)

setOutputDirectory

public void setOutputDirectory(String od)

addMetaGroup

private void addMetaGroup(String name,
 List<String> groupNames)

createGroups

private Map<String,String> createGroups(List<String> groups)

run

public void run()

The main entry method for TestRunner.

This is where all the hard work is done: - Invoke configuration methods - Invoke test methods - Catch exceptions - Collect results - Invoke listeners - etc...

forgetHeavyReferencesIfNeeded

private void forgetHeavyReferencesIfNeeded()

beforeRun

private void beforeRun()

Before run preparements.

invokeTestConfigurations

private void invokeTestConfigurations(ITestNGMethod[] testConfigurationMethods)

privateRunJUnit

private void privateRunJUnit()

newComparator

private static Comparator<ITestNGMethod> newComparator(boolean needPrioritySort)

sortOnPriority

private boolean sortOnPriority(ITestNGMethod[] interceptedOrder)

newQueue

private static BlockingQueue<Runnable> newQueue(boolean needPrioritySort)

privateRun

private void privateRun(XmlTest xmlTest)

Main method that create a graph of methods and then pass it to the graph executor to run them.

intercept

private ITestNGMethod[] intercept(ITestNGMethod[] methods)

Apply the method interceptor (if applicable) to the list of methods.

createWorkers

public List<IWorker<ITestNGMethod>> createWorkers(List<ITestNGMethod> methods)

Create a list of workers to run the methods passed in parameter. Each test method is run in its own worker except in the following cases: - The method belongs to a class that has @Test(sequential=true) - The parallel attribute is set to "classes" In both these cases, all the methods belonging to that class will then be put in the same worker in order to run in the same thread.

Specified by:

createWorkers in interface IThreadWorkerFactory<ITestNGMethod>

Parameters:

methods - tasks that need to be executed

Returns:

list of workers

runJUnitWorkers

private void runJUnitWorkers(List<? extends IWorker<ITestNGMethod>> workers)

afterRun

private void afterRun()

logStart

private void logStart()

Logs the beginning of the beforeRun() .

fireEvent

private void fireEvent(boolean isStart)

Trigger the start/finish event.

Parameters:

isStart - true if the event is for start, false if the event is for finish

methods

private static Stream<Method> methods(IResultMap resultMap)

methods

private static Stream<Method> methods(Stream<ITestNGMethod> methods)

getName

public String getName()

Specified by:

getName in interface ITestContext

Returns:

The name of this test.

getStartDate

public Date getStartDate()

Specified by:

getStartDate in interface ITestContext

Returns:

Returns the startDate.

getEndDate

public Date getEndDate()

Specified by:

getEndDate in interface ITestContext

Returns:

Returns the endDate.

getPassedTests

public IResultMap getPassedTests()

Specified by:

getPassedTests in interface ITestContext

Returns:

A list of all the tests that run successfully.

getSkippedTests

public IResultMap getSkippedTests()

Specified by:

getSkippedTests in interface ITestContext

Returns:

A list of all the tests that were skipped

getFailedTests

public IResultMap getFailedTests()

Specified by:

getFailedTests in interface ITestContext

Returns:

A map of all the tests that failed, indexed by their ITestNGMethod.

See Also:

• ITestNGMethod

getFailedButWithinSuccessPercentageTests

public IResultMap getFailedButWithinSuccessPercentageTests()

Specified by:

getFailedButWithinSuccessPercentageTests in interface ITestContext

Returns:

A list of all the tests that failed but are being ignored because annotated with a successPercentage.

getIncludedGroups

public String[] getIncludedGroups()

Specified by:

getIncludedGroups in interface ITestContext

Returns:

All the groups that are included for this test run.

getExcludedGroups

public String[] getExcludedGroups()

Specified by:

getExcludedGroups in interface ITestContext

Returns:

All the groups that are excluded for this test run.

getOutputDirectory

public String getOutputDirectory()

Specified by:

getOutputDirectory in interface ITestContext

Returns:

Where the reports will be generated.

getSuite

public ISuite getSuite()

Specified by:

getSuite in interface ITestContext

Returns:

Returns the suite.

getAllTestMethods

public ITestNGMethod[] getAllTestMethods()

Specified by:

getAllTestMethods in interface ITestContext

Returns:

All the test methods that were run.

getHost

public String getHost()

Specified by:

getHost in interface ITestContext

Returns:

The host where this test was run, or null if it was run locally. The returned string has the form: host:port

getExcludedMethods

public Collection<ITestNGMethod> getExcludedMethods()

Specified by:

getExcludedMethods in interface ITestContext

Returns:

All the methods that were not included in this test run.

getFailedConfigurations

public IResultMap getFailedConfigurations()

Specified by:

getFailedConfigurations in interface ITestContext

Returns:

The information about the failed configuration method invocations.

See Also:

• ITestContext.getFailedConfigurations()

getConfigurationsScheduledForInvocation

public IResultMap getConfigurationsScheduledForInvocation()

Specified by:

getConfigurationsScheduledForInvocation in interface IConfigEavesdropper

getPassedConfigurations

public IResultMap getPassedConfigurations()

Specified by:

getPassedConfigurations in interface ITestContext

Returns:

The information about the successful configuration method invocations.

See Also:

• ITestContext.getPassedConfigurations()

getSkippedConfigurations

public IResultMap getSkippedConfigurations()

Specified by:

getSkippedConfigurations in interface ITestContext

Returns:

The information about the skipped configuration method invocations.

See Also:

• ITestContext.getSkippedConfigurations()

addPassedTest

public void addPassedTest(ITestNGMethod tm,
 ITestResult tr)

Specified by:

addPassedTest in interface ITestResultNotifier

getPassedTests

public Set<ITestResult> getPassedTests(ITestNGMethod tm)

Specified by:

getPassedTests in interface ITestResultNotifier

getFailedTests

public Set<ITestResult> getFailedTests(ITestNGMethod tm)

Specified by:

getFailedTests in interface ITestResultNotifier

getSkippedTests

public Set<ITestResult> getSkippedTests(ITestNGMethod tm)

Specified by:

getSkippedTests in interface ITestResultNotifier

addSkippedTest

public void addSkippedTest(ITestNGMethod tm,
 ITestResult tr)

Specified by:

addSkippedTest in interface ITestResultNotifier

addFailedTest

public void addFailedTest(ITestNGMethod testMethod,
 ITestResult result)

Specified by:

addFailedTest in interface ITestResultNotifier

addFailedButWithinSuccessPercentageTest

public void addFailedButWithinSuccessPercentageTest(ITestNGMethod testMethod,
 ITestResult result)

Specified by:

addFailedButWithinSuccessPercentageTest in interface ITestResultNotifier

getTest

public XmlTest getTest()

Specified by:

getTest in interface ITestResultNotifier

getTestListeners

public List<ITestListener> getTestListeners()

Specified by:

getTestListeners in interface ITestResultNotifier

getConfigurationListeners

public List<IConfigurationListener> getConfigurationListeners()

Specified by:

getConfigurationListeners in interface ITestResultNotifier

logFailedTest

private void logFailedTest(ITestResult tr,
 boolean withinSuccessPercentage)

log

private static void log(String s)

getVerbose

public static int getVerbose()

setVerbose

public void setVerbose(int n)

addTestListener

void addTestListener(ITestListener listener)

addListener

public void addListener(ITestNGListener listener)

addConfigurationListener

void addConfigurationListener(IConfigurationListener icl)

setExitCodeListener

private void setExitCodeListener(ITestListener exitCodeListener)

getExitCodeListener

public ITestListener getExitCodeListener()

Specified by:

getExitCodeListener in interface ITestResultNotifier

dumpInvokedMethods

private void dumpInvokedMethods()

addMethodInterceptor

void addMethodInterceptor(IMethodInterceptor methodInterceptor)

getCurrentXmlTest

public XmlTest getCurrentXmlTest()

Specified by:

getCurrentXmlTest in interface ITestContext

Returns:

the current XmlTest.

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface IAttributes

Parameters:

name - The name of the attribute to return

Returns:

The attribute

setAttribute

public void setAttribute(String name,
 Object value)

Description copied from interface: IAttributes

Set a custom attribute.

Specified by:

setAttribute in interface IAttributes

Parameters:

name - The attribute name

value - The attribute value

getAttributeNames

public Set<String> getAttributeNames()

Specified by:

getAttributeNames in interface IAttributes

Returns:

all the attributes names.

removeAttribute

public Object removeAttribute(String name)

Description copied from interface: IAttributes

Remove the attribute

Specified by:

removeAttribute in interface IAttributes

Parameters:

name - The attribute name

Returns:

the attribute value if found, null otherwise

getInjectorFactory

public IInjectorFactory getInjectorFactory()

Specified by:

getInjectorFactory in interface ITestContext