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

import { loginPage, projectsPage } from "../../support/page_objects/navigation"
import { mainPage } from "../../support/page_objects/mainPage"
import { roles, staticProjects } from "../../support/page_objects/projectConstants"
import { isTestSuiteActive } from "../../support/page_objects/projectConstants"

// let roleURL = {}

export const genTest = (type, xcdb) => {
    if (!isTestSuiteActive(type, xcdb)) return;

    describe('Static user creations (different roles)', () => {
        // beforeEach(() => {
        //     loginPage.signIn(roles.owner.credentials)
        //     projectsPage.openProject(getPrimarySuite().basic.name)
        // })
        before(() => {
            mainPage.navigationDraw(mainPage.TEAM_N_AUTH).click()
        })

        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) + row header = 6
                cy.get(`tr`).then((obj) => {
                    cy.log(obj.length)
                    if (obj.length == 6) {
                        mainPage.addExistingUserToProject(user.credentials.username, user.name)
                    } else {
                        mainPage.addNewUserToProject(user.credentials, user.name)
                    }
                })
            })
        }

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

        // it(`Logging purpose`, () => {
        //     cy.log(mainPage.roleURL)
        // })
    })    
    
    const roleValidation = (roleType) => {
        describe(`User role validation`, () => {

            if (roleType != 'owner') {
                it(`[${roles[roleType].name}] SignIn, Open project`, () => {
                    cy.log(mainPage.roleURL[roleType])
                    cy.visit(mainPage.roleURL[roleType])
                    cy.wait(3000)

                    // 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")').click()

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

                    if('rest' == type)
                        projectsPage.openProject(staticProjects.externalREST.basic.name)
                    else
                        projectsPage.openProject(staticProjects.externalGQL.basic.name)  
                })                    
            }

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

            // it(`[${roles[roleType].name}] SignIn, Open project`, () => {
            //     loginPage.signIn(roles[roleType].credentials)
            //     if('rest' == type)
            //         projectsPage.openProject(staticProjects.externalREST.basic.name)
            //     else
            //         projectsPage.openProject(staticProjects.externalGQL.basic.name)
            // })

            it(`[${roles[roleType].name}] Left navigation menu, New User add`, (done) => {
                cy.on('uncaught:exception', (err, runnable) => {
                    expect(err.message).to.include('Not allowed')
                    done()
                    return false
                })                
                advancedSettings(roleType, done)

                //done()
            })

            it(`[${roles[roleType].name}] Schema: create table, add/modify/delete column`, (done) => {
                cy.on('uncaught:exception', (err, runnable) => {
                    expect(err.message).to.include('Not allowed')
                    done()
                    return false
                })                
                editSchema(roleType, done)

                // done()
            })

            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)
                else
                    done()
            })

            it(`[${roles[roleType].name}] Comments: view/add`, (done) => {
                cy.on('uncaught:exception', (err, runnable) => {
                    expect(err.message).to.include('Not allowed')
                    done()
                    return false
                })
                // Fix me!
                if (roleType != 'viewer')
                    editComment(roleType, done)
                else
                    done()
            })

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

                cy.on('uncaught:exception', (err, runnable) => {
                    expect(err.message).to.include('Not allowed')
                    done()
                    return false
                })
                
                viewMenu(roleType, done)

                //done()
            })

            it(`[${roles[roleType].name}] Download files`, () => {
                mainPage.hideUnhideField('LastUpdate')
                let storedRecords = [
                    `City,City => Address,Country <= City`,
                    `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`
                ]
                mainPage.downloadAndVerifyCsv(`City_exported_1.csv`, storedRecords)
                mainPage.hideUnhideField('LastUpdate')
            })            

            // after(() => {
            //     if ('viewer' == roleType) {
            //         loginPage.loginAndOpenProject('graphql', false)
            //     }
            // })              

            // it(`Reset`, () => {
            //     if ('viewer' == roleType) {
            //         loginPage.loginAndOpenProject('graphql', false)
            //     }
            // })
        })        
    }

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

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

    // 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)
    cy.wait(2000).then(() => {
        done()
    })
}


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

    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)

    cy.wait(2000).then(() => {
        done()
    })    

}


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

    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(8) > [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(8) > [data-col="City"]`).dblclick().find('input').should(validationString)

    cy.wait(2000).then(() => {
        done()
    })    
}


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

    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(8).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}')

    cy.wait(2000).then(() => {
        done()
    })    
}

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

    let columnName = 'City'
    let navDrawListCnt = 2

    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 (roleType == 'owner' || roleType == 'creator') {
        navDrawListCnt = 4
    }
    cy.get('.v-navigation-drawer__content').eq(1).find('[role="list"]').should('have.length', navDrawListCnt)

    // view list field (default GRID view)
    cy.get(`.nc-view-item`).should('exist')

    // view create option, exists only for owner/ creator
    cy.get(`.nc-create-gallery-view`).should(validationString)
    cy.get(`.nc-create-grid-view`).should(validationString)
    cy.get(`.nc-create-form-view`).should(validationString)

    // share view & automations, exists only for owner/creator
    cy.get(`.nc-share-view`).should(validationString)
    cy.get(`.nc-automations`).should(validationString)

    cy.wait(2000).then(() => {
        done()
    })
}

/**
 * @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/>.
 *
 */