ci: Run cypress tests properly again on CI #6462
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # This workflow is provided via the organization template repository | |
| # | |
| # https://github.com/nextcloud/.github | |
| # https://docs.github.com/en/actions/learn-github-actions/sharing-workflows-with-your-organization | |
| # | |
| # SPDX-FileCopyrightText: 2023-2024 Nextcloud GmbH and Nextcloud contributors | |
| # SPDX-License-Identifier: MIT | |
| name: Cypress | |
| on: pull_request | |
| concurrency: | |
| group: cypress-${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| env: | |
| # Adjust APP_NAME if your repository name is different | |
| APP_NAME: ${{ github.event.repository.name }} | |
| # This represents the server branch to checkout. | |
| # Usually it's the base branch of the PR, but for pushes it's the branch itself. | |
| # e.g. 'main', 'stable27' or 'feature/my-feature' | |
| # n.b. server will use head_ref, as we want to test the PR branch. | |
| BRANCH: ${{ github.base_ref || github.ref_name }} | |
| jobs: | |
| init: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| nodeVersion: ${{ steps.versions.outputs.nodeVersion }} | |
| npmVersion: ${{ steps.versions.outputs.npmVersion }} | |
| env: | |
| PUPPETEER_SKIP_DOWNLOAD: true | |
| steps: | |
| - name: Checkout app | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| - name: Check composer.json | |
| id: check_composer | |
| uses: andstor/file-existence-action@076e0072799f4942c8bc574a82233e1e4d13e9d6 # v3.0.0 | |
| with: | |
| files: "composer.json" | |
| - name: Install composer dependencies | |
| if: steps.check_composer.outputs.files_exists == 'true' | |
| run: composer install --no-dev | |
| - name: Read package.json node and npm engines version | |
| uses: skjnldsv/read-package-engines-version-actions@06d6baf7d8f41934ab630e97d9e6c0bc9c9ac5e4 # v3 | |
| id: versions | |
| with: | |
| fallbackNode: "^20" | |
| fallbackNpm: "^10" | |
| - name: Set up node ${{ steps.versions.outputs.nodeVersion }} | |
| uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 | |
| with: | |
| node-version: ${{ steps.versions.outputs.nodeVersion }} | |
| - name: Set up npm ${{ steps.versions.outputs.npmVersion }} | |
| run: npm i -g 'npm@${{ steps.versions.outputs.npmVersion }}' | |
| - name: Install node dependencies & build app | |
| run: | | |
| npm ci | |
| TESTING=true npm run build --if-present | |
| - name: Save context | |
| uses: buildjet/cache/save@e376f15c6ec6dc595375c78633174c7e5f92dc0e # v3 | |
| with: | |
| key: cypress-context-${{ github.run_id }} | |
| path: ./ | |
| cypress: | |
| runs-on: ubuntu-latest | |
| needs: init | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| # Run multiple copies of the current job in parallel | |
| # Please increase the number or runners as your tests suite grows (0 based index for e2e tests) | |
| containers: [0, 1, 2, 3, 4, 5, 6, 7] | |
| # Hack as strategy.job-total includes the component and GitHub does not allow math expressions | |
| # Always aling this number with the total of e2e runners (max. index + 1) | |
| total-containers: [8] | |
| name: runner ${{ matrix.containers }} | |
| steps: | |
| - name: Restore context | |
| uses: buildjet/cache/restore@e376f15c6ec6dc595375c78633174c7e5f92dc0e # v3 | |
| with: | |
| fail-on-cache-miss: true | |
| key: cypress-context-${{ github.run_id }} | |
| path: ./ | |
| - name: Set up node ${{ needs.init.outputs.nodeVersion }} | |
| uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 | |
| with: | |
| node-version: ${{ needs.init.outputs.nodeVersion }} | |
| - name: Set up npm ${{ needs.init.outputs.npmVersion }} | |
| run: npm i -g 'npm@${{ needs.init.outputs.npmVersion }}' | |
| - name: Run ${{ matrix.containers == 'component' && 'component' || 'E2E' }} cypress tests | |
| uses: cypress-io/github-action@8d3918616d8ac34caa2b49afc8b408b6a872a6f5 # v6.7.1 | |
| with: | |
| record: ${{ secrets.CYPRESS_RECORD_KEY && true }} | |
| parallel: ${{ secrets.CYPRESS_RECORD_KEY && true }} | |
| # cypress run type | |
| component: ${{ matrix.containers == 'component' }} | |
| group: ${{ secrets.CYPRESS_RECORD_KEY && env.CYPRESS_GROUP }} | |
| # cypress env | |
| ci-build-id: ${{ secrets.CYPRESS_RECORD_KEY && env.CYPRESS_BUILD_ID }} | |
| tag: ${{ secrets.CYPRESS_RECORD_KEY && github.event_name }} | |
| env: | |
| # Needs to be prefixed with CYPRESS_ | |
| CYPRESS_BRANCH: ${{ env.BRANCH }} | |
| # https://github.com/cypress-io/github-action/issues/124 | |
| COMMIT_INFO_MESSAGE: ${{ github.event.pull_request.title }} | |
| # Needed for some specific code workarounds | |
| TESTING: true | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }} | |
| SPLIT: ${{ matrix.total-containers }} | |
| SPLIT_INDEX: ${{ matrix.containers == 'component' && 0 || matrix.containers }} | |
| - name: Upload snapshots | |
| uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4.3.4 | |
| if: always() | |
| with: | |
| name: snapshots_${{ matrix.containers }} | |
| path: cypress/snapshots | |
| - name: Extract NC logs | |
| if: failure() && matrix.containers != 'component' | |
| run: docker logs nextcloud-cypress-tests-${{ env.APP_NAME }} > nextcloud.log | |
| - name: Upload NC logs | |
| uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4.3.4 | |
| if: failure() && matrix.containers != 'component' | |
| with: | |
| name: nc_logs_${{ matrix.containers }} | |
| path: nextcloud.log | |
| summary: | |
| runs-on: ubuntu-latest-low | |
| needs: [init, cypress] | |
| if: always() | |
| name: cypress-summary | |
| steps: | |
| - name: Summary status | |
| run: if ${{ needs.init.result != 'success' || ( needs.cypress.result != 'success' && needs.cypress.result != 'skipped' ) }}; then exit 1; fi |