Validation for VPC Name (#6348) (#12271)

modular-magician · melinath · web-flow · commit c577a155ba2d · 2022-08-05T13:12:27.000-07:00
* Validation check

* renamed validateGCPName to validateGCEName

* adding doc link for naming convention

* Update mmv1/third_party/terraform/utils/validation.go

Co-authored-by: Stephen Lewis (Burrows) &lt;stephen.r.burrows@gmail.com&gt;

* Update mmv1/third_party/terraform/utils/validation.go

Co-authored-by: Stephen Lewis (Burrows) &lt;stephen.r.burrows@gmail.com&gt;

* renamed validateGCPName to validateGCEName

Co-authored-by: Stephen Lewis (Burrows) &lt;stephen.r.burrows@gmail.com&gt;
Signed-off-by: Modular Magician &lt;magic-modules@google.com&gt;

Co-authored-by: Stephen Lewis (Burrows) &lt;stephen.r.burrows@gmail.com&gt;
diff --git a/.changelog/6348.txt b/.changelog/6348.txt
@@ -0,0 +1,3 @@
+```release-note:enhancement
+compute: added validation for name field on `google_compute_network`
+```
diff --git a/google/resource_cloudfunctions_function.go b/google/resource_cloudfunctions_function.go
@@ -72,7 +72,7 @@ func parseCloudFunctionId(d *schema.ResourceData, config *Config) (*cloudFunctio
 	}, nil
 }
 
-// Differs from validateGcpName because Cloud Functions allow capital letters
+// Differs from validateGCEName because Cloud Functions allow capital letters
 // at start/end
 func validateResourceCloudFunctionsFunctionName(v interface{}, k string) (ws []string, errors []error) {
 	re := `^(?:[a-zA-Z](?:[-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?)$`
diff --git a/google/resource_composer_environment.go b/google/resource_composer_environment.go
@@ -133,7 +133,7 @@ func resourceComposerEnvironment() *schema.Resource {
 				Type:         schema.TypeString,
 				Required:     true,
 				ForceNew:     true,
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 				Description:  `Name of the environment.`,
 			},
 			"region": {
diff --git a/google/resource_compute_autoscaler.go b/google/resource_compute_autoscaler.go
@@ -280,7 +280,7 @@ to include directives regarding slower scale down, as described above.`,
 				Type:         schema.TypeString,
 				Required:     true,
 				ForceNew:     true,
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 				Description: `Name of the resource. The name must be 1-63 characters long and match
 the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the
 first character must be a lowercase letter, and all following
diff --git a/google/resource_compute_firewall.go b/google/resource_compute_firewall.go
@@ -163,7 +163,7 @@ func resourceComputeFirewall() *schema.Resource {
 				Type:         schema.TypeString,
 				Required:     true,
 				ForceNew:     true,
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 				Description: `Name of the resource. Provided by the client when the resource is
 created. The name must be 1-63 characters long, and comply with
 RFC1035. Specifically, the name must be 1-63 characters long and match
diff --git a/google/resource_compute_forwarding_rule.go b/google/resource_compute_forwarding_rule.go
@@ -187,7 +187,7 @@ func resourceComputeForwardingRule() *schema.Resource {
 				Optional:     true,
 				ForceNew:     true,
 				Description:  "An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing.",
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 			},
 
 			"subnetwork": {
diff --git a/google/resource_compute_global_network_endpoint_group.go b/google/resource_compute_global_network_endpoint_group.go
@@ -43,7 +43,7 @@ func resourceComputeGlobalNetworkEndpointGroup() *schema.Resource {
 				Type:         schema.TypeString,
 				Required:     true,
 				ForceNew:     true,
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 				Description: `Name of the resource; provided by the client when the resource is
 created. The name must be 1-63 characters long, and comply with
 RFC1035. Specifically, the name must be 1-63 characters long and match
diff --git a/google/resource_compute_ha_vpn_gateway.go b/google/resource_compute_ha_vpn_gateway.go
@@ -43,7 +43,7 @@ func resourceComputeHaVpnGateway() *schema.Resource {
 				Type:         schema.TypeString,
 				Required:     true,
 				ForceNew:     true,
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 				Description: `Name of the resource. Provided by the client when the resource is
 created. The name must be 1-63 characters long, and comply with
 RFC1035.  Specifically, the name must be 1-63 characters long and
diff --git a/google/resource_compute_instance_template.go b/google/resource_compute_instance_template.go
@@ -67,7 +67,7 @@ func resourceComputeInstanceTemplate() *schema.Resource {
 				Computed:      true,
 				ForceNew:      true,
 				ConflictsWith: []string{"name_prefix"},
-				ValidateFunc:  validateGCPName,
+				ValidateFunc:  validateGCEName,
 				Description:   `The name of the instance template. If you leave this blank, Terraform will auto-generate a unique name.`,
 			},
 
diff --git a/google/resource_compute_network.go b/google/resource_compute_network.go
@@ -43,9 +43,10 @@ func resourceComputeNetwork() *schema.Resource {
 
 		Schema: map[string]*schema.Schema{
 			"name": {
-				Type:     schema.TypeString,
-				Required: true,
-				ForceNew: true,
+				Type:         schema.TypeString,
+				Required:     true,
+				ForceNew:     true,
+				ValidateFunc: validateGCEName,
 				Description: `Name of the resource. Provided by the client when the resource is
 created. The name must be 1-63 characters long, and comply with
 RFC1035. Specifically, the name must be 1-63 characters long and match
diff --git a/google/resource_compute_network_endpoint_group.go b/google/resource_compute_network_endpoint_group.go
@@ -43,7 +43,7 @@ func resourceComputeNetworkEndpointGroup() *schema.Resource {
 				Type:         schema.TypeString,
 				Required:     true,
 				ForceNew:     true,
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 				Description: `Name of the resource; provided by the client when the resource is
 created. The name must be 1-63 characters long, and comply with
 RFC1035. Specifically, the name must be 1-63 characters long and match
diff --git a/google/resource_compute_network_peering.go b/google/resource_compute_network_peering.go
@@ -36,7 +36,7 @@ func resourceComputeNetworkPeering() *schema.Resource {
 				Type:         schema.TypeString,
 				Required:     true,
 				ForceNew:     true,
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 				Description:  `Name of the peering.`,
 			},
 
diff --git a/google/resource_compute_packet_mirroring.go b/google/resource_compute_packet_mirroring.go
@@ -114,7 +114,7 @@ set to true.`,
 			"name": {
 				Type:         schema.TypeString,
 				Required:     true,
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 				Description:  `The name of the packet mirroring rule`,
 			},
 			"network": {
diff --git a/google/resource_compute_region_autoscaler.go b/google/resource_compute_region_autoscaler.go
@@ -280,7 +280,7 @@ to include directives regarding slower scale down, as described above.`,
 				Type:         schema.TypeString,
 				Required:     true,
 				ForceNew:     true,
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 				Description: `Name of the resource. The name must be 1-63 characters long and match
 the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the
 first character must be a lowercase letter, and all following
diff --git a/google/resource_compute_region_network_endpoint_group.go b/google/resource_compute_region_network_endpoint_group.go
@@ -43,7 +43,7 @@ func resourceComputeRegionNetworkEndpointGroup() *schema.Resource {
 				Type:         schema.TypeString,
 				Required:     true,
 				ForceNew:     true,
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 				Description: `Name of the resource; provided by the client when the resource is
 created. The name must be 1-63 characters long, and comply with
 RFC1035. Specifically, the name must be 1-63 characters long and match
diff --git a/google/resource_compute_region_ssl_certificate.go b/google/resource_compute_region_ssl_certificate.go
@@ -68,7 +68,7 @@ The chain must include at least one intermediate cert.`,
 				Computed:     true,
 				Optional:     true,
 				ForceNew:     true,
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 				Description: `Name of the resource. Provided by the client when the resource is
 created. The name must be 1-63 characters long, and comply with
 RFC1035. Specifically, the name must be 1-63 characters long and match
diff --git a/google/resource_compute_router.go b/google/resource_compute_router.go
@@ -66,7 +66,7 @@ func resourceComputeRouter() *schema.Resource {
 				Type:         schema.TypeString,
 				Required:     true,
 				ForceNew:     true,
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 				Description: `Name of the resource. The name must be 1-63 characters long, and
 comply with RFC1035. Specifically, the name must be 1-63 characters
 long and match the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?'
diff --git a/google/resource_compute_security_policy.go b/google/resource_compute_security_policy.go
@@ -35,7 +35,7 @@ func resourceComputeSecurityPolicy() *schema.Resource {
 				Type:         schema.TypeString,
 				Required:     true,
 				ForceNew:     true,
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 				Description:  `The name of the security policy.`,
 			},
 
diff --git a/google/resource_compute_ssl_certificate.go b/google/resource_compute_ssl_certificate.go
@@ -68,7 +68,7 @@ The chain must include at least one intermediate cert.`,
 				Computed:     true,
 				Optional:     true,
 				ForceNew:     true,
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 				Description: `Name of the resource. Provided by the client when the resource is
 created. The name must be 1-63 characters long, and comply with
 RFC1035. Specifically, the name must be 1-63 characters long and match
diff --git a/google/resource_compute_subnetwork.go b/google/resource_compute_subnetwork.go
@@ -83,7 +83,7 @@ non-overlapping within a network. Only IPv4 is supported.`,
 				Type:         schema.TypeString,
 				Required:     true,
 				ForceNew:     true,
-				ValidateFunc: validateGCPName,
+				ValidateFunc: validateGCEName,
 				Description: `The name of the resource, provided by the client when initially
 creating the resource. The name must be 1-63 characters long, and
 comply with RFC1035. Specifically, the name must be 1-63 characters
@@ -250,7 +250,7 @@ secondary IP ranges within a network. Only IPv4 is supported.`,
 						"range_name": {
 							Type:         schema.TypeString,
 							Required:     true,
-							ValidateFunc: validateGCPName,
+							ValidateFunc: validateGCEName,
 							Description: `The name associated with this subnetwork secondary range, used
 when adding an alias IP range to a VM instance. The name must
 be 1-63 characters long, and comply with RFC1035. The name
diff --git a/google/validation.go b/google/validation.go
@@ -82,7 +82,9 @@ var rfc1918Networks = []string{
 	"192.168.0.0/16",
 }
 
-func validateGCPName(v interface{}, k string) (ws []string, errors []error) {
+// validateGCEName ensures that a field matches the requirements for Compute Engine resource names
+// https://cloud.google.com/compute/docs/naming-resources#resource-name-format
+func validateGCEName(v interface{}, k string) (ws []string, errors []error) {
 	re := `^(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)$`
 	return validateRegexp(re)(v, k)
 }
diff --git a/google/validation_test.go b/google/validation_test.go
@@ -10,7 +10,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 )
 
-func TestValidateGCPName(t *testing.T) {
+func TestvalidateGCEName(t *testing.T) {
 	x := []StringValidationTestCase{
 		// No errors
 		{TestName: "basic", Value: "foobar"},
@@ -27,7 +27,7 @@ func TestValidateGCPName(t *testing.T) {
 		{TestName: "too long", Value: "foobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoob", ExpectError: true},
 	}
 
-	es := testStringValidationCases(x, validateGCPName)
+	es := testStringValidationCases(x, validateGCEName)
 	if len(es) > 0 {
 		t.Errorf("Failed to validate GCP names: %v", es)
 	}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+```release-note:enhancement
	`2`	+compute: added validation for name field on `google_compute_network`
	`3`	+```
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ func parseCloudFunctionId(d schema.ResourceData, config Config) (*cloudFunctio`
`72`	`72`	`}, nil`
`73`	`73`	`}`
`74`	`74`
`75`		`-// Differs from validateGcpName because Cloud Functions allow capital letters`
	`75`	`+// Differs from validateGCEName because Cloud Functions allow capital letters`
`76`	`76`	`// at start/end`
`77`	`77`	`func validateResourceCloudFunctionsFunctionName(v interface{}, k string) (ws []string, errors []error) {`
`78`	`78`	re := `^(?:[a-zA-Z](?:[-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?)$`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,9 @@ var rfc1918Networks = []string{`
`82`	`82`	`"192.168.0.0/16",`
`83`	`83`	`}`
`84`	`84`
`85`		`-func validateGCPName(v interface{}, k string) (ws []string, errors []error) {`
	`85`	`+// validateGCEName ensures that a field matches the requirements for Compute Engine resource names`
	`86`	`+// https://cloud.google.com/compute/docs/naming-resources#resource-name-format`
	`87`	`+func validateGCEName(v interface{}, k string) (ws []string, errors []error) {`
`86`	`88`	re := `^(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)$`
`87`	`89`	`return validateRegexp(re)(v, k)`
`88`	`90`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ import (`
`10`	`10`	`"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"`
`11`	`11`	`)`
`12`	`12`
`13`		`-func TestValidateGCPName(t *testing.T) {`
	`13`	`+func TestvalidateGCEName(t *testing.T) {`
`14`	`14`	`x := []StringValidationTestCase{`
`15`	`15`	`// No errors`
`16`	`16`	`{TestName: "basic", Value: "foobar"},`
`@@ -27,7 +27,7 @@ func TestValidateGCPName(t *testing.T) {`
`27`	`27`	`{TestName: "too long", Value: "foobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoob", ExpectError: true},`
`28`	`28`	`}`
`29`	`29`
`30`		`- es := testStringValidationCases(x, validateGCPName)`
	`30`	`+ es := testStringValidationCases(x, validateGCEName)`
`31`	`31`	`if len(es) > 0 {`
`32`	`32`	`t.Errorf("Failed to validate GCP names: %v", es)`
`33`	`33`	`}`