report

Documentation

Index

• func PrintTable(report Report, writer io.Writer, packages bool)
• type Report
  • func GenerateReport(coverprofile string, root string, exclusions []string, sortBy, order string, ...) (Report, error)
• type Summary

Functions

func PrintTable

func PrintTable(report Report, writer io.Writer, packages bool)

Prints the report to the terminal

Types

type Report

type Report struct {
	Total Summary   // Global coverage
	Files []Summary // Coverage by file
}

Report of the coverage results

func GenerateReport

func GenerateReport(coverprofile string, root string, exclusions []string, sortBy, order string, packages bool) (Report, error)

Generates a coverage report given the coverage profile file, and the following configurations: exclusions: packages to be excluded (if a package is excluded, all its subpackages are excluded as well) sortBy: the order in which the files will be sorted in the report (see sortResults) order: the direction of the the sorting

type Summary

type Summary struct {
	Name                                       string
	Blocks, Stmts, MissingBlocks, MissingStmts int
	BlockCoverage, StmtCoverage                float64
}

Coverage summary for a file or module