Skip to content

Commit 6ee9188

Browse files
aslilacaslilac
committed
fix: use codersdk functions for validating name attributes
1 parent ecc7a9a commit 6ee9188

File tree

9 files changed

+201
-24
lines changed

9 files changed

+201
-24
lines changed

‎.golangci.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Visit https://golangci-lint.run/ for usage documentation
2-
# and information on other useful linters
1+
# Visit https://golangci-lint.run/ for usage documentation and information on
2+
# other useful linters
33
issues:
44
max-per-linter: 0
55
max-same-issues: 0
@@ -24,4 +24,4 @@ linters:
2424
- unconvert
2525
- unparam
2626
- unused
27-
- vet
27+
- vet

‎internal/codersdkvalidator/display_name.go‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
package codersdkvalidator
2+
3+
import (
4+
"context"
5+
6+
"github.com/coder/coder/v2/codersdk"
7+
"github.com/hashicorp/terraform-plugin-framework-validators/helpers/validatordiag"
8+
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
9+
)
10+
11+
type displayNameValidator struct {
12+
err error
13+
}
14+
15+
func DisplayName() validator.String {
16+
return displayNameValidator{}
17+
}
18+
19+
var _ validator.String = displayNameValidator{}
20+
21+
func (v displayNameValidator) ValidateString(ctx context.Context, req validator.StringRequest, resp *validator.StringResponse) {
22+
if req.ConfigValue.IsNull() || req.ConfigValue.IsUnknown() {
23+
return
24+
}
25+
26+
name := req.ConfigValue.ValueString()
27+
if v.err = codersdk.DisplayNameValid(name); v.err != nil {
28+
resp.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(
29+
req.Path,
30+
v.Description(ctx),
31+
name,
32+
))
33+
}
34+
}
35+
36+
var _ validator.Describer = displayNameValidator{}
37+
38+
func (v displayNameValidator) Description(_ context.Context) string {
39+
if v.err != nil {
40+
return v.err.Error()
41+
}
42+
return "value must be a valid display name"
43+
}
44+
45+
func (v displayNameValidator) MarkdownDescription(ctx context.Context) string {
46+
return v.Description(ctx)
47+
}

‎internal/codersdkvalidator/name.go‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
package codersdkvalidator
2+
3+
import (
4+
"context"
5+
6+
"github.com/coder/coder/v2/codersdk"
7+
"github.com/hashicorp/terraform-plugin-framework-validators/helpers/validatordiag"
8+
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
9+
)
10+
11+
type nameValidator struct {
12+
err error
13+
}
14+
15+
func Name() validator.String {
16+
return nameValidator{}
17+
}
18+
19+
var _ validator.String = nameValidator{}
20+
21+
func (v nameValidator) ValidateString(ctx context.Context, req validator.StringRequest, resp *validator.StringResponse) {
22+
if req.ConfigValue.IsNull() || req.ConfigValue.IsUnknown() {
23+
return
24+
}
25+
26+
name := req.ConfigValue.ValueString()
27+
if v.err = codersdk.NameValid(name); v.err != nil {
28+
resp.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(
29+
req.Path,
30+
v.Description(ctx),
31+
name,
32+
))
33+
}
34+
}
35+
36+
var _ validator.Describer = nameValidator{}
37+
38+
func (v nameValidator) Description(_ context.Context) string {
39+
if v.err != nil {
40+
return v.err.Error()
41+
}
42+
return "value must be a valid name"
43+
}
44+
45+
func (v nameValidator) MarkdownDescription(ctx context.Context) string {
46+
return v.Description(ctx)
47+
}

‎internal/codersdkvalidator/template_version_name.go‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
package codersdkvalidator
2+
3+
import (
4+
"context"
5+
6+
"github.com/coder/coder/v2/codersdk"
7+
"github.com/hashicorp/terraform-plugin-framework-validators/helpers/validatordiag"
8+
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
9+
)
10+
11+
type templateVersionNameValidator struct {
12+
err error
13+
}
14+
15+
func TemplateVersionName() validator.String {
16+
return templateVersionNameValidator{}
17+
}
18+
19+
var _ validator.String = templateVersionNameValidator{}
20+
21+
func (v templateVersionNameValidator) ValidateString(ctx context.Context, req validator.StringRequest, resp *validator.StringResponse) {
22+
if req.ConfigValue.IsNull() || req.ConfigValue.IsUnknown() {
23+
return
24+
}
25+
26+
name := req.ConfigValue.ValueString()
27+
if v.err = codersdk.TemplateVersionNameValid(name); v.err != nil {
28+
resp.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(
29+
req.Path,
30+
v.Description(ctx),
31+
name,
32+
))
33+
}
34+
}
35+
36+
var _ validator.Describer = templateVersionNameValidator{}
37+
38+
func (v templateVersionNameValidator) Description(_ context.Context) string {
39+
if v.err != nil {
40+
return v.err.Error()
41+
}
42+
return "value must be a valid template version name"
43+
}
44+
45+
func (v templateVersionNameValidator) MarkdownDescription(ctx context.Context) string {
46+
return v.Description(ctx)
47+
}

‎internal/codersdkvalidator/user_real_name.go‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
package codersdkvalidator
2+
3+
import (
4+
"context"
5+
6+
"github.com/coder/coder/v2/codersdk"
7+
"github.com/hashicorp/terraform-plugin-framework-validators/helpers/validatordiag"
8+
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
9+
)
10+
11+
type userRealNameValidator struct {
12+
err error
13+
}
14+
15+
func UserRealName() validator.String {
16+
return userRealNameValidator{}
17+
}
18+
19+
var _ validator.String = userRealNameValidator{}
20+
21+
func (v userRealNameValidator) ValidateString(ctx context.Context, req validator.StringRequest, resp *validator.StringResponse) {
22+
if req.ConfigValue.IsNull() || req.ConfigValue.IsUnknown() {
23+
return
24+
}
25+
26+
name := req.ConfigValue.ValueString()
27+
if v.err = codersdk.UserRealNameValid(name); v.err != nil {
28+
resp.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(
29+
req.Path,
30+
v.Description(ctx),
31+
name,
32+
))
33+
}
34+
}
35+
36+
var _ validator.Describer = userRealNameValidator{}
37+
38+
func (v userRealNameValidator) Description(_ context.Context) string {
39+
if v.err != nil {
40+
return v.err.Error()
41+
}
42+
return "value must be a valid name for a user"
43+
}
44+
45+
func (v userRealNameValidator) MarkdownDescription(ctx context.Context) string {
46+
return v.Description(ctx)
47+
}

‎internal/provider/group_resource.go‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ import (
66
"strings"
77

88
"github.com/coder/coder/v2/codersdk"
9+
"github.com/coder/terraform-provider-coderd/internal/codersdkvalidator"
910
"github.com/google/uuid"
10-
"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
1111
"github.com/hashicorp/terraform-plugin-framework/attr"
1212
"github.com/hashicorp/terraform-plugin-framework/diag"
1313
"github.com/hashicorp/terraform-plugin-framework/path"
@@ -77,17 +77,15 @@ func (r *GroupResource) Schema(ctx context.Context, req resource.SchemaRequest,
7777
MarkdownDescription: "The unique name of the group.",
7878
Required: true,
7979
Validators: []validator.String{
80-
stringvalidator.LengthBetween(1, 36),
81-
stringvalidator.RegexMatches(nameValidRegex, "Group names must be alpahnumeric with hyphens."),
80+
codersdkvalidator.Name(),
8281
},
8382
},
8483
"display_name": schema.StringAttribute{
8584
MarkdownDescription: "The display name of the group. Defaults to the group name.",
8685
Computed: true,
8786
Optional: true,
8887
Validators: []validator.String{
89-
stringvalidator.LengthBetween(1, 64),
90-
stringvalidator.RegexMatches(displayNameRegex, "Group display names must be alphanumeric with spaces"),
88+
codersdkvalidator.DisplayName(),
9189
},
9290
Default: stringdefault.StaticString(""),
9391
},

‎internal/provider/template_resource.go‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import (
1212
"cdr.dev/slog"
1313
"github.com/coder/coder/v2/codersdk"
1414
"github.com/coder/coder/v2/provisionersdk"
15+
"github.com/coder/terraform-provider-coderd/internal/codersdkvalidator"
1516
"github.com/google/uuid"
1617
"github.com/hashicorp/terraform-plugin-framework-validators/listvalidator"
1718
"github.com/hashicorp/terraform-plugin-framework-validators/setvalidator"
@@ -257,17 +258,15 @@ func (r *TemplateResource) Schema(ctx context.Context, req resource.SchemaReques
257258
MarkdownDescription: "The name of the template.",
258259
Required: true,
259260
Validators: []validator.String{
260-
stringvalidator.LengthBetween(1, 32),
261-
stringvalidator.RegexMatches(nameValidRegex, "Template names must be alphanumeric with hyphens."),
261+
codersdkvalidator.Name(),
262262
},
263263
},
264264
"display_name": schema.StringAttribute{
265265
MarkdownDescription: "The display name of the template. Defaults to the template name.",
266266
Optional: true,
267267
Computed: true,
268268
Validators: []validator.String{
269-
stringvalidator.LengthBetween(1, 64),
270-
stringvalidator.RegexMatches(displayNameRegex, "Template display names must be alphanumeric with spaces."),
269+
codersdkvalidator.DisplayName(),
271270
},
272271
},
273272
"description": schema.StringAttribute{
@@ -417,8 +416,7 @@ func (r *TemplateResource) Schema(ctx context.Context, req resource.SchemaReques
417416
Optional: true,
418417
Computed: true,
419418
Validators: []validator.String{
420-
stringvalidator.LengthBetween(1, 64),
421-
stringvalidator.RegexMatches(templateVersionNameRegex, "Template version names must be alphanumeric with underscores and dots."),
419+
codersdkvalidator.TemplateVersionName(),
422420
},
423421
},
424422
"message": schema.StringAttribute{

‎internal/provider/user_resource.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import (
2222
"github.com/hashicorp/terraform-plugin-log/tflog"
2323

2424
"github.com/coder/coder/v2/codersdk"
25+
"github.com/coder/terraform-provider-coderd/internal/codersdkvalidator"
2526
)
2627

2728
// Ensure provider defined types fully satisfy framework interfaces.
@@ -71,16 +72,15 @@ func (r *UserResource) Schema(ctx context.Context, req resource.SchemaRequest, r
7172
MarkdownDescription: "Username of the user.",
7273
Required: true,
7374
Validators: []validator.String{
74-
stringvalidator.LengthBetween(1, 32),
75-
stringvalidator.RegexMatches(nameValidRegex, "Username must be alphanumeric with hyphens."),
75+
codersdkvalidator.Name(),
7676
},
7777
},
7878
"name": schema.StringAttribute{
7979
MarkdownDescription: "Display name of the user. Defaults to username.",
8080
Computed: true,
8181
Optional: true,
8282
Validators: []validator.String{
83-
stringvalidator.LengthBetween(1, 128),
83+
codersdkvalidator.UserRealName(),
8484
},
8585
},
8686
"email": schema.StringAttribute{

‎internal/provider/util.go‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,11 @@ import (
88
"net/http"
99
"os"
1010
"path/filepath"
11-
"regexp"
1211

1312
"github.com/coder/coder/v2/codersdk"
1413
"github.com/google/uuid"
1514
)
1615

17-
var (
18-
nameValidRegex = regexp.MustCompile("^[a-zA-Z0-9]+(?:-[a-zA-Z0-9]+)*$")
19-
templateVersionNameRegex = regexp.MustCompile(`^[a-zA-Z0-9]+(?:[_.-]{1}[a-zA-Z0-9]+)*$`)
20-
displayNameRegex = regexp.MustCompile(`^[^\s](.*[^\s])?$`)
21-
)
22-
2316
func PtrTo[T any](v T) *T {
2417
return &v
2518
}

0 commit comments

Comments
 (0)