pckg

Documentation

Overview

Package pckg contains high level representations of package coverage statistics.

Index

• type Group
  • func (g *Group) CoveragePercent() (coveragePercent float64)
  • func (g *Group) EstimateCount() (estimatedCount float64)
  • func (g *Group) MedianStatementCount() float64
  • func (g *Group) SetEstimatedStmtCountFrom(reference Group)
  • func (g *Group) StatementCounts() (statementCounts []float64)
  • func (g *Group) TotalCovered() float64
  • func (g *Group) TotalStatementCount() float64
  • func (g *Group) TotalUncovered() float64
• type Stats
  • func (s *Stats) CoveragePercent() (coveragePercent float64)

Types

type Group

type Group []*Stats

Group is a slice of package stats.

func (*Group) CoveragePercent

func (g *Group) CoveragePercent() (coveragePercent float64)

CoveragePercent calculates the coverage percentage across all packages.

func (*Group) EstimateCount

func (g *Group) EstimateCount() (estimatedCount float64)

EstimateCount returns the number of packages who have had their coverage percentages estimated.

func (*Group) MedianStatementCount

func (g *Group) MedianStatementCount() float64

MedianStatementCount calculates the median number of statements in packages that currently have associated tests.

func (*Group) SetEstimatedStmtCountFrom

func (g *Group) SetEstimatedStmtCountFrom(reference Group)

SetEstimatedStmtCountFrom sets the estimated statement count based on the average number of statements in other packages in the group.

func (*Group) StatementCounts

func (g *Group) StatementCounts() (statementCounts []float64)

StatementCounts returns a list of statement counts from the group.

func (*Group) TotalCovered

func (g *Group) TotalCovered() float64

TotalCovered returns the total number of statements that have been covered by unit tests.

func (*Group) TotalStatementCount

func (g *Group) TotalStatementCount() float64

TotalStatementCount returns the sum of statements across all packaes that currently have associated tests.

func (*Group) TotalUncovered

func (g *Group) TotalUncovered() float64

TotalUncovered returns the total number of statements that have not been covered by unit tests.

type Stats

type Stats struct {
	Package         string
	Statements      float64
	Covered         float64
	Uncovered       float64
	Estimated       bool
	RawCoverageData []string
}

Stats represent statistics for one or more packages.

func (*Stats) CoveragePercent

func (s *Stats) CoveragePercent() (coveragePercent float64)

CoveragePercent calculates the coverage percentage for the package stats.