compute: Implement graceful switch for metadata_startup_script (#12360) (#8888)

[upstream:b2590d7dcb9f424e419fe8a1fb2c217ade96827f]

Signed-off-by: Modular Magician <[email protected]>

Author: modular-magician

.changelog/12360.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+compute: made `metadata_startup_script` able to be updated via graceful switch in `google_compute_instance`
+```

google-beta/services/compute/resource_compute_instance.go

@@ -796,7 +796,6 @@ func ResourceComputeInstance() *schema.Resource {
 			"metadata_startup_script": {
 				Type:        schema.TypeString,
 				Optional:    true,
-				ForceNew:    true,
 				Description: `Metadata startup scripts made available within the instance.`,
 			},
 
@@ -1301,6 +1300,9 @@ be from 0 to 999,999,999 inclusive.`,
 				},
 				suppressEmptyGuestAcceleratorDiff,
 			),
+			customdiff.ForceNewIf("metadata_startup_script", func(_ context.Context, d *schema.ResourceDiff, meta interface{}) bool {
+				return isGracefulMetadataStartupSwitch(d)
+			}),
 			validateSubnetworkProject,
 			forceNewIfNetworkIPNotUpdatable,
 			tpgresource.SetLabelsDiff,
@@ -2950,6 +2952,52 @@ func suppressEmptyGuestAcceleratorDiff(_ context.Context, d *schema.ResourceDiff
 	return nil
 }
 
+// Function checks whether a graceful switch (without ForceNew) is available
+// between `metadata_startup_script` and `metadata.startup-script`.
+// Graceful switch can be executed in two situations:
+// 1. When `metadata_startup_script` is created with the old value of
+// `metadata.startup-script`.
+// 2. When `metadata_startup_script` is deleted and the old value remains in
+// `metadata.startup-script`
+// For all other changes in `metadata_startup_script`, function sets ForceNew.
+func isGracefulMetadataStartupSwitch(d *schema.ResourceDiff) bool {
+	oldMd, newMd := d.GetChange("metadata")
+	oldMdMap := oldMd.(map[string]interface{})
+	newMdMap := newMd.(map[string]interface{})
+
+	//No new and old metadata
+	if len(oldMdMap) == 0 && len(newMdMap) == 0 {
+		return true
+	}
+
+	oldMds, newMds := d.GetChange("metadata_startup_script")
+	vMdOld, okOld := oldMdMap["startup-script"]
+	vMdNew, okNew := newMdMap["startup-script"]
+
+	// metadata_startup_script is created
+	if oldMds == "" {
+		if !okOld {
+			return true
+		} else if newMds == vMdOld {
+			return false
+		} else {
+			return true
+		}
+	}
+	// metadata_startup_script is deleted
+	if newMds == "" {
+		if !okNew {
+			return true
+		} else if oldMds == vMdNew {
+			return false
+		} else {
+			return true
+		}
+	}
+
+	return true
+}
+
 func resourceComputeInstanceDelete(d *schema.ResourceData, meta interface{}) error {
 	config := meta.(*transport_tpg.Config)
 	userAgent, err := tpgresource.GenerateUserAgentString(d, config.UserAgent)

google-beta/services/compute/resource_compute_instance_test.go

@@ -3518,6 +3518,43 @@ func TestAccComputeInstance_metadataStartupScript_update(t *testing.T) {
 	})
 }
 
+func TestAccComputeInstance_metadataStartupScript_gracefulSwitch(t *testing.T) {
+	t.Parallel()
+
+	var instance compute.Instance
+	var instanceName = fmt.Sprintf("tf-test-%s", acctest.RandString(t, 10))
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		CheckDestroy:             testAccCheckComputeInstanceDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccComputeInstance_metadataStartupScript(instanceName, "e2-medium", "abc"),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckComputeInstanceExists(
+						t, "google_compute_instance.foobar", &instance),
+					testAccCheckComputeInstanceMetadata(
+						&instance, "foo", "abc"),
+					testAccCheckComputeInstanceMetadata(
+						&instance, "startup-script", "echo hi > /test.txt"),
+				),
+			},
+			{
+				Config: testAccComputeInstance_metadataStartupScript_gracefulSwitch(instanceName, "e2-medium", "abc"),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckComputeInstanceExists(
+						t, "google_compute_instance.foobar", &instance),
+					testAccCheckComputeInstanceMetadata(
+						&instance, "foo", "abc"),
+					testAccCheckComputeInstanceMetadata(
+						&instance, "startup-script", "echo hi > /test.txt"),
+				),
+			},
+		},
+	})
+}
+
 func TestAccComputeInstance_regionBootDisk(t *testing.T) {
 	t.Parallel()
 
@@ -9933,6 +9970,40 @@ resource "google_compute_instance" "foobar" {
 `, instance, machineType, metadata)
 }
 
+func testAccComputeInstance_metadataStartupScript_gracefulSwitch(instance, machineType, metadata string) string {
+	return fmt.Sprintf(`
+data "google_compute_image" "my_image" {
+  family  = "debian-11"
+  project = "debian-cloud"
+}
+
+resource "google_compute_instance" "foobar" {
+  name           = "%s"
+  machine_type   = "%s"
+  zone           = "us-central1-a"
+  can_ip_forward = false
+  tags           = ["foo", "bar"]
+
+  boot_disk {
+    initialize_params {
+      image = data.google_compute_image.my_image.self_link
+    }
+  }
+
+  network_interface {
+    network = "default"
+  }
+
+  metadata = {
+    foo = "%s"
+	startup-script = "echo hi > /test.txt"
+  }
+
+  allow_stopping_for_update = true
+}
+`, instance, machineType, metadata)
+}
+
 func testAccComputeInstance_regionBootDisk(instance, diskName, suffix string) string {
 	return fmt.Sprintf(`
 resource "google_compute_instance" "regional_vm_instance" {