testcoverage

Documentation

Index

• Variables
• func ConfigFromFile(cfg *Config, filename string) error
• func CoveredPercentage(total, covered int64) int
• func GenerateAndSaveBadge(w io.Writer, cfg Config, totalCoverage int) 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 []CoverageStats) AnalyzeResult
  • func Check(w io.Writer, cfg Config) (AnalyzeResult, error)
  • func (r *AnalyzeResult) Pass() bool
• type Badge
• type CDN
• type Config
  • func (c Config) Validate() error
• type CoverageStats
  • func GenerateCoverageStats(cfg Config) ([]CoverageStats, error)
  • func (s *CoverageStats) CoveredPercentage() int
• type Exclude
• type FuncExtent
• type FuncVisitor
  • func (v *FuncVisitor) Visit(node ast.Node) ast.Visitor
• type Git
• type Override
• type Threshold

Variables

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

Functions

func ConfigFromFile

func ConfigFromFile(cfg *Config, filename string) error

func CoveredPercentage

func CoveredPercentage(total, covered int64) int

func GenerateAndSaveBadge

func GenerateAndSaveBadge(w io.Writer, cfg Config, totalCoverage int) 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    []CoverageStats
	PackagesBelowThreshold []CoverageStats
	MeetsTotalCoverage     bool
	TotalCoverage          int
}

func Analyze

func Analyze(cfg Config, coverageStats []CoverageStats) AnalyzeResult

func Check

func Check(w io.Writer, cfg Config) (AnalyzeResult, error)

func (*AnalyzeResult) Pass

func (r *AnalyzeResult) Pass() bool

type Badge

type Badge struct {
	FileName string
	CDN      CDN
	Git      Git
}

type CDN

type CDN struct {
	Key            string
	Secret         string
	Region         string
	FileName       string
	BucketName     string
	Endpoint       string
	ForcePathStyle bool
}

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 CoverageStats

type CoverageStats struct {
	Name      string
	Total     int64
	Covered   int64
	Threshold int
}

func GenerateCoverageStats

func GenerateCoverageStats(cfg Config) ([]CoverageStats, error)

func (*CoverageStats) CoveredPercentage

func (s *CoverageStats) CoveredPercentage() int

type Exclude

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

type FuncExtent

type FuncExtent struct {
	// contains filtered or unexported fields
}

FuncExtent describes a function's extent in the source by file and position.

type FuncVisitor

type FuncVisitor struct {
	// contains filtered or unexported fields
}

FuncVisitor implements the visitor that builds the function position list for a file.

func (*FuncVisitor) Visit

func (v *FuncVisitor) Visit(node ast.Node) ast.Visitor

Visit implements the ast.Visitor interface.

type Git

type Git struct {
	Token      string
	Owner      string
	Repository string
	Branch     string
	FileName   string
}

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