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

Generate grant expansion entitlement IDs without using resource cache. #19

Merged
merged 2 commits into from
Feb 19, 2025
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: 0 additions & 3 deletions .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,6 @@ linters-settings:
tenv:
all: true

varcheck:
exported-fields: false # this appears to improperly detect exported variables as unused when they are used from a package with the same name


linters:
disable-all: true
Expand Down
20 changes: 9 additions & 11 deletions pkg/connector/account.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,8 @@ const (
)

type accountBuilder struct {
client *databricks.Client
resourceType *v2.ResourceType
resourceCache *ResourceCache
client *databricks.Client
resourceType *v2.ResourceType
}

func (a *accountBuilder) ResourceType(ctx context.Context) *v2.ResourceType {
Expand Down Expand Up @@ -133,12 +132,12 @@ func (a *accountBuilder) Grants(ctx context.Context, resource *v2.Resource, pTok

var annotations []protoreflect.ProtoMessage
if resourceId.ResourceType == groupResourceType.Id {
memberResource, annotation, err := a.resourceCache.ExpandGrantForGroup(ctx, "", resourceId.Resource)
rid, expandAnnotation, err := groupGrantExpansion(ctx, resourceId.Resource, resource.ParentResourceId)
if err != nil {
return nil, "", nil, fmt.Errorf("databricks-connector: failed to expand grant for group %s: %w", resourceId.Resource, err)
return rv, "", nil, err
}
annotations = append(annotations, annotation)
resourceId = memberResource.Id
resourceId = rid
annotations = append(annotations, expandAnnotation)
}

rv = append(rv, grant.NewGrant(resource, MarketplaceAdminRole, resourceId, grant.WithAnnotation(annotations...)))
Expand Down Expand Up @@ -282,10 +281,9 @@ func (a *accountBuilder) Revoke(ctx context.Context, grant *v2.Grant) (annotatio
return nil, nil
}

func newAccountBuilder(client *databricks.Client, resourceCache *ResourceCache) *accountBuilder {
func newAccountBuilder(client *databricks.Client) *accountBuilder {
return &accountBuilder{
client: client,
resourceType: accountResourceType,
resourceCache: resourceCache,
client: client,
resourceType: accountResourceType,
}
}
22 changes: 10 additions & 12 deletions pkg/connector/connector.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,19 @@ import (
)

type Databricks struct {
client *databricks.Client
workspaces []string
resourceCache *ResourceCache
client *databricks.Client
workspaces []string
}

// ResourceSyncers returns a ResourceSyncer for each resource type that should be synced from the upstream service.
func (d *Databricks) ResourceSyncers(ctx context.Context) []connectorbuilder.ResourceSyncer {
return []connectorbuilder.ResourceSyncer{
newAccountBuilder(d.client, d.resourceCache),
newGroupBuilder(d.client, d.resourceCache),
newServicePrincipalBuilder(d.client, d.resourceCache),
newUserBuilder(d.client, d.resourceCache),
newWorkspaceBuilder(d.client, d.resourceCache, d.workspaces),
newRoleBuilder(d.client, d.resourceCache),
newAccountBuilder(d.client),
newGroupBuilder(d.client),
newServicePrincipalBuilder(d.client),
newUserBuilder(d.client),
newWorkspaceBuilder(d.client, d.workspaces),
newRoleBuilder(d.client),
}
}

Expand Down Expand Up @@ -117,8 +116,7 @@ func New(
}

return &Databricks{
client: client,
workspaces: workspaces,
resourceCache: NewResourceCache(client),
client: client,
workspaces: workspaces,
}, nil
}
42 changes: 23 additions & 19 deletions pkg/connector/groups.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,23 @@ import (
const groupMemberEntitlement = "member"

type groupBuilder struct {
client *databricks.Client
resourceType *v2.ResourceType
resourceCache *ResourceCache
client *databricks.Client
resourceType *v2.ResourceType
}

func (g *groupBuilder) ResourceType(ctx context.Context) *v2.ResourceType {
return groupResourceType
}

func groupResource(_ context.Context, group *databricks.Group, parent *v2.ResourceId) (*v2.Resource, error) {
func groupResourceId(_ context.Context, groupId string, parentResourceId *v2.ResourceId) string {
if parentResourceId == nil {
return strings.Join([]string{groupResourceType.Id, groupId}, "/")
}

return strings.Join([]string{parentResourceId.ResourceType, parentResourceId.Resource, groupResourceType.Id, groupId}, "/")
}

func groupResource(ctx context.Context, group *databricks.Group, parent *v2.ResourceId) (*v2.Resource, error) {
members := make([]string, len(group.Members))

for i, member := range group.Members {
Expand All @@ -54,11 +61,10 @@ func groupResource(_ context.Context, group *databricks.Group, parent *v2.Resour
}

var options []rs.ResourceOption
groupId := strings.Join([]string{groupResourceType.Id, group.ID}, "/")
if parent != nil {
groupId = strings.Join([]string{parent.ResourceType, parent.Resource, groupResourceType.Id, group.ID}, "/")
options = append(options, rs.WithParentResourceID(parent))
}
groupId := groupResourceId(ctx, group.ID, parent)

resource, err := rs.NewGroupResource(
group.DisplayName,
Expand Down Expand Up @@ -110,7 +116,6 @@ func (g *groupBuilder) List(ctx context.Context, parentResourceID *v2.ResourceId
if err != nil {
return nil, "", nil, err
}
g.resourceCache.Set(group.ID, gr)

rv = append(rv, gr)
}
Expand Down Expand Up @@ -210,12 +215,12 @@ func (g *groupBuilder) Grants(ctx context.Context, resource *v2.Resource, pToken
case "Users":
resourceId = &v2.ResourceId{ResourceType: userResourceType.Id, Resource: memberID}
case "Groups":
memberResource, annotation, err := g.resourceCache.ExpandGrantForGroup(ctx, workspaceId, memberID)
rid, expandAnnotation, err := groupGrantExpansion(ctx, memberID, parentId)
if err != nil {
return nil, "", nil, fmt.Errorf("databricks-connector: failed to expand grant for group %s: %w", memberID, err)
return rv, "", nil, err
}
anns = append(anns, annotation)
resourceId = memberResource.Id
resourceId = rid
anns = append(anns, expandAnnotation)
case "ServicePrincipals":
resourceId = &v2.ResourceId{ResourceType: servicePrincipalResourceType.Id, Resource: memberID}
default:
Expand All @@ -240,12 +245,12 @@ func (g *groupBuilder) Grants(ctx context.Context, resource *v2.Resource, pToken
}
var annotations []protoreflect.ProtoMessage
if resourceId.ResourceType == groupResourceType.Id {
memberResource, annotation, err := g.resourceCache.ExpandGrantForGroup(ctx, workspaceId, resourceId.Resource)
rid, expandAnnotation, err := groupGrantExpansion(ctx, resourceId.Resource, resource.ParentResourceId)
if err != nil {
return nil, "", nil, fmt.Errorf("databricks-connector: failed to expand grant for group %s: %w", resourceId.Resource, err)
return rv, "", nil, err
}
annotations = append(annotations, annotation)
resourceId = memberResource.Id
resourceId = rid
annotations = append(annotations, expandAnnotation)
}

rv = append(rv, grant.NewGrant(resource, ruleSet.Role, resourceId, grant.WithAnnotation(annotations...)))
Expand Down Expand Up @@ -471,10 +476,9 @@ func (g *groupBuilder) Revoke(ctx context.Context, grant *v2.Grant) (annotations
return nil, nil
}

func newGroupBuilder(client *databricks.Client, resourceCache *ResourceCache) *groupBuilder {
func newGroupBuilder(client *databricks.Client) *groupBuilder {
return &groupBuilder{
client: client,
resourceType: groupResourceType,
resourceCache: resourceCache,
client: client,
resourceType: groupResourceType,
}
}
42 changes: 7 additions & 35 deletions pkg/connector/helpers.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,43 +35,15 @@ func parseResourceId(resourceId string) (*v2.ResourceId, *v2.ResourceId, error)
return nil, nil, fmt.Errorf("invalid resource ID: %s", resourceId)
}

type ResourceCache struct {
// Map of API IDs to resources
resources map[string]*v2.Resource
client *databricks.Client
}

func (c *ResourceCache) Get(resourceId string) *v2.Resource {
return c.resources[resourceId]
}

func (c *ResourceCache) Set(resourceId string, resource *v2.Resource) {
c.resources[resourceId] = resource
}

func NewResourceCache(client *databricks.Client) *ResourceCache {
return &ResourceCache{
resources: make(map[string]*v2.Resource),
client: client,
}
}

func (c *ResourceCache) ExpandGrantForGroup(ctx context.Context, workspaceId, groupId string) (*v2.Resource, *v2.GrantExpandable, error) {
memberResource := c.Get(groupId)
if memberResource == nil {
group, _, err := c.client.GetGroup(context.Background(), workspaceId, groupId)
if err != nil {
return nil, nil, fmt.Errorf("databricks-connector: failed to get group %s: %w", groupId, err)
}
memberResource, err = groupResource(ctx, group, nil)
if err != nil {
return nil, nil, fmt.Errorf("databricks-connector: failed to get group %s: %w", groupId, err)
}
c.Set(groupId, memberResource)
func groupGrantExpansion(ctx context.Context, groupId string, parentResource *v2.ResourceId) (*v2.ResourceId, *v2.GrantExpandable, error) {
groupResourceStr := groupResourceId(ctx, groupId, parentResource)
resourceId, err := rs.NewResourceID(groupResourceType, groupResourceStr)
if err != nil {
return nil, nil, err
}

return memberResource, &v2.GrantExpandable{
EntitlementIds: []string{fmt.Sprintf("group:%s:%s", memberResource.Id.Resource, groupMemberEntitlement)},
return resourceId, &v2.GrantExpandable{
EntitlementIds: []string{fmt.Sprintf("group:%s:%s", groupResourceStr, groupMemberEntitlement)},
}, nil
}

Expand Down
24 changes: 14 additions & 10 deletions pkg/connector/roles.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,8 @@ var entitlements = []string{
}

type roleBuilder struct {
client *databricks.Client
resourceType *v2.ResourceType
resourceCache *ResourceCache
client *databricks.Client
resourceType *v2.ResourceType
}

func (r *roleBuilder) ResourceType(ctx context.Context) *v2.ResourceType {
Expand Down Expand Up @@ -233,11 +232,17 @@ func (r *roleBuilder) Grants(ctx context.Context, resource *v2.Resource, pToken
}

if (!isWorkspaceRole && g.HaveRole(roleName)) || (isWorkspaceRole && g.HaveEntitlement(roleName)) {
memberResource, annotation, err := r.resourceCache.ExpandGrantForGroup(ctx, workspaceId, g.ID)
accountId := r.client.GetAccountId()
accountResourceId, err := rs.NewResourceID(accountResourceType, accountId)
if err != nil {
return nil, "", nil, fmt.Errorf("databricks-connector: failed to expand grant for group %s: %w", g.ID, err)
return rv, "", nil, err
}
rv = append(rv, grant.NewGrant(resource, RoleMemberEntitlement, memberResource.Id, grant.WithAnnotation(annotation)))
resourceId, expandAnnotation, err := groupGrantExpansion(ctx, g.ID, accountResourceId)
if err != nil {
return rv, "", nil, err
}

rv = append(rv, grant.NewGrant(resource, RoleMemberEntitlement, resourceId, grant.WithAnnotation(expandAnnotation)))
}
}

Expand Down Expand Up @@ -454,10 +459,9 @@ func (r *roleBuilder) Revoke(ctx context.Context, grant *v2.Grant) (annotations.
return nil, nil
}

func newRoleBuilder(client *databricks.Client, resourceCache *ResourceCache) *roleBuilder {
func newRoleBuilder(client *databricks.Client) *roleBuilder {
return &roleBuilder{
client: client,
resourceType: roleResourceType,
resourceCache: resourceCache,
client: client,
resourceType: roleResourceType,
}
}
23 changes: 11 additions & 12 deletions pkg/connector/service-principals.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@ import (
)

type servicePrincipalBuilder struct {
client *databricks.Client
resourceType *v2.ResourceType
resourceCache *ResourceCache
client *databricks.Client
resourceType *v2.ResourceType
}

func (s *servicePrincipalBuilder) ResourceType(ctx context.Context) *v2.ResourceType {
Expand Down Expand Up @@ -57,7 +56,6 @@ func (s *servicePrincipalBuilder) servicePrincipalResource(ctx context.Context,
return nil, err
}

s.resourceCache.Set(servicePrincipal.ID, resource)
return resource, nil
}

Expand Down Expand Up @@ -190,12 +188,14 @@ func (s *servicePrincipalBuilder) Grants(ctx context.Context, resource *v2.Resou

var annotations []protoreflect.ProtoMessage
if resourceId.ResourceType == groupResourceType.Id {
memberResource, annotation, err := s.resourceCache.ExpandGrantForGroup(ctx, workspaceId, resourceId.Resource)
groupResourceStr := groupResourceId(ctx, resourceId.Resource, resource.ParentResourceId)
annotations = append(annotations, &v2.GrantExpandable{
EntitlementIds: []string{fmt.Sprintf("group:%s:%s", groupResourceStr, groupMemberEntitlement)},
})
resourceId, err = rs.NewResourceID(groupResourceType, groupResourceStr)
if err != nil {
return nil, "", nil, fmt.Errorf("databricks-connector: failed to expand grant for group %s: %w", resourceId.Resource, err)
return rv, "", nil, err
}
annotations = append(annotations, annotation)
resourceId = memberResource.Id
}

rv = append(rv, grant.NewGrant(resource, ruleSet.Role, resourceId, grant.WithAnnotation(annotations...)))
Expand Down Expand Up @@ -376,10 +376,9 @@ func (s *servicePrincipalBuilder) Revoke(ctx context.Context, grant *v2.Grant) (
return nil, nil
}

func newServicePrincipalBuilder(client *databricks.Client, resourceCache *ResourceCache) *servicePrincipalBuilder {
func newServicePrincipalBuilder(client *databricks.Client) *servicePrincipalBuilder {
return &servicePrincipalBuilder{
client: client,
resourceType: servicePrincipalResourceType,
resourceCache: resourceCache,
client: client,
resourceType: servicePrincipalResourceType,
}
}
14 changes: 5 additions & 9 deletions pkg/connector/users.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,8 @@ import (
)

type userBuilder struct {
client *databricks.Client
resourceType *v2.ResourceType
resourceCache *ResourceCache
client *databricks.Client
resourceType *v2.ResourceType
}

func (u *userBuilder) ResourceType(ctx context.Context) *v2.ResourceType {
Expand Down Expand Up @@ -78,8 +77,6 @@ func (u *userBuilder) userResource(ctx context.Context, user *databricks.User, p
return nil, err
}

u.resourceCache.Set(user.ID, resource)

return resource, nil
}

Expand Down Expand Up @@ -159,10 +156,9 @@ func (u *userBuilder) Grants(
return nil, "", nil, nil
}

func newUserBuilder(client *databricks.Client, resourceCache *ResourceCache) *userBuilder {
func newUserBuilder(client *databricks.Client) *userBuilder {
return &userBuilder{
client: client,
resourceType: userResourceType,
resourceCache: resourceCache,
client: client,
resourceType: userResourceType,
}
}
Loading
Loading