You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

junit.html 28 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721
  1. <!--
  2. Licensed to the Apache Software Foundation (ASF) under one or more
  3. contributor license agreements. See the NOTICE file distributed with
  4. this work for additional information regarding copyright ownership.
  5. The ASF licenses this file to You under the Apache License, Version 2.0
  6. (the "License"); you may not use this file except in compliance with
  7. the License. You may obtain a copy of the License at
  8. http://www.apache.org/licenses/LICENSE-2.0
  9. Unless required by applicable law or agreed to in writing, software
  10. distributed under the License is distributed on an "AS IS" BASIS,
  11. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. See the License for the specific language governing permissions and
  13. limitations under the License.
  14. -->
  15. <html>
  16. <head>
  17. <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
  18. <title>JUnit Task</title>
  19. </head>
  20. <body>
  21. <h2><a name="junit">JUnit</a></h2>
  22. <h3>Description</h3>
  23. <p>This task runs tests from the JUnit testing framework. The latest
  24. version of the framework can be found at
  25. <a href="http://www.junit.org">http://www.junit.org</a>.
  26. This task has been tested with JUnit 3.0 up to JUnit 3.8.2; it won't
  27. work with versions prior to JUnit 3.0. It also works with JUnit 4.0, including
  28. "pure" JUnit 4 tests using only annotations and no <code>JUnit4TestAdapter</code>.</p>
  29. <p><strong>Note:</strong> This task depends on external libraries not included
  30. in the Ant distribution. See <a href="../install.html#librarydependencies">
  31. Library Dependencies</a> for more information.
  32. </p>
  33. <p>
  34. <strong>Note</strong>:
  35. You must have <code>junit.jar</code> available.
  36. You can do one of:
  37. </p>
  38. <ol>
  39. <li>
  40. Put both <code>junit.jar</code> and <code>ant-junit.jar</code> in
  41. <code>ANT_HOME/lib</code>.
  42. </li>
  43. <li>
  44. Do not put either in <code>ANT_HOME/lib</code>, and instead
  45. include their locations in your <code>CLASSPATH</code> environment variable.
  46. </li>
  47. <li>
  48. Add both JARs to your classpath using <code>-lib</code>.
  49. </li>
  50. <li>
  51. Specify the locations of both JARs using
  52. a <code>&lt;classpath&gt;</code> element in a <code>&lt;taskdef&gt;</code> in the build file.
  53. </li>
  54. <li>
  55. Leave <code>ant-junit.jar</code> in its default location in <code>ANT_HOME/lib</code>
  56. but include <code>junit.jar</code> in the <code>&lt;classpath&gt;</code> passed
  57. to <code>&lt;junit&gt;</code>. <em>(since Ant 1.7)</em>
  58. </li>
  59. </ol>
  60. <p>
  61. See <a href="../../faq.html#delegating-classloader" target="_top">the
  62. FAQ</a> for details.
  63. </p>
  64. <p>Tests are defined by nested <code>test</code> or
  65. <code>batchtest</code> tags (see <a href="#nested">nested
  66. elements</a>).</p>
  67. <h3>Parameters</h3>
  68. <table border="1" cellpadding="2" cellspacing="0">
  69. <tr>
  70. <td width="12%" valign="top"><b>Attribute</b></td>
  71. <td width="78%" valign="top"><b>Description</b></td>
  72. <td width="10%" valign="top"><b>Required</b></td>
  73. </tr>
  74. <tr>
  75. <td valign="top">printsummary</td>
  76. <td valign="top">Print one-line statistics for each testcase. Can
  77. take the values <code>on</code>,
  78. <code>off</code>, and
  79. <code>withOutAndErr</code>.
  80. <code>withOutAndErr</code> is the same
  81. as <code>on</code> but also includes the output of the test
  82. as written to <code>System.out</code> and <code>System.err</code>.</td>
  83. <td align="center" valign="top">No; default is <code>off</code>.</td>
  84. </tr>
  85. <tr>
  86. <td valign="top">fork</td>
  87. <td valign="top">Run the tests in a separate VM.</td>
  88. <td align="center" valign="top">No; default is <code>off</code>.</td>
  89. </tr>
  90. <tr>
  91. <td valign="top">forkmode</td>
  92. <td valign="top">Controls how many Java Virtual Machines get
  93. created if you want to fork some tests. Possible values are
  94. &quot;perTest&quot; (the default), &quot;perBatch&quot; and
  95. &quot;once&quot;. &quot;once&quot; creates only a single Java VM
  96. for all tests while &quot;perTest&quot; creates a new VM for each
  97. TestCase class. &quot;perBatch&quot; creates a VM for each nested
  98. <code>&lt;batchtest&gt;</code> and one collecting all nested
  99. <code>&lt;test&gt;</code>s. Note that only tests with the same
  100. settings of <code>filtertrace</code>, <code>haltonerror</code>,
  101. <code>haltonfailure</code>, <code>errorproperty</code> and
  102. <code>failureproperty</code> can share a VM, so even if you set
  103. <code>forkmode</code> to &quot;once&quot;, Ant may have to create
  104. more than a single Java VM. This attribute is ignored for tests
  105. that don't get forked into a new Java VM. <em>since Ant 1.6.2</em></td>
  106. <td align="center" valign="top">No; default is <code>perTest</code>.</td>
  107. </tr>
  108. <tr>
  109. <td valign="top">haltonerror</td>
  110. <td valign="top">Stop the build process if an error occurs during the test
  111. run.</td>
  112. <td align="center" valign="top">No; default is <code>off</code>.</td>
  113. </tr>
  114. <tr>
  115. <td valign="top">errorproperty</td>
  116. <td valign="top">The name of a property to set in the event of an error.</td>
  117. <td align="center" valign="top">No</td>
  118. </tr>
  119. <tr>
  120. <td valign="top">haltonfailure</td>
  121. <td valign="top">Stop the build process if a test fails (errors are
  122. considered failures as well).</td>
  123. <td align="center" valign="top">No; default is <code>off</code>.</td>
  124. </tr>
  125. <tr>
  126. <td valign="top">failureproperty</td>
  127. <td valign="top">The name of a property to set in the event of a failure
  128. (errors are considered failures as well).</td>
  129. <td align="center" valign="top">No.</td>
  130. </tr>
  131. <tr>
  132. <td valign="top">filtertrace</td>
  133. <td valign="top">Filter out Junit and Ant stack frames from error and failure stack traces.</td>
  134. <td align="center" valign="top">No; default is <code>on</code>.</td>
  135. </tr>
  136. <tr>
  137. <td valign="top">timeout</td>
  138. <td valign="top">Cancel the individual tests if they don't finish
  139. in the given time (measured in milliseconds). Ignored if
  140. <code>fork</code> is disabled. When running multiple tests
  141. inside the same Java VM (see forkMode), timeout applies to the
  142. time that all tests use together, not to an individual
  143. test.</td>
  144. <td align="center" valign="top">No</td>
  145. </tr>
  146. <tr>
  147. <td valign="top">maxmemory</td>
  148. <td valign="top">Maximum amount of memory to allocate to the forked VM.
  149. Ignored if <code>fork</code> is disabled. <strong>Note</strong>:
  150. If you get <code>java.lang.OutOfMemoryError: Java heap space</code>
  151. in some of your tests then you need to raise the size like
  152. <code>maxmemory="128m"</code></td>
  153. <td align="center" valign="top">No</td>
  154. </tr>
  155. <tr>
  156. <td valign="top">jvm</td>
  157. <td valign="top">The command used to invoke the Java Virtual Machine,
  158. default is 'java'. The command is resolved by
  159. <code>java.lang.Runtime.exec()</code>.
  160. Ignored if <code>fork</code> is disabled.</td>
  161. <td align="center" valign="top">No; default is <code>java</code>.</td>
  162. </tr>
  163. <tr>
  164. <td valign="top">dir</td>
  165. <td valign="top">The directory in which to invoke the VM. Ignored if
  166. <code>fork</code> is disabled.</td>
  167. <td align="center" valign="top">No</td>
  168. </tr>
  169. <tr>
  170. <td valign="top">newenvironment</td>
  171. <td valign="top">Do not propagate the old environment when new
  172. environment variables are specified. Ignored if <code>fork</code> is
  173. disabled.</td>
  174. <td align="center" valign="top">No; default is <code>false</code>.</td>
  175. </tr>
  176. <tr>
  177. <td valign="top">includeantruntime</td>
  178. <td valign="top">Implicitly add the Ant classes required to run
  179. the tests and JUnit to the classpath in forked mode.
  180. </td>
  181. <td align="center" valign="top">No; default is <code>true</code>.</td>
  182. </tr>
  183. <tr>
  184. <td valign="top">showoutput</td>
  185. <td valign="top">Send any output generated by tests to Ant's
  186. logging system as well as to the formatters. By default only the
  187. formatters receive the output.</td>
  188. <td align="center" valign="top">No</td>
  189. </tr>
  190. <tr>
  191. <td valign="top">outputtoformatters</td>
  192. <td valign="top">
  193. <em>Since Ant 1.7.0.</em><br/>
  194. Send any output generated by tests to the test formatters.
  195. This is "true" by default.
  196. </td>
  197. <td align="center" valign="top">No</td>
  198. </tr>
  199. <tr>
  200. <td valign="top">tempdir</td>
  201. <td valign="top">Where Ant should place temporary files.
  202. <em>Since Ant 1.6</em>.</td>
  203. <td align="center" valign="top">No; default is the project's base
  204. directory.</td>
  205. </tr>
  206. <tr>
  207. <td valign="top">reloading</td>
  208. <td valign="top">Whether or not a new classloader should be instantiated for each test case.<br>
  209. Ignore if <code>fork</code> is set to true.
  210. <em>Since Ant 1.6</em>.</td>
  211. <td align="center" valign="top">No; default is <code>true</code>.</td>
  212. </tr>
  213. <tr>
  214. <td valign="top">clonevm</td>
  215. <td valign="top">If set to true true, then all system properties
  216. and the bootclasspath of the forked Java Virtual Machine will be
  217. the same as those of the Java VM running Ant. Default is
  218. &quot;false&quot; (ignored if fork is disabled).
  219. <em>since Ant 1.7</em></td>
  220. <td align="center" valign="top">No</td>
  221. </tr>
  222. <tr>
  223. <td valign="top">logfailedtests</td>
  224. <td valign="top">When Ant executes multiple tests and doesn't stop
  225. on errors or failures it will log a "FAILED" message for each
  226. failing test to its logging system. If you set this option to
  227. false, the message will not be logged and you have to rely on the
  228. formatter output to find the failing tests.
  229. <em>since Ant 1.8.0</em></td>
  230. <td align="center" valign="top">No</td>
  231. </tr>
  232. </table>
  233. <p>By using the <code>errorproperty</code> and <code>failureproperty</code>
  234. attributes, it is possible to
  235. perform setup work (such as starting an external server), execute the test,
  236. clean up, and still fail the build in the event of a failure.</p>
  237. <p>The <code>filtertrace</code> attribute condenses error and failure
  238. stack traces before reporting them.
  239. It works with both the plain and XML formatters. It filters out any lines
  240. that begin with the following string patterns:<pre>
  241. "junit.framework.TestCase"
  242. "junit.framework.TestResult"
  243. "junit.framework.TestSuite"
  244. "junit.framework.Assert."
  245. "junit.swingui.TestRunner"
  246. "junit.awtui.TestRunner"
  247. "junit.textui.TestRunner"
  248. "java.lang.reflect.Method.invoke("
  249. "sun.reflect."
  250. "org.apache.tools.ant."
  251. "org.junit."
  252. "junit.framework.JUnit4TestAdapter"</pre>
  253. <h3><a name="nested">Nested Elements</a></h3>
  254. <p>The <code>&lt;junit&gt;</code> task
  255. supports a nested <code>&lt;classpath&gt;</code>
  256. element that represents a <a href="../using.html#path">PATH like
  257. structure</a>.</p>
  258. <p>As of Ant 1.7, this classpath may be used to refer to <code>junit.jar</code>
  259. as well as your tests and the tested code.
  260. <h4>jvmarg</h4>
  261. <p>If <code>fork</code> is enabled, additional parameters may be passed to
  262. the new VM via nested <code>&lt;jvmarg&gt;</code> elements. For example:</p>
  263. <pre>
  264. &lt;junit fork=&quot;yes&quot;&gt;
  265. &lt;jvmarg value=&quot;-Djava.compiler=NONE&quot;/&gt;
  266. ...
  267. &lt;/junit&gt;
  268. </pre>
  269. <p>would run the test in a VM without JIT.</p>
  270. <p><code>&lt;jvmarg&gt;</code> allows all attributes described in <a
  271. href="../using.html#arg">Command-line Arguments</a>.</p>
  272. <h4>sysproperty</h4>
  273. <p>Use nested <code>&lt;sysproperty&gt;</code> elements to specify system
  274. properties required by the class. These properties will be made available
  275. to the VM during the execution of the test (either ANT's VM or the forked VM,
  276. if <code>fork</code> is enabled).
  277. The attributes for this element are the same as for <a href="../CoreTasks/exec.html#env">environment variables</a>.</p>
  278. <pre>
  279. &lt;junit fork=&quot;no&quot;&gt;
  280. &lt;sysproperty key=&quot;basedir&quot; value=&quot;${basedir}&quot;/&gt;
  281. ...
  282. &lt;/junit&gt;
  283. </pre>
  284. <p>would run the test in ANT's VM and make the <code>basedir</code> property
  285. available to the test.</p>
  286. <h4>syspropertyset</h4>
  287. <p>You can specify a set of properties to be used as system properties
  288. with <a href="../CoreTypes/propertyset.html">syspropertyset</a>s.</p>
  289. <p><em>since Ant 1.6</em>.</p>
  290. <h4>env</h4>
  291. <p>It is possible to specify environment variables to pass to the
  292. forked VM via nested <code>&lt;env&gt;</code> elements. For a description
  293. of the <code>&lt;env&gt;</code> element's attributes, see the
  294. description in the <a href="../CoreTasks/exec.html#env">exec</a> task.</p>
  295. <p>Settings will be ignored if <code>fork</code> is disabled.</p>
  296. <h4>bootclasspath</h4>
  297. <p>The location of bootstrap class files can be specified using this
  298. <a href="../using.html#path">PATH like structure</a> - will be ignored
  299. if <i>fork</i> is not <code>true</code> or the target VM doesn't
  300. support it (i.e. Java 1.1).</p>
  301. <p><em>since Ant 1.6</em>.</p>
  302. <h4>permissions</h4>
  303. <p>Security permissions can be revoked and granted during the execution of the
  304. class via a nested <i>permissions</i> element. For more information please
  305. see <a href="../CoreTypes/permissions.html">permissions</a></p>
  306. <p>Settings will be ignored if fork is enabled.</p>
  307. <p><em>since Ant 1.6</em>.</p>
  308. <h4>assertions</h4>
  309. <p>You can control enablement of Java 1.4 assertions with an
  310. <a href="../CoreTypes/assertions.html"><tt>&lt;assertions&gt;</tt></a>
  311. subelement.</p>
  312. <p>Assertion statements are currently ignored in non-forked mode.</p>
  313. <p><em>since Ant 1.6.</em></p>
  314. <h4>formatter</h4>
  315. <p>The results of the tests can be printed in different
  316. formats. Output will always be sent to a file, unless you set the
  317. <code>usefile</code> attribute to <code>false</code>.
  318. The name of the file is determined by the
  319. name of the test and can be set by the <code>outfile</code> attribute
  320. of <code>&lt;test&gt;</code>.</p>
  321. <p>There are four predefined formatters - one prints the test results
  322. in XML format, the other emits plain text. The formatter named
  323. <code>brief</code> will only print detailed information for testcases
  324. that failed, while <code>plain</code> gives a little statistics line
  325. for all test cases. Custom formatters that need to implement
  326. <code>org.apache.tools.ant.taskdefs.optional.junit.JUnitResultFormatter</code>
  327. can be specified.</p>
  328. <p>If you use the XML formatter, it may not include the same output
  329. that your tests have written as some characters are illegal in XML
  330. documents and will be dropped.</p>
  331. <p>The fourth formatter named <code>failure</code> (since Ant 1.8.0)
  332. collects all failing <code>testXXX()</code>
  333. methods and creates a new <code>TestCase</code> which delegates only these
  334. failing methods. The name and the location can be specified via Java System property or Ant property
  335. <code>ant.junit.failureCollector</code>. The value has to point to the directory and
  336. the name of the resulting class (without suffix). It defaults to <i>java-tmp-dir</i>/FailedTests.</p>
  337. <table border="1" cellpadding="2" cellspacing="0">
  338. <tr>
  339. <td width="12%" valign="top"><b>Attribute</b></td>
  340. <td width="78%" valign="top"><b>Description</b></td>
  341. <td width="10%" valign="top"><b>Required</b></td>
  342. </tr>
  343. <tr>
  344. <td valign="top">type</td>
  345. <td valign="top">Use a predefined formatter (either
  346. <code>xml</code>, <code>plain</code>, <code>brief</code> or <code>failure</code>).</td>
  347. <td align="center" rowspan="2">Exactly one of these.</td>
  348. </tr>
  349. <tr>
  350. <td valign="top">classname</td>
  351. <td valign="top">Name of a custom formatter class.</td>
  352. </tr>
  353. <tr>
  354. <td valign="top">extension</td>
  355. <td valign="top">Extension to append to the output filename.</td>
  356. <td align="center">Yes, if <code>classname</code> has been used.</td>
  357. </tr>
  358. <tr>
  359. <td valign="top">usefile</td>
  360. <td valign="top">Boolean that determines whether output should be
  361. sent to a file.</td>
  362. <td align="center">No; default is <code>true</code>.</td>
  363. </tr>
  364. <tr>
  365. <td valign="top">if</td>
  366. <td valign="top">Only use formatter <a href="../properties.html#if+unless">if the named property is set</a>.</td>
  367. <td align="center">No; default is <code>true</code>.</td>
  368. </tr>
  369. <tr>
  370. <td valign="top">unless</td>
  371. <td valign="top">Only use formatter <a href="../properties.html#if+unless">if the named property is <b>not</b> set</a>.</td>
  372. <td align="center">No; default is <code>true</code>.</td>
  373. </tr>
  374. </table>
  375. <h4>test</h4>
  376. <p>Defines a single test class.</p>
  377. <table border="1" cellpadding="2" cellspacing="0">
  378. <tr>
  379. <td width="12%" valign="top"><b>Attribute</b></td>
  380. <td width="78%" valign="top"><b>Description</b></td>
  381. <td width="10%" valign="top"><b>Required</b></td>
  382. </tr>
  383. <tr>
  384. <td valign="top">name</td>
  385. <td valign="top">Name of the test class.</td>
  386. <td align="center">Yes</td>
  387. </tr>
  388. <tr>
  389. <td valign="top">fork</td>
  390. <td valign="top">Run the tests in a separate VM.
  391. Overrides value set in <code>&lt;junit&gt;</code>.</td>
  392. <td align="center" valign="top">No</td>
  393. </tr>
  394. <tr>
  395. <td valign="top">haltonerror</td>
  396. <td valign="top">Stop the build process if an error occurs during the test
  397. run. Overrides value set in <code>&lt;junit&gt;</code>.</td>
  398. <td align="center" valign="top">No</td>
  399. </tr>
  400. <tr>
  401. <td valign="top">errorproperty</td>
  402. <td valign="top">The name of a property to set in the event of an error.
  403. Overrides value set in <code>&lt;junit&gt;</code>.</td>
  404. <td align="center" valign="top">No</td>
  405. </tr>
  406. <tr>
  407. <td valign="top">haltonfailure</td>
  408. <td valign="top">Stop the build process if a test fails (errors are
  409. considered failures as well). Overrides value set in
  410. <code>&lt;junit&gt;</code>.</td>
  411. <td align="center" valign="top">No</td>
  412. </tr>
  413. <tr>
  414. <td valign="top">failureproperty</td>
  415. <td valign="top">The name of a property to set in the event of a failure
  416. (errors are considered failures as well). Overrides value set in
  417. <code>&lt;junit&gt;</code>.</td>
  418. <td align="center" valign="top">No</td>
  419. </tr>
  420. <tr>
  421. <td valign="top">filtertrace</td>
  422. <td valign="top">Filter out Junit and Ant stack frames from error and failure stack
  423. traces. Overrides value set in <code>&lt;junit&gt;</code>.</td>
  424. <td align="center" valign="top">No; default is <code>on</code>.</td>
  425. </tr>
  426. <tr>
  427. <td valign="top">todir</td>
  428. <td valign="top">Directory to write the reports to.</td>
  429. <td align="center" valign="top">No; default is the current directory.</td>
  430. </tr>
  431. <tr>
  432. <td valign="top">outfile</td>
  433. <td valign="top">Base name of the test result. The full filename is
  434. determined by this attribute and the extension of
  435. <code>formatter</code>.</td>
  436. <td align="center" valign="top">No; default is
  437. <code>TEST-</code><em>name</em>, where <em>name</em> is the name of
  438. the test specified in the <code>name</code> attribute.</td>
  439. </tr>
  440. <tr>
  441. <td valign="top">if</td>
  442. <td valign="top">Only run test <a href="../properties.html#if+unless">if the named property is set</a>.</td>
  443. <td align="center" valign="top">No</td>
  444. </tr>
  445. <tr>
  446. <td valign="top">unless</td>
  447. <td valign="top">Only run test <a href="../properties.html#if+unless">if the named property is <b>not</b> set</a>.</td>
  448. <td align="center" valign="top">No</td>
  449. </tr>
  450. </table>
  451. <p>Tests can define their own formatters via nested
  452. <code>&lt;formatter&gt;</code> elements.</p>
  453. <h4>batchtest</h4>
  454. <p>Define a number of tests based on pattern matching.</p>
  455. <p><code>batchtest</code> collects the included <a href="../CoreTypes/resources.html">resources</a> from any number
  456. of nested <a
  457. href="../CoreTypes/resources.html#collection">Resource Collection</a>s. It then
  458. generates a test class name for each resource that ends in
  459. <code>.java</code> or <code>.class</code>.</p>
  460. <p>Any type of Resource Collection is supported as a nested element,
  461. prior to Ant 1.7 only <code>&lt;fileset&gt;</code> has been
  462. supported.</p>
  463. <table border="1" cellpadding="2" cellspacing="0">
  464. <tr>
  465. <td width="12%" valign="top"><b>Attribute</b></td>
  466. <td width="78%" valign="top"><b>Description</b></td>
  467. <td width="10%" valign="top"><b>Required</b></td>
  468. </tr>
  469. <tr>
  470. <td valign="top">fork</td>
  471. <td valign="top">Run the tests in a separate VM.
  472. Overrides value set in <code>&lt;junit&gt;</code>.</td>
  473. <td align="center" valign="top">No</td>
  474. </tr>
  475. <tr>
  476. <td valign="top">haltonerror</td>
  477. <td valign="top">Stop the build process if an error occurs during the test
  478. run. Overrides value set in <code>&lt;junit&gt;</code>.</td>
  479. <td align="center" valign="top">No</td>
  480. </tr>
  481. <tr>
  482. <td valign="top">errorproperty</td>
  483. <td valign="top">The name of a property to set in the event of an error.
  484. Overrides value set in <code>&lt;junit&gt;</code>.</td>
  485. <td align="center" valign="top">No</td>
  486. </tr>
  487. <tr>
  488. <td valign="top">haltonfailure</td>
  489. <td valign="top">Stop the build process if a test fails (errors are
  490. considered failures as well). Overrides value set in
  491. <code>&lt;junit&gt;</code>.</td>
  492. <td align="center" valign="top">No</td>
  493. </tr>
  494. <tr>
  495. <td valign="top">failureproperty</td>
  496. <td valign="top">The name of a property to set in the event of a failure
  497. (errors are considered failures as well). Overrides value set in
  498. <code>&lt;junit&gt;</code></td>
  499. <td align="center" valign="top">No</td>
  500. </tr>
  501. <tr>
  502. <td valign="top">filtertrace</td>
  503. <td valign="top">Filter out Junit and Ant stack frames from error and failure stack
  504. traces. Overrides value set in <code>&lt;junit&gt;</code>.</td>
  505. <td align="center" valign="top">No; default is <code>on</code>.</td>
  506. </tr>
  507. <tr>
  508. <td valign="top">todir</td>
  509. <td valign="top">Directory to write the reports to.</td>
  510. <td align="center" valign="top">No; default is the current directory.</td>
  511. </tr>
  512. <tr>
  513. <td valign="top">if</td>
  514. <td valign="top">Only run tests <a href="../properties.html#if+unless">if the named property is set</a>.</td>
  515. <td align="center" valign="top">No</td>
  516. </tr>
  517. <tr>
  518. <td valign="top">unless</td>
  519. <td valign="top">Only run tests <a href="../properties.html#if+unless">if the named property is <strong>not</strong> set</a>.</td>
  520. <td align="center" valign="top">No</td>
  521. </tr>
  522. </table>
  523. <p>Batchtests can define their own formatters via nested
  524. <code>&lt;formatter&gt;</code> elements.</p>
  525. <h3>Forked tests and <code>tearDown</code></h3>
  526. <p>If a forked test runs into a timeout, Ant will terminate the Java
  527. VM process it has created, which probably means the
  528. test's <code>tearDown</code> method will never be called. The same
  529. is true if the forked VM crashes for some other reason.</p>
  530. <p>Starting with Ant 1.8.0, a special formatter is distributed with
  531. Ant that tries to load the testcase that was in the forked VM and
  532. invoke that class' <code>tearDown</code> method. This formatter has
  533. the following limitations:</p>
  534. <ul>
  535. <li>It runs in the same Java VM as Ant itself, this is a different
  536. Java VM than the one that was executing the test and it may see a
  537. different classloader (and thus may be unable to load the tast
  538. class).</li>
  539. <li>It cannot determine which test was run when the timeout/crash
  540. occured if the forked VM was running multiple test. I.e. the
  541. formatter cannot work with any <code>forkMode</code> other
  542. than <code>perTest</code> and it won't do anything if the test
  543. class contains a <code>suite()</code> method.</li>
  544. </ul>
  545. <p>If the formatter recognizes an incompatible <code>forkMode</code>
  546. or a <code>suite</code> method or fails to load the test class it
  547. will silently do nothing.</p>
  548. <p>The formatter doesn't have any effect on tests that were not
  549. forked or didn't cause timeouts or VM crashes.</p>
  550. <p>To enable the formatter, add a <code>formatter</code> like</p>
  551. <pre>
  552. &lt;formatter classname="org.apache.tools.ant.taskdefs.optional.junit.TearDownOnVmCrash"
  553. usefile="false"/&gt;
  554. </pre>
  555. <p>to your <code>junit</code> task.</p>
  556. <h3>Examples</h3>
  557. <pre>
  558. &lt;junit&gt;
  559. &lt;test name="my.test.TestCase"/&gt;
  560. &lt;/junit&gt;
  561. </pre>
  562. <p>Runs the test defined in <code>my.test.TestCase</code> in the same
  563. VM. No output will be generated unless the test fails.</p>
  564. <pre>
  565. &lt;junit printsummary="yes" fork="yes" haltonfailure="yes"&gt;
  566. &lt;formatter type="plain"/&gt;
  567. &lt;test name="my.test.TestCase"/&gt;
  568. &lt;/junit&gt;
  569. </pre>
  570. <p>Runs the test defined in <code>my.test.TestCase</code> in a
  571. separate VM. At the end of the test, a one-line summary will be
  572. printed. A detailed report of the test can be found in
  573. <code>TEST-my.test.TestCase.txt</code>. The build process will be
  574. stopped if the test fails.</p>
  575. <pre>
  576. &lt;junit printsummary="yes" haltonfailure="yes"&gt;
  577. &lt;classpath&gt;
  578. &lt;pathelement location="${build.tests}"/&gt;
  579. &lt;pathelement path="${java.class.path}"/&gt;
  580. &lt;/classpath&gt;
  581. &lt;formatter type="plain"/&gt;
  582. &lt;test name="my.test.TestCase" haltonfailure="no" outfile="result"&gt;
  583. &lt;formatter type="xml"/&gt;
  584. &lt;/test&gt;
  585. &lt;batchtest fork="yes" todir="${reports.tests}"&gt;
  586. &lt;fileset dir="${src.tests}"&gt;
  587. &lt;include name="**/*Test*.java"/&gt;
  588. &lt;exclude name="**/AllTests.java"/&gt;
  589. &lt;/fileset&gt;
  590. &lt;/batchtest&gt;
  591. &lt;/junit&gt;
  592. </pre>
  593. <p>Runs <code>my.test.TestCase</code> in the same VM, ignoring the
  594. given CLASSPATH; only a warning is printed if this test fails. In
  595. addition to the plain text test results, for this test a XML result
  596. will be output to <code>result.xml</code>.
  597. Then, for each matching file in the directory defined for
  598. <code>${src.tests}</code> a
  599. test is run in a separate VM. If a test fails, the build process is
  600. aborted. Results are collected in files named
  601. <code>TEST-</code><em>name</em><code>.txt</code> and written to
  602. <code>${reports.tests}</code>.</p>
  603. <pre>
  604. &lt;target name=&quot;test&quot;&gt;
  605. &lt;property name=&quot;collector.dir&quot; value=&quot;${build.dir}/failingTests&quot;/&gt;
  606. &lt;property name=&quot;collector.class&quot; value=&quot;FailedTests&quot;/&gt;
  607. &lt;!-- Delete 'old' collector classes --&gt;
  608. &lt;delete&gt;
  609. &lt;fileset dir=&quot;${collector.dir}&quot; includes=&quot;${collector.class}*.class&quot;/&gt;
  610. &lt;/delete&gt;
  611. &lt;!-- compile the FailedTests class if present --&gt;
  612. &lt;javac srcdir=&quot;${collector.dir}&quot; destdir=&quot;${collector.dir}&quot;/&gt;
  613. &lt;available file=&quot;${collector.dir}/${collector.class}.class&quot; property=&quot;hasFailingTests&quot;/&gt;
  614. &lt;junit haltonerror=&quot;false&quot; haltonfailure=&quot;false&quot;&gt;
  615. &lt;sysproperty key=&quot;ant.junit.failureCollector&quot; value=&quot;${collector.dir}/${collector.class}&quot;/&gt;
  616. &lt;classpath&gt;
  617. &lt;pathelement location=&quot;${collector.dir}&quot;/&gt;
  618. &lt;/classpath&gt;
  619. &lt;batchtest todir=&quot;${collector.dir}&quot; unless=&quot;hasFailingTests&quot;&gt;
  620. &lt;fileset dir=&quot;${collector.dir}&quot; includes=&quot;**/*.java&quot; excludes=&quot;**/${collector.class}.*&quot;/&gt;
  621. &lt;!-- for initial creation of the FailingTests.java --&gt;
  622. &lt;formatter type=&quot;failure&quot;/&gt;
  623. &lt;!-- I want to see something ... --&gt;
  624. &lt;formatter type=&quot;plain&quot; usefile=&quot;false&quot;/&gt;
  625. &lt;/batchtest&gt;
  626. &lt;test name=&quot;FailedTests&quot; if=&quot;hasFailingTests&quot;&gt;
  627. &lt;!-- update the FailingTests.java --&gt;
  628. &lt;formatter type=&quot;failure&quot;/&gt;
  629. &lt;!-- again, I want to see something --&gt;
  630. &lt;formatter type=&quot;plain&quot; usefile=&quot;false&quot;/&gt;
  631. &lt;/test&gt;
  632. &lt;/junit&gt;
  633. &lt;/target&gt;
  634. </pre>
  635. <p>On the first run all tests are collected via the <code>&lt;batchtest/&gt;</code>
  636. element. It's <code>plain</code> formatter shows the output on the console. The
  637. <code>failure</code> formatter creates a java source file in
  638. <code>${build.dir}/failingTests/FailedTests.java</code> which extends
  639. <code>junit.framework.TestCase</code> and returns from a <code>suite()</code>
  640. method a test suite for the failing tests. <br/>
  641. On a second run the collector class exists and instead of the <code>&lt;batchtest/&gt;</code>
  642. the single <code>&lt;test/&gt;</code> will run. So only the failing test cases are re-run.
  643. The two nested formatters are for displaying (for the user) and for updating the collector
  644. class.
  645. </p>
  646. </body>
  647. </html>