coverage

Documentation

Index

• Constants
• Variables
• func CoveredPercentage(total, covered int64) int
• func StatsPluckName(stats []Stats) []string
• func StatsSearchMap(stats []Stats) map[string]Stats
• func StatsSerialize(stats []Stats) []byte
• type Config
• type FileCoverageDiff
• type Stats
  • func GenerateCoverageStats(log *zap.Logger, cfg Config) ([]Stats, error)
  • func StatsCalcTotal(stats []Stats) Stats
  • func StatsDeserialize(b []byte) ([]Stats, error)
  • func StatsFilterWithCoveredLines(stats []Stats) []Stats
  • func StatsFilterWithMissingExplanations(stats []Stats) []Stats
  • func StatsFilterWithUncoveredLines(stats []Stats) []Stats
  • func (s Stats) CoveredPercentage() int
  • func (s Stats) CoveredPercentageF() float64
  • func (s Stats) CoveredPercentageFNR() float64
  • func (s Stats) Str() string
  • func (s Stats) UncoveredLinesCount() int

Constants

const IgnoreText = "coverage-ignore"

Variables

var ErrInvalidFormat = errors.New("invalid format")

Functions

func CoveredPercentage

func CoveredPercentage(total, covered int64) int

func StatsPluckName

func StatsPluckName(stats []Stats) []string

func StatsSearchMap

func StatsSearchMap(stats []Stats) map[string]Stats

func StatsSerialize

func StatsSerialize(stats []Stats) []byte

Types

type Config

type Config struct {
	Profiles               []string
	ExcludePaths           []string
	SourceDir              string
	ForceAnnotationComment bool
}

type FileCoverageDiff

type FileCoverageDiff struct {
	Current Stats  `json:"current"`
	Base    *Stats `json:"base,omitempty"`
}

FileCoverageDiff holds per-file coverage difference between current and base.

type Stats

type Stats struct {
	Name                       string
	Total                      int64
	Covered                    int64
	Threshold                  int
	UncoveredLines             []int
	AnnotationsWithoutComments []int
}

func GenerateCoverageStats

func GenerateCoverageStats(log *zap.Logger, cfg Config) ([]Stats, error)

func StatsCalcTotal

func StatsCalcTotal(stats []Stats) Stats

func StatsDeserialize

func StatsDeserialize(b []byte) ([]Stats, error)

func StatsFilterWithCoveredLines

func StatsFilterWithCoveredLines(stats []Stats) []Stats

func StatsFilterWithMissingExplanations

func StatsFilterWithMissingExplanations(stats []Stats) []Stats

StatsFilterWithMissingExplanations returns stats that have missing explanations

func StatsFilterWithUncoveredLines

func StatsFilterWithUncoveredLines(stats []Stats) []Stats

func (Stats) CoveredPercentage

func (s Stats) CoveredPercentage() int

func (Stats) CoveredPercentageF

func (s Stats) CoveredPercentageF() float64

func (Stats) CoveredPercentageFNR

func (s Stats) CoveredPercentageFNR() float64

func (Stats) Str

func (s Stats) Str() string

func (Stats) UncoveredLinesCount

func (s Stats) UncoveredLinesCount() int