Package org.testng.xml

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

    • Field Detail

      • m_test

        private java.lang.String m_test

      • DEFAULT_SUITE_NAME

        private static final java.lang.String DEFAULT_SUITE_NAME
        The default suite name TODO CQ is this OK as a default name.
        See Also:
        Constant Field Values

      • m_name

        private java.lang.String m_name
        The suite name (defaults to DEFAULT_SUITE_NAME).

      • DEFAULT_VERBOSE

        public static final java.lang.Integer DEFAULT_VERBOSE
        The suite verbose flag (0 to 10).

      • m_verbose

        private java.lang.Integer m_verbose

      • m_parentModule

        private java.lang.String m_parentModule

      • m_guiceStage

        private java.lang.String m_guiceStage

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

      • m_isJUnit

        private java.lang.Boolean m_isJUnit

      • 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

      • m_skipFailedInvocationCounts

        private java.lang.Boolean m_skipFailedInvocationCounts

      • DEFAULT_THREAD_COUNT

        public static final java.lang.Integer DEFAULT_THREAD_COUNT
        The thread count.

      • m_threadCount

        private int m_threadCount

      • DEFAULT_DATA_PROVIDER_THREAD_COUNT

        public static final java.lang.Integer DEFAULT_DATA_PROVIDER_THREAD_COUNT
        Thread count for the data provider pool.

      • m_dataProviderThreadCount

        private int m_dataProviderThreadCount

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

      • m_groupByInstances

        private java.lang.Boolean m_groupByInstances

      • DEFAULT_ALLOW_RETURN_VALUES

        public static final java.lang.Boolean DEFAULT_ALLOW_RETURN_VALUES

      • m_allowReturnValues

        private java.lang.Boolean m_allowReturnValues

      • m_xmlPackages

        private java.util.List<XmlPackage> m_xmlPackages
        The packages containing test classes.

      • m_methodSelectors

        private java.util.List<XmlMethodSelector> m_methodSelectors
        Suite level method selectors.

      • m_tests

        private java.util.List<XmlTest> m_tests
        Tests in suite.

      • m_parameters

        private java.util.Map<java.lang.String,​java.lang.String> m_parameters
        Suite level parameters.

      • m_fileName

        private java.lang.String m_fileName
        Name of the XML file.

      • m_timeOut

        private java.lang.String m_timeOut
        Time out for methods/tests.

      • m_childSuites

        private java.util.List<XmlSuite> m_childSuites
        List of child XML suites specified using tags.

      • m_parentSuite

        private XmlSuite m_parentSuite
        Parent XML suite if this suite was specified in another suite using tag.

      • m_suiteFiles

        private java.util.List<java.lang.String> m_suiteFiles

      • m_listeners

        private java.util.List<java.lang.String> m_listeners

      • DEFAULT_PRESERVE_ORDER

        public static final java.lang.Boolean DEFAULT_PRESERVE_ORDER

      • m_preserveOrder

        private java.lang.Boolean m_preserveOrder

      • m_includedGroups

        private java.util.List<java.lang.String> m_includedGroups

      • m_excludedGroups

        private java.util.List<java.lang.String> m_excludedGroups

      • parsed

        private boolean parsed

    • Constructor Detail

      • XmlSuite

        public XmlSuite()

    • Method Detail

      • setParsed

        public void setParsed​(boolean parsed)

      • isParsed

        public boolean isParsed()
        Returns:
        - true if the current XmlSuite 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()

      • setParallel

        @Deprecated
public void setParallel​(java.lang.String parallel)
        Deprecated.
        Use #setParallel(XmlSuite.ParallelMode) instead
        Parameters:
        parallel - The String value

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

      • updateParameters

        private void updateParameters()
        Updates the list of parameters that apply to this XML suite. This method should be invoked any time there is a change in the state of this suite that would affect the parameter list.
        NOTE: Currently being invoked after a parent suite is added or if parameters for this suite are updated.

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

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

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.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 class java.lang.Object

      • shallowCopy

        public XmlSuite shallowCopy()
        This method returns a shallow cloned version. XmlTests 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 class java.lang.Object

      • f

        static boolean f()
        Used to debug equals() bugs.

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • setPreserveOrder

        @Deprecated
public void setPreserveOrder​(java.lang.String f)
        Deprecated.
        Use setPreserveOrder(Boolean) instead
        Parameters:
        f - The String value

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

      • addTest

        public void addTest​(XmlTest test)

      • getPackageNames

        public java.util.Collection<java.lang.String> getPackageNames()