JSON Coverage Report

The JSON coverage-report format is provided to simplify the task of post-processing a PyUCIS coverage report. The JSON format is easily read and processed by Python as well as JSON libraries for other languages.

The JSON coverage-report format is a direct transcription of the Coverage Report Object API.

PyUCIS JSON Coverage Report

https://fvutils.github.io/pyucis/covreport.json

Validation schema for the PyUCIS machine-readable coverage report

type

object

properties

  • covreport

Coverage Report

Root of the coverage report

type

object

properties

  • covergroups

List of (type) covergroups

type

array

items

Covergroup Type

  • coverage

Coverage percentage achieved by all covergroups

type

number

additionalProperties

False

Covergroup Type

Contains information about a type covergroup

properties

  • name

Type name of the covergroup

type

string

  • coverage

Coverage percentage achieved by this covergroup type

type

number

  • coverpoints

List of coverpoints

type

array

items

Coverpoint

  • covergroups

List of instance covergroups

type

array

items

Covergroup Inst

Covergroup Inst

Contains information about an instance covergroup

type

object

properties

  • name

Instance name of this covergroup

type

string

  • coverage

Coverage percentage achieved by this covergroup type

type

number

  • coverpoints

List of coverpoints

type

array

items

Coverpoint

  • crosses

List of cross coverpoints

type

array

items

Cross

  • covergroups

List of instance covergroups

type

array

items

Covergroup Inst

Coverpoint

Coverage information about a coverpoint

type

object

properties

  • name

Leaf name of the coverpoint

type

string

  • coverage

Coverage achieved by this cross

type

number

  • bins

List of coverage bins

type

array

items

Coverage Bin

  • ignorebins

List of ignored coverage bins

type

array

items

Coverage Bin

  • illegalbins

List of illegal coverage bins

type

array

items

Coverage Bin

Cross

Coverage information about a cross coverpoint

type

object

properties

  • name

Leaf name of the cross

type

string

  • coverage

Coverage achieved by this cross

type

number

  • bins

List of coverage bins

type

array

items

Coverage Bin

Cover Bin

Coverpoint or cross bin

type

object

properties

  • name

Name of the bin

type

string

  • goal

Number of bin hits required to claim coverage

type

integer

  • count

Number of hits the bin has

type

integer