Add a test check function to get cai assets metadata (#13421) (#22107)

[upstream:a01be1afe8991b48de5989c9f121902784c4b0ec]

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

Author: modular-magician

.changelog/13421.txt

@@ -0,0 +1,3 @@
+```release-note:none
+
+```

google/acctest/tgc_utils.go

@@ -0,0 +1,77 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+package acctest
+
+import (
+	"fmt"
+	"log"
+	"regexp"
+	"strings"
+
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+	"github.com/hashicorp/terraform-plugin-testing/terraform"
+	"github.com/hashicorp/terraform-provider-google/google/tpgresource"
+)
+
+// Hardcode the Terraform resource name -> API service name mapping temporarily.
+// TODO: [tgc] read the mapping from the resource metadata files.
+var ApiServiceNames = map[string]string{
+	"google_compute_instance": "compute.googleapis.com",
+	"google_project":          "cloudresourcemanager.googleapis.com",
+}
+
+// Gets the test metadata for tgc:
+//   - test config
+//   - cai asset name
+//     For example: //compute.googleapis.com/projects/ci-test-188019/zones/us-central1-a/instances/tf-test-mi3fqaucf8
+func GetTestMetadataForTgc(service, address, config string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		splits := strings.Split(address, ".")
+		if splits == nil || len(splits) < 2 {
+			return fmt.Errorf("The resource address %s is invalid.", address)
+		}
+		resourceType := splits[0]
+		resourceName := splits[1]
+
+		rState := s.RootModule().Resources[address]
+		if rState == nil || rState.Primary == nil {
+			return fmt.Errorf("The resource state is unavailable. Please check if the address %s.%s is correct.", resourceType, resourceName)
+		}
+
+		// Convert the resource ID into CAI asset name
+		// and then print out the CAI asset name in the logs
+		if apiServiceName, ok := ApiServiceNames[resourceType]; !ok {
+			return fmt.Errorf("The Cai product backend name for resource %s doesn't exist.", resourceType)
+		} else {
+			var rName string
+			switch resourceType {
+			case "google_project":
+				rName = fmt.Sprintf("projects/%s", rState.Primary.Attributes["number"])
+			default:
+				rName = rState.Primary.ID
+			}
+
+			caiAssetName := fmt.Sprintf("//%s/%s", apiServiceName, rName)
+			log.Printf("[DEBUG]TGC CAI asset name: %s", caiAssetName)
+		}
+
+		// The acceptance tests names will be also used for the tgc tests.
+		// "service" is logged and will be used to put the tgc tests into specific service packages.
+		log.Printf("[DEBUG]TGC Terraform service: %s", service)
+		log.Printf("[DEBUG]TGC Terraform resource: %s", resourceType)
+
+		re := regexp.MustCompile(`\"(tf[-_]?test[-_]?.*?)([a-z0-9]+)\"`)
+		config = re.ReplaceAllString(config, `"${1}tgc"`)
+
+		// Replace resource name with the resource's real name,
+		// which is used to get the main resource object by checking the address after parsing raw config.
+		// For example, replace `"google_compute_instance" "foobar"` with `"google_compute_instance" "tf-test-mi3fqaucf8"`
+		n := tpgresource.GetResourceNameFromSelfLink(rState.Primary.ID)
+		old := fmt.Sprintf(`"%s" "%s"`, resourceType, resourceName)
+		new := fmt.Sprintf(`"%s" "%s"`, resourceType, n)
+		config = strings.Replace(config, old, new, 1)
+
+		log.Printf("[DEBUG]TGC raw_config starts %sEnd of TGC raw_config", config)
+		return nil
+	}
+}

google/services/resourcemanager/resource_google_project_test.go

@@ -65,6 +65,8 @@ func TestAccProject_create(t *testing.T) {
 				Config: testAccProject(pid, org),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckGoogleProjectExists("google_project.acceptance", pid),
+					acctest.GetTestMetadataForTgc("resourcemanager", "google_project.acceptance",
+						testAccProject(pid, org)),
 				),
 			},
 		},
@@ -157,6 +159,14 @@ func TestAccProject_labels(t *testing.T) {
 					testAccCheckGoogleProjectHasNoLabels(t, "google_project.acceptance", pid),
 				),
 			},
+			{
+				Config: testAccProject_labels(pid, org, map[string]string{"label": "label-value"}),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckGoogleProjectHasLabels(t, "google_project.acceptance", pid, map[string]string{"label": "label-value"}),
+					acctest.GetTestMetadataForTgc("resourcemanager", "google_project.acceptance",
+						testAccProject_labels(pid, org, map[string]string{"test": "that"})),
+				),
+			},
 		},
 	})
 }
@@ -190,6 +200,10 @@ func TestAccProject_parentFolder(t *testing.T) {
 		Steps: []resource.TestStep{
 			{
 				Config: testAccProject_parentFolder(pid, folderDisplayName, org),
+				Check: resource.ComposeTestCheckFunc(
+					acctest.GetTestMetadataForTgc("resourcemanager", "google_project.acceptance",
+						testAccProject_parentFolder(pid, folderDisplayName, org)),
+				),
 			},
 		},
 	})
@@ -613,7 +627,8 @@ resource "google_project" "acceptance" {
 }
 
 func testAccProject_tagsAllowDestroy(pid, org string, tags map[string]string) string {
-	r := fmt.Sprintf(`resource "google_project" "acceptance" {
+	r := fmt.Sprintf(
+		`resource "google_project" "acceptance" {
 	 project_id = "%s"
   name       = "%s"
   org_id     = "%s"