Package org.testng.xml

Class 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.

    • Constructor Detail

      • XmlTest

        public XmlTest​(XmlSuite suite,
               int index)
        Constructs a XmlTest and adds it to suite's list of tests.
        Parameters:
        suite - the parent suite.
        index - the index of this test tag in testng.xml

      • XmlTest

        public XmlTest​(XmlSuite suite)

      • XmlTest

        public XmlTest()

    • Method Detail

      • 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)

      • setMethodSelectors

        public void setMethodSelectors​(java.util.List<XmlMethodSelector> methodSelectors)

      • getSuite

        public final 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.

      • isGroupFilteringDisabled

        public boolean isGroupFilteringDisabled()

      • 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 - - A Map 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().

      • getTimeOut

        public java.lang.String getTimeOut()

      • getTimeOut

        public long getTimeOut​(long def)

      • setTimeOut

        public void setTimeOut​(long timeOut)

      • setScript

        public void setScript​(XmlScript script)

      • toXml

        public java.lang.String toXml​(java.lang.String indent)

      • clone

        public java.lang.Object clone()
        Clone the source XmlTest by including: - test attributes - groups definitions - parameters

        The <classes> sub element is ignored for the moment.

        Overrides:
        clone in class java.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.
        Parameters:
        method - The method name
        Returns:
        The invocation numbers of the method

      • 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.
        Returns:
        The value

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.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()

      • setXmlDependencyGroups

        public void setXmlDependencyGroups​(java.util.Map<java.lang.String,​java.lang.String> xmlDependencyGroups)

      • 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.

      • isGroupBasedExecution

        public static boolean isGroupBasedExecution​(XmlTest xmlTest)
        Parameters:
        xmlTest - - The XmlTest that represents the current test
        Returns:
        - true if group based selection was employed and false otherwise.