org.testng
Class TestNGAntTask

java.lang.Object  extended by org.apache.tools.ant.ProjectComponent      extended by org.apache.tools.ant.Task          extended by org.testng.TestNGAntTask
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
TestNGAntTask

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)

Author:
Alexandru Popescu, Cedric Beust, Lukas Jungmann


Nested Class Summary
static classTestNGAntTask.Mode
           
protected static classTestNGAntTask.TestNGLogSH
           
 
Field Summary
protected  booleanm_assertEnabled
           
protected  List<org.apache.tools.ant.types.ResourceCollection>m_classFilesets
           
protected  Stringm_configFailurePolicy
           
protected  Stringm_dataproviderthreadCount
           
protected  booleanm_dump
          True if the temporary file created by the Ant Task for command line parameters to TestNG should be preserved after execution.
protected  org.apache.tools.ant.types.Environmentm_environment
           
protected  Stringm_excludedGroups
           
protected  Stringm_failurePropertyName
           
protected  Stringm_fspPropertyName
           
protected  booleanm_haltOnFailure
           
protected  booleanm_haltOnFSP
           
protected  booleanm_haltOnSkipped
           
protected  Stringm_includedGroups
           
protected  org.apache.tools.ant.types.CommandlineJavam_javaCommand
           
protected  Stringm_mainClass
          The suite runner name (defaults to TestNG.class.getName().
protected  Stringm_onHaltTarget
           
protected  Filem_outputDir
           
protected  Stringm_parallelMode
           
protected  Booleanm_randomizeSuites
           
protected  Stringm_skippedPropertyName
           
protected  Filem_testjar
           
protected  Stringm_testRunnerFactory
           
protected  Stringm_threadCount
           
 Stringm_useDefaultListeners
           
protected  Filem_workingDir
           
protected  List<org.apache.tools.ant.types.ResourceCollection>m_xmlFilesets
           
 
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
 
Constructor Summary
TestNGAntTask()
           
 
Method Summary
protected  voidactOnResult(int exitValue, boolean wasKilled)
           
 voidaddClassfileset(org.apache.tools.ant.types.FileSet fs)
           
 voidaddConfiguredPropertySet(org.apache.tools.ant.types.PropertySet sysPropertySet)
          Add the referenced property set as system properties for the TestNG JVM.
 voidaddConfiguredReporter(ReporterConfig reporterConfig)
           
 voidaddEnv(org.apache.tools.ant.types.Environment.Variable var)
          Adds an environment variable; used when forking.
 voidaddSysproperty(org.apache.tools.ant.types.Environment.Variable sysp)
           
 voidaddXmlfileset(org.apache.tools.ant.types.FileSet fs)
           
 org.apache.tools.ant.types.PathcreateBootclasspath()
          Adds a path to the bootclasspath.
 org.apache.tools.ant.types.PathcreateClasspath()
          Adds path to classpath used for tests.
 org.apache.tools.ant.types.Commandline.ArgumentcreateJvmarg()
           
protected  org.apache.tools.ant.taskdefs.ExecuteWatchdogcreateWatchdog()
           
 voidexecute()
          Launches TestNG in a new JVM.
protected  intexecuteAsForked(org.apache.tools.ant.types.CommandlineJava cmd, org.apache.tools.ant.taskdefs.ExecuteWatchdog watchdog)
          Executes the command line as a new process.
protected  org.apache.tools.ant.types.CommandlineJavagetJavaCommand()
          Creates or returns the already created CommandlineJava.
protected  List<String>getSuiteFileNames()
           
protected  voidhandleOutput(String output)
           
 voidsetClassfilesetRef(org.apache.tools.ant.types.Reference ref)
           
 voidsetClasspath(org.apache.tools.ant.types.Path s)
          Set the classpath to be used when running the Java class
 voidsetClasspathRef(org.apache.tools.ant.types.Reference r)
          Classpath to use, by reference.
 voidsetConfigFailurePolicy(String failurePolicy)
           
 voidsetDataProviderThreadCount(String dataproviderthreadCount)
           
 voidsetDelegateCommandSystemProperties(boolean value)
           
 voidsetDumpCommand(boolean verbose)
          Sets the flag to log the command line.
 voidsetDumpEnv(boolean verbose)
          Sets the flag to write on System.out the Ant Environment properties.
 voidsetDumpSys(boolean verbose)
          Sets te flag to write on System.out the system properties.
 voidsetEnableAssert(boolean flag)
           
 voidsetExcludedGroups(String groups)
           
 voidsetFailureProperty(String propertyName)
           
 voidsetFSPProperty(String propertyName)
           
 voidsetGroups(String groups)
           
 voidsetHaltonfailure(boolean value)
           
 voidsetHaltonFSP(boolean value)
           
 voidsetHaltonskipped(boolean value)
           
 voidsetJUnit(boolean value)
           
 voidsetJvm(String jvm)
          Sets a particular JVM to be used.
 voidsetListener(String listener)
          Deprecated. Use "listeners"
 voidsetListeners(String listeners)
           
 voidsetMethods(String methods)
           
 voidsetMethodSelectors(String methodSelectors)
           
 voidsetMode(TestNGAntTask.Mode mode)
           
 voidsetObjectFactory(String className)
           
 voidsetOnHaltTarget(String targetName)
           
 voidsetOutputDir(File dir)
          Sets the test output directory
 voidsetParallel(String parallel)
           
 voidsetRandomizeSuites(Boolean randomizeSuites)
           
 voidsetReporter(String listener)
           
 voidsetSkipFailedInvocationCounts(boolean skip)
           
 voidsetSkippedProperty(String propertyName)
           
 voidsetSuiteName(String s)
          Sets the suite name
 voidsetSuiteRunnerClass(String s)
          Sets the suite runner class to invoke
 voidsetSuiteThreadPoolSize(Integer n)
           
 voidsetTestJar(File s)
          Sets the test jar
 voidsetTestName(String s)
          Sets the test name
 voidsetTestNames(String testNames)
           
 voidsetTestRunnerFactory(String testRunnerFactory)
           
 voidsetThreadCount(String threadCount)
           
 voidsetTimeout(Integer value)
          Set the timeout value (in milliseconds).
 voidsetUseDefaultListeners(String f)
           
 voidsetVerbose(Integer verbose)
           
 voidsetWorkingDir(File workingDir)
          The directory to invoke the VM in.
 voidsetXmlfilesetRef(org.apache.tools.ant.types.Reference ref)
           
 voidsetXmlPathInJar(String path)
           
protected  voidvalidateOptions()
           
 
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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_testRunnerFactory

protected String m_testRunnerFactory

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_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
Constructor Detail

TestNGAntTask

public TestNGAntTask()
Method Detail

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)
Sets 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.


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)

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)

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)

setListener

@Deprecatedpublic void setListener(String listener)
Deprecated. Use "listeners"


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

getSuiteFileNames

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

actOnResult

protected void actOnResult(int exitValue,                           boolean wasKilled)

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 -
Returns:
the exit status of the subprocess or INVALID.

getJavaCommand

protected org.apache.tools.ant.types.CommandlineJava getJavaCommand()
Creates or returns the already created 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

addConfiguredReporter

public void addConfiguredReporter(ReporterConfig 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


Copyright © 2012. All Rights Reserved.


NOTHING
NOTHING
Add the Maven Dependecy to your project: maven dependecy for com.amazonaws : aws-java-sdk : 1.3.14