nocodb/scripts/cypress/integration/common/5a_user_role.js

import { loginPage, projectsPage } from "../../support/page_objects/navigation";
import { mainPage, settingsPage } from "../../support/page_objects/mainPage";
import {
  isPostgres,
  isXcdb,
  roles,
  staticProjects,
} from "../../support/page_objects/projectConstants";
import { isTestSuiteActive } from "../../support/page_objects/projectConstants";
import {
  _advSettings,
  _editSchema,
  _editData,
  _editComment,
  _viewMenu,
  _topRightMenu,
  disableTableAccess,
  _accessControl,
} from "../spec/roleValidation.spec";

export const genTest = (apiType, dbType) => {
  if (!isTestSuiteActive(apiType, dbType)) return;

  describe("Static user creations (different roles)", () => {
    before(() => {
      // standalone test
      // loginPage.loginAndOpenProject(apiType, dbType);

      // open a table to work on views
      //
      cy.restoreLocalStorage();
      settingsPage.openMenu(settingsPage.TEAM_N_AUTH);
    });

    beforeEach(() => {
      cy.restoreLocalStorage();
    });

    afterEach(() => {
      cy.saveLocalStorage();
    });

    after(() => {
      cy.restoreLocalStorage();
      cy.signOut();
      cy.saveLocalStorage();
    });

    const addUser = (user) => {
      it(`RoleType: ${user.name}`, () => {
        // for first project, users need to be added explicitly using "New User" button
        // for subsequent projects, they will be required to just add to this project
        // using ROW count to identify if its former or latter scenario
        // 5 users (owner, creator, editor, viewer, commenter)  = 5
        // cy.get(`.nc-user-row`).then((obj) => {
        //     cy.log(obj.length);
        //     if (obj.length == 5) {
        //         mainPage.addExistingUserToProject(
        //             user.credentials.username,
        //             user.name
        //         );
        //     } else {
        //         mainPage.addNewUserToProject(
        //             user.credentials,
        //             user.name
        //         );
        //     }
        // });

        cy.get(`.nc-user-row`).should("exist");
        mainPage.addNewUserToProject(user.credentials, user.name);
      });
    };

    addUser(roles.creator);
    addUser(roles.editor);
    addUser(roles.commenter);
    addUser(roles.viewer);

    // Access control list- configuration
    //
    it(`Access control list- configuration`, () => {
      mainPage.closeMetaTab();

      // open Project metadata tab
      //
      settingsPage.openMenu(settingsPage.PROJ_METADATA);
      settingsPage.openTab(settingsPage.UI_ACCESS_CONTROL);

      // validate if it has 19 entries representing tables & views
      if (isPostgres()) cy.get(".nc-acl-table-row").should("have.length", 24);
      else if (isXcdb()) cy.get(".nc-acl-table-row").should("have.length", 19);
      else cy.get(".nc-acl-table-row").should("have.length", 19);

      // disable table & view access
      //
      disableTableAccess("Language", "editor");
      disableTableAccess("Language", "commenter");
      disableTableAccess("Language", "viewer");

      disableTableAccess("CustomerList", "editor");
      disableTableAccess("CustomerList", "commenter");
      disableTableAccess("CustomerList", "viewer");

      cy.get("button.nc-acl-save").click();
      cy.toastWait("Updated UI ACL for tables successfully");

      mainPage.closeMetaTab();
    });
  });

  const roleValidation = (roleType) => {
    let clear;

    describe(`User role validation`, () => {
      before(() => {
        cy.restoreLocalStorage();
        cy.visit(mainPage.roleURL[roleType]);

        cy.get('button:contains("SIGN UP"):visible').should("exist");
        cy.get('input[type="text"]', { timeout: 20000 }).type(
          roles[roleType].credentials.username
        );
        cy.get('input[type="password"]').type(
          roles[roleType].credentials.password
        );
        cy.get('button:contains("SIGN UP")').click();
        cy.get(`.nc-project-page-title:contains("My Projects"):visible`).should(
          "exist"
        );

        if (dbType === "xcdb") {
          if ("rest" == apiType)
            projectsPage.openProject(staticProjects.sampleREST.basic.name);
          else projectsPage.openProject(staticProjects.sampleGQL.basic.name);
        } else if (dbType === "mysql") {
          if ("rest" == apiType)
            projectsPage.openProject(staticProjects.externalREST.basic.name);
          else projectsPage.openProject(staticProjects.externalGQL.basic.name);
        } else if (dbType === "postgres") {
          if ("rest" == apiType)
            projectsPage.openProject(staticProjects.pgExternalREST.basic.name);
          else
            projectsPage.openProject(staticProjects.pgExternalGQL.basic.name);
        }

        if (roleType === "creator") {
          // kludge: wait for page load to finish
          // close team & auth tab
          cy.wait(500);
          cy.get("button.ant-tabs-tab-remove").should("exist").click();
          cy.wait(500);
        }

        cy.saveLocalStorage();

        clear = Cypress.LocalStorage.clear;
        Cypress.LocalStorage.clear = () => {};
      });

      beforeEach(() => {
        cy.restoreLocalStorage();
      });

      afterEach(() => {
        cy.saveLocalStorage();
      });

      after(() => {
        cy.restoreLocalStorage();
        cy.signOut();
        cy.saveLocalStorage();

        Cypress.LocalStorage.clear = clear;
      });

      ///////////////////////////////////////////////////////
      // Test suite

      it(`[${roles[roleType].name}] Left navigation menu, New User add`, () => {
        // project configuration settings
        //
        if (roleType !== "owner") {
          _advSettings(roleType, "userRole");
        }
      });

      it(`[${roles[roleType].name}] Access control`, () => {
        // Access control validation
        //
        if (roleType !== "owner") {
          _accessControl(roleType, "userRole");
        }
      });

      it(`[${roles[roleType].name}] Schema: create table, add/modify/delete column`, () => {
        // Schema related validations
        //  - Add/delete table
        //  - Add/Update/delete column
        //
        if (roleType !== "owner") {
          _editSchema(roleType, "userRole");
        }
      });

      it(`[${roles[roleType].name}] Data: add/modify/delete row, update cell contents`, () => {
        // Table data related validations
        //  - Add/delete/modify row
        //
        if (roleType !== "owner") {
          _editData(roleType, "userRole");
        }
      });

      it(`[${roles[roleType].name}] Comments: view/add`, () => {
        // read &/ update comment
        //      Viewer: only allowed to read
        //      Everyone else: read &/ update
        //
        if (roleType !== "owner") {
          _editComment(roleType, "userRole");
        }
      });

      it(`[${roles[roleType].name}] Right navigation menu, share view`, () => {
        // right navigation menu bar
        //      Editor/Viewer/Commenter : can only view 'existing' views
        //      Rest: can create/edit
        if (roleType !== "owner") {
          _viewMenu(roleType, "userRole");
        }
      });

      it(`[${roles[roleType].name}] Download files`, () => {
        // to be fixed
        if (
          roleType === "commenter" ||
          roleType === "viewer" ||
          roleType === "owner"
        ) {
        } else {
          // viewer & commenter doesn't contain hideField option in ncv2
          // #ID, City, LastUpdate, City => Address, Country <= City, +
          mainPage.hideField("LastUpdate");

          const verifyCsv = (retrievedRecords) => {
            // expected output, statically configured
            let storedRecords = [
              `City,Address List,Country`,
              `A Corua (La Corua),939 Probolinggo Loop,Spain`,
              `Abha,733 Mandaluyong Place,Saudi Arabia`,
              `Abu Dhabi,535 Ahmadnagar Manor,United Arab Emirates`,
              `Acua,1789 Saint-Denis Parkway,Mexico`,
            ];

            // skip if xcdb
            if (!isXcdb()) {
              for (let i = 0; i < storedRecords.length; i++) {
                // cy.log(retrievedRecords[i])
                expect(retrievedRecords[i]).to.be.equal(storedRecords[i]);
              }
            }
          };

          // download & verify
          mainPage.downloadAndVerifyCsv(
            `City_exported_1.csv`,
            verifyCsv,
            roleType
          );
          mainPage.unhideField("LastUpdate");
        }
      });

      it(`[${roles[roleType].name}] App store accessibility`, () => {
        cy.visit("/#/apps").then((r) => {
          cy.toastWait("You don't have enough permission to access the page.");
        });
      });
    });
  };

  // skip owner validation as rest of the cases pretty much cover the same
  // roleValidation("owner");
  roleValidation("creator");
  roleValidation("editor");
  roleValidation("commenter");
  roleValidation("viewer");
};

/**
 * @copyright Copyright (c) 2021, Xgene Cloud Ltd
 *
 * @author Pranav C Balan <pranavxc@gmail.com>
 * @author Raju Udava <sivadstala@gmail.com>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */