Skip to content

feat: allow validation to be used with options #202

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 5 commits into from
Mar 22, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,39 @@
# terraform-provider-coder

See [Coder](https://github.com/coder/coder).
Terraform provider for [Coder](https://github.com/coder/coder).

### Developing

Follow the instructions outlined in the [Terraform documentation](https://developer.hashicorp.com/terraform/cli/config/config-file#development-overrides-for-provider-developers)
to setup your local Terraform to use your local version rather than the registry version.

1. Create a file named `.terraformrc` in your `$HOME` directory
2. Add the following content:
```hcl
provider_installation {
# Override the coder/coder provider to use your local version
dev_overrides {
"coder/coder" = "/path/to/terraform-provider-coder"
}

# For all other providers, install them directly from their origin provider
# registries as normal. If you omit this, Terraform will _only_ use
# the dev_overrides block, and so no other providers will be available.
direct {}
}
```
3. (optional, but recommended) Validate your configuration:
1. Create a new `main.tf` file and include:
```hcl
terraform {
required_providers {
coder = {
source = "coder/coder"
}
}
}
```
2. Run `terraform init` and observe a warning like `Warning: Provider development overrides are in effect`
Copy link
Member

Choose a reason for hiding this comment

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

Nice trick!

4. Run `go build -o terraform-provider-coder` to build the provider binary, which Terraform will try locate and execute
5. All local Terraform runs will now use your local provider!
6. _**NOTE**: we vendor in this provider into `github.com/coder/coder`, so if you're testing with a local clone then you should also run `go mod edit -replace github.com/coder/terraform-provider-coder=/path/to/terraform-provider-coder` in your clone._
23 changes: 12 additions & 11 deletions provider/parameter.go
Original file line number Diff line number Diff line change
Expand Up @@ -231,12 +231,11 @@ func parameterDataSource() *schema.Resource {
},
},
"option": {
Type: schema.TypeList,
Description: "Each \"option\" block defines a value for a user to select from.",
ForceNew: true,
Optional: true,
MaxItems: 64,
ConflictsWith: []string{"validation"},
Type: schema.TypeList,
Description: "Each \"option\" block defines a value for a user to select from.",
ForceNew: true,
Optional: true,
MaxItems: 64,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"name": {
Expand Down Expand Up @@ -276,11 +275,10 @@ func parameterDataSource() *schema.Resource {
},
},
"validation": {
Type: schema.TypeList,
MaxItems: 1,
Optional: true,
Description: "Validate the input of a parameter.",
ConflictsWith: []string{"option"},
Type: schema.TypeList,
MaxItems: 1,
Optional: true,
Description: "Validate the input of a parameter.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"min": {
Expand Down Expand Up @@ -410,6 +408,9 @@ func (v *Validation) Valid(typ, value string) error {
if !v.MaxDisabled {
return fmt.Errorf("a max cannot be specified for a %s type", typ)
}
if v.Monotonic != "" {
return fmt.Errorf("monotonic validation can only be specified for number types, not %s types", typ)
}
}
if typ != "string" && v.Regex != "" {
return fmt.Errorf("a regex cannot be specified for a %s type", typ)
Expand Down
68 changes: 66 additions & 2 deletions provider/parameter_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ func TestParameter(t *testing.T) {
}
},
}, {
Name: "ValidationWithOptions",
Name: "RegexValidationWithOptions",
Config: `
data "coder_parameter" "region" {
name = "Region"
Expand All @@ -88,7 +88,23 @@ func TestParameter(t *testing.T) {
}
}
`,
ExpectError: regexp.MustCompile("conflicts with option"),
ExpectError: regexp.MustCompile("a regex cannot be specified for a number type"),
}, {
Name: "MonotonicValidationWithNonNumberType",
Config: `
data "coder_parameter" "region" {
name = "Region"
type = "string"
option {
name = "1"
value = "1"
}
validation {
monotonic = "increasing"
}
}
`,
ExpectError: regexp.MustCompile("monotonic validation can only be specified for number types, not string types"),
}, {
Name: "ValidationRegexMissingError",
Config: `
Expand Down Expand Up @@ -424,6 +440,54 @@ data "coder_parameter" "region" {
require.Equal(t, expected, state.Primary.Attributes[key])
}
},
}, {
Name: "NumberValidation_MonotonicWithOptions",
Copy link
Member

Choose a reason for hiding this comment

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

I used to drop an example here as well.

Config: `
data "coder_parameter" "region" {
name = "Region"
type = "number"
Copy link
Member

Choose a reason for hiding this comment

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

nit: formatting?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh weird, my editor is probably handling tabs in a strange way. Thanks 👍

description = <<-EOF
Always pick a larger region.
EOF
default = 1

option {
name = "Small"
value = 1
}

option {
name = "Medium"
value = 2
}

option {
name = "Large"
value = 3
}

validation {
monotonic = "increasing"
Copy link
Member

Choose a reason for hiding this comment

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

nit: indent

}
}
`,
Check: func(state *terraform.ResourceState) {
for key, expected := range map[string]any{
"name": "Region",
"type": "number",
"validation.#": "1",
"option.0.name": "Small",
"option.0.value": "1",
"option.1.name": "Medium",
"option.1.value": "2",
"option.2.name": "Large",
"option.2.value": "3",
"default": "1",
"validation.0.monotonic": "increasing",
} {
require.Equal(t, expected, state.Primary.Attributes[key])
}
},
}, {
Name: "NumberValidation_Min",
Config: `
Expand Down
Loading