Update Cypress configuration and dependencies for improved testing

.github/workflows/ui-test.yml

@@ -31,10 +31,10 @@ jobs:
         with:
           fetch-depth: '10'
           path: apim-apps
-      - name: Set up JDK 11
+      - name: Set up JDK 21
         uses: actions/setup-java@v4
         with:
-          java-version: 11
+          java-version: 21
           distribution: 'temurin'
       - uses: actions/setup-node@v4
         with:
@@ -73,13 +73,13 @@ jobs:
           nc -zv localhost 9443
       - uses: actions/setup-node@v4
         with:
-          node-version: '18'
+          node-version: '22'
       - name: Cypress run
-        uses: cypress-io/github-action@v4
+        uses: cypress-io/github-action@v7
         with:
           record: false
           working-directory: 'apim-apps/tests'
-          spec: '**/*.spec.js'
+          spec: 'cypress/e2e/**/*.cy.js'
       - name: Upload Screenshots
         uses: actions/upload-artifact@v4
         if: failure()

tests/cypress.config.js

@@ -0,0 +1,42 @@
+const { defineConfig } = require('cypress')
+
+module.exports = defineConfig({
+  chromeWebSecurity: false,
+  pageLoadTimeout: 100000,
+  defaultCommandTimeout: 100000,
+  screenshotsFolder: 'cypress/screenshots',
+  screenshotOnRunFailure: true,
+  reporter: 'cypress-multi-reporters',
+  reporterOptions: {
+    inlineAssets: true,
+    reporterEnabled: 'cypress-mochawesome-reporter, mocha-junit-reporter',
+    mochaJunitReporterReporterOptions: {
+      mochaFile: 'cypress/reports/junit/results-[hash].xml',
+    },
+    cypressMochawesomeReporterReporterOptions: {
+      charts: true,
+      reportPageTitle: 'custom-title',
+    },
+  },
+  video: false,
+  scrollBehavior: 'nearest',
+  retries: {
+    runMode: 2,
+    openMode: 0,
+  },
+  env: {
+    largeTimeout: 100000,
+  },
+  e2e: {
+    setupNodeEvents(on, config) {
+      return require('./cypress/plugins/index.js')(on, config)
+    },
+    specPattern: 'cypress/e2e/**/*.cy.{js,jsx,ts,tsx}',
+    excludeSpecPattern: [
+      '**/externalDevPortals/**/*.cy.js',
+      '**/06-solace-broker-integration.cy.js',
+      '**/*.cy.skip.js',
+    ],
+    baseUrl: 'https://localhost:9443',
+  },
+})

tests/cypress/integration/admin/05-add-custom-throttle-policies.spec.js → tests/cypress/e2e/admin/05-add-custom-throttle-policies.cy.js

@@ -31,7 +31,7 @@ describe("Add custom throttle policies", () => {
       }, () => {
         const policyName = '5reqPerMin';
         const secondDesc = 'For an Admin users allow 5 requests per minute';
-        cy.get('[data-testid="Custom Policies-child-link"]', {timeout: Cypress.config().largeTimeout}).click();
+        cy.get('[data-testid="Custom Policies-child-link"]', {timeout: Cypress.env('largeTimeout')}).click();
         cy.get('[data-testid="throttling-custom-add-button"]').contains('Define Policy').click();
         cy.get('input[name="policyName"]').type(policyName);
         cy.get('input[name="description"]').type('Allow 5 requests per minute for an Admin user');
@@ -46,7 +46,7 @@ describe("Add custom throttle policies", () => {
 
         cy.intercept('GET', '**/throttling/policies/custom').as('getCustomPolicies');
         cy.get('[data-testid="throttling-custom-save-button"]').contains('Edit').click();
-        cy.wait('@getCustomPolicies', {timeout: Cypress.config().largeTimeout}).then(() => {
+        cy.wait('@getCustomPolicies', {timeout: Cypress.env('largeTimeout')}).then(() => {
             cy.get('td').contains(secondDesc).should('exist');
         });
 

tests/cypress/integration/admin/08-add-api-categories.spec.js → tests/cypress/e2e/admin/08-add-api-categories.cy.js

@@ -35,7 +35,7 @@ describe("Add API Categories and assign via publisher portal", () => {
         const category = Utils.generateName();
         const categoryDescription = 'Weather related apis';
 
-        cy.get('[data-testid="API Categories"]', { timeout: Cypress.config().largeTimeout }).click();
+        cy.get('[data-testid="API Categories"]', { timeout: Cypress.env('largeTimeout') }).click();
         cy.get('[data-testid="form-dialog-base-trigger-btn"]').contains('Add API Category').click();
         cy.get('input[name="name"]').type(category);
         cy.get('textarea[name="description"]').type(categoryDescription);
@@ -48,7 +48,7 @@ describe("Add API Categories and assign via publisher portal", () => {
         Utils.addAPI({}).then((apiId) => {
             testApiId = apiId;
             cy.visit(`/publisher/apis/${apiId}/configuration`);
-            cy.get('#APICategories-autocomplete', { timeout: Cypress.config().largeTimeout }).click();
+            cy.get('#APICategories-autocomplete', { timeout: Cypress.env('largeTimeout') }).click();
             cy.get('li').contains(category).click();
             cy.get('#design-config-save-btn').click();
             cy.contains('API updated successfully').should('be.visible');
@@ -61,14 +61,14 @@ describe("Add API Categories and assign via publisher portal", () => {
                 // Delete
                 cy.visit(`/admin/settings/api-categories`);
                 cy.wait(7000);
-                cy.get('[data-testid="MuiDataTableBodyCell-4-0"] > div > div > span:nth-child(2)', { timeout: Cypress.config().largeTimeout })
+                cy.get('[data-testid="MuiDataTableBodyCell-4-0"] > div > div > span:nth-child(2)', { timeout: Cypress.env('largeTimeout') })
                     .should('be.visible')    
                     .click();
                 cy.get('[data-testid="form-dialog-base-save-btn"]').contains("Delete")
                     .should('be.visible')
                     .click();
                 cy.contains('API Category deleted successfully').should('be.visible');
-                //cy.get('div[role="status"]', {timeout: Cypress.config().largeTimeout}).should('have.text', 'API Category deleted successfully');
+                //cy.get('div[role="status"]', {timeout: Cypress.env('largeTimeout')}).should('have.text', 'API Category deleted successfully');
             });
         }
     })

tests/cypress/integration/admin/09-add-edit-delete-km.spec.js → tests/cypress/e2e/admin/09-add-edit-delete-km.cy.js

@@ -139,7 +139,7 @@ describe("Add key manager", () => {
                 cy.get(`#${km}`).should('not.exist');
 
                 cy.visit(`/devportal/applications?tenant=carbon.super`);
-                cy.get(`#itest-application-list-table td a`, {timeout: Cypress.config().largeTimeout}).contains(appName).click();
+                cy.get(`#itest-application-list-table td a`, {timeout: Cypress.env('largeTimeout')}).contains(appName).click();
                 cy.get('#production-keys').click();
                 cy.get(`#${km}`).should('not.exist');
                 cy.get('#sandbox-keys').click();

tests/cypress/integration/devportal/000-general/01-anonymous-user-view-public-apis.spec.js → tests/cypress/e2e/devportal/000-general/01-anonymous-user-view-public-apis.cy.js

@@ -50,7 +50,7 @@ describe("Anonymous view apis", () => {
                         let remainingAttempts = 15;
                         let attemptCount = 0;
                         for (; attemptCount < remainingAttempts; attemptCount++) {
-                            let $apis = Cypress.$('a', apiName, { timeout: Cypress.config().largeTimeout });
+                            let $apis = Cypress.$('a', apiName, { timeout: Cypress.env('largeTimeout') });
                             if ($apis.length) {
                                 // At least one with api name was found.
                                 // Return a jQuery object.

tests/cypress/integration/devportal/000-general/03-self-signup.spec.js → tests/cypress/e2e/devportal/000-general/03-self-signup.cy.js

@@ -50,66 +50,66 @@ describe("Self SignUp", () => {
     const internalSubscriberRole = 'Internal/subscriber';
     const internalTestRole = 'Internal/testRole';
     const selfSignupDisabledConfigJson = JSON.parse(JSON.stringify(tenantConfigJson));
-    delete selfSignupDisabledConfigJson.SelfSignUp;
+    selfSignupDisabledConfigJson.SelfSignUp = { "SignUpRoles": [] };
     const customUserRoleAddedConfigJson = JSON.parse(JSON.stringify(tenantConfigJson));
     customUserRoleAddedConfigJson.SelfSignUp.SignUpRoles.push(internalTestRole);
 
-    it.only("Test - Default self-signup behaviour of the super tenant", () => {
+    it("Test - Default self-signup behaviour of the super tenant", () => {
         cy.addNewUserUsingSelfSignUp(superTenant1Username, password, firstName, lastName,
             getSuperTenantEmail(superTenant1Username), superTenant);
         cy.addExistingUserUsingSelfSignUp(superTenant1Username, superTenant);
         cy.portalLogin(superTenant1Username, password, devPortal, superTenant);
         cy.logoutFromDevportal();
     });
 
-    it.only("Test - Default self-signup behaviour of the wso2 tenant", () => {
+    it("Test - Default self-signup behaviour of the wso2 tenant", () => {
         cy.addNewUserUsingSelfSignUp(Utils.getTenantUser(tenant1Username, testTenant), password, firstName, lastName,
             Utils.getTenantUser(tenant1Username, testTenant), testTenant);
         cy.addExistingUserUsingSelfSignUp(Utils.getTenantUser(tenant1Username, testTenant), testTenant);
         cy.portalLogin(Utils.getTenantUser(tenant1Username, testTenant), password, devPortal, testTenant);
         cy.logoutFromDevportal();
     });
 
-    it.only("Test - Login to the devPortal using incorrect user credentials", () => {
+    it("Test - Login to the devPortal using incorrect user credentials", () => {
         cy.portalLoginUsingIncorrectUserCredentials(incorrectUsername, incorrectPassword, devPortal, testTenant);
     });
 
-    it.only("Test - Login to the publisher portal using incorrect user credentials", () => {
+    it("Test - Login to the publisher portal using incorrect user credentials", () => {
         cy.portalLoginUsingIncorrectUserCredentials(incorrectUsername, incorrectPassword, publisher, superTenant);
     });
 
-    it.only("Test - Login to the admin portal using incorrect user credentials", () => {
+    it("Test - Login to the admin portal using incorrect user credentials", () => {
         cy.portalLoginUsingIncorrectUserCredentials(incorrectUsername, incorrectPassword, adminPortal, superTenant);
     });
 
-    it.only("Test - Login to the carbon using incorrect user credentials", () => {
+    it("Test - Login to the carbon using incorrect user credentials", () => {
         cy.carbonLogin(incorrectUsername, incorrectPassword);
         cy.contains('Login failed! Please recheck the username and password and try again.').should('exist');
     });
 
-    it.only("Test - Login to the publisher using newly created user(superTenant1) credentials", () => {
+    it("Test - Login to the publisher using newly created user(superTenant1) credentials", () => {
         cy.portalLogin(superTenant1Username, password, publisher, superTenant);
         cy.contains('Error 403 : Forbidden').should('exist');
         cy.contains('The server could not verify that you are authorized to access the requested resource.').should('exist');
         cy.logoutFromPublisher();
     });
 
-    it.only("Test - Login to the admin portal using newly created user(superTenant1) credentials", () => {
+    it("Test - Login to the admin portal using newly created user(superTenant1) credentials", () => {
         cy.portalLogin(superTenant1Username, password, adminPortal, superTenant);
         cy.contains('Error 403 : Forbidden').should('exist');
         cy.contains('The server could not verify that you are authorized to access the requested resource.').should('exist');
         cy.logoutFromAdminPortal();
     });
 
-    it.only("Test - Login to the carbon using newly created user(superTenant1) credentials", () => {
+    it("Test - Login to the carbon using newly created user(superTenant1) credentials", () => {
         cy.carbonLogin(superTenant1Username, password);
         cy.get('#region1_dashboard_main_menu').should('not.exist');
         cy.get('#region3_registry_menu').should('not.exist');
         cy.get('#region3_metadata_menu').should('not.exist');
         cy.carbonLogout();
     });
 
-    it.only("Test - Remove self signup config from the advance configuration and create a new user for the super tenant", () => {
+    it("Test - Remove self signup config from the advance configuration and create a new user for the super tenant", () => {
         cy.updateTenantConfig(carbonUsername, carbonPassword, superTenant, selfSignupDisabledConfigJson);
         cy.addNewUserUsingSelfSignUp(superTenant2Username, password, firstName, lastName,
             getSuperTenantEmail(superTenant2Username), superTenant);
@@ -119,7 +119,7 @@ describe("Self SignUp", () => {
         cy.contains('Logout').click();
     });
 
-    it.only("Test - Remove self signup config from the advance configuration and create a new user for the wso2 tenant", () => {
+    it("Test - Remove self signup config from the advance configuration and create a new user for the wso2 tenant", () => {
         cy.updateTenantConfig(tenantAdminUsername, tenantAdminPassword, testTenant, selfSignupDisabledConfigJson);
         cy.addNewUserUsingSelfSignUp(Utils.getTenantUser(tenant2Username, testTenant), password, firstName, lastName,
             Utils.getTenantUser(tenant2Username, testTenant), testTenant);
@@ -129,7 +129,7 @@ describe("Self SignUp", () => {
         cy.contains('Logout').click();
     });
 
-    it.only("Test - Disable self signup from the carbon portal for the super tenant", () => {
+    it("Test - Disable self signup from the carbon portal for the super tenant", () => {
         cy.disableSelfSignUpInCarbonPortal(carbonUsername, carbonPassword, superTenant);
         cy.visit(`${Utils.getAppOrigin()}/devportal/apis?tenant=${superTenant}`);
         cy.get('#itest-devportal-sign-in').click({ force: true });
@@ -139,7 +139,7 @@ describe("Self SignUp", () => {
         cy.contains(`Self registration is disabled for tenant - ${superTenant}`).should('exist');
     });
 
-    it.only("Test - Disable self signup from the carbon portal for the wso2 tenant", () => {
+    it("Test - Disable self signup from the carbon portal for the wso2 tenant", () => {
         cy.disableSelfSignUpInCarbonPortal(tenantAdminUsername, tenantAdminPassword, testTenant);
         cy.visit(`${Utils.getAppOrigin()}/devportal/apis?tenant=${testTenant}`);
         cy.get('#itest-devportal-sign-in').click({ force: true });
@@ -149,7 +149,7 @@ describe("Self SignUp", () => {
         cy.contains(`Self registration is disabled for tenant - ${testTenant}`).should('exist');
     });
 
-    it.only("Test - Enable self signup back for the super tenant", () => {
+    it("Test - Enable self signup back for the super tenant", () => {
         cy.updateTenantConfig(carbonUsername, carbonPassword, superTenant, tenantConfigJson);
         cy.enableSelfSignUpInCarbonPortal(carbonUsername, carbonPassword, superTenant);
         cy.addNewUserUsingSelfSignUp(superTenant4Username, password, firstName, lastName,
@@ -158,7 +158,7 @@ describe("Self SignUp", () => {
         cy.logoutFromDevportal();
     });
 
-    it.only("Test - Enable self signup back for the wso2 tenant", () => {
+    it("Test - Enable self signup back for the wso2 tenant", () => {
         cy.updateTenantConfig(tenantAdminUsername, tenantAdminPassword, testTenant, tenantConfigJson);
         cy.enableSelfSignUpInCarbonPortal(tenantAdminUsername, tenantAdminPassword, testTenant);
         cy.addNewUserUsingSelfSignUp(Utils.getTenantUser(tenant4Username, testTenant), password, firstName, lastName,
@@ -167,7 +167,7 @@ describe("Self SignUp", () => {
         cy.logoutFromDevportal();
     });
 
-    it.only("Test - Assign custom user roles to a super tenant user", () => {
+    it("Test - Assign custom user roles to a super tenant user", () => {
         cy.carbonLogin(carbonUsername, carbonPassword);
         cy.addNewRole(userRole, domain);
         cy.carbonLogout();
@@ -178,7 +178,7 @@ describe("Self SignUp", () => {
             [internalSubscriberRole, internalTestRole]);
     });
 
-    it.only("Test - Assign custom user roles to a tenant user", () => {
+    it("Test - Assign custom user roles to a tenant user", () => {
         cy.carbonLogin(tenantAdminUsername, tenantAdminPassword);
         cy.addNewRole(userRole, domain);
         cy.carbonLogout();
@@ -189,7 +189,7 @@ describe("Self SignUp", () => {
             [internalSubscriberRole, internalTestRole]);
     });
 
-    it.only("Test - Create a user for a unregistered tenant", () => {
+    it("Test - Create a user for a unregistered tenant", () => {
         cy.visit(`${Utils.getAppOrigin()}/devportal/apis?tenant=${testTenant}`);
         cy.get('#itest-devportal-sign-in').click({ force: true });
         cy.get('#registerLink').click();
@@ -199,15 +199,21 @@ describe("Self SignUp", () => {
     });
 
     after(function () {
+        // Reset tenant configs first so self-signup no longer depends on Internal/testRole.
+        cy.updateTenantConfig(carbonUsername, carbonPassword, superTenant, tenantConfigJson);
+        cy.enableSelfSignUpInCarbonPortal(carbonUsername, carbonPassword, superTenant);
+        cy.updateTenantConfig(tenantAdminUsername, tenantAdminPassword, testTenant, tenantConfigJson);
+        cy.enableSelfSignUpInCarbonPortal(tenantAdminUsername, tenantAdminPassword, testTenant);
+
         cy.carbonLogin(carbonUsername, carbonPassword);
         // delete all the created users for super tenant
         cy.visit(`${Utils.getAppOrigin()}/carbon/user/user-mgt.jsp`);
         cy.deleteUser(superTenant1Username);
         cy.deleteUser(superTenant2Username);
         cy.deleteUser(superTenant4Username);
         cy.deleteUser(superTenant5Username);
-        // Remove created user roles
-        cy.deleteRole(internalTestRole);
+        // Remove created user role
+        cy.searchAndDeleteRoleIfExist(internalTestRole);
         cy.carbonLogout();
 
         cy.carbonLogin(tenantAdminUsername, tenantAdminPassword);
@@ -217,15 +223,8 @@ describe("Self SignUp", () => {
         cy.deleteUser(tenant2Username);
         cy.deleteUser(tenant4Username);
         cy.deleteUser(tenant5Username);
-        // Remove created user roles
-        cy.deleteRole(internalTestRole);
+        // Remove created user role
+        cy.searchAndDeleteRoleIfExist(internalTestRole);
         cy.carbonLogout();
-
-        // Reset all the configs back to ensure default behaviour
-        cy.updateTenantConfig(carbonUsername, carbonPassword, superTenant, tenantConfigJson);
-        cy.enableSelfSignUpInCarbonPortal(carbonUsername, carbonPassword, superTenant);
-
-        cy.updateTenantConfig(tenantAdminUsername, tenantAdminPassword, testTenant, tenantConfigJson);
-        cy.enableSelfSignUpInCarbonPortal(tenantAdminUsername, tenantAdminPassword, testTenant);
     })
 });

tests/cypress/integration/devportal/000-general/04-change-password-of-a-user.spec.js → tests/cypress/e2e/devportal/000-general/04-change-password-of-a-user.cy.js

@@ -30,7 +30,7 @@ describe("Change the password from devportal", () => {
   it.only("Change the password from devportal", () => {
     cy.carbonLogin(carbonUsername, carbonPassword);
     cy.addNewUser(username, ["Internal/subscriber"], password);
-    cy.get(".ui-dialog-buttonset", { timeout: Cypress.config().largeTimeout });
+    cy.get(".ui-dialog-buttonset", { timeout: Cypress.env('largeTimeout') });
     cy.get("button").contains("OK").click();
     cy.get("#userTable").contains("td", "newuser").should("exist");
     cy.carbonLogout();
@@ -52,7 +52,7 @@ describe("Change the password from devportal", () => {
     cy.get("input#repeated-new-password").click();
     cy.get("input#repeated-new-password").type(newPassword);
 
-    cy.get("[data-testid='change-password-save-button']").debug().contains("Save").click();
+    cy.get("[data-testid='change-password-save-button']").contains("Save").click();
 
     cy.logoutFromDevportal();
     devportalComonPage.waitUntillDevportalLoaderSpinnerExit();