Coverage JSON files

The map coverage workflow involves three primary JSON files that serve as the inputs, execution logs, and final outputs of the test coverage engine. In each file name, the variable <map> represents the name of the compiled map (.mmc) file without the file extension.

Coverage settings file (<map>.mcs.json)

The coverage settings file is named <map>.mcs.json.

Coverage settings file is a user-authored JSON file that defines configurations for one or more coverage runs with input and output overrides. Use this file to specify unique coverage run identifiers, report levels, diagnostic logging properties, and error-handling behaviors that control how the transformation engine runs each test scenario. The system saves this file in the same directory as the compiled map.

Note:

• You can configure the coverage runs using the Coverage Settings dialog in Design Studio, or you can create the settings file manually in a text editor to conform to the CoverageSettings.schema.json schema that is included in the product distribution.
• To minimize the overall file size of the <map>.mcs.json file, the Map Designer writes only the overridden input cards and output cards to the file when you save your configuration. Any cards that are set to use their default compiled map settings use their originally compiled paths and do not generate entries in this settings file.

Interim report file (<map>.mcr~.json)

The interim report file is named <map>.mcr~.json.

The transformation engine automatically generates the interim report file during map execution. This temporary file records the specific map rules that run successfully for each active coverage run. Because the engine writes this file during run time, the file contains compiled binary rule identifiers and does not resolve the rules to readable text.

Final coverage report file (<map>.mcr.json)

The final coverage report file is named <map>.mcr.json.

The dtxcoverage utility generates the final coverage report file from the interim report. The final report contains the executed and unexecuted map rules, executed and unexecuted functional maps, and executed and unexecuted known run maps.

The report contains an array of JSON documents, with one document for each executable map and run map per coverage run identifier. It also includes an aggregate summary document that rolls up overall coverage statistics across all combined active runs. This report conforms to the CoverageReport.schema.json schema, which is included in the product distribution for customer validation.