cover

package

v0.0.0-...-115217d Latest Latest Go to latest Published: Mar 10, 2021 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/whitehatsec/go-coverage-threshold

Links

Open Source Insights

Documentation ¶

Index ¶

func Run(fileList string) ([]byte, error)
type Config
- func Load(wd string) (*Config, error)
type Entry
- func Parse(result []byte) []*Entry

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Run ¶

func Run(fileList string) ([]byte, error)

Run executes `go test -cover ./...` and returns the raw result.

Types ¶

type Config ¶

type Config struct {
	Threshold float64 `toml:"threshold"`
}

Config holds settings for coverage and thresholds.

func Load ¶

func Load(wd string) (*Config, error)

Load configuration values from files.

type Entry ¶

type Entry struct {
	Coverage  float64
	Duration  string // TODO: parse this further into a time.Duration
	Path      string
	Status    string
	Threshold float64
}

Entry represents a per-path coverage measurement.

func Parse ¶

func Parse(result []byte) []*Entry

Parse the stdout result from `go test -cover ./...`.

func (*Entry) Failed ¶

func (e *Entry) Failed() bool

Failed checks if the threshold was not met.

func (*Entry) Passed ¶

func (e *Entry) Passed() bool

Passed checks if the threshold was met.

func (*Entry) String ¶

func (e *Entry) String() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL