Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix bigquery dataset access iam roles with primative equivalent #6307

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/3471.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
bigquery: Fixed error where `google_bigquery_dataset_access` resources could not be found post-creation if role was set to a predefined IAM role with an equivalent primative role (e.g. `roles/bigquery.dataOwner` and `OWNER`)
```
2 changes: 1 addition & 1 deletion google/resource_big_query_dataset.go
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ domain specified will be granted the specified access`,
member of the access object. Primitive, Predefined and custom
roles are supported. Predefined roles that have equivalent
primitive roles are swapped by the API to their Primitive
counterparts, and will show a diff post-create. See
counterparts. See
[official docs](https://cloud.google.com/bigquery/docs/access-control).`,
},
"special_group": {
Expand Down
27 changes: 24 additions & 3 deletions google/resource_big_query_dataset_access.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,19 @@ import (
"google.golang.org/api/googleapi"
)

var bigqueryAccessRoleToPrimitiveMap = map[string]string{
"roles/bigquery.dataOwner": "OWNER",
"roles/bigquery.dataEditor": "WRITER",
"roles/bigquery.dataViewer": "VIEWER",
}

func resourceBigQueryDatasetAccessRoleDiffSuppress(k, old, new string, d *schema.ResourceData) bool {
if primitiveRole, ok := bigqueryAccessRoleToPrimitiveMap[new]; ok {
return primitiveRole == old
}
return false
}

func resourceBigQueryDatasetAccess() *schema.Resource {
return &schema.Resource{
Create: resourceBigQueryDatasetAccessCreate,
Expand Down Expand Up @@ -68,9 +81,10 @@ group, domain, or special group. For example: 'allUsers'`,
ExactlyOneOf: []string{"user_by_email", "group_by_email", "domain", "special_group", "iam_member", "view"},
},
"role": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Type: schema.TypeString,
Optional: true,
ForceNew: true,
DiffSuppressFunc: resourceBigQueryDatasetAccessRoleDiffSuppress,
Description: `Describes the rights granted to the user specified by the other
member of the access object. Primitive, Predefined and custom
roles are supported. Predefined roles that have equivalent
Expand Down Expand Up @@ -396,6 +410,13 @@ func expandNestedBigQueryDatasetAccessDatasetId(v interface{}, d TerraformResour
}

func expandNestedBigQueryDatasetAccessRole(v interface{}, d TerraformResourceData, config *Config) (interface{}, error) {
if v == nil {
return nil, nil
}

if primitiveRole, ok := bigqueryAccessRoleToPrimitiveMap[v.(string)]; ok {
return primitiveRole, nil
}
return v, nil
}

Expand Down
45 changes: 45 additions & 0 deletions google/resource_bigquery_dataset_access_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,37 @@ func TestAccBigQueryDatasetAccess_multiple(t *testing.T) {
})
}

func TestAccBigQueryDatasetAccess_predefinedRole(t *testing.T) {
t.Parallel()

datasetID := fmt.Sprintf("tf_test_%s", randString(t, 10))

expected1 := map[string]interface{}{
"role": "WRITER",
"domain": "google.com",
}

vcrTest(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
Providers: testAccProviders,
Steps: []resource.TestStep{
{
Config: testAccBigQueryDatasetAccess_predefinedRole(datasetID),
Check: resource.ComposeTestCheckFunc(
testAccCheckBigQueryDatasetAccessPresent(t, "google_bigquery_dataset.dataset", expected1),
),
},
{
// Destroy step instead of CheckDestroy so we can check the access is removed without deleting the dataset
Config: testAccBigQueryDatasetAccess_destroy(datasetID, "dataset"),
Check: resource.ComposeTestCheckFunc(
testAccCheckBigQueryDatasetAccessAbsent(t, "google_bigquery_dataset.dataset", expected1),
),
},
},
})
}

func testAccCheckBigQueryDatasetAccessPresent(t *testing.T, n string, expected map[string]interface{}) resource.TestCheckFunc {
return testAccCheckBigQueryDatasetAccess(t, n, expected, true)
}
Expand Down Expand Up @@ -224,3 +255,17 @@ resource "google_bigquery_dataset" "dataset" {
}
`, datasetID)
}

func testAccBigQueryDatasetAccess_predefinedRole(datasetID string) string {
return fmt.Sprintf(`
resource "google_bigquery_dataset_access" "access" {
dataset_id = google_bigquery_dataset.dataset.dataset_id
role = "roles/bigquery.dataEditor"
domain = "google.com"
}

resource "google_bigquery_dataset" "dataset" {
dataset_id = "%s"
}
`, datasetID)
}
2 changes: 1 addition & 1 deletion website/docs/r/bigquery_dataset.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ The `access` block supports:
member of the access object. Primitive, Predefined and custom
roles are supported. Predefined roles that have equivalent
primitive roles are swapped by the API to their Primitive
counterparts, and will show a diff post-create. See
counterparts. See
[official docs](https://cloud.google.com/bigquery/docs/access-control).

* `special_group` -
Expand Down