BullseyeCoverage Up Contents Search

covxml - Export as XML

covxml [options]

Description

Converts coverage data to an XML format. By default, the XML is written to the standard output.

The XML format is described below.

The Root Element

<?xml version="1.0" encoding="UTF-8"?>
<BullseyeCoverage name="basename" dir="directory" buildId="buildId" version="6" xmlns="https://www.bullseye.com/covxml" summary-measurements>
<!-- sequence of <folder> and <src> elements -->
</BullseyeCoverage>

Attribute	Description
`name`	The basename of the coverage file
`dir`	The source directory. The source and folder names are relative to this directory
`buildId`	Identifies the last change made to the coverage file as a result of building

The folder Element

<folder name="basename" summary-measurements>
<!-- sequence of <folder> and <src> elements -->
</folder>

Attribute	Description
`name`	basename of folder

The src Element

<src name="basename" mtime="n" summary-measurements>
<!-- sequence of <fn> elements -->
</src>

Attribute	Description
`name`	basename of source file
`mtime`	timestamp of source file in seconds since the Epoch when the source was instrumented

The fn Element

<fn name="function-name" summary-measurements>
<!-- sequence of <probe> elements -->
<!-- sequence of <block> elements -->
</fn>

Attribute	Description
`name`	function name

The probe Element

<probe line="n" column="n" col_seq="n" kind="kind" event="event"/>

Attribute	Description
`line`	Source file line number
`column`	Beginning column number of the code measured by the probe, not counting whitespace. If not present, the value is zero.
`col_seq`	Column sequence number. Uniquely identifies probes having the same line and column. If not present, the value is zero.
`kind`	One of: `catch`, `condition`, `constant`, `decision`, `for-range-body`, `function`, `switch-label`, `try`. The value `constant` is not written by version 9.4 and later.
`event`	One of: `none`, `false`, `true`, `full`. Value `none` indicates no coverage. Value `false` indicates the condition or decision evaluated to false at least once, but never true. Value `true` indicates the condition or decision evaluated to true at least once, but never false. Value `full` indicates all possible coverage. For example, a decision covered both true and to false is indicated by `full`. When the `kind` attribute has value `constant`, there is no `event` attribute.

The block Element

<block line="n" entered="entered"/>

Attribute	Description
`line`	Source file line number
`entered`	If the block was entered, the value 1, otherwise 0.

The block element is provided to assist with importation to a system that accepts statement coverage or basic block coverage, but cannot use the condition/decision coverage provided by the probe element. You can ignore this element unless you have such a restriction. This information is similar to statement coverage but does not meet the requirement of statement coverage for safety-critical certification.

The block element indicates whether a basic block of contiguous statements was reached. The statements are either a function body, or substatements in a control structure reached by a conditional branch. A statement reached does not imply the statement completed or that subsequent statements were reached. The block elements are derived from condition/decision coverage as described in Instrumentation Model.

Some information available in the probe elements has no representation in the block elements. For example, the events listed below are not indicated.

The branch due to a false outcome of the controlling expression of the if statement when else is omitted
The branch due to a false outcome of the controlling expression of the do statement, for statement, and while statement
The branch due to a true outcome of the controlling expression of the do statement
Completion of a try-block without an exception
Condition outcomes within the && and || operators and the ?: operator
Decision and condition outcomes within the ?: operator
A branch to a specific case or default within a sequence of case and default labels

The summary-measurements Attributes

fn_cov="n" fn_total="n" cd_cov="n" cd_total="n" d_cov="n" d_total="n"

Attribute	Description
`fn_cov`	number of functions invoked for the region
`fn_total`	total number of functions in the region
`cd_cov`	number of conditions and decisions invoked for the region
`cd_total`	total number of conditions and decisions in the region
`d_cov`	number of decisions invoked for the region
`d_total`	total number of decisions in the region

We recommend ignoring the decision coverage measurements, d_cov and d_total. Decision coverage may report uncovered code as covered. Use these measurements only to compare with results from other tools that cannot provide condition/decision coverage.

Options

`-f`Path	`--file` Path	The coverage file is specified by Path. The default is `test.cov`.
`-h`	`--help`	Display a summary of options.
`-o`Output	`--output` Output	Write XML to Output instead of standard output
`-q`	`--quiet`	Suppress warnings and the copyright message.
`--cobertura`		Cobertura format. This format is provided for importation to tools that recognize Cobertura format, but not BullseyeCoverage format. Statement coverage is derived from condition/decision coverage in the same way as for the `block` element described above. Unlike Cobertura, the data contains no branch coverage, complexity metrics, or performance profiling counts.
`--no-banner`		Suppress startup banner
`--xsl`		Include a style sheet reference. When used with `-o`/`--output`, include a processing instruction specifying a style sheet with name derived from Output by removing any suffix and appending `.xsl`. If the style sheet file does not exist, a sample style sheet is written. Note that some browsers do not allow processing XML stylesheets from the local file system. In this case, a blank page appears. Use the stylesheet over HTTP or HTTPS.

Environment Variables

`COVFILE`	The coverage file. Option `-f` (`--file`) overrides this setting.
`COVXMLCFG`	Configuration file. See FILES.

Files

If the files listed below exist, they contain initial options separated by white space. Within these files, $NAME is replaced by the value of the environment variable named NAME.

BullseyeCoverage/bin/covxml.cfg
home-directory/covxml.cfg

Version History

File Version	Software Version	Date	Changes
1	7.7.25	Sep 2007
2	7.8.0	Sep 2007	Remove root element attribute `mtime`, add attribute `buildId`
3	7.11.3	Jan 2009	Add `probe` element attribute `column`
3	7.12.4	Jun 2009	Remove `probe` element attribute `seq`, add attribute `col_seq`
4	8.0.16	Feb 2011	Add root tag attribute `xmlns`
5	8.9.63	Aug 2015	`BullseyeCoverage` element contains top level measurements
6	8.20.0	Oct 2020	Add `block` element

Updated: 24 Jun 2024