Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tfgen summary percentages #1453

Closed
wants to merge 2 commits into from
Closed

Tfgen summary percentages #1453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f52a48
tfgen summary percentages
VenelinMartinov Oct 18, 2023
a9cc992
split long string literals
VenelinMartinov Oct 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions pkg/tfgen/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ func getDocsForResource(g *Generator, source DocsSource, kind DocKind,
panic("unknown docs kind")
}

entitiesCount++
if err != nil {
return entityDocs{}, fmt.Errorf("get docs for token %s: %w", rawname, err)
}
Expand Down Expand Up @@ -1709,6 +1710,7 @@ func (g *Generator) convertHCL(hcl, path, exampleTitle string, languages []strin

if isCompleteFailure {
hclAllLangsConversionFailures++
hclConversionAttempts++
if exampleTitle == "" {
g.warn(fmt.Sprintf("unable to convert HCL example for Pulumi entity '%s': %v. The example will be dropped "+
"from any generated docs or SDKs.", path, err))
Expand Down Expand Up @@ -1752,6 +1754,8 @@ func (g *Generator) convertHCL(hcl, path, exampleTitle string, languages []strin
err = nil
}

hclConversionAttempts++

return result.String(), nil
}

Expand Down Expand Up @@ -1828,6 +1832,7 @@ func cleanupDoc(

g.debug("Cleaning up description text for [%v]", name)
cleanupText, elided := reformatText(infoCtx, doc.Description, footerLinks)
totalDescriptions++
if elided {
g.debug("Found <elided> in the description. Attempting to extract examples from the description and " +
"reformat examples only.")
Expand Down
106 changes: 81 additions & 25 deletions pkg/tfgen/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,21 @@ package tfgen

import (
"fmt"

schemaTools "github.com/pulumi/schema-tools/pkg"
)

var (
ignoredDocHeaders = make(map[string]int)
totalDescriptions int
elidedDescriptions int // i.e., we discard the entire description, including examples
elidedDescriptionsOnly int // we discarded the description proper, but were able to preserve the examples
elidedArguments int
elidedNestedArguments int
elidedAttributes int

unexpectedSnippets int
hclConversionAttempts int // conversion attempts
hclAllLangsConversionFailures int // examples that failed to convert in any language

// examples that failed to convert in one, but not all, languages. This is less severe impact because users will
Expand All @@ -43,11 +46,19 @@ var (
argumentDescriptionsFromAttributes int

// General metrics:
entitiesCount int
entitiesMissingDocs int

schemaStats schemaTools.PulumiSchemaStats
)

func getPercentage(top int, bottom int) float64 {
if bottom == 0 {
return 100
}
return float64(top) / float64(bottom) * 100
}

// printDocStats outputs metrics relating to document parsing and conversion
func printDocStats() {
fmt.Println("")
Expand All @@ -56,43 +67,88 @@ func printDocStats() {
fmt.Printf("\t%d total resources containing %d total inputs.\n",
schemaStats.Resources.TotalResources, schemaStats.Resources.TotalInputProperties)
fmt.Printf("\t%d total functions.\n", schemaStats.Functions.TotalFunctions)
fmt.Printf("\t%d entities are missing docs entirely because they could not be found in the upstream provider.\n",
entitiesMissingDocs)
fmt.Printf(
"\t%d of %d (%.2f%%) entities are missing docs entirely because they could not be found in the upstream provider.\n",
entitiesMissingDocs, entitiesCount, getPercentage(entitiesMissingDocs, entitiesCount),
)
fmt.Println("")

fmt.Println("Description metrics:")
fmt.Printf("\t%d entity descriptions contained an <elided> reference and were dropped, including examples.\n",
elidedDescriptions)
fmt.Printf("\t%d entity descriptions contained an <elided> reference and were dropped, but examples were preserved.\n",
elidedDescriptionsOnly)
fmt.Printf(
"\t%d of %d (%.2f%%) entity descriptions contained an <elided> reference and were dropped, including examples.\n",
elidedDescriptions, totalDescriptions, getPercentage(elidedDescriptions, totalDescriptions),
)
fmt.Printf(
"\t%d of %d (%.2f%%) entity descriptions contained an <elided> reference and were dropped, "+
"but examples were preserved.\n",
elidedDescriptionsOnly,
totalDescriptions,
getPercentage(elidedDescriptionsOnly, totalDescriptions),
)
fmt.Println("")

fmt.Println("Example conversion metrics:")
fmt.Printf("\t%d HCL examples failed to convert in all languages\n", hclAllLangsConversionFailures)
fmt.Printf("\t%d HCL examples were converted in at least one language but failed to convert to TypeScript\n",
hclTypeScriptPartialConversionFailures)
fmt.Printf("\t%d HCL examples were converted in at least one language but failed to convert to Python\n",
hclPythonPartialConversionFailures)
fmt.Printf("\t%d HCL examples were converted in at least one language but failed to convert to Go\n",
hclGoPartialConversionFailures)
fmt.Printf("\t%d HCL examples were converted in at least one language but failed to convert to C#\n",
hclCSharpPartialConversionFailures)
fmt.Printf(
"\t%d of %d (%.2f%%) HCL examples failed to convert in all languages\n",
hclAllLangsConversionFailures,
hclConversionAttempts,
getPercentage(hclAllLangsConversionFailures, hclConversionAttempts),
)
fmt.Printf(
"\t%d of %d (%.2f%%) HCL examples were converted in at least one language but failed to convert to TypeScript\n",
hclTypeScriptPartialConversionFailures,
hclConversionAttempts,
getPercentage(hclTypeScriptPartialConversionFailures, hclConversionAttempts),
)
fmt.Printf(
"\t%d of %d (%.2f%%) HCL examples were converted in at least one language but failed to convert to Python\n",
hclPythonPartialConversionFailures,
hclConversionAttempts,
getPercentage(hclPythonPartialConversionFailures, hclConversionAttempts),
)
fmt.Printf(
"\t%d of %d (%.2f%%) HCL examples were converted in at least one language but failed to convert to Go\n",
hclGoPartialConversionFailures,
hclConversionAttempts,
getPercentage(hclGoPartialConversionFailures, hclConversionAttempts),
)
fmt.Printf(
"\t%d of %d (%.2f%%) HCL examples were converted in at least one language but failed to convert to C#\n",
hclCSharpPartialConversionFailures,
hclConversionAttempts,
getPercentage(hclCSharpPartialConversionFailures, hclConversionAttempts),
)
fmt.Printf("\t%d entity document sections contained unexpected HCL code snippets. Examples will be converted, "+
"but may not display correctly in the registry, e.g. lacking tabs.\n", unexpectedSnippets)
fmt.Println("")

fmt.Println("Argument metrics:")
fmt.Printf("\t%d argument descriptions were parsed from the upstream docs\n", totalArgumentsFromDocs)
fmt.Printf("\t%d top-level input property descriptions came from an upstream attribute (as opposed to an argument). "+
"Nested arguments are not included in this count.\n", argumentDescriptionsFromAttributes)
fmt.Printf("\t%d arguments contained an <elided> reference and had their descriptions dropped.\n",
elidedArguments)
fmt.Printf("\t%d nested arguments contained an <elided> reference and had their descriptions dropped.\n",
elidedNestedArguments)
//nolint:lll
fmt.Printf("\t%d of %d resource inputs (%.2f%%) are missing descriptions in the schema\n",
schemaStats.Resources.InputPropertiesMissingDescriptions, schemaStats.Resources.TotalInputProperties,
float64(schemaStats.Resources.InputPropertiesMissingDescriptions)/float64(schemaStats.Resources.TotalInputProperties)*100)
fmt.Printf(
"\t%d of %d (%.2f%%) top-level input property descriptions came from an upstream attribute "+
"(as opposed to an argument). Nested arguments are not included in this count.\n",
argumentDescriptionsFromAttributes,
totalArgumentsFromDocs,
getPercentage(argumentDescriptionsFromAttributes, totalArgumentsFromDocs),
)
fmt.Printf("\t%d of %d (%.2f%%) arguments contained an <elided> reference and had their descriptions dropped.\n",
elidedArguments, totalArgumentsFromDocs, getPercentage(elidedArguments, totalArgumentsFromDocs))
fmt.Printf(
"\t%d of %d (%.2f%%) nested arguments contained an <elided> reference and had their descriptions dropped.\n",
elidedNestedArguments,
totalArgumentsFromDocs,
getPercentage(
elidedNestedArguments, totalArgumentsFromDocs),
)
fmt.Printf(
"\t%d of %d (%.2f%%) resource inputs are missing descriptions in the schema\n",
schemaStats.Resources.InputPropertiesMissingDescriptions,
schemaStats.Resources.TotalInputProperties,
getPercentage(
schemaStats.Resources.InputPropertiesMissingDescriptions,
schemaStats.Resources.TotalInputProperties,
),
)
fmt.Println("")

fmt.Println("Attribute metrics:")
Expand Down