fix: Add error type to parameters (#59)

kylecarbs · web-flow · commit b6d707729d00 · 2022-10-03T14:39:14.000-05:00
diff --git a/docs/data-sources/parameter.md b/docs/data-sources/parameter.md
@@ -53,6 +53,7 @@ Optional:
 
 Optional:
 
+- `error` (String) An error message to display if the value doesn't match the provided regex.
 - `max` (Number) The maximum of a number parameter.
 - `min` (Number) The minimum of a number parameter.
 - `regex` (String) A regex for the input parameter to match against.
diff --git a/docs/resources/app.md b/docs/resources/app.md
@@ -64,7 +64,7 @@ resource "coder_app" "intellij" {
 
 - `command` (String) A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. Either "command" or "url" may be specified, but not both.
 - `healthcheck` (Block Set, Max: 1) HTTP health checking to determine the application readiness. (see [below for nested schema](#nestedblock--healthcheck))
-- `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>"`.
+- `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/icons. Use a built-in icon with `data.coder_workspace.me.access_url + "/icons/<path>"`.
 - `name` (String) A display name to identify the app.
 - `relative_path` (Boolean) Specifies whether the URL will be accessed via a relative path or wildcard. Use if wildcard routing is unavailable.
 - `url` (String) A URL to be proxied to from inside the workspace. Either "command" or "url" may be specified, but not both.
diff --git a/examples/resources/coder_app/resource.tf b/examples/resources/coder_app/resource.tf
@@ -26,13 +26,13 @@ resource "coder_app" "code-server" {
 resource "coder_app" "vim" {
   agent_id = coder_agent.dev.id
   name     = "Vim"
-  icon     = data.coder_workspace.me.access_url + "/icons/vim.svg"
+  icon     = "${data.coder_workspace.me.access_url}/icon/vim.svg"
   command  = "vim"
 }
 
 resource "coder_app" "intellij" {
   agent_id = coder_agent.dev.id
-  icon     = data.coder_workspace.me.access_url + "/icons/intellij.svg"
+  icon     = "${data.coder_workspace.me.access_url}/icon/intellij.svg"
   name     = "JetBrains IntelliJ"
   command  = "projector run"
 }
diff --git a/provider/parameter.go b/provider/parameter.go
@@ -2,6 +2,8 @@ package provider
 
 import (
 	"context"
+	"crypto/sha256"
+	"encoding/hex"
 	"fmt"
 	"net/url"
 	"os"
@@ -26,6 +28,7 @@ type Validation struct {
 	Min   int
 	Max   int
 	Regex string
+	Error string
 }
 
 type Parameter struct {
@@ -79,7 +82,7 @@ func parameterDataSource() *schema.Resource {
 				}
 				value = parameter.Default
 			}
-			envValue, ok := os.LookupEnv(fmt.Sprintf("CODER_PARAMETER_%s", parameter.Name))
+			envValue, ok := os.LookupEnv(ParameterEnvironmentVariable(parameter.Name))
 			if ok {
 				value = envValue
 			}
@@ -238,6 +241,12 @@ func parameterDataSource() *schema.Resource {
 							Description:   "A regex for the input parameter to match against.",
 							Optional:      true,
 						},
+						"error": {
+							Type:         schema.TypeString,
+							Optional:     true,
+							RequiredWith: []string{"validation.0.regex"},
+							Description:  "An error message to display if the value doesn't match the provided regex.",
+						},
 					},
 				},
 			},
@@ -292,6 +301,9 @@ func (v *Validation) Valid(typ, value string) error {
 		if !matched {
 			return fmt.Errorf("value %q does not match %q", value, regex)
 		}
+		if v.Error == "" {
+			return fmt.Errorf("an error must be specified with a regex validation")
+		}
 	case "number":
 		num, err := strconv.Atoi(value)
 		if err != nil {
@@ -306,3 +318,11 @@ func (v *Validation) Valid(typ, value string) error {
 	}
 	return nil
 }
+
+// ParameterEnvironmentVariable returns the environment variable to specify for
+// a parameter by it's name. It's hashed because spaces and special characters
+// can be used in parameter names that may not be valid in env vars.
+func ParameterEnvironmentVariable(name string) string {
+	sum := sha256.Sum256([]byte(name))
+	return "CODER_PARAMETER_" + hex.EncodeToString(sum[:])
+}
diff --git a/provider/parameter_test.go b/provider/parameter_test.go
@@ -73,10 +73,24 @@ data "coder_parameter" "region" {
 	}
 	validation {
 		regex = "1"
+		error = "Not 1"
 	}
 }
 `,
 		ExpectError: regexp.MustCompile("conflicts with option"),
+	}, {
+		Name: "ValidationRegexMissingError",
+		Config: `
+data "coder_parameter" "region" {
+	name = "Region"
+	type = "string"
+	default = "hello"
+	validation {
+		regex = "hello"
+	}
+}
+`,
+		ExpectError: regexp.MustCompile("an error must be specified"),
 	}, {
 		Name: "NumberValidation",
 		Config: `
@@ -90,9 +104,6 @@ data "coder_parameter" "region" {
 	}
 }
 `,
-		Check: func(state *terraform.ResourceState) {
-
-		},
 	}, {
 		Name: "DefaultNotNumber",
 		Config: `
