Playwright E2e

Skill: playwright-e2e

Padrão para criar e atualizar testes E2E com Playwright. Garante que toda mudança que afeta UI ou fluxo crítico tenha cobertura, evidência salva e asserções determinísticas — sem sleep arbitrário, sem mock pra fazer passar.

---

Trigger

• Quando a task envolve fluxo de usuário ponta a ponta (login, checkout, onboarding, etc.).
• Quando uma feature web nova for entregue e ainda não tem cobertura E2E.
• Quando um bug se manifestar na UI e a regressão exigir teste.
• Quando o usuário pedir explicitamente "escreve teste e2e", "playwright", "smoke test web".
• Antes de fechar PR que toca rota, página ou interação visível.

---

Steps

1. Identifique o cenário. Liste o caminho feliz e os principais erros (input inválido, sessão expirada, 404/500, viewport mobile/desktop). Cada cenário vira um test(...).
2. Crie o arquivo em tests/e2e/.spec.ts. Nome em kebab-case casando com a feature (ex.: tests/e2e/login.spec.ts).
3. Importe fixtures padrão do Playwright (test, expect) e qualquer fixture customizada do projeto (tests/e2e/fixtures/).
4. Configure o test.describe com nome legível (ex.: Login flow). Agrupe cenários relacionados.
5. Use Page Object quando o mesmo seletor aparecer em 3+ testes. Caso contrário, seletores inline são aceitáveis.
6. Asserte estado final com await expect(...). Asserte URL, DOM visível e textos esperados — não asserte só ausência de erro.
7. Confirme evidência. playwright.config.ts já liga trace: 'on', screenshot: 'only-on-failure' e video: 'on-first-retry'. Não desligue isso por teste.
8. Rode local com npx playwright test tests/e2e/.spec.ts --reporter=list. Verifique HTML report em playwright-report/.
9. Commit. Inclua o arquivo .spec.ts. Não commite test-results/ nem playwright-report/ (estão no .gitignore).
10. No PR, anexe screenshot do estado final do caminho feliz e descreva os cenários cobertos.

---

Padrões

• Naming: .spec.ts, ..spec.ts para sub-fluxos longos.
• Localização: sempre tests/e2e/. Page Objects em tests/e2e/pages/.ts.
• Seletores: prefira getByRole, getByLabel, getByTestId. Evite locator('div.classe123') — frágil.
• Espera: nunca await page.waitForTimeout(ms). Use await expect(locator).toBeVisible(), toHaveURL, toHaveText.
• Asserções: prefira await expect(...).toBeVisible() em vez de if (locator.isVisible()). Auto-retry built-in.
• Setup/Teardown: use test.beforeEach para login/seed; test.afterEach só se realmente precisar limpar.
• Dados: gere dados únicos por teste (crypto.randomUUID()) para evitar colisão entre runs paralelos.
• Viewports: cubra mobile (375x667), tablet (768x1024) e desktop (1280x800) quando o layout muda.
• i18n: se o app é multi-locale, parametrize locale no test.use({ locale: 'pt-BR' }) ou rode como projeto.
• Sem console.log deixado nos specs. Use test.info().annotations se precisar anotar.

---

Definition of Done

• [ ] Spec roda local sem erro: npx playwright test tests/e2e/.spec.ts.
• [ ] Cenários documentados: caminho feliz + ao menos 1 erro + 1 viewport alternativo (quando aplicável).
• [ ] Evidência salva em test-results/ (trace, screenshot, vídeo conforme config).
• [ ] HTML report gerado em playwright-report/ e validado visualmente.
• [ ] PR menciona o screenshot do estado final e lista os cenários cobertos.
• [ ] Nenhum waitForTimeout ou sleep arbitrário no código.
• [ ] Seletores resistentes (role/label/testid), não classes CSS voláteis.
• [ ] CI (.github/workflows/ci.yml) verde para o job playwright.

---

Exemplo

import { test, expect } from '@playwright/test';

test.describe('Login flow', () => {
  test.beforeEach(async ({ page }) => {
    await page.goto('/login');
  });

  test('user logs in with valid credentials', async ({ page }) => {
    await page.getByLabel('Email').fill('user@example.com');
    await page.getByLabel('Password').fill('correct-horse-battery');
    await page.getByRole('button', { name: 'Sign in' }).click();

    await expect(page).toHaveURL(/\/dashboard$/);
    await expect(page.getByRole('heading', { name: /welcome/i })).toBeVisible();
  });

  test('shows error on invalid password', async ({ page }) => {
    await page.getByLabel('Email').fill('user@example.com');
    await page.getByLabel('Password').fill('wrong');
    await page.getByRole('button', { name: 'Sign in' }).click();

    await expect(page.getByRole('alert')).toContainText(/invalid credentials/i);
    await expect(page).toHaveURL(/\/login$/);
  });
});

---

Notas

• Configuração canônica em playwright.config.ts (raiz do projeto). Não duplique opções no spec.
• Testes flaky são bug. Se um teste falha intermitente, abra issue e marque com test.fixme(...) até resolver — não use test.skip silenciosamente.
• Para debugar local: npx playwright test --ui abre o time-travel debugger.
• Trace viewer: npx playwright show-trace test-results/.zip.

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: wesleysimplicio
• Source: wesleysimplicio/PiAPI-Skills
• License: MIT

Install and usage instructions live in the source repository linked above.