Changes between Version 7 and Version 8 of Recipe Commands

Timestamp:

Oct 6, 2005, 6:34:04 PM (19 years ago)

Author:

cmlenz

Comment:

Document <java:junit> and <report>

Recipe Commands

@@ -5 +5 @@
 
   ''Note: the recipe format has changed since [milestone:0.4]. You can find documentation about the previous format by looking at version 3 of this page (see the “page history” link above).''
+
+----
+
+== Generic Commands ==
+
+These are commands that are used without a namespace prefix.
+
+=== `<report>` ===
+
+Parse an XML file and send it to the master as a report with a given category. Use this command in conjunction with the `<sh:pipe>` or `<x:transform>` commands to send custom reports to the build master.
+
+==== Parameters ====
+
+|| Name || Description ||
+|| `category` || Category of the report (for example “test” or “coverage”). ||
+|| `file` || Path to the XML file containing the report data, relative to the project directory. ||
+
+Both parameters must be specified.
 
 ----
@@ -125 +143 @@
 || `file` || Path of the build file, relative to the project source directory (default is `build.xml`). ||
 || `target` || Name of the build target(s) to execute. ||
+|| `args` || Additional arguments to pass to Ant, separated by whitespace. ||
 || `keep_going` || Tell Ant to continue even when errors are in encountered in the build. ||
 
@@ -134 +153 @@
 
 Executes the target `compile` of the `build.xml` buildfile at the top of the project source directory.
+
+=== `<java:junit>` ===
+
+Extracts information about unit test results from a file in [http://junit.org/index.htm JUnit] XML format.
+
+==== Parameters ====
+
+|| Name || Description ||
+|| `file` || Path to the JUnit XML test results file. This can include wildcards, in which case all the file matching the pattern will be included. ||
+|| `srcdir` || Path of the directory unit test sources. Used to link the test cases to files. ||
+
+The `file` attribute is required.
+
+==== Examples ====
+
+{{{
+ <java:junit file="build/tests/results/TEST-*.xml" srcdir="src/tests" />
+}}}
+
+Collects the test results from all files in the `build/tests/results` directory that match the pattern `TEST-*.xml`. Also, maps the class names in the results files to Java source files in the directory `src/tests`.
 
 ----