chore: add new workflow to trigger Cypress tests from core

.github/workflows/e2e-test-dispatch.yml

@@ -0,0 +1,46 @@
+name: 'dhis2: e2e tests triggered by core'
+
+on:
+    workflow_dispatch:
+        inputs:
+            dhis2_version:
+                description: 'DHIS2 core version'
+                required: true
+            instance_url:
+                description: 'Instance URL'
+                required: true
+
+jobs:
+    setup-matrix:
+        runs-on: ubuntu-latest
+        outputs:
+            matrix: ${{ steps.set-matrix.outputs.specs }}
+        steps:
+            - uses: actions/checkout@v3
+
+            - name: Generate Test matrix
+              id: set-matrix
+              run: |
+                  echo "Generating Test Matrix"
+                  echo "::set-output name=specs::$(node src/generateTestMatrix.js)"
+
+            - name: Debug spec-group
+              run: |
+                  echo "Matrix output: ${{ steps.set-matrix.outputs.specs }}"
+
+    call-workflow-e2e-prod:
+        needs: setup-matrix
+        uses: dhis2/workflows/.github/workflows/analytics-e2e-tests-triggered-by-core.yml@workflow-dispatch-cypress
+        with:
+            should_record: ${{ contains(github.event.head_commit.message, '[e2e record]') || contains(join(github.event.pull_request.labels.*.name), 'e2e record') }}
+            spec-group: ${{ needs.setup-matrix.outputs.matrix }}
+            api_base_url: ${{ github.event.inputs.instance_url }}
+            app_url: ${{ github.event.inputs.instance_url }}
+            dhis2_version: ${{ github.event.inputs.dhis2_version }}
+        secrets:
+            username: ${{ secrets.CYPRESS_DHIS2_USERNAME }}
+            password: ${{ secrets.CYPRESS_DHIS2_PASSWORD }}
+            recordkey: ${{ secrets.CYPRESS_RECORD_KEY }}
+            reportportal_api_key: ${{ secrets.REPORTPORTAL_API_KEY }}
+            reportportal_endpoint: ${{ vars.REPORTPORTAL_ENDPOINT }}
+            reportportal_project: ${{ vars.REPORTPORTAL_PROJECT }}

cypress.config.js

@@ -9,6 +9,13 @@ async function setupNodeEvents(on, config) {
     chromeAllowXSiteCookies(on, config)
     excludeByVersionTags(on, config)
 
+    on('task', {
+        log(message) {
+            console.log(message)
+            return null
+        },
+    })
+
     // Delete videos for passing tests
     on('after:spec', (spec, results) => {
         try {
@@ -42,42 +49,47 @@ async function setupNodeEvents(on, config) {
 
 module.exports = defineConfig({
     projectId: 'm5qvjx',
-    reporter: '@reportportal/agent-js-cypress',
+    reporter: 'cypress-multi-reporters',
     reporterOptions: {
-        endpoint: process.env.REPORTPORTAL_ENDPOINT,
-        apiKey: process.env.REPORTPORTAL_API_KEY,
-        launch: 'line_listing_app',
-        project: process.env.REPORTPORTAL_PROJECT,
-        description: '',
-        autoMerge: true,
-        parallel: true,
-        debug: false,
-        restClientConfig: {
-            timeout: 660000,
-        },
-        attributes: [
-            {
-                key: 'dhis2_version',
-                value: process.env.DHIS2_VERSION,
+        reporterEnabled: ['@reportportal/agent-js-cypress', 'spec'],
+        reportportalAgentJsCypressReporterOptions: {
+            endpoint: process.env.REPORTPORTAL_ENDPOINT,
+            apiKey: process.env.REPORTPORTAL_API_KEY,
+            launch: 'line_listing_app',
+            project: process.env.REPORTPORTAL_PROJECT,
+            description: '',
+            autoMerge: true,
+            parallel: true,
+            debug: false,
+            restClientConfig: {
+                timeout: 660000,
             },
-            {
-                key: 'app_name',
-                value: 'line-listing-app',
-            },
-            {
-                key: 'test_level',
-                value: 'e2e',
-            },
-        ],
+            attributes: [
+                {
+                    key: 'dhis2_version',
+                    value: process.env.DHIS2_VERSION,
+                },
+                {
+                    key: 'app_name',
+                    value: 'line-listing-app',
+                },
+                {
+                    key: 'test_level',
+                    value: 'e2e',
+                },
+            ],
+        },
     },
     e2e: {
         setupNodeEvents,
         baseUrl: 'http://localhost:3000',
         specPattern: 'cypress/integration/**/*.cy.js',
         viewportWidth: 1280,
         viewportHeight: 800,
+        pageLoadTimeout: 60000,
         // Record video
         video: true,
+        chromeWebSecurity: false, // Disable Chrome Web Security
         // Enabled to reduce the risk of out-of-memory issues
         experimentalMemoryManagement: true,
         /* When allowing 1 retry on CI, the test suite will pass if

cypress/helpers/startScreen.js

@@ -1,11 +1,43 @@
 import { EXTENDED_TIMEOUT } from '../support/util.js'
 
+// Helper function to log page state and check if specific content is present
+const logPageState = () => {
+    cy.url().then((url) => {
+        cy.log(`Current URL: ${url}`)
+        cy.task('log', `Current URL: ${url}`)
+        console.log(`Current URL: ${url}`)
+    })
+
+    cy.get('body').then((body) => {
+        const bodyText = body.text()
+        cy.log(`Page Body Content: ${bodyText.slice(0, 500)}...`)
+        cy.task('log', `Page Body Content: ${bodyText.slice(0, 500)}...`)
+        console.log(`Page Body Content: ${bodyText.slice(0, 500)}...`)
+    })
+}
+
 export const goToStartPage = (skipEval) => {
-    cy.visit('/', EXTENDED_TIMEOUT).log(Cypress.env('dhis2BaseUrl'))
-    if (!skipEval) {
-        expectStartScreenToBeVisible()
-    }
+    const appPath = '/api/apps/line-listing/index.html';
+    const baseUrl = Cypress.env('dhis2BaseUrl') + appPath;
+    cy.visit(baseUrl, EXTENDED_TIMEOUT).then(() => {
+        cy.log(`Visiting the base URL: ${baseUrl}`)
+        cy.task('log', `Visiting the base URL: ${baseUrl}`)
+        console.log(`Visiting the base URL: ${baseUrl}`)
+        logPageState()
+
+        if (!skipEval) {
+            expectStartScreenToBeVisible()
+        }
+    })
 }
 
-export const expectStartScreenToBeVisible = () =>
-    cy.contains('Getting started', EXTENDED_TIMEOUT).should('be.visible')
+export const expectStartScreenToBeVisible = () => {
+    cy.contains('Getting started', EXTENDED_TIMEOUT)
+        .should('be.visible')
+        .then(() => {
+            cy.log('Confirmed: "Getting started" is visible')
+            cy.task('log', 'Confirmed: "Getting started" is visible')
+            console.log('Confirmed: "Getting started" is visible')
+        })
+    logPageState()
+}

cypress/support/e2e.js

@@ -36,6 +36,11 @@ before(() => {
     const baseUrl = Cypress.env('dhis2BaseUrl')
     const instanceVersion = Cypress.env('dhis2InstanceVersion')
 
+    cy.task(
+        'log',
+        `Attempting to log in with user: ${username} on base URL: ${baseUrl}`
+    )
+
     cy.request({
         url: `${baseUrl}/${LOGIN_ENDPOINT}`,
         method: 'POST',
@@ -46,37 +51,77 @@ before(() => {
             j_password: password,
             '2fa_code': '',
         },
-    }).should((response) => {
+    }).then((response) => {
+        cy.task('log', `Login request returned status: ${response.status}`)
         expect(response.status).to.eq(200)
     })
 
-    cy.getAllCookies()
-        .should((cookies) => {
-            expect(cookies.length).to.be.at.least(1)
-        })
-        .then((cookies) => {
-            const sessionCookieForBaseUrl = findSessionCookieForBaseUrl(
-                baseUrl,
-                cookies
+    cy.getAllCookies().then((cookies) => {
+        cy.task(
+            'log',
+            `Cookies after login attempt: ${JSON.stringify(cookies)}`
+        )
+
+        const sessionCookieForBaseUrl = findSessionCookieForBaseUrl(
+            baseUrl,
+            cookies
+        )
+        if (sessionCookieForBaseUrl) {
+            cy.task(
+                'log',
+                `Found session cookie for base URL: ${JSON.stringify(
+                    sessionCookieForBaseUrl
+                )}`
             )
             Cypress.env(
                 computeEnvVariableName(instanceVersion),
                 JSON.stringify(sessionCookieForBaseUrl)
             )
-        })
+        } else {
+            cy.task('log', `Session cookie not found for base URL: ${baseUrl}`)
+        }
+    })
 })
 
 beforeEach(() => {
     const baseUrl = Cypress.env('dhis2BaseUrl')
     const instanceVersion = Cypress.env('dhis2InstanceVersion')
     const envVariableName = computeEnvVariableName(instanceVersion)
-    const { name, value, ...options } = JSON.parse(Cypress.env(envVariableName))
+    const sessionCookie = Cypress.env(envVariableName)
+
+    cy.task(
+        'log',
+        `Setting session cookie for base URL: ${baseUrl} with cookie data: ${sessionCookie}`
+    )
+
+    const { name, value, ...options } = JSON.parse(sessionCookie)
 
     localStorage.setItem(LOCAL_STORAGE_KEY, baseUrl)
     cy.setCookie(name, value, options)
 
-    cy.getAllCookies().should((cookies) => {
+    cy.getAllCookies().then((cookies) => {
+        cy.task('log', `Cookies in beforeEach: ${JSON.stringify(cookies)}`)
         expect(findSessionCookieForBaseUrl(baseUrl, cookies)).to.exist
         expect(localStorage.getItem(LOCAL_STORAGE_KEY)).to.equal(baseUrl)
     })
+
+    // // Intercept and log api requests
+    // cy.intercept('/api/**').as('apiRequests')
+    // cy.wait('@apiRequests').then((interception) => {
+    //     cy.task('log', `Intercepted request: ${JSON.stringify(interception)}`)
+    // })
+
+    // Log the current URL
+    cy.url().then((currentUrl) => {
+        cy.task(
+            'log',
+            `Current URL after setting session cookie: ${currentUrl}`
+        )
+        if (currentUrl.includes('login')) {
+            throw new Error('Still on login page after setting session cookie.')
+        }
+    })
+
+    // Force a reload to ensure all resources are loaded
+    // cy.reload()
 })

package.json

@@ -30,6 +30,7 @@
         "@testing-library/jest-dom": "^5.16.4",
         "@testing-library/react": "^12.1.4",
         "cypress": "^13.10.0",
+        "cypress-multi-reporters": "^1.6.4",
         "cypress-tags": "^1.2.2",
         "enzyme": "^3.11.0",
         "enzyme-adapter-react-16": "^1.15.8",

yarn.lock

@@ -7007,6 +7007,14 @@ csstype@^3.0.2:
   resolved "https://registry.yarnpkg.com/csstype/-/csstype-3.1.1.tgz#841b532c45c758ee546a11d5bd7b7b473c8c30b9"
   integrity sha512-DJR/VvkAvSZW9bTouZue2sSxDwdTN92uHjqeKVm+0dAqdfNykRzQ95tay8aXMBAAPpUiq4Qcug2L7neoRh2Egw==
 
+cypress-multi-reporters@^1.6.4:
+  version "1.6.4"
+  resolved "https://registry.yarnpkg.com/cypress-multi-reporters/-/cypress-multi-reporters-1.6.4.tgz#6f9d25ed8a0d8d7fa5597977adcd2237d1249931"
+  integrity sha512-3xU2t6pZjZy/ORHaCvci5OT1DAboS4UuMMM8NBAizeb2C9qmHt+cgAjXgurazkwkPRdO7ccK39M5ZaPCju0r6A==
+  dependencies:
+    debug "^4.3.4"
+    lodash "^4.17.21"
+
 cypress-tags@^1.2.2:
   version "1.2.2"
   resolved "https://registry.yarnpkg.com/cypress-tags/-/cypress-tags-1.2.2.tgz#1d992a3eb7f5db9b8b87911cc82c94d7ee9dd217"