Package org.testng

Class SuiteRunner

java.lang.Object

org.testng.SuiteRunner

All Implemented Interfaces:

IAttributes, IInvokedMethodListener, ISuite, ITestNGListener

public class SuiteRunner
extends Object
implements ISuite, IInvokedMethodListener

SuiteRunner is responsible for running all the tests included in one suite. The test start is triggered by run() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SuiteRunner.DefaultTestRunnerFactory	The default implementation of ITestRunnerFactory.
private static class	SuiteRunner.ProxyTestRunnerFactory
private class	SuiteRunner.SuiteWorker
(package private) static class	SuiteRunner.TestListenersContainer

Field Summary

Fields

Modifier and Type	Field	Description
private final IAttributes	attributes
private final Map<Class<? extends IClassListener>,IClassListener>	classListeners
private IConfiguration	configuration
private static final String	DEFAULT_OUTPUT_DIR
private ITestListener	exitCodeListener
private final DataProviderHolder	holder
private Map<Class<? extends IInvokedMethodListener>,IInvokedMethodListener>	invokedMethodListeners
private final Map<Class<? extends ISuiteListener>,ISuiteListener>	listeners
private ITestObjectFactory	objectFactory
private String	outputDir
private com.google.inject.Injector	parentInjector
private String	remoteHost
private final List<IReporter>	reporters
private Boolean	skipFailedInvocationCounts
private final Map<String,ISuiteResult>	suiteResults
private final SuiteRunState	suiteState
private final List<ITestListener>	testListeners
private final List<TestRunner>	testRunners
private ITestRunnerFactory	tmpRunnerFactory
private boolean	useDefaultListeners
private final Set<IExecutionVisualiser>	visualisers
private XmlSuite	xmlSuite

Constructor Summary

Constructors

Modifier	Constructor	Description
	SuiteRunner(IConfiguration configuration, XmlSuite suite, String outputDir, ITestRunnerFactory runnerFactory, boolean useDefaultListeners, Comparator<ITestNGMethod> comparator)
protected	SuiteRunner(IConfiguration configuration, XmlSuite suite, String outputDir, ITestRunnerFactory runnerFactory, boolean useDefaultListeners, List<IMethodInterceptor> methodInterceptors, Collection<IInvokedMethodListener> invokedMethodListeners, SuiteRunner.TestListenersContainer container, Collection<IClassListener> classListeners, DataProviderHolder holder, Comparator<ITestNGMethod> comparator)
	SuiteRunner(IConfiguration configuration, XmlSuite suite, String outputDir, ITestRunnerFactory runnerFactory, Comparator<ITestNGMethod> comparator)

Method Summary

Modifier and Type	Method	Description
(package private) void	addConfigurationListener(IConfigurationListener listener)
protected void	addListener(ISuiteListener reporter)
void	addListener(ITestNGListener listener)
private void	addReporter(IReporter listener)
private void	addVisualiser(IExecutionVisualiser visualiser)
void	afterInvocation(IInvokedMethod method, ITestResult testResult)
void	beforeInvocation(IInvokedMethod method, ITestResult testResult)
private ITestRunnerFactory	buildRunnerFactory(Comparator<ITestNGMethod> comparator)
List<IInvokedMethod>	getAllInvokedMethods()
List<ITestNGMethod>	getAllMethods()
IAnnotationFinder	getAnnotationFinder()	Returns the annotation finder for the given annotation type.
Object	getAttribute(String name)
Set<String>	getAttributeNames()
Collection<IDataProviderListener>	getDataProviderListeners()
Collection<ITestNGMethod>	getExcludedMethods()
(package private) ITestListener	getExitCodeListener()
String	getGuiceStage()
String	getHost()
Map<String,Collection<ITestNGMethod>>	getMethodsByGroups()	Retrieves the map of groups and their associated test methods.
String	getName()
ITestObjectFactory	getObjectFactory()
String	getOutputDirectory()
String	getParallel()
String	getParameter(String parameterName)	FIXME: should be removed?
com.google.inject.Injector	getParentInjector()
String	getParentModule()
List<IReporter>	getReporters()
Map<String,ISuiteResult>	getResults()
SuiteRunState	getSuiteState()	Retrieves the shared state for a suite.
XmlSuite	getXmlSuite()
private void	init(IConfiguration configuration, XmlSuite suite, String outputDir, ITestRunnerFactory runnerFactory, boolean useDefaultListeners, List<IMethodInterceptor> methodInterceptors, Collection<IInvokedMethodListener> invokedMethodListener, SuiteRunner.TestListenersContainer container, Collection<IClassListener> classListeners, DataProviderHolder attribs, Comparator<ITestNGMethod> comparator)
private void	invokeListeners(boolean start)
private void	privateRun()
Object	removeAttribute(String name)	Remove the attribute
void	run()	Triggers the start of running tests included in the suite.
private void	runInParallelTestMode()	Implement .
private void	runSequentially()
private void	runTest(TestRunner tr)
void	setAttribute(String name, Object value)	Set a custom attribute.
void	setHost(String host)
void	setObjectFactory(ITestObjectFactory objectFactory)
private void	setOutputDir(String outputdir)
void	setParentInjector(com.google.inject.Injector injector)
void	setReportResults(boolean reportResults)
void	setSkipFailedInvocationCounts(Boolean skipFailedInvocationCounts)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.testng.IInvokedMethodListener

afterInvocation, beforeInvocation

Methods inherited from interface org.testng.ISuite

getObjectFactory2

Field Details

DEFAULT_OUTPUT_DIR

private static final String DEFAULT_OUTPUT_DIR

See Also:

• Constant Field Values

suiteResults

private final Map<String,ISuiteResult> suiteResults

testRunners

private final List<TestRunner> testRunners

listeners

private final Map<Class<? extends ISuiteListener>,ISuiteListener> listeners

outputDir

private String outputDir

xmlSuite

private XmlSuite xmlSuite

parentInjector

private com.google.inject.Injector parentInjector

testListeners

private final List<ITestListener> testListeners

classListeners

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

tmpRunnerFactory

private ITestRunnerFactory tmpRunnerFactory

holder

private final DataProviderHolder holder

useDefaultListeners

private boolean useDefaultListeners

remoteHost

private String remoteHost

configuration

private IConfiguration configuration

objectFactory

private ITestObjectFactory objectFactory

skipFailedInvocationCounts

private Boolean skipFailedInvocationCounts

reporters

private final List<IReporter> reporters

invokedMethodListeners

private Map<Class<? extends IInvokedMethodListener>,IInvokedMethodListener> invokedMethodListeners

suiteState

private final SuiteRunState suiteState

attributes

private final IAttributes attributes

visualisers

private final Set<IExecutionVisualiser> visualisers

exitCodeListener

private ITestListener exitCodeListener

Constructor Details

SuiteRunner

public SuiteRunner(IConfiguration configuration,
 XmlSuite suite,
 String outputDir,
 ITestRunnerFactory runnerFactory,
 Comparator<ITestNGMethod> comparator)

SuiteRunner

public SuiteRunner(IConfiguration configuration,
 XmlSuite suite,
 String outputDir,
 ITestRunnerFactory runnerFactory,
 boolean useDefaultListeners,
 Comparator<ITestNGMethod> comparator)

SuiteRunner

protected SuiteRunner(IConfiguration configuration,
 XmlSuite suite,
 String outputDir,
 ITestRunnerFactory runnerFactory,
 boolean useDefaultListeners,
 List<IMethodInterceptor> methodInterceptors,
 Collection<IInvokedMethodListener> invokedMethodListeners,
 SuiteRunner.TestListenersContainer container,
 Collection<IClassListener> classListeners,
 DataProviderHolder holder,
 Comparator<ITestNGMethod> comparator)

Method Details

init

private void init(IConfiguration configuration,
 XmlSuite suite,
 String outputDir,
 ITestRunnerFactory runnerFactory,
 boolean useDefaultListeners,
 List<IMethodInterceptor> methodInterceptors,
 Collection<IInvokedMethodListener> invokedMethodListener,
 SuiteRunner.TestListenersContainer container,
 Collection<IClassListener> classListeners,
 DataProviderHolder attribs,
 Comparator<ITestNGMethod> comparator)

getXmlSuite

public XmlSuite getXmlSuite()

Specified by:

getXmlSuite in interface ISuite

Returns:

The representation of the current XML suite file.

getName

public String getName()

Specified by:

getName in interface ISuite

Returns:

the name of this suite.

setObjectFactory

public void setObjectFactory(ITestObjectFactory objectFactory)

setReportResults

public void setReportResults(boolean reportResults)

getExitCodeListener

ITestListener getExitCodeListener()

invokeListeners

private void invokeListeners(boolean start)

setOutputDir

private void setOutputDir(String outputdir)

buildRunnerFactory

private ITestRunnerFactory buildRunnerFactory(Comparator<ITestNGMethod> comparator)

getParallel

public String getParallel()

Specified by:

getParallel in interface ISuite

Returns:

true if the tests must be run in parallel.

getParentModule

public String getParentModule()

Specified by:

getParentModule in interface ISuite

getGuiceStage

public String getGuiceStage()

Specified by:

getGuiceStage in interface ISuite

getParentInjector

public com.google.inject.Injector getParentInjector()

Specified by:

getParentInjector in interface ISuite

setParentInjector

public void setParentInjector(com.google.inject.Injector injector)

Specified by:

setParentInjector in interface ISuite

run

public void run()

Description copied from interface: ISuite

Triggers the start of running tests included in the suite.

Specified by:

run in interface ISuite

privateRun

private void privateRun()

addVisualiser

private void addVisualiser(IExecutionVisualiser visualiser)

addReporter

private void addReporter(IReporter listener)

addConfigurationListener

void addConfigurationListener(IConfigurationListener listener)

getReporters

public List<IReporter> getReporters()

getDataProviderListeners

public Collection<IDataProviderListener> getDataProviderListeners()

runSequentially

private void runSequentially()

runTest

private void runTest(TestRunner tr)

runInParallelTestMode

private void runInParallelTestMode()

Implement . Since this kind of parallelism happens at the suite level, we need a special code path to execute it. All the other parallelism strategies are implemented at the test level in TestRunner#createParallelWorkers (but since this method deals with just one <test> tag, it can't implement , which is why we're doing it here).

addListener

protected void addListener(ISuiteListener reporter)

Parameters:

reporter - The ISuiteListener interested in reporting the result of the current suite.

addListener

public void addListener(ITestNGListener listener)

Specified by:

addListener in interface ISuite

getOutputDirectory

public String getOutputDirectory()

Specified by:

getOutputDirectory in interface ISuite

Returns:

The output directory used for the reports.

getResults

public Map<String,ISuiteResult> getResults()

Specified by:

getResults in interface ISuite

Returns:

The results for this suite.

getParameter

public String getParameter(String parameterName)

FIXME: should be removed?

Specified by:

getParameter in interface ISuite

Parameters:

parameterName - The name of the parameter

Returns:

The value of this parameter, or null if none was specified.

See Also:

• ISuite.getParameter(java.lang.String)

getMethodsByGroups

public Map<String,Collection<ITestNGMethod>> getMethodsByGroups()

Description copied from interface: ISuite

Retrieves the map of groups and their associated test methods.

Specified by:

getMethodsByGroups in interface ISuite

Returns:

A map where the key is the group and the value is a list of methods used by this group.

See Also:

• ISuite.getMethodsByGroups()

getExcludedMethods

public Collection<ITestNGMethod> getExcludedMethods()

Specified by:

getExcludedMethods in interface ISuite

Returns:

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

See Also:

• ISuite.getExcludedMethods()

getObjectFactory

public ITestObjectFactory getObjectFactory()

Specified by:

getObjectFactory in interface ISuite

Returns:

The object factory used to create all test instances.

getAnnotationFinder

public IAnnotationFinder getAnnotationFinder()

Returns the annotation finder for the given annotation type.

Specified by:

getAnnotationFinder in interface ISuite

Returns:

the annotation finder for the given annotation type.

setHost

public void setHost(String host)

getHost

public String getHost()

Specified by:

getHost in interface ISuite

Returns:

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

getSuiteState

public SuiteRunState getSuiteState()

Description copied from interface: ISuite

Retrieves the shared state for a suite.

Specified by:

getSuiteState in interface ISuite

Returns:

the share state of the current suite.

See Also:

• ISuite.getSuiteState()

setSkipFailedInvocationCounts

public void setSkipFailedInvocationCounts(Boolean skipFailedInvocationCounts)

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

afterInvocation

public void afterInvocation(IInvokedMethod method,
 ITestResult testResult)

Specified by:

afterInvocation in interface IInvokedMethodListener

beforeInvocation

public void beforeInvocation(IInvokedMethod method,
 ITestResult testResult)

Specified by:

beforeInvocation in interface IInvokedMethodListener

getAllInvokedMethods

public List<IInvokedMethod> getAllInvokedMethods()

Specified by:

getAllInvokedMethods in interface ISuite

Returns:

a list of all the methods that were invoked in this suite.

getAllMethods

public List<ITestNGMethod> getAllMethods()

Specified by:

getAllMethods in interface ISuite

Returns:

the total number of methods found in this suite. The presence of factories or data providers might cause the actual number of test methods run be bigger than this list.