Move capitalization logic into getPackageDisplayName (#2625)

This pull request clarifies the purpose and use of a package name for
display reasons.

Prior to this change, when generating front matter, a provider's display
name would be put through a capitalization logic that would capitalize
each word in the name, even if the word was in all caps already. E.g.:

`Palo Alto Networks Cloud NGFW For AWS Provider` -> `Palo Alto Networks
Cloud Ngfw For Aws Provider`

This change ensures that whatever is passed into `info.DisplayName` in
the provider remains unaltered. It also unblocks the setting up of
automatic index docs for https://github.com/pulumi/pulumi-cloudngfwaws.

I've also updated the function name to clarify it is specifically about
finding or generating a display name.

pkg/tfgen/installation_docs.go

@@ -33,11 +33,11 @@ func plainDocsParser(docFile *DocFile, g *Generator) ([]byte, error) {
 	// Get file content without front matter
 	content := trimFrontMatter(contentBytes)
 
-	providerName := getProviderName(g)
+	providerDisplayName := getProviderDisplayName(g)
 
 	// Add pulumi-specific front matter
 	// Generate pulumi-specific front matter
-	frontMatter := writeFrontMatter(providerName)
+	frontMatter := writeFrontMatter(providerDisplayName)
 
 	// Remove the title. A title gets populated from Hugo frontmatter; we do not want two.
 	content, err = removeTitle(content)
@@ -51,7 +51,7 @@ func plainDocsParser(docFile *DocFile, g *Generator) ([]byte, error) {
 	// Generate pulumi-specific installation instructions
 	installationInstructions := writeInstallationInstructions(
 		g.info.Golang.ImportBasePath,
-		providerName,
+		providerDisplayName,
 		g.pkg.Name().String(),
 	)
 
@@ -83,10 +83,7 @@ func plainDocsParser(docFile *DocFile, g *Generator) ([]byte, error) {
 	return []byte(contentStr), nil
 }
 
-func writeFrontMatter(providerName string) string {
-	// Capitalize the package name
-	capitalize := cases.Title(language.English)
-	title := capitalize.String(providerName)
+func writeFrontMatter(providerDisplayName string) string {
 	return fmt.Sprintf(delimiter+
 		"# *** WARNING: This file was auto-generated. "+
 		"Do not edit by hand unless you're certain you know what you are doing! ***\n"+
@@ -95,7 +92,7 @@ func writeFrontMatter(providerName string) string {
 		"layout: package\n"+
 		delimiter+
 		"\n",
-		title)
+		providerDisplayName)
 }
 
 // writeInstallationInstructions renders the following for any provider:
@@ -437,10 +434,16 @@ func removeTfVersionMentions() tfbridge.DocsEdit {
 	}
 }
 
-func getProviderName(g *Generator) string {
+func getProviderDisplayName(g *Generator) string {
 	providerName := g.info.DisplayName
 	if providerName != "" {
 		return providerName
 	}
-	return g.pkg.Name().String()
+	// If the provider hasn't set an explicit Display Name, we infer from the package name.
+	providerName = g.pkg.Name().String()
+	// For display purposes, we'll capitalize the name.
+	// This won't always work well - "aws" --> "Aws" isn't necessarily what we want
+	// but it's a reasonable fallback option when info.DisplayName isn't set.
+	capitalize := cases.Title(language.English)
+	return capitalize.String(providerName)
 }

pkg/tfgen/installation_docs_test.go

@@ -131,6 +131,17 @@ func TestDisplayNameFallback(t *testing.T) {
 			pkgName:  "Horse",
 			expected: "Horse",
 		},
+		{
+			name:     "Capitalizes pkgName if lower case",
+			pkgName:  "shetlandpony",
+			expected: "Shetlandpony",
+		},
+		{
+			name:        "Does not alter Display Name",
+			displayName: "Palo Alto Networks Cloud NGFW For AWS Provider",
+			pkgName:     "cloudngfwaws",
+			expected:    "Palo Alto Networks Cloud NGFW For AWS Provider",
+		},
 	}
 	for _, tt := range tests {
 		tt := tt
@@ -145,7 +156,7 @@ func TestDisplayNameFallback(t *testing.T) {
 				},
 				pkg: tokens.NewPackageToken(tokens.PackageName(tt.pkgName)),
 			}
-			actual := getProviderName(g)
+			actual := getProviderDisplayName(g)
 
 			assert.Equal(t, tt.expected, actual)
 		})
@@ -340,7 +351,7 @@ func TestWriteFrontMatter(t *testing.T) {
 
 	tc := testCase{
 		name:         "Generates Front Matter for installation-configuration.md",
-		providerName: "test",
+		providerName: "Test",
 		expected: delimiter +
 			"# *** WARNING: This file was auto-generated. " +
 			"Do not edit by hand unless you're certain you know what you are doing! ***\n" +

pkg/tfgen/test_data/convert-index-file-edit-rules/expected.md

@@ -6,7 +6,7 @@ layout: package
 ---
 ## Installation
 
-The libvirt provider is available as a package in all Pulumi languages:
+The Libvirt provider is available as a package in all Pulumi languages:
 
 * JavaScript/TypeScript: [`@pulumi/libvirt`](https://www.npmjs.com/package/@pulumi/libvirt)
 * Python: [`pulumi-libvirt`](https://pypi.org/project/pulumi-libvirt/)

pkg/tfgen/test_data/convert-index-file/expected.md

@@ -6,7 +6,7 @@ layout: package
 ---
 ## Installation
 
-The libvirt provider is available as a package in all Pulumi languages:
+The Libvirt provider is available as a package in all Pulumi languages:
 
 * JavaScript/TypeScript: [`@pulumi/libvirt`](https://www.npmjs.com/package/@pulumi/libvirt)
 * Python: [`pulumi-libvirt`](https://pypi.org/project/pulumi-libvirt/)