Add external catalog dataset options to google_bigquery_dataset beta (#12113) (#8558)

[upstream:eb942f6be819dcb43d40b1c707d2b00a28579c3e]

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

Author: modular-magician

.changelog/12113.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+bigquery: added `external_catalog_dataset_options` fields to `google_bigquery_dataset` resource (beta)
+```

google-beta/services/bigquery/resource_bigquery_dataset.go

@@ -173,6 +173,30 @@ expiration time indicated by this property.`,
 				Optional:    true,
 				Description: `A user-friendly description of the dataset`,
 			},
+			"external_catalog_dataset_options": {
+				Type:     schema.TypeList,
+				Optional: true,
+				Description: `Options defining open source compatible datasets living in the BigQuery catalog. Contains
+metadata of open source database, schema or namespace represented by the current dataset.`,
+				MaxItems: 1,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"default_storage_location_uri": {
+							Type:     schema.TypeString,
+							Optional: true,
+							Description: `The storage location URI for all tables in the dataset. Equivalent to hive metastore's
+database locationUri. Maximum length of 1024 characters.`,
+						},
+						"parameters": {
+							Type:     schema.TypeMap,
+							Optional: true,
+							Description: `A map of key value pairs defining the parameters and properties of the open source schema.
+Maximum size of 2Mib.`,
+							Elem: &schema.Schema{Type: schema.TypeString},
+						},
+					},
+				},
+			},
 			"external_dataset_reference": {
 				Type:        schema.TypeList,
 				Optional:    true,
@@ -556,6 +580,12 @@ func resourceBigQueryDatasetCreate(d *schema.ResourceData, meta interface{}) err
 	} else if v, ok := d.GetOkExists("resource_tags"); !tpgresource.IsEmptyValue(reflect.ValueOf(resourceTagsProp)) && (ok || !reflect.DeepEqual(v, resourceTagsProp)) {
 		obj["resourceTags"] = resourceTagsProp
 	}
+	externalCatalogDatasetOptionsProp, err := expandBigQueryDatasetExternalCatalogDatasetOptions(d.Get("external_catalog_dataset_options"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("external_catalog_dataset_options"); !tpgresource.IsEmptyValue(reflect.ValueOf(externalCatalogDatasetOptionsProp)) && (ok || !reflect.DeepEqual(v, externalCatalogDatasetOptionsProp)) {
+		obj["externalCatalogDatasetOptions"] = externalCatalogDatasetOptionsProp
+	}
 	labelsProp, err := expandBigQueryDatasetEffectiveLabels(d.Get("effective_labels"), d, config)
 	if err != nil {
 		return err
@@ -723,6 +753,9 @@ func resourceBigQueryDatasetRead(d *schema.ResourceData, meta interface{}) error
 	if err := d.Set("resource_tags", flattenBigQueryDatasetResourceTags(res["resourceTags"], d, config)); err != nil {
 		return fmt.Errorf("Error reading Dataset: %s", err)
 	}
+	if err := d.Set("external_catalog_dataset_options", flattenBigQueryDatasetExternalCatalogDatasetOptions(res["externalCatalogDatasetOptions"], d, config)); err != nil {
+		return fmt.Errorf("Error reading Dataset: %s", err)
+	}
 	if err := d.Set("terraform_labels", flattenBigQueryDatasetTerraformLabels(res["labels"], d, config)); err != nil {
 		return fmt.Errorf("Error reading Dataset: %s", err)
 	}
@@ -836,6 +869,12 @@ func resourceBigQueryDatasetUpdate(d *schema.ResourceData, meta interface{}) err
 	} else if v, ok := d.GetOkExists("resource_tags"); !tpgresource.IsEmptyValue(reflect.ValueOf(v)) && (ok || !reflect.DeepEqual(v, resourceTagsProp)) {
 		obj["resourceTags"] = resourceTagsProp
 	}
+	externalCatalogDatasetOptionsProp, err := expandBigQueryDatasetExternalCatalogDatasetOptions(d.Get("external_catalog_dataset_options"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("external_catalog_dataset_options"); !tpgresource.IsEmptyValue(reflect.ValueOf(v)) && (ok || !reflect.DeepEqual(v, externalCatalogDatasetOptionsProp)) {
+		obj["externalCatalogDatasetOptions"] = externalCatalogDatasetOptionsProp
+	}
 	labelsProp, err := expandBigQueryDatasetEffectiveLabels(d.Get("effective_labels"), d, config)
 	if err != nil {
 		return err
@@ -1281,6 +1320,29 @@ func flattenBigQueryDatasetResourceTags(v interface{}, d *schema.ResourceData, c
 	return v
 }
 
+func flattenBigQueryDatasetExternalCatalogDatasetOptions(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["parameters"] =
+		flattenBigQueryDatasetExternalCatalogDatasetOptionsParameters(original["parameters"], d, config)
+	transformed["default_storage_location_uri"] =
+		flattenBigQueryDatasetExternalCatalogDatasetOptionsDefaultStorageLocationUri(original["defaultStorageLocationUri"], d, config)
+	return []interface{}{transformed}
+}
+func flattenBigQueryDatasetExternalCatalogDatasetOptionsParameters(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	return v
+}
+
+func flattenBigQueryDatasetExternalCatalogDatasetOptionsDefaultStorageLocationUri(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	return v
+}
+
 func flattenBigQueryDatasetTerraformLabels(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
 	if v == nil {
 		return v
@@ -1677,6 +1739,47 @@ func expandBigQueryDatasetResourceTags(v interface{}, d tpgresource.TerraformRes
 	return m, nil
 }
 
+func expandBigQueryDatasetExternalCatalogDatasetOptions(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	l := v.([]interface{})
+	if len(l) == 0 || l[0] == nil {
+		return nil, nil
+	}
+	raw := l[0]
+	original := raw.(map[string]interface{})
+	transformed := make(map[string]interface{})
+
+	transformedParameters, err := expandBigQueryDatasetExternalCatalogDatasetOptionsParameters(original["parameters"], d, config)
+	if err != nil {
+		return nil, err
+	} else if val := reflect.ValueOf(transformedParameters); val.IsValid() && !tpgresource.IsEmptyValue(val) {
+		transformed["parameters"] = transformedParameters
+	}
+
+	transformedDefaultStorageLocationUri, err := expandBigQueryDatasetExternalCatalogDatasetOptionsDefaultStorageLocationUri(original["default_storage_location_uri"], d, config)
+	if err != nil {
+		return nil, err
+	} else if val := reflect.ValueOf(transformedDefaultStorageLocationUri); val.IsValid() && !tpgresource.IsEmptyValue(val) {
+		transformed["defaultStorageLocationUri"] = transformedDefaultStorageLocationUri
+	}
+
+	return transformed, nil
+}
+
+func expandBigQueryDatasetExternalCatalogDatasetOptionsParameters(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (map[string]string, error) {
+	if v == nil {
+		return map[string]string{}, nil
+	}
+	m := make(map[string]string)
+	for k, val := range v.(map[string]interface{}) {
+		m[k] = val.(string)
+	}
+	return m, nil
+}
+
+func expandBigQueryDatasetExternalCatalogDatasetOptionsDefaultStorageLocationUri(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
 func expandBigQueryDatasetEffectiveLabels(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (map[string]string, error) {
 	if v == nil {
 		return map[string]string{}, nil

google-beta/services/bigquery/resource_bigquery_dataset_generated_test.go

@@ -451,6 +451,51 @@ resource "google_bigquery_dataset" "dataset" {
 `, context)
 }
 
+func TestAccBigQueryDataset_bigqueryDatasetExternalCatalogDatasetOptionsExample(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.ProtoV5ProviderBetaFactories(t),
+		CheckDestroy:             testAccCheckBigQueryDatasetDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccBigQueryDataset_bigqueryDatasetExternalCatalogDatasetOptionsExample(context),
+			},
+			{
+				ResourceName:            "google_bigquery_dataset.dataset",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"labels", "terraform_labels"},
+			},
+		},
+	})
+}
+
+func testAccBigQueryDataset_bigqueryDatasetExternalCatalogDatasetOptionsExample(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_bigquery_dataset" "dataset" {
+  provider = google-beta
+
+  dataset_id    = "tf_test_example_dataset%{random_suffix}"
+  friendly_name = "test"
+  description   = "This is a test description"
+  location      = "US"
+
+  external_catalog_dataset_options {
+    parameters = {
+      "dataset_owner" = "test_dataset_owner"
+    }
+    default_storage_location_uri = "gs://test_dataset/tables"
+  }
+}
+`, context)
+}
+
 func TestAccBigQueryDataset_bigqueryDatasetResourceTagsExample(t *testing.T) {
 	t.Parallel()
 

google-beta/services/bigquery/resource_bigquery_dataset_test.go

@@ -455,7 +455,39 @@ func TestAccBigQueryDataset_bigqueryDatasetResourceTags_update(t *testing.T) {
 		},
 	})
 }
+func TestAccBigQueryDataset_externalCatalogDatasetOptions_update(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.ProtoV5ProviderBetaFactories(t),
+		CheckDestroy:             testAccCheckBigQueryDatasetDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccBigQueryDataset_externalCatalogDatasetOptions_basic(context),
+			},
+			{
+				ResourceName:            "google_bigquery_dataset.dataset",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"labels", "terraform_labels"},
+			},
+			{
+				Config: testAccBigQueryDataset_externalCatalogDatasetOptions_update(context),
+			},
+			{
+				ResourceName:            "google_bigquery_dataset.dataset",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"labels", "terraform_labels"},
+			},
+		},
+	})
+}
 func testAccAddTable(t *testing.T, datasetID string, tableID string) resource.TestCheckFunc {
 	// Not actually a check, but adds a table independently of terraform
 	return func(s *terraform.State) error {
@@ -866,3 +898,43 @@ resource "google_bigquery_dataset" "dataset" {
 }
 `, context)
 }
+
+func testAccBigQueryDataset_externalCatalogDatasetOptions_basic(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_bigquery_dataset" "dataset" {
+  provider = google-beta
+
+  dataset_id    = "dataset%{random_suffix}"
+  friendly_name = "test"
+  description   = "This is a test description"
+  location      = "US"
+
+  external_catalog_dataset_options {
+    parameters = {
+      "dataset_owner" = "dataset_owner"
+    }
+    default_storage_location_uri = "gs://test_dataset/tables"
+  }
+}
+`, context)
+}
+
+func testAccBigQueryDataset_externalCatalogDatasetOptions_update(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_bigquery_dataset" "dataset" {
+  provider = google-beta
+
+  dataset_id    = "dataset%{random_suffix}"
+  friendly_name = "test"
+  description   = "This is a test description"
+  location      = "US"
+
+  external_catalog_dataset_options {
+    parameters = {
+      "new_dataset_owner" = "new_dataset_owner"
+    }
+    default_storage_location_uri = "gs://new_test_dataset/new_tables"
+  }
+}
+`, context)
+}

website/docs/r/bigquery_dataset.html.markdown

@@ -219,6 +219,31 @@ resource "google_bigquery_dataset" "dataset" {
   }
 }
 ```
+<div class = "oics-button" style="float: right; margin: 0 0 -15px">
+  <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%3Alatest&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md&cloudshell_working_dir=bigquery_dataset_external_catalog_dataset_options&open_in_editor=main.tf" target="_blank">
+    <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
+  </a>
+</div>
+## Example Usage - Bigquery Dataset External Catalog Dataset Options
+
+
+```hcl
+resource "google_bigquery_dataset" "dataset" {
+  provider = google-beta
+
+  dataset_id    = "example_dataset"
+  friendly_name = "test"
+  description   = "This is a test description"
+  location      = "US"
+
+  external_catalog_dataset_options {
+    parameters = {
+      "dataset_owner" = "test_dataset_owner"
+    }
+    default_storage_location_uri = "gs://test_dataset/tables"
+  }
+}
+```
 
 ## Argument Reference
 
@@ -346,6 +371,12 @@ The following arguments are supported:
   to be the short name, for example "Production". See [Tag definitions](/iam/docs/tags-access-control#definitions)
   for more details.
 
+* `external_catalog_dataset_options` -
+  (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html))
+  Options defining open source compatible datasets living in the BigQuery catalog. Contains
+  metadata of open source database, schema or namespace represented by the current dataset.
+  Structure is [documented below](#nested_external_catalog_dataset_options).
+
 * `project` - (Optional) The ID of the project in which the resource belongs.
     If it is not provided, the provider project is used.
 
@@ -489,6 +520,18 @@ destroying the resource will fail if tables are present.
   BigQuery table. The BigQuery Service Account associated with your project requires
   access to this encryption key.
 
+<a name="nested_external_catalog_dataset_options"></a>The `external_catalog_dataset_options` block supports:
+
+* `parameters` -
+  (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html))
+  A map of key value pairs defining the parameters and properties of the open source schema.
+  Maximum size of 2Mib.
+
+* `default_storage_location_uri` -
+  (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html))
+  The storage location URI for all tables in the dataset. Equivalent to hive metastore's
+  database locationUri. Maximum length of 1024 characters.
+
 ## Attributes Reference
 
 In addition to the arguments listed above, the following computed attributes are exported: