Skip to main content
skill CX Codex

playwright-test — Claude Code skill: what it does, how to install

playwright-test generates zero-flakiness Playwright E2E tests following OpenMetadata rules with API lifecycle checks, multi-role testing, and strict ESLint gating.

Apache-2.0 ★ 15,831 updated 2026-10-24

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add open-metadata/OpenMetadata --skill playwright-test -a claude-code
Open on GitHub

What playwright-test does

This skill builds Playwright test files following guidelines from PLAYWRIGHT_DEVELOPER_HANDBOOK.md. It enforces clean test mechanics: no waitForTimeout, no networkidle, and no force: true. Controls under toast alerts use clickIgnoringToasts. Tests remain independent. Entity lifecycles rely on backend API calls placed inside beforeAll and afterAll blocks.

Before returning the test, the agent runs yarn lint:playwright inside the UI directory. All guardrail rules trigger blocking errors. Adding entries to eslint-suppressions.json is strictly prohibited. The skill depends directly on OpenMetadata handbook paths, making it ineffective in generic repositories without structural adjustments.

What it helps with

  • generate resilient Playwright E2E tests without arbitrary sleep timers
  • test multi-role permissions across admin and consumer personas
  • manage entity lifecycles directly via API endpoints before UI steps
  • enforce repository lint rules with yarn lint:playwright

Example prompts for the agent

  • /playwright-test Feature: Data Quality Rules Category: Features Entity: Table Domain: Observability Scenarios: - Admin can create and configure data quality rules - Data consumer can view test results but not edit rules Roles: admin, dataConsumer
  • /playwright-test Feature: Glossary Terms Category: Features Entity: Glossary Domain: Governance Scenarios: - Data steward creates a new term - Term persists after page reload Roles: dataSteward

How to install playwright-test

1Skills CLI (Vercel)

npx skills add open-metadata/OpenMetadata --skill playwright-test -a claude-code

2Manually: put the files in place

~/.claude/skills/playwright/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/playwright/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about playwright-test

How to install playwright-test in Claude Code?

Run npx skills add open-metadata/OpenMetadata --skill playwright -a claude-code in your terminal.

What does playwright-test do?

It creates end-to-end Playwright tests that follow OpenMetadata conventions, complete with semantic selectors, network response waits, and API setup steps.

Why does the skill run yarn lint:playwright?

CI rules for playwright/* and om-playwright/* treat lint violations as blocking errors. Suppressing new violations in eslint-suppressions.json is explicitly disallowed.

Source text

SKILL.md · Apache-2.0
---
name: playwright-test
description: Generate robust, zero-flakiness Playwright E2E tests following OpenMetadata patterns. Creates comprehensive test files with proper waits, API validation, multi-role permissions, and complete entity lifecycle management.
user-invocable: true
---

# Playwright Test Generator - OpenMetadata

Generate production-ready, zero-flakiness Playwright tests following OpenMetadata conventions.

## Usage

```
/playwright-test
Feature: <feature name>
Category: <Features|Pages|Flow|VersionPages>
Entity: <Table|Dashboard|Pipeline|Topic|Database|User|Team|Glossary|Other>
Domain: <Governance|Discovery|Platform|Observability|Integration>
Scenarios:
  - <scenario 1 description>
  - <scenario 2 description>
  - <scenario 3 description>
Roles: <admin|dataConsumer|dataSteward|owner> (optional, defaults to admin)
```

## Quick Example

```
/playwright-test
Feature: Data Quality Rules
Category: Features
Entity: Table
Domain: Observability
Scenarios:
  - Admin can create and configure data quality rules
  - Data consumer can view test results but not edit rules
  - Test results are persisted after page reload
Roles: admin, dataConsumer
```

---

## Instructions

### Step 1: Read the Handbook FIRST

**CRITICAL**: Before generating any tests, read and apply ALL patterns from:

```
openmetadata-ui/src/main/resources/ui/playwright/PLAYWRIGHT_DEVELOPER_HANDBOOK.md
```

The handbook contains:
- Testing philosophy (user-centric, behavior-focused)
- Anti-flakiness patterns (the :visible selector chain pattern, controls under the toast stack, etc.)
- Test timeout strategies (test.slow() vs test.setTimeout())
- Common test patterns (form submission, dropdowns, multi-role testing)
- Locator priority guidelines
- Support classes reference
- Domain tags
- Validation checklist

**Apply ALL handbook principles before proceeding.**

---

### Step 2: Generate Test Using Handbook Template

Use the **Test File Structure Template** from the handbook. It includes:
- Proper imports (performAdminLogin, entity classes, utilities)
- test.describe with domain tags
- beforeAll/afterAll for entity lifecycle via API
- test.slow() for timeout handling
- test.step() for clear organization
- API response validation pattern

---

### Step 3: Apply Common Test Patterns from Handbook

Reference the **Common Test Patterns** section for:
- Form submission with API validation
- Dropdown selection (with :visible chain pattern)
- Multi-role permission testing
- Data persistence verification
- Navigation patterns
- Search and filter patterns

---

### Step 4: Run ESLint Check

Before returning the generated test, run the full Playwright lint gate — the same one CI runs:

```bash
cd openmetadata-ui/src/main/resources/ui
yarn lint:playwright
```

Every `playwright/*` and `om-playwright/*` guardrail rule runs at `error`; repo-wide `openmetadata-playwright/*` rules set their own severity and may be `warn`. Fix any errors before finalizing —
never add a new entry to `eslint-suppressions.json` to make this pass. See the handbook's
**ESLint Enforcement** section for the full, generated rule reference.

### Step 5: Validate Against Handbook Checklist

Before returning the generated test, verify ALL items from the handbook's **Validation Checklist**:

- ✅ Structure & Organization (test.step, domain tags, imports, beforeAll/afterAll)
- ✅ Anti-Flakiness (no waitForTimeout, no networkidle, no force: true, no positional selectors, no stored :visible locators, `clickIgnoringToasts` for bottom-aligned controls)
- ✅ API & Network (waitForResponse before actions, status code validation)
- ✅ Waits & Assertions (waitForAllLoadersToDisappear, semantic locators, proper assertions)
- ✅ ESLint (`yarn lint:playwright` passes with zero errors)
- ✅ Coverage & Roles (multi-role tests, data persistence, error handling)

---

## Key Reminders

**All patterns, rules, and best practices are in the handbook.**

Read and apply the handbook sections in order:
1. **Anti-Flakiness Patterns** (CRITICAL - #1 cause of flaky tests)
2. **Test File Structure Template** (for proper test structure)
3. **Common Test Patterns** (for specific scenarios)
4. **ESLint Enforcement** (run `yarn lint:playwright` — every rule is `error`)
5. **Validation Checklist** (before returning generated test)

---

## Final Notes

- Generate **production-ready** tests that pass 10/10 times
- Follow ALL patterns from the handbook exactly
- No comments for obvious code (e.g., `// Create entity` before `entity.create()`)
- Test independence - each test runs in any order
- Reference examples: `playwright/e2e/Pages/DataContractInheritance.spec.ts`, `playwright/e2e/Features/Table.spec.ts`

**Generate tests that are production-ready, maintainable, and zero-flakiness by following the handbook patterns exactly.**

---

## Writing Playwright Tests (merged from the former `writing-playwright-tests` skill)

**Reference**: `openmetadata-ui/src/main/resources/ui/playwright/PLAYWRIGHT_DEVELOPER_HANDBOOK.md`

### ESLint Enforcement

All Playwright tests are linted with `eslint-plugin-playwright` plus this repo's local
`om-playwright` rules. Run before submitting:

```bash
cd openmetadata-ui/src/main/resources/ui
yarn lint:playwright
```

Every guardrail rule runs at `error` and none is merely advisory; the severity column is authoritative for anything else. The
generated rule table (per-rule severity and description) lives in the handbook's **ESLint
Enforcement** section; it's produced by `yarn generate:playwright-rules` from `eslint.config.mjs`,
so it can't drift from what actually blocks CI. Pre-existing violations are tracked in
`eslint-suppressions.json` — that ledger may shrink as violations are fixed, never grow.

## Mandatory verification

Before reporting the work complete, run:

```bash
cd openmetadata-ui/src/main/resources/ui && yarn lint:playwright
```

This must exit 0. Do not suppress a new violation to make it pass — suppressions are a record of
pre-existing debt, and adding to them is a plan failure. Fix the test instead.

© open-metadata · Apache-2.0 · open-metadata/OpenMetadata

Similar skills

All skills for Testing and QA →

From the same set4

Project sponsors

Companies that keep this analytics open