From 442ce0c004fce575a7b2f40eeff5a636e510d4c3 Mon Sep 17 00:00:00 2001 From: Nextcloud bot Date: Sun, 15 Sep 2024 09:48:48 +0000 Subject: [PATCH] chore(CI): Updating cypress.yml workflow from template Signed-off-by: Nextcloud bot --- .github/workflows/cypress.yml | 316 +++++++++++++++++----------------- 1 file changed, 155 insertions(+), 161 deletions(-) diff --git a/.github/workflows/cypress.yml b/.github/workflows/cypress.yml index a38d726..cab1b67 100644 --- a/.github/workflows/cypress.yml +++ b/.github/workflows/cypress.yml @@ -1,169 +1,163 @@ +# 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: - push: - branches: - - main - - master - - stable* +on: pull_request concurrency: - group: ${{ github.head_ref || github.run_id }} - cancel-in-progress: true + group: cypress-${{ github.head_ref || github.run_id }} + cancel-in-progress: true env: - APP_NAME: health - CYPRESS_baseUrl: http://127.0.0.1:8081/index.php + # 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: - cypress: - runs-on: ubuntu-22.04 - - strategy: - fail-fast: false - matrix: - node-version: [ 16 ] - databases: [ 'mysql' ] - server-versions: [ 'stable25', 'stable27', 'master' ] - include: - - php-versions: 8.1 - - services: - mysql: - image: ghcr.io/nextcloud/continuous-integration-mariadb-10.6:latest - ports: - - 4444:3306/tcp - env: - MYSQL_ROOT_PASSWORD: rootpassword - options: --health-cmd="mysqladmin ping" --health-interval 5s --health-timeout 2s --health-retries 5 - - steps: - - name: Disabled on forks - if: ${{ github.event.pull_request.head.repo.full_name != github.repository }} - run: | - echo 'Can not approve PRs from forks' - exit 1 - - - name: Checkout server - uses: actions/checkout@v3 - with: - repository: nextcloud/server - ref: ${{ matrix.server-versions }} - - - name: Checkout submodules - shell: bash - run: | - auth_header="$(git config --local --get http.https://github.com/.extraheader)" - git submodule sync --recursive - git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1 - - - name: Checkout viewer - uses: actions/checkout@v3 - with: - repository: nextcloud/viewer - ref: ${{ matrix.server-versions }} - path: apps/viewer - - - name: Register text Git reference - run: | - text_app_ref="$(if [ "${{ matrix.server-versions }}" = "master" ]; then echo -n "main"; else echo -n "${{ matrix.server-versions }}"; fi)" - echo "text_app_ref=$text_app_ref" >> $GITHUB_ENV - - - name: Checkout text app - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0 - with: - repository: nextcloud/text - path: apps/text - ref: ${{ env.text_app_ref }} - - - name: Checkout app - uses: actions/checkout@v3 - with: - path: apps/${{ env.APP_NAME }} - - - name: Set up node 16 - uses: actions/setup-node@v3 - with: - cache: 'npm' - cache-dependency-path: apps/${{ env.APP_NAME}}/package-lock.json - node-version: 16 - - - name: Install dependencies & build app - working-directory: apps/${{ env.APP_NAME }} - run: | - npm ci - TESTING=true npm run build --if-present - composer i --no-dev - - - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v3 - with: - node-version: ${{ matrix.node-version }} - - - name: Set up php ${{ matrix.php-versions }} - uses: shivammathur/setup-php@v2 - with: - php-version: ${{ matrix.php-versions }} - extensions: bz2, ctype, curl, dom, fileinfo, gd, iconv, intl, json, libxml, mbstring, openssl, pcntl, posix, session, simplexml, xmlreader, zip, zlib, sqlite, pdo_sqlite, apcu, pgsql, pdo_pgsql,mysql, pdo_mysql - ini-values: - apc.enable_cli=on - coverage: none - - - name: Set up Nextcloud - env: - DB_PORT: 4444 - PHP_CLI_SERVER_WORKERS: 20 - run: | - mkdir data - ./occ maintenance:install --verbose --database=${{ matrix.databases }} --database-name=nextcloud --database-host=127.0.0.1 --database-port=$DB_PORT --database-user=root --database-pass=rootpassword --admin-user admin --admin-pass admin - ./occ config:system:set hashing_default_password --value=true --type=boolean - ./occ config:system:set memcache.local --value="\\OC\\Memcache\\APCu" - ./occ config:system:set memcache.distributed --value="\\OC\\Memcache\\APCu" - cat config/config.php - ./occ user:list - ./occ app:enable --force text - ./occ app:enable --force ${{ env.APP_NAME }} - ./occ config:system:set query_log_file --value '/home/runner/work/${{ env.APP_NAME }}/${{ env.APP_NAME }}/query.log' - php -S 127.0.0.1:8081 > /tmp/requestlog 2>&1 & - export OC_PASS=1234561 - php occ user:add --password-from-env user1 - php occ user:add --password-from-env user2 - curl -v http://127.0.0.1:8081/index.php/login - cat data/nextcloud.log - - - name: Cypress run - uses: cypress-io/github-action@v4 - with: - wait-on: '${{ env.CYPRESS_baseUrl }}' - working-directory: 'apps/${{ env.APP_NAME }}' - config: defaultCommandTimeout=10000,video=false - env: - # https://github.com/cypress-io/github-action/issues/124 - COMMIT_INFO_MESSAGE: ${{ github.event.pull_request.title }} - COMMIT_INFO_SHA: ${{ github.event.pull_request.head.sha }} - CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }} - npm_package_name: ${{ env.APP_NAME }} - - - name: Print logs - if: always() - run: | - cat /tmp/requestlog - cat data/nextcloud.log - - - name: Upload test failure screenshots - uses: actions/upload-artifact@v2 - if: failure() - with: - name: Upload screenshots - path: apps/${{ env.APP_NAME }}/cypress/screenshots/ - retention-days: 5 - - - name: Upload nextcloud logs - uses: actions/upload-artifact@v2 - if: failure() - with: - name: Upload nextcloud log - path: data/nextcloud.log - retention-days: 5 + init: + runs-on: ubuntu-latest-low + outputs: + nodeVersion: ${{ steps.versions.outputs.nodeVersion }} + npmVersion: ${{ steps.versions.outputs.npmVersion }} + + env: + PUPPETEER_SKIP_DOWNLOAD: true + + steps: + - name: Disabled on forks + if: ${{ github.event.pull_request.head.repo.full_name != github.repository }} + run: | + echo 'Can not run cypress on forks' + exit 1 + + - 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@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3 + 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@v4 + 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 + containers: ['component', '1', '2', '3'] + + name: runner ${{ matrix.containers }} + + steps: + - name: Restore context + uses: buildjet/cache/save@v4 + 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@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3 + 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@0da3c06ed8217b912deea9d8ee69630baed1737e # v6.7.6 + 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 }} + CYPRESS_BUILD_ID: ${{ github.sha }}-${{ github.run_number }} + CYPRESS_GROUP: Run ${{ matrix.containers == 'component' && 'component' || 'E2E' }} + + - name: Upload snapshots + uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0 + 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@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0 + 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