Squish Coco

Code Coverage Measurement for C/C++

Part V
Command Line Tools

Chapter 27  cmreport - Code Coverage Report Generation

Syntax: cmreport -m <csmes_file> -s <selection> ...


Where:

-m <argument> | --csmes=<argument>
CSMes file name
-l <argument> | --level=<argument>
code coverage level
-s <argument> | --select=<argument>
select executions using regular expression
-d <argument> | --deselect=<argument>
deselect executions using regular expression
-h <argument> | --html=<argument>
browsable HTML report output file name
--html-single=<argument>
HTML report output file name (single file)
-t <argument> | --text=<argument>
text report output file name
--stat
print global coverage statistics on the standard output
-x <argument> | --xml=<argument>
XML report output file name
--csv-method=<argument>
Generate a CSV report file for each method
--csv-function=<argument>
Generate a CSV report file for each file
--emma=<argument>
Generate an EMMA-XML report
--executions-reference-from-csmes=<argument>
select all executions present in the specified CSMes file.
-mr <argument> | --csmes-reference=<argument>
CSMes reference file name. When specified, the report is generated compares two software releases together.
--release-comparison=<argument>
comparison mode when comparing two software releases together. Possible values:
none
Only displaying the differences between two software released.
modified_functions
Code coverage only on modified functions.
unmodified_functions
Code coverage only on identical functions.
-sr <argument> | --select-reference=<argument>
select reference executions using regular expression. This option activates the comparison of executions together.
-dd <argument> | --deselect-reference=<argument>
deselect reference executions using regular expression. This option activates the comparison of executions together.

Specific options for HTML/XML output:

--execution-level=<argument>
code coverage level for executions
--method-level=<argument>
code coverage level for methods
--css=<argument>
CSS style sheet
--icon=<argument>
Icon
--title=<argument>
Title
--global=<argument>
Global statistics, values=all, selected or selected_and_first
--method=<argument>
Method statistics, values=all, selected or selected_and_first
--execution=<argument>
Execution statistics, values=all, selected or selected_and_first
--source=<argument>
Source file statistics, values=all, selected or selected_and_first
--method-sort=<argument>
Method sorting, values=name or coverage
--execution-sort=<argument>
Execution sorting, values=name or coverage
--source-sort=<argument>
Source file sorting, values=name or coverage
--global-watermark-low-medium=<argument>
Global watermark setting
--global-watermark-medium-high=<argument>
Global watermark setting
--source-watermark-low-medium=<argument>
Source watermark setting
--source-watermark-medium-high=<argument>
Source watermark setting
--method-watermark-low-medium=<argument>
Method watermark setting
--method-watermark-medium-high=<argument>
Method watermark setting
--execution-watermark-low-medium=<argument>
Execution watermark setting
--execution-watermark-medium-high=<argument>
Execution watermark setting
--source-sublevels=<argument>
Maximum number of intermediate levels for sources
--execution-sublevels=<argument>
Maximum number of intermediate levels for executions
--global-sublevels=<argument>
Maximum number of intermediate levels for global statistics
--method-sublevels=<argument>
Maximum number of intermediate levels for methods
--source-filter-min=<argument>
Filtering out source files according the statistic
--source-filter-max=<argument>
Filtering out source files according the statistic
--method-filter-min=<argument>
Filtering out methods according the statistic
--method-filter-max=<argument>
Filtering out methods according the statistic
--execution-filter-min=<argument>
Filtering out executions according the statistic
--execution-filter-max=<argument>
Filtering out executions according the statistic
-b | --coverage-branch
code coverage on branch level only
-t | --test-coverage
test count mode
-D | --debug
debug flag
--toc
Table of contents
--manually-validated
Manually validated code fragments
--unexecuted
Unexecuted code fragments
--executed
Executed code fragments
--bargraph
Coverage data displayed in a bargraph

Specific options for text output:

--format-executed=<argument>
Line format for the executed for code fragments
--format-unexecuted=<argument>
Line format for the unexecuted for code fragments
Following keywords are substituted:
%f
Source code file name
%l
Line number
%c
Column number
%m
Explanation
It is allowed to to set the output file to an empty string (i.e.: --text=), in this case the standard output of the console is used.

Specific options for CSV output:

--csv-field-separator=<argument>
Field separator for a CSV file
--csv-coma=<argument>
Coma (, or .) used for floats in a CSV file

cmreport is a utility which permits to generate Text, HTML  XML or CSV reports from an instrumentation data base (.csmes file). It generates exactly the same reports as these generated by CoverageBrowser (see chap. export-statistics).

Chapter 28  cmcsexeimport - Command Line Import Utility

Syntax: cmcsexeimport -m <csmes_file> -e <csexe_file> -t <title> [-p <policy>]


Where:

-m <argument>|--csmes=<argument>
CSMes file name
-e <argument>|--csexe=<argument>
CSExe file name
-t <argument>|--title=<argument>
Execution title
-p <argument>|--policy=<argument>
Import policy (ignore_duplicates, import_duplicates_and_empty, import_duplicates or merge)
-P|--passed
Execution marked as passed.
-F|--failed
Execution marked as failed.
-C|--check-manually
Execution marked as to be checked manually.

cmcsexeimport is a utility which permits to import an execution report (.csexe file) into an instrumentation data base (.csmes file). It behaves exactly like CoverageBrowser load of execution report function (see chap. load-execution-report).

Chapter 29  cmmerge - Merging Utility

Syntax: cmmerge -o <output_file> <input_file> ... <input_file>


Where:

-o <argument>|--output=<argument>
CSMes output file
-a|--append
Do not create new output file but merge into an existing CSMes file.
-v|--verbose
Verbose output
-i <argument>|--instrumentation-and-execution=<argument>
Merge only instrumentations and executions present in the reference file (for importing unittests)

cmmerge is a small utility which permits to merge several instrumentation databases (.csmes file) together. It behaves exactly like CoverageBrowser merge function (see chap. mergedatabase).