
Security News
Bun 1.2.19 Adds Isolated Installs for Better Monorepo Support
Bun 1.2.19 introduces isolated installs for smoother monorepo workflows, along with performance boosts, new tooling, and key compatibility fixes.
playwright-custom-json-summary-report
Advanced tools
generate a customizable text summary of your playwright test results
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.
Run following commands:
npm install playwright-custom-json-summary-report --save-dev
yarn add playwright-custom-json-summary-report --dev
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.
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
}
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)
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 |
FAQs
generate a customizable text summary of your playwright test results
The npm package playwright-custom-json-summary-report receives a total of 238 weekly downloads. As such, playwright-custom-json-summary-report popularity was classified as not popular.
We found that playwright-custom-json-summary-report demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Bun 1.2.19 introduces isolated installs for smoother monorepo workflows, along with performance boosts, new tooling, and key compatibility fixes.
Security News
Popular npm packages like eslint-config-prettier were compromised after a phishing attack stole a maintainer’s token, spreading malicious updates.
Security News
/Research
A phishing attack targeted developers using a typosquatted npm domain (npnjs.com) to steal credentials via fake login pages - watch out for similar scams.