Add tags field to Pubsub Topic and Subscription (#15174)

Author: lahuang4

mmv1/products/pubsub/Subscription.yaml

@@ -131,6 +131,13 @@ examples:
       topic_name: 'example-topic'
       subscription_name: 'example-subscription'
     tgc_skip_test: 'The dynamic block is in test configuration. The test takes time to fix.'
+  - name: 'pubsub_subscription_tags'
+    primary_resource_id: 'example'
+    vars:
+      topic_name: 'example-topic'
+      subscription_name: 'example-subscription'
+      tag_key: 'tag_key'
+      tag_value: 'tag_value'
 parameters:
 properties:
   - name: 'name'
@@ -583,3 +590,16 @@ properties:
           description: |
             Controls whether or not to use this transform. If not set or `false`,
             the transform will be applied to messages. Default: `true`.
+  - name: 'tags'
+    type: KeyValuePairs
+    description: |
+      Input only. Resource manager tags to be bound to the subscription. 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/456. The field is ignored when empty. The field is immutable and
+      causes resource replacement when mutated. This field is only set at create
+      time and modifying this field after creation will trigger recreation. To
+      apply tags to an existing resource, see the `google_tags_tag_value`
+      resource.
+    immutable: true
+    ignore_read: true

mmv1/products/pubsub/Topic.yaml

@@ -109,6 +109,12 @@ examples:
     vars:
       topic_name: 'example-topic'
     tgc_skip_test: 'The dynamic block is in test configuration. The test takes time to fix.'
+  - name: 'pubsub_topic_tags'
+    primary_resource_id: 'example'
+    vars:
+      topic_name: 'example-topic'
+      tag_key: 'tag_key'
+      tag_value: 'tag_value'
 parameters:
 properties:
   - name: 'name'
@@ -508,3 +514,16 @@ properties:
           description: |
             Controls whether or not to use this transform. If not set or `false`,
             the transform will be applied to messages. Default: `true`.
+  - name: 'tags'
+    type: KeyValuePairs
+    description: |
+      Input only. Resource manager tags to be bound to the topic. 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/456. The field is ignored when empty. The field is immutable and
+      causes resource replacement when mutated. This field is only set at create
+      time and modifying this field after creation will trigger recreation. To
+      apply tags to an existing resource, see the `google_tags_tag_value`
+      resource.
+    immutable: true
+    ignore_read: true

mmv1/templates/terraform/examples/pubsub_subscription_tags.tf.tmpl

@@ -0,0 +1,23 @@
+resource "google_pubsub_topic" "{{$.PrimaryResourceId}}" {
+  name = "{{index $.Vars "topic_name"}}"
+}
+
+resource "google_pubsub_subscription" "{{$.PrimaryResourceId}}" {
+  name  = "{{index $.Vars "subscription_name"}}"
+  topic = google_pubsub_topic.{{$.PrimaryResourceId}}.id
+  tags = {
+    (google_tags_tag_key.tag_key.namespaced_name) = google_tags_tag_value.tag_value.short_name
+  }
+}
+
+data "google_project" "project" {}
+
+resource "google_tags_tag_key" "tag_key" {
+  parent     = data.google_project.project.id
+  short_name = "{{index $.Vars "tag_key"}}"
+}
+
+resource "google_tags_tag_value" "tag_value" {
+  parent     = google_tags_tag_key.tag_key.id
+  short_name = "{{index $.Vars "tag_value"}}"
+}

mmv1/templates/terraform/examples/pubsub_topic_tags.tf.tmpl

@@ -0,0 +1,18 @@
+resource "google_pubsub_topic" "{{$.PrimaryResourceId}}" {
+  name = "{{index $.Vars "topic_name"}}"
+  tags = {
+    (google_tags_tag_key.tag_key.namespaced_name) = google_tags_tag_value.tag_value.short_name
+  }
+}
+
+data "google_project" "project" {}
+
+resource "google_tags_tag_key" "tag_key" {
+  parent     = data.google_project.project.id
+  short_name = "{{index $.Vars "tag_key"}}"
+}
+
+resource "google_tags_tag_value" "tag_value" {
+  parent     = google_tags_tag_key.tag_key.id
+  short_name = "{{index $.Vars "tag_value"}}"
+}

mmv1/third_party/terraform/services/pubsub/resource_pubsub_subscription_test.go

@@ -583,43 +583,64 @@ func TestAccPubsubSubscription_javascriptUdfUpdate(t *testing.T) {
 	})
 }
 
-func testAccPubsubSubscription_javascriptUdfSettings(topic, subscription, functionName, code string) string {
-	return fmt.Sprintf(`
-resource "google_pubsub_topic" "foo" {
-  name = "%s"
-}
+func TestGetComputedTopicName(t *testing.T) {
+	type testData struct {
+		project  string
+		topic    string
+		expected string
+	}
 
-resource "google_pubsub_subscription" "foo" {
-  name  = "%s"
-  topic = google_pubsub_topic.foo.id
-  message_transforms {
-    disabled = true
-    javascript_udf {
-      function_name = "%s"
-      code = "%s"
-    }
-  }
-}
-`, topic, subscription, functionName, code)
-}
+	var testCases = []testData{
+		{
+			project:  "my-project",
+			topic:    "my-topic",
+			expected: "projects/my-project/topics/my-topic",
+		},
+		{
+			project:  "my-project",
+			topic:    "projects/another-project/topics/my-topic",
+			expected: "projects/another-project/topics/my-topic",
+		},
+	}
 
-func testAccPubsubSubscription_javascriptUdfSettings_noEnabled(topic, subscription, functionName, code string) string {
-	return fmt.Sprintf(`
-resource "google_pubsub_topic" "foo" {
-  name = "%s"
+	for _, testCase := range testCases {
+		computedTopicName := pubsub.GetComputedTopicName(testCase.project, testCase.topic)
+		if computedTopicName != testCase.expected {
+			t.Fatalf("bad computed topic name: %s' => expected %s", computedTopicName, testCase.expected)
+		}
+	}
 }
 
-resource "google_pubsub_subscription" "foo" {
-  name  = "%s"
-  topic = google_pubsub_topic.foo.id
-	message_transforms {
-    javascript_udf {
-      function_name = "%s"
-      code = "%s"
-    }
-  }
-}
-`, topic, subscription, functionName, code)
+func TestAccPubsubSubscription_tags(t *testing.T) {
+	t.Parallel()
+
+	subscription := fmt.Sprintf("tf-test-sub-%s", acctest.RandString(t, 10))
+	tagKey := acctest.BootstrapSharedTestOrganizationTagKey(t, "pubsub-subscription-tagkey", nil)
+	context := map[string]interface{}{
+		"topic":        fmt.Sprintf("tf-test-topic-%s", acctest.RandString(t, 10)),
+		"subscription": subscription,
+		"org":          envvar.GetTestOrgFromEnv(t),
+		"tagKey":       tagKey,
+		"tagValue":     acctest.BootstrapSharedTestOrganizationTagValue(t, "pubsub-subscription-tagvalue", tagKey),
+	}
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		CheckDestroy:             testAccCheckPubsubSubscriptionDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccPubsubSubscription_tags(context),
+			},
+			{
+				ResourceName:            "google_pubsub_subscription.foo",
+				ImportStateId:           subscription,
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"tags"},
+			},
+		},
+	})
 }
 
 func testAccPubsubSubscription_emptyTTL(topic, subscription string) string {
@@ -1000,34 +1021,6 @@ resource "google_pubsub_subscription" "foo" {
 `, topic, subscription)
 }
 
-func TestGetComputedTopicName(t *testing.T) {
-	type testData struct {
-		project  string
-		topic    string
-		expected string
-	}
-
-	var testCases = []testData{
-		{
-			project:  "my-project",
-			topic:    "my-topic",
-			expected: "projects/my-project/topics/my-topic",
-		},
-		{
-			project:  "my-project",
-			topic:    "projects/another-project/topics/my-topic",
-			expected: "projects/another-project/topics/my-topic",
-		},
-	}
-
-	for _, testCase := range testCases {
-		computedTopicName := pubsub.GetComputedTopicName(testCase.project, testCase.topic)
-		if computedTopicName != testCase.expected {
-			t.Fatalf("bad computed topic name: %s' => expected %s", computedTopicName, testCase.expected)
-		}
-	}
-}
-
 func testAccCheckPubsubSubscriptionCache404(t *testing.T, subName string) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		config := acctest.GoogleProviderConfig(t)
@@ -1061,3 +1054,59 @@ resource "google_pubsub_subscription" "foo" {
 }
 `, topic, subscription, filter)
 }
+
+func testAccPubsubSubscription_javascriptUdfSettings(topic, subscription, functionName, code string) string {
+	return fmt.Sprintf(`
+resource "google_pubsub_topic" "foo" {
+  name = "%s"
+}
+
+resource "google_pubsub_subscription" "foo" {
+  name  = "%s"
+  topic = google_pubsub_topic.foo.id
+  message_transforms {
+    disabled = true
+    javascript_udf {
+      function_name = "%s"
+      code = "%s"
+    }
+  }
+}
+`, topic, subscription, functionName, code)
+}
+
+func testAccPubsubSubscription_javascriptUdfSettings_noEnabled(topic, subscription, functionName, code string) string {
+	return fmt.Sprintf(`
+resource "google_pubsub_topic" "foo" {
+  name = "%s"
+}
+
+resource "google_pubsub_subscription" "foo" {
+  name  = "%s"
+  topic = google_pubsub_topic.foo.id
+	message_transforms {
+    javascript_udf {
+      function_name = "%s"
+      code = "%s"
+    }
+  }
+}
+`, topic, subscription, functionName, code)
+}
+
+func testAccPubsubSubscription_tags(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_pubsub_topic" "foo" {
+  name = "%{topic}"
+}
+
+resource "google_pubsub_subscription" "foo" {
+  name  = "%{subscription}"
+  topic = google_pubsub_topic.foo.id
+
+  tags = {
+    "%{org}/%{tagKey}" = "%{tagValue}"
+  }
+}
+`, context)
+}