@testrx/playwright-reporter
v1.0.0
Published
Playwright reporter that captures step-level test execution detail and uploads results to TestRx.
Maintainers
Readme
@testrx/playwright-reporter
A Playwright reporter that captures step-by-step test execution detail
(actions, assertions, timing, errors) and uploads it to TestRx, going
further than Playwright's built-in json reporter, which only captures a
pass/fail summary per test, not individual step detail.
Install
npm install --save-dev @testrx/playwright-reporterConfigure
In playwright.config.ts:
import { defineConfig } from '@playwright/test';
export default defineConfig({
reporter: [
['html'],
['@testrx/playwright-reporter', {
executedBy: process.env.CI ? 'CI' : process.env.USER
}]
]
});Authenticate
The TestRx API token is read only from the TESTRX_API_TOKEN
environment variable. There is no config-file option for it, so it can
never end up committed to source control:
TESTRX_API_TOKEN=your-token-here npx playwright testOr set it as a persistent environment variable in your shell/CI system —
the same token generated from TestRx's Integrations page. Note that the
TestRx VS Code extension's "TestRx: Set API Token" command stores the
token in VS Code's own secret storage, which does NOT set this environment
variable automatically, since npx playwright test runs as a separate
process with no access to VS Code's internal storage. Set
TESTRX_API_TOKEN separately for test runs.
How it knows which issue/project a run belongs to
If you generate test specs using the TestRx VS Code extension (from a
.feature file downloaded via the TestRx web UI), each generated spec
automatically carries issueKey, projectKey, and projectName as
Playwright test annotations. This reporter reads those per test, so no
manual configuration is needed per spec file.
For specs not generated this way, set fallback values in the reporter's config options:
['@testrx/playwright-reporter', {
issueKey: 'PROJ-123',
projectName: 'My Project'
}]A single Playwright run can contain specs for multiple issues — tests are
grouped by issueKey, and one run is uploaded to TestRx per group.
Publishing (maintainers)
npm run build
npm publish --access publicRequires being logged in to npm (npm login) as a member of the @testrx
organization on npmjs.com.
