Config Generation: No provider alias on single instance (#1589)

If we're only going to have one `provider` instance, there's no need to set an alias

Author: julienduchesne

pkg/generate/generate.go

@@ -5,8 +5,6 @@ import (
 	"errors"
 	"fmt"
 	"log"
-	"net"
-	"net/url"
 	"os"
 	"path/filepath"
 	"regexp"
@@ -69,16 +67,7 @@ func Generate(ctx context.Context, cfg *Config) error {
 	}
 
 	if cfg.Grafana != nil {
-		grafanaURLParsed, err := url.Parse(cfg.Grafana.URL)
-		if err != nil {
-			return err
-		}
-
-		stackName := grafanaURLParsed.Hostname()
-		if net.ParseIP(stackName) != nil {
-			stackName = "ip_" + strings.ReplaceAll(stackName, ".", "_")
-		}
-		if err := generateGrafanaResources(ctx, cfg.Grafana.Auth, cfg.Grafana.URL, stackName, true, cfg.OutputDir, "", ""); err != nil {
+		if err := generateGrafanaResources(ctx, cfg.Grafana.Auth, cfg.Grafana.URL, "", true, cfg.OutputDir, "", ""); err != nil {
 			return err
 		}
 	}
@@ -94,6 +83,14 @@ func Generate(ctx context.Context, cfg *Config) error {
 }
 
 func generateImportBlocks(ctx context.Context, client *common.Client, listerData any, resources []*common.Resource, outPath, provider string) error {
+	generatedFilename := func(suffix string) string {
+		if provider == "" {
+			return filepath.Join(outPath, suffix)
+		}
+
+		return filepath.Join(outPath, provider+"-"+suffix)
+	}
+
 	// Generate HCL blocks in parallel with a wait group
 	wg := sync.WaitGroup{}
 	wg.Add(len(resources))
@@ -140,9 +137,11 @@ func generateImportBlocks(ctx context.Context, client *common.Client, listerData
 				}
 
 				b := hclwrite.NewBlock("import", nil)
-				b.Body().SetAttributeTraversal("provider", traversal("grafana", provider))
 				b.Body().SetAttributeTraversal("to", traversal(resource.Name, cleanedID))
 				b.Body().SetAttributeValue("id", cty.StringVal(id))
+				if provider != "" {
+					b.Body().SetAttributeTraversal("provider", traversal("grafana", provider))
+				}
 
 				blocks[i] = b
 				// TODO: Match and update existing import blocks
@@ -178,14 +177,13 @@ func generateImportBlocks(ctx context.Context, client *common.Client, listerData
 		allBlocks = append(allBlocks, r.blocks...)
 	}
 
-	if err := writeBlocks(filepath.Join(outPath, provider+"-imports.tf"), allBlocks...); err != nil {
+	if err := writeBlocks(generatedFilename("imports.tf"), allBlocks...); err != nil {
 		return err
 	}
 
-	generatedFilename := fmt.Sprintf("%s-resources.tf", provider)
-	if err := runTerraform(outPath, "plan", "-generate-config-out="+generatedFilename); err != nil {
+	if err := runTerraform(outPath, "plan", "-generate-config-out="+generatedFilename("resources.tf")); err != nil {
 		return fmt.Errorf("failed to generate resources: %w", err)
 	}
 
-	return sortResourcesFile(filepath.Join(outPath, generatedFilename))
+	return sortResourcesFile(generatedFilename("resources.tf"))
 }

pkg/generate/grafana.go

@@ -2,7 +2,6 @@ package generate
 
 import (
 	"context"
-	"log"
 	"path/filepath"
 	"strings"
 
@@ -17,12 +16,22 @@ import (
 )
 
 func generateGrafanaResources(ctx context.Context, auth, url, stackName string, genProvider bool, outPath, smURL, smToken string) error {
+	generatedFilename := func(suffix string) string {
+		if stackName == "" {
+			return filepath.Join(outPath, suffix)
+		}
+
+		return filepath.Join(outPath, stackName+"-"+suffix)
+	}
+
 	if genProvider {
 		providerBlock := hclwrite.NewBlock("provider", []string{"grafana"})
-		providerBlock.Body().SetAttributeValue("alias", cty.StringVal(stackName))
 		providerBlock.Body().SetAttributeValue("url", cty.StringVal(url))
 		providerBlock.Body().SetAttributeValue("auth", cty.StringVal(auth))
-		if err := writeBlocks(filepath.Join(outPath, stackName+"-provider.tf"), providerBlock); err != nil {
+		if stackName != "" {
+			providerBlock.Body().SetAttributeValue("alias", cty.StringVal(stackName))
+		}
+		if err := writeBlocks(generatedFilename("provider.tf"), providerBlock); err != nil {
 			return err
 		}
 	}
@@ -60,21 +69,20 @@ func generateGrafanaResources(ctx context.Context, auth, url, stackName string,
 		return err
 	}
 
-	log.Printf("Post-processing for %s\n", stackName)
 	stripDefaultsExtraFields := map[string]any{}
 	if singleOrg {
 		stripDefaultsExtraFields["org_id"] = true // Always remove org_id if single org
 	} else {
 		stripDefaultsExtraFields["org_id"] = `"1"` // Remove org_id if it's the default
 	}
 
-	if err := stripDefaults(filepath.Join(outPath, stackName+"-resources.tf"), stripDefaultsExtraFields); err != nil {
+	if err := stripDefaults(generatedFilename("resources.tf"), stripDefaultsExtraFields); err != nil {
 		return err
 	}
-	if err := abstractDashboards(filepath.Join(outPath, stackName+"-resources.tf")); err != nil {
+	if err := abstractDashboards(generatedFilename("resources.tf")); err != nil {
 		return err
 	}
-	if err := wrapJSONFieldsInFunction(filepath.Join(outPath, stackName+"-resources.tf")); err != nil {
+	if err := wrapJSONFieldsInFunction(generatedFilename("resources.tf")); err != nil {
 		return err
 	}
 

pkg/generate/terraform.go

@@ -30,8 +30,16 @@ func runTerraform(dir string, command ...string) error {
 
 func writeBlocks(filepath string, blocks ...*hclwrite.Block) error {
 	contents := hclwrite.NewFile()
-	for i, b := range blocks {
-		if i > 0 {
+	if fileBytes, err := os.ReadFile(filepath); err == nil {
+		var diags hcl.Diagnostics
+		contents, diags = hclwrite.ParseConfig(fileBytes, filepath, hcl.InitialPos)
+		if diags.HasErrors() {
+			return errors.Join(diags.Errs()...)
+		}
+	}
+
+	for _, b := range blocks {
+		if len(contents.Body().Blocks()) > 0 {
 			contents.Body().AppendNewline()
 		}
 		contents.Body().AppendBlock(b)

pkg/generate/testdata/generate/dashboard-expected/imports.tf

@@ -0,0 +1,14 @@
+import {
+  to = grafana_dashboard._1_my-dashboard-uid
+  id = "1:my-dashboard-uid"
+}
+
+import {
+  to = grafana_folder._1_my-folder-uid
+  id = "1:my-folder-uid"
+}
+
+import {
+  to = grafana_notification_policy._1_policy
+  id = "1:policy"
+}

pkg/generate/testdata/generate/dashboard-expected/localhost-imports.tf

@@ -6,3 +6,8 @@ terraform {
     }
   }
 }
+
+provider "grafana" {
+  url  = "http://localhost:3000"
+  auth = "admin:admin"
+}

pkg/generate/testdata/generate/dashboard-expected/localhost-provider.tf

@@ -2,8 +2,7 @@
 # Please review these resources and move them into your main configuration files.
 
 # __generated__ by Terraform from "1:my-dashboard-uid"
-resource "grafana_dashboard" "localhost_1_my-dashboard-uid" {
-  provider = grafana.localhost
+resource "grafana_dashboard" "_1_my-dashboard-uid" {
   config_json = jsonencode({
     title = "My Dashboard"
     uid   = "my-dashboard-uid"
@@ -12,15 +11,13 @@ resource "grafana_dashboard" "localhost_1_my-dashboard-uid" {
 }
 
 # __generated__ by Terraform from "1:my-folder-uid"
-resource "grafana_folder" "localhost_1_my-folder-uid" {
-  provider = grafana.localhost
-  title    = "My Folder"
-  uid      = "my-folder-uid"
+resource "grafana_folder" "_1_my-folder-uid" {
+  title = "My Folder"
+  uid   = "my-folder-uid"
 }
 
 # __generated__ by Terraform from "1:policy"
-resource "grafana_notification_policy" "localhost_1_policy" {
-  provider           = grafana.localhost
+resource "grafana_notification_policy" "_1_policy" {
   contact_point      = "grafana-default-email"
   disable_provenance = true
   group_by           = ["grafana_folder", "alertname"]