The summary generator creates a CSV file which is used as a cache for the information from the JcReport summary XML file. That CSV file is the input for the HTML trend report. The trend report contains a few diagrams and a table showing how the number of findings evolved over the period for which data is available.
Usage
<jcsummaryreport name="fawkez summary"
summary="${cc.home}/artefacts/global/summary.csv"
dest="${cc.home}/artefacts/global"
basedir="${cc.home}/artefacts" />| Attribute | Meaning |
|---|---|
name | Title of the final HTML page. |
summary | CSV file where the summary information is cached. |
dest | Folder where the HTML report and the diagram images are stored. |
basedir | Folder that contains sub folders with summary XML files. |
The base directory can be the CruiseControl artefacts folder, which contains a number of folders named after the build timestamp, or a custom folder where a nightly JcReport script stores its artefacts.
Task definition
<taskdef name="jcsummaryreport"
classname="org.jcoderz.phoenix.report.JcSummaryReportAntTask">
<classpath refid="jcreport.classpath" />
</taskdef>Running headless
When the task runs on a server under JDK 1.4 or later, the Ant process needs the system property java.awt.headless=true. The chart generation uses the Java 2D API, which does not need a display but does need to be told that no display is available.
How the pieces fit
The summary tool does not analyse code itself. It reads the summary XML files that JcReport produced on earlier builds and compares them. The cache file keeps the history so that a build does not have to read every old report again.
The FAQ explains how the quality percentage shown in these reports is calculated and which weights were configured.