@msalaam/xray-qe-toolkit 1.3.3 → 1.3.4

package/commands/genPipeline.js

@@ -2,7 +2,7 @@
  * Command: xray-qe gen-pipeline [--output <path>]
  *
  * Copies the Azure Pipelines YAML template into the consuming project.
- * The template runs Newman and imports results — no QE logic in CI.
+ * The template runs Playwright and imports JSON results — no QE logic in CI.
  */
 
 import fs from "node:fs";
@@ -34,8 +34,11 @@ export default async function genPipeline(opts = {}) {
   console.log("   1. Set pipeline variables in Azure DevOps:");
   console.log("      XRAY_ID, XRAY_SECRET, JIRA_PROJECT_KEY, JIRA_URL,");
   console.log("      JIRA_API_TOKEN, JIRA_EMAIL, TEST_EXEC_KEY");
-  console.log("   2. Commit the generated file to your repo");
-  console.log("   3. Create a pipeline in Azure DevOps pointing to this YAML");
+  console.log("   2. Optionally set API_BASE_URL for Playwright tests");
+  console.log("   3. Commit the generated file to your repo");
+  console.log("   4. Create a pipeline in Azure DevOps pointing to this YAML");
+  console.log("   5. Playwright tests must have xray annotations to map results:");
+  console.log("      test.info().annotations.push({ type: 'xray', description: 'PROJ-123' })");
   console.log("");
   console.log("⚠️  Remember: edit-json and QE review gates are NOT part of CI.");
   console.log("   Run those steps locally before committing.\n");

package/commands/init.js

@@ -114,7 +114,7 @@ export default async function init(opts = {}) {
     const xrayrc = {
       testsPath: "tests.json",
       mappingPath: "xray-mapping.json",
-      collectionPath: "collection.postman.json",
+      playwrightResultsPath: "playwright-results.json",
       knowledgePath: "knowledge",
       playwrightDir: "playwright-tests",
     };
@@ -136,7 +136,7 @@ export default async function init(opts = {}) {
   console.log("   4. Generate test cases: npx xray-qe gen-tests --ai (or edit tests.json manually)");
   console.log("   5. Review tests: npx xray-qe edit-json");
   console.log("   6. Push tests to Xray: npx xray-qe push-tests");
-  console.log("   7. Generate Postman collection: npx xray-qe gen-postman --ai");
-  console.log("   8. Generate CI pipeline: npx xray-qe gen-pipeline");
+  console.log("   7. Generate CI pipeline: npx xqt gen-pipeline");
+  console.log("   8. Run Playwright tests and import results: npx xqt import-results --file playwright-results.json");
   console.log("");
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@msalaam/xray-qe-toolkit",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "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": {

package/templates/README.template.md

@@ -63,13 +63,7 @@ npx xqt edit-json
 npx xqt push-tests
 ```
 
-### 5. Generate Postman Collection
-
-```bash
-npx xqt gen-postman
-```
-
-### 6. Set Up CI Pipeline
+### 5. Set Up CI Pipeline
 
 ```bash
 # Generate Azure Pipelines template
@@ -84,10 +78,9 @@ npx xqt gen-pipeline
 | `npx xqt gen-tests` | Generate test cases from knowledge/ |
 | `npx xqt edit-json` | Review/edit tests in browser |
 | `npx xqt push-tests` | Push tests to Xray Cloud |
-| `npx xqt gen-postman` | Generate Postman collection |
 | `npx xqt gen-pipeline` | Generate CI pipeline template |
 | `npx xqt create-execution` | Create Test Execution issue |
-| `npx xqt import-results` | Import test results (CI) |
+| `npx xqt import-results` | Import Playwright JSON results (CI) |
 
 Run any command with `--help` for details:
 ```bash
@@ -101,8 +94,9 @@ npx xqt gen-tests --help
 2. Generate tests (AI or manual)
 3. Review in edit-json
 4. Push to Xray
-5. Generate Postman collection
-6. Run in CI (newman + import-results)
+5. Generate CI pipeline: npx xqt gen-pipeline
+6. Run Playwright tests in CI
+7. Import results: npx xqt import-results --file playwright-results.json
 ```
 
 ## Files
@@ -111,7 +105,7 @@ npx xqt gen-tests --help
 |------|---------|
 | `tests.json` | Test definitions (source of truth) |
 | `xray-mapping.json` | Maps test IDs to JIRA keys |
-| `collection.postman.json` | Generated Postman collection |
+| `playwright-results.json` | Playwright JSON report (CI output) |
 | `.env` | Credentials (DO NOT COMMIT) |
 | `.xrayrc` | Project config |
 | `knowledge/` | API specs and requirements |

package/templates/azure-pipelines.yml

@@ -3,8 +3,8 @@
 # Generated by @msalaam/xray-qe-toolkit
 # ──────────────────────────────────────────────────────────────
 #
-# This pipeline runs Newman against the generated Postman collection
-# and imports results into Xray Cloud.
+# This pipeline runs Playwright tests and imports the JSON results
+# into Xray Cloud via xqt import-results.
 #
 # IMPORTANT: edit-json and QE review gates are NOT part of CI.
 # Those steps must be run locally before committing.
@@ -12,6 +12,9 @@
 # Required pipeline variables (set in Azure DevOps UI → Variables):
 #   XRAY_ID, XRAY_SECRET, JIRA_PROJECT_KEY, JIRA_URL,
 #   JIRA_API_TOKEN, JIRA_EMAIL, TEST_EXEC_KEY
+#
+# Optional pipeline variables:
+#   API_BASE_URL  — base URL passed to Playwright tests
 # ──────────────────────────────────────────────────────────────
 
 trigger:
@@ -24,7 +27,7 @@ pool:
   vmImage: "ubuntu-latest"
 
 variables:
-  NODE_VERSION: "18.x"
+  NODE_VERSION: "20.x"
 
 steps:
   - task: NodeTool@0
@@ -37,17 +40,24 @@ steps:
     displayName: "Install dependencies"
 
   - script: |
-      npx newman run collection.postman.json \
-        --reporters cli,junit \
-        --reporter-junit-export results.xml \
-        --suppress-exit-code
-    displayName: "Run Newman tests"
+      npx playwright install --with-deps chromium
+    displayName: "Install Playwright browsers"
+
+  - script: |
+      npx playwright test \
+        --reporter=list,json \
+        --output=playwright-results
+    displayName: "Run Playwright tests"
+    continueOnError: true
+    env:
+      PLAYWRIGHT_JSON_OUTPUT_NAME: playwright-results.json
+      API_BASE_URL: $(API_BASE_URL)
 
   - script: |
       npx xqt import-results \
-        --file results.xml \
+        --file playwright-results.json \
         --testExecKey $(TEST_EXEC_KEY)
-    displayName: "Import results to Xray"
+    displayName: "Import Playwright results to Xray"
     env:
       XRAY_ID: $(XRAY_ID)
       XRAY_SECRET: $(XRAY_SECRET)
@@ -57,9 +67,18 @@ steps:
       JIRA_EMAIL: $(JIRA_EMAIL)
 
   - task: PublishTestResults@2
-    displayName: "Publish JUnit results"
+    displayName: "Publish Playwright JUnit results"
+    condition: always()
     inputs:
       testResultsFormat: "JUnit"
-      testResultsFiles: "results.xml"
+      testResultsFiles: "playwright-results/results.xml"
       mergeTestResults: true
       failTaskOnFailedTests: true
+
+  - task: PublishPipelineArtifact@1
+    displayName: "Upload Playwright HTML report"
+    condition: always()
+    inputs:
+      targetPath: "playwright-report"
+      artifact: "playwright-report"
+      publishLocation: "pipeline"