feat: add icon and description fields to workspace preset

ssncferreira · ssncferreira · commit c9a632168bd1 · 2025-07-21T16:46:31.000Z
diff --git a/docs/data-sources/workspace_preset.md b/docs/data-sources/workspace_preset.md
@@ -49,6 +49,8 @@ data "coder_workspace_preset" "standard" {
 ### Optional
 
 - `default` (Boolean) Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.
+- `description` (String) Describe what this preset does.
+- `icon` (String) A URL to an icon that will display in the dashboard. View built-in icons [here](https://github.com/coder/coder/tree/main/site/static/icon). Use a built-in icon with `"${data.coder_workspace.me.access_url}/icon/<path>"`.
 - `parameters` (Map of String) Workspace parameters that will be set by the workspace preset. For simple templates that only need prebuilds, you may define a preset with zero parameters. Because workspace parameters may change between Coder template versions, preset parameters are allowed to define values for parameters that do not exist in the current template version.
 - `prebuilds` (Block Set, Max: 1) Configuration for prebuilt workspaces associated with this preset. Coder will maintain a pool of standby workspaces based on this configuration. When a user creates a workspace using this preset, they are assigned a prebuilt workspace instead of waiting for a new one to build. See prebuilt workspace documentation [here](https://coder.com/docs/admin/templates/extending-templates/prebuilt-workspaces.md) (see [below for nested schema](#nestedblock--prebuilds))
 
diff --git a/integration/integration_test.go b/integration/integration_test.go
@@ -93,6 +93,8 @@ func TestIntegration(t *testing.T) {
 				"workspace_parameter.value":                                 `param value`,
 				"workspace_parameter.icon":                                  `param icon`,
 				"workspace_preset.name":                                     `preset`,
+				"workspace_preset.description":                              `preset description`,
+				"workspace_preset.icon":                                     `preset icon`,
 				"workspace_preset.default":                                  `true`,
 				"workspace_preset.parameters.param":                         `preset param value`,
 				"workspace_preset.prebuilds.instances":                      `1`,
diff --git a/integration/test-data-source/main.tf b/integration/test-data-source/main.tf
@@ -20,8 +20,10 @@ data "coder_parameter" "param" {
   icon        = "param icon"
 }
 data "coder_workspace_preset" "preset" {
-  name    = "preset"
-  default = true
+  name        = "preset"
+  description = "preset description"
+  icon        = "preset icon"
+  default     = true
   parameters = {
     (data.coder_parameter.param.name) = "preset param value"
   }
@@ -65,6 +67,8 @@ locals {
     "workspace_parameter.value" : data.coder_parameter.param.value,
     "workspace_parameter.icon" : data.coder_parameter.param.icon,
     "workspace_preset.name" : data.coder_workspace_preset.preset.name,
+    "workspace_preset.description" : data.coder_workspace_preset.preset.description,
+    "workspace_preset.icon" : data.coder_workspace_preset.preset.icon,
     "workspace_preset.default" : tostring(data.coder_workspace_preset.preset.default),
     "workspace_preset.parameters.param" : data.coder_workspace_preset.preset.parameters.param,
     "workspace_preset.prebuilds.instances" : tostring(one(data.coder_workspace_preset.preset.prebuilds).instances),
diff --git a/provider/workspace_preset.go b/provider/workspace_preset.go
@@ -3,6 +3,7 @@ package provider
 import (
 	"context"
 	"fmt"
+	"net/url"
 	"strings"
 	"time"
 
@@ -18,9 +19,11 @@ import (
 var PrebuildsCRONParser = rbcron.NewParser(rbcron.Minute | rbcron.Hour | rbcron.Dom | rbcron.Month | rbcron.Dow)
 
 type WorkspacePreset struct {
-	Name       string            `mapstructure:"name"`
-	Default    bool              `mapstructure:"default"`
-	Parameters map[string]string `mapstructure:"parameters"`
+	Name        string            `mapstructure:"name"`
+	Description string            `mapstructure:"description"`
+	Icon        string            `mapstructure:"icon"`
+	Default     bool              `mapstructure:"default"`
+	Parameters  map[string]string `mapstructure:"parameters"`
 	// There should always be only one prebuild block, but Terraform's type system
 	// still parses them as a slice, so we need to handle it as such. We could use
 	// an anonymous type and rd.Get to avoid a slice here, but that would not be possible
@@ -93,6 +96,29 @@ func workspacePresetDataSource() *schema.Resource {
 				Required:     true,
 				ValidateFunc: validation.StringIsNotEmpty,
 			},
+			"description": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "Describe what this preset does.",
+			},
+			"icon": {
+				Type: schema.TypeString,
+				Description: "A URL to an icon that will display in the dashboard. View built-in " +
+					"icons [here](https://github.com/coder/coder/tree/main/site/static/icon). Use a " +
+					"built-in icon with `\"${data.coder_workspace.me.access_url}/icon/<path>\"`.",
+				ForceNew: true,
+				Optional: true,
+				ValidateFunc: func(value interface{}, label string) ([]string, []error) {
+					val, ok := value.(string)
+					if !ok {
+						return nil, []error{fmt.Errorf("expected %q to be a string", label)}
+					}
+					if _, err := url.Parse(val); err != nil {
+						return nil, []error{err}
+					}
+					return nil, nil
+				},
+			},
 			"default": {
 				Type:        schema.TypeBool,
 				Description: "Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.",
diff --git a/provider/workspace_preset_test.go b/provider/workspace_preset_test.go
@@ -23,6 +23,11 @@ func TestWorkspacePreset(t *testing.T) {
 			Config: `
 			data "coder_workspace_preset" "preset_1" {
 				name = "preset_1"
+				description = <<-EOT
+					# Select the machine image
+					See the [registry](https://container.registry.blah/namespace) for options.
+					EOT
+				icon = "/icon/region.svg"
 				parameters = {
 					"region" = "us-east1-a"
 				}
@@ -34,6 +39,8 @@ func TestWorkspacePreset(t *testing.T) {
 				require.NotNil(t, resource)
 				attrs := resource.Primary.Attributes
 				require.Equal(t, attrs["name"], "preset_1")
+				require.Equal(t, attrs["description"], "# Select the machine image\nSee the [registry](https://container.registry.blah/namespace) for options.\n")
+				require.Equal(t, attrs["icon"], "/icon/region.svg")
 				require.Equal(t, attrs["parameters.region"], "us-east1-a")
 				return nil
 			},
@@ -76,6 +83,48 @@ func TestWorkspacePreset(t *testing.T) {
 			// So we test it here to make sure we don't regress.
 			ExpectError: regexp.MustCompile("Incorrect attribute value type"),
 		},
+		{
+			Name: "Description field is empty",
+			Config: `
+			data "coder_workspace_preset" "preset_1" {
+				name = "preset_1"
+				description = ""
+				parameters = {
+					"region" = "us-east1-a"
+				}
+			}`,
+			// This validation is done by Terraform, but it could still break if we misconfigure the schema.
+			// So we test it here to make sure we don't regress.
+			ExpectError: nil,
+		},
+		{
+			Name: "Icon field is empty",
+			Config: `
+			data "coder_workspace_preset" "preset_1" {
+				name = "preset_1"
+				icon = ""
+				parameters = {
+					"region" = "us-east1-a"
+				}
+			}`,
+			// This validation is done by Terraform, but it could still break if we misconfigure the schema.
+			// So we test it here to make sure we don't regress.
+			ExpectError: nil,
+		},
+		{
+			Name: "Icon field is an invalid URL",
+			Config: `
+			data "coder_workspace_preset" "preset_1" {
+				name = "preset_1"
+				icon = "/icon%.svg"
+				parameters = {
+					"region" = "us-east1-a"
+				}
+			}`,
+			// This validation is done by Terraform, but it could still break if we misconfigure the schema.
+			// So we test it here to make sure we don't regress.
+			ExpectError: regexp.MustCompile("invalid URL escape"),
+		},
 		{
 			Name: "Parameters field is not provided",
 			Config: `
