Skip to content

Playwright ​

Playwright Test was created specifically to accommodate the needs of end-to-end testing. It supports all modern rendering engines including Chromium, WebKit, and Firefox.

This guide explains how to integrate Playwright with TestBeats for centralized and AI-powered reporting.

Prerequisites ​

  • TestBeats API Key (optional) - Sign in for free with your Work Email at testbeats portal to have a centralized and AI powered reporting. Once you're signed in, create a new organization and generate an API Key.

  • In-coming Webhook URL - Create an incoming webhook url for your Slack or Microsoft Teams or Google Chat.

Integration ​

TestBeats can consume the following reports for publishing test results from Playwright:

JUnit Report ​

1. Configure Playwright to generate JUnit reports ​

Update your playwright.config.ts file to include the junit reporter:

ts
reporter: [
  ['list'],
  ['junit', {  outputFile: 'test-results/junit.xml' }]
]

2. Configure TestBeats to consume JUnit reports ​

Test results can be either published using the command line mode or the configuration mode.

2.1 Command Line Mode ​
  1. First, specify the target name using the appropriate target flag. For example, use the --slack flag to specify the incoming webhook URL.

  2. Next, specify the path to the result files using the appropriate results format flag. For example, use the --junit flag for junit results.

sh
npx testbeats@latest publish --api-key '<api-key>' --slack '<slack-incoming-webhook-url>' --junit 'test-results/junit.xml'
sh
# Download the executable via `curl`.
curl https://raw.githubusercontent.com/test-results-reporter/testbeats/main/scripts/download-latest.sh | bash

# After download completes, run the executable based on you operating system.
./testbeats-linux publish --api-key '<api-key>' --slack '<slack-incoming-webhook-url>' --junit 'test-results/junit.xml'

TIP

  • TestBeats API Key is optional.
  • Environment variable TEST_BEATS_API_KEY can also be used to specify the API key.
2.2 Configuration Mode ​

Update your testbeats.config.json file to include the junit result file:

json
{
  "api_key": "<api-key>",
  "targets": [
    {
      "name": "slack",
      "inputs": {
        "url": "<incoming-webhook-url>"
      }
    }
  ],
  "results": [
    {
      "type": "junit",
      "files": ["test-results/junit.xml"]
    }
  ]
}
sh
npx testbeats@latest publish -c path/to/testbeats.config.json
sh
# Download the executable via `curl`.
curl https://raw.githubusercontent.com/test-results-reporter/testbeats/main/scripts/download-latest.sh | bash

# After download completes, run the executable based on you operating system.
./testbeats-linux publish -c path/to/testbeats.config.json

Example Integration ​

For a complete example of integrating Playwright with TestBeats, refer to this GitHub repository example.

Released under the MIT License.