gocov

README

gocov

Originally github.com/dave/courtney

Allows to exclude some fragments of code from go test coverage.

Excludes

What do we exclude from the coverage report?

Blocks including a panic

If you need to test that your code panics correctly, it should probably be an error rather than a panic.

Notest comments

Blocks or files with a // notest comment are excluded.

Blocks returning a error tested to be non-nil

We only exclude blocks where the error being returned has been tested to be non-nil, so:

err := foo()
if err != nil {
    return err // excluded 
}

... however:

if i == 0 {
    return errors.New("...") // not excluded
}

A few more rules:

• If multiple return values are returned, error must be the last, and all others must be nil or zero values.
• We also exclude blocks returning an error which is the result of a function taking a non-nil error as a parameter, e.g. errors.Wrap(err, "...").
• We also exclude blocks containing a bare return statement, where the function has named result parameters, and the last result is an error that has been tested non-nil. Be aware that in this scenario no attempt is made to verify that the other result parameters are zero values.

Install

go install github.com/heeus/gocov@latest 

Usage

Run the gocov command followed by a list of packages. Use . for the package in the current directory, and adding /... tests all sub-packages recursively. If no packages are provided, the default is ./....

To test the current package, and all sub-packages recursively:

gocov

To test just the current package:

gocov .

Verbose: -v

Verbose output All the output from the go test -v command is shown.

To see code lines, exculded from coverage analyses:

gocov -uncover

Output

Gocov will fail if the tests fail. If the tests succeed, it will

1. Create or overwrite a coverage.out file in the current directory.
2. Print not coverage line addresses. They can are considered as links in VSCode.