profile

Documentation

Overview

Package profile exposes methods for working with coverage profile files and other profile related files.

Index

• type API
  • func New(packageAPI interfaces.PackageAPI, osioAPI hostiface.OSIOAPI) *API
  • func (a *API) BuildAndSaveCoverageProfile(allPackages pckg.Group, coverageProfileName string) error
  • func (a *API) OutputPercentageFile(coveragePercentage float64) error

Types

type API

type API struct {
	// contains filtered or unexported fields
}

API contains methods for creating a coverage profile.

func New

func New(packageAPI interfaces.PackageAPI, osioAPI hostiface.OSIOAPI) *API

New returns a reference to a profile api.

func (*API) BuildAndSaveCoverageProfile

func (a *API) BuildAndSaveCoverageProfile(allPackages pckg.Group, coverageProfileName string) error

BuildAndSaveCoverageProfile builds and saves a coverage profile that can be consumed by go tool cover -html.

func (*API) OutputPercentageFile

func (a *API) OutputPercentageFile(coveragePercentage float64) error

OutputPercentageFile saves a file containing the supplied coverage percentage.