History

mattmoor-sockpuppet 6185837d36 Auto-update dependencies (#99 ) Produced via: `dep ensure -update knative.dev/test-infra knative.dev/pkg` /assign mattmoor		2019-09-13 08:16:37 -07:00
..
README.md	Auto-update dependencies (#99 )	2019-09-13 08:16:37 -07:00
html_display.go	Auto-update dependencies (#98 )	2019-09-12 08:24:33 -07:00
html_template.go	Auto-update dependencies (#98 )	2019-09-12 08:24:33 -07:00
rule.go	Auto-update dependencies (#68 )	2019-08-07 07:22:56 -07:00
xml_display.go	Auto-update dependencies (#98 )	2019-09-12 08:24:33 -07:00
xml_template.go	Auto-update dependencies (#98 )	2019-09-12 08:24:33 -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>

GetCoveragePercentageXMLDisplay() is a utility method that can be used by repos to produce coverage percentage for each resource in a Junit XML results file. The method takes CoveragePercentages as input and produces a Junit result file format.