Support for Tags in google_dataproc_metastore_service resource (#14620) (#10854)

[upstream:707ee8f775d48f6b7750044d61a605ec50ca7520]

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

Author: modular-magician

.changelog/14620.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+metastore: added `tags` field to `google_dataproc_metastore_service` and 'google_dataproc_metastore_federation' resources to allow setting tags for services and federation at creation time
+```

google-beta/services/dataprocmetastore/resource_dataproc_metastore_federation.go

@@ -111,6 +111,15 @@ Please refer to the field 'effective_labels' for all of the labels present on th
 				ForceNew:    true,
 				Description: `The location where the metastore federation should reside.`,
 			},
+			"tags": {
+				Type:     schema.TypeMap,
+				Optional: true,
+				ForceNew: true,
+				Description: `A map of resource manager tags.
+Resource manager tag keys and values have the same definition as resource manager tags.
+Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/{tag_value_id}.`,
+				Elem: &schema.Schema{Type: schema.TypeString},
+			},
 			"create_time": {
 				Type:        schema.TypeString,
 				Computed:    true,
@@ -198,6 +207,12 @@ func resourceDataprocMetastoreFederationCreate(d *schema.ResourceData, meta inte
 	} else if v, ok := d.GetOkExists("backend_metastores"); !tpgresource.IsEmptyValue(reflect.ValueOf(backendMetastoresProp)) && (ok || !reflect.DeepEqual(v, backendMetastoresProp)) {
 		obj["backendMetastores"] = backendMetastoresProp
 	}
+	tagsProp, err := expandDataprocMetastoreFederationTags(d.Get("tags"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("tags"); !tpgresource.IsEmptyValue(reflect.ValueOf(tagsProp)) && (ok || !reflect.DeepEqual(v, tagsProp)) {
+		obj["tags"] = tagsProp
+	}
 	effectiveLabelsProp, err := expandDataprocMetastoreFederationEffectiveLabels(d.Get("effective_labels"), d, config)
 	if err != nil {
 		return err
@@ -655,6 +670,17 @@ func expandDataprocMetastoreFederationBackendMetastoresMetastoreType(v interface
 	return v, nil
 }
 
+func expandDataprocMetastoreFederationTags(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (map[string]string, error) {
+	if v == nil {
+		return map[string]string{}, nil
+	}
+	m := make(map[string]string)
+	for k, val := range v.(map[string]interface{}) {
+		m[k] = val.(string)
+	}
+	return m, nil
+}
+
 func expandDataprocMetastoreFederationEffectiveLabels(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (map[string]string, error) {
 	if v == nil {
 		return map[string]string{}, nil

google-beta/services/dataprocmetastore/resource_dataproc_metastore_federation_generated_meta.yaml

@@ -21,6 +21,7 @@ fields:
   - field: 'name'
   - field: 'state'
   - field: 'state_message'
+  - field: 'tags'
   - field: 'terraform_labels'
     provider_only: true
   - field: 'uid'

google-beta/services/dataprocmetastore/resource_dataproc_metastore_federation_generated_test.go

@@ -49,7 +49,7 @@ func TestAccDataprocMetastoreFederation_dataprocMetastoreFederationBasicExample(
 				ResourceName:            "google_dataproc_metastore_federation.default",
 				ImportState:             true,
 				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"deletion_protection", "federation_id", "labels", "location", "terraform_labels"},
+				ImportStateVerifyIgnore: []string{"deletion_protection", "federation_id", "labels", "location", "tags", "terraform_labels"},
 			},
 		},
 	})
@@ -103,7 +103,7 @@ func TestAccDataprocMetastoreFederation_dataprocMetastoreFederationBigqueryExamp
 				ResourceName:            "google_dataproc_metastore_federation.default",
 				ImportState:             true,
 				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"federation_id", "labels", "location", "terraform_labels"},
+				ImportStateVerifyIgnore: []string{"federation_id", "labels", "location", "tags", "terraform_labels"},
 			},
 		},
 	})

google-beta/services/dataprocmetastore/resource_dataproc_metastore_federation_test.go

@@ -20,11 +20,16 @@ package dataprocmetastore_test
 
 import (
 	"fmt"
-	"github.com/hashicorp/terraform-provider-google-beta/google-beta/acctest"
+	"net/url"
 	"regexp"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+	"github.com/hashicorp/terraform-plugin-testing/terraform"
+	"github.com/hashicorp/terraform-provider-google-beta/google-beta/acctest"
+	"github.com/hashicorp/terraform-provider-google-beta/google-beta/envvar"
+	transport_tpg "github.com/hashicorp/terraform-provider-google-beta/google-beta/transport"
+	"strings"
 )
 
 func TestAccMetastoreFederation_deletionprotection(t *testing.T) {
@@ -62,6 +67,37 @@ func TestAccMetastoreFederation_deletionprotection(t *testing.T) {
 	})
 }
 
+func TestAccMetastoreFederation_tags(t *testing.T) {
+	t.Parallel()
+	tagKey := acctest.BootstrapSharedTestOrganizationTagKey(t, "metastore-fed-tagkey", map[string]interface{}{})
+	context := map[string]interface{}{
+		"random_suffix": acctest.RandString(t, 10),
+		"org":           envvar.GetTestOrgFromEnv(t),
+		"tagKey":        tagKey,
+		"tagValue":      acctest.BootstrapSharedTestOrganizationTagValue(t, "metastore-fed-tagvalue", tagKey),
+	}
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		CheckDestroy:             testAccCheckDataprocMetastoreFederationDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccMetastoreFederationTags(context),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrSet("google_dataproc_metastore_federation.default", "tags.%"),
+					testAccCheckMetastoreFederationHasTagBindings(t),
+				),
+			},
+			{
+				ResourceName:            "google_dataproc_metastore_federation.default",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"federation_id", "location", "tags"},
+			},
+		},
+	})
+}
+
 func testAccMetastoreFederationDeletionProtection(name string, location string) string {
 
 	return fmt.Sprintf(`
@@ -113,3 +149,136 @@ func testAccMetastoreFederationDeletionProtectionFalse(name string, location str
 }
 `, name, name, location)
 }
+
+func testAccCheckMetastoreFederationHasTagBindings(t *testing.T) func(s *terraform.State) error {
+	return func(s *terraform.State) error {
+		for name, rs := range s.RootModule().Resources {
+			if rs.Type != "google_dataproc_metastore_federation" {
+				continue
+			}
+			if strings.HasPrefix(name, "data.") {
+				continue
+			}
+
+			config := acctest.GoogleProviderConfig(t)
+
+			var configuredTagValueNamespacedName string
+			var tagKeyNamespacedName, tagValueShortName string
+			for key, val := range rs.Primary.Attributes {
+				if strings.HasPrefix(key, "tags.") && key != "tags.%" {
+					tagKeyNamespacedName = strings.TrimPrefix(key, "tags.")
+					tagValueShortName = val
+					if tagValueShortName != "" {
+						configuredTagValueNamespacedName = fmt.Sprintf("%s/%s", tagKeyNamespacedName, tagValueShortName)
+						break
+					}
+				}
+			}
+
+			if configuredTagValueNamespacedName == "" {
+				return fmt.Errorf("could not find a configured tag value in the state for resource %s", rs.Primary.ID)
+			}
+
+			if strings.Contains(configuredTagValueNamespacedName, "%{") {
+				return fmt.Errorf("tag namespaced name contains unsubstituted variables: %q. Ensure the context map in the test step is populated", configuredTagValueNamespacedName)
+			}
+
+			safeNamespacedName := url.QueryEscape(configuredTagValueNamespacedName)
+			describeTagValueURL := fmt.Sprintf("https://cloudresourcemanager.googleapis.com/v3/tagValues/namespaced?name=%s", safeNamespacedName)
+
+			respDescribe, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+				Config:    config,
+				Method:    "GET",
+				RawURL:    describeTagValueURL,
+				UserAgent: config.UserAgent,
+			})
+
+			if err != nil {
+				return fmt.Errorf("error describing tag value using namespaced name %q: %v", configuredTagValueNamespacedName, err)
+			}
+
+			fullTagValueName, ok := respDescribe["name"].(string)
+			if !ok || fullTagValueName == "" {
+				return fmt.Errorf("tag value details (name) not found in response for namespaced name: %q, response: %v", configuredTagValueNamespacedName, respDescribe)
+			}
+
+			parts := strings.Split(rs.Primary.ID, "/")
+			if len(parts) != 6 {
+				return fmt.Errorf("invalid resource ID format: %s", rs.Primary.ID)
+			}
+			project := parts[1]
+			location := parts[3]
+			federation_id := parts[5]
+
+			parentURL := fmt.Sprintf("//metastore.googleapis.com/projects/%s/locations/%s/federations/%s", project, location, federation_id)
+			listBindingsURL := fmt.Sprintf("https://%s-cloudresourcemanager.googleapis.com/v3/tagBindings?parent=%s", location, url.QueryEscape(parentURL))
+
+			resp, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+				Config:    config,
+				Method:    "GET",
+				RawURL:    listBindingsURL,
+				UserAgent: config.UserAgent,
+			})
+
+			if err != nil {
+				return fmt.Errorf("error calling TagBindings API: %v", err)
+			}
+
+			tagBindingsVal, exists := resp["tagBindings"]
+			if !exists {
+				tagBindingsVal = []interface{}{}
+			}
+
+			tagBindings, ok := tagBindingsVal.([]interface{})
+			if !ok {
+				return fmt.Errorf("'tagBindings' is not a slice in response for resource %s. Response: %v", rs.Primary.ID, resp)
+			}
+
+			foundMatch := false
+			for _, binding := range tagBindings {
+				bindingMap, ok := binding.(map[string]interface{})
+				if !ok {
+					continue
+				}
+				if bindingMap["tagValue"] == fullTagValueName {
+					foundMatch = true
+					break
+				}
+			}
+
+			if !foundMatch {
+				return fmt.Errorf("expected tag value %s (from namespaced %q) not found in tag bindings for resource %s. Bindings: %v", fullTagValueName, configuredTagValueNamespacedName, rs.Primary.ID, tagBindings)
+			}
+
+			t.Logf("Successfully found matching tag binding for %s with tagValue %s", rs.Primary.ID, fullTagValueName)
+		}
+
+		return nil
+	}
+}
+
+func testAccMetastoreFederationTags(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_dataproc_metastore_service" "backend" {
+	  service_id = "tf-test-service-%{random_suffix}"
+	  location   = "us-east1"
+	  tier       = "DEVELOPER"
+	  hive_metastore_config {
+				version           = "3.1.2"
+				endpoint_protocol = "GRPC"
+			}
+	}
+	resource "google_dataproc_metastore_federation" "default" {
+	  federation_id = "tf-test-federation-%{random_suffix}"
+	  location      = "us-east1"
+	  version       = "3.1.2"
+	  backend_metastores {
+	    name = google_dataproc_metastore_service.backend.id
+	    metastore_type = "DATAPROC_METASTORE"
+	    rank = "1"
+	  }
+	  tags = {
+	    "%{org}/%{tagKey}" = "%{tagValue}"
+	  }
+}`, context)
+}

google-beta/services/dataprocmetastore/resource_dataproc_metastore_service.go

@@ -421,6 +421,15 @@ There must be at least one IP address available in the subnet's primary range. T
 					},
 				},
 			},
+			"tags": {
+				Type:     schema.TypeMap,
+				Optional: true,
+				ForceNew: true,
+				Description: `A map of resource manager tags.
+Resource manager tag keys and values have the same definition as resource manager tags.
+Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/{tag_value_id}.`,
+				Elem: &schema.Schema{Type: schema.TypeString},
+			},
 			"telemetry_config": {
 				Type:        schema.TypeList,
 				Computed:    true,
@@ -603,6 +612,12 @@ func resourceDataprocMetastoreServiceCreate(d *schema.ResourceData, meta interfa
 	} else if v, ok := d.GetOkExists("telemetry_config"); !tpgresource.IsEmptyValue(reflect.ValueOf(telemetryConfigProp)) && (ok || !reflect.DeepEqual(v, telemetryConfigProp)) {
 		obj["telemetryConfig"] = telemetryConfigProp
 	}
+	tagsProp, err := expandDataprocMetastoreServiceTags(d.Get("tags"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("tags"); !tpgresource.IsEmptyValue(reflect.ValueOf(tagsProp)) && (ok || !reflect.DeepEqual(v, tagsProp)) {
+		obj["tags"] = tagsProp
+	}
 	effectiveLabelsProp, err := expandDataprocMetastoreServiceEffectiveLabels(d.Get("effective_labels"), d, config)
 	if err != nil {
 		return err
@@ -2101,6 +2116,17 @@ func expandDataprocMetastoreServiceTelemetryConfigLogFormat(v interface{}, d tpg
 	return v, nil
 }
 
+func expandDataprocMetastoreServiceTags(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (map[string]string, error) {
+	if v == nil {
+		return map[string]string{}, nil
+	}
+	m := make(map[string]string)
+	for k, val := range v.(map[string]interface{}) {
+		m[k] = val.(string)
+	}
+	return m, nil
+}
+
 func expandDataprocMetastoreServiceEffectiveLabels(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (map[string]string, error) {
 	if v == nil {
 		return map[string]string{}, nil

google-beta/services/dataprocmetastore/resource_dataproc_metastore_service_generated_meta.yaml

@@ -48,6 +48,7 @@ fields:
     provider_only: true
   - field: 'state'
   - field: 'state_message'
+  - field: 'tags'
   - field: 'telemetry_config.log_format'
   - field: 'terraform_labels'
     provider_only: true