cover

Documentation

Overview

Package cover reports coverage on modules.

Deprecated: This package is intended for older projects transitioning from OPA v0.x and will remain for the lifetime of OPA v1.x, but its use is not recommended. For newer features and behaviours, such as defaulting to the Rego v1 syntax, use the corresponding components in the github.com/open-policy-agent/opa/v1 package instead. See https://www.openpolicyagent.org/docs/latest/v0-compatibility/ for more information.

Index

• type Cover
  • func New() *Cover
• type CoverageThresholdError
• type FileReport
• type Position
• type PositionSlice
• type Range
• type Report

Types

type Cover

type Cover = v1.Cover

Cover computes and reports on coverage.

func New

func New() *Cover

New returns a new Cover object.

type CoverageThresholdError

type CoverageThresholdError = v1.CoverageThresholdError

CoverageThresholdError represents an error raised when the global code coverage percentage is lower than the specified threshold.

type FileReport

type FileReport = v1.FileReport

FileReport represents a coverage report for a single file.

type Position

type Position = v1.Position

Position represents a file location.

type PositionSlice

type PositionSlice = v1.PositionSlice

PositionSlice is a collection of position that can be sorted.

type Range

type Range = v1.Range

Range represents a range of positions in a file.

type Report

type Report = v1.Report

Report represents a coverage report for a set of files.