Add tags field to Project resource (#11440)

Author: abd-goog

mmv1/third_party/terraform/acctest/bootstrap_test_utils.go

@@ -1304,3 +1304,141 @@ func SetupProjectsAndGetAccessToken(org, billing, pid, service string, config *t
 
 	return accessToken, nil
 }
+
+const sharedTagKeyPrefix = "tf-bootstrap-tagkey"
+
+func BootstrapSharedTestTagKey(t *testing.T, testId string) string {
+	org := envvar.GetTestOrgFromEnv(t)
+	sharedTagKey := fmt.Sprintf("%s-%s", sharedTagKeyPrefix, testId)
+	tagKeyName := fmt.Sprintf("%s/%s", org, sharedTagKey)
+
+	config := BootstrapConfig(t)
+	if config == nil {
+		return ""
+	}
+
+	log.Printf("[DEBUG] Getting shared test tag key %q", sharedTagKey)
+	getURL := fmt.Sprintf("%stagKeys/namespaced?name=%s", config.TagsBasePath, tagKeyName)
+	_, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+		Config:    config,
+		Method:    "GET",
+		Project:   config.Project,
+		RawURL:    getURL,
+		UserAgent: config.UserAgent,
+		Timeout:   2 * time.Minute,
+	})
+	if err != nil && transport_tpg.IsGoogleApiErrorWithCode(err, 403) {
+		log.Printf("[DEBUG] TagKey %q not found, bootstrapping", sharedTagKey)
+		tagKeyObj := map[string]interface{}{
+			"parent":      "organizations/" + org,
+			"shortName":   sharedTagKey,
+			"description": "Bootstrapped tag key for Terraform Acceptance testing",
+		}
+
+		_, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+			Config:    config,
+			Method:    "POST",
+			Project:   config.Project,
+			RawURL:    config.TagsBasePath + "tagKeys/",
+			UserAgent: config.UserAgent,
+			Body:      tagKeyObj,
+			Timeout:   10 * time.Minute,
+		})
+		if err != nil {
+			t.Fatalf("Error bootstrapping shared tag key %q: %s", sharedTagKey, err)
+		}
+
+		log.Printf("[DEBUG] Waiting for shared tag key creation to finish")
+	}
+
+	_, err = transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+		Config:    config,
+		Method:    "GET",
+		Project:   config.Project,
+		RawURL:    getURL,
+		UserAgent: config.UserAgent,
+		Timeout:   2 * time.Minute,
+	})
+
+	if err != nil {
+		t.Fatalf("Error getting shared tag key %q: %s", sharedTagKey, err)
+	}
+
+	return sharedTagKey
+}
+
+const sharedTagValuePrefix = "tf-bootstrap-tagvalue"
+
+func BootstrapSharedTestTagValue(t *testing.T, testId string, tagKey string) string {
+	org := envvar.GetTestOrgFromEnv(t)
+	sharedTagValue := fmt.Sprintf("%s-%s", sharedTagValuePrefix, testId)
+	tagKeyName := fmt.Sprintf("%s/%s", org, tagKey)
+	tagValueName := fmt.Sprintf("%s/%s", tagKeyName, sharedTagValue)
+
+	config := BootstrapConfig(t)
+	if config == nil {
+		return ""
+	}
+
+	log.Printf("[DEBUG] Getting shared test tag value %q", sharedTagValue)
+	getURL := fmt.Sprintf("%stagValues/namespaced?name=%s", config.TagsBasePath, tagValueName)
+	_, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+		Config:    config,
+		Method:    "GET",
+		Project:   config.Project,
+		RawURL:    getURL,
+		UserAgent: config.UserAgent,
+		Timeout:   2 * time.Minute,
+	})
+	if err != nil && transport_tpg.IsGoogleApiErrorWithCode(err, 403) {
+		log.Printf("[DEBUG] TagValue %q not found, bootstrapping", sharedTagValue)
+		log.Printf("[DEBUG] Fetching permanent id for tagkey %s", tagKeyName)
+		tagKeyGetURL := fmt.Sprintf("%stagKeys/namespaced?name=%s", config.TagsBasePath, tagKeyName)
+		tagKeyResponse, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+			Config:    config,
+			Method:    "GET",
+			Project:   config.Project,
+			RawURL:    tagKeyGetURL,
+			UserAgent: config.UserAgent,
+			Timeout:   2 * time.Minute,
+		})
+		if err != nil {
+			t.Fatalf("Error getting tag key id for %s : %s", tagKeyName, err)
+		}
+		tagKeyObj := map[string]interface{}{
+			"parent":      tagKeyResponse["name"].(string),
+			"shortName":   sharedTagValue,
+			"description": "Bootstrapped tag value for Terraform Acceptance testing",
+		}
+
+		_, err = transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+			Config:    config,
+			Method:    "POST",
+			Project:   config.Project,
+			RawURL:    config.TagsBasePath + "tagValues/",
+			UserAgent: config.UserAgent,
+			Body:      tagKeyObj,
+			Timeout:   10 * time.Minute,
+		})
+		if err != nil {
+			t.Fatalf("Error bootstrapping shared tag value %q: %s", sharedTagValue, err)
+		}
+
+		log.Printf("[DEBUG] Waiting for shared tag value creation to finish")
+	}
+
+	_, err = transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+		Config:    config,
+		Method:    "GET",
+		Project:   config.Project,
+		RawURL:    getURL,
+		UserAgent: config.UserAgent,
+		Timeout:   2 * time.Minute,
+	})
+
+	if err != nil {
+		t.Fatalf("Error getting shared tag value %q: %s", sharedTagValue, err)
+	}
+
+	return sharedTagValue
+}

mmv1/third_party/terraform/services/resourcemanager/resource_google_project.go

@@ -133,6 +133,14 @@ func ResourceGoogleProject() *schema.Resource {
 				Description: `All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.`,
 				Elem:        &schema.Schema{Type: schema.TypeString},
 			},
+
+			"tags": {
+				Type:        schema.TypeMap,
+				Optional:    true,
+				ForceNew:    true,
+				Elem:        &schema.Schema{Type: schema.TypeString},
+				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/456. The field is ignored when empty.`,
+			},
 		},
 		UseJSONNumber: true,
 	}
@@ -166,6 +174,10 @@ func resourceGoogleProjectCreate(d *schema.ResourceData, meta interface{}) error
 		project.Labels = tpgresource.ExpandEffectiveLabels(d)
 	}
 
+	if _, ok := d.GetOk("tags"); ok {
+		project.Tags = tpgresource.ExpandStringMap(d, "tags")
+	}
+
 	var op *cloudresourcemanager.Operation
 	err = transport_tpg.Retry(transport_tpg.RetryOptions{
 		RetryFunc: func() (reqErr error) {

mmv1/third_party/terraform/services/resourcemanager/resource_google_project_test.go

@@ -234,6 +234,46 @@ func TestAccProject_migrateParent(t *testing.T) {
 	})
 }
 
+// Test that a Project resource can be created with tags
+func TestAccProject_tags(t *testing.T) {
+	t.Parallel()
+
+	org := envvar.GetTestOrgFromEnv(t)
+	pid := fmt.Sprintf("%s-%d", TestPrefix, acctest.RandInt(t))
+	tagKey := acctest.BootstrapSharedTestTagKey(t, "crm-projects-tagkey")
+	tagValue := acctest.BootstrapSharedTestTagValue(t, "crm-projects-tagvalue", tagKey)
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck: func() { acctest.AccTestPreCheck(t) },
+		ExternalProviders: map[string]resource.ExternalProvider{
+			"time": {},
+		},
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccProject_tags(pid, org, map[string]string{org + "/" + tagKey: tagValue}),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckGoogleProjectExists("google_project.acceptance", pid),
+				),
+			},
+			// Make sure import supports tags
+			{
+				ResourceName:            "google_project.acceptance",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"tags", "deletion_policy"}, // we don't read tags back
+			},
+			// Update tags tries to replace project but fails due to deletion policy
+			{
+				Config:      testAccProject_tags(pid, org, map[string]string{}),
+				ExpectError: regexp.MustCompile("deletion_policy"),
+			},
+			{
+				Config: testAccProject_tagsAllowDestroy(pid, org, map[string]string{org + "/" + tagKey: tagValue}),
+			},
+		},
+	})
+}
+
 func testAccCheckGoogleProjectExists(r, pid string) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		rs, ok := s.RootModule().Resources[r]
@@ -553,3 +593,35 @@ resource "google_folder" "folder1" {
 }
 `, pid, pid, org, folderName, org)
 }
+
+func testAccProject_tags(pid, org string, tags map[string]string) string {
+	r := fmt.Sprintf(`
+resource "google_project" "acceptance" {
+  project_id = "%s"
+  name       = "%s"
+  org_id     = "%s"
+  tags = {`, pid, pid, org)
+
+	l := ""
+	for key, value := range tags {
+		l += fmt.Sprintf("%q = %q\n", key, value)
+	}
+	l += fmt.Sprintf("}\n}")
+	return r + l
+}
+
+func testAccProject_tagsAllowDestroy(pid, org string, tags map[string]string) string {
+	r := fmt.Sprintf(`resource "google_project" "acceptance" {
+	 project_id = "%s"
+  name       = "%s"
+  org_id     = "%s"
+  deletion_policy = "DELETE"
+  tags = {`, pid, pid, org)
+	l := ""
+	for key, value := range tags {
+		l += fmt.Sprintf("%q = %q\n", key, value)
+	}
+
+	l += fmt.Sprintf("}\n}")
+	return r + l
+}

mmv1/third_party/terraform/website/docs/r/google_project.html.markdown

@@ -20,6 +20,8 @@ doc for more information.
 
 ~> It is recommended to use the `constraints/compute.skipDefaultNetworkCreation` [constraint](/docs/providers/google/r/google_organization_policy.html) to remove the default network instead of setting `auto_create_network` to false, when possible.
 
+~> It may take a while for the attached tag bindings to be deleted after the project is scheduled to be deleted. 
+
 To get more information about projects, see:
 
 * [API documentation](https://cloud.google.com/resource-manager/reference/rest/v1/projects)
@@ -51,6 +53,17 @@ resource "google_folder" "department1" {
 }
 ```
 
+To create a project with a tag
+
+```hcl
+resource "google_project" "my_project" {
+  name       = "My Project"
+  project_id = "your-project-id"
+  org_id     = "1234567"
+  tags = {"1234567/env":"staging"}
+}
+```
+
 ## Argument Reference
 
 The following arguments are supported:
@@ -100,6 +113,8 @@ The following arguments are supported:
    to be abandoned rather than deleted, i.e., the Terraform resource can be deleted without deleting the Project via 
    the Google API. Possible values are: "PREVENT", "ABANDON", "DELETE". Default value is `PREVENT`.
 
+* `tags` - (Optional) 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/456. The field is ignored when empty. The field is immutable and causes resource replacement when mutated.
+
 ## Attributes Reference
 
 In addition to the arguments listed above, the following computed attributes are