improve big query job error messages (#12157) (#8542)

[upstream:9323d5fb8acdf32fb92f08e21af26cb0e2d1feb2]

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

Author: modular-magician

.changelog/12157.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+bigquery: added descriptive validation errors for missing required fields in `google_bigquery_job` destination table configuration
+```

google-beta/services/bigquery/resource_bigquery_job.go

@@ -2331,6 +2331,20 @@ func expandBigQueryJobConfigurationQueryDestinationTable(v interface{}, d tpgres
 		transformed["tableId"] = parts[3]
 	}
 
+	configError := "Invalid BigQuery job destination_table configuration. You must either:\n" +
+		"1. Set all of project_id, dataset_id, and table_id separately, or\n" +
+		"2. Provide table_id in the form 'projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}}'"
+
+	// Validate required fields
+	if projectId, ok := transformed["projectId"]; !ok || projectId == nil ||
+		reflect.ValueOf(projectId).IsZero() {
+		return nil, fmt.Errorf("%s\nMissing or empty projectId", configError)
+	}
+
+	if datasetId, ok := transformed["datasetId"]; !ok || datasetId == nil ||
+		reflect.ValueOf(datasetId).IsZero() {
+		return nil, fmt.Errorf("%s\nMissing or empty datasetId", configError)
+	}
 	return transformed, nil
 }
 
@@ -2714,6 +2728,20 @@ func expandBigQueryJobConfigurationLoadDestinationTable(v interface{}, d tpgreso
 		transformed["tableId"] = parts[3]
 	}
 
+	configError := "Invalid BigQuery job destination_table configuration. You must either:\n" +
+		"1. Set all of project_id, dataset_id, and table_id separately, or\n" +
+		"2. Provide table_id in the form 'projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}}'"
+
+	// Validate required fields
+	if projectId, ok := transformed["projectId"]; !ok || projectId == nil ||
+		reflect.ValueOf(projectId).IsZero() {
+		return nil, fmt.Errorf("%s\nMissing or empty projectId", configError)
+	}
+
+	if datasetId, ok := transformed["datasetId"]; !ok || datasetId == nil ||
+		reflect.ValueOf(datasetId).IsZero() {
+		return nil, fmt.Errorf("%s\nMissing or empty datasetId", configError)
+	}
 	return transformed, nil
 }
 
@@ -3008,6 +3036,20 @@ func expandBigQueryJobConfigurationCopyDestinationTable(v interface{}, d tpgreso
 		transformed["tableId"] = parts[3]
 	}
 
+	configError := "Invalid BigQuery job destination_table configuration. You must either:\n" +
+		"1. Set all of project_id, dataset_id, and table_id separately, or\n" +
+		"2. Provide table_id in the form 'projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}}'"
+
+	// Validate required fields
+	if projectId, ok := transformed["projectId"]; !ok || projectId == nil ||
+		reflect.ValueOf(projectId).IsZero() {
+		return nil, fmt.Errorf("%s\nMissing or empty projectId", configError)
+	}
+
+	if datasetId, ok := transformed["datasetId"]; !ok || datasetId == nil ||
+		reflect.ValueOf(datasetId).IsZero() {
+		return nil, fmt.Errorf("%s\nMissing or empty datasetId", configError)
+	}
 	return transformed, nil
 }
 
@@ -3175,6 +3217,20 @@ func expandBigQueryJobConfigurationExtractSourceTable(v interface{}, d tpgresour
 		transformed["tableId"] = parts[3]
 	}
 
+	configError := "Invalid BigQuery job destination_table configuration. You must either:\n" +
+		"1. Set all of project_id, dataset_id, and table_id separately, or\n" +
+		"2. Provide table_id in the form 'projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}}'"
+
+	// Validate required fields
+	if projectId, ok := transformed["projectId"]; !ok || projectId == nil ||
+		reflect.ValueOf(projectId).IsZero() {
+		return nil, fmt.Errorf("%s\nMissing or empty projectId", configError)
+	}
+
+	if datasetId, ok := transformed["datasetId"]; !ok || datasetId == nil ||
+		reflect.ValueOf(datasetId).IsZero() {
+		return nil, fmt.Errorf("%s\nMissing or empty datasetId", configError)
+	}
 	return transformed, nil
 }
 

google-beta/services/bigquery/resource_bigquery_job_test.go

@@ -4,6 +4,7 @@ package bigquery_test
 
 import (
 	"fmt"
+	"regexp"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
@@ -83,3 +84,64 @@ resource "google_bigquery_job" "job" {
 }
 `, context)
 }
+
+func TestAccBigQueryJob_validationErrors(t *testing.T) {
+	t.Parallel()
+	context := map[string]interface{}{
+		"random_suffix": acctest.RandString(t, 10),
+		"project":       envvar.GetTestProjectFromEnv(),
+	}
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccBigQueryJob_missingProjectId(context),
+				ExpectError: regexp.MustCompile(
+					`(?s)Invalid BigQuery job destination_table configuration\. You must either:.*Missing or empty projectId`,
+				),
+			},
+			{
+				Config: testAccBigQueryJob_missingDatasetId(context),
+				ExpectError: regexp.MustCompile(
+					`(?s)Invalid BigQuery job destination_table configuration\. You must either:.*Missing or empty datasetId`,
+				),
+			},
+		},
+	})
+}
+
+func testAccBigQueryJob_missingProjectId(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_bigquery_job" "job" {
+  job_id     = "tf-test-job-%{random_suffix}"
+
+  query {
+    query = "SELECT state FROM [lookerdata:cdc.project_tycho_reports]"
+    destination_table {
+      dataset_id = "example_dataset"
+      table_id   = "example_table"
+      # project_id intentionally omitted
+    }
+  }
+}
+`, context)
+}
+
+func testAccBigQueryJob_missingDatasetId(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_bigquery_job" "job" {
+  job_id     = "tf-test-job-%{random_suffix}"
+
+  query {
+    query = "SELECT state FROM [lookerdata:cdc.project_tycho_reports]"
+    destination_table {
+      project_id = "%{project}"
+      table_id   = "example_table"
+      # dataset_id intentionally omitted
+    }
+  }
+}
+`, context)
+}