Merge pull request #8 from opf/isolate-test-launch-to-docker-container

Isolated playwright tests into docker container

Author: Ihor-Khomenko

.cursor/skills/tests/SKILL.md

@@ -127,15 +127,25 @@ try {
 - To run in headed mode, use Playwright’s native CLI flags, e.g.:
   - `npx playwright test --headed`
 - Default worker configuration:
-  - Single worker (`workers: 1`) to keep tests predictable and avoid cross-test interference.
-- Common commands:
+  - Single worker (`workers: 1`), overridable via `E2E_WORKERS` or `--workers`.
+- **Native (Node.js on host):**
   - Run tests: `npx playwright test`
   - Run tests headed: `npx playwright test --headed`
   - Run tests and open report: `npx playwright test && npx playwright show-report`
+- **Docker (zero local Node/browser):**
+  - Run all tests: `./run-tests.sh` (default `E2E_ENV=local`)
+  - Target env: `E2E_ENV=edge ./run-tests.sh` or `E2E_ENV=stage ./run-tests.sh`
+  - Pass Playwright args: `./run-tests.sh --grep @smoke`; force rebuild: `./run-tests.sh --build`
+  - Reports and traces are bind-mounted to `playwright-report/` and `test-results/` on the host.
+
+## Writing Style
+
+- Keep all documentation, comments, and README files short and precise.
+- No emojis, no decorative characters, no redundant explanations.
+- Only comment non-obvious logic; do not narrate what the code does.
 
 ## Self-Improvement Directive
 
-- After completing significant refactoring, introducing new patterns, or making architectural changes to this E2E codebase:
-  - Update this `SKILL.md` to reflect the new conventions, helpers, and standards.
-  - Keep the file concise and focused on project-specific knowledge that future sessions should follow by default.
+- After significant refactoring or architectural changes, update this `SKILL.md` to reflect new conventions.
+- Keep this file concise and focused on project-specific knowledge.
 

.dockerignore

@@ -0,0 +1,28 @@
+# Dependencies and build artifacts (installed in container)
+node_modules/
+.playwright-browsers/
+
+# Git
+.git/
+.gitignore
+
+# Reports and results (bind-mounted at runtime)
+playwright-report/
+test-results/
+
+# Local env (passed via env_file or env at runtime)
+.env
+.env.*
+!.env.example
+
+# IDE and OS
+.idea/
+.vscode/
+.DS_Store
+*.log
+
+# Cursor
+.cursor/
+
+# Plan files (not needed in image)
+*.plan.md

.gitignore

@@ -13,4 +13,6 @@ playwright-report/
 test-results/
 .playwright-browsers/
 
+docker-compose.override.yml
+
 .DS_Store

.node-version

@@ -0,0 +1 @@
+v24.13.1

Dockerfile

@@ -0,0 +1,14 @@
+ARG PLAYWRIGHT_VERSION=v1.58.2
+FROM mcr.microsoft.com/playwright:${PLAYWRIGHT_VERSION}-noble
+
+# Never open or serve report inside container; host opens static report after run
+ENV PLAYWRIGHT_HTML_OPEN=never
+
+WORKDIR /app
+
+COPY package.json package-lock.json ./
+RUN npm ci --ignore-scripts
+
+COPY . .
+
+ENTRYPOINT ["npx", "playwright", "test"]

README.md

@@ -1,179 +1,82 @@
 # E2E Integration Tests
 
-Playwright end-to-end tests for OpenProject-Nextcloud-Keycloak integration.
-
-
+Playwright E2E tests for OpenProject, Nextcloud, and Keycloak integration.
 
 ## Requirements
 
-- Node.js 18+
-- npm
-- Integration cluster deployed via https://github.com/opf/integration-qa-helmfile
-- Playwright browsers installed
+- Docker (for Docker-based runs), or Node.js 18+ and npm (for native runs)
+- Integration cluster via [opf/integration-qa-helmfile](https://github.com/opf/integration-qa-helmfile)
 
 ## Quick Start
 
-1. **Install dependencies:**
-   ```bash
-   npm install
-   npm run playwright:install
-   ```
-
-2. **Ensure local integration cluster is running (for local tests):**
-   The recommended way to run a full local OpenProject–Nextcloud–Keycloak stack is via the
-   [`opf/integration-qa-helmfile`](https://github.com/opf/integration-qa-helmfile/tree/main) repo.
-   Follow its README to `make setup` and `make deploy`, which will provision:
-   - `https://openproject.test`
-   - `https://nextcloud.test`
-   - `https://keycloak.test`
-
-3. **Run tests (native Playwright, headless by default):**
-   ```bash
-   E2E_ENV=local npx playwright test        # local Helm/defaults
-   E2E_ENV=edge npx playwright test         # edge/staging secrets must be exported
-   E2E_ENV=stage npx playwright test        # stage secrets must be exported
-   ```
-
-## Commands
-
-### Run Tests
-```bash
-# Native Playwright (recommended)
-E2E_ENV=local npx playwright test
-E2E_ENV=edge npx playwright test
-E2E_ENV=stage npx playwright test
-
-# Run tests and automatically open HTML report
-E2E_ENV=local npx playwright test && npx playwright show-report
-
-# Override worker count to re-enable parallelism (default is 1)
-npx playwright test --workers 4
-
-# npm script shortcuts (thin wrappers around the above)
-npm run test:edge     # uses E2E_ENV=edge
-npm run test:stage    # uses E2E_ENV=stage
-npm run test:local    # uses E2E_ENV=local
-
-# Run in headed mode (non-headless)
-npm run test:e2e:headed     
-npx playwright test --headed
-
-# Run with UI mode
-npm run test:e2e:ui
-```
-
-### View Results
+**Docker (no local Node.js required):**
 ```bash
-# Open last test report (native)
-npx playwright show-report
-
-# Or via npm script
-npm run report:show
+./run-tests.sh
 ```
 
-### Run Tests by Tag
-
-Use `--grep` to include tags:
+**Native:**
 ```bash
-npx playwright test --grep @fast
+npm install
+npm run playwright:install
+E2E_ENV=local npx playwright test
 ```
 
-Skip a tag with `--grep-invert`:
-```bash
-npx playwright test --grep-invert @fast
-```
+## Running Tests
 
-Logical OR (either tag):
-```bash
-npx playwright test --grep "@fast|@slow"
-```
+### Docker
 
-Logical AND (both tags via lookahead):
 ```bash
-npx playwright test --grep "(?=.*@fast)(?=.*@slow)"
+./run-tests.sh                    # local, all tests
+E2E_ENV=edge ./run-tests.sh       # edge environment
+E2E_ENV=stage ./run-tests.sh      # stage environment
+./run-tests.sh --grep @smoke      # filter by tag
+./run-tests.sh --build            # force image rebuild
+./run-tests.sh --no-open-report   # skip opening report in browser after run
 ```
 
-## Test Organization & Tags
-
-All tests now live directly under `tests/`:
-- `kc-integration.spec.ts` - Keycloak integration (`@smoke`, `@regression`, `@integration`)
-- `nc-integration.spec.ts` - Nextcloud integration (`@regression`, `@integration`)
-- `op-integration.spec.ts` - OpenProject integration (`@regression`, `@integration`)
-
-All specs run for the single supported setup (`sso-external`). Use `--grep` to target `@smoke`, `@regression`, or `@integration`.
-
-## Test Users
+Report opens on your machine after the run. Each run writes to `playwright-report/run-YYYY-MM-DD_HH-mm-ss/` (report in `report/`, plus `results.json`, `junit.xml`). Traces/screenshots/videos stay in `test-results/`. Config is mounted so changes to `playwright.config.ts` apply without rebuilding the image; use `--build` only when deps or Dockerfile change.
 
-Defaults (overridable via env):
-- OpenProject admin: `E2E_OP_ADMIN_USER` / `E2E_OP_ADMIN_PASS` (default `admin/admin`)
-- Nextcloud admin: `E2E_NC_ADMIN_USER` / `E2E_NC_ADMIN_PASS` (default `admin/admin`)
-- Keycloak admin: `E2E_KC_ADMIN_USER` / `E2E_KC_ADMIN_PASS` (default `admin/admin`)
-- Keycloak realm users: `E2E_ALICE_USER` / `E2E_ALICE_PASS` (default `alice/1234`), `E2E_BRIAN_USER` / `E2E_BRIAN_PASS` (default `brian/1234`)
+Credentials and host overrides go in `.env.local` (gitignored, loaded automatically). If `opnc-root-ca.crt` is in the project root it is mounted and used automatically for self-signed CA.
 
-Import from `e2e/utils/test-users.ts`:
+### Native
 
-```typescript
-import { OP_ADMIN_USER, NC_ADMIN_USER, ADMIN_USER, ALICE_USER, BRIAN_USER } from '../utils/test-users';
+```bash
+E2E_ENV=local npx playwright test
+E2E_ENV=edge npx playwright test
+E2E_ENV=stage npx playwright test
+npx playwright test --headed
+npx playwright test --workers 4
+npx playwright show-report
+npm run test:e2e:report          # run tests then open report (native)
 ```
 
-## Test Helpers
+npm shortcuts: `npm run test:local`, `test:edge`, `test:stage`, `test:docker`, `report:show`.
 
-Use the helpers in `utils/test-helpers.ts` to keep specs focused on behaviour instead of data setup:
+**Report:** Docker: report opens automatically after `./run-tests.sh` (or open `playwright-report/index.html`). Native: `npm run report:show` serves at http://localhost:9323 (bound to 0.0.0.0).
 
-- Ensure a user has admin rights (idempotent):
+### Tags
 
-```typescript
-import { ensureUserIsAdmin } from '../utils/test-helpers';
-
-const loginIdentifier = ALICE_USER.email ?? `${ALICE_USER.username}@example.com`;
-const { userId, updated } = await ensureUserIsAdmin(loginIdentifier);
-```
-
-- Ensure a project exists and has a Nextcloud storage configured via API:
-
-```typescript
-import { ensureProjectHasNextcloudStorage } from '../utils/test-helpers';
-
-await ensureProjectHasNextcloudStorage('demo-project');
+```bash
+npx playwright test --grep @smoke
+npx playwright test --grep "@smoke|@regression"
 ```
 
-- Copy the demo project via UI using page objects:
-
-```typescript
-import { OpenProjectHomePage } from '../pageobjects/openproject';
-
-const homePage = new OpenProjectHomePage(page);
-await homePage.copyDemoProjectViaUi('test');
-```
+Tags in use: `@smoke`, `@regression`, `@integration`.
 
 ## Environment Variables
 
-Hosts (preferred):\
-`OPENPROJECT_HOST`, `NEXTCLOUD_HOST`, `KEYCLOAK_HOST`
-
-Versions (optional):\
-`OPENPROJECT_VERSION`, `NEXTCLOUD_VERSION`, `INTEGRATION_APP_VERSION`, `KEYCLOAK_VERSION`
-
-Credentials (see Test Users):\
-`E2E_OP_ADMIN_USER`, `E2E_OP_ADMIN_PASS`, `E2E_NC_ADMIN_USER`, `E2E_NC_ADMIN_PASS`, `E2E_KC_ADMIN_USER`, `E2E_KC_ADMIN_PASS`, `E2E_ALICE_USER`, `E2E_ALICE_PASS`, `E2E_BRIAN_USER`, `E2E_BRIAN_PASS`
-
-Other controls:\
-`SETUP_METHOD` (`sso-external` only), `SETUP_JOB_CHECK=true` to enforce cluster setup-job wait (off by default), `E2E_ENV` to pick env preset.
-
-Local runs: put the above in `.env.local` (already gitignored). CI ignores this file.
-
-**Tests fail to connect?**
-- Verify pods are running: `kubectl get pods -n opnc-integration`
-- Check port forwarding is active
-
-**Playwright complains about missing browser executable?**
-- Make sure you've run `npm run playwright:install` (or `npx playwright install`) after `npm install`.
-- Re-run your test command, e.g. `E2E_ENV=local npx playwright test`.
-
-## More Information
-
-- Tests run with a single worker by default (configurable via `--workers`)
-- Uses Page Object Model pattern
-- Locators stored in JSON files
-- See `e2e/utils/locators_guide.md` for locator usage examples
-
+| Variable | Purpose | Default |
+|---|---|---|
+| `E2E_ENV` | Target environment | `local` |
+| `OPENPROJECT_HOST` | OpenProject hostname | per-env default |
+| `NEXTCLOUD_HOST` | Nextcloud hostname | per-env default |
+| `KEYCLOAK_HOST` | Keycloak hostname | per-env default |
+| `E2E_OP_ADMIN_USER/PASS` | OpenProject admin credentials | `admin/admin` |
+| `E2E_NC_ADMIN_USER/PASS` | Nextcloud admin credentials | `admin/admin` |
+| `E2E_KC_ADMIN_USER/PASS` | Keycloak admin credentials | `admin/admin` |
+| `E2E_ALICE_USER/PASS` | Realm user alice | `alice/1234` |
+| `E2E_BRIAN_USER/PASS` | Realm user brian | `brian/1234` |
+| `E2E_WORKERS` | Worker count | `1` |
+| `SETUP_JOB_CHECK` | Wait for K8s setup-job | `false` |
+
+Put variables in `.env.local` for local runs.

docker-compose.yml

@@ -0,0 +1,61 @@
+services:
+  e2e:
+    build:
+      context: .
+      args:
+        PLAYWRIGHT_VERSION: ${PLAYWRIGHT_VERSION:-v1.58.2}
+    env_file:
+      - path: .env.local
+        required: false
+    environment:
+      - E2E_ENV=${E2E_ENV:-local}
+      - CI=${CI:-}
+      - PLAYWRIGHT_HTML_OPEN=never
+      - E2E_WORKERS=${E2E_WORKERS:-}
+      - E2E_LOG_LEVEL=${E2E_LOG_LEVEL:-}
+      - SETUP_METHOD=${SETUP_METHOD:-}
+      - SETUP_JOB_CHECK=${SETUP_JOB_CHECK:-}
+      - SKIP_SETUP_JOB_CHECK=${SKIP_SETUP_JOB_CHECK:-}
+      - KUBERNETES_NAMESPACE=${KUBERNETES_NAMESPACE:-}
+      - OPENPROJECT_HOST=${OPENPROJECT_HOST:-}
+      - OPENPROJECT_URL=${OPENPROJECT_URL:-}
+      - NEXTCLOUD_HOST=${NEXTCLOUD_HOST:-}
+      - NEXTCLOUD_URL=${NEXTCLOUD_URL:-}
+      - KEYCLOAK_HOST=${KEYCLOAK_HOST:-}
+      - KEYCLOAK_URL=${KEYCLOAK_URL:-}
+      - OPENPROJECT_VERSION=${OPENPROJECT_VERSION:-}
+      - NEXTCLOUD_VERSION=${NEXTCLOUD_VERSION:-}
+      - NEXTCLOUD_API_VERSION=${NEXTCLOUD_API_VERSION:-}
+      - INTEGRATION_APP_VERSION=${INTEGRATION_APP_VERSION:-}
+      - NEXTCLOUD_TEAM_FOLDERS_VERSION=${NEXTCLOUD_TEAM_FOLDERS_VERSION:-}
+      - KEYCLOAK_VERSION=${KEYCLOAK_VERSION:-}
+      - E2E_OP_ADMIN_USER=${E2E_OP_ADMIN_USER:-}
+      - E2E_OP_ADMIN_PASS=${E2E_OP_ADMIN_PASS:-}
+      - E2E_NC_ADMIN_USER=${E2E_NC_ADMIN_USER:-}
+      - E2E_NC_ADMIN_PASS=${E2E_NC_ADMIN_PASS:-}
+      - E2E_KC_ADMIN_USER=${E2E_KC_ADMIN_USER:-}
+      - E2E_KC_ADMIN_PASS=${E2E_KC_ADMIN_PASS:-}
+      - E2E_ALICE_USER=${E2E_ALICE_USER:-}
+      - E2E_ALICE_PASS=${E2E_ALICE_PASS:-}
+      - E2E_BRIAN_USER=${E2E_BRIAN_USER:-}
+      - E2E_BRIAN_PASS=${E2E_BRIAN_PASS:-}
+      - E2E_KC_REALM=${E2E_KC_REALM:-}
+      - E2E_KC_NC_CLIENT_ID=${E2E_KC_NC_CLIENT_ID:-}
+      - E2E_KC_NC_CLIENT_SECRET=${E2E_KC_NC_CLIENT_SECRET:-}
+      - ALLOW_INSECURE_TLS=${ALLOW_INSECURE_TLS:-}
+      - NODE_EXTRA_CA_CERTS=${NODE_EXTRA_CA_CERTS:-}
+      - OPENPROJECT_CA_CERT_PATH=${OPENPROJECT_CA_CERT_PATH:-}
+    extra_hosts:
+      # Resolve *.test to Docker host for local Helm
+      - "openproject.test:host-gateway"
+      - "nextcloud.test:host-gateway"
+      - "keycloak.test:host-gateway"
+    volumes:
+      - ./tests:/app/tests
+      - ./test-results:/app/test-results
+      - ./playwright-report:/app/playwright-report
+      - ./pageobjects:/app/pageobjects
+      - ./locators:/app/locators
+      - ./utils:/app/utils
+      - ./playwright.config.ts:/app/playwright.config.ts
+      - ./global-setup.ts:/app/global-setup.ts