Add WooCommerce end-to-end page type tests

Author: Tsvetan Stoychev

.github/workflows/ci.yml

@@ -100,6 +100,26 @@ jobs:
       - name: Test JavaScript loaders
         run: npm run test:js
 
+  woocommerce-e2e:
+    name: WooCommerce E2E page types
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+
+      - name: Run WooCommerce E2E suite
+        run: make woocommerce-e2e
+
+      - name: Upload WooCommerce E2E diagnostics
+        if: failure()
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: woocommerce-e2e-diagnostics
+          path: test-results/woocommerce-e2e
+          if-no-files-found: ignore
+
   unit:
     name: Unit (PHP ${{ matrix.php }})
     runs-on: ubuntu-latest
@@ -202,6 +222,7 @@ jobs:
       - quality
       - translations
       - javascript
+      - woocommerce-e2e
       - unit
       - integration
 

.github/workflows/prerelease.yml

@@ -23,6 +23,9 @@ jobs:
           BASICRUM_RELEASE_TAG: ${{ github.event.release.tag_name }}
         run: make conventions
 
+      - name: Run WooCommerce E2E page-type tests
+        run: make woocommerce-e2e
+
       - name: Setup release PHP
         uses: shivammathur/setup-php@f3e473d116dcccaddc5834248c87452386958240 # v2
         with:

.github/workflows/release.yml

@@ -23,6 +23,9 @@ jobs:
           BASICRUM_RELEASE_TAG: ${{ github.event.release.tag_name }}
         run: make conventions
 
+      - name: Run WooCommerce E2E page-type tests
+        run: make woocommerce-e2e
+
       - name: Setup release PHP
         uses: shivammathur/setup-php@f3e473d116dcccaddc5834248c87452386958240 # v2
         with:

AGENTS.md

@@ -32,6 +32,10 @@ namespace, PSR-4 Composer autoloading, PHP 7.4+, and WordPress 6.0+.
   hard-coded script handles.
 - Boomerang lives in `assets/js/boomr/`; standard and consent loaders live in
   `assets/js/loaders/`.
+- WooCommerce browser E2E tests are root-level test tooling. Keep the pinned
+  WooCommerce version and checksum synchronized in `tools/setup-woocommerce-e2e.sh`.
+  Review and update each Docker image tag and digest together in
+  `docker/woocommerce-e2e.yml`.
 - Pin third-party GitHub Actions to full 40-character commit SHAs. Keep the
   reviewed release tag in the adjacent comment and update pins through reviewed
   Dependabot pull requests.
@@ -50,6 +54,7 @@ make composer-audit
 make conventions
 make unit
 make js-test
+make woocommerce-e2e
 make integration-setup
 make integration
 make translations

Makefile

@@ -13,7 +13,7 @@ TEST_DB_PASS = root
 TEST_DB_HOST = db
 WP_TEST_VERSION ?= latest
 
-.PHONY: help build up down restart logs shell composer-install wp-install lint lint-fix lint-php analyse composer-validate composer-audit conventions translations js-install js-test integration-setup integration test package package-verify package-smoke clean
+.PHONY: help build up down restart logs shell composer-install wp-install lint lint-fix lint-php analyse composer-validate composer-audit conventions translations js-install js-test woocommerce-e2e integration-setup integration test package package-verify package-smoke clean
 
 help:
 	@echo "Targets:"
@@ -35,6 +35,7 @@ help:
 	@echo "  translations       Update POT, PO, and MO translation catalogs"
 	@echo "  js-install         Install locked JavaScript test dependencies"
 	@echo "  js-test            Run loader behavior tests in Chromium"
+	@echo "  woocommerce-e2e    Run WooCommerce page-type browser tests"
 	@echo "  unit               Run unit tests"
 	@echo "  integration-setup  Install WordPress test suite inside containers"
 	@echo "  integration        Run integration tests"
@@ -99,6 +100,9 @@ js-install:
 js-test: js-install
 	$(COMPOSE) run --rm --no-deps --user "$$(id -u):$$(id -g)" -e HOME=/tmp $(JS_SERVICE) npm run test:js
 
+woocommerce-e2e:
+	sh tools/run-woocommerce-e2e.sh
+
 unit:
 	$(COMPOSE) run --rm -w $(PLUGIN_WORKDIR) $(PHP_SERVICE) composer unit
 

README.md

@@ -28,6 +28,7 @@ make composer-audit
 make conventions
 make translations
 make js-test
+make woocommerce-e2e
 make package
 make package-smoke
 ```
@@ -121,6 +122,15 @@ intercept the synthetic Boomerang request, and block every unexpected network
 request. They cover consent gating, repeated opt-in, opt-out cleanup, and cookie
 behavior on HTTP, HTTPS, localhost, and subdomains.
 
+`make woocommerce-e2e` starts an isolated WordPress 6.9 and WooCommerce 10.9.4
+stack, seeds a product and completed order, then uses Playwright to visit the
+shop, product, cart, checkout, and order-received pages. It intercepts the
+synthetic collector and verifies the actual Basicrum beacon `p_type` values.
+The WooCommerce download is pinned and checksum-verified in
+`tools/setup-woocommerce-e2e.sh`; update its version and checksum together.
+The stack's Docker image tags and immutable digests are reviewed together in
+`docker/woocommerce-e2e.yml`.
+
 The JavaScript package, Playwright configuration, and browser tests live at the
 repository root. The release builder copies only `plugins/basicrum/`, and the
 release verifier also rejects Node or Playwright development files if they ever

checklist.md

@@ -93,6 +93,8 @@ Acceptance criteria:
 - [ ] Test the latest stable WordPress release with a currently supported PHP
   version.
 - [ ] Test WordPress trunk with the newest compatible PHP version.
+- [x] Add an isolated WooCommerce E2E suite covering shop, product, cart,
+  checkout, and order-received page types through actual Basicrum beacons.
 - [ ] Update `Tested up to` only after the stable integration test passes.
 - [ ] Document how compatibility metadata is updated for each release.
 

docker/woocommerce-e2e.yml

@@ -0,0 +1,88 @@
+services:
+  db:
+    # Reviewed tag: mysql:8.0
+    image: mysql:8.0@sha256:7dcddc01f13bab2f15cde676d44d01f61fc9f99fe7785e86196dfc07d358ae2b
+    command: --default-authentication-plugin=mysql_native_password
+    environment:
+      MYSQL_DATABASE: wordpress
+      MYSQL_USER: wordpress
+      MYSQL_PASSWORD: wordpress
+      MYSQL_ROOT_PASSWORD: root
+    healthcheck:
+      test: ["CMD", "mysqladmin", "ping", "-h", "127.0.0.1", "-proot"]
+      interval: 5s
+      timeout: 5s
+      retries: 20
+
+  wordpress:
+    # Reviewed tag: wordpress:6.9-php8.2-apache
+    image: wordpress:6.9-php8.2-apache@sha256:29a3af5db27d8c1716367575280bbf449cd231ced707daf8ce411895c042ed76
+    depends_on:
+      db:
+        condition: service_healthy
+    environment:
+      WORDPRESS_DB_HOST: db:3306
+      WORDPRESS_DB_NAME: wordpress
+      WORDPRESS_DB_USER: wordpress
+      WORDPRESS_DB_PASSWORD: wordpress
+    volumes:
+      - wordpress_data:/var/www/html
+      - plugin_workspace:/var/www/html/wp-content/plugins/basicrum:ro
+
+  wpcli:
+    # Reviewed tag: wordpress:cli-2.12.0-php8.2
+    image: wordpress:cli-2.12.0-php8.2@sha256:b93ed9324c515901534955dfb528b7e1de158827815d7bb699d774b6bb6df8aa
+    user: "33:33"
+    depends_on:
+      db:
+        condition: service_healthy
+    environment:
+      WORDPRESS_DB_HOST: db:3306
+      WORDPRESS_DB_NAME: wordpress
+      WORDPRESS_DB_USER: wordpress
+      WORDPRESS_DB_PASSWORD: wordpress
+      WP_URL: http://wordpress
+      WP_TITLE: Basicrum WooCommerce E2E
+      WP_ADMIN_USER: admin
+      WP_ADMIN_PASSWORD: basicrum-e2e-password
+      WP_ADMIN_EMAIL: admin@example.test
+      HTTP_HOST: wordpress
+    volumes:
+      - wordpress_data:/var/www/html
+      - plugin_workspace:/var/www/html/wp-content/plugins/basicrum:ro
+      - ../tools:/tools:ro
+
+  plugin:
+    # Reviewed tag: composer:2
+    image: composer:2@sha256:5946476338742b200bb9ff88f8be56275ddae4b3949c72305cb0dbf10cfcb760
+    entrypoint: ["sh", "-c"]
+    command:
+      - >-
+        rm -rf /workspace/vendor &&
+        tar -C /source --exclude='./vendor' -cf - . | tar -C /workspace -xf -
+    volumes:
+      - ../plugins/basicrum:/source:ro
+      - plugin_workspace:/workspace
+
+  composer:
+    # Reviewed tag: composer:2
+    image: composer:2@sha256:5946476338742b200bb9ff88f8be56275ddae4b3949c72305cb0dbf10cfcb760
+    working_dir: /workspace
+    volumes:
+      - plugin_workspace:/workspace
+
+  javascript:
+    # Reviewed tag: mcr.microsoft.com/playwright:v1.61.1-noble
+    image: mcr.microsoft.com/playwright:v1.61.1-noble@sha256:5b8f294aff9041b7191c34a4bab3ac270157a28774d4b0660e9743297b697e48
+    working_dir: /workspace
+    environment:
+      CI: "true"
+      HOME: /tmp
+      WOOCOMMERCE_E2E_BASE_URL: http://wordpress
+    volumes:
+      - ../:/workspace
+    ipc: host
+
+volumes:
+  wordpress_data:
+  plugin_workspace:

package.json

@@ -8,7 +8,8 @@
   "scripts": {
     "test": "npm run test:js",
     "test:js": "playwright test",
-    "test:js:headed": "playwright test --headed"
+    "test:js:headed": "playwright test --headed",
+    "test:e2e:woocommerce": "playwright test --config=playwright.woocommerce-e2e.config.js"
   },
   "devDependencies": {
     "@playwright/test": "1.61.1"

playwright.woocommerce-e2e.config.js

@@ -0,0 +1,37 @@
+const { defineConfig } = require( '@playwright/test' );
+
+const baseURL = process.env.WOOCOMMERCE_E2E_BASE_URL;
+
+if ( ! baseURL ) {
+	throw new Error( 'WOOCOMMERCE_E2E_BASE_URL must be set for WooCommerce E2E tests.' );
+}
+
+module.exports = defineConfig( {
+	testDir: './tests/e2e',
+	fullyParallel: false,
+	forbidOnly: Boolean( process.env.CI ),
+	retries: process.env.CI ? 1 : 0,
+	workers: 1,
+	reporter: process.env.CI
+		? [
+			[ 'line' ],
+			[ 'html', { outputFolder: 'test-results/woocommerce-e2e/report', open: 'never' } ],
+		]
+		: 'list',
+	timeout: 45_000,
+	expect: {
+		timeout: 20_000,
+	},
+	use: {
+		baseURL,
+		browserName: 'chromium',
+		headless: true,
+		ignoreHTTPSErrors: true,
+		actionTimeout: 10_000,
+		navigationTimeout: 30_000,
+		screenshot: 'only-on-failure',
+		trace: 'retain-on-failure',
+		video: 'retain-on-failure',
+	},
+	outputDir: 'test-results/woocommerce-e2e/results',
+} );