Merge pull request #3138 from nextcloud/backport/3137/master

nextcloud · Aug 27, 2024 · 466f467 · 466f467
2 parents 3aff08c + 22e9f66
commit 466f467
Show file tree

Hide file tree

Showing 10 changed files with 3,540 additions and 2,373 deletions.
diff --git a/.github/workflows/cypress.yml b/.github/workflows/cypress.yml
@@ -18,20 +18,19 @@ 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 }}
+  # Server requires head_ref instead of base_ref, as we want to test the PR branch
+  BRANCH: ${{ github.head_ref || github.ref_name }}
 
 jobs:
   init:
-    runs-on: ubuntu-latest-low
+    runs-on: ubuntu-latest
     outputs:
       nodeVersion: ${{ steps.versions.outputs.nodeVersion }}
       npmVersion: ${{ steps.versions.outputs.npmVersion }}
 
     env:
+      # We'll install cypress in the cypress job
+      CYPRESS_INSTALL_BINARY: 0
       PUPPETEER_SKIP_DOWNLOAD: true
 
     steps:
@@ -88,8 +87,11 @@ jobs:
       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: ['1', '2', '3']
+        # Please increase the number or runners as your tests suite grows (0 based index for e2e tests)
+        containers: ['0', '1', '2']
+        # Hack as strategy.job-total includes the component and GitHub does not allow math expressions
+        # Always align this number with the total of e2e runners (max. index + 1)
+        total-containers: [3]
 
     name: runner ${{ matrix.containers }}
 
@@ -109,17 +111,19 @@ jobs:
       - name: Set up npm ${{ needs.init.outputs.npmVersion }}
         run: npm i -g 'npm@${{ needs.init.outputs.npmVersion }}'
 
+      - name: Install cypress
+        run: ./node_modules/cypress/bin/cypress install
+
       - name: Run ${{ matrix.containers == 'component' && 'component' || 'E2E' }} cypress tests
         uses: cypress-io/github-action@df7484c5ba85def7eef30db301afa688187bc378 # v6.7.2
         with:
-          record: ${{ secrets.CYPRESS_RECORD_KEY && true }}
-          parallel: ${{ secrets.CYPRESS_RECORD_KEY && true }}
-          # cypress run type
+          # We already installed the dependencies in the init job
+          install: false
           component: ${{ matrix.containers == 'component' }}
-          group: ${{ secrets.CYPRESS_RECORD_KEY && env.CYPRESS_GROUP }}
+          group: ${{ matrix.use-cypress-cloud && matrix.containers == 'component' && 'Run component' || matrix.use-cypress-cloud && 'Run E2E' || '' }}
           # cypress env
-          ci-build-id: ${{ secrets.CYPRESS_RECORD_KEY && env.CYPRESS_BUILD_ID }}
-          tag: ${{ secrets.CYPRESS_RECORD_KEY && github.event_name }}
+          ci-build-id: ${{ matrix.use-cypress-cloud && format('{0}-{1}', github.sha, github.run_number) || '' }}
+          tag: ${{ matrix.use-cypress-cloud && github.event_name || '' }}
         env:
           # Needs to be prefixed with CYPRESS_
           CYPRESS_BRANCH: ${{ env.BRANCH }}
@@ -129,11 +133,11 @@ jobs:
           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' }}
+          SPLIT: ${{ matrix.total-containers }}
+          SPLIT_INDEX: ${{ matrix.containers == 'component' && 0 || matrix.containers }}
 
       - name: Upload snapshots
-        uses: actions/upload-artifact@834a144ee995460fba8ed112a2fc961b36a5ec5a # v4.3.6
+        uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4.3.4
         if: always()
         with:
           name: snapshots_${{ matrix.containers }}
@@ -144,7 +148,7 @@ jobs:
         run: docker logs nextcloud-cypress-tests-${{ env.APP_NAME }} > nextcloud.log
 
       - name: Upload NC logs
-        uses: actions/upload-artifact@834a144ee995460fba8ed112a2fc961b36a5ec5a # v4.3.6
+        uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4.3.4
         if: failure() && matrix.containers != 'component'
         with:
           name: nc_logs_${{ matrix.containers }}

diff --git a/cypress.config.ts b/cypress.config.ts
@@ -1,11 +1,6 @@
-/**
- * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
- * SPDX-License-Identifier: AGPL-3.0-or-later
- */
-import { configureNextcloud, startNextcloud, stopNextcloud, waitOnNextcloud } from './cypress/dockerNode'
+import { configureNextcloud, startNextcloud, stopNextcloud, waitOnNextcloud } from '@nextcloud/cypress/docker'
 import { defineConfig } from 'cypress'
-
-import getCompareSnapshotsPlugin from 'cypress-visual-regression/dist/plugin'
+import cypressSplit from 'cypress-split'
 
 export default defineConfig({
 	projectId: 'xcmgay',
@@ -14,10 +9,9 @@ export default defineConfig({
 	viewportWidth: 1280,
 	viewportHeight: 720,
 
-	requestTimeout: 20000,
-
+	// Tries again 2 more times on failure
 	retries: {
-		runMode: 0,
+		runMode: 2,
 		// do not retry in `cypress open`
 		openMode: 0,
 	},
@@ -32,40 +26,14 @@ export default defineConfig({
 	// https://github.com/cypress-io/cypress/issues/871
 	scrollBehavior: 'center',
 
-	// Visual regression testing
-	env: {
-		failSilently: false,
-		type: 'actual',
-	},
-	screenshotsFolder: 'cypress/snapshots/actual',
-	trashAssetsBeforeRuns: true,
-
 	e2e: {
-		// Disable isolation
+		// Disable session isolation
 		testIsolation: false,
 
 		// We've imported your old cypress plugins here.
 		// You may want to clean this up later by importing these.
 		async setupNodeEvents(on, config) {
-			getCompareSnapshotsPlugin(on, config)
-
-			// Disable spell checking to prevent rendering differences
-			on('before:browser:launch', (browser, launchOptions) => {
-				if (browser.family === 'chromium' && browser.name !== 'electron') {
-					launchOptions.preferences.default['browser.enable_spellchecking'] = false
-					return launchOptions
-				}
-
-				if (browser.family === 'firefox') {
-					launchOptions.preferences['layout.spellcheckDefault'] = 0
-					return launchOptions
-				}
-
-				if (browser.name === 'electron') {
-					launchOptions.preferences.spellcheck = false
-					return launchOptions
-				}
-			})
+			cypressSplit(on, config)
 
 			// Remove container after run
 			on('after:run', () => {
@@ -76,17 +44,12 @@ export default defineConfig({
 
 			// Before the browser launches
 			// starting Nextcloud testing container
-			return startNextcloud(process.env.BRANCH)
-				.then((ip) => {
-					// Setting container's IP as base Url
-					config.baseUrl = `http://${ip}/index.php`
-					return ip
-				})
-				.then(waitOnNextcloud)
-				.then(() => configureNextcloud(process.env.BRANCH))
-				.then(() => {
-					return config
-				})
+			const ip = await startNextcloud(process.env.BRANCH)
+			// Setting container's IP as base Url
+			config.baseUrl = `http://${ip}/index.php`
+			await waitOnNextcloud(ip)
+			await configureNextcloud(['groupfolders']) // pass empty array as WE are already the viewer
+			return config
 		},
 	},
-})
+})