bincover: Index | Files | Directories

package bincover

import ""

Package bincover provides an easy way to measure code coverage of Golang binaries. See examples/ to see how bincover is used to measure coverage of a simple Go application.


Package Files

doc.go instrument_bin.go run_bin.go


var (
    ExitCode = 0

func RunTest Uses

func RunTest(f func())

RunTest runs function f (usually main), with arguments specified by the flag "args-file", a file of newline-separated args. When f runs to completion (success or failure), RunTest prints (newline-separated): 1. f's output, 2. startOfMetadataMarker 3. a testMetadata struct 4. endOfMetadataMarker

Otherwise, if an unexpected error is encountered during execution, RunTest panics.

type CoverageCollector Uses

type CoverageCollector struct {
    MergedCoverageFilename string
    CollectCoverage        bool
    // contains filtered or unexported fields

func NewCoverageCollector Uses

func NewCoverageCollector(mergedCoverageFilename string, collectCoverage bool) *CoverageCollector

NewCoverageCollector initializes a CoverageCollector with the specified merged coverage filename. CollectCoverage can be set to true to collect coverage, or set to false to skip coverage collection. This is provided in order to enable reuse of CoverageCollector for tests where coverage measurement is not needed.

func (*CoverageCollector) RunBinary Uses

func (c *CoverageCollector) RunBinary(binPath string, mainTestName string, env []string, args []string) (output string, exitCode int, err error)

RunBinary runs the instrumented binary at binPath with env environment variables, executing only the test with mainTestName with the specified args.

func (*CoverageCollector) Setup Uses

func (c *CoverageCollector) Setup() error

func (*CoverageCollector) TearDown Uses

func (c *CoverageCollector) TearDown() error

TearDown merges the coverage profiles collecting from repeated runs of RunBinary. It must be called at the teardown stage of the test suite, otherwise no merged coverage profile will be created.



Package bincover imports 11 packages (graph) and is imported by 1 packages. Updated 2020-09-10. Refresh now. Tools for package owners.