playwright-zephyr-junit-reporter 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 abautu@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,53 @@
+# playwright-zephyr-junit-reporter
+
+A [Playwright](https://playwright.dev/) reporter that imports JUnit test results into [Zephyr Squad for Jira Cloud](https://zephyrdocs.atlassian.net/wiki/spaces/ZFJCLOUD/pages/1686798372/Test+Automation+API+Documentation) via the Test Automation API.
+
+## Installation
+
+```bash
+npm install --save-dev playwright-zephyr-junit-reporter
+```
+
+## Usage
+
+Add both the built-in `junit` reporter and this reporter to your `playwright.config.js`. Both must point to the same output file — this reporter reads the file that `junit` writes.
+
+```js
+// playwright.config.js
+export default {
+  reporter: [
+    ['junit', { stripANSIControlSequences: true, outputFile: './playwright-report/junit/results.xml' }],
+    ['playwright-zephyr-junit-reporter', {
+      projectKey: process.env.ZEPHYR_PROJECT_KEY,
+      accountId: process.env.ZEPHYR_ACCOUNT_ID,
+      accessKey: process.env.ZEPHYR_ACCESS_KEY,
+      secretKey: process.env.ZEPHYR_SECRET_KEY,
+      jUnitFile: './playwright-report/junit/results.xml',
+    }],
+  ],
+};
+```
+
+## Configuration
+
+| Option | Type | Required | Default | Description |
+|---|---|---|---|---|
+| `projectKey` | `string` | yes | — | Jira project key (e.g. `PROJ`) |
+| `accountId` | `string` | yes | — | Jira account ID of the user running the import |
+| `accessKey` | `string` | yes | — | Zephyr Squad access key |
+| `secretKey` | `string` | yes | — | Zephyr Squad secret key |
+| `jUnitFile` | `string` | yes | — | Path to the JUnit XML results file |
+| `jobName` | `string` | no | `"Import tests results"` | Display name for the automation job |
+| `jobDescription` | `string` | no | `"Import automatic tests results from JUnit file."` | Description for the automation job |
+| `cycleName` | `string` | no | `"Playwright tests"` | Test cycle name in Zephyr (current date/time is appended automatically) |
+| `versionName` | `string` | no | `"Unscheduled"` | Zephyr version/fix version name |
+| `timeOut` | `number` | no | `300000` | Upload job timeout in milliseconds |
+
+### Obtaining credentials
+
+- **`accessKey` / `secretKey`**: Generated in Jira under **Apps → Zephyr Squad → API Keys**.
+- **`accountId`**: Your Atlassian account ID, visible in your Jira profile URL or via the Jira REST API.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,41 @@
+import type { FullResult, Reporter } from '@playwright/test/reporter';
+/**
+ * Options for {@link ZephyrJUnitImportReporter}.
+ */
+export interface ZephyrJUnitImportReporterOptions {
+    /** Jira project key (e.g. `"PROJ"`). */
+    projectKey: string;
+    /** Jira account ID of the user running the import. */
+    accountId: string;
+    /** Zephyr Squad access key. */
+    accessKey: string;
+    /** Zephyr Squad secret key. */
+    secretKey: string;
+    /** Path to the JUnit XML results file. */
+    jUnitFile: string;
+    /** Upload job timeout in ms. Defaults to 5 minutes. */
+    timeOut?: number;
+    /** Display name for the automation job. */
+    jobName?: string;
+    /** Description for the automation job. */
+    jobDescription?: string;
+    /** Test cycle name in Zephyr. Defaults to `"Playwright tests"`. */
+    cycleName?: string;
+    /** Zephyr version/fix version name. Defaults to `"Unscheduled"`. */
+    versionName?: string;
+}
+declare class ZephyrJUnitImportReporter implements Reporter {
+    private projectKey;
+    private accountId;
+    private accessKey;
+    private secretKey;
+    private jUnitFile;
+    private timeOut;
+    private jobName;
+    private jobDescription;
+    private cycleName;
+    private versionName;
+    constructor(options: ZephyrJUnitImportReporterOptions);
+    onEnd(_result: FullResult): Promise<void>;
+}
+export default ZephyrJUnitImportReporter;

package/dist/index.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_1 = require("@playwright/test");
+const fs_1 = require("fs");
+// See https://zephyrdocs.atlassian.net/wiki/spaces/ZFJCLOUD/pages/1686798372/Test+Automation+API+Documentation
+const ZEPHYR_BASE_URL = 'https://prod-vortexapi.zephyr4jiracloud.com/';
+class ZephyrJUnitImportReporter {
+    constructor(options) {
+        this.projectKey = options.projectKey;
+        this.accountId = options.accountId;
+        this.accessKey = options.accessKey;
+        this.secretKey = options.secretKey;
+        this.jUnitFile = options.jUnitFile;
+        this.timeOut = options.timeOut || 5 * 60000;
+        this.jobName = options.jobName || 'Import tests results';
+        this.jobDescription = options.jobDescription || 'Import automatic tests results from JUnit file.';
+        this.cycleName = options.cycleName || 'Playwright tests';
+        this.versionName = options.versionName || 'Unscheduled';
+    }
+    async onEnd(_result) {
+        let jUnitBuffer;
+        try {
+            jUnitBuffer = (0, fs_1.readFileSync)(this.jUnitFile);
+        }
+        catch {
+            throw new Error(`JUnit file not found: ${this.jUnitFile}`);
+        }
+        const client = await test_1.request.newContext({ baseURL: ZEPHYR_BASE_URL });
+        try {
+            let response;
+            response = await client.post('api/v1/jwt/generate', {
+                data: {
+                    accessKey: this.accessKey,
+                    secretKey: this.secretKey,
+                    accountId: this.accountId,
+                },
+            });
+            if (!response.ok()) {
+                throw new Error(`Failed to generate JWT: ${await response.text()}`);
+            }
+            const jwt = await response.text();
+            console.log('Create and execute an upload job for Zephyr test automation.');
+            response = await client.post('api/v1/automation/job/saveAndExecute', {
+                headers: {
+                    accessKey: this.accessKey,
+                    jwt: jwt,
+                },
+                multipart: {
+                    projectKey: this.projectKey,
+                    jobName: this.jobName,
+                    jobDescription: this.jobDescription,
+                    automationFramework: 'JUNIT',
+                    createNewCycle: true,
+                    cycleName: this.cycleName,
+                    appendDateTimeInCycleName: true,
+                    versionName: this.versionName,
+                    file: {
+                        name: 'results.xml',
+                        mimeType: 'text/xml',
+                        buffer: jUnitBuffer,
+                    },
+                    assigneeUser: this.accountId,
+                    mandatoryFields: JSON.stringify({
+                        reporter: {
+                            id: this.accountId,
+                        },
+                    }),
+                },
+                timeout: this.timeOut,
+            });
+            if (!response.ok()) {
+                throw new Error(`Failed to create upload test automation: ${await response.text()}`);
+            }
+            console.log('Response: ' + (await response.json()).message);
+        }
+        finally {
+            await client.dispose();
+        }
+    }
+}
+exports.default = ZephyrJUnitImportReporter;

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "playwright-zephyr-junit-reporter",
+  "version": "1.0.0",
+  "description": "Playwright reporter that imports JUnit test results to Zephyr Squad (Zephyr for Jira Cloud) via the Test Automation API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "@playwright/test": ">=1.0.0"
+  },
+  "keywords": [
+    "playwright",
+    "zephyr",
+    "zephyr-squad",
+    "zephyr-for-jira",
+    "junit",
+    "reporter",
+    "test-automation"
+  ],
+  "author": "abautu@gmail.com",
+  "license": "MIT",
+  "devDependencies": {
+    "@playwright/test": "^1.59.1",
+    "@types/node": "^25.6.2",
+    "typescript": "^6.0.3"
+  }
+}