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

fix(rbac): reduce the catalog calls when build graph #1203

Merged
merged 6 commits into from
Feb 20, 2024
Merged

fix(rbac): reduce the catalog calls when build graph #1203

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
009ba7a
fix(rbac): reduce the catalog calls when build graph
PatAKnight Feb 13, 2024
f3a047a
fix(rbac): update userEntityRef to userName
PatAKnight Feb 16, 2024
eadb556
fix(rbac): fix minor sonarcloud issue
PatAKnight Feb 16, 2024
0f696be
fix(rbac): review suggestions
PatAKnight Feb 19, 2024
fb62a79
fix(rbac): add tests on more complex graphs
PatAKnight Feb 19, 2024
36f031c
fix(rbac): fix tests
PatAKnight Feb 20, 2024
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
2 changes: 1 addition & 1 deletion plugins/rbac-backend/src/role-manager/ancestor-search-memo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ export class AncestorSearchMemo {
const groupName = `group:${group.metadata.namespace?.toLocaleLowerCase(
'en-US',
)}/${group.metadata.name.toLocaleLowerCase('en-US')}`;
if (!memo.hasEntityRef(group.metadata.name)) {
if (!memo.hasEntityRef(groupName)) {
memo.setNode(groupName);
}

Expand Down
231 changes: 214 additions & 17 deletions plugins/rbac-backend/src/role-manager/role-manager.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,11 @@ describe('BackstageRoleManager', () => {
'team-b',
]);

catalogApiMock.getEntities.mockImplementation((_arg: any) => {
catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupMock] };
}
return { items: [groupMock, groupParentMock] };
});

Expand All @@ -294,7 +298,11 @@ describe('BackstageRoleManager', () => {
'team-b',
]);

catalogApiMock.getEntities.mockImplementation((_arg: any) => {
catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupMock] };
}
return { items: [groupMock, groupParentMock] };
});

Expand Down Expand Up @@ -327,7 +335,11 @@ describe('BackstageRoleManager', () => {
const groupCMock = createGroupEntity('team-c', 'team-a', [], ['tom']);
const groupDMock = createGroupEntity('team-d', 'team-a', [], ['john']);

catalogApiMock.getEntities.mockImplementation((_arg: any) => {
catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupBMock] };
}
return { items: [groupAMock, groupBMock, groupCMock, groupDMock] };
});

Expand All @@ -349,16 +361,20 @@ describe('BackstageRoleManager', () => {
// user:default/tom user:default/mike user:default:john
//
it('should return true for hasLink, when user:default/mike inherits role:default/team-b from group:default/team-b', async () => {
const groupAMock = createGroupEntity('team-a', undefined, [
'team-b',
const groupBMock = createGroupEntity('team-b', undefined, [
'team-a',
'team-c',
'team-d',
]);
const groupBMock = createGroupEntity('team-b', 'team-a', [], ['mike']);
const groupAMock = createGroupEntity('team-a', 'team-b', [], ['mike']);
const groupCMock = createGroupEntity('team-c', 'team-a', [], ['tom']);
const groupDMock = createGroupEntity('team-d', 'team-a', [], ['john']);

catalogApiMock.getEntities.mockImplementation((_arg: any) => {
catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupAMock] };
}
return { items: [groupAMock, groupBMock, groupCMock, groupDMock] };
});

Expand All @@ -385,7 +401,11 @@ describe('BackstageRoleManager', () => {
const groupBMock = createGroupEntity('team-b', 'team-a', ['mike']);
const groupAMock = createGroupEntity('team-a', undefined, ['team-b']);

catalogApiMock.getEntities.mockImplementation((_arg: any) => {
catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupBMock] };
}
return { items: [groupAMock, groupBMock] };
});

Expand All @@ -410,7 +430,11 @@ describe('BackstageRoleManager', () => {
const groupBMock = createGroupEntity('team-b', 'team-a', ['mike']);
const groupAMock = createGroupEntity('team-a', undefined, ['team-b']);

catalogApiMock.getEntities.mockImplementation((_arg: any) => {
catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupBMock] };
}
return { items: [groupAMock, groupBMock] };
});

Expand Down Expand Up @@ -439,7 +463,11 @@ describe('BackstageRoleManager', () => {
const groupAMock = createGroupEntity('team-a', undefined, [], ['team-c']);
const groupBMock = createGroupEntity('team-b', undefined, [], ['team-d']);

catalogApiMock.getEntities.mockImplementation((_arg: any) => {
catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupCMock, groupDMock] };
}
return { items: [groupAMock, groupBMock, groupCMock, groupDMock] };
});

Expand All @@ -466,7 +494,11 @@ describe('BackstageRoleManager', () => {
const groupAMock = createGroupEntity('team-a', undefined, ['team-c']);
const groupBMock = createGroupEntity('team-b', undefined, ['team-d']);

catalogApiMock.getEntities.mockImplementation((_arg: any) => {
catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupCMock, groupDMock] };
}
return { items: [groupAMock, groupBMock, groupCMock, groupDMock] };
});

Expand Down Expand Up @@ -495,7 +527,11 @@ describe('BackstageRoleManager', () => {
const groupAMock = createGroupEntity('team-a', undefined, ['team-c']);
const groupBMock = createGroupEntity('team-b', undefined, ['team-d']);

catalogApiMock.getEntities.mockImplementation((_arg: any) => {
catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupCMock, groupDMock] };
}
return { items: [groupAMock, groupBMock, groupCMock, groupDMock] };
});

Expand All @@ -522,7 +558,11 @@ describe('BackstageRoleManager', () => {
const groupAMock = createGroupEntity('team-a', undefined, ['team-c']);
const groupBMock = createGroupEntity('team-b', undefined, ['team-d']);

catalogApiMock.getEntities.mockImplementation((_arg: any) => {
catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupCMock, groupDMock] };
}
return { items: [groupAMock, groupBMock, groupCMock, groupDMock] };
});

Expand Down Expand Up @@ -550,7 +590,11 @@ describe('BackstageRoleManager', () => {
const groupBMock = createGroupEntity('team-b', 'team-a', [], ['mike']);
const groupAMock = createGroupEntity('team-a', 'team-b', ['team-b']);

catalogApiMock.getEntities.mockImplementation((_arg: any) => {
catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupBMock] };
}
return { items: [groupBMock, groupAMock] };
});

Expand Down Expand Up @@ -588,7 +632,11 @@ describe('BackstageRoleManager', () => {
const groupBMock = createGroupEntity('team-b', 'team-a', ['mike']);
const groupAMock = createGroupEntity('team-a', 'team-b', ['team-b']);

catalogApiMock.getEntities.mockImplementation((_arg: any) => {
catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupBMock] };
}
return { items: [groupBMock, groupAMock] };
});

Expand Down Expand Up @@ -743,7 +791,11 @@ describe('BackstageRoleManager', () => {
const groupAMock = createGroupEntity('team-a', 'team-c', ['team-c']);
const groupBMock = createGroupEntity('team-b', undefined, ['team-d']);

catalogApiMock.getEntities.mockImplementation((_arg: any) => {
catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupCMock, groupDMock] };
}
return { items: [groupCMock, groupDMock, groupAMock, groupBMock] };
});

Expand Down Expand Up @@ -774,7 +826,11 @@ describe('BackstageRoleManager', () => {
const groupAMock = createGroupEntity('team-a', 'team-c', ['team-c']);
const groupBMock = createGroupEntity('team-b', undefined, ['team-d']);

catalogApiMock.getEntities.mockImplementation((_arg: any) => {
catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupCMock, groupDMock] };
}
return { items: [groupCMock, groupDMock, groupAMock, groupBMock] };
});

Expand All @@ -791,6 +847,147 @@ describe('BackstageRoleManager', () => {
);
});

// user:default/mike should inherits role from group:default/team-f, and we have a complex graph, and cycle dependency
// So return false on call hasLink.
//
// Hierarchy:
// role:default/team-e
// ↓
// |----------------- group:default/team-e ---------|
// ↓ |
// | ----------------- group:default/team-f ----| |
// ↓ ↓ |
// group:default/team-a -> role:default/team-a group:default/team-b |
// ↓ ↑ ↓ ↓
// group:default/team-c -> role:default/team-c group:default/team-d group:default/team-g -> role:default/team-g
// ↓ ↓ ↓
// user:default/mike -------------------|---------------------------------|
//
it('should return false for hasLink, when user:default/mike inherits role from group tree with group:default/team-e, complex tree', async () => {
const groupCMock = createGroupEntity('team-c', 'team-a', [], ['mike']);
const groupDMock = createGroupEntity('team-d', 'team-b', [], ['mike']);
const groupAMock = createGroupEntity('team-a', 'team-c', ['team-c']);
const groupBMock = createGroupEntity('team-b', 'team-f', ['team-d']);
const groupFMock = createGroupEntity('team-f', 'team-e', [
'team-a',
'team-b',
]);
const groupEMock = createGroupEntity('team-e', undefined, [
'team-f',
'team-g',
]);
const groupGMock = createGroupEntity(
'team-g',
'team-e',
['team-d'],
AndrienkoAleksandr marked this conversation as resolved.
Show resolved Hide resolved
['mike'],
);

catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupCMock, groupDMock, groupGMock] };
}
return {
items: [
groupCMock,
groupDMock,
groupAMock,
groupBMock,
groupFMock,
groupEMock,
groupGMock,
],
};
});

roleManager.addLink('group:default/team-a', 'role:default/team-a');
roleManager.addLink('group:default/team-c', 'role:default/team-c');
roleManager.addLink('group:default/team-e', 'role:default/team-e');
roleManager.addLink('group:default/team-g', 'role:default/team-g');

const result = await roleManager.hasLink(
'user:default/mike',
'role:default/team-e',
);
expect(result).toBeFalsy();
expect(loggerMock.warn).toHaveBeenCalledWith(
'Detected cycle dependencies in the Group graph: [["group:default/team-a","group:default/team-c"]]. Admin/(catalog owner) have to fix it to make RBAC permission evaluation correct for group: group:default/team-a',
);

const test = await roleManager.hasLink(
'user:default/mike',
'role:default/team-g',
);
expect(test).toBeFalsy();
});

// user:default/mike should inherits role from group:default/team-f, and we have a complex graph
AndrienkoAleksandr marked this conversation as resolved.
Show resolved Hide resolved
// So return true on call hasLink.
//
// Hierarchy:
// role:default/team-e
// ↓
// |----------------- group:default/team-e ---------|
// ↓ |
// | ----------------- group:default/team-f ----| |
// ↓ ↓ |
// group:default/team-a -> role:default/team-a group:default/team-b |
// ↓ ↓ ↓
// group:default/team-c -> role:default/team-c group:default/team-d group:default/team-g -> role:default/team-g
// ↓ ↓ ↓
// user:default/mike -------------------|---------------------------------|
//
it('should return true for hasLink, when user:default/mike inherits role from group tree with group:default/team-e, complex tree', async () => {
const groupCMock = createGroupEntity('team-c', 'team-a', [], ['mike']);
const groupDMock = createGroupEntity('team-d', 'team-b', [], ['mike']);
const groupAMock = createGroupEntity('team-a', 'team-f', ['team-c']);
const groupBMock = createGroupEntity('team-b', 'team-f', ['team-d']);
const groupFMock = createGroupEntity('team-f', 'team-e', [
'team-a',
'team-b',
]);
const groupEMock = createGroupEntity('team-e', undefined, [
'team-f',
'team-g',
]);
const groupGMock = createGroupEntity(
'team-g',
'team-e',
['team-d'],
['mike'],
);

catalogApiMock.getEntities.mockImplementation((arg: any) => {
const hasMember = arg.filter['relations.hasMember'];
if (hasMember && hasMember === 'user:default/mike') {
return { items: [groupCMock, groupDMock, groupGMock] };
}
return {
items: [
groupCMock,
groupDMock,
groupAMock,
groupBMock,
groupFMock,
groupEMock,
groupGMock,
],
};
});

roleManager.addLink('group:default/team-a', 'role:default/team-a');
roleManager.addLink('group:default/team-c', 'role:default/team-c');
roleManager.addLink('group:default/team-e', 'role:default/team-e');
roleManager.addLink('group:default/team-g', 'role:default/team-g');

const result = await roleManager.hasLink(
'user:default/mike',
'role:default/team-e',
);
expect(result).toBeTruthy();
});

// user:default/mike should inherits from group:default/team-a, but we have cycle dependency: team-a -> team-c.
// So return false on call hasLink.
//
Expand Down
Loading