Coverage report file format

Edit online

The final coverage report (<map>.mcr.json) is a JSON file that conforms to the CoverageReport.schema.json schema, which is included in the product distribution. The report is an array of JSON documents. There is one document for each executable map and each run map, for each coverage run identifier. Additionally, there are aggregate summary documents that provide rolled-up coverage status across all runs.

Top-level fields

The following table describes the top-level properties within each JSON document in the report:

Property	Values	Description
`mapName`	String	The compiled map file name (.mmc).
`mapNameMMC`	String	The map name without the file extension.
`coverageId`	String	The coverage run identifier (for example, Default, GoodAudit, RUNID1).
`coverageType`	String	The coverage type. Currently always Basic.
`coverageTime`	Number	Elapsed execution time in seconds for this coverage run.
`reportLevel`	String	The report level used: DETAILS, OUTLINE, or VERBOSE.
`runMap`	Boolean	True if this document describes a run map; false if it describes an executable map.
`mapDirectory`	String	The directory where the compiled map is located.
`sourceMap`	String	The path to the source map file (.mms), if available.
`inputs`	Array	Input card information for this coverage run.
`outputs`	Array	Output card information including executed rule counts and unexecuted rule details.
`executedFunctionalMaps`	Array	Functional maps that were invoked during this run.
`unexecutedFunctionalMaps`	Array	Functional maps that were never invoked during this run.
`executedRunMaps`	Array	Run maps that were called, with execution counts.
`unexecutedRunMaps`	Object	Run maps that were not called, organized under knownRunMaps.

Output card fields

Each entry in the outputs array contains the following properties:

Property	Values	Description
`cardNumber`	Integer	The card number as defined in the map.
`cardName`	String	The output card name.
`schemaName`	String	The type tree or schema file name.
`schemaType`	String	The root type name in the schema.
`cardAdapter`	String	The adapter type (for example, File).
`cardCommand`	String	The output file or command used for this run.
`executedRuleCount`	Integer	Total number of rules that were executed for this output card.
`unexecutedRules`	Array	Array of unexecuted rules. Each entry includes the target path, rule text (for Details and Verbose report levels only), and ruleType.