Package org.testng.xml
Class XmlTest
- java.lang.Object
-
- org.testng.xml.XmlTest
-
- All Implemented Interfaces:
java.lang.Cloneable
public class XmlTest extends java.lang.Object implements java.lang.Cloneable
This class describes the tag <test> in testng.xml.
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_TIMEOUT_MS
private java.lang.Boolean
m_allowReturnValues
private java.util.Map<java.lang.String,java.util.List<java.lang.Integer>>
m_failedInvocationNumbers
private java.lang.Boolean
m_groupByInstances
private int
m_index
private java.lang.Boolean
m_isJUnit
private java.util.List<XmlMethodSelector>
m_methodSelectors
private java.lang.String
m_name
private XmlSuite.ParallelMode
m_parallel
private java.util.Map<java.lang.String,java.lang.String>
m_parameters
private java.lang.Boolean
m_preserveOrder
private java.lang.Boolean
m_skipFailedInvocationCounts
private XmlSuite
m_suite
private int
m_threadCount
private java.lang.String
m_timeOut
private java.lang.Integer
m_verbose
private java.util.List<XmlClass>
m_xmlClasses
private java.util.Map<java.lang.String,java.lang.String>
m_xmlDependencyGroups
private XmlGroups
m_xmlGroups
private java.util.List<XmlPackage>
m_xmlPackages
-
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
addMetaGroup(java.lang.String name, java.lang.String... metaGroup)
void
addMetaGroup(java.lang.String name, java.util.List<java.lang.String> metaGroup)
void
addParameter(java.lang.String key, java.lang.String value)
void
addXmlDependencyGroup(java.lang.String group, java.lang.String dependsOn)
java.lang.Object
clone()
Clone the sourceXmlTest
by including: - test attributes - groups definitions - parameters The <classes> sub element is ignored for the moment.boolean
equals(java.lang.Object obj)
java.lang.Boolean
getAllowReturnValues()
java.util.Map<java.lang.String,java.lang.String>
getAllParameters()
java.util.List<XmlClass>
getClasses()
java.util.List<java.lang.String>
getExcludedGroups()
java.lang.String
getExpression()
boolean
getGroupByInstances()
java.util.List<java.lang.String>
getIncludedGroups()
int
getIndex()
Note that this attribute does not come from the XML file, it's calculated internally and represents the order in which this test tag was found in its <suite> tag.java.util.List<java.lang.Integer>
getInvocationNumbers(java.lang.String method)
Convenience method to cache the ordering numbers for methods.java.util.Map<java.lang.String,java.lang.String>
getLocalParameters()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>
getMetaGroups()
java.util.List<XmlMethodSelector>
getMethodSelectors()
java.lang.String
getName()
java.util.List<XmlPackage>
getPackages()
XmlSuite.ParallelMode
getParallel()
java.lang.String
getParameter(java.lang.String name)
java.util.Map<java.lang.String,java.lang.String>
getParameters()
Deprecated.UsegetLocalParameters()
orgetAllParameters()
java.lang.Boolean
getPreserveOrder()
XmlSuite
getSuite()
Returns the suite this test is part of.java.util.Map<java.lang.String,java.lang.String>
getTestParameters()
Deprecated.UsegetLocalParameters()
insteadint
getThreadCount()
java.lang.String
getTimeOut()
long
getTimeOut(long def)
int
getVerbose()
java.util.List<XmlClass>
getXmlClasses()
java.util.Map<java.lang.String,java.lang.String>
getXmlDependencyGroups()
XmlGroups
getXmlGroups()
java.util.List<XmlPackage>
getXmlPackages()
int
hashCode()
private void
init(XmlSuite suite, int index)
boolean
isJUnit()
boolean
nameMatchesAny(java.util.List<java.lang.String> names)
void
setAllowReturnValues(java.lang.Boolean allowReturnValues)
void
setBeanShellExpression(java.lang.String expression)
void
setClasses(java.util.List<XmlClass> c)
void
setClassNames(java.util.List<XmlClass> classes)
Deprecated.use setXmlClassesvoid
setExcludedGroups(java.util.List<java.lang.String> g)
void
setExpression(java.lang.String expression)
void
setGroupByInstances(boolean f)
void
setGroups(XmlGroups xmlGroups)
void
setIncludedGroups(java.util.List<java.lang.String> g)
void
setJunit(boolean isJUnit)
void
setJUnit(boolean isJUnit)
void
setMetaGroups(java.util.Map<java.lang.String,java.util.List<java.lang.String>> metaGroups)
void
setMethodSelectors(java.util.List<XmlMethodSelector> methodSelectors)
void
setName(java.lang.String name)
void
setPackages(java.util.List<XmlPackage> p)
void
setParallel(XmlSuite.ParallelMode parallel)
void
setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
void
setPreserveOrder(java.lang.Boolean preserveOrder)
void
setPreserveOrder(java.lang.String preserveOrder)
Deprecated.UsesetPreserveOrder(Boolean)
insteadvoid
setSkipFailedInvocationCounts(boolean skip)
void
setSuite(XmlSuite result)
void
setThreadCount(int threadCount)
void
setTimeOut(long timeOut)
private void
setTimeOut(java.lang.String timeOut)
void
setVerbose(int v)
void
setXmlClasses(java.util.List<XmlClass> classes)
Sets the XML Classes.void
setXmlPackages(java.util.List<XmlPackage> packages)
void
setXmlSuite(XmlSuite suite)
boolean
skipFailedInvocationCounts()
java.lang.String
toXml(java.lang.String indent)
-
-
-
Field Detail
-
DEFAULT_TIMEOUT_MS
public static final int DEFAULT_TIMEOUT_MS
- See Also:
- Constant Field Values
-
m_suite
private XmlSuite m_suite
-
m_name
private java.lang.String m_name
-
m_verbose
private java.lang.Integer m_verbose
-
m_isJUnit
private java.lang.Boolean m_isJUnit
-
m_threadCount
private int m_threadCount
-
m_xmlClasses
private java.util.List<XmlClass> m_xmlClasses
-
m_parameters
private java.util.Map<java.lang.String,java.lang.String> m_parameters
-
m_parallel
private XmlSuite.ParallelMode m_parallel
-
m_methodSelectors
private java.util.List<XmlMethodSelector> m_methodSelectors
-
m_xmlPackages
private java.util.List<XmlPackage> m_xmlPackages
-
m_timeOut
private java.lang.String m_timeOut
-
m_skipFailedInvocationCounts
private java.lang.Boolean m_skipFailedInvocationCounts
-
m_failedInvocationNumbers
private java.util.Map<java.lang.String,java.util.List<java.lang.Integer>> m_failedInvocationNumbers
-
m_preserveOrder
private java.lang.Boolean m_preserveOrder
-
m_index
private int m_index
-
m_groupByInstances
private java.lang.Boolean m_groupByInstances
-
m_allowReturnValues
private java.lang.Boolean m_allowReturnValues
-
m_xmlDependencyGroups
private java.util.Map<java.lang.String,java.lang.String> m_xmlDependencyGroups
-
m_xmlGroups
private XmlGroups m_xmlGroups
-
-
Method Detail
-
init
private void init(XmlSuite suite, int index)
-
setXmlPackages
public void setXmlPackages(java.util.List<XmlPackage> packages)
-
getXmlPackages
public java.util.List<XmlPackage> getXmlPackages()
-
getPackages
public java.util.List<XmlPackage> getPackages()
-
setPackages
public void setPackages(java.util.List<XmlPackage> p)
-
getMethodSelectors
public java.util.List<XmlMethodSelector> getMethodSelectors()
-
setMethodSelectors
public void setMethodSelectors(java.util.List<XmlMethodSelector> methodSelectors)
-
getSuite
public XmlSuite getSuite()
Returns the suite this test is part of.- Returns:
- the suite this test is part of.
-
getIncludedGroups
public java.util.List<java.lang.String> getIncludedGroups()
- Returns:
- the includedGroups.
-
setClassNames
@Deprecated public void setClassNames(java.util.List<XmlClass> classes)
Deprecated.use setXmlClassesSets the XML Classes.- Parameters:
classes
- The classes to set.
-
getXmlClasses
public java.util.List<XmlClass> getXmlClasses()
- Returns:
- Returns the classes.
-
getClasses
public java.util.List<XmlClass> getClasses()
-
setClasses
public void setClasses(java.util.List<XmlClass> c)
-
setXmlClasses
public void setXmlClasses(java.util.List<XmlClass> classes)
Sets the XML Classes.- Parameters:
classes
- The classes to set.
-
getName
public java.lang.String getName()
- Returns:
- Returns the name.
-
setName
public void setName(java.lang.String name)
- Parameters:
name
- The name to set.
-
setVerbose
public void setVerbose(int v)
- Parameters:
v
- - Verbosity level.
-
getThreadCount
public int getThreadCount()
-
setThreadCount
public void setThreadCount(int threadCount)
-
setIncludedGroups
public void setIncludedGroups(java.util.List<java.lang.String> g)
-
setExcludedGroups
public void setExcludedGroups(java.util.List<java.lang.String> g)
-
getExcludedGroups
public java.util.List<java.lang.String> getExcludedGroups()
-
addIncludedGroup
public void addIncludedGroup(java.lang.String g)
-
addExcludedGroup
public void addExcludedGroup(java.lang.String g)
-
getVerbose
public int getVerbose()
- Returns:
- Returns the verbose.
-
getGroupByInstances
public boolean getGroupByInstances()
-
setGroupByInstances
public void setGroupByInstances(boolean f)
-
isJUnit
public boolean isJUnit()
- Returns:
- Returns the isJUnit.
-
setJUnit
public void setJUnit(boolean isJUnit)
- Parameters:
isJUnit
- The isJUnit to set.
-
setJunit
public void setJunit(boolean isJUnit)
-
setSkipFailedInvocationCounts
public void setSkipFailedInvocationCounts(boolean skip)
-
skipFailedInvocationCounts
public boolean skipFailedInvocationCounts()
- Returns:
- Returns the isJUnit.
-
addMetaGroup
public void addMetaGroup(java.lang.String name, java.util.List<java.lang.String> metaGroup)
-
addMetaGroup
public void addMetaGroup(java.lang.String name, java.lang.String... metaGroup)
-
setMetaGroups
public void setMetaGroups(java.util.Map<java.lang.String,java.util.List<java.lang.String>> metaGroups)
-
getMetaGroups
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getMetaGroups()
- Returns:
- Returns the metaGroups.
-
setParameters
public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
- Parameters:
parameters
- - AMap
of parameters.
-
addParameter
public void addParameter(java.lang.String key, java.lang.String value)
-
getParameter
public java.lang.String getParameter(java.lang.String name)
-
getAllParameters
public java.util.Map<java.lang.String,java.lang.String> getAllParameters()
- Returns:
- the parameters defined in this test tag and the tags above it.
-
getLocalParameters
public java.util.Map<java.lang.String,java.lang.String> getLocalParameters()
- Returns:
- the parameters defined in this tag, and only this test tag. To retrieve
the inherited parameters as well, call
getAllParameters()
.
-
getParameters
@Deprecated public java.util.Map<java.lang.String,java.lang.String> getParameters()
Deprecated.UsegetLocalParameters()
orgetAllParameters()
-
getTestParameters
@Deprecated public java.util.Map<java.lang.String,java.lang.String> getTestParameters()
Deprecated.UsegetLocalParameters()
instead- Returns:
- the parameters defined on this
tag only
-
setParallel
public void setParallel(XmlSuite.ParallelMode parallel)
-
getParallel
public XmlSuite.ParallelMode getParallel()
-
getTimeOut
public java.lang.String getTimeOut()
-
getTimeOut
public long getTimeOut(long def)
-
setTimeOut
public void setTimeOut(long timeOut)
-
setTimeOut
private void setTimeOut(java.lang.String timeOut)
-
setExpression
public void setExpression(java.lang.String expression)
-
setBeanShellExpression
public void setBeanShellExpression(java.lang.String expression)
-
getExpression
public java.lang.String getExpression()
-
toXml
public java.lang.String toXml(java.lang.String indent)
-
clone
public java.lang.Object clone()
Clone the sourceXmlTest
by including: - test attributes - groups definitions - parameters The <classes> sub element is ignored for the moment.- Overrides:
clone
in classjava.lang.Object
- Returns:
- a clone of the current XmlTest
-
getInvocationNumbers
public java.util.List<java.lang.Integer> getInvocationNumbers(java.lang.String method)
Convenience method to cache the ordering numbers for methods.
-
setPreserveOrder
@Deprecated public void setPreserveOrder(java.lang.String preserveOrder)
Deprecated.UsesetPreserveOrder(Boolean)
instead
-
setPreserveOrder
public void setPreserveOrder(java.lang.Boolean preserveOrder)
-
getPreserveOrder
public java.lang.Boolean getPreserveOrder()
-
setSuite
public void setSuite(XmlSuite result)
-
getAllowReturnValues
public java.lang.Boolean getAllowReturnValues()
-
setAllowReturnValues
public void setAllowReturnValues(java.lang.Boolean allowReturnValues)
-
getIndex
public int getIndex()
Note that this attribute does not come from the XML file, it's calculated internally and represents the order in which this test tag was found in its <suite> tag. It's used to calculate the ordering of the tests when preserve-test-order is true.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
addXmlDependencyGroup
public void addXmlDependencyGroup(java.lang.String group, java.lang.String dependsOn)
-
getXmlDependencyGroups
public java.util.Map<java.lang.String,java.lang.String> getXmlDependencyGroups()
-
setXmlSuite
public void setXmlSuite(XmlSuite suite)
-
setGroups
public void setGroups(XmlGroups xmlGroups)
-
getXmlGroups
public XmlGroups getXmlGroups()
-
nameMatchesAny
public boolean nameMatchesAny(java.util.List<java.lang.String> names)
- Parameters:
names
- The list of names to check.- Returns:
true
if the current test's name matches with any of the given names.
-
-