Playwright test reporting

If you are using Playwright with JavaScript/Node.js Tesults supplies a reporter specifically designed for Playwright to make integration quick and easy.

Install the playwright-tesults-reporter

npm install playwright-tesults-reporter --save

Specify the playwright-tesults-reporter as one or one of many reporters to use in the playwright.conf.js file:

const config = {
  reporter: [['playwright-tesults-reporter', {'tesults-target': 'token'}]]
}

The 'token' above should be replaced with your Tesults target token, which you received when creating a project or target, and can be regenerated from the configuration menu.

Then run playwright as usual with the npx playwright test command.

Files generated by tests

Any files attached during a test using the built-in Playwright attach method (example below) will be automatically uploaded to Tesults for reporting.

await page.screenshot({path: 'screenshot.png', fullPage: true });
await testInfo.attach('screenshot.png', { path: 'screenshot.png' });
await testInfo.attach('otherpic.jpg', { path: '/Users/John/Desktop/picture1.jpg'});

Caution: If uploading files the time taken to upload is entirely dependent on your network speed. Typical office upload speeds of 100 - 1000 Mbps should allow upload of even hundreds of files quite quickly, just a few seconds, but if you have slower access it may take hours. We recommend uploading a reasonable number of files for each test case. The upload method blocks at the end of a test run while uploading test results and files. When starting out test without files first to ensure everything is setup correctly.

Handling multiple test jobs with targets

For supporting multiple test jobs Tesults suggests creating multiple targets, as outlined in the project structuring advice. There are several ways you could handle configuration for multiple targets within Playwright and we discuss one way here.

Utilize a .env file. Store multiple target tokens in the file, for example:

# .env file
TARGET1=eyJ0eX...
TARGET2=eyJ0eY...
TARGET3=eyJ0eZ...

Then in your playwright.conf.js file you can utilize these values when you pass in the target to Tesults, for example:

require('dotenv').config();
...
const config = {
  reporter: [['playwright-tesults-reporter', {'tesults-target': process.env.TARGET1}]]
}
...

You can create multiple playwright.conf.js files each referencing a different target and in your package.json file create scripts to run each one, for example:

...
"scripts": {
  "test-job-1": "npx playwright test --config=playwright.config1.js",
  "test-job-2": "npx playwright test --config=playwright.config2.js",
  "test-job-3": "npx playwright test --config=playwright.config3.js"
}, ...

Run the desired test job:

npm run test-job-1

Target

tesults-targetRequired

Required arg to upload to Tesults, if this arg is not provided the reporter does not attempt upload, effectively disabling it. Get your target token from the configuration menu in the Tesults web interface.

{'tesults-target': 'token'}

tesults-build-nameOptional

Use this to report a build version or name for reporting purposes.

{'tesults-build-name': '1.0.0'}

tesults-build-resultOptional

Use this to report the build result, must be one of [pass, fail, unknown].

{'tesults-build-result': 'pass'}

tesults-build-descriptionOptional

Use this to report a build description for reporting purposes.

{'tesults-build-description': 'added new feature'}

tesults-build-reasonOptional

Use this to report a build failure reason.

{'tesults-build-reason': 'build error line 201 somefile.js'}

Result interpretation is supported by Playwright. Install version 1.0.1 or newer. If you use result interpretation we recommend you add these minimum mapping values: