TestNG

java.lang.Object
- org.testng.TestNG

Direct Known Subclasses:

TestNG
```
public class TestNG
extends java.lang.Object
```
This class is the main entry point for running tests in the TestNG framework. Users can create their own TestNG object and invoke it in many different ways:
- On an existing testng.xml
- On a synthetic testng.xml, created entirely from Java
- By directly setting the test classes
You can also define which groups to include or exclude, assign parameters, etc...
The command line parameters are:
- -d outputdir: specify the output directory
- -testclass class_name: specifies one or several class names
- -testjar jar_name: specifies the jar containing the tests
- -sourcedir src1;src2: ; separated list of source directories (used only when javadoc annotations are used)
- -target
- -groups
- -testrunfactory
- -listener
Please consult documentation for more details. FIXME: should support more than simple paths for suite xmls
Author:

Cedric Beust

See Also:

usage()

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class TestNG.ExitCodeListener
Deprecated.

Nested Classes
Modifier and Type	Class	Description
`static class`	`TestNG.ExitCodeListener`	Deprecated.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`DEFAULT_COMMAND_LINE_SUITE_NAME`	The default name for a suite launched from the command line
`static java.lang.String`	`DEFAULT_COMMAND_LINE_TEST_NAME`	The default name for a test launched from the command line
`static java.lang.String`	`DEFAULT_OUTPUTDIR`	The default name of the result's output directory (keep public, used by Eclipse).
`static java.lang.Integer`	`DEFAULT_VERBOSE`
`protected long`	`m_end`
`protected long`	`m_start`
`protected java.util.List<XmlSuite>`	`m_suites`
`protected boolean`	`m_useDefaultListeners`
`static java.lang.String`	`SHOW_TESTNG_STACK_FRAMES`	System properties
`static java.lang.String`	`TEST_CLASSPATH`

Constructor Summary

Constructors
Constructor Description

TestNG()
Default constructor.

TestNG(boolean useDefaultListeners)
Used by maven2 to have 0 output of any kind come out of testng.

Constructors
Constructor	Description
`TestNG()`	Default constructor.
`TestNG(boolean useDefaultListeners)`	Used by maven2 to have 0 output of any kind come out of testng.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addAlterSuiteListener(IAlterSuiteListener l)`	Deprecated. Use addListener(ITestNGListener) instead
`void`	`addClassLoader(java.lang.ClassLoader loader)`	Add a class loader to the searchable loaders.
`void`	`addExecutionListener(IExecutionListener l)`	Deprecated. Use addListener(ITestNGListener) instead
`void`	`addInvokedMethodListener(IInvokedMethodListener listener)`	Deprecated. Use addListener(ITestNGListener) instead
`void`	`addListener(java.lang.Object listener)`	Deprecated. Use addListener(ITestNGListener) instead
`void`	`addListener(IClassListener listener)`	Deprecated. Use addListener(ITestNGListener) instead
`void`	`addListener(IInvokedMethodListener listener)`	Deprecated. Use addListener(ITestNGListener) instead
`void`	`addListener(IReporter listener)`	Deprecated. Use addListener(ITestNGListener) instead
`void`	`addListener(ISuiteListener listener)`	Deprecated. Use addListener(ITestNGListener) instead
`void`	`addListener(ITestListener listener)`	Deprecated. Use addListener(ITestNGListener) instead
`void`	`addListener(ITestNGListener listener)`
`void`	`addMethodSelector(java.lang.String className, int priority)`
`void`	`addMethodSelector(XmlMethodSelector selector)`
`void`	`configure(java.util.Map cmdLineArgs)`	Deprecated. use new configure(CommandLineArgs) method
`protected void`	`configure(CommandLineArgs cla)`	Configure the TestNG instance based on the command line parameters.
`IAnnotationTransformer`	`getAnnotationTransformer()`
`XmlSuite.FailurePolicy`	`getConfigFailurePolicy()`	Returns the configuration failure policy.
`protected IConfiguration`	`getConfiguration()`
`static TestNG`	`getDefault()`	Deprecated. since 5.1
`java.lang.String`	`getDefaultSuiteName()`
`java.lang.String`	`getDefaultTestName()`
`protected long`	`getEnd()`
`java.lang.String`	`getOutputDirectory()`
`java.util.Set<IReporter>`	`getReporters()`
`java.util.List<ITestNGListener>`	`getServiceLoaderListeners()`
`protected long`	`getStart()`
`int`	`getStatus()`
`java.util.List<ISuiteListener>`	`getSuiteListeners()`
`java.lang.Integer`	`getSuiteThreadPoolSize()`
`java.util.List<ITestListener>`	`getTestListeners()`
`boolean`	`hasFailure()`
`boolean`	`hasFailureWithinSuccessPercentage()`
`boolean`	`hasSkip()`
`void`	`initializeEverything()`	Invoked by the remote runner.
`void`	`initializeSuitesAndJarFile()`
`static boolean`	`isJdk14()`	Deprecated.
`static void`	`main(java.lang.String[] argv)`	The TestNG entry point for command line execution.
`static TestNG`	`privateMain(java.lang.String[] argv, ITestListener listener)`	Note: this method is not part of the public API and is meant for internal usage only.
`void`	`run()`	Run TestNG.
`protected java.util.List<ISuite>`	`runSuites()`	Run the test suites.
`java.util.List<ISuite>`	`runSuitesLocally()`	This needs to be public for maven2, for now..At least until an alternative mechanism is found.
`void`	`setAnnotationTransformer(IAnnotationTransformer t)`	Deprecated. Use addListener(ITestNGListener) instead
`void`	`setCommandLineSuite(XmlSuite suite)`
`void`	`setConfigFailurePolicy(java.lang.String failurePolicy)`	Deprecated. Use `setConfigFailurePolicy(org.testng.xml.XmlSuite.FailurePolicy)` instead
`void`	`setConfigFailurePolicy(XmlSuite.FailurePolicy failurePolicy)`	Sets the policy for whether or not to ever invoke a configuration method again after it has failed once.
`void`	`setDataProviderThreadCount(int count)`
`void`	`setDefaultSuiteName(java.lang.String defaultSuiteName)`
`void`	`setDefaultTestName(java.lang.String defaultTestName)`
`void`	`setExcludedGroups(java.lang.String groups)`	Define which groups will be excluded from this run.
`void`	`setGroupByInstances(boolean b)`
`void`	`setGroups(java.lang.String groups)`	Define which groups will be included from this run.
`void`	`setJUnit(java.lang.Boolean isJUnit)`	Specify if this run should be made in JUnit mode
`void`	`setListenerClasses(java.util.List<java.lang.Class<? extends ITestNGListener>> classes)`	Define which listeners to user for this run.
`void`	`setMethodInterceptor(IMethodInterceptor methodInterceptor)`
`void`	`setMixed(java.lang.Boolean isMixed)`	Specify if this run should be made in mixed mode
`void`	`setObjectFactory(java.lang.Class c)`
`void`	`setObjectFactory(ITestObjectFactory factory)`
`void`	`setOutputDirectory(java.lang.String outputdir)`	Sets the output directory where the reports will be created.
`void`	`setParallel(java.lang.String parallel)`	Deprecated. Use #setParallel(XmlSuite.ParallelMode) instead
`void`	`setParallel(XmlSuite.ParallelMode parallel)`
`void`	`setPreserveOrder(boolean b)`
`void`	`setRandomizeSuites(boolean randomizeSuites)`
`void`	`setServiceLoaderClassLoader(java.net.URLClassLoader ucl)`
`void`	`setSkipFailedInvocationCounts(java.lang.Boolean skip)`
`void`	`setSourcePath(java.lang.String path)`	This method is invoked by Maven's Surefire, only remove it once Surefire has been modified to no longer call it.
`void`	`setSuiteThreadPoolSize(java.lang.Integer suiteThreadPoolSize)`
`void`	`setTestClasses(java.lang.Class[] classes)`	Set the test classes to be run by this TestNG object.
`void`	`setTestJar(java.lang.String jarPath)`	Sets a jar containing a testng.xml file.
`void`	`setTestNames(java.util.List<java.lang.String> testNames)`	Only run the specified tests from the suite.
`static void`	`setTestNGVersion()`	Deprecated. The TestNG version is now established at load time. This method is not required anymore and is now a no-op.
`protected void`	`setTestRunnerFactory(ITestRunnerFactory itrf)`
`void`	`setTestSuites(java.util.List<java.lang.String> suites)`	Set the suites file names to be run by this TestNG object.
`void`	`setThreadCount(int threadCount)`	Define the number of threads in the thread pool.
`void`	`setUseDefaultListeners(boolean useDefaultListeners)`	If this method is passed true before run(), the default listeners will not be used.
`void`	`setVerbose(int verbose)`	Sets the level of verbosity.
`void`	`setXmlPathInJar(java.lang.String xmlPathInJar)`	Sets the path to the XML file in the test jar file.
`void`	`setXmlSuites(java.util.List<XmlSuite> suites)`	Specifies the XmlSuite objects to run.
`protected static void`	`validateCommandLineParameters(CommandLineArgs args)`	Double check that the command line parameters are valid.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_COMMAND_LINE_SUITE_NAME
```
public static final java.lang.String DEFAULT_COMMAND_LINE_SUITE_NAME
```
    The default name for a suite launched from the command line
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COMMAND_LINE_TEST_NAME
```
public static final java.lang.String DEFAULT_COMMAND_LINE_TEST_NAME
```
    The default name for a test launched from the command line
    
    See Also:
    
    Constant Field Values
  - DEFAULT_OUTPUTDIR
```
public static final java.lang.String DEFAULT_OUTPUTDIR
```
    The default name of the result's output directory (keep public, used by Eclipse).
    
    See Also:
    
    Constant Field Values
  - SHOW_TESTNG_STACK_FRAMES
```
public static final java.lang.String SHOW_TESTNG_STACK_FRAMES
```
    System properties
    
    See Also:
    
    Constant Field Values
  - TEST_CLASSPATH
```
public static final java.lang.String TEST_CLASSPATH
```
    See Also:
    
    Constant Field Values
  - m_suites
```
protected java.util.List<XmlSuite> m_suites
```
  - m_useDefaultListeners
```
protected boolean m_useDefaultListeners
```
  - DEFAULT_VERBOSE
```
public static final java.lang.Integer DEFAULT_VERBOSE
```
  - m_end
```
protected long m_end
```
  - m_start
```
protected long m_start
```
- Constructor Detail
  - TestNG
```
public TestNG()
```
    Default constructor. Setting also usage of default listeners/reporters.
  - TestNG
```
public TestNG(boolean useDefaultListeners)
```
    Used by maven2 to have 0 output of any kind come out of testng.
    
    Parameters:
    
    useDefaultListeners - Whether or not any default reports should be added to tests.
- Method Detail
  - getStatus
```
public int getStatus()
```
  - setOutputDirectory
```
public void setOutputDirectory(java.lang.String outputdir)
```
    Sets the output directory where the reports will be created.
    
    Parameters:
    
    outputdir - The directory.
  - setUseDefaultListeners
```
public void setUseDefaultListeners(boolean useDefaultListeners)
```
    If this method is passed true before run(), the default listeners will not be used.
    - org.testng.reporters.TestHTMLReporter
    - org.testng.reporters.JUnitXMLReporter
    - org.testng.reporters.XMLReporter
    See Also:
    
    TestHTMLReporter, JUnitXMLReporter, XMLReporter
  - setTestJar
```
public void setTestJar(java.lang.String jarPath)
```
    Sets a jar containing a testng.xml file.
    
    Parameters:
    
    jarPath -
  - setXmlPathInJar
```
public void setXmlPathInJar(java.lang.String xmlPathInJar)
```
    Sets the path to the XML file in the test jar file.
  - initializeSuitesAndJarFile
```
public void initializeSuitesAndJarFile()
```
  - setThreadCount
```
public void setThreadCount(int threadCount)
```
    Define the number of threads in the thread pool.
  - setParallel
```
@Deprecated
public void setParallel(java.lang.String parallel)
```
    Deprecated. Use #setParallel(XmlSuite.ParallelMode) instead
    
    Define whether this run will be run in parallel mode.
  - setParallel
```
public void setParallel(XmlSuite.ParallelMode parallel)
```
  - setCommandLineSuite
```
public void setCommandLineSuite(XmlSuite suite)
```
  - setTestClasses
```
public void setTestClasses(java.lang.Class[] classes)
```
    Set the test classes to be run by this TestNG object. This method will create a dummy suite that will wrap these classes called "Command Line Test".
    If used together with threadCount, parallel, groups, excludedGroups than this one must be set first.
    
    Parameters:
    
    classes - An array of classes that contain TestNG annotations.
  - addMethodSelector
```
public void addMethodSelector(java.lang.String className,
                              int priority)
```
  - addMethodSelector
```
public void addMethodSelector(XmlMethodSelector selector)
```
  - setTestSuites
```
public void setTestSuites(java.util.List<java.lang.String> suites)
```
    Set the suites file names to be run by this TestNG object. This method tries to load and parse the specified TestNG suite xml files. If a file is missing, it is ignored.
    Parameters:
    suites - A list of paths to one more XML files defining the tests. For example:
    TestNG tng = new TestNG(); List suites = Lists.newArrayList(); suites.add("c:/tests/testng1.xml"); suites.add("c:/tests/testng2.xml"); tng.setTestSuites(suites); tng.run();
  - setXmlSuites
```
public void setXmlSuites(java.util.List<XmlSuite> suites)
```
    Specifies the XmlSuite objects to run.
    
    Parameters:
    
    suites -
    
    See Also:
    
    XmlSuite
  - setExcludedGroups
```
public void setExcludedGroups(java.lang.String groups)
```
    Define which groups will be excluded from this run.
    
    Parameters:
    
    groups - A list of group names separated by a comma.
  - setGroups
```
public void setGroups(java.lang.String groups)
```
    Define which groups will be included from this run.
    
    Parameters:
    
    groups - A list of group names separated by a comma.
  - setTestRunnerFactory
```
protected void setTestRunnerFactory(ITestRunnerFactory itrf)
```
  - setObjectFactory
```
public void setObjectFactory(java.lang.Class c)
```
  - setObjectFactory
```
public void setObjectFactory(ITestObjectFactory factory)
```
  - setListenerClasses
```
public void setListenerClasses(java.util.List<java.lang.Class<? extends ITestNGListener>> classes)
```
    Define which listeners to user for this run.
    
    Parameters:
    
    classes - A list of classes, which must be either ISuiteListener, ITestListener or IReporter
  - addListener
```
@Deprecated
public void addListener(java.lang.Object listener)
```
    Deprecated. Use addListener(ITestNGListener) instead
  - addListener
```
public void addListener(ITestNGListener listener)
```
  - addListener
```
@Deprecated
public void addListener(IInvokedMethodListener listener)
```
    Deprecated. Use addListener(ITestNGListener) instead
  - addListener
```
@Deprecated
public void addListener(ISuiteListener listener)
```
    Deprecated. Use addListener(ITestNGListener) instead
  - addListener
```
@Deprecated
public void addListener(ITestListener listener)
```
    Deprecated. Use addListener(ITestNGListener) instead
  - addListener
```
@Deprecated
public void addListener(IClassListener listener)
```
    Deprecated. Use addListener(ITestNGListener) instead
  - addListener
```
@Deprecated
public void addListener(IReporter listener)
```
    Deprecated. Use addListener(ITestNGListener) instead
  - addInvokedMethodListener
```
@Deprecated
public void addInvokedMethodListener(IInvokedMethodListener listener)
```
    Deprecated. Use addListener(ITestNGListener) instead
  - getReporters
```
public java.util.Set<IReporter> getReporters()
```
  - getTestListeners
```
public java.util.List<ITestListener> getTestListeners()
```
  - getSuiteListeners
```
public java.util.List<ISuiteListener> getSuiteListeners()
```
  - setVerbose
```
public void setVerbose(int verbose)
```
    Sets the level of verbosity. This value will override the value specified in the test suites.
    
    Parameters:
    
    verbose - the verbosity level (0 to 10 where 10 is most detailed) Actually, this is a lie: you can specify -1 and this will put TestNG in debug mode (no longer slicing off stack traces and all).
  - initializeEverything
```
public void initializeEverything()
```
    Invoked by the remote runner.
  - run
```
public void run()
```
    Run TestNG.
  - runSuites
```
protected java.util.List<ISuite> runSuites()
```
    Run the test suites.
    This method can be overridden by subclass.
    For example, DistributedTestNG to run in master/slave mode according to commandline args.
    
    Returns:
    
    - List of suites that were run as ISuite objects.
    
    Since:
    
    6.9.11 when moving distributed/remote classes out into separate project
  - addAlterSuiteListener
```
@Deprecated
public void addAlterSuiteListener(IAlterSuiteListener l)
```
    Deprecated. Use addListener(ITestNGListener) instead
  - addExecutionListener
```
@Deprecated
public void addExecutionListener(IExecutionListener l)
```
    Deprecated. Use addListener(ITestNGListener) instead
  - runSuitesLocally
```
public java.util.List<ISuite> runSuitesLocally()
```
    This needs to be public for maven2, for now..At least until an alternative mechanism is found.
  - getConfiguration
```
protected IConfiguration getConfiguration()
```
  - main
```
public static void main(java.lang.String[] argv)
```
    The TestNG entry point for command line execution.
    
    Parameters:
    
    argv - the TestNG command line parameters.
    
    Throws:
    
    java.io.FileNotFoundException
  - privateMain
```
public static TestNG privateMain(java.lang.String[] argv,
                                 ITestListener listener)
```
    Note: this method is not part of the public API and is meant for internal usage only.
  - configure
```
protected void configure(CommandLineArgs cla)
```
    Configure the TestNG instance based on the command line parameters.
  - setSuiteThreadPoolSize
```
public void setSuiteThreadPoolSize(java.lang.Integer suiteThreadPoolSize)
```
  - getSuiteThreadPoolSize
```
public java.lang.Integer getSuiteThreadPoolSize()
```
  - setRandomizeSuites
```
public void setRandomizeSuites(boolean randomizeSuites)
```
  - setSourcePath
```
public void setSourcePath(java.lang.String path)
```
    This method is invoked by Maven's Surefire, only remove it once Surefire has been modified to no longer call it.
  - configure
```
@Deprecated
public void configure(java.util.Map cmdLineArgs)
```
    Deprecated. use new configure(CommandLineArgs) method
    
    This method is invoked by Maven's Surefire to configure the runner, do not remove unless you know for sure that Surefire has been updated to use the new configure(CommandLineArgs) method.
  - setTestNames
```
public void setTestNames(java.util.List<java.lang.String> testNames)
```
    Only run the specified tests from the suite.
  - setSkipFailedInvocationCounts
```
public void setSkipFailedInvocationCounts(java.lang.Boolean skip)
```
  - setJUnit
```
public void setJUnit(java.lang.Boolean isJUnit)
```
    Specify if this run should be made in JUnit mode
    
    Parameters:
    
    isJUnit -
  - setMixed
```
public void setMixed(java.lang.Boolean isMixed)
```
    Specify if this run should be made in mixed mode
  - setTestNGVersion
```
@Deprecated
public static void setTestNGVersion()
```
    Deprecated. The TestNG version is now established at load time. This method is not required anymore and is now a no-op.
  - isJdk14
```
@Deprecated
public static boolean isJdk14()
```
    Deprecated.
    
    Returns true if this is the JDK 1.4 JAR version of TestNG, false otherwise.
    
    Returns:
    
    true if this is the JDK 1.4 JAR version of TestNG, false otherwise.
  - validateCommandLineParameters
```
protected static void validateCommandLineParameters(CommandLineArgs args)
```
    Double check that the command line parameters are valid.
  - hasFailure
```
public boolean hasFailure()
```
    Returns:
    
    true if at least one test failed.
  - hasFailureWithinSuccessPercentage
```
public boolean hasFailureWithinSuccessPercentage()
```
    Returns:
    
    true if at least one test failed within success percentage.
  - hasSkip
```
public boolean hasSkip()
```
    Returns:
    
    true if at least one test was skipped.
  - getOutputDirectory
```
public java.lang.String getOutputDirectory()
```
  - getAnnotationTransformer
```
public IAnnotationTransformer getAnnotationTransformer()
```
  - setAnnotationTransformer
```
@Deprecated
public void setAnnotationTransformer(IAnnotationTransformer t)
```
    Deprecated. Use addListener(ITestNGListener) instead
  - getDefaultSuiteName
```
public java.lang.String getDefaultSuiteName()
```
    Returns:
    
    the defaultSuiteName
  - setDefaultSuiteName
```
public void setDefaultSuiteName(java.lang.String defaultSuiteName)
```
    Parameters:
    
    defaultSuiteName - the defaultSuiteName to set
  - getDefaultTestName
```
public java.lang.String getDefaultTestName()
```
    Returns:
    
    the defaultTestName
  - setDefaultTestName
```
public void setDefaultTestName(java.lang.String defaultTestName)
```
    Parameters:
    
    defaultTestName - the defaultTestName to set
  - setConfigFailurePolicy
```
public void setConfigFailurePolicy(XmlSuite.FailurePolicy failurePolicy)
```
    Sets the policy for whether or not to ever invoke a configuration method again after it has failed once. Possible values are defined in XmlSuite. The default value is XmlSuite.FailurePolicy.SKIP
    
    Parameters:
    
    failurePolicy - the configuration failure policy
  - setConfigFailurePolicy
```
@Deprecated
public void setConfigFailurePolicy(java.lang.String failurePolicy)
```
    Deprecated. Use setConfigFailurePolicy(org.testng.xml.XmlSuite.FailurePolicy) instead
  - getConfigFailurePolicy
```
public XmlSuite.FailurePolicy getConfigFailurePolicy()
```
    Returns the configuration failure policy.
    
    Returns:
    
    config failure policy
  - getDefault
```
@Deprecated
public static TestNG getDefault()
```
    Deprecated. since 5.1
  - setMethodInterceptor
```
public void setMethodInterceptor(IMethodInterceptor methodInterceptor)
```
  - setDataProviderThreadCount
```
public void setDataProviderThreadCount(int count)
```
  - addClassLoader
```
public void addClassLoader(java.lang.ClassLoader loader)
```
    Add a class loader to the searchable loaders.
  - setPreserveOrder
```
public void setPreserveOrder(boolean b)
```
  - getStart
```
protected long getStart()
```
  - getEnd
```
protected long getEnd()
```
  - setGroupByInstances
```
public void setGroupByInstances(boolean b)
```
  - setServiceLoaderClassLoader
```
public void setServiceLoaderClassLoader(java.net.URLClassLoader ucl)
```
  - getServiceLoaderListeners
```
public java.util.List<ITestNGListener> getServiceLoaderListeners()
```

Class TestNG

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_COMMAND_LINE_SUITE_NAME

DEFAULT_COMMAND_LINE_TEST_NAME

DEFAULT_OUTPUTDIR

SHOW_TESTNG_STACK_FRAMES

TEST_CLASSPATH

m_suites

m_useDefaultListeners

DEFAULT_VERBOSE

m_end

m_start

Constructor Detail

TestNG

TestNG

Method Detail

getStatus

setOutputDirectory

setUseDefaultListeners

setTestJar

setXmlPathInJar

initializeSuitesAndJarFile

setThreadCount

setParallel

setParallel

setCommandLineSuite

setTestClasses

addMethodSelector

addMethodSelector

setTestSuites

setXmlSuites

setExcludedGroups

setGroups

setTestRunnerFactory

setObjectFactory

setObjectFactory

setListenerClasses

addListener

addListener

addListener

addListener

addListener

addListener

addListener

addInvokedMethodListener

getReporters

getTestListeners

getSuiteListeners

setVerbose

initializeEverything

run

runSuites

addAlterSuiteListener

addExecutionListener

runSuitesLocally

getConfiguration

main

privateMain

configure

setSuiteThreadPoolSize

getSuiteThreadPoolSize

setRandomizeSuites

setSourcePath

configure

setTestNames

setSkipFailedInvocationCounts

setJUnit

setMixed

setTestNGVersion

isJdk14

validateCommandLineParameters

hasFailure

hasFailureWithinSuccessPercentage

hasSkip

getOutputDirectory