Produces a JSON report of Code Coverage for the given coverage database.

Usage

 java com.atlassian.clover.reporters.json.JSONReporter [OPTIONS] PARAMS

Parameters

-i, --initstring <file>

The initstring of the coverage database.

-o, --outputdir <dir>

The output directory for generated JSON.

Options

-a, --alwaysreport

Forces a report to be generated, even if there is no coverage data. Defaults to 'false', i.e. a report with no coverage will abort generation.

-d, --debug

Switch logging level to debug.

-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'.

-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.

-v, --verbose

Switch logging level to verbose.

Return code

The JSONReporter.main() calls System.exit() and returns non-zero return code in case of error during JSON report generation.

API Usage

JSONReporter 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.json.JSONReporter;

public class JsonReportRunner {
    public void runReport() {
        // CloverStartup.loadLicense(Logger.getInstance()); - required for Atlassian Clover 4.1.2 or older
        String [] cliArgs = { "-i", "clover.db", "-o", "clover_json" };
        int result = JSONReporter.runReport(cliArgs);
        if (result != 0) {
            // problem during report generation
        }
    }
}

Examples

 java com.atlassian.clover.reporters.json.JSONReporter -i clover.db -o clover_json

Read coverage for the Clover database "clover.db" and produce a report in the directory "clover_json".