Changeset 65049

Timestamp:

10/30/2026 04:21:43 PM (2 days ago)

Author:

lancewillett

Message:

Build/Test Tools: Run E2E tests in parallel and serial projects.

Split the Playwright suite into parallel and serial projects, running each in a separate CI job for both SCRIPT_DEBUG settings. Keep the default all project on one worker for local runs, and give each CI job a distinct artifact name.

Remove the redundant media-upload login to avoid concurrent writes to shared authentication state. Document how to classify specs and check their execution order.

Developed in: ​https://github.com/WordPress/wordpress-develop/pull/14897

Props adrianmoldovanwp, lucatume.
See #66392.

Location:

trunk

Files:

• .github/workflows/end-to-end-tests.yml (modified) (1 diff)
• .github/workflows/reusable-end-to-end-tests.yml (modified) (4 diffs)
• tests/e2e/README.md (modified) (1 diff)
• tests/e2e/playwright.config.js (modified) (2 diffs)
• tests/e2e/specs/media-upload.test.js (modified) (1 diff)

trunk/.github/workflows/end-to-end-tests.yml

@@ -83 +83 @@
       matrix:
         LOCAL_SCRIPT_DEBUG: [ true, false ]
+        # See the "Projects" section in tests/e2e/README.md.
+        test-group: [ 'parallel', 'serial' ]
         # A matrix value is needed in the 'name' directive for proper grouping in the GitHub UI.
         label: [ 'E2E Tests' ]
     with:
       LOCAL_SCRIPT_DEBUG: ${{ matrix.LOCAL_SCRIPT_DEBUG }}
+      test-group: ${{ matrix.test-group }}
 
   slack-notifications:

trunk/.github/workflows/reusable-end-to-end-tests.yml

@@ -33 +33 @@
         type: 'boolean'
         default: true
+      test-group:
+        description: 'The Playwright project to run. Runs the default projects when empty.'
+        required: false
+        type: 'string'
+        default: ''
 
 env:
@@ -63 +68 @@
   # - Ensures version-controlled files are not modified or deleted.
   e2e-tests:
-    name: SCRIPT_DEBUG ${{ inputs.LOCAL_SCRIPT_DEBUG && 'enabled' || 'disabled' }}
+    name: ${{ inputs.test-group && format( '{0}, ', inputs.test-group ) || '' }}SCRIPT_DEBUG ${{ inputs.LOCAL_SCRIPT_DEBUG && 'enabled' || 'disabled' }}
     runs-on: ubuntu-24.04
     permissions:
@@ -148 +153 @@
 
       - name: Run E2E tests
-        run: npm run test:e2e
+        run: |
+          if [ -n "${TEST_GROUP}" ]; then
+            npm run test:e2e -- --project="${TEST_GROUP}"
+          else
+            npm run test:e2e
+          fi
         env:
+          TEST_GROUP: ${{ inputs.test-group }}
           # Chromium is installed above and is the only browser the suite runs. Without this,
           # `wp-scripts test-playwright` also downloads Firefox and WebKit on every run.
@@ -158 +169 @@
         if: always()
         with:
-          name: failures-artifacts${{ inputs.LOCAL_SCRIPT_DEBUG && '-SCRIPT_DEBUG' || '' }}-${{ github.run_id }}
+          name: failures-artifacts${{ inputs.test-group && format( '-{0}', inputs.test-group ) || '' }}${{ inputs.LOCAL_SCRIPT_DEBUG && '-SCRIPT_DEBUG' || '' }}-${{ github.run_id }}
           path: artifacts
           if-no-files-found: ignore

trunk/tests/e2e/README.md

@@ -41 +41 @@
 
 
+## Projects
+
+The suite has three Playwright projects, defined in `playwright.config.js`:
+
+* `all`: every spec, one at a time on one worker. `npm run test:e2e` runs this project.
+* `parallel`: specs that can share the site with other tests. Spec files run at the same time on several workers, one for every two CPU cores. Tests inside one file still run in order. Run it with `npm run test:e2e -- --project=parallel`.
+* `serial`: specs that break the site for other tests. They run one at a time on one worker. Run it with `npm run test:e2e -- --project=serial`.
+
+CI runs `parallel` and `serial` in separate jobs.
+
+New specs go in `parallel` by default. Add a spec to `SERIAL_SPECS` only if it makes the site unusable for other tests, or if it changes content or settings that other tests use, for example with `requestUtils.deleteAllPosts()`.
+
+Before you open a pull request with a new spec, run its project a few times with `--shuffle`. Playwright then runs the spec files in a random order, so a spec that needs another spec to run first, or that breaks a spec that runs after it, fails:
+
+```
+npm run test:e2e -- --project=parallel --shuffle
+```
+
+Playwright prints the seed of each run, for example `shuffle seed 317753389`. To run the same order again, give the seed: `--shuffle 317753389`.
+
 ## Documentation
 

trunk/tests/e2e/playwright.config.js

@@ -3 +3 @@
  */
 import path from 'node:path';
-import { defineConfig } from '@playwright/test';
+import { defineConfig, devices } from '@playwright/test';
 
 /**
@@ -16 +16 @@
 );
 
+const SERIAL_SPECS = [
+        'install.test.js',
+        'maintenance-mode.test.js',
+        'fatal-error-handler.test.js',
+        'login-localize-script.test.js',
+        'gutenberg-plugin.test.js',
+        'plugins.test.js',
+        'themes.test.js',
+        // These delete all posts or media, including other workers' content.
+        'cache-control-headers-directives.test.js',
+        'dashboard.test.js',
+        'edit-posts.test.js',
+        'empty-trash-restore-trashed-posts.test.js',
+        'media-library-client-side-upload.test.js',
+        'media-modal-client-side-upload.test.js',
+        'media-new-client-side-upload.test.js',
+];
+
 const config = defineConfig( {
         ...baseConfig,
         globalSetup: require.resolve( './config/global-setup.js' ),
+        workers: '50%',
         webServer: {
                 ...baseConfig.webServer,
                 command: 'npm run env:start',
         },
+        projects: [
+                {
+                        name: 'all',
+                        fullyParallel: false,
+                        workers: 1,
+                        use: { ...devices[ 'Desktop Chrome' ] },
+                },
+                {
+                        name: 'parallel',
+                        default: false,
+                        testIgnore: SERIAL_SPECS,
+                        fullyParallel: false,
+                        use: { ...devices[ 'Desktop Chrome' ] },
+                },
+                {
+                        name: 'serial',
+                        default: false,
+                        testMatch: SERIAL_SPECS,
+                        fullyParallel: false,
+                        workers: 1,
+                        use: { ...devices[ 'Desktop Chrome' ] },
+                },
+        ],
 } );
 

trunk/tests/e2e/specs/media-upload.test.js

@@ -10 +10 @@
 
 test( 'Test dismissing failed upload works correctly', async ({ page, admin, requestUtils }) => {
-        // Log in before visiting admin page.
-        await requestUtils.login();
         await admin.visitAdminPage( '/media-new.php' );