tgc-revival: modify cai asset name format for container resources

Author: zli82016

mmv1/api/metadata/metadata.go

@@ -14,12 +14,15 @@ func FromResource(r api.Resource) Metadata {
 		ApiServiceName:      r.ProductMetadata.ServiceName(),
 		ApiVersion:          r.ProductMetadata.ServiceVersion(),
 		ApiResourceTypeKind: r.ApiResourceTypeKind,
-		CaiAssetNameFormat:  r.CAIFormatOverride(),
 		ApiVariantPatterns:  r.ApiVariantPatterns,
 		AutogenStatus:       r.AutogenStatus != "",
 		Fields:              FromProperties(r.AllNestedProperties(google.Concat(r.RootProperties(), r.UserVirtualFields()))),
 	}
 
+	if r.CAIFormatOverride() != "" {
+		m.CaiAssetNameFormats = []string{r.CAIFormatOverride()}
+	}
+
 	if m.ApiVersion == "" {
 		m.ApiVersion = r.ServiceVersion()
 	}
@@ -55,9 +58,9 @@ type Metadata struct {
 	// The API "resource type kind" used for this resource. For example, "Function".
 	ApiResourceTypeKind string `yaml:"api_resource_type_kind"`
 
-	// The custom CAI asset name format for this resource is typically specified (for example, //cloudsql.googleapis.com/projects/{{project}}/instances/{{name}}).
-	// This will only have a value if it's different than the Terraform resource ID format.
-	CaiAssetNameFormat string `yaml:"cai_asset_name_format,omitempty"`
+	// The custom CAI asset name formats for this resource is typically specified (for example, //cloudsql.googleapis.com/projects/{{project}}/instances/{{name}}).
+	// This will only have values if they are different than the Terraform resource ID format.
+	CaiAssetNameFormats []string `yaml:"cai_asset_name_format,omitempty"`
 
 	// The API URL patterns used by this resource that represent variants. For example, "folders/{folder}/feeds/{feed}". Each pattern must match the value defined
 	// in the API exactly. The use of `api_variant_patterns` is only meaningful when the resource type has multiple parent types available.

mmv1/third_party/terraform/acctest/resource_inventory_reader.go

@@ -27,7 +27,7 @@ type Metadata struct {
 	ApiServiceName      string          `yaml:"api_service_name"`
 	ApiVersion          string          `yaml:"api_version"`
 	ApiResourceTypeKind string          `yaml:"api_resource_type_kind"`
-	CaiAssetNameFormat  string          `yaml:"cai_asset_name_format"`
+	CaiAssetNameFormats []string        `yaml:"cai_asset_name_formats"`
 	ApiVariantPatterns  []string        `yaml:"api_variant_patterns"`
 	AutogenStatus       bool            `yaml:"autogen_status,omitempty"`
 	Fields              []MetadataField `yaml:"fields"`

mmv1/third_party/terraform/acctest/tgc_utils.go

@@ -14,6 +14,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
 	"github.com/hashicorp/terraform-plugin-testing/terraform"
 	"github.com/hashicorp/terraform-provider-google/google/envvar"
+	"github.com/hashicorp/terraform-provider-google/google/tpgresource"
 )
 
 type ResourceMetadata struct {
@@ -116,7 +117,7 @@ func CollectAllTgcMetadata(tgcPayload TgcMetadataPayload) resource.TestCheckFunc
 				if !ok {
 					log.Printf("[DEBUG]TGC Terraform error: unknown resource type %s", metadata.ResourceType)
 					metadata.CaiAssetNames = []string{"unknown"}
-				} else if yamlMetadata.CaiAssetNameFormat == "" {
+				} else if len(yamlMetadata.CaiAssetNameFormats) == 0 {
 					log.Printf("[DEBUG]TGC Terraform error: unknown CAI asset name format for resource type %s", yamlMetadata.CaiAssetNameFormat)
 
 					var rName string
@@ -137,19 +138,19 @@ func CollectAllTgcMetadata(tgcPayload TgcMetadataPayload) resource.TestCheckFunc
 
 					metadata.CaiAssetNames = []string{fmt.Sprintf("//%s/%s", yamlMetadata.ApiServiceName, rName)}
 				} else {
-					paramsMap := make(map[string]any, 0)
-					params := extractIdentifiers(yamlMetadata.CaiAssetNameFormat)
-					for _, param := range params {
-						v := rState.Primary.Attributes[param]
-						paramsMap[param] = v
+					caiAssetNameFormat := ""
+					if len(yamlMetadata.CaiAssetNameFormats) == 1 {
+						caiAssetNameFormat = yamlMetadata.CaiAssetNameFormats[0]
+					} else {
+						if strings.HasPrefix(yamlMetadata.Resource, "google_container_") {
+							caiAssetNameFormat = resolveContainerCaiAssetNameFormat(yamlMetadata.CaiAssetNameFormats, rState.Primary.Attributes["location"])
+						}
 					}
 
-					caiAssetName := replacePlaceholders(yamlMetadata.CaiAssetNameFormat, paramsMap)
-
+					caiAssetName := formatCaiAssetName(caiAssetNameFormat, rState.Primary.Attributes)
 					if _, ok := serviceWithProjectNumber[metadata.Service]; ok {
 						caiAssetName = strings.Replace(caiAssetName, projectId, projectNumber, 1)
 					}
-
 					metadata.CaiAssetNames = []string{caiAssetName}
 				}
 			}
@@ -179,6 +180,42 @@ func CollectAllTgcMetadata(tgcPayload TgcMetadataPayload) resource.TestCheckFunc
 	}
 }
 
+// resolveContainerCaiAssetNameFormat determines the correct CAI asset name format
+// for GKE resources based on whether the resource location is a zone or a region.
+func resolveContainerCaiAssetNameFormat(caiAssetNameFormats []string, location string) string {
+	if tpgresource.IsZone(location) {
+		for _, nameFormat := range caiAssetNameFormats {
+			if strings.Contains(nameFormat, "/zones/") {
+				return nameFormat
+			}
+		}
+	} else {
+		for _, nameFormat := range caiAssetNameFormats {
+			if strings.Contains(nameFormat, "/locations/") {
+				return nameFormat
+			}
+		}
+	}
+
+	return ""
+}
+
+// FormatCaiAssetName constructs a fully qualified Cloud Asset Inventory (CAI) asset name
+// by interpolating values from the provided attributes map into a format template.
+// It extracts required placeholders (e.g., "{{project}}", "{{name}}") from the
+// caiAssetNameFormat string and replaces them with their corresponding values from the map.
+func formatCaiAssetName(caiAssetNameFormat string, attributes map[string]string) string {
+	paramsMap := make(map[string]any, 0)
+	params := extractIdentifiers(caiAssetNameFormat)
+	for _, param := range params {
+		v := attributes[param]
+		paramsMap[param] = v
+	}
+
+	caiAssetName := replacePlaceholders(caiAssetNameFormat, paramsMap)
+	return caiAssetName
+}
+
 // For example, for the url "projects/{{project}}/schemas/{{schema}}",
 // the identifiers are "project", "schema".
 func extractIdentifiers(url string) []string {

mmv1/third_party/terraform/services/bigtable/resource_bigtable_instance_meta.yaml

@@ -1,7 +1,8 @@
 resource: 'google_bigtable_instance'
 generation_type: 'handwritten'
 api_service_name: 'bigtableadmin.googleapis.com'
-cai_asset_name_format: '//bigtable.googleapis.com/projects/{{project}}/instances/{{name}}'
+cai_asset_name_formats:
+- '//bigtable.googleapis.com/projects/{{project}}/instances/{{name}}'
 api_version: 'v2'
 api_resource_type_kind: 'Instance'
 fields:

mmv1/third_party/terraform/services/bigtable/resource_bigtable_table_meta.yaml

@@ -3,7 +3,8 @@ generation_type: 'handwritten'
 api_service_name: 'bigtableadmin.googleapis.com'
 api_version: 'v2'
 api_resource_type_kind: 'Table'
-cai_asset_name_format: '//bigtable.googleapis.com/projects/{{project}}/instances/{{instance_name}}/tables/{{name}}'
+cai_asset_name_formats:
+- '//bigtable.googleapis.com/projects/{{project}}/instances/{{instance_name}}/tables/{{name}}'
 fields:
   - api_field: 'automatedBackupPolicy.frequency'
   - api_field: 'automatedBackupPolicy.retentionPeriod'

mmv1/third_party/terraform/services/container/resource_container_cluster_meta.yaml.tmpl

@@ -9,6 +9,9 @@ api_version: 'v1'
 api_resource_type_kind: 'Cluster'
 api_variant_patterns:
   - 'projects/{project}/locations/{location}/clusters/{cluster}'
+cai_asset_name_formats:
+  - {{"//container.googleapis.com/projects/{{project}}/locations/{{location}}/clusters/{{name}}"}}
+  - {{"//container.googleapis.com/projects/{{project}}/zones/{{location}}/clusters/{{name}}"}}
 fields:
   - field: 'addons_config.cloudrun_config.disabled'
     api_field: 'addonsConfig.cloudRunConfig.disabled'

mmv1/third_party/terraform/services/container/resource_container_node_pool_meta.yaml.tmpl

@@ -7,6 +7,9 @@ api_version: 'v1beta1'
 api_version: 'v1'
 {{- end }}
 api_resource_type_kind: 'NodePool'
+cai_asset_name_formats:
+  - {{"//container.googleapis.com/projects/{{project}}/locations/{{location}}/clusters/{{cluster}}/nodePools/{{name}}"}}
+  - {{"//container.googleapis.com/projects/{{project}}/zones/{{location}}/clusters/{{cluster}}/nodePools/{{name}}"}}
 fields:
   - api_field: 'autoscaling.locationPolicy'
   - api_field: 'autoscaling.maxNodeCount'

mmv1/third_party/terraform/services/resourcemanager/resource_google_service_account_meta.yaml

@@ -3,7 +3,8 @@ generation_type: 'handwritten'
 api_service_name: 'iam.googleapis.com'
 api_version: 'v1'
 api_resource_type_kind: 'ServiceAccount'
-cai_asset_name_format: '//iam.googleapis.com/projects/{{project}}/serviceAccounts/{{unique_id}}'
+cai_asset_name_formats:
+- '//iam.googleapis.com/projects/{{project}}/serviceAccounts/{{unique_id}}'
 fields:
   - field: 'account_id'
   - field: 'create_ignore_already_exists'

mmv1/third_party/terraform/services/tags/resource_tags_location_tag_binding_meta.yaml

@@ -3,7 +3,8 @@ generation_type: 'handwritten'
 api_service_name: 'cloudresourcemanager.googleapis.com'
 api_version: 'v3'
 api_resource_type_kind: 'TagBinding'
-cai_asset_name_format: '//cloudresourcemanager.googleapis.com/{{name}}'
+cai_asset_name_formats:
+- '//cloudresourcemanager.googleapis.com/{{name}}'
 fields:
   - field: 'location'
   - api_field: 'name'