E2E Test Framework
Current State
!cat package.json 2>/dev/null | grep -oE 'playwright|cypress|selenium' || echo 'No E2E framework detected'
Overview
Execute end-to-end tests that simulate real user workflows across the full application stack -- browser interactions, API calls, database operations, and third-party integrations. Supports Playwright (recommended), Cypress, Selenium, and Puppeteer.
Prerequisites
- E2E testing framework installed (Playwright, Cypress, or Selenium WebDriver)
- Application running in a test environment with seeded test data
- Browser binaries installed (
npx playwright install or Cypress binary)
- Test user accounts created with known credentials
- Environment variables configured for base URL, API keys, and test credentials
Instructions
- Identify critical user journeys to cover:
- User registration and login flow.
- Primary feature workflow (e.g., create item, edit, delete).
- Search and filtering functionality.
- Checkout or payment flow (if applicable).
- Error handling (404 pages, form validation, session expiry).
- Create page object models (POM) for reusable page interactions:
- One class per page or major component.
- Encapsulate locators, actions (click, fill, select), and assertions.
- Use
data-testid attributes as primary selectors for stability.
- Write E2E test files organized by user journey:
- Each test file covers one complete workflow.
- Use
beforeEach to navigate to the starting page and reset state.
- Use
afterEach to capture screenshots on failure.
- Keep tests independent -- no test should depend on another test's output.
- Handle authentication efficiently:
- Store authenticated session state to a file (
storageState in Playwright).
- Reuse session across tests that require login.
- Create a separate auth setup fixture that runs once per worker.
- Configure multi-browser and responsive testing:
- Run tests on Chromium, Firefox, and WebKit.
- Test at mobile (375px), tablet (768px), and desktop (1280px) viewports.
- Use Playwright projects to define browser/viewport combinations.
- Add retry and stability mechanisms:
- Use
expect with auto-waiting locators (Playwright) instead of explicit waits.
- Configure test retries (max 2) for CI environments.
- Add
networkidle or domcontentloaded wait conditions for page transitions.
- Generate test reports with screenshots, traces, and video on failure.
Output
- E2E test files organized by user journey in
tests/e2e/ or e2e/
- Page object model classes in
tests/e2e/pages/
- Playwright/Cypress configuration file with browser and viewport matrix
- Authentication state file for session reuse
- HTML test report with screenshots, traces, and failure details
Error Handling
| Error |
Cause |
Solution |
| Element not found / timeout |
Selector changed or element lazy-loaded after timeout |
Use data-testid attributes; increase timeout; use waitFor with proper state checks |
| Test passes locally but fails in CI |
Headless browser behavior differs or CI is slower |
Run CI in headless mode locally to reproduce; increase timeouts; check viewport size |
| Authentication state expired |
Stored session tokens have short TTL |
Regenerate auth state before each test run; use long-lived test account tokens |
| Flaky test due to animation |
Click registered before animation completes |
Disable CSS animations in test config; use force: true on click; add waitForLoadState |
| Database state pollution |
Previous test left data that affects current test |
Seed database in beforeEach; use transactional rollback; reset via API endpoint |
Examples
Playwright test for user registration flow:
import { test, expect } from '@playwright/test';
test('new user can register and see dashboard', async ({ page }) => {
await page.goto('/register');
await page.getByTestId('name-input').fill('Test User');
await page.getByTestId('email-input').fill('test@example.com');
await page.getByTestId('password-input').fill('SecurePass123!');
await page.getByTestId('register-button').click();
await expect(page).toHaveURL(/\/dashboard/);
await expect(page.getByTestId('welcome-message')).toContainText('Test User');
});
Page object model:
export class LoginPage {
constructor(private page: Page) {}
async login(email: string, password: string) {
await this.page.goto('/login');
await this.page.getByTestId('email').fill(email);
await this.page.getByTestId('password').fill(password);
await this.page.getByTestId('submit').click();
await this.page.waitForURL(/\/dashboard/);
}
}
Playwright config with multi-browser projects:
export default defineConfig({
projects: [
{ name: 'chromium', use: { ...devices['Desktop Chrome'] } },
{ name: 'firefox', use: { ...devices['Desktop Firefox'] } },
{ name: 'mobile', use: { ...devices['iPhone 14'] } },
],
use: { screenshot: 'only-on-failure', trace: 'on-first-retry' },
});
Resources
1---2name: running-e2e-tests3description: Execute end-to-end tests covering full user workflows across frontend and backend. Use when performing specialized testing. Trigger with phrases like "run end-to-end tests", "test user flows", or "execute E2E suite".4license: MIT5---6# E2E Test Framework
7
8## Current State
9
10!`cat package.json 2>/dev/null | grep -oE 'playwright|cypress|selenium' || echo 'No E2E framework detected'`
11
12## Overview
13
14Execute end-to-end tests that simulate real user workflows across the full application stack -- browser interactions, API calls, database operations, and third-party integrations. Supports Playwright (recommended), Cypress, Selenium, and Puppeteer.
15
16## Prerequisites
17
18- E2E testing framework installed (Playwright, Cypress, or Selenium WebDriver)
19- Application running in a test environment with seeded test data
20- Browser binaries installed (`npx playwright install` or Cypress binary)
21- Test user accounts created with known credentials
22- Environment variables configured for base URL, API keys, and test credentials
23
24## Instructions
25
261. Identify critical user journeys to cover:
27 - User registration and login flow.
28 - Primary feature workflow (e.g., create item, edit, delete).
29 - Search and filtering functionality.
30 - Checkout or payment flow (if applicable).
31 - Error handling (404 pages, form validation, session expiry).
322. Create page object models (POM) for reusable page interactions:
33 - One class per page or major component.
34 - Encapsulate locators, actions (click, fill, select), and assertions.
35 - Use `data-testid` attributes as primary selectors for stability.
363. Write E2E test files organized by user journey:
37 - Each test file covers one complete workflow.
38 - Use `beforeEach` to navigate to the starting page and reset state.
39 - Use `afterEach` to capture screenshots on failure.
40 - Keep tests independent -- no test should depend on another test's output.
414. Handle authentication efficiently:
42 - Store authenticated session state to a file (`storageState` in Playwright).
43 - Reuse session across tests that require login.
44 - Create a separate auth setup fixture that runs once per worker.
455. Configure multi-browser and responsive testing:
46 - Run tests on Chromium, Firefox, and WebKit.
47 - Test at mobile (375px), tablet (768px), and desktop (1280px) viewports.
48 - Use Playwright projects to define browser/viewport combinations.
496. Add retry and stability mechanisms:
50 - Use `expect` with auto-waiting locators (Playwright) instead of explicit waits.
51 - Configure test retries (max 2) for CI environments.
52 - Add `networkidle` or `domcontentloaded` wait conditions for page transitions.
537. Generate test reports with screenshots, traces, and video on failure.
54
55## Output
56
57- E2E test files organized by user journey in `tests/e2e/` or `e2e/`
58- Page object model classes in `tests/e2e/pages/`
59- Playwright/Cypress configuration file with browser and viewport matrix
60- Authentication state file for session reuse
61- HTML test report with screenshots, traces, and failure details
62
63## Error Handling
64
65| Error | Cause | Solution |
66|-------|-------|---------|
67| Element not found / timeout | Selector changed or element lazy-loaded after timeout | Use `data-testid` attributes; increase timeout; use `waitFor` with proper state checks |
68| Test passes locally but fails in CI | Headless browser behavior differs or CI is slower | Run CI in headless mode locally to reproduce; increase timeouts; check viewport size |
69| Authentication state expired | Stored session tokens have short TTL | Regenerate auth state before each test run; use long-lived test account tokens |
70| Flaky test due to animation | Click registered before animation completes | Disable CSS animations in test config; use `force: true` on click; add `waitForLoadState` |
71| Database state pollution | Previous test left data that affects current test | Seed database in `beforeEach`; use transactional rollback; reset via API endpoint |
72
73## Examples
74
75**Playwright test for user registration flow:**
76
77```typescript
78import { test, expect } from '@playwright/test';
79
80test('new user can register and see dashboard', async ({ page }) => {
81 await page.goto('/register');
82 await page.getByTestId('name-input').fill('Test User');
83 await page.getByTestId('email-input').fill('test@example.com');
84 await page.getByTestId('password-input').fill('SecurePass123!');
85 await page.getByTestId('register-button').click();
86
87 await expect(page).toHaveURL(/\/dashboard/);
88 await expect(page.getByTestId('welcome-message')).toContainText('Test User');
89});
90```
91
92**Page object model:**
93
94```typescript
95export class LoginPage {
96 constructor(private page: Page) {}
97 async login(email: string, password: string) {
98 await this.page.goto('/login');
99 await this.page.getByTestId('email').fill(email);
100 await this.page.getByTestId('password').fill(password);
101 await this.page.getByTestId('submit').click();
102 await this.page.waitForURL(/\/dashboard/);
103 }
104}
105```
106
107**Playwright config with multi-browser projects:**
108
109```typescript
110export default defineConfig({
111 projects: [
112 { name: 'chromium', use: { ...devices['Desktop Chrome'] } },
113 { name: 'firefox', use: { ...devices['Desktop Firefox'] } },
114 { name: 'mobile', use: { ...devices['iPhone 14'] } },
115 ],
116 use: { screenshot: 'only-on-failure', trace: 'on-first-retry' },
117});
118```
119
120## Resources
121
122- Playwright documentation: https://playwright.dev/docs/intro
123- Cypress documentation: https://docs.cypress.io/
124- Page Object Model pattern: https://playwright.dev/docs/pom
125- Playwright best practices: https://playwright.dev/docs/best-practices
126- E2E testing strategies: https://martinfowler.com/bliki/TestPyramid.html