covergate

type Baseline struct {
	// Total is the minimum acceptable overall percentage.
	Total float64 `json:"total"`
	// Packages maps a package import path to its minimum percentage.
	Packages map[string]float64 `json:"packages"`
	// Exclude records the glob patterns used when the baseline was written,
	// so a later check cannot silently widen them.
	Exclude []string `json:"exclude,omitempty"`
	// Mode records the "go test -covermode" counter mode the baseline was
	// measured with. Percentages are not comparable across modes, so a later
	// check measured in a different mode is rejected.
	Mode string `json:"mode,omitempty"`
	// OS records the GOOS the baseline was measured on. Platform-specific
	// branches are unreachable, and therefore uncovered, on every other
	// platform, so percentages are not comparable across operating systems.
	OS string `json:"os,omitempty"`
	// Note is free-form context for humans reading the file.
	Note string `json:"note,omitempty"`
}

type Block struct {
	// File is the import-path-qualified file name, for example
	// "github.com/jongio/azd-core/env/load.go".
	File string
	// Statements is the number of statements in the block.
	Statements int
	// Count is the number of times the block was executed.
	Count int
}

type CheckError struct {
	Regressions []Regression
}

type CheckOptions struct {
	// Tolerance is the percentage drop allowed before a regression is
	// reported. It absorbs rounding noise from non-deterministic test
	// selection. Zero means any drop fails.
	Tolerance float64
	// IgnoreNewPackages disables the "new package below total" rule. By
	// default a package absent from the baseline must at least meet the
	// baseline total, so new code cannot dilute overall coverage.
	IgnoreNewPackages bool
	// AllowExcludeDrift permits the report's exclude patterns to differ from
	// those recorded in the baseline. By default a mismatch fails, because
	// widening exclusions is the easiest way to fake a passing gate.
	AllowExcludeDrift bool
	// AllowModeDrift permits the profile's counter mode to differ from the
	// mode the baseline was recorded with. By default a mismatch fails,
	// because percentages are not comparable across modes.
	AllowModeDrift bool
	// AllowOSDrift permits the check to run on a different GOOS than the
	// baseline was recorded on. By default a mismatch fails, because
	// platform-specific code is unreachable, and so uncovered, elsewhere.
	AllowOSDrift bool
}

type Config struct {
	// Profile is the coverage profile to read. Defaults to "coverage.out".
	Profile string
	// BaselineFile is where the recorded floor lives. Defaults to
	// DefaultBaselineFile.
	BaselineFile string
	// Exclude holds glob patterns for code that should not count, such as
	// generated sources.
	Exclude []string
	// Check tunes ratchet enforcement.
	Check CheckOptions
	// SkipOnForeignOS downgrades a platform mismatch from a failure to a
	// visible notice, so a developer on a platform other than the one the
	// baseline was recorded on still gets a coverage report instead of a
	// hard stop. Enforcement then belongs to CI, which runs on the recording
	// platform. Leave it false wherever the gate is authoritative.
	SkipOnForeignOS bool
	// Out receives human-readable progress. Defaults to os.Stdout.
	Out io.Writer
}

type Delta struct {
	// Scope is "total" or a package import path.
	Scope string
	// Baseline is the recorded floor.
	Baseline float64
	// Current is the measured value.
	Current float64
	// New reports whether the scope is absent from the baseline.
	New bool
}

type Options struct {
	// Exclude holds slash-separated glob patterns matched against each
	// block's file path. Matching blocks are dropped before any percentage
	// is computed. Use this for generated code, for example "**/gen/**".
	Exclude []string
}

type ProfileData struct {
	// Mode is the value of the profile's "mode:" header, such as "atomic".
	Mode string
	// Blocks holds every counted region in the profile.
	Blocks []Block
}

type Regression Delta

type Report struct {
	// Total is coverage across every retained block.
	Total Stats `json:"total"`
	// Packages maps a package import path to its coverage.
	Packages map[string]Stats `json:"packages"`
	// Mode is the counter mode of the profile this report came from, such as
	// "atomic". Aggregate leaves it empty; Profile fills it in from the
	// profile header.
	Mode string `json:"mode,omitempty"`
	// OS is the GOOS the profile was measured on. Aggregate leaves it empty;
	// Profile fills it in from the running process, because a profile is only
	// ever produced by tests running on the current platform.
	OS string `json:"os,omitempty"`
	// Excluded is the number of blocks dropped by the Exclude patterns.
	Excluded int `json:"-"`
	// contains filtered or unexported fields
}

type Stats struct {
	Covered    int `json:"covered"`
	Statements int `json:"statements"`
}