Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elaichenkov/playwright-zephyr
Zephyr reporter for the Playwright
https://github.com/elaichenkov/playwright-zephyr
playwright reporter typescript zephyr
Last synced: about 4 hours ago
JSON representation
Zephyr reporter for the Playwright
- Host: GitHub
- URL: https://github.com/elaichenkov/playwright-zephyr
- Owner: elaichenkov
- License: mit
- Created: 2021-10-26T14:52:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T20:30:38.000Z (3 months ago)
- Last Synced: 2024-10-29T22:56:33.079Z (3 months ago)
- Topics: playwright, reporter, typescript, zephyr
- Language: TypeScript
- Homepage:
- Size: 1.68 MB
- Stars: 33
- Watchers: 4
- Forks: 21
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zephyr reporter for Playwright
Publish Playwright test run on Zephyr
## Install
```sh
npm i -D playwright-zephyr
```
## Usage
Add **Server** reporter to your `playwright.config.ts` configuration file
```typescript
// playwright.config.ts
import { PlaywrightTestConfig } from '@playwright/test';
const config: PlaywrightTestConfig = {
reporter: [['playwright-zephyr', {
host: 'https://jira.your-company-domain.com/',
authorizationToken: 'SVSdrtwgDSA312342--',
projectKey: 'JARV'
}]],
}
```
If you want to use **Cloud** reporter, you need to specify `cloud` option:
```typescript
// playwright.config.ts
import { PlaywrightTestConfig } from '@playwright/test';
const config: PlaywrightTestConfig = {
reporter: [
['playwright-zephyr/lib/src/cloud', {
projectKey: 'JARV', // <-- Replace with your project key
authorizationToken: process.env.ZEPHYR_AUTH_TOKEN, // <-- Replace with your authorization token
}],
],
}
```
If your test cycle requires custom fields, you can specify them in `testCycle` option:
```typescript
// playwright.config.ts
import { PlaywrightTestConfig } from '@playwright/test';
const config: PlaywrightTestConfig = {
reporter: [
['playwright-zephyr/lib/src/cloud', {
projectKey: 'JARV', // <-- Replace with your project key
authorizationToken: process.env.ZEPHYR_AUTH_TOKEN, // <-- Replace with your authorization token
testCycle: {
name: `Automated Playwright Run - ${new Date().toISOString()}`,
customFields: {
Browser: 'Google Chrome',
Device: 'MacOS',
},
},
}],
],
}
```
Read how to get Zephyr authorization token [here](https://tm4j-cloud.elevio.help/en/articles/164).
Also, your playwright tests should include unique ID inside square brackets `[J79]` of your Zephyr test case:
```typescript
// ↓ Zephyr test case ID inside square brackets
test('[J79] basic test', async ({ page }) => {
await page.goto('https://playwright.dev/');
const title = page.locator('.navbar__inner .navbar__title');
await expect(title).toHaveText('Playwright');
});
```
Then run your tests with `npx playwright test` command and you'll see the result in console:
```sh
✅ Test cycle JARV-C2901 has been created
👇 Check out the test result
🔗 https://jira.your-company-domain.com/secure/Tests.jspa#/testPlayer/JARV-C2901
```
And you'll see the result in the Zephyr:
## License
playwright-zephyr is [MIT licensed](./LICENSE).
## Author
Yevhen Laichenkov