Skip to content

feat: Validate monotonicity for coder_parameter #90

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.

Sign up for GitHub

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 2 commits into from
Feb 3, 2023
Merged

feat: Validate monotonicity for coder_parameter #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fdefcdb
feat: Validate monotonicity for coder_parameter
mtojek Feb 3, 2023
53c16f9
Fix
mtojek Feb 3, 2023
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
15 changes: 14 additions & 1 deletion examples/resources/coder_parameter/resource.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,23 @@ data "coder_parameter" "cores" {
data "coder_parameter" "disk_size" {
name = "Disk Size"
type = "number"
default = "5"
validation {
# This can apply to number.
min = 0
max = 10
monotonic = "increasing"
}
}

data "coder_parameter" "cat_lives" {
name = "Cat Live"
type = "number"
default = "9"
validation {
# This can apply to number and string types.
# This can apply to number.
min = 0
max = 10
monotonic = "decreasing"
}
}
21 changes: 18 additions & 3 deletions provider/parameter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,19 @@ type Option struct {
}

type Validation struct {
Min int
Max int
Min int
Max int
Monotonic string

Regex string
Error string
}

const (
ValidationMonotonicIncreasing = "increasing"
ValidationMonotonicDecreasing = "decreasing"
)

type Parameter struct {
Value string
Name string
Expand Down Expand Up @@ -235,9 +242,14 @@ func parameterDataSource() *schema.Resource {
Description: "The maximum of a number parameter.",
RequiredWith: []string{"validation.0.min"},
},
"monotonic": {
Type: schema.TypeString,
Optional: true,
Description: "Number monotonicity, either increasing or decreasing.",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just curious: Why don't we use a validation func here?

(I do see the check in valueIsType, it's just not obvious why we're doing that instead of validation func.)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will pass this question to @kylecarbs who originally implemented this code. I deduce that this is due to the compliance with terraform-plugin-sdk?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure actually...

},
"regex": {
Type: schema.TypeString,
ConflictsWith: []string{"validation.0.min", "validation.0.max"},
ConflictsWith: []string{"validation.0.min", "validation.0.max", "validation.0.monotonic"},
Description: "A regex for the input parameter to match against.",
Optional: true,
},
Expand Down Expand Up @@ -318,6 +330,9 @@ func (v *Validation) Valid(typ, value string) error {
if num > v.Max {
return 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)
}
}
return nil
}
Expand Down
35 changes: 30 additions & 5 deletions provider/parameter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,8 @@ func TestValueValidatesType(t *testing.T) {
RegexError string
Min,
Max int
Error *regexp.Regexp
Monotonic string
Error *regexp.Regexp
}{{
Name: "StringWithMin",
Type: "string",
Expand Down Expand Up @@ -320,18 +321,42 @@ func TestValueValidatesType(t *testing.T) {
RegexError: "bad fruit",
Value: "apple",
Error: regexp.MustCompile(`bad fruit`),
}, {
Name: "InvalidMonotonicity",
Type: "number",
Value: "1",
Min: 0,
Max: 2,
Monotonic: "foobar",
Error: regexp.MustCompile(`number monotonicity can be either "increasing" or "decreasing"`),
}, {
Name: "IncreasingMonotonicity",
Type: "number",
Value: "1",
Min: 0,
Max: 2,
Monotonic: "increasing",
}, {
Name: "DecreasingMonotonicity",
Type: "number",
Value: "1",
Min: 0,
Max: 2,
Monotonic: "decreasing",
}} {
tc := tc
t.Run(tc.Name, func(t *testing.T) {
t.Parallel()
v := &provider.Validation{
Min: tc.Min,
Max: tc.Max,
Regex: tc.Regex,
Error: tc.RegexError,
Min: tc.Min,
Max: tc.Max,
Monotonic: tc.Monotonic,
Regex: tc.Regex,
Error: tc.RegexError,
}
err := v.Valid(tc.Type, tc.Value)
if tc.Error != nil {
require.Error(t, err)
require.True(t, tc.Error.MatchString(err.Error()), "got: %s", err.Error())
}
})
Expand Down