nocodb/cypress/integration/user_role_spec.js

import { loginPage, projectsPage } from "../support/page_objects/navigation"
import { mainPage } from "../support/page_objects/mainPage"


// database
//      validation details
//          advSettings: left navigation bar (audit, metadata, auth, transient view modes)
//          editSchema: create table, add/update/delete column
//          editData: add/ update/ delete row, cell contents
//          editComment: add comment
//          shareView: right navigation bar (share options)
const roles = {
    owner: {
        name: 'owner',
        credentials: { username: 'user@nocodb.com', password: 'Password123.' },
        validations: { advSettings: true, editSchema: true, editData: true, editComment: true, shareView: true }
    },
    creator: {
        name: 'creator',
        credentials: { username: 'creator@nocodb.com', password: 'Password123.' },
        validations: { advSettings: true, editSchema: true, editData: true, editComment: true, shareView: true }
    },
    editor: {
        name: 'editor',
        credentials: { username: 'editor@nocodb.com', password: 'Password123.' },
        validations: { advSettings: false, editSchema: false, editData: true, editComment: true, shareView: false }
    },
    commenter: {
        name: 'commenter',
        credentials: { username: 'commenter@nocodb.com', password: 'Password123.' },
        validations: { advSettings: false, editSchema: false, editData: false, editComment: true, shareView: false }
    },
    viewer: {
        name: 'viewer',
        credentials: { username: 'viewer@nocodb.com', password: 'Password123.' },
        validations: { advSettings: false, editSchema: false, editData: false, editComment: false, shareView: false }
    }
}


// add new user to specified role
//
const addUser = (userCred, role) => {

    let linkText

    // click on New User button, feed details
    cy.get('button:contains("New User")').first().click()
    cy.get('label:contains(Email)').next('input').type(userCred.username).trigger('input')
    cy.get('label:contains(Select User roles)').click()

    // opt-in requested role & submit
    // note that, 'editor' is set by default
    //
    cy.getActiveMenu().contains(role).click()
    cy.getActiveMenu().contains('editor').click()
    cy.get('.mdi-menu-down').click()
    cy.get('.nc-invite-or-save-btn').click()

    // get URL, invoke
    cy.getActiveModal().find('.v-alert').then(($obj) => {
        linkText = $obj.text()
        cy.log(linkText)

        cy.visit(linkText)
    })

    // SignUp is taken care under userRoleCreation()
    // wait for some time to ensure screen is loaded
    //
    cy.wait(2000)
}


const userRoleCreation = (roleType) => {
    it(`User creation: ${roleType}`, () => {

        loginPage.signIn(roles.owner.credentials)
        projectsPage.openProject('sakilaDb')

        // Team & Auth tab is open by default
        //
        addUser(roles[roleType].credentials, roleType)

        // Redirected to new URL, feed details
        //
        cy.get('input[type="text"]').type(roles[roleType].credentials.username)
        cy.get('input[type="password"]').type(roles[roleType].credentials.password)
        cy.get('button:contains("SIGN UP")').click()

        cy.url({ timeout: 6000 }).should('contain', '#/project')
        cy.wait(1000)

        projectsPage.openProject('sakilaDb')
    })
}

describe('Test project creation, user creation', () => {

    let projectName = ''

    it('Create Project', () => {

        loginPage.signUp(roles.owner.credentials)

        const projectParams = { dbType: 1, apiType: 0, name: 'sakilaDb' }
        const databaseParams = {
            databaseType: 0,
            hostAddress: 'localhost',
            portNumber: '3306',
            username: 'root',
            password: 'password',
            databaseName: 'sakila'
        }

        projectName = projectsPage.createProject(projectParams, databaseParams)
    })

    userRoleCreation('creator')
    userRoleCreation('editor')
    userRoleCreation('commenter')
    userRoleCreation('viewer')
})

const genTest = (roleType) => {

    describe(`User role validation`, () => {

        // project configuration settings
        //
        const advancedSettings = (roleType) => {

            // let validationString = (true == roleValidation[roleIdx].advSettings) ? 'exist' : 'not.exist'
            let validationString = (true == roles[roleType].validations.advSettings) ? 'exist' : 'not.exist'

            // hardwired to be enabled for all roles
            mainPage.navigationDraw(mainPage.AUDIT).should('exist')

            mainPage.navigationDraw(mainPage.APPSTORE).should(validationString)
            mainPage.navigationDraw(mainPage.TEAM_N_AUTH).should(validationString)
            mainPage.navigationDraw(mainPage.PROJ_METADATA).should(validationString)

            mainPage.navigationDraw(mainPage.ROLE_VIEW).should(validationString)
            if ('exist' == validationString) {
                mainPage.navigationDraw(mainPage.ROLE_VIEW).contains('editor')
                mainPage.navigationDraw(mainPage.ROLE_VIEW).contains('commenter')
                mainPage.navigationDraw(mainPage.ROLE_VIEW).contains('viewer')
            }

            cy.get('button:contains("New User")').should(validationString)

        }


        // Schema related validations
        //  - Add/delete table
        //  - Add/Update/delete column
        //
        const editSchema = (roleType) => {

            let columnName = 'City'
            let validationString = (true == roles[roleType].validations.editSchema) ? 'exist' : 'not.exist'

            // create table options
            //
            cy.get('.add-btn').should(validationString)
            cy.get('.v-tabs-bar').eq(0).find('button.mdi-plus-box').should(validationString)

            // open existing table-column
            //
            cy.openTableTab(columnName)

            // delete table option
            //
            cy.get('.nc-table-delete-btn').should(validationString)

            // add new column option
            //        
            cy.get('.new-column-header').should(validationString)

            // update column (edit/ delete menu)
            //
            cy.get(`th:contains(${columnName}) .mdi-menu-down`).should(validationString)

        }


        // Table data related validations
        //  - Add/delete/modify row
        //
        const editData = (roleType) => {

            let columnName = 'City'
            let validationString = (true == roles[roleType].validations.editData) ? 'exist' : 'not.exist'

            cy.openTableTab(columnName)

            // add new row option (from menu header)
            //
            cy.get('.nc-add-new-row-btn').should(validationString)

            // update row option (right click)
            //
            cy.get(`tbody > :nth-child(4) > [data-col="City"]`).rightclick()

            cy.get('.menuable__content__active').should(validationString)

            if (validationString == 'exist') {

                // right click options will exist (only for 'exist' case)
                //
                cy.getActiveMenu().contains('Insert New Row').should(validationString)
                cy.getActiveMenu().contains('Delete Row').should(validationString)
                cy.getActiveMenu().contains('Delete Selected Rows').should(validationString)
                cy.get('body').type('{esc}')

                // update cell contents option using row expander should be enabled
                //
                //cy.get('.nc-row-expand-icon').eq(4).click({ force: true })
                cy.get('.v-input.row-checkbox').eq(4).next().next().click({ force: true })
                cy.getActiveModal().find('button').contains('Save Row').should('exist')
                cy.get('body').type('{esc}')

            }
            else {
                // update cell contents option using row expander should be disabled
                //
                //cy.get('.nc-row-expand-icon').eq(4).click({ force: true })
                cy.get('.v-input.row-checkbox').eq(4).next().next().click({ force: true })
                cy.getActiveModal().find('button:disabled').contains('Save Row').should('exist')
                cy.get('body').type('{esc}')
            }

            // double click cell entries to edit
            //
            cy.get(`tbody > :nth-child(4) > [data-col="City"]`).dblclick().find('input').should(validationString)
        }


        // read &/ update comment
        //      Viewer: only allowed to read
        //      Everyone else: read &/ update
        //
        const editComment = (roleType) => {

            let columnName = 'City'
            let validationString = (true == roles[roleType].validations.editComment) ? 'Comment added successfully' : 'Not allowed'

            cy.openTableTab(columnName)

            // click on comment icon & type comment
            //

            cy.get('.v-input.row-checkbox').eq(4).next().next().click({ force: true })
            //cy.get('.nc-row-expand-icon').eq(4).click({ force: true })
            cy.getActiveModal().find('.mdi-comment-multiple-outline').should('exist').click()
            cy.getActiveModal().find('.comment-box').type('Comment-1{enter}')

            // Expected response: 
            //      Viewer: Not allowed
            //      Everyone else: Comment added successfully
            //
            cy.get('body').contains(validationString, { timeout: 2000 }).should('exist')
            cy.get('body').type('{esc}')
        }

        // right navigation menu bar
        //      Editor/Viewer/Commenter : can only view 'existing' views
        //      Rest: can create/edit
        const viewMenu = (roleType) => {

            let columnName = 'City'
            let navDrawListCnt = 2
            let navDrawListItemCnt = 5
            cy.openTableTab(columnName)
            let validationString = (true == roles[roleType].validations.shareView) ? 'exist' : 'not.exist'

            // validate if Share button is visible at header tool bar
            cy.get('header.v-toolbar').eq(0).find('button:contains("Share")').should(validationString)

            // Owner, Creator will have two navigation drawer (on each side of center panel)
            if (validationString == 'exist') {
                navDrawListCnt = 4
                navDrawListItemCnt = 16
            }
            cy.get('.v-navigation-drawer__content').eq(1).find('[role="list"]').should('have.length', navDrawListCnt)
            cy.get('.v-navigation-drawer__content').eq(1).find('.v-list-item').should('have.length', navDrawListItemCnt)

            // redundant
            // cy.get('.v-navigation-drawer__content').eq(1).find('.v-list-item').eq(0).contains('Views').should('exist')
            // cy.get('.v-navigation-drawer__content').eq(1).find('.v-list-item').eq(1).contains('City').should('exist')

            // cy.get(`.nc-create-grid-view`).should(validationString)
            // cy.get(`.nc-create-gallery-view`).should(validationString)
        }



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

        it(`[${roles[roleType].name}] SignIn, Open project SakilaDb`, () => {
            loginPage.signIn(roles[roleType].credentials)
            projectsPage.openProject('sakilaDb')
        })

        it(`[${roles[roleType].name}] Left navigation menu, New User add`, () => {
            advancedSettings(roleType)
        })

        it(`[${roles[roleType].name}] Schema: create table, add/modify/delete column`, () => {
            editSchema(roleType)
        })

        it(`[${roles[roleType].name}] Data: add/modify/delete row, update cell contents`, (/*done*/) => {

            // known issue: to be fixed
            // right click raising alarm 'not allowed' for viewer
            //
            // cy.on('uncaught:exception', (err, runnable) => {
            //     expect(err.message).to.include('Not allowed')
            //     done()
            //     return false
            // })

            if (roleType != 'editor')
                editData(roleType)

            // done()
        })

        it(`[${roles[roleType].name}] Comments: view/add`, () => {

            // Fix me!
            if (roleType != 'viewer')
                editComment(roleType)
        })

        it(`[${roles[roleType].name}] Right navigation menu, share view`, () => {
            viewMenu(roleType)
        })
    })
}

genTest('owner')
genTest('creator')
genTest('editor')
genTest('commenter')
genTest('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/>.
 *
 */