Package 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
SuiteRunneris responsible for running all the tests included in one suite. The test start is triggered byrun()method.
-
-
Constructor Summary
Constructors Modifier Constructor 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)protectedSuiteRunner(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.protectedSuiteRunner(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.protectedSuiteRunner(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)protectedSuiteRunner(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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidaddListener(ISuiteListener reporter)Registers ISuiteListeners interested in reporting the result of the current suite.voidaddListener(ITestNGListener listener)voidafterInvocation(IInvokedMethod method, ITestResult testResult)voidbeforeInvocation(IInvokedMethod method, ITestResult testResult)java.util.List<IInvokedMethod>getAllInvokedMethods()java.util.List<ITestNGMethod>getAllMethods()IAnnotationFindergetAnnotationFinder()Returns the annotation finder for the given annotation type.java.lang.ObjectgetAttribute(java.lang.String name)java.util.Set<java.lang.String>getAttributeNames()java.util.Collection<ITestNGMethod>getExcludedMethods()java.lang.StringgetGuiceStage()java.lang.StringgetHost()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.StringgetName()IObjectFactorygetObjectFactory()IObjectFactory2getObjectFactory2()java.lang.StringgetOutputDirectory()java.lang.StringgetParallel()java.lang.StringgetParameter(java.lang.String parameterName)FIXME: should be removed?com.google.inject.InjectorgetParentInjector()java.lang.StringgetParentModule()java.util.List<IReporter>getReporters()java.util.Map<java.lang.String,ISuiteResult>getResults()SuiteRunStategetSuiteState()Retrieves the shared state for a suite.XmlSuitegetXmlSuite()static voidppp(java.lang.String s)java.lang.ObjectremoveAttribute(java.lang.String name)Remove the attributevoidrun()Triggers the start of running tests included in the suite.voidsetAttribute(java.lang.String name, java.lang.Object value)Set a custom attribute.voidsetHost(java.lang.String host)voidsetObjectFactory(ITestObjectFactory objectFactory)voidsetParentInjector(com.google.inject.Injector injector)voidsetReportResults(boolean reportResults)voidsetSkipFailedInvocationCounts(java.lang.Boolean skipFailedInvocationCounts)
-
-
-
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
-
getXmlSuite
public XmlSuite getXmlSuite()
- Specified by:
getXmlSuitein interfaceISuite- Returns:
- The representation of the current XML suite file.
-
getName
public java.lang.String getName()
-
setObjectFactory
public void setObjectFactory(ITestObjectFactory objectFactory)
-
setReportResults
public void setReportResults(boolean reportResults)
-
getParallel
public java.lang.String getParallel()
- Specified by:
getParallelin interfaceISuite- Returns:
- true if the tests must be run in parallel.
-
getParentModule
public java.lang.String getParentModule()
- Specified by:
getParentModulein interfaceISuite
-
getGuiceStage
public java.lang.String getGuiceStage()
- Specified by:
getGuiceStagein interfaceISuite
-
getParentInjector
public com.google.inject.Injector getParentInjector()
- Specified by:
getParentInjectorin interfaceISuite
-
setParentInjector
public void setParentInjector(com.google.inject.Injector injector)
- Specified by:
setParentInjectorin interfaceISuite
-
run
public void run()
Description copied from interface:ISuiteTriggers the start of running tests included in the suite.
-
getReporters
public java.util.List<IReporter> getReporters()
-
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:
addListenerin interfaceISuite
-
getOutputDirectory
public java.lang.String getOutputDirectory()
- Specified by:
getOutputDirectoryin interfaceISuite- Returns:
- The output directory used for the reports.
-
getResults
public java.util.Map<java.lang.String,ISuiteResult> getResults()
- Specified by:
getResultsin interfaceISuite- Returns:
- The results for this suite.
-
getParameter
public java.lang.String getParameter(java.lang.String parameterName)
FIXME: should be removed?- Specified by:
getParameterin interfaceISuite- 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:ISuiteRetrieves the map of groups and their associated test methods.- Specified by:
getMethodsByGroupsin interfaceISuite- 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:ISuiteRetrieves the list of all the methods that were invoked during this run.- Specified by:
getInvokedMethodsin interfaceISuite- 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:
getExcludedMethodsin interfaceISuite- Returns:
- All the methods that were not included in this test run.
- See Also:
ISuite.getExcludedMethods()
-
getObjectFactory
public IObjectFactory getObjectFactory()
- Specified by:
getObjectFactoryin interfaceISuite- Returns:
- The object factory used to create all test instances.
-
getObjectFactory2
public IObjectFactory2 getObjectFactory2()
- Specified by:
getObjectFactory2in interfaceISuite
-
getAnnotationFinder
public IAnnotationFinder getAnnotationFinder()
Returns the annotation finder for the given annotation type.- Specified by:
getAnnotationFinderin interfaceISuite- 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()
-
getSuiteState
public SuiteRunState getSuiteState()
Description copied from interface:ISuiteRetrieves the shared state for a suite.- Specified by:
getSuiteStatein interfaceISuite- 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:
getAttributein interfaceIAttributes- 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:IAttributesSet a custom attribute.- Specified by:
setAttributein interfaceIAttributes
-
getAttributeNames
public java.util.Set<java.lang.String> getAttributeNames()
- Specified by:
getAttributeNamesin interfaceIAttributes- Returns:
- all the attributes names.
-
removeAttribute
public java.lang.Object removeAttribute(java.lang.String name)
Description copied from interface:IAttributesRemove the attribute- Specified by:
removeAttributein interfaceIAttributes- Returns:
- the attribute value if found, null otherwise
-
afterInvocation
public void afterInvocation(IInvokedMethod method, ITestResult testResult)
- Specified by:
afterInvocationin interfaceIInvokedMethodListener
-
beforeInvocation
public void beforeInvocation(IInvokedMethod method, ITestResult testResult)
- Specified by:
beforeInvocationin interfaceIInvokedMethodListener
-
getAllInvokedMethods
public java.util.List<IInvokedMethod> getAllInvokedMethods()
- Specified by:
getAllInvokedMethodsin interfaceISuite- Returns:
- a list of all the methods that were invoked in this suite.
-
getAllMethods
public java.util.List<ITestNGMethod> getAllMethods()
- Specified by:
getAllMethodsin interfaceISuite- 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.
-
-