Merge pull request #131 from coder/coder/param_required

chore: add error diagnostic to missing required parameters

Author: Emyrk

parameter.go

@@ -25,6 +25,14 @@ func parameters(modules terraform.Modules) ([]types.Parameter, hcl.Diagnostics)
 			}
 
 			if param != nil {
+				if param.Required && param.Value.Value.IsNull() {
+					param.Diagnostics = append(param.Diagnostics, types.DiagnosticCode(&hcl.Diagnostic{
+						Severity: hcl.DiagError,
+						Summary:  "Required parameter not provided",
+						Detail:   "parameter value is null",
+					}, types.DiagnosticCodeRequired))
+				}
+
 				params = append(params, *param)
 
 				if _, ok := exists[param.Name]; !ok {

preview_test.go

@@ -7,6 +7,7 @@ import (
 	"path/filepath"
 	"regexp"
 	"slices"
+	"strings"
 	"testing"
 
 	"github.com/hashicorp/hcl/v2"
@@ -144,7 +145,8 @@ func Test_Extract(t *testing.T) {
 			unknownTags: []string{},
 			input:       preview.Input{},
 			params: map[string]assertParam{
-				"os": ap().
+				"os": apWithDiags().
+					errorDiagnostics("unique").
 					value("0000000000000000000000000000000000000000000000000000000000000000"),
 			},
 		},
@@ -222,7 +224,18 @@ func Test_Extract(t *testing.T) {
 			input:       preview.Input{},
 			unknownTags: []string{},
 			params: map[string]assertParam{
-				"word": ap(),
+				"word": apWithDiags().
+					errorDiagnostics("Required"),
+			},
+		},
+		{
+			name:        "required",
+			dir:         "required",
+			expTags:     map[string]string{},
+			input:       preview.Input{},
+			unknownTags: []string{},
+			params: map[string]assertParam{
+				"region": apWithDiags().errorDiagnostics("Required"),
 			},
 		},
 		{
@@ -487,9 +500,53 @@ func Test_Extract(t *testing.T) {
 type assertParam func(t *testing.T, parameter types.Parameter)
 
 func ap() assertParam {
+	return func(t *testing.T, parameter types.Parameter) {
+		t.Helper()
+		assert.Empty(t, parameter.Diagnostics, "parameter should have no diagnostics")
+	}
+}
+
+func apWithDiags() assertParam {
 	return func(t *testing.T, parameter types.Parameter) {}
 }
 
+func (a assertParam) errorDiagnostics(patterns ...string) assertParam {
+	return a.diagnostics(hcl.DiagError, patterns...)
+}
+
+func (a assertParam) warnDiagnostics(patterns ...string) assertParam {
+	return a.diagnostics(hcl.DiagWarning, patterns...)
+}
+
+func (a assertParam) diagnostics(sev hcl.DiagnosticSeverity, patterns ...string) assertParam {
+	shadow := patterns
+	return a.extend(func(t *testing.T, parameter types.Parameter) {
+		checks := make([]string, len(shadow))
+		copy(checks, shadow)
+
+	DiagLoop:
+		for _, diag := range parameter.Diagnostics {
+			if diag.Severity != sev {
+				continue
+			}
+			for i, pat := range checks {
+				if strings.Contains(diag.Summary, pat) || strings.Contains(diag.Detail, pat) {
+					checks = append(checks[:i], checks[i+1:]...)
+					break DiagLoop
+				}
+			}
+		}
+
+		assert.Equal(t, []string{}, checks, "missing expected diagnostic errors")
+	})
+}
+
+func (a assertParam) noDiagnostics() assertParam {
+	return a.extend(func(t *testing.T, parameter types.Parameter) {
+		assert.Empty(t, parameter.Diagnostics, "parameter should have no diagnostics")
+	})
+}
+
 func (a assertParam) formType(exp provider.ParameterFormType) assertParam {
 	return a.extend(func(t *testing.T, parameter types.Parameter) {
 		assert.Equal(t, exp, parameter.FormType, "parameter form type equality check")
@@ -555,6 +612,7 @@ func (a assertParam) extend(f assertParam) assertParam {
 	}
 
 	return func(t *testing.T, parameter types.Parameter) {
+		t.Helper()
 		(a)(t, parameter)
 		f(t, parameter)
 	}

site/src/types/preview.ts

@@ -1,5 +1,8 @@
 // Code generated by 'guts'. DO NOT EDIT.
 
+// From types/diagnostics.go
+export const DiagnosticCodeRequired = "required";
+
 // From types/diagnostics.go
 export interface DiagnosticExtra {
     readonly code: string;

testdata/required/main.tf

@@ -0,0 +1,25 @@
+// Base case for workspace tags + parameters.
+terraform {
+  required_providers {
+    coder = {
+      source = "coder/coder"
+      version = "2.4.0-pre0"
+    }
+  }
+}
+
+data "coder_parameter" "region" {
+  name        = "region"
+  description = "Which region would you like to deploy to?"
+  type        = "string"
+  order       = 1
+
+  option {
+    name  = "Europe"
+    value = "eu"
+  }
+  option {
+    name  = "United States"
+    value = "us"
+  }
+}

testdata/required/skipe2e

@@ -0,0 +1 @@
+missing param value

types/diagnostics.go

@@ -6,6 +6,12 @@ import (
 	"github.com/hashicorp/hcl/v2"
 )
 
+const (
+	// DiagnosticCodeRequired is used when a parameter value is `null`, but
+	// the parameter is required.
+	DiagnosticCodeRequired = "required"
+)
+
 type DiagnosticExtra struct {
 	Code string `json:"code"`
 
@@ -19,6 +25,13 @@ func (e DiagnosticExtra) UnwrapDiagnosticExtra() interface{} {
 	return e.Wrapped
 }
 
+func DiagnosticCode(diag *hcl.Diagnostic, code string) *hcl.Diagnostic {
+	SetDiagnosticExtra(diag, DiagnosticExtra{
+		Code: code,
+	})
+	return diag
+}
+
 func ExtractDiagnosticExtra(diag *hcl.Diagnostic) DiagnosticExtra {
 	// Zero values for a missing extra field is fine.
 	extra, _ := hcl.DiagnosticExtra[DiagnosticExtra](diag)