XMLReporter
Produces an XML report of Code Coverage for the given coverage database.
Usage
java com.atlassian.clover.reporters.xml.XMLReporter [OPTIONS] PARAMS
Note: in Clover 3.1.x and older a class was named com.cenqua.clover.reporters.xml.XMLReporter.
Parameters
-i, --initstring <file> | The initstring of the coverage database. |
-o, --outfile <file> | The file to write XML output to. |
Options
-a, --alwaysreport | Forces a report to be generated, even if there is no coverage data. Defaults to ' |
-d, --debug | Switch logging level to debug. |
-f, --filter <string> | Comma or space separated list of contexts to ignore when generating coverage reports. Most useful one is "catch". |
-if --includefailcoverage | Specifies whether or not to include coverage attributed to a test that has failed. If omitted, failed test coverage is not included. Default setting is 'false'. |
-l, --lineinfo | Include source-level coverage info. |
-s, --span <interval> | Specifies how far back in time to include coverage recordings from. . See Using Spans. Default includes "all coverage data found". |
| -si, --showinner | Since 3.2.0: Show inner functions in the report (like a lambda function inside a method). |
| -sl, --showlambda | Since 3.2.0: Show lambda functions in the report. |
| -tc, --threadcount <int> | Number of additional threads to be allocated to report generation. Default is 0. |
-t, --title <string> | Report title. |
-v, --verbose | Switch logging level to verbose. |
Return code
@since Clover 3.1.12: The XMLReporter.main() calls System.exit() and returns non-zero return code in case of error during XML report generation.
API Usage
XMLReporter provides a simple API that accepts an array of strings representing the command line arguments and returns an integer result code. The following fragment illustrates use of the API:
import com.atlassian.clover.CloverStartup;
import com.atlassian.clover.Logger;
import com.atlassian.clover.reporters.xml.XMLReporter;
public class XmlReportRunner {
public void runReport() {
CloverStartup.loadLicense(Logger.getInstance());
String [] cliArgs = { "-i", "clover.db", "-o", "clover.xml" };
int result = XMLReporter.runReport(cliArgs);
if (result != 0) {
// problem during report generation
}
}
}Examples
java com.atlassian.clover.reporters.xml.XMLReporter -i clover.db -o coverage.xmlRead coverage for the Clover database "clover.db", and produce a report in the file "coverage.xml"
java com.atlassian.clover.reporters.xml.XMLReporter -l -t "My Coverage" -i clover.db -o coverage.xmlProduce the same report as above, but include source-level coverage information, and a report title.