Make google_notebooks_instance metadata field updatable (#7945)

* 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 f22a9e4.

mmv1/products/notebooks/Instance.yaml

@@ -81,6 +81,7 @@ examples:
       service_account: :SERVICE_ACCT
 custom_code: !ruby/object:Provider::Terraform::CustomCode
   constants: templates/terraform/constants/notebooks_instance.go
+  update_encoder: templates/terraform/update_encoder/notebooks_instance.go
 parameters:
   - !ruby/object:Api::Type::ResourceRef
     name: 'location'
@@ -362,7 +363,11 @@ properties:
     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" }.
+    # This was added as part of https://github.com/GoogleCloudPlatform/magic-modules/pull/3761 to
+    # avoid detecting drift, since this field is partially server-managed.
     ignore_read: true
+    update_verb: :PATCH
+    update_url: 'projects/{{project}}/locations/{{location}}/instances/{{name}}:updateMetadataItems'
   - !ruby/object:Api::Type::Time
     name: 'createTime'
     description: 'Instance creation time'

mmv1/templates/terraform/update_encoder/notebooks_instance.go

@@ -0,0 +1,7 @@
+// 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

mmv1/third_party/terraform/tests/resource_notebooks_instance_test.go.erb

@@ -1,10 +1,9 @@
 <% autogen_exception -%>
 package google
 
-<% unless version == 'ga' %>
-
 import (
 	"fmt"
+	"strconv"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
@@ -47,25 +46,25 @@ func TestAccNotebooksInstance_update(t *testing.T) {
 				ResourceName:            "google_notebooks_instance.instance",
 				ImportState:             true,
 				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"vm_image"},
+				ImportStateVerifyIgnore: []string{"vm_image", "metadata"},
 			},
 			{
-				Config: testAccNotebooksInstance_update(context),
+				Config: testAccNotebooksInstance_update(context, true),
 			},
 			{
 				ResourceName:            "google_notebooks_instance.instance",
 				ImportState:             true,
 				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"vm_image"},
+				ImportStateVerifyIgnore: []string{"vm_image", "metadata"},
 			},
 			{
-				Config: testAccNotebooksInstance_basic(context),
+				Config: testAccNotebooksInstance_update(context, false),
 			},
 			{
 				ResourceName:            "google_notebooks_instance.instance",
 				ImportState:             true,
 				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"vm_image"},
+				ImportStateVerifyIgnore: []string{"vm_image", "metadata"},
 			},
 		},
 	})
@@ -108,34 +107,46 @@ resource "google_notebooks_instance" "instance" {
     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{}) string {
+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"
 
-  nic_type = "VIRTIO_NET"
-
-  reservation_affinity {
-    consume_reservation_type = "NO_RESERVATION"
-  }
-
   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)
 }
-
-
-<% end -%>