@msalaam/xray-qe-toolkit 1.3.4 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/.env.example +23 -9
  2. package/README.md +721 -1322
  3. package/bin/cli.js +97 -51
  4. package/commands/createExecution.js +112 -23
  5. package/commands/createPlan.js +121 -0
  6. package/commands/editJson.js +1 -1
  7. package/commands/genPipeline.js +1 -1
  8. package/commands/genTests.js +18 -18
  9. package/commands/importResults.js +107 -74
  10. package/commands/init.js +258 -70
  11. package/commands/pullTests.js +128 -0
  12. package/commands/pushTests.js +87 -43
  13. package/commands/status.js +108 -0
  14. package/commands/syncFolders.js +62 -0
  15. package/commands/validate.js +136 -0
  16. package/lib/config.js +50 -13
  17. package/lib/index.js +43 -4
  18. package/lib/playwrightConverter.js +91 -173
  19. package/lib/testCaseBuilder.js +116 -55
  20. package/lib/xrayClient.js +779 -202
  21. package/package.json +5 -4
  22. package/schema/business-rules.schema.json +110 -0
  23. package/schema/tests.schema.json +42 -16
  24. package/templates/README.template.md +570 -158
  25. package/templates/SPEC-DRIVEN-APPROACH.md +372 -0
  26. package/templates/azure-pipelines.yml +129 -77
  27. package/templates/business-rules.yaml +83 -0
  28. package/templates/resources-README.md +112 -0
  29. package/templates/tests.json +69 -51
  30. package/commands/genPostman.js +0 -70
  31. package/lib/postmanGenerator.js +0 -304
  32. package/templates/knowledge-README.md +0 -121
package/.env.example CHANGED
@@ -1,16 +1,30 @@
1
- # Xray Cloud API Credentials
2
- # Get your credentials from: https://xray.cloud.getxray.app/api/v2
1
+ # ─── Xray Cloud API Credentials ──────────────────────────────────────────────
2
+ # Generate at: https://xray.cloud.getxray.app → Settings → API Keys
3
3
  XRAY_ID=your_client_id_here
4
4
  XRAY_SECRET=your_client_secret_here
5
5
 
6
- # Optional: Region-specific GraphQL endpoint (default: US)
7
- # EU: https://xray.cloud.getxray.app/api/v2/graphql
8
- # US: https://api.xray.cloud.getxray.app/api/v2/graphql (default)
9
- # XRAY_GRAPHQL_URL=https://api.xray.cloud.getxray.app/api/v2/graphql
6
+ # ─── Xray Region ──────────────────────────────────────────────────────────────
7
+ # "us" (default) or "eu" — determines GraphQL / REST / Auth endpoint URLs
8
+ # Can also be set in .xrayrc as xrayRegion
9
+ # XRAY_REGION=us
10
10
 
11
- # Optional: Default project key if not specified via CLI
12
- # PROJECT_KEY=APIEE
11
+ # ─── Xray Endpoint Overrides (optional) ───────────────────────────────────────
12
+ # Only set these if you need to override the region-derived defaults
13
+ # XRAY_GRAPHQL_URL=https://api.xray.cloud.getxray.app/api/v2/graphql
14
+ # XRAY_REST_URL=https://xray.cloud.getxray.app/api/v2
15
+ # XRAY_AUTH_URL=https://xray.cloud.getxray.app/api/v2/authenticate
13
16
 
17
+ # ─── JIRA Credentials ─────────────────────────────────────────────────────────
18
+ JIRA_URL=https://oldmutual.atlassian.net
14
19
  JIRA_EMAIL=your.email@oldmutual.com
15
20
  JIRA_API_TOKEN=your_jira_api_token_here
16
- JIRA_URL=https://oldmutual.atlassian.net/
21
+
22
+ # ─── Project ──────────────────────────────────────────────────────────────────
23
+ JIRA_PROJECT_KEY=APIEE
24
+
25
+ # ─── XQT Defaults (optional — can also be set in .xrayrc) ────────────────────
26
+ # Test Plan key to associate pushes and results with
27
+ # XQT_TEST_PLAN_KEY=APIEE-1234
28
+
29
+ # Default environment label used by import-results and create-execution
30
+ # XQT_DEFAULT_ENV=IOP-DEV