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

Bigquery dataset iam #6553

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
9 changes: 9 additions & 0 deletions .changelog/3608.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
```release-note:new-resource
`google_bigquery_dataset_iam_binding`
```
```release-note:new-resource
`google_bigquery_dataset_iam_member`
```
```release-note:new-resource
`google_bigquery_dataset_iam_policy`
```
236 changes: 236 additions & 0 deletions google/iam_bigquery_dataset.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,236 @@
package google

import (
"errors"
"fmt"
"strings"

"github.com/hashicorp/errwrap"
"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
"google.golang.org/api/cloudresourcemanager/v1"
)

var IamBigqueryDatasetSchema = map[string]*schema.Schema{
"dataset_id": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
},
"project": {
Type: schema.TypeString,
Optional: true,
Computed: true,
ForceNew: true,
},
}

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

type BigqueryDatasetIamUpdater struct {
project string
datasetId string
Config *Config
}

func NewBigqueryDatasetIamUpdater(d *schema.ResourceData, config *Config) (ResourceIamUpdater, error) {
project, err := getProject(d, config)
if err != nil {
return nil, err
}

d.Set("project", project)

return &BigqueryDatasetIamUpdater{
project: project,
datasetId: d.Get("dataset_id").(string),
Config: config,
}, nil
}

func BigqueryDatasetIdParseFunc(d *schema.ResourceData, config *Config) error {
fv, err := parseProjectFieldValue("datasets", d.Id(), "project", d, config, false)
if err != nil {
return err
}

d.Set("project", fv.Project)
d.Set("dataset_id", fv.Name)

// Explicitly set the id so imported resources have the same ID format as non-imported ones.
d.SetId(fv.RelativeLink())
return nil
}

func (u *BigqueryDatasetIamUpdater) GetResourceIamPolicy() (*cloudresourcemanager.Policy, error) {
url := fmt.Sprintf("%s%s", u.Config.BigQueryBasePath, u.GetResourceId())

res, err := sendRequest(u.Config, "GET", u.project, url, nil)
if err != nil {
return nil, errwrap.Wrapf(fmt.Sprintf("Error retrieving IAM policy for %s: {{err}}", u.DescribeResource()), err)
}

policy, err := accessToPolicy(res["access"])
if err != nil {
return nil, err
}
return policy, nil
}

func (u *BigqueryDatasetIamUpdater) SetResourceIamPolicy(policy *cloudresourcemanager.Policy) error {
url := fmt.Sprintf("%s%s", u.Config.BigQueryBasePath, u.GetResourceId())

access, err := policyToAccess(policy)
if err != nil {
return err
}
obj := map[string]interface{}{
"access": access,
}

_, err = sendRequest(u.Config, "PATCH", u.project, url, obj)
if err != nil {
return fmt.Errorf("Error creating DatasetAccess: %s", err)
}

return nil
}

func accessToPolicy(access interface{}) (*cloudresourcemanager.Policy, error) {
if access == nil {
return nil, nil
}
roleToBinding := make(map[string]*cloudresourcemanager.Binding)

accessArr := access.([]interface{})
for _, v := range accessArr {
memberRole := v.(map[string]interface{})
rawRole, ok := memberRole["role"]
if !ok {
// "view" allows role to not be defined. It is a special dataset access construct, so ignore
// If a user wants to manage "view" access they should use the `bigquery_dataset_access` resource
continue
}
role := rawRole.(string)
if iamRole, ok := bigqueryAccessPrimitiveToRoleMap[role]; ok {
// API changes certain IAM roles to legacy roles. Revert these changes
role = iamRole
}
member, err := accessToIamMember(memberRole)
if err != nil {
return nil, err
}
// We have to combine bindings manually
binding, ok := roleToBinding[role]
if !ok {
binding = &cloudresourcemanager.Binding{Role: role, Members: []string{}}
}
binding.Members = append(binding.Members, member)

roleToBinding[role] = binding
}
bindings := make([]*cloudresourcemanager.Binding, 0)
for _, v := range roleToBinding {
bindings = append(bindings, v)
}

return &cloudresourcemanager.Policy{Bindings: bindings}, nil
}

func policyToAccess(policy *cloudresourcemanager.Policy) ([]map[string]interface{}, error) {
res := make([]map[string]interface{}, 0)
if len(policy.AuditConfigs) != 0 {
return nil, errors.New("Access policies not allowed on BigQuery Dataset IAM policies")
}
for _, binding := range policy.Bindings {
if binding.Condition != nil {
return nil, errors.New("IAM conditions not allowed on BigQuery Dataset IAM")
}
if fullRole, ok := bigqueryAccessPrimitiveToRoleMap[binding.Role]; ok {
return nil, fmt.Errorf("BigQuery Dataset legacy role %s is not allowed when using google_bigquery_dataset_iam resources. Please use the full form: %s", binding.Role, fullRole)
}
for _, member := range binding.Members {
access := map[string]interface{}{
"role": binding.Role,
}
memberType, member, err := iamMemberToAccess(member)
if err != nil {
return nil, err
}
access[memberType] = member
res = append(res, access)
}
}

return res, nil
}

// Returns the member access type and member for an IAM member.
// Dataset access uses different member types to identify groups, domains, etc.
// these types are used as keys in the access JSON payload
func iamMemberToAccess(member string) (string, string, error) {
pieces := strings.SplitN(member, ":", 2)
if len(pieces) > 1 {
switch pieces[0] {
case "group":
return "groupByEmail", pieces[1], nil
case "domain":
return "domain", pieces[1], nil
case "user":
return "userByEmail", pieces[1], nil
case "serviceAccount":
return "userByEmail", pieces[1], nil
default:
return "", "", fmt.Errorf("Failed to parse BigQuery Dataset IAM member type: %s", member)
}
}
if member == "projectOwners" || member == "projectReaders" || member == "projectWriters" || member == "allAuthenticatedUsers" {
// These are special BigQuery Dataset permissions
return "specialGroup", member, nil
}
return "iamMember", member, nil
}

func accessToIamMember(access map[string]interface{}) (string, error) {
// One of the fields must be set, we have to find which IAM member type this maps to
if member, ok := access["groupByEmail"]; ok {
return fmt.Sprintf("group:%s", member.(string)), nil
}
if member, ok := access["domain"]; ok {
return fmt.Sprintf("domain:%s", member.(string)), nil
}
if member, ok := access["specialGroup"]; ok {
return member.(string), nil
}
if member, ok := access["iamMember"]; ok {
return member.(string), nil
}
if _, ok := access["view"]; ok {
// view does not map to an IAM member, use access instead
return "", fmt.Errorf("Failed to convert BigQuery Dataset access to IAM member. To use views with a dataset, please use dataset_access")
}
if member, ok := access["userByEmail"]; ok {
// service accounts have "gservice" in their email. This is best guess due to lost information
if strings.Contains(member.(string), "gserviceaccount") {
return fmt.Sprintf("serviceAccount:%s", member.(string)), nil
}
return fmt.Sprintf("user:%s", member.(string)), nil
}
return "", fmt.Errorf("Failed to identify IAM member from BigQuery Dataset access: %v", access)
}

func (u *BigqueryDatasetIamUpdater) GetResourceId() string {
return fmt.Sprintf("projects/%s/datasets/%s", u.project, u.datasetId)
}

// Matches the mutex of google_big_query_dataset_access
func (u *BigqueryDatasetIamUpdater) GetMutexKey() string {
return fmt.Sprintf("%s", u.datasetId)
}

func (u *BigqueryDatasetIamUpdater) DescribeResource() string {
return fmt.Sprintf("Bigquery Dataset %s/%s", u.project, u.datasetId)
}
3 changes: 3 additions & 0 deletions google/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -785,6 +785,9 @@ func ResourceMapWithErrors() (map[string]*schema.Resource, error) {
"google_bigtable_instance_iam_member": ResourceIamMember(IamBigtableInstanceSchema, NewBigtableInstanceUpdater, BigtableInstanceIdParseFunc),
"google_bigtable_instance_iam_policy": ResourceIamPolicy(IamBigtableInstanceSchema, NewBigtableInstanceUpdater, BigtableInstanceIdParseFunc),
"google_bigtable_table": resourceBigtableTable(),
"google_bigquery_dataset_iam_binding": ResourceIamBinding(IamBigqueryDatasetSchema, NewBigqueryDatasetIamUpdater, BigqueryDatasetIdParseFunc),
"google_bigquery_dataset_iam_member": ResourceIamMember(IamBigqueryDatasetSchema, NewBigqueryDatasetIamUpdater, BigqueryDatasetIdParseFunc),
"google_bigquery_dataset_iam_policy": ResourceIamPolicy(IamBigqueryDatasetSchema, NewBigqueryDatasetIamUpdater, BigqueryDatasetIdParseFunc),
"google_billing_account_iam_binding": ResourceIamBinding(IamBillingAccountSchema, NewBillingAccountIamUpdater, BillingAccountIdParseFunc),
"google_billing_account_iam_member": ResourceIamMember(IamBillingAccountSchema, NewBillingAccountIamUpdater, BillingAccountIdParseFunc),
"google_billing_account_iam_policy": ResourceIamPolicy(IamBillingAccountSchema, NewBillingAccountIamUpdater, BillingAccountIdParseFunc),
Expand Down
62 changes: 62 additions & 0 deletions google/resource_bigquery_dataset_iam_member_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
package google

import (
"fmt"
"testing"

"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
)

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

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

expected := map[string]interface{}{
"role": "roles/viewer",
"userByEmail": fmt.Sprintf("%s@%s.iam.gserviceaccount.com", saID, getTestProjectFromEnv()),
}

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

func testAccBigqueryDatasetIamMember_destroy(datasetID, rs string) string {
return fmt.Sprintf(`
resource "google_bigquery_dataset" "%s" {
dataset_id = "%s"
}
`, rs, datasetID)
}

func testAccBigqueryDatasetIamMember_basic(datasetID, saID string) string {
return fmt.Sprintf(`
resource "google_bigquery_dataset_iam_member" "access" {
dataset_id = google_bigquery_dataset.dataset.dataset_id
role = "roles/viewer"
member = "serviceAccount:${google_service_account.bqviewer.email}"
}

resource "google_bigquery_dataset" "dataset" {
dataset_id = "%s"
}

resource "google_service_account" "bqviewer" {
account_id = "%s"
}
`, datasetID, saID)
}
Loading