feat(bigqueryanalyticshub): Add multi-region support to listings and subscriptions

Author: okvidhi

mmv1/products/bigqueryanalyticshub/Listing.yaml

@@ -35,12 +35,12 @@ iam_policy:
   method_name_separator: ':'
   fetch_iam_policy_verb: 'POST'
   parent_resource_attribute: 'listing_id'
+  example_config_body: 'templates/terraform/iam/iam_attributes.go.tmpl'
   import_format:
     - 'projects/{{project}}/locations/{{location}}/dataExchanges/{{data_exchange_id}}/listings/{{listing_id}}'
     - '{{listing_id}}'
 custom_code:
   pre_update: 'templates/terraform/pre_update/bigqueryanalyticshub_listing.go.tmpl'
-  pre_delete: 'templates/terraform/pre_delete/bigquery_analytics_hub_listing.go.tmpl'
 # Skipping the sweeper due to the non-standard base_url
 exclude_sweeper: true
 examples:
@@ -97,29 +97,16 @@ examples:
       dataset_id: 'tf_test_dataset'
       routine_id: 'tf_test_routine'
       desc: 'Example for listing with routine'
-  - name: 'bigquery_analyticshub_public_listing'
+  - name: 'bigquery_analyticshub_listing_multiregion'
     primary_resource_id: 'listing'
+    min_version: beta 
     primary_resource_name: 'fmt.Sprintf("tf_test_my_data_exchange%s", context["random_suffix"]), fmt.Sprintf("tf_test_my_listing%s", context["random_suffix"])'
     region_override: 'US'
     vars:
       data_exchange_id: 'my_data_exchange'
       listing_id: 'my_listing'
-      desc: 'example public listing'
-  - name: 'bigquery_analyticshub_listing_marketplace'
-    primary_resource_id: 'listing'
-    primary_resource_name: 'fmt.Sprintf("tf_test_my_data_exchange%s", context["random_suffix"]), fmt.Sprintf("tf_test_my_listing%s", context["random_suffix"])'
-    region_override: 'us'
-    vars:
-      data_exchange_id: 'my_data_exchange'
-      listing_id: 'my_listing'
-      desc: 'example data exchange'
-    ignore_read_extra:
-      - 'delete_commercial'
-virtual_fields:
-  - name: 'delete_commercial'
-    type: Boolean
-    description: |-
-      If the listing is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid deleting commercial listings accidentally.
+      description: 'example listing for multiregion'
+    exclude_test: true #Handwritten Create test as replica has to be created through Go BQ client
 parameters:
 properties:
   - name: 'name'
@@ -148,6 +135,7 @@ properties:
     url_param_only: true
     required: true
     immutable: true
+    diff_suppress_func: 'tpgresource.CaseDiffSuppress'
   - name: 'displayName'
     type: String
     description: |-
@@ -206,7 +194,6 @@ properties:
   - name: 'bigqueryDataset'
     type: NestedObject
     description: Shared dataset i.e. BigQuery dataset source.
-    immutable: true
     exactly_one_of:
       - 'pubsubTopic'
       - 'bigqueryDataset'
@@ -245,6 +232,43 @@ properties:
               exactly_one_of:
                 - 'table'
                 - 'routine'
+      - name: 'replicaLocations'
+        type: Array
+        is_set: true
+        min_version: 'beta'
+        set_hash_func: 'tpgresource.CaseInsensitiveHash' # Add this line
+        description: |
+          A list of regions where the publisher has created shared dataset replicas.
+        item_type:
+          type: String
+          diff_suppress_func: 'tpgresource.CaseDiffSuppress'
+      - name: 'effectiveReplicas'
+        type: Array
+        description: |
+          Server owned effective state of replicas. Contains both primary and secondary replicas.
+          Each replica includes a system-computed (output-only) state and primary designation.
+        output: true
+        min_version: 'beta'
+        item_type:
+          type: NestedObject
+          properties:
+            - name: 'location'
+              type: String
+              description: |
+                The geographic location where the replica resides.
+              output: true
+            - name: 'replicaState'
+              type: String
+              description: |
+                Output-only. Assigned by Analytics Hub based on real BigQuery replication state.
+                Possible values: REPLICA_STATE_UNSPECIFIED, READY_TO_USE, UNAVAILABLE
+              output: true
+            - name: 'primaryState'
+              type: String
+              description: |
+                Output-only. Indicates that this replica is the primary replica.
+                Possible values: PRIMARY_STATE_UNSPECIFIED, PRIMARY_REPLICA
+              output: true
   - name: 'pubsubTopic'
     type: NestedObject
     description: Pub/Sub topic source.
@@ -288,41 +312,3 @@ properties:
     type: Boolean
     description:
       If true, subscriber email logging is enabled and all queries on the linked dataset will log the email address of the querying user. Once enabled, this setting cannot be turned off.
-  - name: 'state'
-    type: String
-    description: |-
-      Current state of the listing.
-    output: true
-  - name: 'discoveryType'
-    type: Enum
-    enum_values:
-      - 'DISCOVERY_TYPE_PRIVATE'
-      - 'DISCOVERY_TYPE_PUBLIC'
-    default_from_api: true
-    description: Specifies the type of discovery on the discovery page. Cannot be set for a restricted listing. Note that this does not control the visibility of the exchange/listing which is defined by IAM permission.
-  - name: 'allowOnlyMetadataSharing'
-    type: Boolean
-    immutable: true
-    description: If true, the listing is only available to get the resource metadata. Listing is non subscribable.
-  - name: 'commercialInfo'
-    type: NestedObject
-    description: |
-      Commercial info contains the information about the commercial data products associated with the listing.
-    output: true
-    properties:
-      - name: 'cloudMarketplace'
-        type: NestedObject
-        description: Details of the Marketplace Data Product associated with the Listing.
-        output: true
-        properties:
-          - name: 'service'
-            type: String
-            description: |
-              Resource name of the commercial service associated with the Marketplace Data Product. e.g. example.com
-            output: true
-          - name: 'commercialState'
-            type: String
-            description: |
-              Commercial state of the Marketplace Data Product.
-              Possible values: COMMERCIAL_STATE_UNSPECIFIED, ONBOARDING, ACTIVE
-            output: true

mmv1/products/bigqueryanalyticshub/ListingSubscription.yaml

@@ -32,7 +32,6 @@ import_format:
 custom_code:
   decoder: 'templates/terraform/decoders/bigqueryanalyticshub_listing_subscription.go.tmpl'
   pre_read: 'templates/terraform/pre_read/bigqueryanalyticshub_listing_subscription.tmpl'
-  post_read: 'templates/terraform/post_read/bigqueryanalyticshub_listing_subscription.go.tmpl'
   pre_delete: 'templates/terraform/pre_read/bigqueryanalyticshub_listing_subscription.tmpl'
   post_import: templates/terraform/post_import/analytics_hub_subscription.go.tmpl
 sweeper:
@@ -52,6 +51,21 @@ examples:
       listing_id: 'my_listing'
       destination_dataset_id: 'destination_dataset'
       description: 'example data exchange'
+  - name: 'bigquery_analyticshub_listing_subscription_multiregion'
+    primary_resource_id: 'subscription'
+    min_version: beta
+    primary_resource_name: 'fmt.Sprintf(\"tf_test_my_data_exchange%s\",
+      context[\"\
+      random_suffix\"]), fmt.Sprintf(\"tf_test_my_listing%s\",
+      context[\"random_suffix\"\
+      ])'
+    region_override: 'US'
+    vars:
+      data_exchange_id: 'my_data_exchange'
+      listing_id: 'my_listing'
+      destination_dataset_id: 'destination_dataset'
+      description: 'example listing multiregion subscription'
+    exclude_test: true #Handwritten Create test as replica has to be created through Go BQ client
 parameters:
   - name: 'dataExchangeId'
     type: String
@@ -77,6 +91,7 @@ properties:
   - name: 'destinationDataset'
     type: NestedObject
     required: true
+    ignore_read: true
     description:
       The destination dataset for this subscription.
     properties:
@@ -112,6 +127,16 @@ properties:
         description: |
           The labels associated with this dataset. You can use these to
           organize and group your datasets.
+      - name: 'replicaLocations'
+        is_set: true
+        type: Array
+        min_version: 'beta'
+        set_hash_func: 'tpgresource.CaseInsensitiveHash' # Add this line
+        description: |
+          List of regions where the subscriber wants dataset replicas.
+        item_type:
+          type: String
+          diff_suppress_func: 'tpgresource.CaseDiffSuppress' # Apply here for array elements
   - name: 'name'
     type: String
     description: |-
@@ -198,19 +223,3 @@ properties:
     type: Boolean
     description: 'Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for Listing.'
     output: true
-  - name: 'commercialInfo'
-    type: NestedObject
-    description: |
-      Commercial info metadata for this subscription. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.
-    output: true
-    properties:
-      - name: 'cloudMarketplace'
-        type: NestedObject
-        description: Cloud Marketplace commercial metadata for this subscription.
-        output: true
-        properties:
-          - name: 'order'
-            type: String
-            description: |
-              Resource name of the Marketplace Order.
-            output: true

mmv1/templates/terraform/pre_update/bigqueryanalyticshub_listing.go.tmpl

@@ -18,3 +18,23 @@ if d.HasChange("pubsub_topic.0.data_affinity_regions"){
 	}
 } 
 
+if d.HasChange("bigquery_dataset.0.replica_locations"){               
+    // Split URL into base and query parts
+	parts := strings.SplitN(url, "?", 2)
+	if len(parts) == 2 {
+	base := parts[0]
+	query := parts[1]
+
+	query = strings.ReplaceAll(query, "%2C", ",")
+	query = strings.ReplaceAll(query, "%2c", ",")
+
+	// Replace "bigqueryDataset" with "bigqueryDataset.replicaLocations"
+	query = strings.ReplaceAll(query, "bigqueryDataset", "bigqueryDataset.replicaLocations")
+
+	// Re-encode commas back
+	query = strings.ReplaceAll(query, ",", "%2C")
+
+	url = base + "?" + query
+	}
+} 
+