reduce name prefix in compute resources (#11448)

Author: c2thorn

mmv1/products/compute/RegionSslCertificate.yaml

@@ -47,7 +47,13 @@ async: !ruby/object:Api::OpAsync
 docs: !ruby/object:Provider::Terraform::Docs
   optional_properties: |
     * `name_prefix` - (Optional) Creates a unique name beginning with the
-     specified prefix. Conflicts with `name`.
+     specified prefix. Conflicts with `name`. Max length is 54 characters.
+     Prefixes with lengths longer than 37 characters will use a shortened
+     UUID that will be more prone to collisions.
+     Resulting name for a `name_prefix` <= 37 characters:
+     `name_prefix` + YYYYmmddHHSSssss + 8 digit incremental counter
+     Resulting name for a `name_prefix` 38 - 54 characters:
+     `name_prefix` + YYmmdd + 3 digit incremental counter
 examples:
   - !ruby/object:Provider::Terraform::Examples
     name: 'region_ssl_certificate_basic'

mmv1/products/compute/SslCertificate.yaml

@@ -47,7 +47,13 @@ async: !ruby/object:Api::OpAsync
 docs: !ruby/object:Provider::Terraform::Docs
   optional_properties: |
     * `name_prefix` - (Optional) Creates a unique name beginning with the
-     specified prefix. Conflicts with `name`.
+     specified prefix. Conflicts with `name`. Max length is 54 characters.
+     Prefixes with lengths longer than 37 characters will use a shortened
+     UUID that will be more prone to collisions.
+     Resulting name for a `name_prefix` <= 37 characters:
+     `name_prefix` + YYYYmmddHHSSssss + 8 digit incremental counter
+     Resulting name for a `name_prefix` 38 - 54 characters:
+     `name_prefix` + YYmmdd + 3 digit incremental counter
 examples:
   - !ruby/object:Provider::Terraform::Examples
     name: 'ssl_certificate_basic'

mmv1/templates/terraform/custom_expand/name_or_name_prefix.go.erb

@@ -17,7 +17,12 @@ func expand<%= prefix -%><%= titlelize_property(property) -%>(v interface{}, d t
 	if v, ok := d.GetOk("name"); ok {
 		certName = v.(string)
 	} else if v, ok := d.GetOk("name_prefix"); ok {
-		certName = id.PrefixedUniqueId(v.(string))
+		prefix := v.(string)
+		if len(prefix) > 37 {
+			certName = tpgresource.ReducedPrefixedUniqueId(prefix)
+		} else {
+			certName = id.PrefixedUniqueId(prefix)
+		}
 	} else {
 		certName = id.UniqueId()
 	}

mmv1/templates/terraform/encoders/workflow.go.erb

@@ -2,7 +2,12 @@ var ResName string
 if v, ok := d.GetOk("name"); ok {
 	ResName = v.(string)
 } else if v, ok := d.GetOk("name_prefix"); ok {
-	ResName = id.PrefixedUniqueId(v.(string))
+	prefix := v.(string)
+	if len(prefix) > 37 {
+		ResName = tpgresource.ReducedPrefixedUniqueId(prefix)
+	} else {
+		ResName = id.PrefixedUniqueId(prefix)
+	}
 } else {
 	ResName = id.UniqueId()
 }

mmv1/templates/terraform/extra_schema_entry/ssl_certificate.erb

@@ -7,11 +7,11 @@
 	Description:   "Creates a unique name beginning with the specified prefix. Conflicts with name.",
 	ValidateFunc: func(v interface{}, k string) (ws []string, errors []error) {
 		// https://cloud.google.com/compute/docs/reference/latest/sslCertificates#resource
-		// uuid is 26 characters, limit the prefix to 37.
+		// uuid is 9 characters, limit the prefix to 54.
 		value := v.(string)
-		if len(value) > 37 {
+		if len(value) > 54 {
 			errors = append(errors, fmt.Errorf(
-				"%q cannot be longer than 37 characters, name is limited to 63", k))
+				"%q cannot be longer than 54 characters, name is limited to 63", k))
 		}
 		return
 	},

mmv1/third_party/terraform/services/compute/resource_compute_instance_template.go.erb

@@ -96,14 +96,14 @@ func ResourceComputeInstanceTemplate() *schema.Resource {
 				Optional:    true,
 				Computed:    true,
 				ForceNew:    true,
-				Description: `Creates a unique name beginning with the specified prefix. Conflicts with name.`,
+				Description: `Creates a unique name beginning with the specified prefix. Conflicts with name. Max length is 54 characters. Prefixes with lengths longer than 37 characters will use a shortened UUID that will be more prone to collisions.`,
 				ValidateFunc: func(v interface{}, k string) (ws []string, errors []error) {
 					// https://cloud.google.com/compute/docs/reference/latest/instanceTemplates#resource
-					// uuid is 26 characters, limit the prefix to 37.
+					// shortened uuid is 9 characters, limit the prefix to 55.
 					value := v.(string)
-					if len(value) > 37 {
+					if len(value) > 54 {
 						errors = append(errors, fmt.Errorf(
-							"%q cannot be longer than 37 characters, name is limited to 63", k))
+							"%q cannot be longer than 54 characters, name is limited to 63", k))
 					}
 					return
 				},
@@ -1434,7 +1434,12 @@ func resourceComputeInstanceTemplateCreate(d *schema.ResourceData, meta interfac
 	if v, ok := d.GetOk("name"); ok {
 		itName = v.(string)
 	} else if v, ok := d.GetOk("name_prefix"); ok {
-		itName = id.PrefixedUniqueId(v.(string))
+		prefix := v.(string)
+		if len(prefix) > 37 {
+			itName = tpgresource.ReducedPrefixedUniqueId(prefix)
+		} else {
+			itName = id.PrefixedUniqueId(prefix)
+		}
 	} else {
 		itName = id.UniqueId()
 	}

mmv1/third_party/terraform/services/compute/resource_compute_instance_template_test.go.erb

@@ -875,6 +875,45 @@ func TestAccComputeInstanceTemplate_invalidDiskType(t *testing.T) {
 	})
 }
 
+func TestAccComputeInstanceTemplate_withNamePrefix(t *testing.T) {
+	t.Parallel()
+
+	// 8 + 46 = 54 which is the valid max
+	normalPrefix := "tf-test-" + fmt.Sprintf("%046s", "")
+	reducedSuffixPrefix := "tf-test-" + fmt.Sprintf("%029s", "")
+	invalidPrefix := "tf-test-" + fmt.Sprintf("%047s", "")
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccComputeInstanceTemplate_withNamePrefix(normalPrefix),
+			},
+			{
+				ResourceName:            "google_compute_instance_template.foobar",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"name_prefix"},
+			},
+			{
+				Config:      testAccComputeInstanceTemplate_withNamePrefix(invalidPrefix),
+				PlanOnly:    true,
+				ExpectError: regexp.MustCompile("cannot be longer than 54 characters"),
+			},
+			{
+				Config: testAccComputeInstanceTemplate_withNamePrefix(reducedSuffixPrefix),
+			},
+			{
+				ResourceName:            "google_compute_instance_template.foobar",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"name_prefix"},
+			},
+		},
+	})
+}
+
 func TestAccComputeInstanceTemplate_withScratchDisk(t *testing.T) {
 	t.Parallel()
 
@@ -2609,6 +2648,28 @@ resource "google_compute_instance_template" "foobar" {
 `, suffix, suffix)
 }
 
+func testAccComputeInstanceTemplate_withNamePrefix(prefix string) string {
+	return fmt.Sprintf(`
+data "google_compute_image" "my_image" {
+	family  = "debian-12"
+	project = "debian-cloud"
+}
+resource "google_compute_instance_template" "foobar" {
+  name_prefix    = "%s"
+  machine_type   = "n1-standard-1"   // can't be e2 because of local-ssd
+  can_ip_forward = false
+  disk {
+    source_image = data.google_compute_image.my_image.name
+    auto_delete  = true
+    boot         = true
+  }
+  network_interface {
+    network = "default"
+  }
+}
+`, prefix)
+}
+
 func testAccComputeInstanceTemplate_with375GbScratchDisk(suffix string) string {
 	return fmt.Sprintf(`
 data "google_compute_image" "my_image" {

mmv1/third_party/terraform/services/compute/resource_compute_region_instance_template.go.erb

@@ -77,11 +77,11 @@ func ResourceComputeRegionInstanceTemplate() *schema.Resource {
 				Description: `Creates a unique name beginning with the specified prefix. Conflicts with name.`,
 				ValidateFunc: func(v interface{}, k string) (ws []string, errors []error) {
 					// https://cloud.google.com/compute/docs/reference/latest/instanceTemplates#resource
-					// uuid is 26 characters, limit the prefix to 37.
+					// uuid is 9 characters, limit the prefix to 54.
 					value := v.(string)
-					if len(value) > 37 {
+					if len(value) > 54 {
 						errors = append(errors, fmt.Errorf(
-							"%q cannot be longer than 37 characters, name is limited to 63", k))
+							"%q cannot be longer than 54 characters, name is limited to 63", k))
 					}
 					return
 				},
@@ -1144,7 +1144,12 @@ func resourceComputeRegionInstanceTemplateCreate(d *schema.ResourceData, meta in
 	if v, ok := d.GetOk("name"); ok {
 		itName = v.(string)
 	} else if v, ok := d.GetOk("name_prefix"); ok {
-		itName = id.PrefixedUniqueId(v.(string))
+		prefix := v.(string)
+		if len(prefix) > 37 {
+			itName = tpgresource.ReducedPrefixedUniqueId(prefix)
+		} else {
+			itName = id.PrefixedUniqueId(prefix)
+		}
 	} else {
 		itName = id.UniqueId()
 	}

mmv1/third_party/terraform/tpgresource/utils.go

@@ -22,6 +22,7 @@ import (
 	"github.com/hashicorp/go-cty/cty"
 	fwDiags "github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/id"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 	"golang.org/x/exp/maps"
@@ -878,3 +879,16 @@ func DefaultProviderZone(_ context.Context, diff *schema.ResourceDiff, meta inte
 
 	return nil
 }
+
+// id.UniqueId() returns a timestamp + incremental hash
+// This function truncates the timestamp to provide a prefix + 9 using
+// YYmmdd + last 3 digits of the incremental hash
+func ReducedPrefixedUniqueId(prefix string) string {
+	// uniqueID is timestamp + 8 digit counter (YYYYmmddHHMMSSssss + 12345678)
+	uniqueId := id.PrefixedUniqueId("")
+	// last three digits of the counter (678)
+	counter := uniqueId[len(uniqueId)-3:]
+	// YYmmdd of date
+	date := uniqueId[2:8]
+	return prefix + date + counter
+}

mmv1/third_party/terraform/website/docs/guides/version_6_upgrade.html.markdown

@@ -88,9 +88,14 @@ terraform {
 
 ## Provider
 
-### Provider-level change example header
+### Compute: `name_prefix` max length has been extended from 37 to 54 characters
 
-Description of the change and how users should adjust their configuration (if needed).
+Affected resources: `google_compute_instance_template`, `google_compute_region_instance_template`, `google_compute_ssl_certificate`,
+and `google_compute_region_ssl_certificate`
+
+Previously, the max length of `name_prefix` was 37 characters since the autogenerated UUID suffix was 26 characters which combined to
+the total max length for names of 63 characters.
+In 6.0, providing a `name_prefix` larger than 37 characters will prompt the provider to use a shortened suffix of only 9 characters, leading to a new max of 54 characters for `name_prefix`. This shortened suffix is inevitably more prone to collisions, so use the longer max `name_prefix` length with caution.
 
 ## Datasources
 

mmv1/third_party/terraform/website/docs/r/compute_instance_template.html.markdown

@@ -295,7 +295,14 @@ The following arguments are supported:
   this blank, Terraform will auto-generate a unique name.
 
 * `name_prefix` - (Optional) Creates a unique name beginning with the specified
-  prefix. Conflicts with `name`.
+  prefix. Conflicts with `name`. Max length is 54 characters.
+  Prefixes with lengths longer than 37 characters will use a shortened
+  UUID that will be more prone to collisions.
+
+  Resulting name for a `name_prefix` <= 37 characters:
+  `name_prefix` + YYYYmmddHHSSssss + 8 digit incremental counter
+  Resulting name for a `name_prefix` 38 - 54 characters:
+  `name_prefix` + YYmmdd + 3 digit incremental counter
 
 * `can_ip_forward` - (Optional) Whether to allow sending and receiving of
     packets with non-matching source or destination IPs. This defaults to false.

mmv1/third_party/terraform/website/docs/r/compute_region_instance_template.html.markdown

@@ -307,7 +307,14 @@ The following arguments are supported:
   this blank, Terraform will auto-generate a unique name.
 
 * `name_prefix` - (Optional) Creates a unique name beginning with the specified
-  prefix. Conflicts with `name`.
+  prefix. Conflicts with `name`. Max length is 54 characters.
+  Prefixes with lengths longer than 37 characters will use a shortened
+  UUID that will be more prone to collisions.
+
+  Resulting name for a `name_prefix` <= 37 characters:
+  `name_prefix` + YYYYmmddHHSSssss + 8 digit incremental counter
+  Resulting name for a `name_prefix` 38 - 54 characters:
+  `name_prefix` + YYmmdd + 3 digit incremental counter
 
 * `can_ip_forward` - (Optional) Whether to allow sending and receiving of
     packets with non-matching source or destination IPs. This defaults to false.