Skip to content

Add jsonschema for JobPermission #2642

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

Closed
kanterov wants to merge 1 commit into from
Closed

Add jsonschema for JobPermission #2642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
74 changes: 59 additions & 15 deletions bundle/config/mutator/resourcemutator/apply_bundle_permissions_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,38 @@ func TestApplyBundlePermissions(t *testing.T) {
require.NoError(t, diags.Error())

require.Len(t, b.Config.Resources.Jobs["job_1"].Permissions, 3)
require.Contains(t, b.Config.Resources.Jobs["job_1"].Permissions, resources.Permission{Level: "CAN_MANAGE", UserName: "TestUser"})
require.Contains(t, b.Config.Resources.Jobs["job_1"].Permissions, resources.Permission{Level: "CAN_VIEW", GroupName: "TestGroup"})
require.Contains(t, b.Config.Resources.Jobs["job_1"].Permissions, resources.Permission{Level: "CAN_MANAGE_RUN", ServicePrincipalName: "TestServicePrincipal"})
require.Contains(
t,
b.Config.Resources.Jobs["job_1"].Permissions,
resources.JobPermission{Level: resources.JobPermissionLevelCanManage, UserName: "TestUser"},
)
require.Contains(
t,
b.Config.Resources.Jobs["job_1"].Permissions,
resources.JobPermission{Level: resources.JobPermissionLevelCanView, GroupName: "TestGroup"},
)
require.Contains(
t,
b.Config.Resources.Jobs["job_1"].Permissions,
resources.JobPermission{Level: resources.JobPermissionLevelCanManageRun, ServicePrincipalName: "TestServicePrincipal"},
)

require.Len(t, b.Config.Resources.Jobs["job_2"].Permissions, 3)
require.Contains(t, b.Config.Resources.Jobs["job_2"].Permissions, resources.Permission{Level: "CAN_MANAGE", UserName: "TestUser"})
require.Contains(t, b.Config.Resources.Jobs["job_2"].Permissions, resources.Permission{Level: "CAN_VIEW", GroupName: "TestGroup"})
require.Contains(t, b.Config.Resources.Jobs["job_2"].Permissions, resources.Permission{Level: "CAN_MANAGE_RUN", ServicePrincipalName: "TestServicePrincipal"})
require.Contains(
t,
b.Config.Resources.Jobs["job_2"].Permissions,
resources.JobPermission{Level: resources.JobPermissionLevelCanManage, UserName: "TestUser"},
)
require.Contains(
t,
b.Config.Resources.Jobs["job_2"].Permissions,
resources.JobPermission{Level: resources.JobPermissionLevelCanView, GroupName: "TestGroup"},
)
require.Contains(
t,
b.Config.Resources.Jobs["job_2"].Permissions,
resources.JobPermission{Level: resources.JobPermissionLevelCanManageRun, ServicePrincipalName: "TestServicePrincipal"},
)

require.Len(t, b.Config.Resources.Pipelines["pipeline_1"].Permissions, 3)
require.Contains(t, b.Config.Resources.Pipelines["pipeline_1"].Permissions, resources.Permission{Level: "CAN_MANAGE", UserName: "TestUser"})
Expand Down Expand Up @@ -142,16 +166,16 @@ func TestWarningOnOverlapPermission(t *testing.T) {
JobSettings: &jobs.JobSettings{
Name: "job_1",
},
Permissions: []resources.Permission{
{Level: permissions.CAN_VIEW, UserName: "TestUser"},
Permissions: []resources.JobPermission{
{Level: resources.JobPermissionLevelCanView, UserName: "TestUser"},
},
},
"job_2": {
JobSettings: &jobs.JobSettings{
Name: "job_2",
},
Permissions: []resources.Permission{
{Level: permissions.CAN_VIEW, UserName: "TestUser2"},
Permissions: []resources.JobPermission{
{Level: resources.JobPermissionLevelCanView, UserName: "TestUser2"},
},
},
},
Expand All @@ -162,11 +186,31 @@ func TestWarningOnOverlapPermission(t *testing.T) {
diags := bundle.Apply(context.Background(), b, ApplyBundlePermissions())
require.NoError(t, diags.Error())

require.Contains(t, b.Config.Resources.Jobs["job_1"].Permissions, resources.Permission{Level: "CAN_VIEW", UserName: "TestUser"})
require.Contains(t, b.Config.Resources.Jobs["job_1"].Permissions, resources.Permission{Level: "CAN_VIEW", GroupName: "TestGroup"})
require.Contains(t, b.Config.Resources.Jobs["job_2"].Permissions, resources.Permission{Level: "CAN_VIEW", UserName: "TestUser2"})
require.Contains(t, b.Config.Resources.Jobs["job_2"].Permissions, resources.Permission{Level: "CAN_MANAGE", UserName: "TestUser"})
require.Contains(t, b.Config.Resources.Jobs["job_2"].Permissions, resources.Permission{Level: "CAN_VIEW", GroupName: "TestGroup"})
require.Contains(
t,
b.Config.Resources.Jobs["job_1"].Permissions,
resources.JobPermission{Level: resources.JobPermissionLevelCanView, UserName: "TestUser"},
)
require.Contains(
t,
b.Config.Resources.Jobs["job_1"].Permissions,
resources.JobPermission{Level: resources.JobPermissionLevelCanView, GroupName: "TestGroup"},
)
require.Contains(
t,
b.Config.Resources.Jobs["job_2"].Permissions,
resources.JobPermission{Level: resources.JobPermissionLevelCanView, UserName: "TestUser2"},
)
require.Contains(
t,
b.Config.Resources.Jobs["job_2"].Permissions,
resources.JobPermission{Level: resources.JobPermissionLevelCanManage, UserName: "TestUser"},
)
require.Contains(
t,
b.Config.Resources.Jobs["job_2"].Permissions,
resources.JobPermission{Level: resources.JobPermissionLevelCanView, GroupName: "TestGroup"},
)
}

func TestAllResourcesExplicitlyDefinedForPermissionsSupport(t *testing.T) {
Expand Down
41 changes: 31 additions & 10 deletions bundle/config/mutator/resourcemutator/filter_current_user_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,28 @@ var robot = resources.Permission{
ServicePrincipalName: "i-Robot",
}

var jobAlice = resources.JobPermission{
Level: resources.JobPermissionLevelCanManage,
UserName: "alice@databricks.com",
}

var jobBob = resources.JobPermission{
Level: resources.JobPermissionLevelCanView,
UserName: "bob@databricks.com",
}

var jobRobot = resources.JobPermission{
Level: resources.JobPermissionLevelCanManageRun,
ServicePrincipalName: "i-Robot",
}

func testFixture(userName string) *bundle.Bundle {
jobPermissions := []resources.JobPermission{
jobAlice,
jobBob,
jobRobot,
}

p := []resources.Permission{
alice,
bob,
Expand All @@ -51,13 +72,13 @@ func testFixture(userName string) *bundle.Bundle {
JobSettings: &jobs.JobSettings{
Name: "job1",
},
Permissions: p,
Permissions: jobPermissions,
},
"job2": {
JobSettings: &jobs.JobSettings{
Name: "job2",
},
Permissions: p,
Permissions: jobPermissions,
},
},
Pipelines: map[string]*resources.Pipeline{
Expand Down Expand Up @@ -102,12 +123,12 @@ func TestFilterCurrentUser(t *testing.T) {

// Assert current user is filtered out.
assert.Len(t, b.Config.Resources.Jobs["job1"].Permissions, 2)
assert.Contains(t, b.Config.Resources.Jobs["job1"].Permissions, robot)
assert.Contains(t, b.Config.Resources.Jobs["job1"].Permissions, bob)
assert.Contains(t, b.Config.Resources.Jobs["job1"].Permissions, jobRobot)
assert.Contains(t, b.Config.Resources.Jobs["job1"].Permissions, jobBob)

assert.Len(t, b.Config.Resources.Jobs["job2"].Permissions, 2)
assert.Contains(t, b.Config.Resources.Jobs["job2"].Permissions, robot)
assert.Contains(t, b.Config.Resources.Jobs["job2"].Permissions, bob)
assert.Contains(t, b.Config.Resources.Jobs["job2"].Permissions, jobRobot)
assert.Contains(t, b.Config.Resources.Jobs["job2"].Permissions, jobBob)

assert.Len(t, b.Config.Resources.Pipelines["pipeline1"].Permissions, 2)
assert.Contains(t, b.Config.Resources.Pipelines["pipeline1"].Permissions, robot)
Expand Down Expand Up @@ -137,12 +158,12 @@ func TestFilterCurrentServicePrincipal(t *testing.T) {

// Assert current user is filtered out.
assert.Len(t, b.Config.Resources.Jobs["job1"].Permissions, 2)
assert.Contains(t, b.Config.Resources.Jobs["job1"].Permissions, alice)
assert.Contains(t, b.Config.Resources.Jobs["job1"].Permissions, bob)
assert.Contains(t, b.Config.Resources.Jobs["job1"].Permissions, jobAlice)
assert.Contains(t, b.Config.Resources.Jobs["job1"].Permissions, jobBob)

assert.Len(t, b.Config.Resources.Jobs["job2"].Permissions, 2)
assert.Contains(t, b.Config.Resources.Jobs["job2"].Permissions, alice)
assert.Contains(t, b.Config.Resources.Jobs["job2"].Permissions, bob)
assert.Contains(t, b.Config.Resources.Jobs["job2"].Permissions, jobAlice)
assert.Contains(t, b.Config.Resources.Jobs["job2"].Permissions, jobBob)

assert.Len(t, b.Config.Resources.Pipelines["pipeline1"].Permissions, 2)
assert.Contains(t, b.Config.Resources.Pipelines["pipeline1"].Permissions, alice)
Expand Down
8 changes: 7 additions & 1 deletion bundle/config/mutator/resourcemutator/validate_target_mode_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,19 @@ func TestProcessTargetModeProduction(t *testing.T) {
diags = validateProductionMode(b, false)
require.ErrorContains(t, diags.Error(), "A common practice is to use a username or principal name in this path, i.e. use\n\n root_path: /Workspace/Users/lennart@company.com/.bundle/${bundle.name}/${bundle.target}")

jobPermissions := []resources.JobPermission{
{
Level: resources.JobPermissionLevelCanManage,
UserName: "user@company.com",
},
}
permissions := []resources.Permission{
{
Level: "CAN_MANAGE",
UserName: "user@company.com",
},
}
b.Config.Resources.Jobs["job1"].Permissions = permissions
b.Config.Resources.Jobs["job1"].Permissions = jobPermissions
b.Config.Resources.Jobs["job1"].RunAs = &jobs.JobRunAs{UserName: "user@company.com"}
b.Config.Resources.Jobs["job2"].RunAs = &jobs.JobRunAs{UserName: "user@company.com"}
b.Config.Resources.Jobs["job3"].RunAs = &jobs.JobRunAs{UserName: "user@company.com"}
Expand Down
27 changes: 23 additions & 4 deletions bundle/config/resources/job.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,30 @@ import (
"github.com/databricks/databricks-sdk-go/service/jobs"
)

type JobPermissionLevel string

const (
JobPermissionLevelCanManage JobPermissionLevel = `CAN_MANAGE`
JobPermissionLevelCanManageRun JobPermissionLevel = `CAN_MANAGE_RUN`
JobPermissionLevelCanView JobPermissionLevel = `CAN_VIEW`
JobPermissionLevelIsOwner JobPermissionLevel = `IS_OWNER`
)

// JobPermission holds the permission level setting for a single principal.
// Multiple of these can be defined on any job.
type JobPermission struct {
Level JobPermissionLevel `json:"level"`

UserName string `json:"user_name,omitempty"`
ServicePrincipalName string `json:"service_principal_name,omitempty"`
GroupName string `json:"group_name,omitempty"`
}

type Job struct {
ID string `json:"id,omitempty" bundle:"readonly"`
Permissions []Permission `json:"permissions,omitempty"`
ModifiedStatus ModifiedStatus `json:"modified_status,omitempty" bundle:"internal"`
URL string `json:"url,omitempty" bundle:"internal"`
ID string `json:"id,omitempty" bundle:"readonly"`
Permissions []JobPermission `json:"permissions,omitempty"`
ModifiedStatus ModifiedStatus `json:"modified_status,omitempty" bundle:"internal"`
URL string `json:"url,omitempty" bundle:"internal"`

*jobs.JobSettings
}
Expand Down
4 changes: 2 additions & 2 deletions bundle/deploy/terraform/convert_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,9 @@ func TestBundleToTerraformJob(t *testing.T) {

func TestBundleToTerraformJobPermissions(t *testing.T) {
src := resources.Job{
Permissions: []resources.Permission{
Permissions: []resources.JobPermission{
{
Level: "CAN_VIEW",
Level: resources.JobPermissionLevelCanView,
UserName: "jane@doe.com",
},
},
Expand Down
4 changes: 2 additions & 2 deletions bundle/deploy/terraform/tfdyn/convert_job_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ func TestConvertJob(t *testing.T) {
},
},
},
Permissions: []resources.Permission{
Permissions: []resources.JobPermission{
{
Level: "CAN_VIEW",
Level: resources.JobPermissionLevelCanView,
UserName: "jane@doe.com",
},
},
Expand Down
12 changes: 6 additions & 6 deletions bundle/deploy/terraform/tfdyn/convert_permissions_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ import (

func TestConvertPermissions(t *testing.T) {
src := resources.Job{
Permissions: []resources.Permission{
Permissions: []resources.JobPermission{
{
Level: "CAN_VIEW",
Level: resources.JobPermissionLevelCanView,
UserName: "jane@doe.com",
},
{
Level: "CAN_MANAGE",
Level: resources.JobPermissionLevelCanManage,
GroupName: "special admins",
},
{
Level: "CAN_RUN",
Level: resources.JobPermissionLevelCanManageRun,
ServicePrincipalName: "spn",
},
},
Expand All @@ -50,7 +50,7 @@ func TestConvertPermissions(t *testing.T) {
ServicePrincipalName: "",
},
{
PermissionLevel: "CAN_RUN",
PermissionLevel: "CAN_MANAGE_RUN",
UserName: "",
GroupName: "",
ServicePrincipalName: "spn",
Expand All @@ -73,7 +73,7 @@ func TestConvertPermissionsNil(t *testing.T) {

func TestConvertPermissionsEmpty(t *testing.T) {
src := resources.Job{
Permissions: []resources.Permission{},
Permissions: []resources.JobPermission{},
}

vin, err := convert.FromTyped(src, dyn.NilValue)
Expand Down
13 changes: 13 additions & 0 deletions bundle/internal/schema/annotations.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,19 @@ github.com/databricks/cli/bundle/config/resources.Grant:
"privileges":
"description": |-
The privileges to grant to the specified entity
github.com/databricks/cli/bundle/config/resources.JobPermission:
"group_name":
"description": |-
PLACEHOLDER
"level":
"description": |-
PLACEHOLDER
"service_principal_name":
"description": |-
PLACEHOLDER
"user_name":
"description": |-
PLACEHOLDER
github.com/databricks/cli/bundle/config/resources.Permission:
"-":
"description": |-
Expand Down
7 changes: 7 additions & 0 deletions bundle/internal/schema/annotations_openapi_overrides.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,13 @@ github.com/databricks/cli/bundle/config/resources.Job:
"run_as":
"description": |-
PLACEHOLDER
github.com/databricks/cli/bundle/config/resources.JobPermissionLevel:
"_":
"enum":
- CAN_MANAGE
- CAN_MANAGE_RUN
- CAN_VIEW
- IS_OWNER
github.com/databricks/cli/bundle/config/resources.MlflowExperiment:
"_":
"markdown_description": |-
Expand Down
Loading
Loading