End-to-end tests

The end-to-end suite runs Playwright against a local Cozy Stack and CouchDB started with Docker Compose. It provisions two test instances, Alice and Bob, and installs the Drive app in each instance.

Prerequisites

• Node version from .nvmrc and dependencies installed with yarn install
• Docker with the Compose plugin available as docker compose
• The host ports 18080, 15984, and 16060 available (can be configured via COZY_E2E_STACK_PORT, COZY_E2E_COUCHDB_PORT, COZY_E2E_ADMIN_PORT)
• A production build of Drive
• Playwright Chromium installed

Prepare the environment once:

yarn build
yarn e2e:setup

Run the suite

yarn e2e

The default lifecycle is destructive. It removes the E2E Compose runtime before the suite starts and after it finishes. Use it when a clean E2E state is wanted.

The suite uses one Playwright worker because its scenarios share Alice and Bob fixture state. Do not run two local suites at the same time: they target the same Compose project and host ports.

Reuse a local runtime

Set E2E_PERSIST=1 to leave the runtime running and reuse it on the next run:

yarn e2e:persist
yarn e2e:persist

yarn e2e:persist sets E2E_PERSIST=1. Persistent runs do not run Compose cleanup and start with --no-recreate. Setup is idempotent: existing Alice and Bob instances, Drive installations, feature flags, and contacts are reused.

E2E_SKIP_TEARDOWN=1 is kept as a compatibility alias for E2E_PERSIST=1. Use E2E_PERSIST in new commands.

Reset a persistent runtime

To explicitly discard the current runtime data before running the suite while keeping the newly provisioned runtime afterwards:

yarn e2e:reset

yarn e2e:reset sets both E2E_PERSIST=1 and E2E_RESET=1. E2E_RESET=1 runs docker compose down --volumes before startup. Without E2E_PERSIST=1, the normal teardown also runs after the suite.

To remove the runtime without running tests:

docker compose -f docker-compose.e2e.yml down --volumes

Isolate a test runtime

By default, the E2E suite uses the default Docker Compose project name. If you need to isolate a test run from an existing persistent runtime, use E2E_PROJECT_NAME:

E2E_PROJECT_NAME=custom-harness yarn e2e

The harness will apply this explicit Compose identity to all startup, lifecycle, and teardown commands. To run concurrent suites, combine E2E_PROJECT_NAME with custom port overrides (COZY_E2E_STACK_PORT, etc.) to prevent port collisions.

Debugging and reports

# Run headed with the Playwright inspector
yarn e2e:debug

# Open the last HTML report
yarn e2e:report