The Playwright Reports Server provides APIs for managing and generating reports based on Playwright test results. It allows to:
- Store HTML reports and easily view them without downloading locally
- Merge results into one report from sharded runs together (https://playwright.dev/docs/test-sharding)
- Store raw results, and agregate them together into one report
Clone this repo and run:
npm run build && npm run start
All data will be stored at /public/data/
folder. You can backup it, to keep your data safe.
Application will be accessible at localhost:3000
Returns list of generated reports (can be viewed by Url) on server:
curl --location --request DELETE 'http://localhost:3000/api/report/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: <api-token>' \
--data '{
"reportsIds": [
"6a615fe1-2452-4867-9ae5-6ee68313aac6"
]
}'
Response example:
[
{
"reportID": "8e9af87d-1d10-4729-aefd-3e92ee64d06c",
"createdAt": "2024-05-06T16:52:45.017Z",
"reportUrl": "/data/reports/8e9af87d-1d10-4729-aefd-3e92ee64d06c/index.html"
},
{
"reportID": "8fe427ed-783c-4fb9-aacc-ba6fbc5f5667",
"createdAt": "2024-05-06T16:59:38.814Z",
"reportUrl": "/data/reports/8fe427ed-783c-4fb9-aacc-ba6fbc5f5667/index.html"
}
]
Deletes report folder
curl --location --request DELETE 'http://localhost:3000/api/report/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: <api-token>' \
--data '{
"reportsIds": [
"6a615fe1-2452-4867-9ae5-6ee68313aac6"
]
}'
Response example:
{
"message": "Reports deleted successfully",
"reportsIds": ["6a615fe1-2452-4867-9ae5-6ee68313aac6"]
}
Generates report from provided resultsIds, merges results together into one report, using https://playwright.dev/docs/test-sharding#merge-reports-cli
curl --location 'http://localhost:3000/api/report/generate' \
--header 'Content-Type: application/json' \
--header 'Authorization: <api-token>' \
--data '{
"resultsIds": [
"b1d29907-7efa-48e8-a8d1-db49cf5c2998",
"a7beb04b-f190-4fbb-bebd-58b2c776e6c3",
]
}'
Response example:
{
"reportId": "8e9af87d-1d10-4729-aefd-3e92ee64d06c",
"reportUrl": "/data/reports/8e9af87d-1d10-4729-aefd-3e92ee64d06c/index.html"
}
Returns list of currently existing results (raw blobs .zip files) on server:
curl --location 'http://localhost:3000/api/result/list'
Response will contain array of results:
[
{
"resultID": "a7beb04b-f190-4fbb-bebd-58b2c776e6c3",
"createdAt": "2024-05-06T16:40:33.021Z",
"testRunName": "regression-run-v1.10",
"reporter": "okhotemskyi"
}
]
Accepts .zip archive - output of blob report, details - https://playwright.dev/docs/test-reporters#blob-reporter:
curl --location --request PUT 'http://localhost:3000/api/result/upload' \
--header 'Authorization: <api-token>' \
--form 'file=@"/path/to/file"'
Notice, that you can pass any custom keys with string values as form keys:
curl --location --request PUT 'http://localhost:3000/api/result/upload' \
--header 'Authorization: <api-token>' \
--form 'file=@"/path/to/file"' \
--form 'project="desktop"' \
--form 'reporter="okhotemskyi"' \
--form 'appVersion="1.2.2"'
Response example:
{
"message": "Success",
"data": {
"resultID": "e7ed1c2a-6b24-421a-abb6-095fb62f9957",
"createdAt": "2024-07-07T13:35:57.382Z",
"project": "desktop",
"reporter": "okhotemskyi",
"appVersion": "1.2.2"
},
"status": 201
}
Returns server stats:
curl --location 'http://localhost:3000/api/info' \
--header 'Authorization: <api-token>' \
Response example:
{
"dataFolderSizeinMB": "0.00 MB",
"numOfResults": 0,
"resultsFolderSizeinMB": "0.00 MB",
"numOfReports": 0,
"reportsFolderSizeinMB": "0.00 MB"
}
Returns server stats:
curl --location 'http://localhost:3000/api/ping'
Response example:
pong
Optional authorization can be enabled, by setting API_TOKEN
environment variable on application start. This token will be required to be passed for every request as header:
Authorization: YOUR_TOKEN
If you do not set a token the application will work without authorization.