Reduce Cypress Execution Time with Github Actions Parallel Jobs

.github/workflows/test.yml

@@ -1,62 +1,68 @@
 name: Test
 on: [push, pull_request]
 jobs:
-  Tests:
+  CypressMockTests:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        node-version: [18.x]
+        container: [1, 2, 3, 4, 5] # Creates 5 parallel executions for Cypress tests.
     steps:
       - uses: actions/checkout@v4
-      - name: Setup Node.js ${{ matrix.node-version }}
+
+      - name: Setup Node.js
         uses: actions/[email protected]
         with:
-          node-version: ${{ matrix.node-version }}
-      - name: Node.js modules cache, repository
-        uses: actions/cache@v4
-        id: repo-cache
-        with:
-          path: ${{ github.workspace }}/node_modules
-          key: ${{ runner.os }}-${{ matrix.node-version }}-modules-repo-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ matrix.node-version }}-modules-repo
-      - name: Node.js modules cache, backend
-        uses: actions/cache@v4
-        id: backend-cache
-        with:
-          path: ${{ github.workspace }}/backend/node_modules
-          key: ${{ runner.os }}-${{ matrix.node-version }}-modules-backend-${{ hashFiles('**/backend/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ matrix.node-version }}-modules-backend
-      - name: Node.js modules cache, frontend
-        uses: actions/cache@v4
-        id: frontend-cache
-        with:
-          path: |
-            ~/.cache/Cypress
-            ${{ github.workspace }}/frontend/node_modules
-          key: ${{ runner.os }}-${{ matrix.node-version }}-modules-frontend-${{ hashFiles('**/frontend/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ matrix.node-version }}-modules-frontend
-      - name: Install Node.js packages
-        if: ${{ steps.repo-cache.outputs.cache-hit != 'true' || steps.backend-cache.outputs.cache-hit != 'true' || steps.frontend-cache.outputs.cache-hit != 'true' }}
+          node-version: '18.x'
+
+      - name: Install Node.js packages for Cypress
         run: npm install
-      - name: Check for uncomitted changes
+
+      - name: Get test files
+        id: test-files
         run: |
-          git diff --exit-code
-      - name: Test backend & test frontend with code coverage
-        if: ${{ success() }}
-        run: npm run test:backend && npm run test:frontend:coverage
-      - name: Upload coverage reports to Codecov
-        uses: codecov/[email protected]
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          fail_ci_if_error: false
-          name: frontend
-          directory: ./frontend/coverage
-          verbose: true
-      - uses: actions/upload-artifact@v4
-        if: ${{ always() }}
-        with:
-          name: cypress-results
-          path: ./frontend/src/__tests__/cypress/results/
+          echo "Current working directory:"
+          pwd
+
+          TEST_DIR="frontend/src/__tests__/cypress/cypress/tests/mocked"
+          echo "Listing contents of the current directory:"
+          ls -la
+          echo "Checking for test files in $TEST_DIR"
+
+          echo "Listing contents of frontend/src/__tests__/cypress/cypress/tests:"
+          ls -la frontend/src/__tests__/cypress/cypress/tests/
+
+          if [ -d "$TEST_DIR" ]; then
+            echo "Listing contents of mocked directory:"
+            ls -la "$TEST_DIR" 
+
+            TEST_FILES=$(find "$TEST_DIR" -name "*.cy.ts" | tr '\n' ',')
+            echo "Found test files: $TEST_FILES"
+
+            echo "files=$TEST_FILES" >> $GITHUB_OUTPUT
+          else
+            echo "Directory does not exist. No test files found." >> $GITHUB_OUTPUT
+            echo "files=" >> $GITHUB_OUTPUT  # Set empty output if no files found
+          fi
+
+      - name: Run Cypress Mock Tests in Parallel
+        env:
+          CONTAINER_INDEX: ${{ matrix.container }}
+          TEST_FILES: ${{ steps.test-files.outputs.files }}
+        run: |
+          echo "Running Cypress tests for container $CONTAINER_INDEX..."
+          echo "Test Files: $TEST_FILES"  
+
+          # Generate the list of spec files for this container and trim trailing comma
+          SPEC_FILES=$(echo "$TEST_FILES" | tr ',' '\n' | awk -v container="$CONTAINER_INDEX" 'NR % 5 == container - 1' | sed 's|^frontend/||' | tr '\n' ',' | sed 's/,$//')
+
+          # Check if SPEC_FILES is empty
+          if [ -z "$SPEC_FILES" ]; then
+            echo "No spec files found for container $CONTAINER_INDEX. Skipping Cypress tests."
+            exit 0
+          else
+            echo "Spec files for this container: $SPEC_FILES"
+            export SPEC_PATTERN="$SPEC_FILES"
+            echo "Running Cypress with spec pattern: ${SPEC_PATTERN}"
+            cd frontend && npm run test:cypress-ci
+          fi

frontend/package.json

@@ -35,14 +35,16 @@
     "test:jest": "jest",
     "test:jest:coverage": "rimraf jest-coverage && jest --silent --coverage --coverageReporters=json --coverageReporters=lcov",
     "test:unit": "npm run test:jest -- --silent",
-    "test:cypress-ci": "npx concurrently -P -k -s first \"npm run cypress:server:build && npm run cypress:server\" \"npx wait-on tcp:127.0.0.1:9001 && npm run cypress:run:mock -- {@}\" -- ",
+    "test:unit-coverage": "run-s test:lint test:type-check test:jest:coverage",
+    "test:cypress-ci": "npx concurrently -P -k -s first \"npm run cypress:server:build && npm run cypress:server\" \"npx wait-on tcp:127.0.0.1:9001 && CY_MOCK=1 CY_WS_PORT=9002 npm run cypress:run -- --headless --project src/__tests__/cypress --spec '${SPEC_PATTERN}'\"",
     "test:cypress-ci:coverage": "npx concurrently -P -k -s first \"npm run cypress:server:build:coverage && npm run cypress:server\" \"npx wait-on tcp:127.0.0.1:9001 && npm run cypress:run:mock:coverage\"",
     "coverage:merge": "rimraf coverage && istanbul-merge --out coverage/coverage-final.json jest-coverage/coverage-final.json src/__tests__/cypress/coverage/coverage-final.json && nyc report --reporter html -t coverage --report-dir coverage/report && nyc report --reporter json-summary -t coverage --report-dir coverage",
     "cypress:open": "cypress open --project src/__tests__/cypress",
     "cypress:run": "cypress run -b chrome --project src/__tests__/cypress",
     "cypress:open:mock": "CY_MOCK=1 CY_WS_PORT=9002 npm run cypress:open -- ",
     "cypress:run:mock": "CY_MOCK=1 CY_WS_PORT=9002 npm run cypress:run -- ",
     "cypress:run:mock:coverage": "rimraf src/__tests__/cypress/coverage src/__tests__/cypress/.nyc_output && CY_COVERAGE=true npm run cypress:run:mock",
+    "cypress:run:mock:coverage:parallel": "cypress run --coverage",
     "cypress:open:record": "CY_RECORD=1 npm run cypress:open",
     "cypress:run:record": "CY_RECORD=1 npm run cypress:run && npm run cypress:format",
     "cypress:server:build": "ODH_DIST_DIR=./public-cypress POLL_INTERVAL=9999999 FAST_POLL_INTERVAL=9999999 WS_HOSTNAME=localhost:9002 npm run build",

package.json

@@ -39,8 +39,12 @@
     "test": "run-s test:backend test:frontend",
     "test:backend": "cd ./backend && npm run test",
     "test:frontend": "cd ./frontend && npm run test",
-    "test:frontend:coverage": "cd ./frontend && npm run test:coverage",
-    "test:cypress-ci": "cd ./frontend && npm run test:cypress-ci -- ",
+    "test:frontend:unit-coverage": "cd ./frontend && npm run test:unit-coverage",
+
+    "test:cypress-ci": "CY_MOCK=1 CY_WS_PORT=9002 npm run cypress:run",
+    "test:cypress-ci:parallel": "cd ./frontend && npm run cypress:server:build:coverage && npm run cypress:server & npx wait-on tcp:127.0.0.1:9001 && npm run cypress:run:mock:coverage",
+    "cypress:run:mock:coverage": "cypress run --coverage",
+    "cypress:run:mock:coverage:parallel": "cypress run --coverage",
     "test:unit": "cd ./frontend && npm run test:unit",
     "test:fix": "run-s test:fix-backend test:fix-frontend",
     "test:fix-backend": "cd ./backend && npm run test:fix",