mirror of
https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git
synced 2025-12-18 02:21:13 +00:00
78 lines
3.1 KiB
Markdown
78 lines
3.1 KiB
Markdown
# Playwright E2E Test Guide
|
|
|
|
## Development setup
|
|
```bash
|
|
pnpm install-browsers:local # in playwright directory
|
|
pnpm build:docker # from root first to test against local changes
|
|
```
|
|
|
|
## Quick Start
|
|
```bash
|
|
pnpm test:all # Run all tests (fresh containers, pnpm build:docker from root first to ensure local containers)
|
|
pnpm test:local # Starts a local server and runs the UI tests
|
|
N8N_BASE_URL=localhost:5068 pnpm test:local # Runs the UI tests against the instance running
|
|
```
|
|
|
|
## Test Commands
|
|
```bash
|
|
# By Mode
|
|
pnpm test:container:standard # Sqlite
|
|
pnpm test:container:postgres # PostgreSQL
|
|
pnpm test:container:queue # Queue mode
|
|
pnpm test:container:multi-main # HA setup
|
|
|
|
pnpm test:performance # Runs the performance tests against Sqlite container
|
|
pnpm test:chaos # Runs the chaos tests
|
|
|
|
|
|
# Development
|
|
pnpm test:all --grep "workflow" # Pattern match, can run across all test types UI/cli-workflow/performance
|
|
pnpm test:local --ui # To enable UI debugging and test running mode
|
|
```
|
|
|
|
## Test Tags
|
|
```typescript
|
|
test('basic test', ...) // All modes, fully parallel
|
|
test('postgres only @mode:postgres', ...) // Mode-specific
|
|
test('needs clean db @db:reset', ...) // Sequential per worker
|
|
test('chaos test @mode:multi-main @chaostest', ...) // Isolated per worker
|
|
test('cloud resource test @cloud:trial', ...) // Cloud resource constraints
|
|
```
|
|
|
|
## Fixture Selection
|
|
- **`base.ts`**: Standard testing with worker-scoped containers (default choice)
|
|
- **`cloud-only.ts`**: Cloud resource testing with guaranteed isolation
|
|
- Use for performance testing under resource constraints
|
|
- Requires `@cloud:*` tags (`@cloud:trial`, `@cloud:enterprise`, etc.)
|
|
- Creates only cloud containers, no worker containers
|
|
|
|
```typescript
|
|
// Standard testing
|
|
import { test, expect } from '../fixtures/base';
|
|
|
|
// Cloud resource testing
|
|
import { test, expect } from '../fixtures/cloud-only';
|
|
test('Performance under constraints @cloud:trial', async ({ n8n, api }) => {
|
|
// Test runs with 384MB RAM, 250 millicore CPU
|
|
});
|
|
```
|
|
|
|
## Tips
|
|
- `test:*` commands use fresh containers (for testing)
|
|
- VS Code: Set `N8N_BASE_URL` in Playwright settings to run tests directly from VS Code
|
|
- Pass custom env vars via `N8N_TEST_ENV='{"KEY":"value"}'`
|
|
|
|
## Project Layout
|
|
- **composables**: Multi-page interactions (e.g., `WorkflowComposer.executeWorkflowAndWaitForNotification()`)
|
|
- **config**: Test setup and configuration (constants, test users, etc.)
|
|
- **fixtures**: Custom test fixtures extending Playwright's base test
|
|
- `base.ts`: Standard fixtures with worker-scoped containers
|
|
- `cloud-only.ts`: Cloud resource testing with test-scoped containers only
|
|
- **pages**: Page Object Models for UI interactions
|
|
- **services**: API helpers for E2E controller, REST calls, etc.
|
|
- **utils**: Utility functions (string manipulation, helpers, etc.)
|
|
- **workflows**: Test workflow JSON files for import/reuse
|
|
|
|
## Writing Tests
|
|
For guidelines on writing new tests, see [CONTRIBUTING.md](./CONTRIBUTING.md).
|