playwright-validation
Use when validating UI changes in a branch require Playwright E2E testing. Reviews branch changes, validates UI with Playwright MCP, and adds missing test cases.
How do I install this agent skill?
npx skills add https://github.com/open-metadata/openmetadata --skill playwright-validationIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill is a development tool for validating UI changes using Playwright E2E tests. It includes hardcoded default credentials for a local development environment and possesses a surface for indirect prompt injection by reading local source code and web content.
- Socketpass
No alerts
- Snykfail
Risk: HIGH · 1 issue
- Runlayerwarn
1/1 file flagged
What does this agent skill do?
Playwright Validation Skill
This skill guides you through validating UI changes and ensuring comprehensive Playwright E2E test coverage.
When to Use
- After completing UI feature development
- Before creating a PR for UI changes
- When reviewing UI-related branches
- To verify existing Playwright tests cover all scenarios
Workflow
Phase 1: Review Branch Changes
-
Identify changed files vs main:
git diff main --stat git diff main --name-only | grep -E "\.(tsx?|less|css|scss)$" -
Focus on UI component changes:
git diff main -- "openmetadata-ui/src/main/resources/ui/src/components/**" --stat -
Check for existing Playwright tests:
git diff main --name-only | grep -E "playwright.*\.spec\.ts$" -
Read the changed component files to understand the UI modifications
Phase 2: Review Existing Playwright Tests
-
Locate relevant test files:
- Check
playwright/e2e/Pages/for page-level tests - Check
playwright/e2e/Features/for feature-specific tests - Use Glob/Grep to find tests related to the feature
- Check
-
Analyze test coverage:
- Read the existing test file(s)
- Identify the test scenarios already covered
- Note any gaps in coverage based on the UI changes
-
Review test utilities:
- Check
playwright/utils/for helper functions - Check
playwright/support/for entity classes and fixtures
- Check
Phase 3: Validate with Playwright MCP
-
Start the browser and navigate:
mcp__playwright__browser_navigate to http://localhost:8585 -
Authenticate if needed:
- Use
mcp__playwright__browser_fill_formfor login - Default admin:
admin@open-metadata.org/admin
- Use
-
Navigate to the feature area:
- Use
mcp__playwright__browser_clickfor navigation - Use
mcp__playwright__browser_snapshotto inspect page state
- Use
-
Validate UI behavior:
- Test the main user flows
- Verify visual elements (icons, badges, labels)
- Check interactive elements (buttons, dropdowns, forms)
- Verify state changes and API calls
-
Document findings:
- Note what works correctly
- Identify any issues or missing functionality
- List scenarios not covered by existing tests
Phase 4: Add Missing Test Cases
-
Create a TodoWrite checklist of missing test scenarios
-
For each missing test case:
a. Add necessary test fixtures in
beforeAll:- Create new entity instances (TableClass, DataProduct, etc.)
- Set up required relationships (domains, assets)
b. Add cleanup in
afterAll:- Delete created entities in reverse order
c. Write the test following the pattern:
test('Descriptive Test Name - What it validates', async ({ page }) => { test.setTimeout(300000); await test.step('Step description', async () => { // Test actions and assertions }); await test.step('Next step', async () => { // More actions and assertions }); }); -
Test patterns to cover:
- Happy path (expected behavior)
- Edge cases (empty states, max values)
- Error handling (invalid inputs, failed requests)
- State transitions (before/after actions)
- UI feedback (loading states, success/error messages)
- Permissions (disabled buttons, restricted actions)
-
Run Playwright lint check:
yarn lint:playwrightEvery
playwright/*andom-playwright/*guardrail rule iserrorseverity. Repo-wideopenmetadata-playwright/*rules set their own, and may sit atwarnwhile their call sites migrate — read the severity column in the handbook's ESLint Enforcement table rather than assuming.
Common Test Utilities
Navigation
import { sidebarClick } from '../../utils/sidebar';
import { redirectToHomePage } from '../../utils/common';
import { selectDataProduct, selectDomain } from '../../utils/domain';
Waiting
import { waitForAllLoadersToDisappear } from '../../utils/entity';
await waitForAllLoadersToDisappear(page);
await expect(page.getByTestId('content')).toBeVisible();
// NEVER use: page.waitForLoadState('networkidle') — blocked by ESLint
API Responses
const response = page.waitForResponse('/api/v1/endpoint*');
await someAction();
await response;
expect((await response).status()).toBe(200);
Assertions
await expect(page.getByTestId('element')).toBeVisible();
await expect(page.getByTestId('element')).toContainText('text');
await expect(page.locator('.class')).not.toBeVisible();
Checklist Before Completion
- All UI changes have corresponding test coverage
- Tests cover both positive and negative scenarios
- Tests verify visual indicators (icons, badges, states)
- Tests validate API interactions
-
yarn lint:playwrightpasses with zero errors - No
networkidle,page.pause(), ortest.only()usage (blocked by ESLint) - Test fixtures are properly created and cleaned up
- Test timeouts use
test.slow()(preferred) ortest.setTimeout()
Example: Data Contract Inheritance Tests
For reference, see the comprehensive test coverage in:
playwright/e2e/Pages/DataContractInheritance.spec.ts
This file demonstrates:
- Multiple entity setup in beforeAll
- Domain assignment patches
- Contract creation and validation
- Inheritance icon verification
- Action button state verification (disabled/enabled)
- API response validation (POST vs PATCH)
- Fallback behavior testing
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/open-metadata/openmetadata/playwright-validation">View playwright-validation on skillZs</a>