diff options
Diffstat (limited to 'framework/src/ant/apache-ant-1.9.6/manual/Tasks/junitreport.html')
| -rw-r--r-- | framework/src/ant/apache-ant-1.9.6/manual/Tasks/junitreport.html | 214 |
1 files changed, 214 insertions, 0 deletions
diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/junitreport.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/junitreport.html new file mode 100644 index 00000000..365920b2 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/junitreport.html @@ -0,0 +1,214 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>JUnitReport Task</title> +</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. +<p><strong>Note:</strong> This task depends on external libraries not included in +the Apache Ant distribution. See <a href="../install.html#librarydependencies"> +Library Dependencies</a> for more information.</p> + +<h3>Requirements</h3> + +<p>The task needs Apache <a +href="http://xml.apache.org/xalan-j/">Xalan 2.4.1+ or Xalan XSLTC</a> +(JDK 1.4 contains a version of Xalan-J 2.x while JDK 1.5 ships with a +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> +<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> +</table> + +<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> +<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> + +<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 +task using the nested <a href="../Types/fileset.html"><code><FileSet></code></a> +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> + <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> + </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> +<p> Ant assumes the following concerning the <tt>frames</tt> and <tt>noframes</tt> formats :</p> +<p>The <tt>frames</tt> format uses +a stylesheet which is generating output <em>only</em> by redirecting.</p> +<p>The +<tt>noframes</tt> format does not use redirecting and generates one +file called <tt>junit-noframes.html</tt>.</p> +<p>Custom versions of <tt>junit-frames.xsl</tt> or <tt>junit-noframes.xsl</tt> must adhere to the above conventions.</p> + +<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 be passed <a href="../properties.html#if+unless">if this property is set</a>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">unless</td> + <td valign="top">The param will not be passed <a href="../properties.html#if+unless">if this property is set</a>.</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<p>The built-in stylesheets support the following parameters:</p> +<table width="60%" border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>XSL-Parameter</b></td> + <td valign="top"><b>Description</b></td> + <td align="center" valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">TITLE</td> + <td valign="top">Title used in <title> and <h1> tags</td> + <td align="center" valign="top">No. Defaults to <i>Unit Test Results.</i></td> + </tr> +</table> + +<h4>classpath</h4> +<p><em>Since Ant 1.9.5.</em> +Like for the <a href="../CoreTasks/style.html#classpath">XSLT task</a>, +a nested <classpath> will be used to load the processor.</p> + +<h4>factory</h4> +<p><em>Since Ant 1.9.5.</em> +Like for the <a href="../CoreTasks/style.html#factory">XSLT task</a>, +a nested <factory> can be used to specify factory settings.</p> + + +<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> +<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> + +</body> + +</html> |