testcoverage

package
v2.10.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 18, 2024 License: GPL-3.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrThresholdNotInRange         = errors.New("threshold must be in range [0 - 100]")
	ErrCoverageProfileNotSpecified = errors.New("coverage profile file not specified")
	ErrRegExpNotValid              = errors.New("regular expression is not valid")
	ErrCDNOptionNotSet             = errors.New("CDN options are not valid")
	ErrGitOptionNotSet             = errors.New("git options are not valid")
)

Functions

func Check

func Check(w io.Writer, cfg Config) bool

func ConfigFromFile

func ConfigFromFile(cfg *Config, filename string) error

func ReportForGithubAction

func ReportForGithubAction(w io.Writer, result AnalyzeResult)

func ReportForHuman

func ReportForHuman(w io.Writer, result AnalyzeResult)

func SetGithubActionOutput

func SetGithubActionOutput(result AnalyzeResult, report string) error

Types

type AnalyzeResult

type AnalyzeResult struct {
	Threshold              Threshold
	FilesBelowThreshold    []coverage.Stats
	PackagesBelowThreshold []coverage.Stats
	MeetsTotalCoverage     bool
	TotalCoverage          int
}

func Analyze

func Analyze(cfg Config, coverageStats []coverage.Stats) AnalyzeResult

func (*AnalyzeResult) Pass

func (r *AnalyzeResult) Pass() bool

type Badge added in v2.8.0

type Badge struct {
	FileName string
	CDN      badgestorer.CDN
	Git      badgestorer.Git
}

type Config

type Config struct {
	Profile            string     `yaml:"profile"`
	LocalPrefix        string     `yaml:"local-prefix"`
	Threshold          Threshold  `yaml:"threshold"`
	Override           []Override `yaml:"override,omitempty"`
	Exclude            Exclude    `yaml:"exclude"`
	GithubActionOutput bool       `yaml:"github-action-output"`
	Badge              Badge      `yaml:"-"`
}

func (Config) Validate

func (c Config) Validate() error

type Exclude added in v2.6.0

type Exclude struct {
	Paths []string `yaml:"paths,omitempty"`
}

type Override added in v2.7.0

type Override struct {
	Threshold int    `yaml:"threshold"`
	Path      string `yaml:"path"`
}

type Threshold

type Threshold struct {
	File    int `yaml:"file"`
	Package int `yaml:"package"`
	Total   int `yaml:"total"`
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL