knative
/
pkg
mirror of https://github.com/knative/pkg.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pkg/test/webhook-apicoverage/view
History
mattmoor-sockpuppet 014d54e62f golang format tools (#637) 
Produced via:
  `gofmt -s -w $(find -path './vendor' -prune -o -type f -name '*.go' -print))`
  `goimports -w $(find -name '*.go' | grep -v vendor)`
/assign mattmoor
 		2019-09-06 07:26:05 -07:00
..
README.md Move webhook apicoverage to knative/pkg (#555) 2019-08-06 07:16:55 -07:00
aggregate_coverage.html test/webhook-apicoverage: Changing html display to use go templates (#564) 2019-09-05 07:06:06 -07:00
html_display.go golang format tools (#637) 2019-09-06 07:26:05 -07:00
rule.go Move webhook apicoverage to knative/pkg (#555) 2019-08-06 07:16:55 -07:00
type_coverage.html test/webhook-apicoverage: Changing html display to use go templates (#564) 2019-09-05 07:06:06 -07:00

README.md

View

This package contains types and helper methods that repos can use to display API Coverage results.

DisplayRules provides a mechanism for repos to define their own display rules. DisplayHelper methods can use these rules to define how to display results.

GetHTMLDisplay() is a utility method that can be used by repos to get a HTML(JSON) like textual display of API Coverage. This method takes an array of TypeCoverage and DisplayRules object and returns a string representing its coverage in the color coded format inside a HTML page:

Package: <PackageName>
Type: <TypeName>
{
    <FieldName> <Ignored>/<Coverage:TrueorFalse> [Values]
    ....
    ....
    ....
}

GetHTMLCoverageValuesDisplay() is a utility method that can be used by repos to produce coverage values display. The method takes as input CoverageValue and produces a display in the format inside a HTML page:

CoverageValues:

Total Fields:  <Number of total fields>
Covered Fields: <Number of fields covered>
Ignored Fields: <Number of fields ignored>
Coverage Percentage: <Percentage value of coverage>