History

Markus Thömmes 09d5e09da8 Assorted linting fixes. (#1443 )		2020-06-24 12:11:27 -07:00
..
README.md	Format markdown (#668 )	2019-09-12 08:22:35 -07:00
html_display.go	test/webhook-apicoverage: Add support to produce junit xml results (#651 )	2019-09-11 11:02:30 -07:00
html_template.go	Assorted linting fixes. (#1443 )	2020-06-24 12:11:27 -07:00
rule.go	Move webhook apicoverage to knative/pkg (#555 )	2019-08-06 07:16:55 -07:00
xml_display.go	Renaming Importer to Source (#662 )	2019-09-11 13:16:31 -07:00
xml_template.go	Assorted linting fixes. (#1443 )	2020-06-24 12:11:27 -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.