playwright-custom-json-summary-report v2.2.0
📜 🎭 Playwright Summary Report JSON 🎭 📜
Small JSON based custom reporter for Playwright. It can be handy to publish test results for things such as an SNS message or minimal Slack update. This Tool allows you to generate smaller reports with basic info about your test run.
Table of Contents
✨ Installation ✨
Run following commands:
npm
npm i playwright-custom-json-summary-report
yarn
yarn add playwright-custom-json-summary-report
Configuration
Modify your playwright.config.ts file to include the reporter:
reporter: [
['playwright-custom-json-summary-report', { outputFile: 'custom-summary.json' }]],
['html'], // other reporters
['dot']
],The default output location will be to your root as summary.json Including the optional outputFile parameter allows you to specify a custom report location.
Default Output 📜
If you do not pass an outputFile option, then the summary will be generated to a summary.json file in the following format:
{
"Total Tests in Suite": 30,
"Total Tests Completed": 30,
"Tests Passed": 27,
"Tests Failed": 0,
"Flaky Tests": 0,
"Test run was failure free": true,
"Test Skipped": 3,
"Duration of CPU usage in ms": 75188,
"Duration of entire test run in ms": 12531,
"Average Test Duration in ms": 2506.3,
"Test Suite Duration": "00:13 (mm:ss)",
"Average Test Duration": "00:03 (mm:ss)",
"Number of workers used for test run": 6
}Customizing Outputs 👨💻
You may also create a custom report by leveraging the values in the stats object. To add a custom report leveraging your stats, create a function in the format:
import type { Stats } from 'playwright-custom-json-summary-report';
function customReport(stats: Stats) {
return `Greetings, hello, ${stats.expectedResults} tests passed as expected in ${stats.formattedDurationSuite}`;
}
export default customReport;and then modify your playwright.config.ts file with the following:
import type { PlaywrightTestConfig } from '@playwright/test';
import { devices } from '@playwright/test';
import customReport from './customReport';
// Your custom report path and preferred name
const config: PlaywrightTestConfig = {
...
reporter: [
['playwright-custom-json-summary-report', { outputFile: 'custom-summary.json', inputTemplate: customReport }]]
],this will generate a custom-summary.json file such as :
hello, 50 tests passed as expected in 03:51 (mm:ss)Available Stats 🧰
The stats object provides information on your test suite:
| Name | type | Description |
|---|---|---|
| testsInSuite | number | Total number of tests in suite |
| totalTestsRun | number | total tests run. Retried tests can make this value larger than testsInSuite |
| expectedResults | number | total test finished as expected |
| unexpectedResults | number | total tests not finished as expected |
| flakyTests | number | total of tests that passed when retried |
| testMarkedSkipped | number | total tests marked as test.skip() or test.fixme() |
| failureFree | boolean | returns true if suite completes with all test completing as expected after retries |
| durationCPU | number | total milliseconds spent run tests. If tests run parallel with multiple workers, this value will be larger than the duration of running the suite |
| durationSuite | number | milliseconds to complete all tests in suite |
| avgTestDuration | number | average test duration of all tests in milliseconds |
| formattedDurationSuite | string | duration to complete all tests in mm:ss format |
| formattedAvgTestDuration | string | average test duration of all tests in mm:ss format |
| failures | object | an object containing each failure in the format {[test.title: result.status]} Retries with failures will populate this with multiple entries of the same test |
| workers | number | total number of workers used to run the suite |
Credit 👏🏻
Special thanks to Stephen Kilbourn.
The original code, which served as the foundation for this work, was sourced from his Git repository. The code has been modified to meed the unique needs and goals for my project.