improve tf config generation

Author: johnstcn

internal/provider/cached_image_resource_test.go

@@ -14,8 +14,6 @@ import (
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
 )
 
-// TODO: change this to only test for a non-existent image.
-// Move the heavy lifting to integration.
 func TestAccCachedImageDataSource(t *testing.T) {
 	t.Run("Found", func(t *testing.T) {
 		ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
@@ -28,23 +26,13 @@ func TestAccCachedImageDataSource(t *testing.T) {
 
 		deps := setup(ctx, t, files)
 		seedCache(ctx, t, deps)
-		tfCfg := fmt.Sprintf(`resource "envbuilder_cached_image" "test" {
-	builder_image = %q
-	workspace_folder = %q
-	git_url = %q
-	git_ssh_private_key_path = %q
-	extra_env = {
-	"FOO" : "bar"
-	}
-	cache_repo = %q
-	verbose = true
-}`, deps.BuilderImage, deps.Repo.Dir, deps.Repo.URL, deps.Repo.Key, deps.CacheRepo)
+		deps.ExtraEnv["FOO"] = "bar"
 		resource.Test(t, resource.TestCase{
 			PreCheck:                 func() { testAccPreCheck(t) },
 			ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
 			Steps: []resource.TestStep{
 				{
-					Config: tfCfg,
+					Config: deps.Config(t),
 					Check: resource.ComposeAggregateTestCheckFunc(
 						// Inputs should still be present.
 						resource.TestCheckResourceAttr("envbuilder_cached_image.test", "cache_repo", deps.CacheRepo),
@@ -89,24 +77,14 @@ func TestAccCachedImageDataSource(t *testing.T) {
 	RUN date > /date.txt`,
 		}
 		deps := setup(ctx, t, files)
+		deps.ExtraEnv["FOO"] = "bar"
 		// We do not seed the cache.
-		tfCfg := fmt.Sprintf(`resource "envbuilder_cached_image" "test" {
-	builder_image = %q
-	workspace_folder = %q
-	git_url = %q
-	git_ssh_private_key_path = %q
-	extra_env = {
-	"FOO" : "bar"
-	}
-	cache_repo = %q
-	verbose = true
-}`, deps.BuilderImage, deps.Repo.Dir, deps.Repo.URL, deps.Repo.Key, deps.CacheRepo)
 		resource.Test(t, resource.TestCase{
 			PreCheck:                 func() { testAccPreCheck(t) },
 			ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
 			Steps: []resource.TestStep{
 				{
-					Config: tfCfg,
+					Config: deps.Config(t),
 					Check: resource.ComposeAggregateTestCheckFunc(
 						// Computed values MUST be present.
 						resource.TestCheckResourceAttr("envbuilder_cached_image.test", "id", uuid.Nil.String()),

internal/provider/provider_test.go

@@ -6,11 +6,13 @@ package provider
 import (
 	"bufio"
 	"context"
+	"fmt"
 	"io"
 	"os"
 	"slices"
 	"strings"
 	"testing"
+	"text/template"
 
 	"github.com/coder/terraform-provider-envbuilder/testutil/registrytest"
 	"github.com/hashicorp/terraform-plugin-framework/providerserver"
@@ -40,12 +42,56 @@ func testAccPreCheck(t *testing.T) {
 	// function.
 }
 
+// testDependencies contain information about stuff the test depends on.
 type testDependencies struct {
 	BuilderImage string
 	CacheRepo    string
+	ExtraEnv     map[string]string
 	Repo         testGitRepoSSH
 }
 
+// Config generates a valid Terraform config file from the dependencies.
+func (d *testDependencies) Config(t testing.TB) string {
+	t.Helper()
+
+	tpl := `provider envbuilder {}
+resource "envbuilder_cached_image" "test" {
+  builder_image            = {{ quote .BuilderImage }}
+	cache_repo               = {{ quote .CacheRepo }}
+	extra_env                = {{ tfMap .ExtraEnv }}
+	git_url                  = {{ quote .Repo.URL }}
+	git_ssh_private_key_path = {{ quote .Repo.Key }}
+	verbose                  = true
+	workspace_folder         = {{ quote .Repo.Dir }}
+}`
+
+	fm := template.FuncMap{"tfMap": tfMap, "quote": quote}
+	var sb strings.Builder
+	tmpl, err := template.New("envbuilder_cached_image").Funcs(fm).Parse(tpl)
+	require.NoError(t, err)
+	require.NoError(t, tmpl.Execute(&sb, d))
+	return sb.String()
+}
+
+func tfMap(m map[string]string) string {
+	var sb strings.Builder
+	_, _ = sb.WriteRune('{')
+	_, _ = sb.WriteRune('\n')
+	for k, v := range m {
+		_, _ = sb.WriteString(fmt.Sprintf("%q", k))
+		_, _ = sb.WriteRune(':')
+		_, _ = sb.WriteRune(' ')
+		_, _ = sb.WriteString(fmt.Sprintf("%q", v))
+		_, _ = sb.WriteRune('\n')
+	}
+	_, _ = sb.WriteRune('}')
+	return sb.String()
+}
+
+func quote(s string) string {
+	return fmt.Sprintf("%q", s)
+}
+
 func setup(ctx context.Context, t testing.TB, files map[string]string) testDependencies {
 	t.Helper()
 
@@ -64,6 +110,7 @@ func setup(ctx context.Context, t testing.TB, files map[string]string) testDepen
 	return testDependencies{
 		BuilderImage: envbuilderImageRef,
 		CacheRepo:    reg + "/test",
+		ExtraEnv:     make(map[string]string),
 		Repo:         gitRepo,
 	}
 }