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

[Workspace] add tests for workspace collaborators page #1632

Merged
merged 5 commits into from
Nov 15, 2024
Merged
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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add one more test for search and filter?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our initial plan is to cover basic tests, let us cover these in the next stage.

Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
/*
* Copyright OpenSearch Contributors
* SPDX-License-Identifier: Apache-2.0
*/

import { MiscUtils } from '@opensearch-dashboards-test/opensearch-dashboards-test-library';
const miscUtils = new MiscUtils(cy);
const workspaceName = 'test_workspace_collaborators';
let workspaceId;

if (
Cypress.env('WORKSPACE_ENABLED') &&
Cypress.env('SAVED_OBJECTS_PERMISSION_ENABLED') &&
Cypress.env('SECURITY_ENABLED')
) {
describe('Workspace collaborators', () => {
beforeEach(() => {
cy.deleteWorkspaceByName(workspaceName);
//Create a workspace before each test
cy.createWorkspace({
name: workspaceName,
features: ['use-case-observability'],
settings: {
permissions: {
library_write: {
users: [`${Cypress.env('username')}`],
groups: ['admin_group'],
},
write: {
users: [`${Cypress.env('username')}`],
groups: ['admin_group'],
},
library_read: {
users: ['read_user'],
},
read: {
users: ['read_user'],
},
},
},
}).then((value) => {
workspaceId = value;
miscUtils.visitPage(`w/${value}/app/workspace_collaborators`);
});
});

afterEach(() => {
cy.deleteWorkspaceById(workspaceId);
});

it('should add user and group collaborators successfully', () => {
//Add user
cy.getElementByTestId('add-collaborator-popover').click();
cy.get('button[id="user"]').click();
cy.contains('Add Users').should('be.visible');
cy.getElementByTestId('workspaceCollaboratorIdInput-0').type(
'new_read_user'
);
cy.get('button[type="submit"]')
.contains('span', 'Add collaborators')
.click();

//Add group
cy.getElementByTestId('add-collaborator-popover').click();
cy.get('button[id="group"]').click();
cy.contains('Add Groups').should('be.visible');
cy.getElementByTestId('workspaceCollaboratorIdInput-0').type(
'new_admin_group'
);
cy.get('span[title="Admin"]').click();
cy.get('button[type="submit"]')
.contains('span', 'Add collaborators')
.click();

cy.contains('new_read_user');

cy.get('table')
.contains('td', 'new_read_user')
.parent()
.within(() => {
cy.get('td').eq(3).contains('Read only');
});

cy.get('table')
.contains('td', 'new_admin_group')
.parent()
.within(() => {
cy.get('td').eq(3).contains('Admin');
});
const expectedWorkspace = {
name: workspaceName,
features: ['use-case-observability'],
description: 'test_description',
permissions: {
library_write: {
users: [`${Cypress.env('username')}`],
groups: ['admin_group', 'new_admin_group'],
},
write: {
users: [`${Cypress.env('username')}`],
groups: ['admin_group', 'new_admin_group'],
},
library_read: {
users: ['read_user', 'new_read_user'],
},
read: {
users: ['read_user', 'new_read_user'],
},
},
};
cy.checkWorkspace(workspaceId, expectedWorkspace);
});

it('should change access level successfully', () => {
cy.get('table')
.contains('td', 'read_user')
.parent('tr')
.within(() => {
cy.get('input[type="checkbox"]').check();
});
cy.get('table')
.contains('td', 'admin_group')
.parent('tr')
.within(() => {
cy.get('input[type="checkbox"]').check();
});

cy.getElementByTestId(
'workspace-detail-collaborator-table-actions'
).click();
cy.get('div[role="dialog"]')
.find('span')
.contains('Change access level')
.click();
cy.get('div[role="dialog"]')
.find('span')
.contains('Read and write')
.click();
cy.getElementByTestId('confirmModalConfirmButton').click();

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: we can add a verification here to verify change access level toast exists

Copy link
Collaborator Author

@raintygao raintygao Nov 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we have verified the actual content in the table has been updated, this is more trustable than the toast, right?

cy.contains('read_user');

cy.get('table')
.contains('td', 'read_user')
.parent()
.within(() => {
cy.get('td').eq(3).contains('Read and write');
});
cy.get('table')
.contains('td', 'admin_group')
.parent()
.within(() => {
cy.get('td').eq(3).contains('Read and write');
});
const expectedWorkspace = {
name: workspaceName,
features: ['use-case-observability'],
description: 'test_description',
permissions: {
library_write: {
users: [`${Cypress.env('username')}`, 'read_user'],
groups: ['admin_group'],
},
write: {
users: [`${Cypress.env('username')}`],
},
read: {
groups: ['admin_group'],
users: ['read_user'],
},
},
};
cy.checkWorkspace(workspaceId, expectedWorkspace);
});

it('should delete collaborators successfully', () => {
cy.get('table')
.contains('td', 'read_user')
.parent('tr')
.within(() => {
cy.get('input[type="checkbox"]').check();
});
cy.get('table')
.contains('td', 'admin_group')
.parent('tr')
.within(() => {
cy.get('input[type="checkbox"]').check();
});

cy.getElementByTestId('confirm-delete-button').click();
cy.getElementByTestId('confirmModalConfirmButton').click();
Copy link
Member

@SuZhou-Joe SuZhou-Joe Nov 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we add assertion to ensure the selected collaborators have been removed from UI?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: same here verify toast of delete collaborators exists


cy.contains('read_user').should('not.exist');
cy.contains('admin_group').should('not.exist');
const expectedWorkspace = {
name: workspaceName,
features: ['use-case-observability'],
description: 'test_description',
permissions: {
library_write: {
users: ['admin'],
},
write: {
users: ['admin'],
},
},
};
cy.checkWorkspace(workspaceId, expectedWorkspace);
});
});
}
Loading