feat: add a workspace preset datasource

docs/data-sources/workspace_preset.md

@@ -0,0 +1,42 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "coder_workspace_preset Data Source - terraform-provider-coder"
+subcategory: ""
+description: |-
+  Use this data source to predefine common configurations for workspaces.
+---
+
+# coder_workspace_preset (Data Source)
+
+Use this data source to predefine common configurations for workspaces.
+
+## Example Usage
+
+```terraform
+provider "coder" {}
+
+# presets can be used to predefine common configurations for workspaces
+# Parameters are referenced by their name. Each parameter must be defined in the preset.
+# Values defined by the preset must pass validation for the parameter.
+# See the coder_parameter data source's documentation for examples of how to define
+# parameters like the ones used below.
+data "coder_workspace_preset" "example" {
+  name = "example"
+  parameters = {
+    (data.coder_parameter.example.name) = "us-central1-a"
+    (data.coder_parameter.ami.name) = "ami-xxxxxxxx"
+  }
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `name` (String) Name of the workspace preset.
+- `parameters` (Map of String) Parameters of the workspace preset.
+
+### Read-Only
+
+- `id` (String) ID of the workspace preset.

examples/data-sources/coder_workspace_preset/data-source.tf

@@ -0,0 +1,14 @@
+provider "coder" {}
+
+# presets can be used to predefine common configurations for workspaces
+# Parameters are referenced by their name. Each parameter must be defined in the preset.
+# Values defined by the preset must pass validation for the parameter.
+# See the coder_parameter data source's documentation for examples of how to define
+# parameters like the ones used below.
+data "coder_workspace_preset" "example" {
+  name = "example"
+  parameters = {
+    (data.coder_parameter.example.name) = "us-central1-a"
+    (data.coder_parameter.ami.name) = "ami-xxxxxxxx"
+  }
+}

provider/provider.go

@@ -61,12 +61,13 @@ func New() *schema.Provider {
 			}, nil
 		},
 		DataSourcesMap: map[string]*schema.Resource{
-			"coder_workspace":       workspaceDataSource(),
-			"coder_workspace_tags":  workspaceTagDataSource(),
-			"coder_provisioner":     provisionerDataSource(),
-			"coder_parameter":       parameterDataSource(),
-			"coder_external_auth":   externalAuthDataSource(),
-			"coder_workspace_owner": workspaceOwnerDataSource(),
+			"coder_workspace":        workspaceDataSource(),
+			"coder_workspace_tags":   workspaceTagDataSource(),
+			"coder_provisioner":      provisionerDataSource(),
+			"coder_parameter":        parameterDataSource(),
+			"coder_external_auth":    externalAuthDataSource(),
+			"coder_workspace_owner":  workspaceOwnerDataSource(),
+			"coder_workspace_preset": workspacePresetDataSource(),
 		},
 		ResourcesMap: map[string]*schema.Resource{
 			"coder_agent":          agentResource(),

provider/workspace_preset.go

@@ -0,0 +1,64 @@
+package provider
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/mitchellh/mapstructure"
+)
+
+type WorkspacePreset struct {
+	Name       string            `mapstructure:"name"`
+	Parameters map[string]string `mapstructure:"parameters"`
+}
+
+func workspacePresetDataSource() *schema.Resource {
+	return &schema.Resource{
+		SchemaVersion: 1,
+
+		Description: "Use this data source to predefine common configurations for workspaces.",
+		ReadContext: func(ctx context.Context, rd *schema.ResourceData, i interface{}) diag.Diagnostics {
+			var preset WorkspacePreset
+			err := mapstructure.Decode(struct {
+				Name       interface{}
+				Parameters interface{}
+			}{
+				Name:       rd.Get("name"),
+				Parameters: rd.Get("parameters"),
+			}, &preset)
+			if err != nil {
+				return diag.Errorf("decode workspace preset: %s", err)
+			}
+
+			if preset.Name == "" {
+				return diag.Errorf("workspace preset name must be set")
+			}
+
+			if len(preset.Parameters) == 0 {
+				return diag.Errorf("workspace preset must define a value for at least one parameter")
+			}
+
+			rd.SetId(preset.Name)
+
+			return nil
+		},
+		Schema: map[string]*schema.Schema{
+			"id": {
+				Type:        schema.TypeString,
+				Description: "ID of the workspace preset.",
+				Computed:    true,
+			},
+			"name": {
+				Type:        schema.TypeString,
+				Description: "Name of the workspace preset.",
+				Required:    true,
+			},
+			"parameters": {
+				Type:        schema.TypeMap,
+				Description: "Parameters of the workspace preset.",
+				Required:    true,
+			},
+		},
+	}
+}

provider/workspace_preset_test.go

@@ -0,0 +1,127 @@
+package provider_test
+
+import (
+	"regexp"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
+	"github.com/stretchr/testify/require"
+)
+
+func TestWorkspacePreset(t *testing.T) {
+	// Happy Path:
+	resource.Test(t, resource.TestCase{
+		ProviderFactories: coderFactory(),
+		IsUnitTest:        true,
+		Steps: []resource.TestStep{{
+			Config: `
+			data "coder_workspace_preset" "preset_1" {
+				name = "preset_1"
+				parameters = {
+					"region" = "us-east1-a"
+				}
+			}`,
+			Check: func(state *terraform.State) error {
+				require.Len(t, state.Modules, 1)
+				require.Len(t, state.Modules[0].Resources, 1)
+				resource := state.Modules[0].Resources["data.coder_workspace_preset.preset_1"]
+				require.NotNil(t, resource)
+				attrs := resource.Primary.Attributes
+				require.Equal(t, attrs["name"], "preset_1")
+				require.Equal(t, attrs["parameters.region"], "us-east1-a")
+				return nil
+			},
+		}},
+	})
+
+	// Given the Name field is not provided
+	resource.Test(t, resource.TestCase{
+		ProviderFactories: coderFactory(),
+		IsUnitTest:        true,
+		Steps: []resource.TestStep{{
+			Config: `
+			data "coder_workspace_preset" "preset_1" {
+				parameters = {
+					"region" = "us-east1-a"
+				}
+			}`,
+			// This is from terraform's validation based on our schema, not based on our validation in ReadContext:
+			ExpectError: regexp.MustCompile("The argument \"name\" is required, but no definition was found"),
+		}},
+	})
+
+	// Given the Name field is empty
+	resource.Test(t, resource.TestCase{
+		ProviderFactories: coderFactory(),
+		IsUnitTest:        true,
+		Steps: []resource.TestStep{{
+			Config: `
+			data "coder_workspace_preset" "preset_1" {
+				name = ""
+				parameters = {
+					"region" = "us-east1-a"
+				}
+			}`,
+			ExpectError: regexp.MustCompile("workspace preset name must be set"),
+		}},
+	})
+
+	// Given the Name field is not a string
+	resource.Test(t, resource.TestCase{
+		ProviderFactories: coderFactory(),
+		IsUnitTest:        true,
+		Steps: []resource.TestStep{{
+			Config: `
+			data "coder_workspace_preset" "preset_1" {
+				name = [1, 2, 3]
+				parameters = {
+					"region" = "us-east1-a"
+				}
+			}`,
+			ExpectError: regexp.MustCompile("Incorrect attribute value type"),
+		}},
+	})
+
+	// Given the Parameters field is not provided
+	resource.Test(t, resource.TestCase{
+		ProviderFactories: coderFactory(),
+		IsUnitTest:        true,
+		Steps: []resource.TestStep{{
+			Config: `
+			data "coder_workspace_preset" "preset_1" {
+				name = "preset_1"
+			}`,
+			ExpectError: regexp.MustCompile("The argument \"parameters\" is required, but no definition was found"),
+		}},
+	})
+
+	// Given the Parameters field is empty
+	resource.Test(t, resource.TestCase{
+		ProviderFactories: coderFactory(),
+		IsUnitTest:        true,
+		Steps: []resource.TestStep{{
+			Config: `
+			data "coder_workspace_preset" "preset_1" {
+				name = "preset_1"
+				parameters = {}
+			}`,
+			ExpectError: regexp.MustCompile("workspace preset must define a value for at least one parameter"),
+		}},
+	})
+
+	// Given the Parameters field is not a map
+	resource.Test(t, resource.TestCase{
+		ProviderFactories: coderFactory(),
+		IsUnitTest:        true,
+		Steps: []resource.TestStep{{
+			Config: `
+			data "coder_workspace_preset" "preset_1" {
+				name = "preset_1"
+				parameters = "not a map"
+			}`,
+			// This is from terraform's validation based on our schema, not based on our validation in ReadContext:
+			ExpectError: regexp.MustCompile("Inappropriate value for attribute \"parameters\": map of string required"),
+		}},
+	})
+}