Make google_notebooks_instance metadata field updatable (#7945) (#14650)

* Added update tests proving that metadata is not updatable

* Test fixes

* Made notebooks instance metadata field updatable

* Added metadata to ImportStateVerifyIgnore for impacted tests

* Removed non-updatable fields from update test

* Temporarily made metadata field not updatable to prove that only these changes are required to make the tests pass

* Revert "Temporarily made metadata field not updatable to prove that only these changes are required to make the tests pass"

This reverts commit f22a9e4cd29c3e0d35c1888aca5280a1bef6c22b.

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

Author: modular-magician

.changelog/7945.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+notebooks: added update-in-place support for `google_notebooks_instance.metadata` field
+```

google/resource_notebooks_instance.go

@@ -220,7 +220,6 @@ An object containing a list of "key": value pairs. Example: { "name": "wrench",
 			"metadata": {
 				Type:     schema.TypeMap,
 				Optional: true,
-				ForceNew: true,
 				Description: `Custom metadata to apply to this instance.
 An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.`,
 				Elem: &schema.Schema{Type: schema.TypeString},
@@ -820,6 +819,11 @@ func resourceNotebooksInstanceUpdate(d *schema.ResourceData, meta interface{}) e
 			obj["labels"] = labelsProp
 		}
 
+		obj, err = resourceNotebooksInstanceUpdateEncoder(d, meta, obj)
+		if err != nil {
+			return err
+		}
+
 		url, err := tpgresource.ReplaceVars(d, config, "{{NotebooksBasePath}}projects/{{project}}/locations/{{location}}/instances/{{name}}:setLabels")
 		if err != nil {
 			return err
@@ -852,6 +856,53 @@ func resourceNotebooksInstanceUpdate(d *schema.ResourceData, meta interface{}) e
 			return err
 		}
 	}
+	if d.HasChange("metadata") {
+		obj := make(map[string]interface{})
+
+		metadataProp, err := expandNotebooksInstanceMetadata(d.Get("metadata"), d, config)
+		if err != nil {
+			return err
+		} else if v, ok := d.GetOkExists("metadata"); !tpgresource.IsEmptyValue(reflect.ValueOf(v)) && (ok || !reflect.DeepEqual(v, metadataProp)) {
+			obj["metadata"] = metadataProp
+		}
+
+		obj, err = resourceNotebooksInstanceUpdateEncoder(d, meta, obj)
+		if err != nil {
+			return err
+		}
+
+		url, err := tpgresource.ReplaceVars(d, config, "{{NotebooksBasePath}}projects/{{project}}/locations/{{location}}/instances/{{name}}:updateMetadataItems")
+		if err != nil {
+			return err
+		}
+
+		// err == nil indicates that the billing_project value was found
+		if bp, err := tpgresource.GetBillingProject(d, config); err == nil {
+			billingProject = bp
+		}
+
+		res, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+			Config:    config,
+			Method:    "PATCH",
+			Project:   billingProject,
+			RawURL:    url,
+			UserAgent: userAgent,
+			Body:      obj,
+			Timeout:   d.Timeout(schema.TimeoutUpdate),
+		})
+		if err != nil {
+			return fmt.Errorf("Error updating Instance %q: %s", d.Id(), err)
+		} else {
+			log.Printf("[DEBUG] Finished updating Instance %q: %#v", d.Id(), res)
+		}
+
+		err = NotebooksOperationWaitTime(
+			config, res, project, "Updating Instance", userAgent,
+			d.Timeout(schema.TimeoutUpdate))
+		if err != nil {
+			return err
+		}
+	}
 
 	d.Partial(false)
 
@@ -1408,3 +1459,13 @@ func expandNotebooksInstanceContainerImageRepository(v interface{}, d tpgresourc
 func expandNotebooksInstanceContainerImageTag(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
 	return v, nil
 }
+
+func resourceNotebooksInstanceUpdateEncoder(d *schema.ResourceData, meta interface{}, obj map[string]interface{}) (map[string]interface{}, error) {
+	// Update requests use "items" as the api name instead of "metadata"
+	// https://cloud.google.com/vertex-ai/docs/workbench/reference/rest/v1/projects.locations.instances/updateMetadataItems
+	if metadata, ok := obj["metadata"]; ok {
+		obj["items"] = metadata
+		delete(obj, "metadata")
+	}
+	return obj, nil
+}

google/resource_notebooks_instance_test.go

@@ -1 +1,151 @@
 package google
+
+import (
+	"fmt"
+	"strconv"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+)
+
+func TestAccNotebooksInstance_create_vm_image(t *testing.T) {
+	t.Parallel()
+
+	prefix := fmt.Sprintf("%d", RandInt(t))
+	name := fmt.Sprintf("tf-%s", prefix)
+
+	VcrTest(t, resource.TestCase{
+		ProtoV5ProviderFactories: ProtoV5ProviderFactories(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccNotebooksInstance_create_vm_image(name),
+			},
+			{
+				ResourceName:            "google_notebooks_instance.test",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"vm_image", "metadata"},
+			},
+		},
+	})
+}
+
+func TestAccNotebooksInstance_update(t *testing.T) {
+	context := map[string]interface{}{
+		"random_suffix": RandString(t, 10),
+	}
+
+	VcrTest(t, resource.TestCase{
+		ProtoV5ProviderFactories: ProtoV5ProviderFactories(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccNotebooksInstance_basic(context),
+			},
+			{
+				ResourceName:            "google_notebooks_instance.instance",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"vm_image", "metadata"},
+			},
+			{
+				Config: testAccNotebooksInstance_update(context, true),
+			},
+			{
+				ResourceName:            "google_notebooks_instance.instance",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"vm_image", "metadata"},
+			},
+			{
+				Config: testAccNotebooksInstance_update(context, false),
+			},
+			{
+				ResourceName:            "google_notebooks_instance.instance",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"vm_image", "metadata"},
+			},
+		},
+	})
+}
+
+func testAccNotebooksInstance_create_vm_image(name string) string {
+	return fmt.Sprintf(`
+
+resource "google_notebooks_instance" "test" {
+  name = "%s"
+  location = "us-west1-a"
+  machine_type = "e2-medium"
+  metadata = {
+    proxy-mode = "service_account"
+    terraform  = "true"
+  }
+
+  nic_type = "VIRTIO_NET"
+
+  reservation_affinity {
+    consume_reservation_type = "NO_RESERVATION"
+  }
+
+  vm_image {
+    project      = "deeplearning-platform-release"
+    image_family = "tf-latest-cpu"
+  }
+}
+`, name)
+}
+
+func testAccNotebooksInstance_basic(context map[string]interface{}) string {
+	return Nprintf(`
+resource "google_notebooks_instance" "instance" {
+  name = "tf-test-notebooks-instance%{random_suffix}"
+  location = "us-central1-a"
+  machine_type = "e2-medium"
+
+  vm_image {
+    project      = "deeplearning-platform-release"
+    image_family = "tf-latest-cpu"
+  }
+
+  metadata = {
+    proxy-mode = "service_account"
+    terraform  = "true"
+  }
+
+  lifecycle {
+  	prevent_destroy = true
+  }
+}
+`, context)
+}
+
+func testAccNotebooksInstance_update(context map[string]interface{}, preventDestroy bool) string {
+	context["prevent_destroy"] = strconv.FormatBool(preventDestroy)
+
+	return Nprintf(`
+resource "google_notebooks_instance" "instance" {
+  name = "tf-test-notebooks-instance%{random_suffix}"
+  location = "us-central1-a"
+  machine_type = "e2-medium"
+
+  vm_image {
+    project      = "deeplearning-platform-release"
+    image_family = "tf-latest-cpu"
+  }
+
+  metadata = {
+    proxy-mode = "service_account"
+    terraform  = "true"
+    notebook-upgrade-schedule = "0 * * * *"
+  }
+
+  labels = {
+    key = "value"
+  }
+
+  lifecycle {
+  	prevent_destroy = %{prevent_destroy}
+  }
+}
+`, context)
+}