org.testng

Class SuiteRunner

java.lang.Object

org.testng.SuiteRunner

All Implemented Interfaces:

IAttributes, IInvokedMethodListener, ISuite, ITestNGListener

public class SuiteRunner
extends java.lang.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 and Description
private static class	SuiteRunner.DefaultTestRunnerFactory The default implementation of ITestRunnerFactory.
private static class	SuiteRunner.ProxyTestRunnerFactory
private class	SuiteRunner.SuiteWorker

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<ITestNGMethod>	allTestMethods
private IAttributes	attributes
private java.util.Map<java.lang.Class<? extends IClassListener>,IClassListener>	classListeners
private IConfiguration	configuration
private java.util.Map<java.lang.Class<? extends IDataProviderListener>,IDataProviderListener>	dataProviderListeners
private static java.lang.String	DEFAULT_OUTPUT_DIR
private java.util.Map<java.lang.Class<? extends IInvokedMethodListener>,IInvokedMethodListener>	invokedMethodListeners
private java.util.Collection<IInvokedMethod>	invokedMethods The list of all the methods invoked during this run
private java.util.Map<java.lang.Class<? extends ISuiteListener>,ISuiteListener>	listeners
private ITestObjectFactory	objectFactory
private java.lang.String	outputDir
private com.google.inject.Injector	parentInjector
private java.lang.String	remoteHost
private java.util.List<IReporter>	reporters
private java.lang.Boolean	skipFailedInvocationCounts
private java.util.Map<java.lang.String,ISuiteResult>	suiteResults
private SuiteRunState	suiteState
private java.util.List<ITestListener>	testListeners
private java.util.List<TestRunner>	testRunners
private TestListenerAdapter	textReporter
private ITestRunnerFactory	tmpRunnerFactory
private boolean	useDefaultListeners
private XmlSuite	xmlSuite

Constructor Summary

Constructors

Modifier	Constructor and Description
	SuiteRunner(IConfiguration configuration, XmlSuite suite, java.lang.String outputDir) Deprecated.
	SuiteRunner(IConfiguration configuration, XmlSuite suite, java.lang.String outputDir, java.util.Comparator<ITestNGMethod> comparator)
	SuiteRunner(IConfiguration configuration, XmlSuite suite, java.lang.String outputDir, ITestRunnerFactory runnerFactory) Deprecated.
	SuiteRunner(IConfiguration configuration, XmlSuite suite, java.lang.String outputDir, ITestRunnerFactory runnerFactory, boolean useDefaultListeners) Deprecated.
	SuiteRunner(IConfiguration configuration, XmlSuite suite, java.lang.String outputDir, ITestRunnerFactory runnerFactory, boolean useDefaultListeners, java.util.Comparator<ITestNGMethod> comparator)
protected	SuiteRunner(IConfiguration configuration, XmlSuite suite, java.lang.String outputDir, ITestRunnerFactory runnerFactory, boolean useDefaultListeners, java.util.List<IMethodInterceptor> methodInterceptors, java.util.Collection<IInvokedMethodListener> invokedMethodListeners, java.util.Collection<ITestListener> testListeners, java.util.Collection<IClassListener> classListeners) Deprecated.
protected	SuiteRunner(IConfiguration configuration, XmlSuite suite, java.lang.String outputDir, ITestRunnerFactory runnerFactory, boolean useDefaultListeners, java.util.List<IMethodInterceptor> methodInterceptors, java.util.Collection<IInvokedMethodListener> invokedMethodListeners, java.util.Collection<ITestListener> testListeners, java.util.Collection<IClassListener> classListeners, java.util.Comparator<ITestNGMethod> comparator) Deprecated. - This constructor stands deprecated as of TestNG v6.13.
protected	SuiteRunner(IConfiguration configuration, XmlSuite suite, java.lang.String outputDir, ITestRunnerFactory runnerFactory, boolean useDefaultListeners, java.util.List<IMethodInterceptor> methodInterceptors, java.util.Collection<IInvokedMethodListener> invokedMethodListeners, java.util.Collection<ITestListener> testListeners, java.util.Collection<IClassListener> classListeners, java.util.Map<java.lang.Class<? extends IDataProviderListener>,IDataProviderListener> dataProviderListeners, java.util.Comparator<ITestNGMethod> comparator)
protected	SuiteRunner(IConfiguration configuration, XmlSuite suite, java.lang.String outputDir, ITestRunnerFactory runnerFactory, boolean useDefaultListeners, java.util.List<IMethodInterceptor> methodInterceptors, java.util.List<IInvokedMethodListener> invokedMethodListeners, java.util.List<ITestListener> testListeners, java.util.List<IClassListener> classListeners) Deprecated. - This constructor stands deprecated.
	SuiteRunner(IConfiguration configuration, XmlSuite suite, java.lang.String outputDir, ITestRunnerFactory runnerFactory, java.util.Comparator<ITestNGMethod> comparator)

Method Summary

Modifier and Type	Method and Description
(package private) void	addConfigurationListener(IConfigurationListener listener)
protected void	addListener(ISuiteListener reporter) Registers ISuiteListeners interested in reporting the result of the current suite.
void	addListener(ITestNGListener listener)
private void	addReporter(IReporter listener)
void	afterInvocation(IInvokedMethod method, ITestResult testResult)
void	beforeInvocation(IInvokedMethod method, ITestResult testResult)
private ITestRunnerFactory2	buildRunnerFactory(java.util.Comparator<ITestNGMethod> comparator)
java.util.List<IInvokedMethod>	getAllInvokedMethods()
java.util.List<ITestNGMethod>	getAllMethods()
IAnnotationFinder	getAnnotationFinder() Returns the annotation finder for the given annotation type.
java.lang.Object	getAttribute(java.lang.String name)
java.util.Set<java.lang.String>	getAttributeNames()
java.util.Collection<ITestNGMethod>	getExcludedMethods()
java.lang.String	getGuiceStage()
java.lang.String	getHost()
private java.util.Collection<ITestNGMethod>	getIncludedOrExcludedMethods(boolean included)
java.util.Collection<ITestNGMethod>	getInvokedMethods() Retrieves the list of all the methods that were invoked during this run.
java.util.Map<java.lang.String,java.util.Collection<ITestNGMethod>>	getMethodsByGroups() Retrieves the map of groups and their associated test methods.
java.lang.String	getName()
IObjectFactory	getObjectFactory()
IObjectFactory2	getObjectFactory2()
java.lang.String	getOutputDirectory()
java.lang.String	getParallel()
java.lang.String	getParameter(java.lang.String parameterName) FIXME: should be removed?
com.google.inject.Injector	getParentInjector()
java.lang.String	getParentModule()
java.util.List<IReporter>	getReporters()
java.util.Map<java.lang.String,ISuiteResult>	getResults()
SuiteRunState	getSuiteState() Retrieves the shared state for a suite.
XmlSuite	getXmlSuite()
private void	init(IConfiguration configuration, XmlSuite suite, java.lang.String outputDir, ITestRunnerFactory runnerFactory, boolean useDefaultListeners, java.util.List<IMethodInterceptor> methodInterceptors, java.util.Collection<IInvokedMethodListener> invokedMethodListener, java.util.Collection<ITestListener> testListeners, java.util.Collection<IClassListener> classListeners, java.util.Map<java.lang.Class<? extends IDataProviderListener>,IDataProviderListener> dataProviderListeners, java.util.Comparator<ITestNGMethod> comparator)
private void	invokeListeners(boolean start)
static void	ppp(java.lang.String s)
private void	privateRun()
java.lang.Object	removeAttribute(java.lang.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(java.lang.String name, java.lang.Object value) Set a custom attribute.
void	setHost(java.lang.String host)
void	setObjectFactory(ITestObjectFactory objectFactory)
private void	setOutputDir(java.lang.String outputdir)
void	setParentInjector(com.google.inject.Injector injector)
void	setReportResults(boolean reportResults)
void	setSkipFailedInvocationCounts(java.lang.Boolean skipFailedInvocationCounts)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OUTPUT_DIR

private static final java.lang.String DEFAULT_OUTPUT_DIR

See Also:

Constant Field Values

suiteResults

private java.util.Map<java.lang.String,ISuiteResult> suiteResults

testRunners

private java.util.List<TestRunner> testRunners

listeners

private java.util.Map<java.lang.Class<? extends ISuiteListener>,ISuiteListener> listeners

textReporter

private TestListenerAdapter textReporter

outputDir

private java.lang.String outputDir

xmlSuite

private XmlSuite xmlSuite

parentInjector

private com.google.inject.Injector parentInjector

testListeners

private java.util.List<ITestListener> testListeners

classListeners

private final java.util.Map<java.lang.Class<? extends IClassListener>,IClassListener> classListeners

dataProviderListeners

private final java.util.Map<java.lang.Class<? extends IDataProviderListener>,IDataProviderListener> dataProviderListeners

tmpRunnerFactory

private ITestRunnerFactory tmpRunnerFactory

useDefaultListeners

private boolean useDefaultListeners

remoteHost

private java.lang.String remoteHost

configuration

private IConfiguration configuration

objectFactory

private ITestObjectFactory objectFactory

skipFailedInvocationCounts

private java.lang.Boolean skipFailedInvocationCounts

reporters

private java.util.List<IReporter> reporters

invokedMethodListeners

private java.util.Map<java.lang.Class<? extends IInvokedMethodListener>,IInvokedMethodListener> invokedMethodListeners

invokedMethods

private final java.util.Collection<IInvokedMethod> invokedMethods

The list of all the methods invoked during this run

allTestMethods

private java.util.List<ITestNGMethod> allTestMethods

suiteState

private SuiteRunState suiteState

attributes

private IAttributes attributes

Constructor Detail

SuiteRunner

public SuiteRunner(IConfiguration configuration,
                   XmlSuite suite,
                   java.lang.String outputDir,
                   java.util.Comparator<ITestNGMethod> comparator)

SuiteRunner

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

SuiteRunner

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

SuiteRunner

@Deprecated
public SuiteRunner(IConfiguration configuration,
                               XmlSuite suite,
                               java.lang.String outputDir)

Deprecated.

SuiteRunner

@Deprecated
public SuiteRunner(IConfiguration configuration,
                               XmlSuite suite,
                               java.lang.String outputDir,
                               ITestRunnerFactory runnerFactory)

Deprecated.

SuiteRunner

@Deprecated
public SuiteRunner(IConfiguration configuration,
                               XmlSuite suite,
                               java.lang.String outputDir,
                               ITestRunnerFactory runnerFactory,
                               boolean useDefaultListeners)

Deprecated.

SuiteRunner

@Deprecated
protected SuiteRunner(IConfiguration configuration,
                                  XmlSuite suite,
                                  java.lang.String outputDir,
                                  ITestRunnerFactory runnerFactory,
                                  boolean useDefaultListeners,
                                  java.util.List<IMethodInterceptor> methodInterceptors,
                                  java.util.List<IInvokedMethodListener> invokedMethodListeners,
                                  java.util.List<ITestListener> testListeners,
                                  java.util.List<IClassListener> classListeners)

Deprecated. - This constructor stands deprecated.

SuiteRunner

@Deprecated
protected SuiteRunner(IConfiguration configuration,
                                  XmlSuite suite,
                                  java.lang.String outputDir,
                                  ITestRunnerFactory runnerFactory,
                                  boolean useDefaultListeners,
                                  java.util.List<IMethodInterceptor> methodInterceptors,
                                  java.util.Collection<IInvokedMethodListener> invokedMethodListeners,
                                  java.util.Collection<ITestListener> testListeners,
                                  java.util.Collection<IClassListener> classListeners)

Deprecated.

SuiteRunner

@Deprecated
protected SuiteRunner(IConfiguration configuration,
                                  XmlSuite suite,
                                  java.lang.String outputDir,
                                  ITestRunnerFactory runnerFactory,
                                  boolean useDefaultListeners,
                                  java.util.List<IMethodInterceptor> methodInterceptors,
                                  java.util.Collection<IInvokedMethodListener> invokedMethodListeners,
                                  java.util.Collection<ITestListener> testListeners,
                                  java.util.Collection<IClassListener> classListeners,
                                  java.util.Comparator<ITestNGMethod> comparator)

Deprecated. - This constructor stands deprecated as of TestNG v6.13.

SuiteRunner

protected SuiteRunner(IConfiguration configuration,
                      XmlSuite suite,
                      java.lang.String outputDir,
                      ITestRunnerFactory runnerFactory,
                      boolean useDefaultListeners,
                      java.util.List<IMethodInterceptor> methodInterceptors,
                      java.util.Collection<IInvokedMethodListener> invokedMethodListeners,
                      java.util.Collection<ITestListener> testListeners,
                      java.util.Collection<IClassListener> classListeners,
                      java.util.Map<java.lang.Class<? extends IDataProviderListener>,IDataProviderListener> dataProviderListeners,
                      java.util.Comparator<ITestNGMethod> comparator)

Method Detail

init

private void init(IConfiguration configuration,
                  XmlSuite suite,
                  java.lang.String outputDir,
                  ITestRunnerFactory runnerFactory,
                  boolean useDefaultListeners,
                  java.util.List<IMethodInterceptor> methodInterceptors,
                  java.util.Collection<IInvokedMethodListener> invokedMethodListener,
                  java.util.Collection<ITestListener> testListeners,
                  java.util.Collection<IClassListener> classListeners,
                  java.util.Map<java.lang.Class<? extends IDataProviderListener>,IDataProviderListener> dataProviderListeners,
                  java.util.Comparator<ITestNGMethod> comparator)

getXmlSuite

public XmlSuite getXmlSuite()

Specified by:

getXmlSuite in interface ISuite

Returns:

The representation of the current XML suite file.

getName

public java.lang.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)

invokeListeners

private void invokeListeners(boolean start)

setOutputDir

private void setOutputDir(java.lang.String outputdir)

buildRunnerFactory

private ITestRunnerFactory2 buildRunnerFactory(java.util.Comparator<ITestNGMethod> comparator)

getParallel

public java.lang.String getParallel()

Specified by:

getParallel in interface ISuite

Returns:

true if the tests must be run in parallel.

getParentModule

public java.lang.String getParentModule()

Specified by:

getParentModule in interface ISuite

getGuiceStage

public java.lang.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()

addReporter

private void addReporter(IReporter listener)

addConfigurationListener

void addConfigurationListener(IConfigurationListener listener)

getReporters

public java.util.List<IReporter> getReporters()

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 tag, it can't implement , which is why we're doing it here).

addListener

protected void addListener(ISuiteListener reporter)

Registers ISuiteListeners interested in reporting the result of the current suite.

Parameters:

reporter -

addListener

public void addListener(ITestNGListener listener)

Specified by:

addListener in interface ISuite

getOutputDirectory

public java.lang.String getOutputDirectory()

Specified by:

getOutputDirectory in interface ISuite

Returns:

The output directory used for the reports.

getResults

public java.util.Map<java.lang.String,ISuiteResult> getResults()

Specified by:

getResults in interface ISuite

Returns:

The results for this suite.

getParameter

public java.lang.String getParameter(java.lang.String parameterName)

FIXME: should be removed?

Specified by:

getParameter in interface ISuite

Returns:

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

See Also:

ISuite.getParameter(java.lang.String)

getMethodsByGroups

public java.util.Map<java.lang.String,java.util.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()

getInvokedMethods

public java.util.Collection<ITestNGMethod> getInvokedMethods()

Description copied from interface: ISuite

Retrieves the list of all the methods that were invoked during this run.

Specified by:

getInvokedMethods in interface ISuite

Returns:

a collection of ITestNGMethods belonging to all tests included in the suite.

See Also:

ISuite.getInvokedMethods()

getExcludedMethods

public java.util.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()

getIncludedOrExcludedMethods

private java.util.Collection<ITestNGMethod> getIncludedOrExcludedMethods(boolean included)

getObjectFactory

public IObjectFactory getObjectFactory()

Specified by:

getObjectFactory in interface ISuite

Returns:

The object factory used to create all test instances.

getObjectFactory2

public IObjectFactory2 getObjectFactory2()

Specified by:

getObjectFactory2 in interface ISuite

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.

ppp

public static void ppp(java.lang.String s)

setHost

public void setHost(java.lang.String host)

getHost

public java.lang.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(java.lang.Boolean skipFailedInvocationCounts)

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Specified by:

getAttribute in interface IAttributes

Parameters:

name - The name of the attribute to return

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Description copied from interface: IAttributes

Set a custom attribute.

Specified by:

setAttribute in interface IAttributes

getAttributeNames

public java.util.Set<java.lang.String> getAttributeNames()

Specified by:

getAttributeNames in interface IAttributes

Returns:

all the attributes names.

removeAttribute

public java.lang.Object removeAttribute(java.lang.String name)

Description copied from interface: IAttributes

Remove the attribute

Specified by:

removeAttribute in interface IAttributes

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 java.util.List<IInvokedMethod> getAllInvokedMethods()

Specified by:

getAllInvokedMethods in interface ISuite

Returns:

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

getAllMethods

public java.util.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.