Updating cypress.yml workflow from template

Signed-off-by: Nextcloud bot <bot@nextcloud.com>

.github/workflows/cypress.yml

@@ -5,120 +5,142 @@ on:
   push:
     branches:
       - main
+      - master
       - stable*
 
 env:
-  APP_NAME: deck
+  # Adjust APP_NAME if your repository name is different
-  CYPRESS_baseUrl: http://localhost:8081/index.php
+  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:
+  init:
-
     runs-on: ubuntu-latest
+    outputs:
+      nodeVersion: ${{ steps.versions.outputs.nodeVersion }}
+      npmVersion: ${{ steps.versions.outputs.npmVersion }}
+
+    steps:
+      - name: Checkout app
+        uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
+
+      - name: Check composer.json
+        id: check_composer
+        uses: andstor/file-existence-action@20b4d2e596410855db8f9ca21e96fbe18e12930b # v2
+        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@0ce2ed60f6df073a62a77c0a4958dd0fc68e32e7 # v2.1
+        id: versions
+        with:
+          fallbackNode: "^20"
+          fallbackNpm: "^9"
+
+      - name: Set up node ${{ steps.versions.outputs.nodeVersion }}
+        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
+        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:
-        node-version: [14.x]
+        # Run multiple copies of the current job in parallel
-        # containers: [1, 2, 3]
+        # Please increase the number or runners as your tests suite grows
-        php-versions: [ '8.0' ]
+        containers: ["component", 1, 2, 3]
-        databases: [ 'sqlite' ]
+
-        server-versions: [ 'master' ]
+    name: runner ${{ matrix.containers }}
 
     steps:
-      - name: Use Node.js ${{ matrix.node-version }}
+      - name: Restore context
-        uses: actions/setup-node@v3
+        uses: buildjet/cache/restore@e376f15c6ec6dc595375c78633174c7e5f92dc0e # v3
         with:
-          node-version: ${{ matrix.node-version }}
+          fail-on-cache-miss: true
-      - name: Set up npm7
+          key: cypress-context-${{ github.run_id }}
-        run: npm i -g npm@7
+          path: ./
 
-      - name: Register text Git reference
+      - name: Set up node ${{ needs.init.outputs.nodeVersion }}
-        run: |
+        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
-          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 server
-        uses: actions/checkout@v3
         with:
-          repository: nextcloud/server
+          node-version: ${{ needs.init.outputs.nodeVersion }}
-          ref: ${{ matrix.server-versions }}
 
-      - name: Checkout submodules
+      - name: Set up npm ${{ needs.init.outputs.npmVersion }}
-        shell: bash
+        run: npm i -g npm@"${{ needs.init.outputs.npmVersion }}"
-        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 ${{ env.APP_NAME }}
+      - name: Run ${{ matrix.containers == 'component' && 'component' || 'E2E' }} cypress tests
-        uses: actions/checkout@v3
+        uses: cypress-io/github-action@db1693016f23ccf9043f4b2428f9b04e5d502a73 # v5.8.1
-        with:
-          path: apps/${{ env.APP_NAME }}
-
-      - name: Checkout text
-        uses: actions/checkout@v3
-        with:
-          repository: nextcloud/text
-          ref: ${{ env.text_app_ref }}
-          path: apps/text
-
-      - name: Set up php ${{ matrix.php-versions }}
-        uses: shivammathur/setup-php@2.25.4
-        with:
-          php-version: ${{ matrix.php-versions }}
-          extensions: mbstring, iconv, fileinfo, intl, sqlite, pdo_sqlite, zip, gd, apcu
-          ini-values:
-            apc.enable_cli=on
-          coverage: none
-
-      - name: Set up Nextcloud
-        env:
-          DB_PORT: 4444
-          PHP_CLI_SERVER_WORKERS: 10
-        run: |
-          mkdir data
-          php 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
-          php occ config:system:set memcache.local --value="\\OC\\Memcache\\APCu"
-          php occ config:system:set debug --value=true --type=boolean
-          php -f index.php
-          php -S 0.0.0.0:8081 &
-          export OC_PASS=1234561
-          php occ user:add --password-from-env user1
-          php occ user:add --password-from-env user2
-          php occ app:enable deck
-          php occ app:list
-          cd apps/deck
-          composer install --no-dev
-          npm ci
-          npm run build
-          cd ../../
-          curl -v http://localhost:8081/index.php/login
-
-      - name: Cypress run
-        uses: cypress-io/github-action@v5
         with:
           record: true
-          parallel: false
+          parallel: true
-          wait-on: '${{ env.CYPRESS_baseUrl }}'
+          # cypress run type
-          working-directory: 'apps/${{ env.APP_NAME }}'
+          component: ${{ matrix.containers == 'component' }}
-          config: defaultCommandTimeout=10000,video=false
+          group: Run ${{ matrix.containers == 'component' && 'component' || 'E2E' }}
+          # cypress env
+          ci-build-id: ${{ github.sha }}-${{ github.run_number }}
+          tag: ${{ 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 }}
-          npm_package_name: ${{ env.APP_NAME }}
 
-      - name: Upload test failure screenshots
+      - name: Upload snapshots
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
-        if: failure()
+        if: always()
         with:
-          name: Upload screenshots
+          name: snapshots_${{ matrix.containers }}
-          path: apps/${{ env.APP_NAME }}/cypress/screenshots/
+          path: cypress/snapshots
-          retention-days: 5
 
-      - name: Upload nextcloud logs
+      - name: Extract NC logs
-        uses: actions/upload-artifact@v3
+        if: failure() && matrix.containers != 'component'
-        if: failure()
+        run: docker logs nextcloud-cypress-tests-${{ env.APP_NAME }} > nextcloud.log
+
+      - name: Upload NC logs
+        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+        if: failure() && matrix.containers != 'component'
         with:
-          name: Upload nextcloud log
+          name: nc_logs_${{ matrix.containers }}
-          path: data/nextcloud.log
+          path: nextcloud.log
-          retention-days: 5
+
+  summary:
+    runs-on: ubuntu-latest
+    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