The <junit> task supports a nested <classpath> element that represents a PATH like structure.
jvmarg
If fork is enabled, additional parameters may be passed to the new VM via nested <jvmarg> elements. For example:
<junit fork="yes"> <jvmarg value="-Djava.compiler=NONE"/> ... </junit>would run the test in a VM without JIT.
<jvmarg> allows all attributes described in Command-line Arguments.
sysproperty
Use nested <sysproperty> elements to specify system properties required by the class. These properties will be made available to the VM during the execution of the test (either ANT's VM or the forked VM, if fork is enabled). The attributes for this element are the same as for environment variables.
<junit fork="no"> <sysproperty key="basedir" value="${basedir}"/> ... </junit>would run the test in ANT's VM and make the basedir property available to the test.
env
It is possible to specify environment variables to pass to the forked VM via nested <env> elements. For a description of the <env> element's attributes, see the description in the exec task.
Settings will be ignored if fork is disabled.
formatter
The results of the tests can be printed in different formats. Output will always be sent to a file, unless you set the usefile attribute to false. The name of the file is determined by the name of the test and can be set by the outfile attribute of <test>.
There are three predefined formatters - one prints the test results in
XML format, the other emits plain text. The formatter named brief will
only print detailed information for testcases that failed, while plain
gives a little statistics line for all test cases. Custom formatters
that need to implement
org.apache.tools.ant.taskdefs.optional.junit.JUnitResultFormatter can
be specified.
If you use the XML formatter, it may not include the same output that your tests have written as some characters are illegal in XML documents and will be dropped.
Attribute | Description | Required | ||||
|
|
Exactly one of these. | ||||
extension | Extension to append to the output filename. | Yes, if classname has been used. | ||||
usefile | Boolean that determines whether output should be sent to a file. | No; default is true. |
test
Defines a single test class.
Attribute | Description | Required |
name | Name of the test class. | Yes |
fork | Run the tests in a separate VM. Overrides value set in <junit>. | No |
haltonerror | Stop the build process if an error occurs during the test run. Overrides value set in <junit>. | No |
errorproperty | The name of a property to set in the event of an error. Overrides value set in <junit>. | No |
haltonfailure | Stop the build process if a test fails (errors are considered failures as well). Overrides value set in <junit>. | No |
failureproperty | The name of a property to set in the event of a failure (errors are considered failures as well). Overrides value set in <junit>. | No |
filtertrace | Filter out Junit and Ant stack frames from error and failure stack traces. Overrides value set in <junit>. | No; default is on. |
todir | Directory to write the reports to. | No; default is the current directory. |
outfile | Base name of the test result. The full filename is determined by this attribute and the extension of formatter. | No; default is TEST-name, where name is the name of the test specified in the name attribute. |
if | Only run test if the named property is set. | No |
unless | Only run test if the named property is not set. | No |
Tests can define their own formatters via nested <formatter> elements.
batchtest
Define a number of tests based on pattern matching.
batchtest collects the included files from any number of nested <fileset>s. It then generates a test class name for each file that ends in .java or .class.
Attribute | Description | Required |
fork | Run the tests in a separate VM. Overrides value set in <junit>. | No |
haltonerror | Stop the build process if an error occurs during the test run. Overrides value set in <junit>. | No |
errorproperty | The name of a property to set in the event of an error. Overrides value set in <junit>. | No |
haltonfailure | Stop the build process if a test fails (errors are considered failures as well). Overrides value set in <junit>. | No |
failureproperty | The name of a property to set in the event of a failure (errors are considered failures as well). Overrides value set in <junit> | No |
filtertrace | Filter out Junit and Ant stack frames from error and failure stack traces. Overrides value set in <junit>. | No; default is on. |
todir | Directory to write the reports to. | No; default is the current directory. |
if | Only run tests if the named property is set. | No |
unless | Only run tests if the named property is not set. | No |
Batchtests can define their own formatters via nested <formatter> elements.
bf Examples
<junit> <test name="my.test.TestCase"/> </junit>Runs the test defined in my.test.TestCase in the same VM. No output will be generated unless the test fails.
<junit printsummary="yes" fork="yes" haltonfailure="yes"> <formatter type="plain"/> <test name="my.test.TestCase"/> </junit>Runs the test defined in my.test.TestCase in a separate VM. At the end of the test, a one-line summary will be printed. A detailed report of the test can be found in TEST-my.test.TestCase.txt. The build process will be stopped if the test fails.
<junit printsummary="yes" haltonfailure="yes"> <classpath> <pathelement location="${build.tests}"/> <pathelement path="${java.class.path}"/> </classpath> <formatter type="plain"/> <test name="my.test.TestCase" haltonfailure="no" outfile="result"> <formatter type="xml"/> </test> <batchtest fork="yes" todir="${reports.tests}"> <fileset dir="${src.tests}"> <include name="**/*Test*.java"/> <exclude name="**/AllTests.java"/> </fileset> </batchtest> </junit>Runs my.test.TestCase in the same VM, ignoring the given CLASSPATH; only a warning is printed if this test fails. In addition to the plain text test results, for this test a XML result will be output to result.xml. Then, for each matching file in the directory defined for ${src.tests} a test is run in a separate VM. If a test fails, the build process is aborted. Results are collected in files named TEST-name.txt and written to ${reports.tests}.