​

Playwright Integration Tests

​

Pre-requisites

1. Completed the OpenMetadata UI setup - Follow all pre-requisites in the OpenMetadata UI section, which covers Node.js, Yarn, and other dependencies.
2. Services running - Playwright tests require all OpenMetadata services to be running in a clean state, including Elastic Search, Airflow, and MySQL database.

​

Starting Required Services

sh docker/run_local_docker.sh

​

Installing Playwright

cd openmetadata-ui/src/main/resources/ui
# Install dependencies (if not already done during UI setup)
yarn install
# Install Playwright browsers (required for running tests)
yarn playwright install

Note: The Playwright browser installation is only needed once per machine. These browsers are used to run tests in different browser environments (Chromium, Firefox, WebKit).

​

Running Playwright Tests

​

Running Tests in Headless Mode

yarn playwright:run

​

Running Tests with UI Mode

yarn playwright:open

• View all available tests
• Run individual tests or test suites
• Debug tests with breakpoints
• View test traces and screenshots
• Inspect the DOM during test execution

​

Running Specific Tests

yarn playwright test <test-file-name>
# Example:
yarn playwright test auth.setup.ts

yarn playwright test --grep "<pattern>"
# Example:
yarn playwright test --grep "login"

​

Running Tests on Different Browsers

# Run on specific browser
yarn playwright test --project=chromium
yarn playwright test --project=firefox
yarn playwright test --project=webkit

# Run on all browsers
yarn playwright test --project=chromium --project=firefox --project=webkit

​

Running Tests by Category

# Run all feature tests
yarn playwright test e2e/Features/

# Run all flow tests
yarn playwright test e2e/Flow/

# Run all page tests
yarn playwright test e2e/Pages/

# Run nightly tests (long-running tests)
yarn playwright test e2e/nightly/

​

Excluding Tests

• Nightly tests are excluded from regular test runs (testIgnore: ['**/nightly/**'])
• Data Insight tests run in a separate project with dependencies

​

Test Structure and Organization

​

Test Directory Structure

playwright/
├── e2e/                    # End-to-end test files
│   ├── auth.setup.ts      # Authentication setup
│   ├── auth.teardown.ts   # Authentication cleanup
│   ├── Features/          # Feature-specific tests
│   ├── Flow/              # User flow tests
│   ├── Pages/             # Page-specific tests
│   ├── VersionPages/      # Version-related tests
│   └── nightly/           # Nightly build tests
├── constant/              # Test constants and configurations
├── support/               # Support classes and utilities
├── utils/                 # Utility functions for tests
└── output/               # Test results and artifacts
    ├── test-results/     # Test execution results
    └── playwright-report/ # HTML reports

​

Test Categories

• Features: Tests for specific features (e.g., ActivityFeed, BulkImport, Permissions)
• Flow: End-to-end user workflows (e.g., AddRoleAndAssignToUser, GlobalSearch)
• Pages: Tests for individual pages (e.g., Login, Teams, DataInsight)
• VersionPages: Tests for entity version management
• Nightly: Long-running tests executed in nightly builds

​

Writing New Tests

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

test.describe("Feature Name", () => {
  test.beforeEach(async ({ page }) => {
    // Setup code before each test
    await page.goto("/");
  });

  test("should perform expected behavior", async ({ page }) => {
    // Test implementation
    await page.click('button[data-testid="submit"]');
    await expect(page.locator(".success-message")).toBeVisible();
  });
});

​

Debugging Tests

​

Using Debug Mode

# Run tests in debug mode
yarn playwright test --debug

​

Using Playwright Inspector

# Pause execution at a specific point
PWDEBUG=1 yarn playwright test

​

Generating Test Code

yarn playwright:codegen

​

Test Reports and Artifacts

​

Viewing HTML Reports

yarn playwright show-report

​

Test Artifacts

• Screenshots on failure
• Test traces for debugging
• Videos of test execution (configurable)

​

Configuration

• Test directory: ./playwright/e2e
• Base URL: Default http://localhost:8585 (configurable via PLAYWRIGHT_TEST_BASE_URL)
• Parallel execution: Tests run in parallel by default
• Retries: Configured for CI environments (1 retry on CI, 0 locally)
• Workers: 4 workers on CI, system default locally
• Reporters: List, HTML, GitHub Actions, and Blob reporters
• Timeout: 60 seconds per test (configurable)
• Traces: Captured on first retry
• Screenshots: Captured on failure only

​

Environment Variables

# Set base URL for tests
export PLAYWRIGHT_TEST_BASE_URL=http://localhost:8585

# Run in CI mode (enables retries and specific configurations)
export CI=true

# Run tests
yarn playwright:run

​

Test Projects

• setup: Authentication setup that runs before tests
• restore-policies: Cleanup that runs after tests
• chromium: Main test suite on Chrome
• data-insight-application: Data Insight app setup
• Data Insight: Tests specific to Data Insight features

​

CI/CD Integration

• Run with retries on failure
• Use optimized parallel execution
• Generate GitHub Actions compatible reports
• Fail fast on test.only() in source code

# CI-specific execution
CI=true yarn playwright:run

​

Troubleshooting

​

Common Issues and Solutions

1. Tests failing due to stale data
   • Reset the database to a clean state
   • Restart the OpenMetadata server
   Copy

   Ask AI

   # Find the distribution tar file
   cd openmetadata-dist/target/
   tar -xzf openmetadata-$VERSION.tar.gz
   # Execute drop-create-all command as described in deployment docs
   # Restart the server
   
2. Browser installation issues
   Copy

   Ask AI

   # Reinstall Playwright browsers
   yarn playwright install --force
   
3. Authentication failures
   • Clear the auth storage state
   Copy

   Ask AI

   rm -rf playwright/.auth/
   
4. Timeout issues
   • Increase timeout in playwright.config.ts
   • Check if services are fully started before running tests
5. Flaky tests
   • Use Playwright’s built-in retry mechanism
   • Ensure proper wait conditions in tests
   • Use data-testid attributes for reliable element selection

​

Best Practices

1. Use Page Object Model: Organize page interactions in separate classes
2. Data-testid attributes: Use consistent test IDs for element selection
3. Avoid hard-coded waits: Use Playwright’s built-in wait conditions
4. Clean test data: Ensure tests clean up after themselves
5. Parallel execution: Write tests to be independent and parallelizable
6. Meaningful assertions: Use descriptive assertion messages
7. Reusable utilities: Create utility functions for common operations

​

Additional Resources

• Playwright Documentation
• Playwright Best Practices
• OpenMetadata Testing Guidelines