refactor warnings into its own function

Emyrk · Emyrk · commit 9f947c3caebf · 2025-05-14T09:50:21.000-05:00
diff --git a/coderd/database/migrations/000325_dynamic_parameters_metadata.down.sql b/coderd/database/migrations/000325_dynamic_parameters_metadata.down.sql
diff --git a/coderd/database/migrations/000325_dynamic_parameters_metadata.up.sql b/coderd/database/migrations/000325_dynamic_parameters_metadata.up.sql
@@ -1,4 +1,4 @@
-ALTER TABLE template_version_terraform_values ADD COLUMN provisionerd_version TEXT NOT NULL DEFAULT '';
+ALTER TABLE template_version_terraform_values ADD COLUMN IF NOT EXISTS provisionerd_version TEXT NOT NULL DEFAULT '';
 
 COMMENT ON COLUMN template_version_terraform_values.provisionerd_version IS
 	'What version of the provisioning engine was used to generate the cached plan and module files.';
diff --git a/coderd/parameters.go b/coderd/parameters.go
@@ -81,34 +81,14 @@ func (api *API) templateVersionDynamicParameters(rw http.ResponseWriter, r *http
 	}
 	defer api.FileCache.Release(fileID)
 
-	staticDiagnostics := hcl.Diagnostics{}
-	missingMetaData := hcl.Diagnostic{
-		Severity: hcl.DiagWarning,
-		Summary:  "This template version is missing required metadata to support dynamic parameters. Go back to the classic creation flow.",
-		Detail:   "To restore full functionality, please re-import the terraform as a new template version.",
-	}
-
 	// Having the Terraform plan available for the evaluation engine is helpful
 	// for populating values from data blocks, but isn't strictly required. If
 	// we don't have a cached plan available, we just use an empty one instead.
 	plan := json.RawMessage("{}")
 	tf, err := api.Database.GetTemplateVersionTerraformValues(ctx, templateVersion.ID)
-	if xerrors.Is(err, sql.ErrNoRows) {
-		staticDiagnostics = staticDiagnostics.Append(&missingMetaData)
-	}
 	if err == nil {
 		plan = tf.CachedPlan
 
-		major, minor, err := apiversion.Parse(tf.ProvisionerdVersion)
-		if err != nil || tf.ProvisionerdVersion == "" {
-			staticDiagnostics = staticDiagnostics.Append(&missingMetaData)
-		} else if major < 1 || (major == 1 && minor < 5) {
-			missingMetaData.Detail = "This template version requires provisioner v1.5 or newer to support dynamic parameters. " +
-				"Some options may be missing or incorrect. " +
-				"Please contact an administrator to update the provisioner and re-import the template version."
-			staticDiagnostics = staticDiagnostics.Append(&missingMetaData)
-		}
-
 		if tf.CachedModuleFiles.Valid {
 			moduleFilesFS, err := api.FileCache.Acquire(fileCtx, tf.CachedModuleFiles.UUID)
 			if err != nil {
@@ -136,6 +116,10 @@ func (api *API) templateVersionDynamicParameters(rw http.ResponseWriter, r *http
 		return
 	}
 
+	var staticDiagnostics hcl.Diagnostics
+	// If the err is sql.ErrNoRows, an empty terraform values struct is correct.
+	staticDiagnostics = staticDiagnostics.Extend(parameterProvisionerVersionDiagnostic(tf))
+
 	owner, err := api.getWorkspaceOwnerData(ctx, user, templateVersion.OrganizationID)
 	if err != nil {
 		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
@@ -291,3 +275,31 @@ func (api *API) getWorkspaceOwnerData(
 		Groups:       groupNames,
 	}, nil
 }
+
+// parameterProvisionerVersionDiagnostic checks the version of the provisioner
+// used to create the template version. If the version is less than 1.5, it
+// returns a warning diagnostic. Only versions 1.5+ return the module & plan data
+// required.
+func parameterProvisionerVersionDiagnostic(tf database.TemplateVersionTerraformValue) hcl.Diagnostics {
+	missingMetaData := hcl.Diagnostic{
+		Severity: hcl.DiagWarning,
+		Summary:  "This template version is missing required metadata to support dynamic parameters. Go back to the classic creation flow.",
+		Detail:   "To restore full functionality, please re-import the terraform as a new template version.",
+	}
+
+	if tf.ProvisionerdVersion == "" {
+		return hcl.Diagnostics{&missingMetaData}
+	}
+
+	major, minor, err := apiversion.Parse(tf.ProvisionerdVersion)
+	if err != nil || tf.ProvisionerdVersion == "" {
+		return hcl.Diagnostics{&missingMetaData}
+	} else if major < 1 || (major == 1 && minor < 5) {
+		missingMetaData.Detail = "This template version requires provisioner v1.5 or newer to support dynamic parameters. " +
+			"Some options may be missing or incorrect. " +
+			"Please contact an administrator to update the provisioner and re-import the template version."
+		return hcl.Diagnostics{&missingMetaData}
+	}
+
+	return nil
+}
diff --git a/coderd/parameters_internal_test.go b/coderd/parameters_internal_test.go
@@ -0,0 +1,78 @@
+package coderd
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/coder/coder/v2/coderd/database"
+)
+
+func Test_parameterProvisionerVersionDiagnostic(t *testing.T) {
+	t.Parallel()
+
+	testCases := []struct {
+		version string
+		warning bool
+	}{
+		{
+			version: "",
+			warning: true,
+		},
+		{
+			version: "invalid",
+			warning: true,
+		},
+		{
+			version: "0.4",
+			warning: true,
+		},
+		{
+			version: "0.5",
+			warning: true,
+		},
+		{
+			version: "0.6",
+			warning: true,
+		},
+		{
+			version: "1.4",
+			warning: true,
+		},
+		{
+			version: "1.5",
+			warning: false,
+		},
+		{
+			version: "1.6",
+			warning: false,
+		},
+		{
+			version: "2.0",
+			warning: false,
+		},
+		{
+			version: "2.5",
+			warning: false,
+		},
+		{
+			version: "2.6",
+			warning: false,
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run("Version_"+tc.version, func(t *testing.T) {
+			t.Parallel()
+			diags := parameterProvisionerVersionDiagnostic(database.TemplateVersionTerraformValue{
+				ProvisionerdVersion: tc.version,
+			})
+			if tc.warning {
+				require.Len(t, diags, 1, "expected warning")
+			} else {
+				require.Len(t, diags, 0, "expected no warning")
+			}
+		})
+	}
+
+}
