AnalyticsHub Marketplace Changes (#14556) (#23731)

[upstream:4dd5624b9bd5d9fb7d39acf94deb53127832f1d1]

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

Author: modular-magician

.changelog/14556.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+bigqueryanalyticshub: Added 'commercial_info' and 'delete_commercial' fields in 'google_bigquery_analytics_hub_listing' resource
+```

google/services/bigqueryanalyticshub/resource_bigquery_analytics_hub_listing.go

@@ -247,11 +247,45 @@ See https://cloud.google.com/about/locations for full listing of possible Cloud
 					},
 				},
 			},
+			"commercial_info": {
+				Type:        schema.TypeList,
+				Computed:    true,
+				Description: `Commercial info contains the information about the commercial data products associated with the listing.`,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"cloud_marketplace": {
+							Type:        schema.TypeList,
+							Computed:    true,
+							Description: `Details of the Marketplace Data Product associated with the Listing.`,
+							Elem: &schema.Resource{
+								Schema: map[string]*schema.Schema{
+									"commercial_state": {
+										Type:     schema.TypeString,
+										Computed: true,
+										Description: `Commercial state of the Marketplace Data Product.
+Possible values: COMMERCIAL_STATE_UNSPECIFIED, ONBOARDING, ACTIVE`,
+									},
+									"service": {
+										Type:        schema.TypeString,
+										Computed:    true,
+										Description: `Resource name of the commercial service associated with the Marketplace Data Product. e.g. example.com`,
+									},
+								},
+							},
+						},
+					},
+				},
+			},
 			"name": {
 				Type:        schema.TypeString,
 				Computed:    true,
 				Description: `The resource name of the listing. e.g. "projects/myproject/locations/US/dataExchanges/123/listings/456"`,
 			},
+			"delete_commercial": {
+				Type:        schema.TypeBool,
+				Optional:    true,
+				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.`,
+			},
 			"project": {
 				Type:     schema.TypeString,
 				Optional: true,
@@ -434,6 +468,7 @@ func resourceBigqueryAnalyticsHubListingRead(d *schema.ResourceData, meta interf
 		return transport_tpg.HandleNotFoundError(err, d, fmt.Sprintf("BigqueryAnalyticsHubListing %q", d.Id()))
 	}
 
+	// Explicitly set virtual fields to default values if unset
 	if err := d.Set("project", project); err != nil {
 		return fmt.Errorf("Error reading Listing: %s", err)
 	}
@@ -480,6 +515,9 @@ func resourceBigqueryAnalyticsHubListingRead(d *schema.ResourceData, meta interf
 	if err := d.Set("log_linked_dataset_query_user_email", flattenBigqueryAnalyticsHubListingLogLinkedDatasetQueryUserEmail(res["logLinkedDatasetQueryUserEmail"], d, config)); err != nil {
 		return fmt.Errorf("Error reading Listing: %s", err)
 	}
+	if err := d.Set("commercial_info", flattenBigqueryAnalyticsHubListingCommercialInfo(res["commercialInfo"], d, config)); err != nil {
+		return fmt.Errorf("Error reading Listing: %s", err)
+	}
 
 	return nil
 }
@@ -712,6 +750,10 @@ func resourceBigqueryAnalyticsHubListingDelete(d *schema.ResourceData, meta inte
 	}
 
 	headers := make(http.Header)
+	deleteCommercial := d.Get("delete_commercial")
+	if deleteCommercial != nil {
+		url = url + "?deleteCommercial=" + fmt.Sprintf("%v", deleteCommercial)
+	}
 
 	log.Printf("[DEBUG] Deleting Listing %q", d.Id())
 	res, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
@@ -749,6 +791,8 @@ func resourceBigqueryAnalyticsHubListingImport(d *schema.ResourceData, meta inte
 	}
 	d.SetId(id)
 
+	// Explicitly set virtual fields to default values on import
+
 	return []*schema.ResourceData{d}, nil
 }
 
@@ -930,6 +974,42 @@ func flattenBigqueryAnalyticsHubListingLogLinkedDatasetQueryUserEmail(v interfac
 	return v
 }
 
+func flattenBigqueryAnalyticsHubListingCommercialInfo(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	if v == nil {
+		return nil
+	}
+	original := v.(map[string]interface{})
+	if len(original) == 0 {
+		return nil
+	}
+	transformed := make(map[string]interface{})
+	transformed["cloud_marketplace"] =
+		flattenBigqueryAnalyticsHubListingCommercialInfoCloudMarketplace(original["cloudMarketplace"], d, config)
+	return []interface{}{transformed}
+}
+func flattenBigqueryAnalyticsHubListingCommercialInfoCloudMarketplace(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	if v == nil {
+		return nil
+	}
+	original := v.(map[string]interface{})
+	if len(original) == 0 {
+		return nil
+	}
+	transformed := make(map[string]interface{})
+	transformed["service"] =
+		flattenBigqueryAnalyticsHubListingCommercialInfoCloudMarketplaceService(original["service"], d, config)
+	transformed["commercial_state"] =
+		flattenBigqueryAnalyticsHubListingCommercialInfoCloudMarketplaceCommercialState(original["commercialState"], d, config)
+	return []interface{}{transformed}
+}
+func flattenBigqueryAnalyticsHubListingCommercialInfoCloudMarketplaceService(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	return v
+}
+
+func flattenBigqueryAnalyticsHubListingCommercialInfoCloudMarketplaceCommercialState(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	return v
+}
+
 func expandBigqueryAnalyticsHubListingDisplayName(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
 	return v, nil
 }

google/services/bigqueryanalyticshub/resource_bigquery_analytics_hub_listing_generated_meta.yaml

@@ -8,10 +8,14 @@ fields:
   - field: 'bigquery_dataset.dataset'
   - field: 'bigquery_dataset.selected_resources.table'
   - field: 'categories'
+  - field: 'commercial_info.cloud_marketplace.commercial_state'
+  - field: 'commercial_info.cloud_marketplace.service'
   - field: 'data_exchange_id'
     provider_only: true
   - field: 'data_provider.name'
   - field: 'data_provider.primary_contact'
+  - field: 'delete_commercial'
+    provider_only: true
   - field: 'description'
   - field: 'display_name'
   - field: 'documentation'

google/services/bigqueryanalyticshub/resource_bigquery_analytics_hub_listing_generated_test.go

@@ -347,6 +347,63 @@ resource "google_bigquery_analytics_hub_listing" "listing" {
 `, context)
 }
 
+func TestAccBigqueryAnalyticsHubListing_bigqueryAnalyticshubListingMarketplaceExample(t *testing.T) {
+	t.Parallel()
+
+	context := map[string]interface{}{
+		"random_suffix": acctest.RandString(t, 10),
+	}
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		CheckDestroy:             testAccCheckBigqueryAnalyticsHubListingDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccBigqueryAnalyticsHubListing_bigqueryAnalyticshubListingMarketplaceExample(context),
+			},
+			{
+				ResourceName:            "google_bigquery_analytics_hub_listing.listing",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"data_exchange_id", "delete_commercial", "listing_id", "location"},
+			},
+		},
+	})
+}
+
+func testAccBigqueryAnalyticsHubListing_bigqueryAnalyticshubListingMarketplaceExample(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_bigquery_analytics_hub_data_exchange" "listing" {
+  location         = "US"
+  data_exchange_id = "tf_test_my_data_exchange%{random_suffix}"
+  display_name     = "tf_test_my_data_exchange%{random_suffix}"
+  description      = "example data exchange%{random_suffix}"
+}
+
+resource "google_bigquery_analytics_hub_listing" "listing" {
+  location         = "US"
+  data_exchange_id = google_bigquery_analytics_hub_data_exchange.listing.data_exchange_id
+  listing_id       = "tf_test_my_listing%{random_suffix}"
+  display_name     = "tf_test_my_listing%{random_suffix}"
+  description      = "example data exchange%{random_suffix}"
+  delete_commercial = true
+
+  bigquery_dataset {
+    dataset = google_bigquery_dataset.listing.id
+  }
+
+}
+
+resource "google_bigquery_dataset" "listing" {
+  dataset_id                  = "tf_test_my_listing%{random_suffix}"
+  friendly_name               = "tf_test_my_listing%{random_suffix}"
+  description                 = "example data exchange%{random_suffix}"
+  location                    = "US"
+}
+`, context)
+}
+
 func testAccCheckBigqueryAnalyticsHubListingDestroyProducer(t *testing.T) func(s *terraform.State) error {
 	return func(s *terraform.State) error {
 		for name, rs := range s.RootModule().Resources {

google/services/bigqueryanalyticshub/resource_bigquery_analytics_hub_listing_subscription.go

@@ -136,6 +136,29 @@ organize and group your datasets.`,
 				DiffSuppressFunc: tpgresource.CaseDiffSuppress,
 				Description:      `The name of the location of the data exchange. Distinct from the location of the destination data set.`,
 			},
+			"commercial_info": {
+				Type:        schema.TypeList,
+				Computed:    true,
+				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.`,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"cloud_marketplace": {
+							Type:        schema.TypeList,
+							Computed:    true,
+							Description: `Cloud Marketplace commercial metadata for this subscription.`,
+							Elem: &schema.Resource{
+								Schema: map[string]*schema.Schema{
+									"order": {
+										Type:        schema.TypeString,
+										Computed:    true,
+										Description: `Resource name of the Marketplace Order.`,
+									},
+								},
+							},
+						},
+					},
+				},
+			},
 			"creation_time": {
 				Type:        schema.TypeString,
 				Computed:    true,
@@ -412,6 +435,9 @@ func resourceBigqueryAnalyticsHubListingSubscriptionRead(d *schema.ResourceData,
 	if err := d.Set("log_linked_dataset_query_user_email", flattenBigqueryAnalyticsHubListingSubscriptionLogLinkedDatasetQueryUserEmail(res["logLinkedDatasetQueryUserEmail"], d, config)); err != nil {
 		return fmt.Errorf("Error reading ListingSubscription: %s", err)
 	}
+	if err := d.Set("commercial_info", flattenBigqueryAnalyticsHubListingSubscriptionCommercialInfo(res["commercialInfo"], d, config)); err != nil {
+		return fmt.Errorf("Error reading ListingSubscription: %s", err)
+	}
 
 	return nil
 }
@@ -613,6 +639,36 @@ func flattenBigqueryAnalyticsHubListingSubscriptionLogLinkedDatasetQueryUserEmai
 	return v
 }
 
+func flattenBigqueryAnalyticsHubListingSubscriptionCommercialInfo(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	if v == nil {
+		return nil
+	}
+	original := v.(map[string]interface{})
+	if len(original) == 0 {
+		return nil
+	}
+	transformed := make(map[string]interface{})
+	transformed["cloud_marketplace"] =
+		flattenBigqueryAnalyticsHubListingSubscriptionCommercialInfoCloudMarketplace(original["cloudMarketplace"], d, config)
+	return []interface{}{transformed}
+}
+func flattenBigqueryAnalyticsHubListingSubscriptionCommercialInfoCloudMarketplace(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	if v == nil {
+		return nil
+	}
+	original := v.(map[string]interface{})
+	if len(original) == 0 {
+		return nil
+	}
+	transformed := make(map[string]interface{})
+	transformed["order"] =
+		flattenBigqueryAnalyticsHubListingSubscriptionCommercialInfoCloudMarketplaceOrder(original["order"], d, config)
+	return []interface{}{transformed}
+}
+func flattenBigqueryAnalyticsHubListingSubscriptionCommercialInfoCloudMarketplaceOrder(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	return v
+}
+
 func expandBigqueryAnalyticsHubListingSubscriptionDestinationDataset(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
 	l := v.([]interface{})
 	if len(l) == 0 || l[0] == nil {

google/services/bigqueryanalyticshub/resource_bigquery_analytics_hub_listing_subscription_generated_meta.yaml

@@ -5,6 +5,7 @@ api_service_name: 'analyticshub.googleapis.com'
 api_version: 'v1'
 api_resource_type_kind: 'Subscription'
 fields:
+  - field: 'commercial_info.cloud_marketplace.order'
   - field: 'creation_time'
   - field: 'data_exchange_id'
     provider_only: true

google/services/bigqueryanalyticshub/resource_bigquery_analytics_hub_listing_test.go

@@ -146,3 +146,72 @@ resource "google_bigquery_analytics_hub_listing" "listing_pubsub" {
 }
 `, updatedContext)
 }
+
+func TestAccBigqueryAnalyticsHubListing_bigqueryAnalyticshubListingMarketplaceUpdate(t *testing.T) {
+	t.Parallel()
+
+	context := map[string]interface{}{
+		"random_suffix": acctest.RandString(t, 10),
+	}
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		CheckDestroy:             testAccCheckBigqueryAnalyticsHubListingDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccBigqueryAnalyticsHubListing_bigqueryAnalyticshubListingMarketplaceExample(context),
+			},
+			{
+				ResourceName:            "google_bigquery_analytics_hub_listing.listing",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"data_exchange_id", "listing_id", "location", "delete_commercial"},
+			},
+			{
+				Config: testAccBigqueryAnalyticsHubListing_bigqueryAnalyticshubListingMarketplaceUpdate(context),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("google_bigquery_analytics_hub_listing.listing", "delete_commercial", "false"),
+				),
+			},
+			{
+				ResourceName:            "google_bigquery_analytics_hub_listing.listing",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"data_exchange_id", "listing_id", "location", "delete_commercial"},
+			},
+		},
+	})
+}
+
+func testAccBigqueryAnalyticsHubListing_bigqueryAnalyticshubListingMarketplaceUpdate(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_bigquery_analytics_hub_data_exchange" "listing" {
+  location         = "US"
+  data_exchange_id = "tf_test_my_data_exchange%{random_suffix}"
+  display_name     = "tf_test_my_data_exchange%{random_suffix}"
+  description      = "example data exchange%{random_suffix}"
+}
+
+resource "google_bigquery_analytics_hub_listing" "listing" {
+  location         = "US"
+  data_exchange_id = google_bigquery_analytics_hub_data_exchange.listing.data_exchange_id
+  listing_id       = "tf_test_my_listing%{random_suffix}"
+  display_name     = "tf_test_my_listing%{random_suffix}"
+  description      = "example data exchange%{random_suffix}"
+  delete_commercial = false
+
+  bigquery_dataset {
+    dataset = google_bigquery_dataset.listing.id
+  }
+
+}
+
+resource "google_bigquery_dataset" "listing" {
+  dataset_id                  = "tf_test_my_listing%{random_suffix}"
+  friendly_name               = "tf_test_my_listing%{random_suffix}"
+  description                 = "example data exchange%{random_suffix}"
+  location                    = "US"
+}
+`, context)
+}