playwright-ci-reporter v1.5.2
Playwright CI Reporter
A modern, maintainable custom reporter for Playwright tests that enhances your test output with colorized results, comprehensive metrics, and intelligent failure analysis. Perfect for CI/CD pipelines and local development.
⨠Features
šØ Smart Colorized Output:
- ā Passed tests (Green)
- ā Failed tests (Red)
- š Retry attempts (Yellow)
- ā ļø Skipped tests (Gray)
- š Test run status (Bright Magenta)
š Comprehensive Metrics:
- Total execution time with smart formatting
- Average test duration analysis
- Slowest test identification
- Top slowest tests ranking
- Pass/fail/skip statistics
š Advanced Features:
- Configurable slow test thresholds
- Timeout warnings
- Stack trace controls
- Retry attempt tracking
- Manual testing reminders for skipped tests
š Intelligent Reporting:
- Detailed failure analysis
- Clear error messages
- Formatted stack traces
- Test timing insights
- Skipped test warnings
š Installation
Install the package using npm:
npm install playwright-ci-reporter
Usage
Integrate the playwright-ci-reporter
into your Playwright configuration file (playwright.config.ts
):
import {defineConfig} from '@playwright/test';
export default defineConfig({
testDir: './tests', // Adjust to your test directory
retries: 2, // Example of using retries
reporter: [['playwright-ci-reporter']],
use: {
trace: 'on-first-retry', // Example: trace only on retries
video: 'on-first-retry',
screenshot: 'only-on-failure',
},
});
š Output Examples
Successful Run
š Starting test run: 3 tests using 2 workers
ā
Login test passed in 1.23s
ā
API integration test passed in 2.45s
ā ļø Payment test was skipped
ā
All 3 tests passed | 1 skipped | ā± Total: 3.68s
Additional Metrics:
- Average passed test time: 1.84s
- Slowest test took: 2.45s
- Top 3 slowest tests:
1. API integration test: 2.45s
2. Login test: 1.23s
ā ļø Warning: 1 test was skipped.
Please ensure to test the skipped scenarios manually before deployment.
Failed Run
š Starting test run: 3 tests using 2 workers
ā
Login test passed in 1.23s
ā API test failed in 2.45s
š Retry attempt for "API test" (failed) in 2.50s
ā ļø Payment test was skipped
ā 1 of 3 tests failed | 1 passed | 1 skipped | ā± Total: 6.18s
Failures:
--- Failure #1 ---
Test: API test
Stack Trace:
at Connection.connect (/src/api/connection.ts:45:7)
š¤ Contributing
We welcome contributions! Here's how you can help:
- Fork the repository
- Create your feature branch:
git checkout -b feature/amazing-feature
- Make your changes and commit them:
git commit -m 'Add some amazing feature'
- Push to your fork:
git push origin feature/amazing-feature
- Open a Pull Request
Please ensure your PR:
- Follows the existing code style
- Includes appropriate tests
- Updates documentation as needed
- Describes the changes made
š License
This project is licensed under the MIT License - see the LICENSE file for details.
š Acknowledgments
- Built with Playwright
- Inspired by the need for better test reporting in CI/CD pipelines
- Thanks to all contributors who help make this reporter better
7 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago