Skip to content

fix: skip validating unknown version names #123

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 1 commit into from
Oct 31, 2024
Merged

fix: skip validating unknown version names #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 18 additions & 13 deletions internal/provider/template_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -896,9 +896,27 @@ func (a *activeVersionValidator) ValidateList(ctx context.Context, req validator
return
}

// Check all versions have unique names
uniqueNames := make(map[string]struct{})
for _, version := range data {
if version.Name.IsNull() || version.Name.IsUnknown() {
continue
}
if _, ok := uniqueNames[version.Name.ValueString()]; ok {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Template version names must be unique. `%s` appears twice.", version.Name.ValueString()))
return
}
uniqueNames[version.Name.ValueString()] = struct{}{}
}

// Check if only one item in Version has active set to true
active := false
for _, version := range data {
// `active` is required, so if it's null or unknown, this is Terraform
// requesting an early validation.
if version.Active.IsNull() || version.Active.IsUnknown() {
return
}
if version.Active.ValueBool() {
if active {
resp.Diagnostics.AddError("Client Error", "Only one template version can be active at a time.")
Expand All @@ -910,19 +928,6 @@ func (a *activeVersionValidator) ValidateList(ctx context.Context, req validator
if !active {
resp.Diagnostics.AddError("Client Error", "At least one template version must be active.")
}

// Check all versions have unique names
uniqueNames := make(map[string]struct{})
for _, version := range data {
if version.Name.IsNull() {
continue
}
if _, ok := uniqueNames[version.Name.ValueString()]; ok {
Copy link
Member Author

@ethanndickson ethanndickson Oct 31, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

If two names were populated using Terraform variables, they'd be Unknown and ValueString would return the empty string for both, which would then lead to a false duplicate in the map.

resp.Diagnostics.AddError("Client Error", "Template version names must be unique.")
return
}
uniqueNames[version.Name.ValueString()] = struct{}{}
}
}

var _ validator.List = &activeVersionValidator{}
Expand Down
56 changes: 56 additions & 0 deletions internal/provider/template_resource_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -648,6 +648,62 @@ func TestAccTemplateResourceAGPL(t *testing.T) {
})
}

func TestAccTemplateResourceVariables(t *testing.T) {
cfg := `
provider coderd {
url = "%s"
token = "%s"
}

data "coderd_organization" "default" {
is_default = true
}

variable "PRIOR_GIT_COMMIT_SHA" {
default = "abcdef"
}

variable "CURRENT_GIT_COMMIT_SHA" {
default = "ghijkl"
}

variable "ACTIVE" {
default = true
}

resource "coderd_template" "sample" {
name = "example-template"
versions = [
{
name = "${var.PRIOR_GIT_COMMIT_SHA}"
directory = "../../integration/template-test/example-template"
active = var.ACTIVE
},
{
name = "${var.CURRENT_GIT_COMMIT_SHA}"
directory = "../../integration/template-test/example-template"
active = false
}
]
}`

ctx := context.Background()
client := integration.StartCoder(ctx, t, "template_acc", false)

cfg = fmt.Sprintf(cfg, client.URL.String(), client.SessionToken())

resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
IsUnitTest: true,
ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
Steps: []resource.TestStep{
{
Config: cfg,
},
},
})
}

type testAccTemplateResourceConfig struct {
URL string
Token string
Expand Down
Loading