Use a validator library instead of custom validation where possible (#…

…230) When the TF provider was created, there was no official library for standard validation. This meant that we had to write our own validation functions. This commit replaces those with a library that is maintained by the Terraform team.
vercel · Oct 29, 2024 · 393410d · 393410d
1 parent 4d5a5e1
commit 393410d
Show file tree

Hide file tree

Showing 28 changed files with 93 additions and 693 deletions.
diff --git a/vercel/data_source_project.go b/vercel/data_source_project.go
@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"regexp"
 
+	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
@@ -69,8 +70,8 @@ For more detailed information, please see the [Vercel documentation](https://ver
 			"name": schema.StringAttribute{
 				Required: true,
 				Validators: []validator.String{
-					stringLengthBetween(1, 52),
-					stringRegex(
+					stringvalidator.LengthBetween(1, 52),
+					stringvalidator.RegexMatches(
 						regexp.MustCompile(`^[a-z0-9\-]{0,100}$`),
 						"The name of a Project can only contain up to 100 alphanumeric lowercase characters and hyphens",
 					),
@@ -142,7 +143,7 @@ For more detailed information, please see the [Vercel documentation](https://ver
 						Description: "The git provider of the repository. Must be either `github`, `gitlab`, or `bitbucket`.",
 						Computed:    true,
 						Validators: []validator.String{
-							stringOneOf("github", "gitlab", "bitbucket"),
+							stringvalidator.OneOf("github", "gitlab", "bitbucket"),
 						},
 					},
 					"repo": schema.StringAttribute{
@@ -237,7 +238,7 @@ For more detailed information, please see the [Vercel documentation](https://ver
 						Computed:    true,
 						Optional:    true,
 						Validators: []validator.String{
-							stringOneOf("team", "global"),
+							stringvalidator.OneOf("team", "global"),
 						},
 					},
 				},

diff --git a/vercel/data_source_shared_environment_variable.go b/vercel/data_source_shared_environment_variable.go
@@ -5,6 +5,8 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/hashicorp/terraform-plugin-framework-validators/setvalidator"
+	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
@@ -108,8 +110,10 @@ For more detailed information, please see the [Vercel documentation](https://ver
 				Description: "The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.",
 				ElementType: types.StringType,
 				Validators: []validator.Set{
-					stringSetItemsIn("production", "preview", "development"),
-					stringSetMinCount(1),
+					setvalidator.ValueStringsAre(
+						stringvalidator.OneOf("production", "preview", "development"),
+					),
+					setvalidator.SizeAtLeast(1),
 				},
 			},
 			"key": schema.StringAttribute{

diff --git a/vercel/resource_deployment.go b/vercel/resource_deployment.go
@@ -9,6 +9,7 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/hashicorp/terraform-plugin-framework-validators/mapvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
@@ -128,7 +129,7 @@ terraform to your Deployment.
 				PlanModifiers: []planmodifier.Map{mapplanmodifier.RequiresReplace()},
 				ElementType:   types.StringType,
 				Validators: []validator.Map{
-					mapItemsMinCount(1),
+					mapvalidator.SizeAtLeast(1),
 				},
 			},
 			"ref": schema.StringAttribute{

diff --git a/vercel/resource_dns_record.go b/vercel/resource_dns_record.go
@@ -6,6 +6,8 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/hashicorp/terraform-plugin-framework-validators/int64validator"
+	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
@@ -87,7 +89,7 @@ For more detailed information, please see the [Vercel documentation](https://ver
 				PlanModifiers: []planmodifier.String{stringplanmodifier.RequiresReplace()},
 				Required:      true,
 				Validators: []validator.String{
-					stringOneOf("A", "AAAA", "ALIAS", "CAA", "CNAME", "MX", "NS", "SRV", "TXT"),
+					stringvalidator.OneOf("A", "AAAA", "ALIAS", "CAA", "CNAME", "MX", "NS", "SRV", "TXT"),
 				},
 			},
 			"value": schema.StringAttribute{
@@ -100,16 +102,16 @@ For more detailed information, please see the [Vercel documentation](https://ver
 				Optional:    true,
 				Computed:    true,
 				Validators: []validator.Int64{
-					int64GreaterThan(60),
-					int64LessThan(2147483647),
+					int64validator.AtLeast(60),
+					int64validator.AtMost(2147483647),
 				},
 			},
 			"mx_priority": schema.Int64Attribute{
 				Description: "The priority of the MX record. The priority specifies the sequence that an email server receives emails. A smaller value indicates a higher priority.",
 				Optional:    true, // required for MX records.
 				Validators: []validator.Int64{
-					int64GreaterThan(0),
-					int64LessThan(65535),
+					int64validator.AtLeast(0),
+					int64validator.AtMost(65535),
 				},
 			},
 			"comment": schema.StringAttribute{
@@ -118,7 +120,7 @@ For more detailed information, please see the [Vercel documentation](https://ver
 				Computed:    true,
 				Default:     stringdefault.StaticString(""),
 				Validators: []validator.String{
-					stringLengthBetween(0, 500),
+					stringvalidator.LengthBetween(0, 500),
 				},
 			},
 			"srv": schema.SingleNestedAttribute{
@@ -129,24 +131,24 @@ For more detailed information, please see the [Vercel documentation](https://ver
 						Description: "A relative weight for records with the same priority, higher value means higher chance of getting picked.",
 						Required:    true,
 						Validators: []validator.Int64{
-							int64GreaterThan(0),
-							int64LessThan(65535),
+							int64validator.AtLeast(0),
+							int64validator.AtMost(65535),
 						},
 					},
 					"port": schema.Int64Attribute{
 						Description: "The TCP or UDP port on which the service is to be found.",
 						Required:    true,
 						Validators: []validator.Int64{
-							int64GreaterThan(0),
-							int64LessThan(65535),
+							int64validator.AtLeast(0),
+							int64validator.AtMost(65535),
 						},
 					},
 					"priority": schema.Int64Attribute{
 						Description: "The priority of the target host, lower value means more preferred.",
 						Required:    true,
 						Validators: []validator.Int64{
-							int64GreaterThan(0),
-							int64LessThan(65535),
+							int64validator.AtLeast(0),
+							int64validator.AtMost(65535),
 						},
 					},
 					"target": schema.StringAttribute{

diff --git a/vercel/resource_edge_config.go b/vercel/resource_edge_config.go
@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"regexp"
 
+	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
@@ -64,7 +65,7 @@ An Edge Config is a global data store that enables experimentation with feature
 				Description: "The name/slug of the Edge Config.",
 				Required:    true,
 				Validators: []validator.String{
-					stringRegex(
+					stringvalidator.RegexMatches(
 						regexp.MustCompile(`^[a-z0-9\_\-]{0,32}$`),
 						"The name of an Edge Config can only contain up to 32 alphanumeric lowercase characters, hyphens and underscores.",
 					),

diff --git a/vercel/resource_edge_config_token.go b/vercel/resource_edge_config_token.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
@@ -67,7 +68,7 @@ An Edge Config token is used to authenticate against an Edge Config's endpoint.
 				Required:      true,
 				PlanModifiers: []planmodifier.String{stringplanmodifier.RequiresReplace()},
 				Validators: []validator.String{
-					stringLengthBetween(1, 52),
+					stringvalidator.LengthBetween(1, 52),
 				},
 			},
 			"edge_config_id": schema.StringAttribute{

diff --git a/vercel/resource_log_drain.go b/vercel/resource_log_drain.go
@@ -4,6 +4,10 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/hashicorp/terraform-plugin-framework-validators/float64validator"
+	"github.com/hashicorp/terraform-plugin-framework-validators/mapvalidator"
+	"github.com/hashicorp/terraform-plugin-framework-validators/setvalidator"
+	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
@@ -84,7 +88,7 @@ Teams on Pro and Enterprise plans can subscribe to log drains that are generic a
 				Required:      true,
 				PlanModifiers: []planmodifier.String{stringplanmodifier.RequiresReplace()},
 				Validators: []validator.String{
-					stringOneOf("json", "ndjson"),
+					stringvalidator.OneOf("json", "ndjson"),
 				},
 			},
 			"environments": schema.SetAttribute{
@@ -93,8 +97,8 @@ Teams on Pro and Enterprise plans can subscribe to log drains that are generic a
 				PlanModifiers: []planmodifier.Set{setplanmodifier.RequiresReplace()},
 				Required:      true,
 				Validators: []validator.Set{
-					stringSetItemsIn("production", "preview"),
-					stringSetMinCount(1),
+					setvalidator.ValueStringsAre(stringvalidator.OneOf("production", "preview")),
+					setvalidator.SizeAtLeast(1),
 				},
 			},
 			"headers": schema.MapAttribute{
@@ -103,7 +107,7 @@ Teams on Pro and Enterprise plans can subscribe to log drains that are generic a
 				PlanModifiers: []planmodifier.Map{mapplanmodifier.RequiresReplace()},
 				Optional:      true,
 				Validators: []validator.Map{
-					mapMaxCount(5),
+					mapvalidator.SizeAtMost(5),
 				},
 			},
 			"project_ids": schema.SetAttribute{
@@ -117,8 +121,8 @@ Teams on Pro and Enterprise plans can subscribe to log drains that are generic a
 				Optional:      true,
 				PlanModifiers: []planmodifier.Float64{float64planmodifier.RequiresReplace()},
 				Validators: []validator.Float64{
-					float64GreaterThan(0),
-					float64LessThan(1),
+					float64validator.AtLeast(0),
+					float64validator.AtMost(1),
 				},
 			},
 			"secret": schema.StringAttribute{
@@ -128,7 +132,7 @@ Teams on Pro and Enterprise plans can subscribe to log drains that are generic a
 				Sensitive:     true,
 				PlanModifiers: []planmodifier.String{stringplanmodifier.RequiresReplaceIfConfigured(), stringplanmodifier.UseStateForUnknown()},
 				Validators: []validator.String{
-					stringLengthGreaterThan(32),
+					stringvalidator.LengthAtLeast(32),
 				},
 			},
 			"sources": schema.SetAttribute{
@@ -137,8 +141,8 @@ Teams on Pro and Enterprise plans can subscribe to log drains that are generic a
 				ElementType:   types.StringType,
 				PlanModifiers: []planmodifier.Set{setplanmodifier.RequiresReplace()},
 				Validators: []validator.Set{
-					stringSetItemsIn("static", "edge", "external", "build", "lambda"),
-					stringSetMinCount(1),
+					setvalidator.ValueStringsAre(stringvalidator.OneOf("static", "edge", "external", "build", "lambda")),
+					setvalidator.SizeAtLeast(1),
 				},
 			},
 			"endpoint": schema.StringAttribute{