|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.testng.TestNG
public class TestNG
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:
usage()
Nested Class Summary | |
---|---|
static class |
TestNG.ExitCodeListener
|
Field Summary | |
---|---|
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. |
static int |
HAS_FAILURE
|
static int |
HAS_FSP
|
static int |
HAS_NO_TEST
|
static int |
HAS_SKIPPED
|
static java.lang.String |
JAVADOC_ANNOTATION_TYPE
The JavaDoc annotation type ID ("javadoc"). |
static java.lang.String |
JDK_ANNOTATION_TYPE
The JDK50 annotation type ID ("JDK5"). |
protected java.util.List<XmlSuite> |
m_cmdlineSuites
|
protected java.lang.String[] |
m_excludedGroups
|
protected boolean |
m_hasTests
|
protected java.lang.String[] |
m_includedGroups
|
protected java.util.List<IInvokedMethodListener> |
m_invokedMethodListeners
|
protected IAnnotationFinder |
m_javadocAnnotationFinder
|
protected IAnnotationFinder |
m_jdkAnnotationFinder
|
protected java.lang.String |
m_outputDir
|
protected java.lang.String[] |
m_sourceDirs
The source directories as set by setSourcePath (or testng-sourcedir-override.properties). |
protected int |
m_status
|
protected java.util.List<ISuiteListener> |
m_suiteListeners
|
protected java.util.List<XmlSuite> |
m_suites
|
protected java.util.List<ITestListener> |
m_testListeners
|
protected ITestRunnerFactory |
m_testRunnerFactory
|
protected boolean |
m_useDefaultListeners
|
static java.lang.String |
SRC_SEPARATOR
A separator constant (semi-colon). |
Constructor Summary | |
---|---|
TestNG()
Default constructor. |
|
TestNG(boolean useDefaultListeners)
Used by maven2 to have 0 output of any kind come out of testng. |
Method Summary | |
---|---|
void |
addInvokedMethodListener(IInvokedMethodListener listener)
|
void |
addListener(IInvokedMethodListener listener)
|
void |
addListener(IReporter listener)
|
void |
addListener(ISuiteListener listener)
|
void |
addListener(ITestListener listener)
|
void |
addListener(java.lang.Object listener)
|
void |
addMethodSelector(java.lang.String className,
int priority)
|
protected static java.util.Map |
checkConditions(java.util.Map params)
Checks TestNG preconditions. |
void |
configure(java.util.Map cmdLineArgs)
Configure the TestNG instance by reading the settings provided in the map. |
protected SuiteRunner |
createAndRunSuiteRunners(XmlSuite xmlSuite)
|
IAnnotationTransformer |
getAnnotationTransformer()
|
static TestNG |
getDefault()
Deprecated. since 5.1 |
java.lang.String |
getDefaultSuiteName()
|
java.lang.String |
getDefaultTestName()
|
java.lang.String |
getOutputDirectory()
|
java.util.List<IReporter> |
getReporters()
|
boolean |
getSkipFailedInvocationCounts()
|
int |
getStatus()
|
java.util.List<ISuiteListener> |
getSuiteListeners()
|
java.util.List<ITestListener> |
getTestListeners()
|
boolean |
hasFailure()
|
boolean |
hasFailureWithinSuccessPercentage()
|
boolean |
hasSkip()
|
void |
initializeSuitesAndJarFile()
|
static boolean |
isJdk14()
Returns true if this is the JDK 1.4 JAR version of TestNG, false otherwise. |
static void |
main(java.lang.String[] argv)
The TestNG entry point for command line execution. |
static TestNG |
privateMain(java.lang.String[] argv,
ITestListener listener)
|
void |
run()
Run TestNG. |
java.util.List<ISuite> |
runSuitesLocally()
This needs to be public for maven2, for now..At least until an alternative mechanism is found. |
void |
setAnnotations(java.lang.String annotationType)
Sets the default annotation type for suites that have not explicitly set the annotation property. |
void |
setAnnotationTransformer(IAnnotationTransformer t)
|
void |
setCommandLineSuite(XmlSuite suite)
|
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 |
setGroups(java.lang.String groups)
Define which groups will be included from this run. |
void |
setHasFailure(boolean hasFailure)
Deprecated. since 5.1 |
void |
setHasFailureWithinSuccessPercentage(boolean hasFailureWithinSuccessPercentage)
Deprecated. since 5.1 |
void |
setHasSkip(boolean hasSkip)
Deprecated. since 5.1 |
void |
setJUnit(java.lang.Boolean isJUnit)
Specify if this run should be made in JUnit mode |
void |
setListenerClasses(java.util.List<java.lang.Class> classes)
Define which listeners to user for this run. |
void |
setMaster(java.lang.String fileName)
Specify if this run should be in Master-Slave mode as Master |
void |
setMethodInterceptor(IMethodInterceptor methodInterceptor)
|
void |
setObjectFactory(java.lang.Class c)
|
void |
setOutputDirectory(java.lang.String outputdir)
Sets the output directory where the reports will be created. |
void |
setParallel(java.lang.String parallel)
Define whether this run will be run in parallel mode. |
void |
setSkipFailedInvocationCounts(boolean skip)
|
void |
setSlave(java.lang.String fileName)
Specify if this run should be in Master-Slave mode as slave |
void |
setSourcePath(java.lang.String sourcePaths)
Sets the ; separated path of source directories. |
protected void |
setStatus(int status)
|
void |
setTarget(java.lang.String target)
Deprecated. use the setDefaultAnnotationType replacement method. |
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. |
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)
|
protected void |
setTestRunnerFactoryClass(java.lang.Class testRunnerFactoryClass)
|
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 |
setXmlSuites(java.util.List<XmlSuite> suites)
Specifies the XmlSuite objects to run. |
static void |
usage()
Prints the usage message to System.out. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_COMMAND_LINE_SUITE_NAME
public static final java.lang.String DEFAULT_COMMAND_LINE_TEST_NAME
public static final java.lang.String DEFAULT_OUTPUTDIR
public static final java.lang.String SRC_SEPARATOR
public static final java.lang.String JDK_ANNOTATION_TYPE
public static final java.lang.String JAVADOC_ANNOTATION_TYPE
protected java.util.List<XmlSuite> m_suites
protected java.util.List<XmlSuite> m_cmdlineSuites
protected java.lang.String m_outputDir
protected java.lang.String[] m_sourceDirs
protected IAnnotationFinder m_javadocAnnotationFinder
protected IAnnotationFinder m_jdkAnnotationFinder
protected java.lang.String[] m_includedGroups
protected java.lang.String[] m_excludedGroups
protected boolean m_useDefaultListeners
protected ITestRunnerFactory m_testRunnerFactory
protected java.util.List<ITestListener> m_testListeners
protected java.util.List<ISuiteListener> m_suiteListeners
public static final int HAS_FAILURE
public static final int HAS_SKIPPED
public static final int HAS_FSP
public static final int HAS_NO_TEST
protected int m_status
protected boolean m_hasTests
protected java.util.List<IInvokedMethodListener> m_invokedMethodListeners
Constructor Detail |
---|
public TestNG()
public TestNG(boolean useDefaultListeners)
useDefaultListeners
- Whether or not any default reports
should be added to tests.Method Detail |
---|
public int getStatus()
protected void setStatus(int status)
public void setOutputDirectory(java.lang.String outputdir)
outputdir
- The directory.public void setUseDefaultListeners(boolean useDefaultListeners)
org.testng.reporters.TestHTMLReporter
,
org.testng.reporters.JUnitXMLReporter
,
org.testng.reporters.XMLReporter
@Deprecated public void setTarget(java.lang.String target)
target
- the default annotation type. This is one of the two constants
(TestNG.JAVADOC_ANNOTATION_TYPE or TestNG.JDK_ANNOTATION_TYPE).
For backward compatibility reasons we accept "1.4", "1.5". Any other value will
default to TestNG.JDK_ANNOTATION_TYPE.public void setAnnotations(java.lang.String annotationType)
annotationType
- the default annotation type. This is one of the two constants
(TestNG.JAVADOC_ANNOTATION_TYPE or TestNG.JDK_ANNOTATION_TYPE).
For backward compatibility reasons we accept "1.4", "1.5". Any other value will
default to TestNG.JDK_ANNOTATION_TYPE.public void setSourcePath(java.lang.String sourcePaths)
sourcePaths
- a semi-colon separated list of source directories.public void setTestJar(java.lang.String jarPath)
jarPath
- public void initializeSuitesAndJarFile()
public void setThreadCount(int threadCount)
public void setParallel(java.lang.String parallel)
public void setCommandLineSuite(XmlSuite suite)
public void setTestClasses(java.lang.Class[] classes)
classes
- An array of classes that contain TestNG annotations.public void addMethodSelector(java.lang.String className, int priority)
public void setTestSuites(java.util.List<java.lang.String> suites)
suites
- A list of paths to one more XML files defining the tests. For example:
TestNG tng = new TestNG(); Listsuites = new ArrayList (); suites.add("c:/tests/testng1.xml"); suites.add("c:/tests/testng2.xml"); tng.setTestSuites(suites); tng.run();
public void setXmlSuites(java.util.List<XmlSuite> suites)
suites
- XmlSuite
public void setExcludedGroups(java.lang.String groups)
groups
- A list of group names separated by a comma.public void setGroups(java.lang.String groups)
groups
- A list of group names separated by a comma.protected void setTestRunnerFactoryClass(java.lang.Class testRunnerFactoryClass)
protected void setTestRunnerFactory(ITestRunnerFactory itrf)
public void setObjectFactory(java.lang.Class c)
public void setListenerClasses(java.util.List<java.lang.Class> classes)
classes
- A list of classes, which must be either ISuiteListener,
ITestListener or IReporterpublic void addListener(java.lang.Object listener)
public void addListener(IInvokedMethodListener listener)
public void addListener(ISuiteListener listener)
public void addListener(ITestListener listener)
public void addListener(IReporter listener)
public void addInvokedMethodListener(IInvokedMethodListener listener)
public java.util.List<IReporter> getReporters()
public java.util.List<ITestListener> getTestListeners()
public java.util.List<ISuiteListener> getSuiteListeners()
public void setVerbose(int verbose)
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).public void run()
public java.util.List<ISuite> runSuitesLocally()
protected SuiteRunner createAndRunSuiteRunners(XmlSuite xmlSuite)
public static void main(java.lang.String[] argv)
argv
- the TestNG command line parameters.public static TestNG privateMain(java.lang.String[] argv, ITestListener listener)
argv
- listener
-
public void configure(java.util.Map cmdLineArgs)
cmdLineArgs
- map of settingsfor setting keys
public void setMaster(java.lang.String fileName)
fileName
- remote.properties pathpublic void setSlave(java.lang.String fileName)
fileName
- remote.properties pathpublic void setJUnit(java.lang.Boolean isJUnit)
isJUnit
- @Deprecated public static void setTestNGVersion()
public static boolean isJdk14()
protected static java.util.Map checkConditions(java.util.Map params)
params
- the parsed command line parameters.public boolean hasFailure()
public boolean hasFailureWithinSuccessPercentage()
public boolean hasSkip()
public static void usage()
public java.lang.String getOutputDirectory()
public IAnnotationTransformer getAnnotationTransformer()
public boolean getSkipFailedInvocationCounts()
public void setSkipFailedInvocationCounts(boolean skip)
public void setAnnotationTransformer(IAnnotationTransformer t)
public java.lang.String getDefaultSuiteName()
public void setDefaultSuiteName(java.lang.String defaultSuiteName)
defaultSuiteName
- the defaultSuiteName to setpublic java.lang.String getDefaultTestName()
public void setDefaultTestName(java.lang.String defaultTestName)
defaultTestName
- the defaultTestName to set@Deprecated public static TestNG getDefault()
@Deprecated public void setHasFailure(boolean hasFailure)
@Deprecated public void setHasFailureWithinSuccessPercentage(boolean hasFailureWithinSuccessPercentage)
@Deprecated public void setHasSkip(boolean hasSkip)
public void setMethodInterceptor(IMethodInterceptor methodInterceptor)
public void setDataProviderThreadCount(int count)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |