2001-02-13 12:32:01 +00:00
|
|
|
<html>
|
|
|
|
|
<head>
|
2005-04-29 18:58:16 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
2002-02-03 22:11:39 +00:00
|
|
|
<title>JUnitReport Task</title>
|
2001-02-13 12:32:01 +00:00
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<h2><a name="junitreport">JUnitReport</a></h2>
|
|
|
|
|
Merge the individual XML files generated by the JUnit task and eventually apply
|
|
|
|
|
a stylesheet on the resulting merged document to provide a browsable report of
|
|
|
|
|
the testcases results.
|
2002-03-14 01:01:18 +00:00
|
|
|
<p><strong>Note:</strong> This task depends on external libraries not included in
|
|
|
|
|
the Ant distribution. See <a href="../install.html#librarydependencies">
|
|
|
|
|
Library Dependencies</a> for more information.</p>
|
|
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Requirements</h3>
|
2004-06-25 13:42:10 +00:00
|
|
|
|
|
|
|
|
<p>The task needs Apache <a
|
2004-07-30 17:47:57 +00:00
|
|
|
href="http://xml.apache.org/xalan-j/">Xalan 2.4.1+ or Xalan XSLTC</a>
|
2004-06-25 13:42:10 +00:00
|
|
|
(JDK 1.4 contains a version of Xalan-J 2.x while JDK 1.5 ships with a
|
2004-07-30 17:47:57 +00:00
|
|
|
version of XSLTC). Starting from JDK 1.4.2-01 it ships with a bundled
|
|
|
|
|
Xalan-J 2.4.1+, meaning that JDK version prior to 1.4.2-01 won't work
|
|
|
|
|
out of the box. The table below summarize the compatibility status.
|
|
|
|
|
</p>
|
|
|
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
|
|
|
|
<tr><th>Xalan</th><th>Sun JDK Bundle</th><th>Status<th></tr>
|
|
|
|
|
<tr><td>2.4.1+</td><td>JDK 1.4.2-01+</td><td>OK</td></tr>
|
|
|
|
|
<tr><td>XSLTC</td><td>JDK 1.5.x</td><td>OK</td></tr>
|
2005-04-29 18:58:16 +00:00
|
|
|
<tr><td>2.x</td><td>JDK 1.4.x</td><td>DEPRECATED<br><i>Use ${ant.home}/etc/junit-frames-xalan1.xsl
|
|
|
|
|
<br> Upgrade Xalan using the JDK endorsement mechanism</i></td></tr>
|
2004-07-30 17:47:57 +00:00
|
|
|
</table>
|
2004-06-25 13:42:10 +00:00
|
|
|
|
2004-07-30 17:47:57 +00:00
|
|
|
<p>With Ant 1.6.2 we had to decide between supporting Xalan-J 1/Xalan J 2.4.1-
|
|
|
|
|
and Xalan 2.4.1+/XSLTC, since there was no way to support both couples at the same
|
|
|
|
|
time.</p>
|
2006-06-25 14:38:27 +00:00
|
|
|
<p>With Ant 1.7 we had to drop support Xalan-J 1, since Xalan-J 1 has not
|
|
|
|
|
available anymore for quite some time.</p>
|
2004-06-25 13:42:10 +00:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Parameters</h3>
|
|
|
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
|
|
|
|
<tr>
|
|
|
|
|
<td width="12%" valign="top"><b>Attribute</b></td>
|
|
|
|
|
<td width="78%" valign="top"><b>Description</b></td>
|
|
|
|
|
<td width="10%" valign="top"><b>Required</b></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">tofile</td>
|
|
|
|
|
<td valign="top">The name of the XML file that will aggregate all individual
|
|
|
|
|
XML testsuite previously generated by the JUnit task.</td>
|
|
|
|
|
<td align="center" valign="top">No. Default to TESTS-TestSuites.xml</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">todir</td>
|
|
|
|
|
<td valign="top">The directory where should be written the file resulting
|
|
|
|
|
from the individual XML testsuite aggregation.</td>
|
|
|
|
|
<td align="center" valign="top">No. Default to current directory</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
<h3><a name="nested">Nested Elements</a></h3>
|
|
|
|
|
<h4>fileset</h4>
|
|
|
|
|
<p><code>junitreport</code> collects individual xml files generated by the JUnit
|
2001-09-08 01:05:18 +00:00
|
|
|
task using the nested <a href="../CoreTypes/fileset.html"><code><FileSet></code></a>
|
2001-02-13 12:32:01 +00:00
|
|
|
element.</p>
|
|
|
|
|
<h4>report</h4>
|
|
|
|
|
<p>Generate a browsable report based on the document created by the merge.</p>
|
|
|
|
|
<h3>Parameters</h3>
|
|
|
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
|
|
|
|
<tr>
|
|
|
|
|
<td width="12%" valign="top"><b>Attribute</b></td>
|
|
|
|
|
<td width="78%" valign="top"><b>Description</b></td>
|
|
|
|
|
<td width="10%" valign="top"><b>Required</b></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">format</td>
|
|
|
|
|
<td valign="top">The format of the generated report. Must be "noframes"
|
|
|
|
|
or "frames".</td>
|
|
|
|
|
<td align="center" valign="top">No, default to "frames"</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">styledir</td>
|
|
|
|
|
<td valign="top">The directory where the stylesheets are defined. They must
|
|
|
|
|
be conforming to the following conventions:
|
|
|
|
|
<ul>
|
2001-08-07 22:38:49 +00:00
|
|
|
<li>frames format: the stylesheet must be named <i>junit-frames.xsl</i>.</li>
|
|
|
|
|
<li>noframes format: the stylesheet must be named <i>junit-noframes.xsl</i>.</li>
|
2001-02-13 12:32:01 +00:00
|
|
|
</ul>
|
|
|
|
|
</td>
|
|
|
|
|
<td align="center" valign="top">No. Default to embedded stylesheets.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">todir</td>
|
|
|
|
|
<td valign="top">The directory where the files resulting from the
|
|
|
|
|
transformation should be written to.</td>
|
|
|
|
|
<td align="center" valign="top">No. Default to current directory</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
2006-06-30 23:42:17 +00:00
|
|
|
<h3>Nested Element of the report tag</h3>
|
|
|
|
|
<h4>param</h4>
|
|
|
|
|
<em>Since Ant 1.7</em>the report tag supports nested param tags.
|
|
|
|
|
These tags can pass XSL parameters to the stylesheet.
|
|
|
|
|
<h3>Parameters</h3>
|
|
|
|
|
<table width="60%" border="1" cellpadding="2" cellspacing="0">
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top"><b>Attribute</b></td>
|
|
|
|
|
<td valign="top"><b>Description</b></td>
|
|
|
|
|
<td align="center" valign="top"><b>Required</b></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">name</td>
|
|
|
|
|
<td valign="top">Name of the XSL parameter</td>
|
|
|
|
|
<td align="center" valign="top">Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">expression</td>
|
|
|
|
|
<td valign="top">Text value to be placed into the param.<br>
|
|
|
|
|
Was originally intended to be an XSL expression.</td>
|
|
|
|
|
<td align="center" valign="top">Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">if</td>
|
|
|
|
|
<td valign="top">The param will only passed if this property is set.</td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">unless</td>
|
|
|
|
|
<td valign="top">The param will only passed unless this property is set.</td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
</table>
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Example of report</h3>
|
|
|
|
|
<blockquote>
|
|
|
|
|
<pre><junitreport todir="./reports">
|
|
|
|
|
<fileset dir="./reports">
|
|
|
|
|
<include name="TEST-*.xml"/>
|
|
|
|
|
</fileset>
|
|
|
|
|
<report format="frames" todir="./report/html"/>
|
|
|
|
|
</junitreport>
|
|
|
|
|
</pre>
|
|
|
|
|
</blockquote>
|
|
|
|
|
<p>would generate a <tt>TESTS-TestSuites.xml</tt> file in the directory <tt>reports</tt> and
|
|
|
|
|
generate the default framed report in the directory <tt>report/html</tt>.</p>
|
2006-06-30 23:42:17 +00:00
|
|
|
<h3>Example of report with xsl params</h3>
|
|
|
|
|
<blockquote>
|
|
|
|
|
<pre>
|
|
|
|
|
<junitreport todir="${outputdir}">
|
|
|
|
|
<fileset dir="${jrdir}">
|
|
|
|
|
<include name="TEST-*.xml"/>
|
|
|
|
|
</fileset>
|
|
|
|
|
<report todir="${outputdir}/html"
|
|
|
|
|
styledir="junitreport"
|
|
|
|
|
format="frames">
|
|
|
|
|
<param name="key1" expression="value1"/>
|
|
|
|
|
<param name="key2" expression="value2"/>
|
|
|
|
|
</report>
|
|
|
|
|
</junitreport>
|
|
|
|
|
</pre>
|
|
|
|
|
</blockquote>
|
|
|
|
|
<p>This example requires a file called <tt>junitreport/junit-frames.xsl</tt>.
|
|
|
|
|
The XSL parameters key1 and key2 will be passed to the XSL transformation.</p>
|
2002-01-10 08:48:33 +00:00
|
|
|
<hr>
|
2006-06-30 23:42:17 +00:00
|
|
|
<p align="center">Copyright © 2001-2002,2004-2006 The Apache Software Foundation. All rights
|
2002-01-10 08:48:33 +00:00
|
|
|
Reserved.</p>
|
2001-02-13 12:32:01 +00:00
|
|
|
</body>
|
|
|
|
|
|
|
|
|
|
</html>
|
