testcoverage

Documentation

Index

• Variables
• func Check(w io.Writer, cfg Config) bool
• func ConfigFromFile(cfg *Config, filename string) error
• func ReportForGithubAction(w io.Writer, result AnalyzeResult)
• func ReportForHuman(w io.Writer, result AnalyzeResult)
• func SetGithubActionOutput(result AnalyzeResult) error
• type AnalyzeResult
  • func Analyze(cfg Config, coverageStats []coverage.Stats) AnalyzeResult
  • func (r *AnalyzeResult) Pass() bool
• type Badge
• type Config
  • func (c Config) Validate() error
• type Exclude
• type Override
• type Threshold

Variables

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) 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

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

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

type Override

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"`
}