Skip to content

feat: relax error message for number-typed coder parameters #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Feb 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/data-sources/parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Optional:

Optional:

- `error` (String) An error message to display if the value doesn't match the provided regex.
- `error` (String) An error message to display if the value breaks the validation rules. The following placeholders are supported: {max}, {min}, and {value}.
- `max` (Number) The maximum of a number parameter.
- `min` (Number) The minimum of a number parameter.
- `monotonic` (String) Number monotonicity, either increasing or decreasing.
Expand Down
34 changes: 27 additions & 7 deletions provider/parameter.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"os"
"regexp"
"strconv"
"strings"

"github.com/google/uuid"
"github.com/hashicorp/go-cty/cty"
Expand Down Expand Up @@ -314,10 +315,9 @@ func parameterDataSource() *schema.Resource {
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.",
Type: schema.TypeString,
Optional: true,
Description: "An error message to display if the value breaks the validation rules. The following placeholders are supported: {max}, {min}, and {value}.",
},
},
},
Expand Down Expand Up @@ -438,13 +438,13 @@ func (v *Validation) Valid(typ, value string) error {
case "number":
num, err := strconv.Atoi(value)
if err != nil {
return fmt.Errorf("value %q is not a number", value)
return takeFirstError(v.errorRendered(value), fmt.Errorf("value %q is not a number", value))
}
if !v.MinDisabled && num < v.Min {
return fmt.Errorf("value %d is less than the minimum %d", num, v.Min)
return takeFirstError(v.errorRendered(value), fmt.Errorf("value %d is less than the minimum %d", num, v.Min))
}
if !v.MaxDisabled && num > v.Max {
return fmt.Errorf("value %d is more than the maximum %d", num, v.Max)
return takeFirstError(v.errorRendered(value), fmt.Errorf("value %d is more than the maximum %d", num, v.Max))
}
if v.Monotonic != "" && v.Monotonic != ValidationMonotonicIncreasing && v.Monotonic != ValidationMonotonicDecreasing {
return fmt.Errorf("number monotonicity can be either %q or %q", ValidationMonotonicIncreasing, ValidationMonotonicDecreasing)
Expand All @@ -466,3 +466,23 @@ func ParameterEnvironmentVariable(name string) string {
sum := sha256.Sum256([]byte(name))
return "CODER_PARAMETER_" + hex.EncodeToString(sum[:])
}

func takeFirstError(errs ...error) error {
for _, err := range errs {
if err != nil {
return err
}
}
return xerrors.Errorf("developer error: error message is not provided")
}

func (v *Validation) errorRendered(value string) error {
if v.Error == "" {
return nil
}
r := strings.NewReplacer(
"{min}", fmt.Sprintf("%d", v.Min),
"{max}", fmt.Sprintf("%d", v.Max),
"{value}", value)
return xerrors.Errorf(r.Replace(v.Error))
}
14 changes: 14 additions & 0 deletions provider/parameter_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -527,6 +527,20 @@ data "coder_parameter" "region" {
}
`,
ExpectError: regexp.MustCompile("is more than the maximum"),
}, {
Name: "NumberValidation_CustomError",
Config: `
data "coder_parameter" "region" {
name = "Region"
type = "number"
default = 5
validation {
max = 3
error = "foobar"
}
}
`,
ExpectError: regexp.MustCompile("foobar"),
}, {
Name: "NumberValidation_NotInRange",
Config: `
Expand Down