Meowwright

Light and modern testing framework for Playwright.

Overview

Meowwright is a testing framework built on top of Playwright, designed to make UI testing easier and more maintainable. It follows the Page Object Model pattern and provides a structured approach to writing tests.

Features

• Page Object Model implementation
• Robust fixture system supporting multiple page objects
• Centralized configuration management system for test data and environments
• Advanced logging strategy with Winston
• Comprehensive utility classes for common operations
• CI/CD integration with Google Cloud Build

Getting Started

Prerequisites

• Node.js (latest LTS version recommended)
• npm or yarn

Installation

1. Clone the repository
2. Install dependencies:

npm ci

3. Install Playwright browsers:

npx playwright install

Running Tests

To run all tests:

npx playwright test

To run a specific test file:

npx playwright test tests/example.spec.ts

Project Structure

• pages/: Page Object Model classes
• fixtures/: Test fixtures
• tests/: Test files
• config/: Configuration files and manager
• playwright.config.ts: Playwright configuration
• docs/: Documentation

Documentation

• Configuration Management System: How to use the centralized configuration system
• Logging Strategy: How to use the logging system
• Utility Classes: How to use the utility classes for common operations

Using the Fixture System

Meowwright provides a robust fixture system that allows tests to use multiple page objects. The main fixture file is fixtures/page-fixtures.ts, which exports a test object with all available page objects.

Example Usage

// Import the test object with all fixtures
import { test } from '../../fixtures/page-fixtures';

// Use multiple page objects in a test
test('Navigate between pages', async ({ homePage, elementsPage }) => {
    await homePage.navigate();
    await elementsPage.navigate();
});

// Or use just the page objects you need
test('Home page only', async ({ homePage }) => {
    await homePage.navigate();
});

Adding New Page Objects

To add a new page object to the fixture system:

1. Create your page object class in the pages/ directory
2. Add it to the PageFixtures type in fixtures/page-fixtures.ts
3. Add a fixture function for it in the test.extend() call

CI/CD Pipeline

This project includes a CI/CD pipeline configuration for Google Cloud Build. The pipeline:

1. Installs dependencies
2. Installs Playwright browsers
3. Runs tests
4. Uploads test reports and artifacts to Google Cloud Storage

For detailed setup instructions, see CI/CD Setup.

License

Apache License 2.0