@zest-pw/test 1.0.0

package/dist/zephyr-api/update-execution-result.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateTestResult = updateTestResult;
+const get_results_from_json_1 = require("./get-results-from-json");
+const zephyr_api_1 = require("./zephyr-api");
+async function updateTestResult() {
+    console.log('Updating test result in Zephyr...');
+    const testResults = await (0, get_results_from_json_1.getResultsFromJson)();
+    if (!testResults) {
+        console.error('No test results found');
+        return;
+    }
+    // Iterate over object with testCaseKey as keys
+    for (const testCaseKey in testResults) {
+        const steps = testResults[testCaseKey];
+        const testCaseId = await (0, zephyr_api_1.getTestCaseId)(testCaseKey);
+        if (!testCaseId) {
+            console.warn(`Test case ID not found for key: ${testCaseKey}`);
+            continue;
+        }
+        const testExecutionKey = await (0, zephyr_api_1.getTestExecutionKey)(testCaseId);
+        if (testExecutionKey) {
+            await (0, zephyr_api_1.putTestExecution)(testExecutionKey, steps);
+        }
+    }
+}

package/dist/zephyr-api/zephyr-api.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Gets test case ID from Zephyr by its key
+ * @param testCaseKey - Test case key (e.g., "TC-001")
+ * @returns Test case ID or undefined in case of error
+ */
+export declare function getTestCaseId(testCaseKey: string): Promise<string | undefined>;
+/**
+ * Gets test execution key from Zephyr by test case ID
+ * @param testCaseId - Test case ID
+ * @returns Test execution key or null in case of error
+ */
+export declare function getTestExecutionKey(testCaseId: string): Promise<string | null>;
+/**
+ * Puts test execution in Zephyr
+ * @param testExecutionKey - Test execution key
+ * @param steps - Array of test steps to update
+ */
+export declare function putTestExecution(testExecutionKey: string, steps: string[]): Promise<void>;
+//# sourceMappingURL=zephyr-api.d.ts.map

package/dist/zephyr-api/zephyr-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zephyr-api.d.ts","sourceRoot":"","sources":["../../zephyr-api/zephyr-api.ts"],"names":[],"mappings":"AAQA;;;;GAIG;AACH,wBAAsB,aAAa,CAAC,WAAW,EAAE,MAAM,+BAmBtD;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,UAAU,EAAE,MAAM,0BA2B3D;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,gBAAgB,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,iBA2B/E"}

package/dist/zephyr-api/zephyr-api.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTestCaseId = getTestCaseId;
+exports.getTestExecutionKey = getTestExecutionKey;
+exports.putTestExecution = putTestExecution;
+// Common headers for all requests
+const getHeaders = () => {
+    return {
+        'Content-Type': 'application/json',
+        'Authorization': `Bearer ${process.env.ZEPHYR_API_KEY}`
+    };
+};
+/**
+ * Gets test case ID from Zephyr by its key
+ * @param testCaseKey - Test case key (e.g., "TC-001")
+ * @returns Test case ID or undefined in case of error
+ */
+async function getTestCaseId(testCaseKey) {
+    try {
+        const response = await fetch(process.env.ZEPHYR_API_URL + 'testcases/' + testCaseKey, {
+            method: 'GET',
+            headers: getHeaders(),
+        });
+        // Return only ID
+        const data = await response.json();
+        const id = data.id;
+        console.log('------------------------------------------');
+        console.log('Test case key:', testCaseKey);
+        return id;
+    }
+    catch (error) {
+        console.error('Error getting test case ID:', error);
+        return undefined;
+    }
+}
+/**
+ * Gets test execution key from Zephyr by test case ID
+ * @param testCaseId - Test case ID
+ * @returns Test execution key or null in case of error
+ */
+async function getTestExecutionKey(testCaseId) {
+    try {
+        const response = await fetch(process.env.ZEPHYR_API_URL + 'testexecutions' + '?testCycle=' + process.env.ZEPHYR_TEST_CYCLE_KEY + '&maxResults=1000', {
+            method: 'GET',
+            headers: getHeaders()
+        });
+        // Find object in array by testCase.id
+        const data = await response.json();
+        const testExecution = data.values.find((execution) => execution.testCase.id === testCaseId);
+        if (testExecution) {
+            console.log('Test execution key:', testExecution.key);
+            return testExecution.key;
+        }
+        else {
+            console.log('Test execution not found for testCase ID:', testCaseId);
+            return null;
+        }
+    }
+    catch (error) {
+        console.error('Error getting test execution:', error);
+        return null;
+    }
+}
+/**
+ * Puts test execution in Zephyr
+ * @param testExecutionKey - Test execution key
+ * @param steps - Array of test steps to update
+ */
+async function putTestExecution(testExecutionKey, steps) {
+    try {
+        const body = {
+            steps: steps
+        };
+        await fetch(process.env.ZEPHYR_API_URL + 'testexecutions/' + testExecutionKey + '/teststeps', {
+            method: 'PUT',
+            body: JSON.stringify(body),
+            headers: getHeaders()
+        });
+        console.log('Successfully sent test steps to Zephyr ✅');
+        console.log('------------------------------------------');
+        // Add 3 second pause after updating steps
+        console.log('Waiting 3 seconds before continuing... ⏳');
+        await new Promise(resolve => setTimeout(resolve, 3000));
+    }
+    catch (error) {
+        console.error('Error updating test steps:', error);
+        throw error;
+    }
+}

package/package.json

@@ -0,0 +1,69 @@
+{
+    "name": "@zest-pw/test",
+    "version": "1.0.0",
+    "description": "Advanced Playwright test framework with automatic screenshots, custom reporting, and Zephyr Scale integration",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "exports": {
+      ".": {
+        "default": "./dist/index.js",
+        "types": "./dist/index.d.ts"
+      },
+      "./reporter": "./dist/reporter/custom-reporter.js"
+    },
+    "files": [
+      "dist",
+      "scripts",
+      "README.md",
+      "LICENSE"
+    ],
+    "bin": {
+      "zest-pw-init": "scripts/install-config.js"
+    },
+    "scripts": {
+      "build": "tsc",
+      "test": "playwright test",
+      "prepublishOnly": "npm run build",
+      "type-check": "tsc --noEmit",
+      "postinstall": "node scripts/install-config.js",
+      "install": "node scripts/install-config.js"
+    },
+    "keywords": [
+      "playwright",
+      "testing",
+      "automation",
+      "zephyr",
+      "zephyr-scale",
+      "screenshots",
+      "test-framework",
+      "test-reporter",
+      "e2e",
+      "end-to-end"
+    ],
+    "author": "",
+    "license": "MIT",
+    "repository": {
+      "type": "git",
+      "url": "https://github.com/Capuchin33/zest-pw.git"
+    },
+    "homepage": "https://github.com/Capuchin33/zest-pw#readme",
+    "bugs": {
+      "url": "https://github.com/Capuchin33/zest-pw/issues"
+    },
+    "engines": {
+      "node": ">=16.0.0"
+    },
+    "peerDependencies": {
+      "@playwright/test": "^1.40.0"
+    },
+    "peerDependenciesMeta": {
+      "@playwright/test": {
+        "optional": false
+      }
+    },
+    "devDependencies": {
+      "@playwright/test": "^1.40.0",
+      "@types/node": "^20.0.0",
+      "typescript": "^5.0.0"
+    }
+  }

package/scripts/install-config.js

@@ -0,0 +1,92 @@
+#!/usr/bin/env node
+
+/**
+ * Post-install script to automatically create zest.config.ts in the project root
+ * This script runs after npm install and creates a default configuration file
+ * if it doesn't already exist.
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+const configTemplate = `import { defineZestConfig } from '@zest-pw/test';
+
+/**
+ * Zest Playwright Configuration
+ * 
+ * Configure test reporting, screenshots, and Zephyr integration
+ */
+export default defineZestConfig({
+  reporter: {
+    // Save test results to JSON file
+    saveJsonReport: true,
+    // Output directory for reports
+    outputDir: 'test-results',
+    // Print test results to console
+    printToConsole: true,
+    // Verbose output (includes all step details)
+    verbose: false,
+  },
+  screenshots: {
+    // Enable screenshot capture
+    enabled: true,
+    // Include screenshots in JSON report
+    includeInReport: true,
+    // Capture screenshots only on failure
+    onlyOnFailure: false,
+    // Save screenshots to disk as files
+    saveToDisk: false,
+  },
+  zephyr: {
+    // Enable Zephyr Scale integration
+    enabled: false,
+    // Update test results in Zephyr after test run
+    updateResults: false,
+    // API credentials (uses environment variables by default)
+    // apiUrl: process.env.ZEPHYR_API_URL,
+    // apiKey: process.env.ZEPHYR_API_KEY,
+    // testCycleKey: process.env.ZEPHYR_TEST_CYCLE_KEY,
+  },
+});
+`;
+
+const configFileName = 'zest.config.ts';
+
+// When postinstall runs, process.cwd() is the project root where npm install was executed
+// This is the correct directory where we want to create zest.config.ts
+const projectRoot = process.cwd();
+const configPath = path.join(projectRoot, configFileName);
+
+// Skip if we're in the zest-pw package development directory itself
+// (when running npm install in the package repo)
+const packageJsonPath = path.join(projectRoot, 'package.json');
+if (fs.existsSync(packageJsonPath)) {
+  try {
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+    if (packageJson.name === '@zest-pw/test') {
+      // We're in the package development directory, skip
+      process.exit(0);
+    }
+  } catch (e) {
+    // If we can't read package.json, continue anyway
+  }
+}
+
+// Перевіряємо, чи файл вже існує
+if (fs.existsSync(configPath)) {
+  console.log(`[@zest-pw/test] ✓ ${configFileName} already exists, skipping...`);
+  process.exit(0);
+}
+
+// Створюємо файл конфігурації
+try {
+  fs.writeFileSync(configPath, configTemplate, 'utf8');
+  console.log(`[@zest-pw/test] ✓ Created ${configFileName} in project root`);
+  console.log(`[@zest-pw/test]   Location: ${configPath}`);
+} catch (error) {
+  // Don't break the installation process, but show the error
+  console.error(`[@zest-pw/test] ⚠ Failed to create ${configFileName}:`, error.message);
+  console.error(`[@zest-pw/test]   Target directory: ${projectRoot}`);
+  process.exit(0); // Exit with 0 to not break npm install
+}
+