Package org.testng

Class TestNGAntTask

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.testng.TestNGAntTask
All Implemented Interfaces:
Cloneable
public class TestNGAntTask extends org.apache.tools.ant.Task
TestNG settings:
  • classfileset (inner)
  • classfilesetref (attribute)
  • xmlfileset (inner)
  • xmlfilesetref (attribute)
  • enableAssert (attribute)
  • excludedGroups (attribute)
  • groups (attribute)
  • junit (attribute)
  • listener (attribute)
  • outputdir (attribute)
  • parallel (attribute)
  • reporter (attribute)
  • sourcedir (attribute)
  • sourcedirref (attribute)
  • suitename (attribute)
  • suiterunnerclass (attribute)
  • target (attribute)
  • testjar (attribute)
  • testname (attribute)
  • threadcount (attribute)
  • dataproviderthreadcount (attribute)
  • verbose (attribute)
  • testrunfactory (attribute)
  • configFailurepolicy (attribute)
  • randomizeSuites (attribute)
  • methodselectors (attribute)
Ant settings:
  • classpath (inner)
  • classpathref (attribute)
  • jvm (attribute)
  • workingDir (attribute)
  • env (inner)
  • sysproperty (inner)
  • propertyset (inner)
  • jvmarg (inner)
  • timeout (attribute)
  • haltonfailure (attribute)
  • onHaltTarget (attribute)
  • failureProperty (attribute)
  • haltonFSP (attribute)
  • FSPproperty (attribute)
  • haltonskipped (attribute)
  • skippedProperty (attribute)
  • testRunnerFactory (attribute)
Debug information:
  • dumpCommand (boolean)
  • dumpEnv (boolean)
  • dumpSys (boolean)

  • Field Details

    • m_javaCommand

      protected org.apache.tools.ant.types.CommandlineJava m_javaCommand

    • m_xmlFilesets

      protected List<org.apache.tools.ant.types.ResourceCollection> m_xmlFilesets

    • m_classFilesets

      protected List<org.apache.tools.ant.types.ResourceCollection> m_classFilesets

    • m_outputDir

      protected File m_outputDir

    • m_testjar

      protected File m_testjar

    • m_workingDir

      protected File m_workingDir

    • m_timeout

      private Integer m_timeout

    • m_listeners

      private List<String> m_listeners

    • m_methodselectors

      private List<String> m_methodselectors

    • m_objectFactory

      private String m_objectFactory

    • m_testRunnerFactory

      protected String m_testRunnerFactory

    • m_delegateCommandSystemProperties

      private boolean m_delegateCommandSystemProperties

    • m_environment

      protected org.apache.tools.ant.types.Environment m_environment

    • m_mainClass

      protected String m_mainClass
      The suite runner name (defaults to TestNG.class.getName().

    • m_dump

      protected boolean m_dump
      True if the temporary file created by the Ant Task for command line parameters to TestNG should be preserved after execution.

    • m_dumpEnv

      private boolean m_dumpEnv

    • m_dumpSys

      private boolean m_dumpSys

    • m_assertEnabled

      protected boolean m_assertEnabled

    • m_haltOnFailure

      protected boolean m_haltOnFailure

    • m_onHaltTarget

      protected String m_onHaltTarget

    • m_failurePropertyName

      protected String m_failurePropertyName

    • m_haltOnSkipped

      protected boolean m_haltOnSkipped

    • m_skippedPropertyName

      protected String m_skippedPropertyName

    • m_haltOnFSP

      protected boolean m_haltOnFSP

    • m_fspPropertyName

      protected String m_fspPropertyName

    • m_includedGroups

      protected String m_includedGroups

    • m_excludedGroups

      protected String m_excludedGroups

    • m_parallelMode

      protected String m_parallelMode

    • m_threadCount

      protected String m_threadCount

    • m_dataproviderthreadCount

      protected String m_dataproviderthreadCount

    • m_configFailurePolicy

      protected String m_configFailurePolicy

    • m_randomizeSuites

      protected Boolean m_randomizeSuites

    • m_useDefaultListeners

      public String m_useDefaultListeners

    • m_suiteName

      private String m_suiteName

    • m_testName

      private String m_testName

    • m_skipFailedInvocationCounts

      private Boolean m_skipFailedInvocationCounts

    • m_methods

      private String m_methods

    • mode

      private TestNGAntTask.Mode mode

    • forkJvm

      private boolean forkJvm

    • m_ignoreMissedTestNames

      private boolean m_ignoreMissedTestNames

    • LOGGER

      private static final Logger LOGGER

    • reporterConfigs

      private List<AntReporterConfig> reporterConfigs
      The list of report listeners added via <reporter> sub-element of the Ant task

    • m_testNames

      private String m_testNames

    • m_verbose

      private Integer m_verbose

    • m_suiteThreadPoolSize

      private Integer m_suiteThreadPoolSize

    • m_xmlPathInJar

      private String m_xmlPathInJar

  • Constructor Details

    • TestNGAntTask

      public TestNGAntTask()

  • Method Details

    • setParallel

      public void setParallel(String parallel)

    • setThreadCount

      public void setThreadCount(String threadCount)

    • setDataProviderThreadCount

      public void setDataProviderThreadCount(String dataproviderthreadCount)

    • setUseDefaultListeners

      public void setUseDefaultListeners(String f)

    • setHaltonfailure

      public void setHaltonfailure(boolean value)

    • setOnHaltTarget

      public void setOnHaltTarget(String targetName)

    • setFailureProperty

      public void setFailureProperty(String propertyName)

    • setHaltonskipped

      public void setHaltonskipped(boolean value)

    • setSkippedProperty

      public void setSkippedProperty(String propertyName)

    • setHaltonFSP

      public void setHaltonFSP(boolean value)

    • setFSPProperty

      public void setFSPProperty(String propertyName)

    • setDelegateCommandSystemProperties

      public void setDelegateCommandSystemProperties(boolean value)

    • setDumpCommand

      public void setDumpCommand(boolean verbose)
      Parameters:
      verbose - the flag to log the command line. When verbose is set to true the command line parameters are stored in a temporary file stored in the user's default temporary file directory. The file created is prefixed with "testng".

    • setDumpEnv

      public void setDumpEnv(boolean verbose)
      Sets the flag to write on System.out the Ant Environment properties.
      Parameters:
      verbose - true for printing

    • setDumpSys

      public void setDumpSys(boolean verbose)
      Sets te flag to write on System.out the system properties.
      Parameters:
      verbose - true for dumping the info

    • setEnableAssert

      public void setEnableAssert(boolean flag)

    • setWorkingDir

      public void setWorkingDir(File workingDir)
      The directory to invoke the VM in.
      Parameters:
      workingDir - the directory to invoke the JVM from.

    • setJvm

      public void setJvm(String jvm)
      Sets a particular JVM to be used. Default is 'java' and is solved by Runtime.exec() .
      Parameters:
      jvm - the new jvm

    • setTimeout

      public void setTimeout(Integer value)
      Set the timeout value (in milliseconds).

      If the tests are running for more than this value, the tests will be canceled.

      Parameters:
      value - the maximum time (in milliseconds) allowed before declaring the test as 'timed-out'

    • createJvmarg

      public org.apache.tools.ant.types.Commandline.Argument createJvmarg()

    • addSysproperty

      public void addSysproperty(org.apache.tools.ant.types.Environment.Variable sysp)

    • addEnv

      public void addEnv(org.apache.tools.ant.types.Environment.Variable var)
      Adds an environment variable; used when forking.
      Parameters:
      var - The variable

    • createClasspath

      public org.apache.tools.ant.types.Path createClasspath()
      Adds path to classpath used for tests.
      Returns:
      reference to the classpath in the embedded java command line

    • createBootclasspath

      public org.apache.tools.ant.types.Path createBootclasspath()
      Adds a path to the bootclasspath.
      Returns:
      reference to the bootclasspath in the embedded java command line

    • setClasspath

      public void setClasspath(org.apache.tools.ant.types.Path s)
      Set the classpath to be used when running the Java class
      Parameters:
      s - an Ant Path object containing the classpath.

    • setClasspathRef

      public void setClasspathRef(org.apache.tools.ant.types.Reference r)
      Classpath to use, by reference.
      Parameters:
      r - a reference to an existing classpath

    • addXmlfileset

      public void addXmlfileset(org.apache.tools.ant.types.FileSet fs)

    • setXmlfilesetRef

      public void setXmlfilesetRef(org.apache.tools.ant.types.Reference ref)

    • addClassfileset

      public void addClassfileset(org.apache.tools.ant.types.FileSet fs)

    • setClassfilesetRef

      public void setClassfilesetRef(org.apache.tools.ant.types.Reference ref)

    • setTestNames

      public void setTestNames(String testNames)

    • setIgnoreMissedTestNames

      public void setIgnoreMissedTestNames(boolean ignoreMissedTestNames)

    • setSuiteRunnerClass

      public void setSuiteRunnerClass(String s)
      Sets the suite runner class to invoke
      Parameters:
      s - the name of the suite runner class

    • setSuiteName

      public void setSuiteName(String s)
      Sets the suite name
      Parameters:
      s - the name of the suite

    • setTestName

      public void setTestName(String s)
      Sets the test name
      Parameters:
      s - the name of the test

    • setJUnit

      public void setJUnit(boolean value)

    • setMode

      public void setMode(TestNGAntTask.Mode mode)

    • setForkJvm

      public void setForkJvm(boolean forkJvm)

    • setOutputDir

      public void setOutputDir(File dir)
      Sets the test output directory
      Parameters:
      dir - the name of directory

    • setTestJar

      public void setTestJar(File s)
      Sets the test jar
      Parameters:
      s - the name of test jar

    • setGroups

      public void setGroups(String groups)

    • setExcludedGroups

      public void setExcludedGroups(String groups)

    • setVerbose

      public void setVerbose(Integer verbose)

    • setReporter

      public void setReporter(String listener)

    • setObjectFactory

      public void setObjectFactory(String className)

    • setTestRunnerFactory

      public void setTestRunnerFactory(String testRunnerFactory)

    • setSuiteThreadPoolSize

      public void setSuiteThreadPoolSize(Integer n)

    • setListeners

      public void setListeners(String listeners)

    • setMethodSelectors

      public void setMethodSelectors(String methodSelectors)

    • setConfigFailurePolicy

      public void setConfigFailurePolicy(String failurePolicy)

    • setRandomizeSuites

      public void setRandomizeSuites(Boolean randomizeSuites)

    • setMethods

      public void setMethods(String methods)

    • execute

      public void execute() throws org.apache.tools.ant.BuildException
      Launches TestNG in a new JVM.

      Overrides:
      execute in class org.apache.tools.ant.Task
      Throws:
      org.apache.tools.ant.BuildException

    • createArguments

      protected List<String> createArguments()

    • addDefaultListeners

      private void addDefaultListeners(List<String> argv)

    • addOutputDir

      private void addOutputDir(List<String> argv)

    • addReporterConfigs

      private void addReporterConfigs(List<String> argv)

    • addFilesOfRCollection

      private void addFilesOfRCollection(List<String> argv, String name, List<org.apache.tools.ant.types.ResourceCollection> resources)

    • addListOfStringIfNotEmpty

      private void addListOfStringIfNotEmpty(List<String> argv, String name, List<String> arguments)

    • addArgumentsIfNotEmpty

      private void addArgumentsIfNotEmpty(List<String> argv, String name, List<String> arguments, String separator)

    • addFileIfFile

      private void addFileIfFile(List<String> argv, String name, File file)

    • addBooleanIfTrue

      private void addBooleanIfTrue(List<String> argv, String name, Boolean value)

    • addIntegerIfNotNull

      private void addIntegerIfNotNull(List<String> argv, String name, Integer value)

    • addStringIfNotNull

      private void addStringIfNotNull(List<String> argv, String name, String value)

    • addStringIfNotBlank

      private void addStringIfNotBlank(List<String> argv, String name, String value)

    • addXmlFiles

      private void addXmlFiles(List<String> argv)

    • getSuiteFileNames

      protected List<String> getSuiteFileNames()
      Returns:
      the list of the XML file names. This method can be overridden by subclasses.

    • delegateCommandSystemProperties

      private void delegateCommandSystemProperties()

    • printDebugInfo

      private void printDebugInfo(String fileName)

    • debug

      private void debug(String message)

    • actOnResult

      protected void actOnResult(int exitValue, boolean wasKilled)

    • executeHaltTarget

      private void executeHaltTarget(int exitValue)
      Executes the target, if any, that user designates executing before failing the test

    • executeAsForked

      protected int executeAsForked(org.apache.tools.ant.types.CommandlineJava cmd, org.apache.tools.ant.taskdefs.ExecuteWatchdog watchdog)
      Executes the command line as a new process.
      Parameters:
      cmd - the command to execute
      watchdog - - A ExecuteWatchdog object.
      Returns:
      the exit status of the subprocess or INVALID.

    • getJavaCommand

      protected org.apache.tools.ant.types.CommandlineJava getJavaCommand()
      Returns:
      the created (or create) the CommandlineJava.

    • createWatchdog

      protected org.apache.tools.ant.taskdefs.ExecuteWatchdog createWatchdog()
      Returns:
      null if there is no timeout value, otherwise the watchdog instance.
      Throws:
      org.apache.tools.ant.BuildException - under unspecified circumstances
      Since:
      Ant 1.2

    • validateOptions

      protected void validateOptions() throws org.apache.tools.ant.BuildException
      Throws:
      org.apache.tools.ant.BuildException

    • createResourceCollection

      private org.apache.tools.ant.types.ResourceCollection createResourceCollection(org.apache.tools.ant.types.Reference ref)

    • appendClassSelector

      private org.apache.tools.ant.types.FileSet appendClassSelector(org.apache.tools.ant.types.FileSet fs)

    • findJar

      private File findJar()

    • fromURI

      private String fromURI(String uri)

    • getFiles

      private List<String> getFiles(List<org.apache.tools.ant.types.ResourceCollection> resources) throws org.apache.tools.ant.BuildException
      Returns the list of files corresponding to the resource collection
      Parameters:
      resources - - A list of ResourceCollection
      Returns:
      the list of files corresponding to the resource collection
      Throws:
      org.apache.tools.ant.BuildException

    • dumpCommand

      private void dumpCommand(String fileName)

    • readAndPrintFile

      private void readAndPrintFile(String fileName)

    • addConfiguredReporter

      public void addConfiguredReporter(AntReporterConfig reporterConfig)

    • setSkipFailedInvocationCounts

      public void setSkipFailedInvocationCounts(boolean skip)

    • setXmlPathInJar

      public void setXmlPathInJar(String path)

    • addConfiguredPropertySet

      public void addConfiguredPropertySet(org.apache.tools.ant.types.PropertySet sysPropertySet)
      Add the referenced property set as system properties for the TestNG JVM.
      Parameters:
      sysPropertySet - A PropertySet of system properties.

    • handleOutput

      protected void handleOutput(String output)
      Overrides:
      handleOutput in class org.apache.tools.ant.Task