diff --git a/go.mod b/go.mod
index 02ea7137..cb415c2b 100644
--- a/go.mod
+++ b/go.mod
@@ -1,6 +1,6 @@
module github.com/coder/terraform-provider-coder/v2
-go 1.22.9
+go 1.24.2
require (
github.com/docker/docker v26.1.5+incompatible
@@ -79,7 +79,7 @@ require (
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.27.0 // indirect
go.opentelemetry.io/otel/metric v1.31.0 // indirect
go.opentelemetry.io/otel/trace v1.31.0 // indirect
- golang.org/x/crypto v0.33.0 // indirect
+ golang.org/x/crypto v0.35.0 // indirect
golang.org/x/net v0.34.0 // indirect
golang.org/x/sync v0.11.0 // indirect
golang.org/x/sys v0.30.0 // indirect
diff --git a/go.sum b/go.sum
index 2b5ad9c5..870d770d 100644
--- a/go.sum
+++ b/go.sum
@@ -225,8 +225,8 @@ golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACk
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
-golang.org/x/crypto v0.33.0 h1:IOBPskki6Lysi0lo9qQvbxiQ+FvsCC/YWOecCHAixus=
-golang.org/x/crypto v0.33.0/go.mod h1:bVdXmD7IV/4GdElGPozy6U7lWdRXA4qyRVGJV57uQ5M=
+golang.org/x/crypto v0.35.0 h1:b15kiHdrGCHrP6LvwaQ3c03kgNhhiMgvlhxHQhmg2Xs=
+golang.org/x/crypto v0.35.0/go.mod h1:dy7dXNW32cAb/6/PRuTNsix8T+vJAqvuIy5Bli/x0YQ=
golang.org/x/exp v0.0.0-20240613232115-7f521ea00fb8 h1:yixxcjnhBmY0nkL253HFVIm0JsFHwrHdT3Yh6szTnfY=
golang.org/x/exp v0.0.0-20240613232115-7f521ea00fb8/go.mod h1:jj3sYF3dwk5D+ghuXyeI3r5MFf+NT2An6/9dOA95KSI=
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
diff --git a/main.go b/main.go
index 2eaa5dc5..ef606a6d 100644
--- a/main.go
+++ b/main.go
@@ -1,6 +1,8 @@
package main
import (
+ "flag"
+
"github.com/hashicorp/terraform-plugin-sdk/v2/plugin"
"github.com/coder/terraform-provider-coder/v2/provider"
@@ -11,8 +13,15 @@ import (
//go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs
func main() {
- servePprof()
- plugin.Serve(&plugin.ServeOpts{
+ debug := flag.Bool("debug", false, "Enable debug mode for the provider")
+ flag.Parse()
+
+ opts := &plugin.ServeOpts{
+ Debug: *debug,
+ ProviderAddr: "registry.terraform.io/coder/coder",
ProviderFunc: provider.New,
- })
+ }
+
+ servePprof()
+ plugin.Serve(opts)
}
diff --git a/provider/formtype.go b/provider/formtype.go
index 753f8945..75d32c46 100644
--- a/provider/formtype.go
+++ b/provider/formtype.go
@@ -115,9 +115,11 @@ var formTypeTruthTable = map[OptionType]map[bool][]ParameterFormType{
// The use case is when using multi-select. The options are 'string' and the
// value is 'list(string)'.
func ValidateFormType(paramType OptionType, optionCount int, specifiedFormType ParameterFormType) (OptionType, ParameterFormType, error) {
- allowed, ok := formTypeTruthTable[paramType][optionCount > 0]
+ optionsExist := optionCount > 0
+ allowed, ok := formTypeTruthTable[paramType][optionsExist]
if !ok || len(allowed) == 0 {
- return paramType, specifiedFormType, xerrors.Errorf("value type %q is not supported for 'form_types'", paramType)
+ // This error should really never be hit, as the provider sdk does an enum validation.
+ return paramType, specifiedFormType, xerrors.Errorf("\"type\" attribute=%q is not supported, choose one of %v", paramType, OptionTypes())
}
if specifiedFormType == ParameterFormTypeDefault {
@@ -126,7 +128,27 @@ func ValidateFormType(paramType OptionType, optionCount int, specifiedFormType P
}
if !slices.Contains(allowed, specifiedFormType) {
- return paramType, specifiedFormType, xerrors.Errorf("value type %q is not supported for 'form_types'", specifiedFormType)
+ optionMsg := ""
+ opposite := formTypeTruthTable[paramType][!optionsExist]
+
+ // This extra message tells a user if they are using a valid form_type
+ // for a 'type', but it is invalid because options do/do-not exist.
+ // It serves as a more helpful error message.
+ //
+ // Eg: form_type=slider is valid for type=number, but invalid if options exist.
+ // And this error message is more accurate than just saying "form_type=slider is
+ // not valid for type=number".
+ if slices.Contains(opposite, specifiedFormType) {
+ if optionsExist {
+ optionMsg = " when options exist"
+ } else {
+ optionMsg = " when options do not exist"
+ }
+ }
+ return paramType, specifiedFormType,
+ xerrors.Errorf("\"form_type\" attribute=%q is not supported for \"type\"=%q%s, choose one of %v",
+ specifiedFormType, paramType,
+ optionMsg, toStrings(allowed))
}
// This is the only current special case. If 'multi-select' is selected, the type
diff --git a/provider/parameter.go b/provider/parameter.go
index 4eb8a282..2f7dc662 100644
--- a/provider/parameter.go
+++ b/provider/parameter.go
@@ -124,7 +124,7 @@ func parameterDataSource() *schema.Resource {
}
var value string
if parameter.Default != "" {
- err := valueIsType(parameter.Type, parameter.Default)
+ err := valueIsType(parameter.Type, parameter.Default, cty.Path{cty.GetAttrStep{Name: "default"}})
if err != nil {
return err
}
@@ -144,6 +144,8 @@ func parameterDataSource() *schema.Resource {
return diag.Errorf("ephemeral parameter requires the default property")
}
+ // TODO: Should we move this into the Valid() function on
+ // Parameter?
if len(parameter.Validation) == 1 {
validation := ¶meter.Validation[0]
err = validation.Valid(parameter.Type, value)
@@ -153,73 +155,27 @@ func parameterDataSource() *schema.Resource {
}
// Validate options
-
- // optionType might differ from parameter.Type. This is ok, and parameter.Type
- // should be used for the value type, and optionType for options.
- var optionType OptionType
- optionType, parameter.FormType, err = ValidateFormType(parameter.Type, len(parameter.Option), parameter.FormType)
+ _, parameter.FormType, err = ValidateFormType(parameter.Type, len(parameter.Option), parameter.FormType)
if err != nil {
- return diag.FromErr(err)
+ return diag.Diagnostics{
+ {
+ Severity: diag.Error,
+ Summary: "Invalid form_type for parameter",
+ Detail: err.Error(),
+ AttributePath: cty.Path{cty.GetAttrStep{Name: "form_type"}},
+ },
+ }
}
// Set the form_type back in case the value was changed.
// Eg via a default. If a user does not specify, a default value
// is used and saved.
rd.Set("form_type", parameter.FormType)
- if len(parameter.Option) > 0 {
- names := map[string]interface{}{}
- values := map[string]interface{}{}
- for _, option := range parameter.Option {
- _, exists := names[option.Name]
- if exists {
- return diag.Errorf("multiple options cannot have the same name %q", option.Name)
- }
- _, exists = values[option.Value]
- if exists {
- return diag.Errorf("multiple options cannot have the same value %q", option.Value)
- }
- err := valueIsType(optionType, option.Value)
- if err != nil {
- return err
- }
- values[option.Value] = nil
- names[option.Name] = nil
- }
-
- if parameter.Default != "" {
- if parameter.Type == OptionTypeListString && optionType == OptionTypeString {
- // If the type is list(string) and optionType is string, we have
- // to ensure all elements of the default exist as options.
- var defaultValues []string
- // TODO: We do this unmarshal in a few spots. It should be standardized.
- err = json.Unmarshal([]byte(parameter.Default), &defaultValues)
- if err != nil {
- return diag.Errorf("default value %q is not a list of strings", parameter.Default)
- }
-
- // missing is used to construct a more helpful error message
- var missing []string
- for _, defaultValue := range defaultValues {
- _, defaultIsValid := values[defaultValue]
- if !defaultIsValid {
- missing = append(missing, defaultValue)
- }
- }
-
- if len(missing) > 0 {
- return diag.Errorf(
- "default value %q is not a valid option, values %q are missing from the option",
- parameter.Default, strings.Join(missing, ", "),
- )
- }
- } else {
- _, defaultIsValid := values[parameter.Default]
- if !defaultIsValid {
- return diag.Errorf("%q default value %q must be defined as one of options", parameter.FormType, parameter.Default)
- }
- }
- }
+ diags := parameter.Valid()
+ if diags.HasError() {
+ return diags
}
+
return nil
},
Schema: map[string]*schema.Schema{
@@ -433,7 +389,7 @@ func fixValidationResourceData(rawConfig cty.Value, validation interface{}) (int
return vArr, nil
}
-func valueIsType(typ OptionType, value string) diag.Diagnostics {
+func valueIsType(typ OptionType, value string, attrPath cty.Path) diag.Diagnostics {
switch typ {
case OptionTypeNumber:
_, err := strconv.ParseFloat(value, 64)
@@ -446,10 +402,9 @@ func valueIsType(typ OptionType, value string) diag.Diagnostics {
return diag.Errorf("%q is not a bool", value)
}
case OptionTypeListString:
- var items []string
- err := json.Unmarshal([]byte(value), &items)
- if err != nil {
- return diag.Errorf("%q is not an array of strings", value)
+ _, diags := valueIsListString(value, attrPath)
+ if diags.HasError() {
+ return diags
}
case OptionTypeString:
// Anything is a string!
@@ -459,6 +414,102 @@ func valueIsType(typ OptionType, value string) diag.Diagnostics {
return nil
}
+func (v *Parameter) Valid() diag.Diagnostics {
+ // optionType might differ from parameter.Type. This is ok, and parameter.Type
+ // should be used for the value type, and optionType for options.
+ optionType, _, err := ValidateFormType(v.Type, len(v.Option), v.FormType)
+ if err != nil {
+ return diag.Diagnostics{
+ {
+ Severity: diag.Error,
+ Summary: "Invalid form_type for parameter",
+ Detail: err.Error(),
+ AttributePath: cty.Path{cty.GetAttrStep{Name: "form_type"}},
+ },
+ }
+ }
+
+ optionNames := map[string]any{}
+ optionValues := map[string]any{}
+ if len(v.Option) > 0 {
+ for _, option := range v.Option {
+ _, exists := optionNames[option.Name]
+ if exists {
+ return diag.Diagnostics{{
+ Severity: diag.Error,
+ Summary: "Option names must be unique.",
+ Detail: fmt.Sprintf("multiple options found with the same name %q", option.Name),
+ },
+ }
+ }
+ _, exists = optionValues[option.Value]
+ if exists {
+ return diag.Diagnostics{
+ {
+ Severity: diag.Error,
+ Summary: "Option values must be unique.",
+ Detail: fmt.Sprintf("multiple options found with the same value %q", option.Value),
+ },
+ }
+ }
+ diags := valueIsType(optionType, option.Value, cty.Path{})
+ if diags.HasError() {
+ return diags
+ }
+ optionValues[option.Value] = nil
+ optionNames[option.Name] = nil
+ }
+ }
+
+ if v.Default != "" && len(v.Option) > 0 {
+ if v.Type == OptionTypeListString && optionType == OptionTypeString {
+ // If the type is list(string) and optionType is string, we have
+ // to ensure all elements of the default exist as options.
+ defaultValues, diags := valueIsListString(v.Default, cty.Path{cty.GetAttrStep{Name: "default"}})
+ if diags.HasError() {
+ return diags
+ }
+
+ // missing is used to construct a more helpful error message
+ var missing []string
+ for _, defaultValue := range defaultValues {
+ _, defaultIsValid := optionValues[defaultValue]
+ if !defaultIsValid {
+ missing = append(missing, defaultValue)
+ }
+ }
+
+ if len(missing) > 0 {
+ return diag.Diagnostics{
+ {
+ Severity: diag.Error,
+ Summary: "Default values must be a valid option",
+ Detail: fmt.Sprintf(
+ "default value %q is not a valid option, values %q are missing from the options",
+ v.Default, strings.Join(missing, ", "),
+ ),
+ AttributePath: cty.Path{cty.GetAttrStep{Name: "default"}},
+ },
+ }
+ }
+ } else {
+ _, defaultIsValid := optionValues[v.Default]
+ if !defaultIsValid {
+ return diag.Diagnostics{
+ {
+ Severity: diag.Error,
+ Summary: "Default value must be a valid option",
+ Detail: fmt.Sprintf("the value %q must be defined as one of options", v.Default),
+ AttributePath: cty.Path{cty.GetAttrStep{Name: "default"}},
+ },
+ }
+ }
+ }
+ }
+
+ return nil
+}
+
func (v *Validation) Valid(typ OptionType, value string) error {
if typ != OptionTypeNumber {
if !v.MinDisabled {
@@ -519,6 +570,22 @@ func (v *Validation) Valid(typ OptionType, value string) error {
return nil
}
+func valueIsListString(value string, path cty.Path) ([]string, diag.Diagnostics) {
+ var items []string
+ err := json.Unmarshal([]byte(value), &items)
+ if err != nil {
+ return nil, diag.Diagnostics{
+ {
+ Severity: diag.Error,
+ Summary: "When using list(string) type, value must be a json encoded list of strings",
+ Detail: fmt.Sprintf("value %q is not a valid list of strings", value),
+ AttributePath: path,
+ },
+ }
+ }
+ return items, 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.
diff --git a/provider/parameter_test.go b/provider/parameter_test.go
index f817280e..4b52d943 100644
--- a/provider/parameter_test.go
+++ b/provider/parameter_test.go
@@ -291,7 +291,7 @@ func TestParameter(t *testing.T) {
}
}
`,
- ExpectError: regexp.MustCompile("cannot have the same name"),
+ ExpectError: regexp.MustCompile("Option names must be unique"),
}, {
Name: "DuplicateOptionValue",
Config: `
@@ -308,7 +308,7 @@ func TestParameter(t *testing.T) {
}
}
`,
- ExpectError: regexp.MustCompile("cannot have the same value"),
+ ExpectError: regexp.MustCompile("Option values must be unique"),
}, {
Name: "RequiredParameterNoDefault",
Config: `
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy