tgc-revival: fix cai asset name format (#15414)

Author: zli82016

docs/content/reference/metadata.md

@@ -31,6 +31,10 @@ The version of the API used for this resource e.g., "v2".
 
 The API "resource type kind" used for this resource e.g., "Function".
 
+### `cai_asset_name_format`
+
+The custom CAI asset name format for this resource is typically specified (e.g., //cloudsql.googleapis.com/projects/{{project}}/instances/{{name}}). If this format is not provided, the Terraform resource ID format is used instead.
+
 ### `api_variant_patterns`
 
 The API URL patterns used by this resource that represent variants e.g., "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/api/product.go

@@ -65,6 +65,9 @@ type Product struct {
 	// base URL. Specific to defining the resource as a CAI asset.
 	CaiBaseUrl string
 
+	// The service name from CAI asset name, e.g. bigtable.googleapis.com.
+	CaiAssetService string `yaml:"cai_asset_service,omitempty"`
+
 	// CaiResourceType of resources that already have an AssetType constant defined in the product.
 	ResourcesWithCaiAssetType map[string]struct{}
 

mmv1/api/resource.go

@@ -397,6 +397,9 @@ type TGCResource struct {
 	// Tests for TGC, will automatically be filled with resource's examples
 	// and handwritten tests. Can be specified in order to skip specific tests.
 	TGCTests []resource.TGCTest `yaml:"tgc_tests,omitempty"`
+
+	// [Optional] It overrides the default Cai asset name format, which is the resource id format
+	CaiAssetNameFormat string `yaml:"cai_asset_name_format,omitempty"`
 }
 
 func (r *Resource) UnmarshalYAML(unmarshal func(any) error) error {
@@ -1949,12 +1952,7 @@ func (r Resource) StateUpgradersCount() []int {
 }
 
 func (r Resource) CaiProductBaseUrl() string {
-	version := r.ProductMetadata.VersionObjOrClosest(r.TargetVersionName)
-	baseUrl := version.CaiBaseUrl
-	if baseUrl == "" {
-		baseUrl = version.BaseUrl
-	}
-	return baseUrl
+	return r.ProductMetadata.ServiceBaseUrl()
 }
 
 // Gets the CAI product legacy base url.
@@ -2074,16 +2072,31 @@ func (r Resource) getCandidateCaiId(url string) string {
 	return ""
 }
 
-// Gets the Cai asset name template, which doesn't include version
-// For example: //monitoring.googleapis.com/projects/{{project}}/services/{{service_id}}
-func (r Resource) CaiAssetNameTemplate(productBackendName string) string {
-	template := r.rawCaiAssetNameTemplate(productBackendName)
-	versionRegex, err := regexp.Compile(`\/(v\d[^\/]*)\/`)
-	if err != nil {
-		log.Fatalf("Cannot compile the regular expression: %v", err)
+// Gets a format string that is used to override the default format from resource id format
+func (r Resource) CAIFormatOverride() string {
+	caiAssetService := strings.Trim(r.ProductMetadata.CaiAssetService, "/")
+	if r.CaiAssetNameFormat != "" || caiAssetService != "" {
+		if caiAssetService == "" {
+			caiAssetService = r.ProductMetadata.ServiceName()
+		}
+
+		caiAssetName := r.CaiAssetNameFormat
+		if caiAssetName == "" {
+			caiAssetName = r.IdFormat
+		}
+		return fmt.Sprintf("//%s/%s", caiAssetService, caiAssetName)
+	}
+	return ""
+}
+
+// Gets a format string for CAI asset name
+func (r Resource) GetCaiAssetNameTemplate() string {
+	caiAssetNameFormat := r.CAIFormatOverride()
+	if caiAssetNameFormat != "" {
+		return caiAssetNameFormat
 	}
 
-	return versionRegex.ReplaceAllString(template, "/")
+	return fmt.Sprintf("//%s.googleapis.com/%s", r.CaiProductBackendName(r.CaiProductBaseUrl()), r.IdFormat)
 }
 
 // Gets the Cai API version

mmv1/products/accesscontextmanager/AccessPolicy.yaml

@@ -33,6 +33,7 @@ docs:
 id_format: '{{name}}'
 base_url: 'accessPolicies'
 self_link: 'accessPolicies/{{name}}'
+cai_asset_name_format: 'accessPolicies/{{name}}'
 update_verb: 'PATCH'
 update_mask: true
 import_format:

mmv1/products/bigtable/product.yaml

@@ -19,3 +19,4 @@ versions:
     base_url: 'https://bigtableadmin.googleapis.com/v2/'
 scopes:
   - 'https://www.googleapis.com/auth/bigtable'
+cai_asset_service: 'bigtable.googleapis.com'

mmv1/products/billing/ProjectInfo.yaml

@@ -23,6 +23,7 @@ references:
 docs:
 id_format: 'projects/{{project}}'
 base_url: 'projects/{{project}}/billingInfo'
+cai_asset_name_format: 'projects/{{project}}/billingInfo'
 create_verb: 'PUT'
 delete_verb: 'PUT'
 import_format:

mmv1/products/binaryauthorization/Policy.yaml

@@ -23,6 +23,7 @@ docs:
 id_format: 'projects/{{project}}'
 base_url: 'projects/{{project}}/policy'
 self_link: 'projects/{{project}}/policy'
+cai_asset_name_format: 'projects/{{project}}/policy'
 create_verb: 'PUT'
 delete_verb: 'PUT'
 import_format:

mmv1/products/cloudasset/FolderFeed.yaml

@@ -42,6 +42,7 @@ custom_code:
 supports_indirect_user_project_override: true
 include_in_tgc_next_DO_NOT_USE: true
 cai_base_url: 'folders/{{folder}}/feeds'
+cai_asset_name_format: 'folders/{{folder}}/feeds/{{feed_id}}'
 tgc_ignore_terraform_encoder: true
 examples:
   - name: 'cloud_asset_folder_feed'

mmv1/products/cloudasset/OrganizationFeed.yaml

@@ -42,6 +42,7 @@ custom_code:
 supports_indirect_user_project_override: true
 include_in_tgc_next_DO_NOT_USE: true
 cai_base_url: 'organizations/{{org_id}}/feeds'
+cai_asset_name_format: 'organizations/{{org_id}}/feeds/{{feed_id}}'
 tgc_ignore_terraform_encoder: true
 examples:
   - name: 'cloud_asset_organization_feed'

mmv1/products/cloudasset/ProjectFeed.yaml

@@ -40,6 +40,7 @@ custom_code:
   custom_import: 'templates/terraform/custom_import/cloud_asset_feed.go.tmpl'
 include_in_tgc_next_DO_NOT_USE: true
 cai_base_url: 'projects/{{project}}/feeds'
+cai_asset_name_format: 'projects/{{project}}/feeds/{{feed_id}}'
 tgc_ignore_terraform_encoder: true
 examples:
   - name: 'cloud_asset_project_feed'