test: [PROD-14255] add cypress test for the dataset rename feature

Author: csm-thu

cypress/commons/actions/generic/DatasetManager.js

@@ -98,6 +98,26 @@ export const getDatasetOverviewPlaceholderRetryButton = () => cy.get(SELECTORS.o
 export const getDatasetOverviewPlaceholderRollbackButton = () => cy.get(SELECTORS.overview.placeholder.rollbackButton);
 export const getDatasetOverviewPlaceholderApiLink = () => cy.get(SELECTORS.overview.placeholder.apiLink);
 
+export const getDatasetNameEditableTextField = () => cy.get(SELECTORS.overview.datasetNameTextField);
+export const getRenameDatasetButton = () => cy.get(SELECTORS.overview.renameScenario);
+
+// Parameters
+//  - newDatasetName (string)
+//  - options (object) is an optional parameter. If provided, it can have the following properties:
+//    - id (optional): id of the dataset to update (if not provided, it will be guessed from the request URL)
+//    - validateRequest (optional): validation function to run on the dataset update request
+export const renameDataset = (newDatasetName, options) => {
+  const renameDatasetAlias = api.interceptUpdateDataset({
+    id: options?.id,
+    validateRequest: options?.validateRequest,
+  });
+
+  getRenameDatasetButton().click();
+  getDatasetNameEditableTextField().type('{selectAll}{backspace}' + newDatasetName + '{enter}');
+
+  api.waitAlias(renameDatasetAlias);
+};
+
 export const getCategoryAccordionSummary = (categoryId) =>
   cy.get(SELECTORS.overview.categories.accordionSummary.replace('$CATEGORY_ID', categoryId));
 export const getCategoryAccordionDetails = (categoryId) =>

cypress/commons/constants/generic/IdConstants.js

@@ -241,6 +241,8 @@ export const GENERIC_SELECTORS = {
     },
     overview: {
       datasetName: '[data-cy=dataset-name]',
+      datasetNameTextField: '[data-cy=dataset-name-editable-text-field]',
+      renameScenario: '[data-cy=rename-dataset-button]',
       placeholder: {
         container: '[data-cy=dataset-overview-placeholder]',
         title: '[data-cy=dataset-overview-title]',

cypress/e2e/brewery/DatasetManager_RenameDataset.cy.js

@@ -0,0 +1,62 @@
+// Copyright (c) Cosmo Tech.
+// Licensed under the MIT license.
+import { DatasetManager, Login } from '../../commons/actions';
+import { stub } from '../../commons/services/stubbing';
+import { SOLUTION, WORKSPACE, ORGANIZATION_WITH_DEFAULT_ROLE_USER } from '../../fixtures/stubbing/DatasetManager';
+import { EDITABLE_DATASET, NON_EDITABLE_DATASET } from '../../fixtures/stubbing/RenameDataset';
+
+describe('rename datasets in Dataset Manager view', () => {
+  before(() => {
+    const linkedWorkspace = { ...WORKSPACE, linkedDatasetIdList: [EDITABLE_DATASET.id, NON_EDITABLE_DATASET.id] };
+    stub.start();
+    stub.setOrganizations([ORGANIZATION_WITH_DEFAULT_ROLE_USER]);
+    stub.setSolutions([SOLUTION]);
+    stub.setWorkspaces([linkedWorkspace]);
+    console.log(EDITABLE_DATASET, NON_EDITABLE_DATASET);
+    stub.setDatasets([EDITABLE_DATASET, NON_EDITABLE_DATASET]);
+  });
+
+  beforeEach(() => Login.login({ url: '/W-stbbdbrwryWithDM/datasetmanager', workspaceId: 'W-stbbdbrwryWithDM' }));
+  after(stub.stop);
+
+  it('cannot rename datasets if role is viewer', () => {
+    DatasetManager.switchToDatasetManagerView();
+    DatasetManager.selectDatasetById(NON_EDITABLE_DATASET.id);
+    DatasetManager.getDatasetNameInOverview().should('have.text', NON_EDITABLE_DATASET.name);
+    DatasetManager.getDatasetNameEditableTextField().should('not.exist');
+    DatasetManager.getRenameDatasetButton().should('not.exist');
+  });
+
+  it('can rename datasets if role is editor', () => {
+    const datasetName = EDITABLE_DATASET.name;
+    const newName = 'renamed';
+
+    DatasetManager.switchToDatasetManagerView();
+    DatasetManager.selectDatasetById(EDITABLE_DATASET.id);
+    DatasetManager.getDatasetNameInOverview().should('have.text', datasetName);
+    DatasetManager.getDatasetNameEditableTextField().should('not.exist');
+    DatasetManager.getRenameDatasetButton().should('exist').should('be.visible');
+
+    // Edit & cancel without confirming the changes
+    DatasetManager.getRenameDatasetButton().click();
+    DatasetManager.getDatasetNameInOverview().should('not.exist');
+    DatasetManager.getDatasetNameEditableTextField().should('exist').should('be.visible');
+    DatasetManager.getDatasetNameEditableTextField().type('{selectAll}{backspace}' + newName + '{esc}');
+    DatasetManager.getDatasetNameEditableTextField().should('not.exist'); // Input field disappeared
+    DatasetManager.getDatasetNameInOverview().should('have.text', datasetName); // Initial name remained unchanged
+
+    // Edit & confirm
+    const validateRequest = (query) => {
+      console.log(query);
+      return true;
+    };
+    DatasetManager.renameDataset(newName, { validateRequest });
+    DatasetManager.getDatasetNameInOverview().should('have.text', newName); // Dataset name has been changed
+
+    // Switch between dataset and check that the new name has been persisted
+    DatasetManager.selectDatasetById(NON_EDITABLE_DATASET.id);
+    DatasetManager.getDatasetNameInOverview().should('have.text', NON_EDITABLE_DATASET.name);
+    DatasetManager.selectDatasetById(EDITABLE_DATASET.id);
+    DatasetManager.getDatasetNameInOverview().should('have.text', newName);
+  });
+});

cypress/fixtures/stubbing/RenameDataset/datasets.js

@@ -0,0 +1,26 @@
+// Copyright (c) Cosmo Tech.
+// Licensed under the MIT license.
+import { WORKSPACE } from '../DatasetManager/workspaces';
+import { DEFAULT_DATASET } from '../default';
+
+export const NON_EDITABLE_DATASET = {
+  ...DEFAULT_DATASET,
+  main: true,
+  id: 'd-noneditable',
+  name: 'non editable dataset',
+  ingestionStatus: 'SUCCESS',
+  twincacheStatus: 'FULL',
+  linkedWorkspaceIdList: [WORKSPACE.id],
+  security: { default: 'viewer', accessControlList: [] },
+};
+
+export const EDITABLE_DATASET = {
+  ...DEFAULT_DATASET,
+  main: true,
+  id: 'd-editable',
+  name: 'editable dataset',
+  ingestionStatus: 'SUCCESS',
+  twincacheStatus: 'FULL',
+  linkedWorkspaceIdList: [WORKSPACE.id],
+  security: { default: 'editor', accessControlList: [] },
+};

cypress/fixtures/stubbing/RenameDataset/index.js

@@ -0,0 +1,4 @@
+// Copyright (c) Cosmo Tech.
+// Licensed under the MIT license.
+
+export { EDITABLE_DATASET, NON_EDITABLE_DATASET } from './datasets';