chore: implement form_type and use custom terraform provider

Author: Emyrk

.github/workflows/gotest.yml

@@ -15,12 +15,37 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/[email protected]
       - uses: actions/setup-go@v5
         with:
           go-version: 1.22.8
+      - name: Install Coder Terraform Provider Locally
+        uses: actions/[email protected]
+        with:
+          repository: 'coder/terraform-provider-coder'
+          ref: 'stevenmasley/form_control'
+          path: "terraform-provider-coder"
+      - name: Build Local Terraform Provider
+        run: |
+          cd terraform-provider-coder
+          go build -o terraform-provider-coder
+          cd ..
+      - name: Setup dev terraform
+        run: |
+          touch $HOME/.terraformrc
+          echo provider_installation { > $HOME/.terraformrc
+          echo   dev_overrides { >> $HOME/.terraformrc
+          echo     "coder/coder" = "$GITHUB_WORKSPACE/terraform-provider-coder" >> $HOME/.terraformrc
+          echo   } >> $HOME/.terraformrc
+          echo   direct {} >> $HOME/.terraformrc
+          echo } >> $HOME/.terraformrc
+          
+          echo "'.terraformrc' contents"
+          cat $HOME/.terraformrc
+
+      - uses: actions/[email protected]
       - name: Install gotestsum
         shell: bash
         run: go install gotest.tools/gotestsum@latest
+
       - name: Run tests
         run: gotestsum ./...

extract/parameter.go

@@ -2,6 +2,7 @@ package extract
 
 import (
 	"fmt"
+	"slices"
 	"strings"
 
 	"github.com/aquasecurity/trivy/pkg/iac/terraform"
@@ -11,6 +12,7 @@ import (
 
 	"github.com/coder/preview/hclext"
 	"github.com/coder/preview/types"
+	"github.com/coder/terraform-provider-coder/v2/provider"
 )
 
 func ParameterFromBlock(block *terraform.Block) (*types.Parameter, hcl.Diagnostics) {
@@ -26,6 +28,16 @@ func ParameterFromBlock(block *terraform.Block) (*types.Parameter, hcl.Diagnosti
 		diags = diags.Append(typDiag)
 	}
 
+	formType, formTypeDiags := optionalStringEnum[provider.ParameterFormType](block, "form_type", provider.ParameterFormTypeDefault, func(s provider.ParameterFormType) error {
+		if !slices.Contains(provider.ParameterFormTypes(), s) {
+			return fmt.Errorf("invalid form type %q, expected one of [%s]", s, strings.Join(toStrings(provider.ParameterFormTypes()), ", "))
+		}
+		return nil
+	})
+	if formTypeDiags != nil {
+		diags = diags.Append(formTypeDiags)
+	}
+
 	pName, nameDiag := requiredString(block, "name")
 	if nameDiag != nil {
 		diags = diags.Append(nameDiag)
@@ -36,16 +48,24 @@ func ParameterFromBlock(block *terraform.Block) (*types.Parameter, hcl.Diagnosti
 	}
 
 	pVal := richParameterValue(block)
+
+	def := types.StringLiteral("")
+	defAttr := block.GetAttribute("default")
+	if !defAttr.IsNil() {
+		def = types.ToHCLString(block, defAttr)
+	}
+
 	p := types.Parameter{
 		Value: pVal,
-		RichParameter: types.RichParameter{
+		ParameterData: types.ParameterData{
 			Name:        pName,
 			Description: optionalString(block, "description"),
 			Type:        pType,
+			FormType:    formType,
 			Mutable:     optionalBoolean(block, "mutable"),
 			// Default value is always written as a string, then converted
 			// to the correct type.
-			DefaultValue: optionalString(block, "default"),
+			DefaultValue: def,
 			Icon:         optionalString(block, "icon"),
 			Options:      make([]*types.ParameterOption, 0),
 			Validations:  make([]*types.ParameterValidation, 0),
@@ -58,7 +78,25 @@ func ParameterFromBlock(block *terraform.Block) (*types.Parameter, hcl.Diagnosti
 		},
 	}
 
-	for _, b := range block.GetBlocks("option") {
+	optBlocks := block.GetBlocks("option")
+
+	optionType, newFormType, err := provider.ValidateFormType(string(p.Type), len(optBlocks), p.FormType)
+	if err != nil {
+		diags = diags.Append(&hcl.Diagnostic{
+			Severity: hcl.DiagError,
+			Summary:  fmt.Sprintf("Invalid parameter `type=%q` and `form_type=%q`", p.Type, p.FormType),
+			Detail:   err.Error(),
+			Context:  &block.HCLBlock().DefRange,
+		})
+
+		// Parameter cannot be used
+		p.FormType = provider.ParameterFormTypeError
+	} else {
+		p.Type = types.ParameterType(optionType)
+		p.FormType = newFormType
+	}
+
+	for _, b := range optBlocks {
 		opt, optDiags := ParameterOptionFromBlock(b)
 		diags = diags.Extend(optDiags)
 
@@ -107,6 +145,7 @@ func ParameterFromBlock(block *terraform.Block) (*types.Parameter, hcl.Diagnosti
 			paramTypeDiag.EvalContext = block.Context().Inner()
 		}
 		diags = diags.Append(paramTypeDiag)
+		p.FormType = provider.ParameterFormTypeError
 	}
 
 	if ctyType != cty.NilType && pVal.Value.Type().Equals(cty.String) {
@@ -126,10 +165,9 @@ func ParameterFromBlock(block *terraform.Block) (*types.Parameter, hcl.Diagnosti
 		}
 	}
 
-	// Parameter usage diags are useful.
 	usageDiags := ParameterUsageDiagnostics(p)
 	if usageDiags.HasErrors() {
-		p.FormControl = types.FormControlError
+		p.FormType = provider.ParameterFormTypeError
 	}
 	diags = diags.Extend(usageDiags)
 
@@ -215,20 +253,14 @@ func ParameterOptionFromBlock(block *terraform.Block) (types.ParameterOption, hc
 
 	valAttr := block.GetAttribute("value")
 
-	pVal := types.HCLString{
-		Value:      hclext.Value(valAttr.HCLAttribute().Expr, block.Context().Inner()),
-		ValueDiags: nil,
-		ValueExpr:  valAttr.HCLAttribute().Expr,
-	}
-
 	if diags.HasErrors() {
 		return types.ParameterOption{}, diags
 	}
 
 	p := types.ParameterOption{
 		Name:        pName,
 		Description: optionalString(block, "description"),
-		Value:       pVal,
+		Value:       types.ToHCLString(block, valAttr),
 		Icon:        optionalString(block, "icon"),
 	}
 
@@ -355,7 +387,7 @@ func optionalString(block *terraform.Block, key string) string {
 		return ""
 	}
 	val := attr.Value()
-	if val.Type() != cty.String {
+	if !val.Type().Equals(cty.String) {
 		return ""
 	}
 
@@ -440,3 +472,11 @@ func ParameterCtyType(typ string) (cty.Type, error) {
 		return cty.Type{}, fmt.Errorf("unsupported type: %q", typ)
 	}
 }
+
+func toStrings[A ~string](l []A) []string {
+	var r []string
+	for _, v := range l {
+		r = append(r, string(v))
+	}
+	return r
+}

extract/state.go

@@ -7,6 +7,7 @@ import (
 	tfjson "github.com/hashicorp/terraform-json"
 
 	"github.com/coder/preview/types"
+	"github.com/coder/terraform-provider-coder/v2/provider"
 )
 
 func ParametersFromState(state *tfjson.StateModule) ([]types.Parameter, error) {
@@ -53,12 +54,13 @@ func ParameterFromState(block *tfjson.StateResource) (types.Parameter, error) {
 
 	param := types.Parameter{
 		Value: types.StringLiteral(st.string("value")),
-		RichParameter: types.RichParameter{
+		ParameterData: types.ParameterData{
 			Name:         st.string("name"),
 			Description:  st.optionalString("description"),
 			Type:         types.ParameterType(st.optionalString("type")),
+			FormType:     provider.ParameterFormType(st.optionalString("form_type")),
 			Mutable:      st.optionalBool("mutable"),
-			DefaultValue: st.optionalString("default"),
+			DefaultValue: types.StringLiteral(st.optionalString("default")),
 			Icon:         st.optionalString("icon"),
 			Options:      options,
 			Validations:  validations,

go.mod

@@ -7,7 +7,7 @@ require (
 	github.com/aquasecurity/trivy v0.58.2
 	github.com/coder/guts v1.0.2-0.20250227211802-139809366a22
 	github.com/coder/serpent v0.10.0
-	github.com/coder/terraform-provider-coder/v2 v2.2.0
+	github.com/coder/terraform-provider-coder/v2 v2.2.1-0.20250313232118-21ff5ae2bf31
 	github.com/coder/websocket v1.8.12
 	github.com/go-chi/chi v4.1.2+incompatible
 	github.com/hashicorp/go-version v1.7.0
@@ -73,13 +73,17 @@ require (
 	github.com/hashicorp/go-getter v1.7.8 // indirect
 	github.com/hashicorp/go-hclog v1.6.3 // indirect
 	github.com/hashicorp/go-multierror v1.1.1 // indirect
+	github.com/hashicorp/go-plugin v1.6.2 // indirect
 	github.com/hashicorp/go-retryablehttp v0.7.7 // indirect
 	github.com/hashicorp/go-safetemp v1.0.0 // indirect
 	github.com/hashicorp/go-uuid v1.0.3 // indirect
 	github.com/hashicorp/logutils v1.0.0 // indirect
 	github.com/hashicorp/terraform-plugin-go v0.26.0 // indirect
 	github.com/hashicorp/terraform-plugin-log v0.9.0 // indirect
-	github.com/hashicorp/terraform-plugin-sdk/v2 v2.36.0 // indirect
+	github.com/hashicorp/terraform-plugin-sdk/v2 v2.36.1 // indirect
+	github.com/hashicorp/terraform-registry-address v0.2.4 // indirect
+	github.com/hashicorp/terraform-svchost v0.1.1 // indirect
+	github.com/hashicorp/yamux v0.1.1 // indirect
 	github.com/jmespath/go-jmespath v0.4.1-0.20220621161143-b0104c826a24 // indirect
 	github.com/klauspost/compress v1.17.11 // indirect
 	github.com/liamg/memoryfs v1.6.0 // indirect
@@ -95,6 +99,7 @@ require (
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
 	github.com/muesli/reflow v0.3.0 // indirect
 	github.com/muesli/termenv v0.15.2 // indirect
+	github.com/oklog/run v1.0.0 // indirect
 	github.com/pion/transport/v2 v2.0.0 // indirect
 	github.com/pion/udp v0.1.4 // indirect
 	github.com/planetscale/vtprotobuf v0.6.1-0.20240319094008-0393e58bdf10 // indirect

go.sum

@@ -720,8 +720,10 @@ github.com/coder/pretty v0.0.0-20230908205945-e89ba86370e0 h1:3A0ES21Ke+FxEM8CXx
 github.com/coder/pretty v0.0.0-20230908205945-e89ba86370e0/go.mod h1:5UuS2Ts+nTToAMeOjNlnHFkPahrtDkmpydBen/3wgZc=
 github.com/coder/serpent v0.10.0 h1:ofVk9FJXSek+SmL3yVE3GoArP83M+1tX+H7S4t8BSuM=
 github.com/coder/serpent v0.10.0/go.mod h1:cZFW6/fP+kE9nd/oRkEHJpG6sXCtQ+AX7WMMEHv0Y3Q=
-github.com/coder/terraform-provider-coder/v2 v2.2.0 h1:VC29ALb/y/mgdN2+u+u6b5qmHPH/MJIO7FjjBbT3YaY=
-github.com/coder/terraform-provider-coder/v2 v2.2.0/go.mod h1:RHGyb+ghiy8UpDAMJM8duRFuzd+1VqA3AtkRLh2P3Ug=
+github.com/coder/terraform-provider-coder/v2 v2.2.1-0.20250313231042-bcfbf3924c60 h1:qOUvnd7Ea51eDXFEDNzX+/s/CGZUNPAYYTqo4Ccpyp4=
+github.com/coder/terraform-provider-coder/v2 v2.2.1-0.20250313231042-bcfbf3924c60/go.mod h1:X28s3rz+aEM5PkBKvk3xcUrQFO2eNPjzRChUg9wb70U=
+github.com/coder/terraform-provider-coder/v2 v2.2.1-0.20250313232118-21ff5ae2bf31 h1:JpDe/YonsKNbpbfruoniS/N0ozBV8Ekd67auoGOi3lY=
+github.com/coder/terraform-provider-coder/v2 v2.2.1-0.20250313232118-21ff5ae2bf31/go.mod h1:X28s3rz+aEM5PkBKvk3xcUrQFO2eNPjzRChUg9wb70U=
 github.com/coder/websocket v1.8.12 h1:5bUXkEPPIbewrnkU8LTCLVaxi4N4J8ahufH2vlo4NAo=
 github.com/coder/websocket v1.8.12/go.mod h1:LNVeNrXQZfe5qhS9ALED3uA+l5pPqvwXg3CKoDBB2gs=
 github.com/containerd/log v0.1.0 h1:TCJt7ioM2cr/tfR8GPbGf9/VRAX8D2B4PjzCpfX540I=
@@ -980,8 +982,8 @@ github.com/hashicorp/terraform-plugin-go v0.26.0 h1:cuIzCv4qwigug3OS7iKhpGAbZTiy
 github.com/hashicorp/terraform-plugin-go v0.26.0/go.mod h1:+CXjuLDiFgqR+GcrM5a2E2Kal5t5q2jb0E3D57tTdNY=
 github.com/hashicorp/terraform-plugin-log v0.9.0 h1:i7hOA+vdAItN1/7UrfBqBwvYPQ9TFvymaRGZED3FCV0=
 github.com/hashicorp/terraform-plugin-log v0.9.0/go.mod h1:rKL8egZQ/eXSyDqzLUuwUYLVdlYeamldAHSxjUFADow=
-github.com/hashicorp/terraform-plugin-sdk/v2 v2.36.0 h1:7/iejAPyCRBhqAg3jOx+4UcAhY0A+Sg8B+0+d/GxSfM=
-github.com/hashicorp/terraform-plugin-sdk/v2 v2.36.0/go.mod h1:TiQwXAjFrgBf5tg5rvBRz8/ubPULpU0HjSaVi5UoJf8=
+github.com/hashicorp/terraform-plugin-sdk/v2 v2.36.1 h1:WNMsTLkZf/3ydlgsuXePa3jvZFwAJhruxTxP/c1Viuw=
+github.com/hashicorp/terraform-plugin-sdk/v2 v2.36.1/go.mod h1:P6o64QS97plG44iFzSM6rAn6VJIC/Sy9a9IkEtl79K4=
 github.com/hashicorp/terraform-registry-address v0.2.4 h1:JXu/zHB2Ymg/TGVCRu10XqNa4Sh2bWcqCNyKWjnCPJA=
 github.com/hashicorp/terraform-registry-address v0.2.4/go.mod h1:tUNYTVyCtU4OIGXXMDp7WNcJ+0W1B4nmstVDgHMjfAU=
 github.com/hashicorp/terraform-svchost v0.1.1 h1:EZZimZ1GxdqFRinZ1tpJwVxxt49xc/S52uzrw4x0jKQ=

hclext/value.go

@@ -34,16 +34,16 @@ func CompareParameters(t *testing.T, pr *preview.Output, values *tfjson.StateMod
 
 	types.SortParameters(stateParams)
 	types.SortParameters(pr.Parameters)
-	require.Len(t, pr.Parameters, len(stateParams), "number of parameters")
+	passed = passed && assert.Len(t, pr.Parameters, len(stateParams), "number of parameters")
 
 	for i, param := range stateParams {
 		adata, err := json.Marshal(param)
-		require.NoError(t, err, "marshal parameter %q", param.Name)
+		passed = passed && assert.NoError(t, err, "marshal parameter %q", param.Name)
 
 		bdata, err := json.Marshal(pr.Parameters[i])
-		require.NoError(t, err, "marshal parameter %q", pr.Parameters[i].Name)
+		passed = passed && assert.NoError(t, err, "marshal parameter %q", pr.Parameters[i].Name)
 
-		require.JSONEq(t, string(adata), string(bdata), "parameter %q", param.Name)
+		passed = passed && assert.JSONEq(t, string(adata), string(bdata), "parameter %q", param.Name)
 	}
 
 	return passed

internal/verify/cmp.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/coder/preview"
 	"github.com/coder/preview/types"
+	"github.com/coder/terraform-provider-coder/v2/provider"
 )
 
 func Test_Extract(t *testing.T) {
@@ -40,9 +41,10 @@ func Test_Extract(t *testing.T) {
 			},
 			unknownTags: []string{},
 			params: map[string]assertParam{
-				"Region": ap().value("us").
+				"region": ap().value("us").
 					def("us").
-					optVals("us", "eu"),
+					optVals("us", "eu").
+					formType(provider.ParameterFormTypeRadio),
 				"numerical": ap().value("5"),
 			},
 		},
@@ -369,6 +371,12 @@ func ap() assertParam {
 	return func(t *testing.T, parameter types.Parameter) {}
 }
 
+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")
+	})
+}
+
 func (a assertParam) unknown() assertParam {
 	return a.extend(func(t *testing.T, parameter types.Parameter) {
 		assert.False(t, parameter.Value.IsKnown(), "parameter unknown check")

preview_test.go

@@ -0,0 +1,26 @@
+# Development
+
+Currently, a branch of the coder terraform provider is required.
+
+
+1. Git clone `[email protected]:coder/terraform-provider-coder.git`
+  - Checkout branch `stevenmasley/form_control`
+  - Build the provider with `go build -o terraform-provider-coder`
+1. Create a file named `.terraformrc` in your `$HOME` directory
+1. Add the following content:
+
+```hcl
+ provider_installation {
+     # Override the coder/coder provider to use your local version
+     dev_overrides {
+       "coder/coder" = "/path/to/terraform-provider-coder"
+     }
+
+     # For all other providers, install them directly from their origin provider
+     # registries as normal. If you omit this, Terraform will _only_ use
+     # the dev_overrides block, and so no other providers will be available.
+     direct {}
+ }
+```
+
+Now you are using the right terraform provider.

testdata/static/README.md

@@ -18,7 +18,7 @@ data "coder_workspace_tags" "custom_workspace_tags" {
 }
 
 data "coder_parameter" "region" {
-  name        = "Region"
+  name        = "region"
   description = "Which region would you like to deploy to?"
   type        = "string"
   default     = "us"
@@ -40,4 +40,4 @@ data "coder_parameter" "numerical" {
   type        = "number"
   default     = 5
   order       = 2
-}
+}