Package org.testng.xml
Class XmlSuite
- java.lang.Object
-
- org.testng.xml.XmlSuite
-
- All Implemented Interfaces:
java.lang.Cloneable
public class XmlSuite extends java.lang.Object implements java.lang.Cloneable
This class describes the tag <suite> in testng.xml.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
XmlSuite.FailurePolicy
Configuration failure policy options.static class
XmlSuite.ParallelMode
Parallel modes.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.Boolean
DEFAULT_ALLOW_RETURN_VALUES
static XmlSuite.FailurePolicy
DEFAULT_CONFIG_FAILURE_POLICY
Whether to SKIP or CONTINUE to re-attempt failed configuration methods.static java.lang.Integer
DEFAULT_DATA_PROVIDER_THREAD_COUNT
Thread count for the data provider pool.static java.lang.Boolean
DEFAULT_GROUP_BY_INSTANCES
By default, a method failing will cause all instances of that class to skip.static java.lang.Boolean
DEFAULT_JUNIT
JUnit compatibility flag.static java.lang.Boolean
DEFAULT_MIXED
Mixed mode flag.static XmlSuite.ParallelMode
DEFAULT_PARALLEL
static java.lang.Boolean
DEFAULT_PRESERVE_ORDER
static java.lang.Boolean
DEFAULT_SKIP_FAILED_INVOCATION_COUNTS
static java.lang.Integer
DEFAULT_THREAD_COUNT
The thread count.static java.lang.Integer
DEFAULT_VERBOSE
The suite verbose flag (0 to 10).
-
Constructor Summary
Constructors Constructor Description XmlSuite()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addExcludedGroup(java.lang.String g)
void
addIncludedGroup(java.lang.String g)
void
addListener(java.lang.String listener)
void
addTest(XmlTest test)
java.lang.Object
clone()
Note that this is not a full clone: XmlTest children are not cloned by this method.boolean
equals(java.lang.Object obj)
java.lang.Boolean
getAllowReturnValues()
java.util.Map<java.lang.String,java.lang.String>
getAllParameters()
java.util.List<XmlSuite>
getChildSuites()
XmlSuite.FailurePolicy
getConfigFailurePolicy()
Returns the configuration failure policy.int
getDataProviderThreadCount()
java.util.List<java.lang.String>
getExcludedGroups()
java.lang.String
getFileName()
java.lang.Boolean
getGroupByInstances()
XmlGroups
getGroups()
java.lang.String
getGuiceStage()
java.util.List<java.lang.String>
getIncludedGroups()
java.util.List<java.lang.String>
getListeners()
java.util.List<java.lang.String>
getLocalListeners()
java.util.List<XmlMethodSelector>
getMethodSelectors()
Returns the method selectors.java.lang.String
getName()
Returns the name.ITestObjectFactory
getObjectFactory()
Deprecated.- This method stands deprecated as of TestNG7.5.0
.java.lang.Class<? extends ITestObjectFactory>
getObjectFactoryClass()
java.util.Collection<java.lang.String>
getPackageNames()
java.util.List<XmlPackage>
getPackages()
XmlSuite.ParallelMode
getParallel()
Returns the parallel mode.java.lang.String
getParameter(java.lang.String name)
Returns the parameter defined in this suite only.java.util.Map<java.lang.String,java.lang.String>
getParameters()
java.lang.String
getParentModule()
XmlSuite
getParentSuite()
java.lang.Boolean
getPreserveOrder()
java.util.List<java.lang.String>
getSuiteFiles()
Returns the suite files.java.lang.String
getTest()
Returns the test.java.util.List<XmlTest>
getTests()
Returns the tests.int
getThreadCount()
java.lang.String
getTimeOut()
Returns the timeout.long
getTimeOut(long def)
Returns the timeout as a long value specifying the default value to be used if no timeout was specified.java.lang.Integer
getVerbose()
Returns the verbose.XmlMethodSelectors
getXmlMethodSelectors()
java.util.List<XmlPackage>
getXmlPackages()
Returns the XML packages.int
hashCode()
java.lang.Boolean
isJUnit()
boolean
isParsed()
void
onListenerElement(java.lang.String className)
void
onMethodSelectorElement(java.lang.String language, java.lang.String name, java.lang.String priority)
void
onPackagesElement(java.lang.String name)
void
onParameterElement(java.lang.String name, java.lang.String value)
void
onSuiteFilesElement(java.lang.String path)
void
setAllowReturnValues(java.lang.Boolean allowReturnValues)
void
setConfigFailurePolicy(XmlSuite.FailurePolicy configFailurePolicy)
Sets the configuration failure policy.void
setDataProviderThreadCount(int count)
void
setExcludedGroups(java.util.List<java.lang.String> g)
void
setFileName(java.lang.String fileName)
void
setGroupByInstances(boolean f)
void
setGroups(XmlGroups xmlGroups)
void
setGuiceStage(java.lang.String guiceStage)
void
setIncludedGroups(java.util.List<java.lang.String> g)
void
setJunit(java.lang.Boolean j)
void
setJUnit(java.lang.Boolean isJUnit)
Sets the JUnit compatibility flag.void
setListeners(java.util.List<java.lang.String> listeners)
void
setMethodSelectors(java.util.List<XmlMethodSelector> methodSelectors)
Sets the method selectors.void
setMethodSelectors(XmlMethodSelectors xms)
void
setName(java.lang.String name)
Sets the name.void
setObjectFactory(ITestObjectFactory objectFactory)
Deprecated.void
setObjectFactoryClass(java.lang.Class<? extends ITestObjectFactory> objectFactoryClass)
void
setPackages(java.util.List<XmlPackage> packages)
void
setParallel(XmlSuite.ParallelMode parallel)
Sets the parallel mode.void
setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
Sets parameters.void
setParentModule(java.lang.String parentModule)
void
setParentSuite(XmlSuite parentSuite)
void
setParsed(boolean parsed)
void
setPreserveOrder(java.lang.Boolean f)
void
setSkipFailedInvocationCounts(boolean skip)
void
setSuiteFiles(java.util.List<java.lang.String> files)
Sets the suite files.void
setTests(java.util.List<XmlTest> tests)
void
setThreadCount(int threadCount)
Set the thread count.void
setTimeOut(java.lang.String timeOut)
Sets the timeout.void
setVerbose(java.lang.Integer verbose)
Set the verbose.void
setXmlMethodSelectors(XmlMethodSelectors xms)
void
setXmlPackages(java.util.List<XmlPackage> packages)
Sets the XML packages.XmlSuite
shallowCopy()
This method returns a shallow cloned version.java.lang.Boolean
skipFailedInvocationCounts()
java.lang.String
toString()
java.lang.String
toXml()
-
-
-
Field Detail
-
DEFAULT_VERBOSE
public static final java.lang.Integer DEFAULT_VERBOSE
The suite verbose flag (0 to 10).
-
DEFAULT_PARALLEL
public static final XmlSuite.ParallelMode DEFAULT_PARALLEL
-
DEFAULT_CONFIG_FAILURE_POLICY
public static final XmlSuite.FailurePolicy DEFAULT_CONFIG_FAILURE_POLICY
Whether to SKIP or CONTINUE to re-attempt failed configuration methods.
-
DEFAULT_JUNIT
public static final java.lang.Boolean DEFAULT_JUNIT
JUnit compatibility flag.
-
DEFAULT_MIXED
public static final java.lang.Boolean DEFAULT_MIXED
Mixed mode flag.
-
DEFAULT_SKIP_FAILED_INVOCATION_COUNTS
public static final java.lang.Boolean DEFAULT_SKIP_FAILED_INVOCATION_COUNTS
-
DEFAULT_THREAD_COUNT
public static final java.lang.Integer DEFAULT_THREAD_COUNT
The thread count.
-
DEFAULT_DATA_PROVIDER_THREAD_COUNT
public static final java.lang.Integer DEFAULT_DATA_PROVIDER_THREAD_COUNT
Thread count for the data provider pool.
-
DEFAULT_GROUP_BY_INSTANCES
public static final java.lang.Boolean DEFAULT_GROUP_BY_INSTANCES
By default, a method failing will cause all instances of that class to skip.
-
DEFAULT_ALLOW_RETURN_VALUES
public static final java.lang.Boolean DEFAULT_ALLOW_RETURN_VALUES
-
DEFAULT_PRESERVE_ORDER
public static final java.lang.Boolean DEFAULT_PRESERVE_ORDER
-
-
Method Detail
-
setParsed
public void setParsed(boolean parsed)
-
isParsed
public boolean isParsed()
- Returns:
- -
true
if the currentXmlSuite
has already been parsed.
-
getFileName
public java.lang.String getFileName()
- Returns:
- The fileName.
-
setFileName
public void setFileName(java.lang.String fileName)
- Parameters:
fileName
- The fileName to set.
-
getParallel
public XmlSuite.ParallelMode getParallel()
Returns the parallel mode.- Returns:
- The parallel mode.
-
getParentModule
public java.lang.String getParentModule()
-
getGuiceStage
public java.lang.String getGuiceStage()
-
getObjectFactory
@Deprecated public ITestObjectFactory getObjectFactory()
Deprecated.- This method stands deprecated as of TestNG7.5.0
. UsegetObjectFactoryClass()
instead.- Returns:
- - A
ITestObjectFactory
instance.
-
getObjectFactoryClass
public java.lang.Class<? extends ITestObjectFactory> getObjectFactoryClass()
-
setObjectFactory
@Deprecated public void setObjectFactory(ITestObjectFactory objectFactory)
Deprecated.
-
setObjectFactoryClass
public void setObjectFactoryClass(java.lang.Class<? extends ITestObjectFactory> objectFactoryClass)
-
setParallel
public void setParallel(XmlSuite.ParallelMode parallel)
Sets the parallel mode.- Parameters:
parallel
- The parallel mode.
-
setParentModule
public void setParentModule(java.lang.String parentModule)
-
setGuiceStage
public void setGuiceStage(java.lang.String guiceStage)
-
setConfigFailurePolicy
public void setConfigFailurePolicy(XmlSuite.FailurePolicy configFailurePolicy)
Sets the configuration failure policy.- Parameters:
configFailurePolicy
- The config failure policy.
-
getConfigFailurePolicy
public XmlSuite.FailurePolicy getConfigFailurePolicy()
Returns the configuration failure policy.- Returns:
- The configuration failure policy.
-
getVerbose
public java.lang.Integer getVerbose()
Returns the verbose.- Returns:
- The verbose.
-
setVerbose
public void setVerbose(java.lang.Integer verbose)
Set the verbose.- Parameters:
verbose
- The verbose to set.
-
getName
public java.lang.String getName()
Returns the name.- Returns:
- The name.
-
setName
public void setName(java.lang.String name)
Sets the name.- Parameters:
name
- The name to set.
-
getTest
public java.lang.String getTest()
Returns the test.- Returns:
- The test.
-
getTests
public java.util.List<XmlTest> getTests()
Returns the tests.- Returns:
- The tests.
-
setTests
public void setTests(java.util.List<XmlTest> tests)
-
getMethodSelectors
public java.util.List<XmlMethodSelector> getMethodSelectors()
Returns the method selectors.- Returns:
- The method selectors.
-
setMethodSelectors
public void setMethodSelectors(java.util.List<XmlMethodSelector> methodSelectors)
Sets the method selectors.- Parameters:
methodSelectors
- The method selectors.
-
setParameters
public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
Sets parameters.- Parameters:
parameters
- The parameters.
-
getParameters
public java.util.Map<java.lang.String,java.lang.String> getParameters()
- Returns:
- the parameters that apply to tests in this suite.
The set of parameters for a suite is appended with parameters from the parent suite. Also, parameters from this suite override the same named parameters from the parent suite.
-
getAllParameters
public java.util.Map<java.lang.String,java.lang.String> getAllParameters()
- Returns:
- The parameters defined in this suite and all its XmlTests.
-
getParameter
public java.lang.String getParameter(java.lang.String name)
Returns the parameter defined in this suite only.- Parameters:
name
- The parameter name.- Returns:
- The parameter defined in this suite only.
-
getThreadCount
public int getThreadCount()
- Returns:
- The threadCount.
-
setThreadCount
public void setThreadCount(int threadCount)
Set the thread count.- Parameters:
threadCount
- The thread count to set.
-
isJUnit
public java.lang.Boolean isJUnit()
- Returns:
- The JUnit compatibility flag.
-
setJUnit
public void setJUnit(java.lang.Boolean isJUnit)
Sets the JUnit compatibility flag.- Parameters:
isJUnit
- The JUnit compatibility flag.
-
setJunit
public void setJunit(java.lang.Boolean j)
-
skipFailedInvocationCounts
public java.lang.Boolean skipFailedInvocationCounts()
-
setSkipFailedInvocationCounts
public void setSkipFailedInvocationCounts(boolean skip)
-
setXmlPackages
public void setXmlPackages(java.util.List<XmlPackage> packages)
Sets the XML packages.- Parameters:
packages
- The XML packages.
-
getXmlPackages
public java.util.List<XmlPackage> getXmlPackages()
Returns the XML packages.- Returns:
- The XML packages.
-
getPackages
public java.util.List<XmlPackage> getPackages()
-
setMethodSelectors
public void setMethodSelectors(XmlMethodSelectors xms)
-
setPackages
public void setPackages(java.util.List<XmlPackage> packages)
-
toXml
public java.lang.String toXml()
- Returns:
- A String representation of this XML suite.
-
getLocalListeners
public java.util.List<java.lang.String> getLocalListeners()
- Returns:
- - The list of listener names that are local to the current <suite>.
-
setXmlMethodSelectors
public void setXmlMethodSelectors(XmlMethodSelectors xms)
-
getXmlMethodSelectors
public XmlMethodSelectors getXmlMethodSelectors()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
clone
public java.lang.Object clone()
Note that this is not a full clone: XmlTest children are not cloned by this method.- Overrides:
clone
in classjava.lang.Object
-
shallowCopy
public XmlSuite shallowCopy()
This method returns a shallow cloned version.XmlTest
s are not copied by this method.- Returns:
- - A shallow copied version of
XmlSuite
.
-
setTimeOut
public void setTimeOut(java.lang.String timeOut)
Sets the timeout.- Parameters:
timeOut
- The timeout.
-
getTimeOut
public java.lang.String getTimeOut()
Returns the timeout.- Returns:
- The timeout.
-
getTimeOut
public long getTimeOut(long def)
Returns the timeout as a long value specifying the default value to be used if no timeout was specified.- Parameters:
def
- The default value to be used if no timeout was specified.- Returns:
- The timeout as a long value specifying the default value to be used if no timeout was specified.
-
setSuiteFiles
public void setSuiteFiles(java.util.List<java.lang.String> files)
Sets the suite files.- Parameters:
files
- The suite files.
-
getSuiteFiles
public java.util.List<java.lang.String> getSuiteFiles()
Returns the suite files.- Returns:
- The suite files.
-
setListeners
public void setListeners(java.util.List<java.lang.String> listeners)
-
getListeners
public java.util.List<java.lang.String> getListeners()
-
setDataProviderThreadCount
public void setDataProviderThreadCount(int count)
-
getDataProviderThreadCount
public int getDataProviderThreadCount()
-
setParentSuite
public void setParentSuite(XmlSuite parentSuite)
-
getParentSuite
public XmlSuite getParentSuite()
-
getChildSuites
public java.util.List<XmlSuite> getChildSuites()
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
setPreserveOrder
public void setPreserveOrder(java.lang.Boolean f)
-
getPreserveOrder
public java.lang.Boolean getPreserveOrder()
-
getIncludedGroups
public java.util.List<java.lang.String> getIncludedGroups()
- Returns:
- Returns the includedGroups. Note: do not modify the returned value, use
addIncludedGroup(String)
.
-
addIncludedGroup
public void addIncludedGroup(java.lang.String g)
-
setIncludedGroups
public void setIncludedGroups(java.util.List<java.lang.String> g)
- Parameters:
g
- - The list of groups to include.
-
setExcludedGroups
public void setExcludedGroups(java.util.List<java.lang.String> g)
- Parameters:
g
- The excludedGrousps to set.
-
getExcludedGroups
public java.util.List<java.lang.String> getExcludedGroups()
- Returns:
- Returns the excludedGroups. Note: do not modify the returned value, use
addExcludedGroup(String)
.
-
addExcludedGroup
public void addExcludedGroup(java.lang.String g)
-
getGroupByInstances
public java.lang.Boolean getGroupByInstances()
-
setGroupByInstances
public void setGroupByInstances(boolean f)
-
addListener
public void addListener(java.lang.String listener)
-
getAllowReturnValues
public java.lang.Boolean getAllowReturnValues()
-
setAllowReturnValues
public void setAllowReturnValues(java.lang.Boolean allowReturnValues)
-
setGroups
public void setGroups(XmlGroups xmlGroups)
-
onParameterElement
public void onParameterElement(java.lang.String name, java.lang.String value)
-
onListenerElement
public void onListenerElement(java.lang.String className)
-
onSuiteFilesElement
public void onSuiteFilesElement(java.lang.String path)
-
onPackagesElement
public void onPackagesElement(java.lang.String name)
-
onMethodSelectorElement
public void onMethodSelectorElement(java.lang.String language, java.lang.String name, java.lang.String priority)
-
getGroups
public XmlGroups getGroups()
-
addTest
public void addTest(XmlTest test)
-
getPackageNames
public java.util.Collection<java.lang.String> getPackageNames()
-
-