Allow setting serial-port-logging-enable in google_workbench_instance metadata (#14243) (#10253)

[upstream:1922be09ce7cae0f115ba9d229a2765f19b5ced3]

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

Author: modular-magician

.changelog/14243.txt

@@ -0,0 +1,3 @@
+```release-note:bug
+google_workbench_instance: serial-port-logging-enable` metadata key is now settable.
+```

google-beta/services/workbench/resource_workbench_instance.go

@@ -20,6 +20,7 @@
 package workbench
 
 import (
+	"context"
 	"fmt"
 	"log"
 	"net/http"
@@ -61,6 +62,10 @@ func WorkbenchInstanceLabelsDiffSuppress(k, old, new string, d *schema.ResourceD
 	return false
 }
 
+var WorkbenchInstanceSettableUnmodifiableDefaultMetadata = []string{
+	"serial-port-logging-enable",
+}
+
 var WorkbenchInstanceProvidedMetadata = []string{
 	"agent-health-check-interval-seconds",
 	"agent-health-check-path",
@@ -107,7 +112,6 @@ var WorkbenchInstanceProvidedMetadata = []string{
 	"report-system-status",
 	"resource-url",
 	"restriction",
-	"serial-port-logging-enable",
 	"service-account-mode",
 	"shutdown-script",
 	"title",
@@ -132,6 +136,12 @@ func WorkbenchInstanceMetadataDiffSuppress(k, old, new string, d *schema.Resourc
 		}
 	}
 
+	for _, metadata := range WorkbenchInstanceSettableUnmodifiableDefaultMetadata {
+		if strings.Contains(k, metadata) && new == "" {
+			return true
+		}
+	}
+
 	// Let diff be determined by metadata
 	if strings.Contains(k, "gce_setup.0.metadata.%") {
 		return true
@@ -299,6 +309,34 @@ func mergeMaps(oldMap, newMap map[string]interface{}) map[string]string {
 	return modifiedMap
 }
 
+func workbenchMetadataCustomizeDiff(_ context.Context, diff *schema.ResourceDiff, meta interface{}) error {
+	if diff.HasChange("gce_setup.0.metadata") {
+		o, n := diff.GetChange("gce_setup.0.metadata")
+		oldMetadata := o.(map[string]interface{})
+		newMetadata := n.(map[string]interface{})
+
+		for _, key := range WorkbenchInstanceSettableUnmodifiableDefaultMetadata {
+			oldValue, oldOk := oldMetadata[key]
+			newValue, newOk := newMetadata[key]
+
+			// Condition to force new:
+			// 1. The key exists in both old and new metadata AND their values differ.
+			// 2. The key exists in new but not in old (meaning it was added).
+			//
+			// The key exists in old but not in new (meaning it was removed) is ignored.
+			if (oldOk && newOk && oldValue != newValue) ||
+				(!oldOk && newOk) {
+				// If a change is detected for this specific key, force a new resource and stop checking.
+				if err := diff.ForceNew("gce_setup.0.metadata"); err != nil {
+					return err
+				}
+				return nil // Return nil immediately after forcing new
+			}
+		}
+	}
+	return nil
+}
+
 func ResourceWorkbenchInstance() *schema.Resource {
 	return &schema.Resource{
 		Create: resourceWorkbenchInstanceCreate,
@@ -317,6 +355,7 @@ func ResourceWorkbenchInstance() *schema.Resource {
 		},
 
 		CustomizeDiff: customdiff.All(
+			workbenchMetadataCustomizeDiff,
 			tpgresource.SetLabelsDiff,
 			tpgresource.DefaultProviderProject,
 		),

google-beta/services/workbench/resource_workbench_instance_generated_test.go

@@ -313,7 +313,8 @@ resource "google_workbench_instance" "instance" {
     }
 
     metadata = {
-      terraform = "true"
+      terraform = "true",
+      serial-port-logging-enable = "false"
     }
 
     enable_ip_forwarding = true

google-beta/services/workbench/resource_workbench_instance_test.go

@@ -103,7 +103,8 @@ resource "google_workbench_instance" "instance" {
 	  }
 
     metadata = {
-      terraform = "true"
+      terraform = "true",
+	  "serial-port-logging-enable" = "false",
     }
 
   }
@@ -368,6 +369,19 @@ func TestAccWorkbenchInstance_updateMetadataKey(t *testing.T) {
 				ImportStateVerify:       true,
 				ImportStateVerifyIgnore: []string{"name", "instance_owners", "location", "instance_id", "request_id", "labels", "terraform_labels", "desired_state", "update_time", "health_info", "health_state"},
 			},
+			{
+				Config: testAccWorkbenchInstance_update(context),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr(
+						"google_workbench_instance.instance", "state", "ACTIVE"),
+				),
+			},
+			{
+				ResourceName:            "google_workbench_instance.instance",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"name", "instance_owners", "location", "instance_id", "request_id", "labels", "terraform_labels", "desired_state", "update_time", "health_info", "health_state"},
+			},
 			{
 				Config: testAccWorkbenchInstance_updateMetadata(context),
 				Check: resource.ComposeTestCheckFunc(
@@ -395,6 +409,7 @@ resource "google_workbench_instance" "instance" {
     metadata = {
       terraform = "true"
       "resource-url" = "new-fake-value",
+      "serial-port-logging-enable" = "true",
     }
   }
 
@@ -417,7 +432,7 @@ resource "google_workbench_instance" "instance" {
       terraform = "true",
       "idle-timeout-seconds" = "10800",
       "image-url" = "fake-value",
-	  "container-custom-params" = "test-params",
+      "container-custom-params" = "test-params",
     }
   }
 

website/docs/r/workbench_instance.html.markdown

@@ -200,7 +200,8 @@ resource "google_workbench_instance" "instance" {
     }
 
     metadata = {
-      terraform = "true"
+      terraform = "true",
+      serial-port-logging-enable = "false"
     }
 
     enable_ip_forwarding = true