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.

Sign up for GitHub

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

Jump to bottom

validate permission levels relative to the object #706

Merged
merged 4 commits into from
Jul 6, 2021
Merged

validate permission levels relative to the object #706

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aef3814
validate permission levels relative to the object
psg2 Jul 1, 2021
473a467
fix permission tests
psg2 Jul 1, 2021
2ecac3b
refactor to use permissionsIDFieldMapping
psg2 Jul 2, 2021
2b35aa5
Merge branch 'master' into add-validation-for-permission-levels
nfx Jul 6, 2021
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
65 changes: 50 additions & 15 deletions access/resource_permissions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"github.com/databrickslabs/terraform-provider-databricks/workspace"
"github.com/hashicorp/go-cty/cty"
"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/customdiff"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/pkg/errors"
)
Expand Down Expand Up @@ -211,6 +212,8 @@ func (a PermissionsAPI) Read(objectID string) (objectACL ObjectACL, err error) {
type permissionsIDFieldMapping struct {
field, objectType, resourceType string

allowedPermissionLevels []string

idRetriever func(client *common.DatabricksClient, id string) (string, error)
}

Expand All @@ -227,20 +230,20 @@ func permissionsResourceIDFields(ctx context.Context) []permissionsIDFieldMappin
return strconv.FormatInt(info.ObjectID, 10), nil
}
return []permissionsIDFieldMapping{
{"cluster_policy_id", "cluster-policy", "cluster-policies", SIMPLE},
{"instance_pool_id", "instance-pool", "instance-pools", SIMPLE},
{"cluster_id", "cluster", "clusters", SIMPLE},
{"job_id", "job", "jobs", SIMPLE},
{"notebook_id", "notebook", "notebooks", SIMPLE},
{"notebook_path", "notebook", "notebooks", PATH},
{"directory_id", "directory", "directories", SIMPLE},
{"directory_path", "directory", "directories", PATH},
{"authorization", "tokens", "authorization", SIMPLE},
{"authorization", "passwords", "authorization", SIMPLE},
{"sql_endpoint_id", "endpoints", "sql/endpoints", SIMPLE},
{"sql_dashboard_id", "dashboard", "sql/dashboards", SIMPLE},
{"sql_alert_id", "alert", "sql/alerts", SIMPLE},
{"sql_query_id", "query", "sql/queries", SIMPLE},
{"cluster_policy_id", "cluster-policy", "cluster-policies", []string{"CAN_USE"}, SIMPLE},
{"instance_pool_id", "instance-pool", "instance-pools", []string{"CAN_ATTACH_TO", "CAN_MANAGE"}, SIMPLE},
{"cluster_id", "cluster", "clusters", []string{"CAN_ATTACH_TO", "CAN_RESTART", "CAN_MANAGE"}, SIMPLE},
{"job_id", "job", "jobs", []string{"CAN_VIEW", "CAN_MANAGE_RUN", "IS_OWNER", "CAN_MANAGE"}, SIMPLE},
{"notebook_id", "notebook", "notebooks", []string{"CAN_READ", "CAN_RUN", "CAN_EDIT", "CAN_MANAGE"}, SIMPLE},
{"notebook_path", "notebook", "notebooks", []string{"CAN_READ", "CAN_RUN", "CAN_EDIT", "CAN_MANAGE"}, PATH},
{"directory_id", "directory", "directories", []string{"CAN_READ", "CAN_RUN", "CAN_EDIT", "CAN_MANAGE"}, SIMPLE},
{"directory_path", "directory", "directories", []string{"CAN_READ", "CAN_RUN", "CAN_EDIT", "CAN_MANAGE"}, PATH},
{"authorization", "tokens", "authorization", []string{"CAN_USE"}, SIMPLE},
{"authorization", "passwords", "authorization", []string{"CAN_USE"}, SIMPLE},
{"sql_endpoint_id", "endpoints", "sql/endpoints", []string{"CAN_USE", "CAN_MANAGE"}, SIMPLE},
{"sql_dashboard_id", "dashboard", "sql/dashboards", []string{"CAN_USE", "CAN_MANAGE"}, SIMPLE},
{"sql_alert_id", "alert", "sql/alerts", []string{"CAN_USE", "CAN_MANAGE"}, SIMPLE},
{"sql_query_id", "query", "sql/queries", []string{"CAN_USE", "CAN_MANAGE"}, SIMPLE},
}
}

Expand Down Expand Up @@ -286,6 +289,15 @@ func (oa *ObjectACL) ToPermissionsEntity(ctx context.Context, d *schema.Resource
return entity, fmt.Errorf("unknown object type %s", oa.ObjectType)
}

func stringInSlice(a string, list []string) bool {
for _, b := range list {
if b == a {
return true
}
}
return false
}

// ResourcePermissions definition
func ResourcePermissions() *schema.Resource {
s := common.StructToSchema(PermissionsEntity{}, func(s map[string]*schema.Schema) map[string]*schema.Schema {
Expand Down Expand Up @@ -353,7 +365,30 @@ func ResourcePermissions() *schema.Resource {
return nil
}
return &schema.Resource{
Schema: s,
Schema: s,
CustomizeDiff: customdiff.Sequence(
func(ctx context.Context, diff *schema.ResourceDiff, v interface{}) error {
// Plan time validation for object permission levels
for _, mapping := range permissionsResourceIDFields(ctx) {
if _, ok := diff.GetOk(mapping.field); !ok {
continue
}

access_control_list := diff.Get("access_control").(*schema.Set).List()
for _, access_control := range access_control_list {
m := access_control.(map[string]interface{})

permission_level := m["permission_level"].(string)

if !stringInSlice(permission_level, mapping.allowedPermissionLevels) {
return fmt.Errorf(`permission_level %s is not supported with %s objects`, permission_level, mapping.field)
}
}
}

return nil
},
),
ReadContext: readContext,
CreateContext: func(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
var entity PermissionsEntity
Expand Down
40 changes: 20 additions & 20 deletions access/resource_permissions_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ func TestResourcePermissionsCreate(t *testing.T) {
AccessControlList: []AccessControlChange{
{
UserName: TestingUser,
PermissionLevel: "CAN_READ",
PermissionLevel: "CAN_ATTACH_TO",
},
},
},
Expand All @@ -384,7 +384,7 @@ func TestResourcePermissionsCreate(t *testing.T) {
UserName: TestingUser,
AllPermissions: []Permission{
{
PermissionLevel: "CAN_READ",
PermissionLevel: "CAN_ATTACH_TO",
Inherited: false,
},
},
Expand Down Expand Up @@ -415,7 +415,7 @@ func TestResourcePermissionsCreate(t *testing.T) {
"access_control": []interface{}{
map[string]interface{}{
"user_name": TestingUser,
"permission_level": "CAN_READ",
"permission_level": "CAN_ATTACH_TO",
},
},
},
Expand All @@ -426,7 +426,7 @@ func TestResourcePermissionsCreate(t *testing.T) {
require.Equal(t, 1, len(ac.List()))
firstElem := ac.List()[0].(map[string]interface{})
assert.Equal(t, TestingUser, firstElem["user_name"])
assert.Equal(t, "CAN_READ", firstElem["permission_level"])
assert.Equal(t, "CAN_ATTACH_TO", firstElem["permission_level"])
}

func TestResourcePermissionsCreate_SQLA_Asset(t *testing.T) {
Expand All @@ -439,7 +439,7 @@ func TestResourcePermissionsCreate_SQLA_Asset(t *testing.T) {
AccessControlList: []AccessControlChange{
{
UserName: TestingUser,
PermissionLevel: "CAN_READ",
PermissionLevel: "CAN_USE",
},
{
UserName: TestingAdminUser,
Expand All @@ -457,7 +457,7 @@ func TestResourcePermissionsCreate_SQLA_Asset(t *testing.T) {
AccessControlList: []AccessControl{
{
UserName: TestingUser,
PermissionLevel: "CAN_READ",
PermissionLevel: "CAN_USE",
},
{
UserName: TestingAdminUser,
Expand All @@ -481,7 +481,7 @@ func TestResourcePermissionsCreate_SQLA_Asset(t *testing.T) {
"access_control": []interface{}{
map[string]interface{}{
"user_name": TestingUser,
"permission_level": "CAN_READ",
"permission_level": "CAN_USE",
},
},
},
Expand All @@ -492,7 +492,7 @@ func TestResourcePermissionsCreate_SQLA_Asset(t *testing.T) {
require.Equal(t, 1, len(ac.List()))
firstElem := ac.List()[0].(map[string]interface{})
assert.Equal(t, TestingUser, firstElem["user_name"])
assert.Equal(t, "CAN_READ", firstElem["permission_level"])
assert.Equal(t, "CAN_USE", firstElem["permission_level"])
}

func TestResourcePermissionsCreate_SQLA_Endpoint(t *testing.T) {
Expand All @@ -505,7 +505,7 @@ func TestResourcePermissionsCreate_SQLA_Endpoint(t *testing.T) {
AccessControlList: []AccessControlChange{
{
UserName: TestingUser,
PermissionLevel: "CAN_READ",
PermissionLevel: "CAN_USE",
},
{
UserName: TestingAdminUser,
Expand All @@ -523,7 +523,7 @@ func TestResourcePermissionsCreate_SQLA_Endpoint(t *testing.T) {
AccessControlList: []AccessControl{
{
UserName: TestingUser,
PermissionLevel: "CAN_READ",
PermissionLevel: "CAN_USE",
},
{
UserName: TestingAdminUser,
Expand All @@ -547,7 +547,7 @@ func TestResourcePermissionsCreate_SQLA_Endpoint(t *testing.T) {
"access_control": []interface{}{
map[string]interface{}{
"user_name": TestingUser,
"permission_level": "CAN_READ",
"permission_level": "CAN_USE",
},
},
},
Expand All @@ -558,7 +558,7 @@ func TestResourcePermissionsCreate_SQLA_Endpoint(t *testing.T) {
require.Equal(t, 1, len(ac.List()))
firstElem := ac.List()[0].(map[string]interface{})
assert.Equal(t, TestingUser, firstElem["user_name"])
assert.Equal(t, "CAN_READ", firstElem["permission_level"])
assert.Equal(t, "CAN_USE", firstElem["permission_level"])
}

func TestResourcePermissionsCreate_NotebookPath_NotExists(t *testing.T) {
Expand Down Expand Up @@ -608,7 +608,7 @@ func TestResourcePermissionsCreate_NotebookPath(t *testing.T) {
AccessControlList: []AccessControlChange{
{
UserName: TestingUser,
PermissionLevel: "CAN_USE",
PermissionLevel: "CAN_READ",
},
},
},
Expand All @@ -624,7 +624,7 @@ func TestResourcePermissionsCreate_NotebookPath(t *testing.T) {
UserName: TestingUser,
AllPermissions: []Permission{
{
PermissionLevel: "CAN_USE",
PermissionLevel: "CAN_READ",
Inherited: false,
},
},
Expand Down Expand Up @@ -655,7 +655,7 @@ func TestResourcePermissionsCreate_NotebookPath(t *testing.T) {
"access_control": []interface{}{
map[string]interface{}{
"user_name": TestingUser,
"permission_level": "CAN_USE",
"permission_level": "CAN_READ",
},
},
},
Expand All @@ -667,7 +667,7 @@ func TestResourcePermissionsCreate_NotebookPath(t *testing.T) {
require.Equal(t, 1, len(ac.List()))
firstElem := ac.List()[0].(map[string]interface{})
assert.Equal(t, TestingUser, firstElem["user_name"])
assert.Equal(t, "CAN_USE", firstElem["permission_level"])
assert.Equal(t, "CAN_READ", firstElem["permission_level"])
}

func TestResourcePermissionsCreate_error(t *testing.T) {
Expand Down Expand Up @@ -716,7 +716,7 @@ func TestResourcePermissionsUpdate(t *testing.T) {
UserName: TestingUser,
AllPermissions: []Permission{
{
PermissionLevel: "CAN_RUN",
PermissionLevel: "CAN_VIEW",
Inherited: false,
},
},
Expand Down Expand Up @@ -748,7 +748,7 @@ func TestResourcePermissionsUpdate(t *testing.T) {
AccessControlList: []AccessControlChange{
{
UserName: TestingUser,
PermissionLevel: "CAN_RUN",
PermissionLevel: "CAN_VIEW",
},
{
UserName: TestingAdminUser,
Expand All @@ -763,7 +763,7 @@ func TestResourcePermissionsUpdate(t *testing.T) {

access_control {
user_name = "ben"
permission_level = "CAN_RUN"
permission_level = "CAN_VIEW"
}
`,
Resource: ResourcePermissions(),
Expand All @@ -776,7 +776,7 @@ func TestResourcePermissionsUpdate(t *testing.T) {
require.Equal(t, 1, len(ac.List()))
firstElem := ac.List()[0].(map[string]interface{})
assert.Equal(t, TestingUser, firstElem["user_name"])
assert.Equal(t, "CAN_RUN", firstElem["permission_level"])
assert.Equal(t, "CAN_VIEW", firstElem["permission_level"])
}

func permissionsTestHelper(t *testing.T,
Expand Down