@msalaam/xray-qe-toolkit 1.1.0 → 1.2.0

package/lib/playwrightConverter.js

@@ -0,0 +1,297 @@
+/**
+ * @msalaam/xray-qe-toolkit — Playwright to Xray JSON Converter
+ *
+ * Converts Playwright test results JSON format to Xray Cloud JSON import format.
+ * Supports mapping Playwright test annotations to Xray test keys.
+ */
+
+/**
+ * Convert Playwright JSON results to Xray JSON import format.
+ *
+ * Playwright test mapping:
+ * - Test annotations like `test.info().annotations.push({type: 'xray', description: 'PROJ-123'})`
+ * - Or test titles that include [PROJ-123] format
+ * - Falls back to creating test summary from test title
+ *
+ * @param {object} playwrightJson - Playwright JSON reporter output
+ * @param {object} options - Conversion options
+ * @param {string} options.testExecutionKey - Xray Test Execution key to link results
+ * @param {string} options.projectKey - JIRA project key for test creation
+ * @param {string} options.summary - Test Execution summary (optional)
+ * @param {string} options.description - Test Execution description (optional)
+ * @returns {object} Xray JSON format
+ */
+export function convertPlaywrightToXray(playwrightJson, options = {}) {
+  const startTime = new Date(playwrightJson.config?.metadata?.actualWorkers ? 
+    Date.now() - getTotalDuration(playwrightJson) : Date.now()).toISOString();
+  const finishTime = new Date().toISOString();
+
+  const xrayJson = {
+    info: {
+      summary: options.summary || `Playwright Test Execution - ${new Date().toISOString()}`,
+      description: options.description || "Automated Playwright test execution results",
+      startDate: startTime,
+      finishDate: finishTime,
+    },
+    tests: [],
+  };
+
+  // Add testExecutionKey if provided
+  if (options.testExecutionKey) {
+    xrayJson.info.testExecutionKey = options.testExecutionKey;
+  }
+
+  // Add project if provided and no testExecutionKey
+  if (options.projectKey && !options.testExecutionKey) {
+    xrayJson.info.project = options.projectKey;
+  }
+
+  // Process all test suites
+  if (playwrightJson.suites) {
+    for (const suite of playwrightJson.suites) {
+      processTestSuite(suite, xrayJson.tests, options);
+    }
+  }
+
+  return xrayJson;
+}
+
+/**
+ * Get total duration from Playwright results
+ * @param {object} playwrightJson
+ * @returns {number} Duration in milliseconds
+ */
+function getTotalDuration(playwrightJson) {
+  let total = 0;
+  if (playwrightJson.suites) {
+    for (const suite of playwrightJson.suites) {
+      total += getSuiteDuration(suite);
+    }
+  }
+  return total;
+}
+
+/**
+ * Get duration of a test suite
+ * @param {object} suite
+ * @returns {number}
+ */
+function getSuiteDuration(suite) {
+  let duration = 0;
+  if (suite.specs) {
+    for (const spec of suite.specs) {
+      if (spec.tests) {
+        for (const test of spec.tests) {
+          if (test.results) {
+            for (const result of test.results) {
+              duration += result.duration || 0;
+            }
+          }
+        }
+      }
+    }
+  }
+  if (suite.suites) {
+    for (const subSuite of suite.suites) {
+      duration += getSuiteDuration(subSuite);
+    }
+  }
+  return duration;
+}
+
+/**
+ * Process a test suite recursively
+ * @param {object} suite
+ * @param {array} xrayTests
+ * @param {object} options
+ */
+function processTestSuite(suite, xrayTests, options) {
+  // Process specs in this suite
+  if (suite.specs) {
+    for (const spec of suite.specs) {
+      if (spec.tests) {
+        for (const test of spec.tests) {
+          const xrayTest = convertTest(test, spec, suite, options);
+          if (xrayTest) {
+            xrayTests.push(xrayTest);
+          }
+        }
+      }
+    }
+  }
+
+  // Process nested suites
+  if (suite.suites) {
+    for (const subSuite of suite.suites) {
+      processTestSuite(subSuite, xrayTests, options);
+    }
+  }
+}
+
+/**
+ * Convert a single Playwright test to Xray test format
+ * @param {object} test - Playwright test
+ * @param {object} spec - Playwright spec
+ * @param {object} suite - Playwright suite
+ * @param {object} options
+ * @returns {object|null}
+ */
+function convertTest(test, spec, suite, options) {
+  if (!test.results || test.results.length === 0) {
+    return null;
+  }
+
+  // Get the last result (retries)
+  const result = test.results[test.results.length - 1];
+
+  // Extract Xray test key from annotations or title
+  const testKey = extractTestKey(spec.title, test.annotations);
+
+  // Map Playwright status to Xray status
+  const status = mapStatus(result.status);
+
+  const xrayTest = {
+    status,
+    comment: buildComment(result, spec, suite),
+  };
+
+  // Add testKey if found, otherwise use testInfo for test creation
+  if (testKey) {
+    xrayTest.testKey = testKey;
+  } else {
+    // Create test info for new test creation
+    xrayTest.testInfo = {
+      summary: spec.title,
+      type: "Generic",
+      projectKey: options.projectKey,
+    };
+    
+    // Add file path as label if available
+    if (spec.file) {
+      xrayTest.testInfo.labels = [extractFileName(spec.file)];
+    }
+  }
+
+  // Add duration if available (convert to seconds for Xray)
+  if (result.duration) {
+    xrayTest.duration = Math.round(result.duration);
+  }
+
+  // Add start/finish times if available
+  if (result.startTime) {
+    xrayTest.start = new Date(result.startTime).toISOString();
+  }
+  if (result.startTime && result.duration) {
+    xrayTest.finish = new Date(result.startTime + result.duration).toISOString();
+  }
+
+  // Add error details if test failed
+  if (result.error) {
+    xrayTest.comment += `\n\nError: ${result.error.message || ''}`;
+    if (result.error.stack) {
+      xrayTest.comment += `\n\nStack trace:\n${result.error.stack}`;
+    }
+  }
+
+  // Add evidence/attachments if available
+  if (result.attachments && result.attachments.length > 0) {
+    xrayTest.evidence = result.attachments.map(attachment => ({
+      filename: attachment.name || 'attachment',
+      contentType: attachment.contentType || 'application/octet-stream',
+      // Note: Xray expects base64 data or URL - Playwright attachments need to be read separately
+      data: attachment.body ? attachment.body.toString('base64') : null
+    })).filter(e => e.data); // Only include attachments with data
+    
+    // Add attachment info to comment
+    if (xrayTest.evidence.length > 0) {
+      xrayTest.comment += `\n\nAttachments: ${result.attachments.map(a => a.name).join(', ')}`;
+    }
+  }
+
+  return xrayTest;
+}
+
+/**
+ * Extract Xray test key from title or annotations
+ * @param {string} title
+ * @param {array} annotations
+ * @returns {string|null}
+ */
+function extractTestKey(title, annotations) {
+  // Check annotations first
+  if (annotations) {
+    for (const annotation of annotations) {
+      if (annotation.type === 'xray' && annotation.description) {
+        return annotation.description;
+      }
+      if (annotation.type === 'test-id' && annotation.description) {
+        return annotation.description;
+      }
+    }
+  }
+
+  // Check title for [PROJ-123] format
+  const match = title.match(/\[([\w]+-\d+)\]/);
+  if (match) {
+    return match[1];
+  }
+
+  return null;
+}
+
+/**
+ * Map Playwright status to Xray status
+ * @param {string} playwrightStatus
+ * @returns {string}
+ */
+function mapStatus(playwrightStatus) {
+  const statusMap = {
+    passed: 'PASSED',
+    failed: 'FAILED',
+    timedOut: 'FAILED',
+    interrupted: 'ABORTED',
+    skipped: 'TODO',
+  };
+
+  return statusMap[playwrightStatus] || 'TODO';
+}
+
+/**
+ * Build comment text for test result
+ * @param {object} result
+ * @param {object} spec
+ * @param {object} suite
+ * @returns {string}
+ */
+function buildComment(result, spec, suite) {
+  const parts = [];
+
+  if (suite.title) {
+    parts.push(`Suite: ${suite.title}`);
+  }
+
+  parts.push(`Test: ${spec.title}`);
+
+  if (spec.file) {
+    parts.push(`File: ${extractFileName(spec.file)}`);
+  }
+
+  if (result.retry > 0) {
+    parts.push(`Retry: ${result.retry}`);
+  }
+
+  if (result.workerIndex !== undefined) {
+    parts.push(`Worker: ${result.workerIndex}`);
+  }
+
+  return parts.join('\n');
+}
+
+/**
+ * Extract filename from full path
+ * @param {string} filePath
+ * @returns {string}
+ */
+function extractFileName(filePath) {
+  return filePath.split(/[/\\]/).pop() || filePath;
+}

package/lib/postmanGenerator.js

@@ -216,8 +216,7 @@ function inferEndpoint(step) {
 
 /**
  * Build Postman test script lines from an expected result.
- */SCAFFOLD: Expected - ${step.expected_result}`,
-    `// SCAFFOLD: Enhance this assertion based on actual API behavior
+ */
 function buildTestScript(step) {
   const lines = [
     `// Expected: ${step.expected_result}`,

package/lib/xrayClient.js

@@ -329,7 +329,7 @@ export async function linkMultiple(cfg, testKeys, containerKey) {
   return { linked, failed };
 }
 
-// ─── Xray import endpoint ──────────────────────────────────────────────────────
+// ─── Xray import endpoints ─────────────────────────────────────────────────────
 
 /**
  * Import JUnit/XUnit XML results into Xray Cloud.
@@ -359,6 +359,29 @@ export async function importResults(cfg, xrayToken, xmlBuffer, testExecKey) {
   return response.data;
 }
 
+/**
+ * Import test results using Xray's native JSON format.
+ * This format supports detailed test information including custom fields and evidence.
+ *
+ * @param {object} cfg
+ * @param {string} xrayToken JWT
+ * @param {object} xrayJson  Xray JSON format object
+ * @returns {Promise<object>}
+ */
+export async function importResultsXrayJson(cfg, xrayToken, xrayJson) {
+  const url = "https://xray.cloud.getxray.app/api/v2/import/execution";
+
+  const response = await axios.post(url, xrayJson, {
+    httpsAgent,
+    headers: {
+      Authorization: `Bearer ${xrayToken}`,
+      "Content-Type": "application/json",
+    },
+  });
+
+  return response.data;
+}
+
 // ─── Retry wrapper ─────────────────────────────────────────────────────────────
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@msalaam/xray-qe-toolkit",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Full QE workflow toolkit for Xray Cloud integration — test management, Postman generation, CI pipeline scaffolding, and browser-based review gates for API regression projects.",
   "type": "module",
   "bin": {