qa-skills 3.0.0 → 3.1.0

package/skills/qa-qase-integration/references/api-reference.md

@@ -1,354 +0,0 @@
-# Qase.io REST API Reference
-
-Base URL: `https://api.qase.io/v1`
-
-Authentication: `Token: {QASE_API_TOKEN}` (header)
-
-## Projects
-
-### GET /project
-
-List all projects.
-
-**Query params:** `limit` (1–100, default 10), `offset` (default 0)
-
-**Response 200:**
-```json
-{
-  "status": true,
-  "result": {
-    "total": 5,
-    "filtered": 5,
-    "count": 5,
-    "entities": [
-      {
-        "title": "My Project",
-        "code": "MP",
-        "counts": {
-          "cases": 42,
-          "suites": 3,
-          "milestones": 2,
-          "runs": { "total": 10, "active": 1 },
-          "defects": { "total": 5, "open": 2 }
-        }
-      }
-    ]
-  }
-}
-```
-
-### POST /project
-
-Create a new project.
-
-**Request body:**
-```json
-{
-  "title": "My Project",
-  "code": "MP",
-  "description": "Optional description"
-}
-```
-
-**Response 200:**
-```json
-{
-  "status": true,
-  "result": {
-    "id": 1,
-    "code": "MP"
-  }
-}
-```
-
----
-
-## Test Suites
-
-### GET /suite/{code}
-
-List test suites. `{code}` = project code.
-
-**Query params:** `limit`, `offset`, `search`
-
-**Response 200:**
-```json
-{
-  "status": true,
-  "result": {
-    "total": 3,
-    "entities": [
-      {
-        "id": 1,
-        "title": "Login",
-        "description": "Login flow tests",
-        "parent_id": null
-      }
-    ]
-  }
-}
-```
-
-### POST /suite/{code}
-
-Create a test suite.
-
-**Request body:**
-```json
-{
-  "title": "Login",
-  "description": "Login flow tests",
-  "parent_id": null
-}
-```
-
-**Response 200:**
-```json
-{
-  "status": true,
-  "result": {
-    "id": 1
-  }
-}
-```
-
----
-
-## Test Cases
-
-### GET /case/{code}
-
-List test cases. `{code}` = project code.
-
-**Query params:** `limit`, `offset`, `suite_id`, `search`, `milestone_id`, `severity`, `priority`, `type`, `automation`
-
-**Response 200:**
-```json
-{
-  "status": true,
-  "result": {
-    "total": 42,
-    "entities": [
-      {
-        "id": 1,
-        "title": "Valid login",
-        "description": "User can login with valid credentials",
-        "preconditions": "User is on login page",
-        "postconditions": null,
-        "severity": 2,
-        "priority": 2,
-        "type": 1,
-        "automation": 1,
-        "suite_id": 1,
-        "steps": [
-          {
-            "action": "Enter valid email and password",
-            "expected_result": "User is logged in"
-          }
-        ]
-      }
-    ]
-  }
-}
-```
-
-### POST /case/{code}
-
-Create a test case.
-
-**Request body:**
-```json
-{
-  "title": "Valid login",
-  "description": "User can login with valid credentials",
-  "preconditions": "User is on login page",
-  "postconditions": null,
-  "severity": 2,
-  "priority": 2,
-  "type": 1,
-  "automation": 1,
-  "suite_id": 1,
-  "steps": [
-    {
-      "action": "Enter valid email and password",
-      "expected_result": "User is logged in"
-    }
-  ],
-  "tags": ["login", "smoke"]
-}
-```
-
-**Response 200:**
-```json
-{
-  "status": true,
-  "result": {
-    "id": 1
-  }
-}
-```
-
-### PATCH /case/{code}/{id}
-
-Update a test case. `{id}` = case ID.
-
----
-
-## Test Runs
-
-### GET /run/{code}
-
-List test runs. `{code}` = project code.
-
-**Query params:** `limit`, `offset`, `status`, `milestone_id`, `environment_id`
-
-**Response 200:**
-```json
-{
-  "status": true,
-  "result": {
-    "total": 10,
-    "entities": [
-      {
-        "id": 1,
-        "title": "Regression Run 2024-01-15",
-        "status": "active",
-        "is_autotest": true
-      }
-    ]
-  }
-}
-```
-
-### POST /run/{code}
-
-Create a test run.
-
-**Request body:**
-```json
-{
-  "title": "Regression Run 2024-01-15",
-  "description": "Full regression",
-  "include_all_cases": false,
-  "cases": [1, 2, 3],
-  "is_autotest": true,
-  "environment_id": 1,
-  "milestone_id": 1,
-  "tags": ["regression", "ci"]
-}
-```
-
-**Response 200:**
-```json
-{
-  "status": true,
-  "result": {
-    "id": 1
-  }
-}
-```
-
----
-
-## Test Results
-
-### POST /result/{code}/{id}
-
-Create a test result. `{code}` = project code, `{id}` = run ID.
-
-**Request body:**
-```json
-{
-  "case_id": 1,
-  "status": "passed",
-  "time_ms": 1500,
-  "comment": "Optional comment",
-  "stacktrace": "Optional stack trace for failures",
-  "defect": false,
-  "attachments": []
-}
-```
-
-**Status values:** `passed`, `failed`, `blocked`, `skipped`, `invalid` (+ custom)
-
-**Alternative (create case on-the-fly):**
-```json
-{
-  "case": {
-    "title": "New test case title",
-    "suite_title": "Suite Name",
-    "description": "Description",
-    "preconditions": "Preconditions",
-    "severity": "major",
-    "priority": "high"
-  },
-  "status": "failed",
-  "comment": "Assertion failed",
-  "stacktrace": "Error: expected..."
-}
-```
-
-**Response 200:**
-```json
-{
-  "status": true,
-  "result": {
-    "case_id": 1,
-    "hash": "abc123"
-  }
-}
-```
-
-### POST /result/{code}/{id}/bulk
-
-Bulk create results. Same structure with array of result objects.
-
----
-
-## Defects
-
-### GET /defect/{code}
-
-List defects. `{code}` = project code.
-
-**Query params:** `limit`, `offset`, `status`, `milestone_id`
-
-### POST /defect/{code}
-
-Create a defect.
-
-**Request body:**
-```json
-{
-  "title": "Login fails with special characters",
-  "actual_result": "Error 500",
-  "severity": 2,
-  "priority": 2,
-  "description": "When password contains @#$...",
-  "steps": ["Step 1", "Step 2"],
-  "attachments": []
-}
-```
-
-**Response 200:**
-```json
-{
-  "status": true,
-  "result": {
-    "id": 1
-  }
-}
-```
-
----
-
-## Error Codes
-
-| Code | Meaning |
-| ---- | ------- |
-| 400 | Bad Request |
-| 401 | Unauthorized (invalid/missing token) |
-| 403 | Forbidden (insufficient permissions) |
-| 404 | Not Found |
-| 422 | Unprocessable Entity (validation errors) |
-| 429 | Too Many Requests (rate limit; check Retry-After) |

package/skills/qa-qase-integration/references/ci-integration.md

@@ -1,196 +0,0 @@
-# CI/CD Integration with Qase.io
-
-## Overview
-
-Push test execution results from CI/CD pipelines to Qase.io. Two main approaches:
-
-1. **qase-api reporter** — Native reporter that sends results directly to Qase during test execution
-2. **JUnit XML → Qase** — Parse JUnit XML artifacts and push via REST API (e.g., in a separate job)
-
-## Option 1: qase-api Reporter
-
-### Supported Frameworks
-
-- **Jest** — `@qase/jest`
-- **Playwright** — `@qase/playwright`
-- **Cypress** — `@qase/cypress`
-- **Pytest** — `qase-pytest`
-- **Mocha** — `@qase/mocha`
-- **PHPUnit** — `qase-phpunit`
-
-### Configuration
-
-Set environment variables:
-
-```bash
-QASE_API_TOKEN=your_api_token
-QASE_PROJECT_CODE=MP
-QASE_RUN_ID=123   # Optional: append to existing run
-QASE_RUN_NAME="CI Run $(date +%Y-%m-%d)"
-```
-
-### Jest Example
-
-```javascript
-// jest.config.js
-module.exports = {
-  reporters: [
-    'default',
-    ['@qase/jest', {
-      apiToken: process.env.QASE_API_TOKEN,
-      projectCode: process.env.QASE_PROJECT_CODE,
-      runId: process.env.QASE_RUN_ID,
-      runName: process.env.QASE_RUN_NAME,
-      logging: true
-    }]
-  ]
-};
-```
-
-### Playwright Example
-
-```typescript
-// playwright.config.ts
-import { defineConfig } from '@playwright/test';
-
-export default defineConfig({
-  reporter: [
-    ['html'],
-    ['@qase/playwright', {
-      apiToken: process.env.QASE_API_TOKEN,
-      projectCode: process.env.QASE_PROJECT_CODE,
-      runId: process.env.QASE_RUN_ID,
-      runName: process.env.QASE_RUN_NAME
-    }]
-  ]
-});
-```
-
-### Pytest Example
-
-```python
-# pytest.ini or pyproject.toml
-[pytest]
-addopts = -v --qase --qase-api-token=${QASE_API_TOKEN} --qase-project=${QASE_PROJECT_CODE} --qase-run-id=${QASE_RUN_ID}
-```
-
-Or in `conftest.py`:
-
-```python
-def pytest_configure(config):
-    config.addinivalue_line("addopts", "--qase")
-    config.addinivalue_line("addopts", f"--qase-api-token={os.environ.get('QASE_API_TOKEN')}")
-    config.addinivalue_line("addopts", f"--qase-project={os.environ.get('QASE_PROJECT_CODE')}")
-```
-
-### Case ID Mapping
-
-Reporters map test names to Qase cases. Options:
-
-- **Case ID in test name** — e.g., `C1` or `C123` prefix
-- **Decorator/annotation** — `@qase.id(123)` or `@qase.id("C123")`
-- **Title matching** — Match by test title (less reliable)
-
----
-
-## Option 2: GitHub Actions + JUnit XML
-
-Push JUnit XML results to Qase.io in a separate step.
-
-### Workflow Example
-
-```yaml
-name: Tests + Qase Sync
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Setup Node
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Run tests
-        run: npm test -- --ci --reporters=default --reporters=jest-junit
-        env:
-          JEST_JUNIT_OUTPUT_DIR: ./test-results
-
-      - name: Upload JUnit results
-        uses: actions/upload-artifact@v4
-        with:
-          name: junit-results
-          path: test-results/
-
-  qase-push:
-    needs: test
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Download JUnit results
-        uses: actions/download-artifact@v4
-        with:
-          name: junit-results
-
-      - name: Push to Qase.io
-        uses: qase-io/qase-report-action@v1
-        with:
-          api-token: ${{ secrets.QASE_API_TOKEN }}
-          project-code: ${{ vars.QASE_PROJECT_CODE }}
-          results-path: ./
-          run-name: "CI Run ${{ github.run_number }}"
-          run-complete: true
-```
-
-### Alternative: Custom Script
-
-If no ready-made action fits, use a script that:
-
-1. Parses JUnit XML
-2. Creates a run via `POST /run/{code}`
-3. Maps each `<testcase>` to a Qase case (by title or external ID)
-4. Posts results via `POST /result/{code}/{run_id}` or bulk endpoint
-
-```bash
-# Example: using qase-api CLI or custom Node/Python script
-npx qase-api push-results \
-  --token $QASE_API_TOKEN \
-  --project $QASE_PROJECT_CODE \
-  --results ./test-results/junit.xml \
-  --run-name "CI Run"
-```
-
----
-
-## Environment Variables
-
-| Variable | Required | Description |
-| -------- | -------- | ----------- |
-| `QASE_API_TOKEN` | Yes | API token from app.qase.io/user/api/token |
-| `QASE_PROJECT_CODE` | Yes | Project code (2–10 chars) |
-| `QASE_RUN_ID` | No | Append to existing run |
-| `QASE_RUN_NAME` | No | Name for new run |
-| `QASE_ENVIRONMENT_ID` | No | Environment for the run |
-
----
-
-## Best Practices
-
-1. **Secrets** — Store `QASE_API_TOKEN` in GitHub Secrets (or equivalent); never in code
-2. **Run naming** — Include build ID, branch, or date for traceability
-3. **Case mapping** — Use consistent test naming or `@qase.id()` for reliable mapping
-4. **Bulk results** — Use `POST /result/{code}/{id}/bulk` for large result sets
-5. **Run completion** — Call run complete endpoint when all results are posted
-6. **Retries** — Handle 429; implement exponential backoff for rate limits

package/skills/qa-qase-integration/references/field-mapping.md

@@ -1,157 +0,0 @@
-# Field Mapping: Local QA Skills ↔ Qase.io
-
-## Test Case Fields
-
-| Local (QA Skills) | Qase.io Field | Notes |
-| ----------------- | ------------- | ----- |
-| ID | — | Local identifier; use for traceability; Qase assigns its own `id` |
-| Title | `title` | Required; max 255 chars |
-| Description | `description` | Free text |
-| Module / Component | `suite_id` or `suite_title` | Map to Qase suite |
-| Preconditions | `preconditions` | Free text |
-| Steps (Action \| Expected) | `steps[].action`, `steps[].expected_result` | See steps format below |
-| Postconditions | `postconditions` | Free text |
-| Test Data | `steps[].data` or in description | Optional |
-| Traceability (Req ID) | `tags` or custom field | e.g., tag `req:REQ-FN-001` |
-| Priority | `priority` | See Priority enum |
-| Severity | `severity` | See Severity enum |
-| Type | `type` | See Type enum |
-| Automation status | `automation` | See Automation enum |
-
-## Steps Format
-
-**Local (QA Skills):**
-```
-| Step# | Action | Expected Result |
-| 1 | Enter valid email | Email accepted |
-| 2 | Enter valid password | Password accepted |
-| 3 | Click Login | User is logged in |
-```
-
-**Qase.io:**
-```json
-{
-  "steps": [
-    {
-      "action": "Enter valid email",
-      "expected_result": "Email accepted"
-    },
-    {
-      "action": "Enter valid password",
-      "expected_result": "Password accepted"
-    },
-    {
-      "action": "Click Login",
-      "expected_result": "User is logged in"
-    }
-  ]
-}
-```
-
-## Priority Enum
-
-| Local | Qase.io (integer) | Qase.io (slug) |
-| ----- | ----------------- | -------------- |
-| Critical / P1 | 1 | `critical` |
-| High / P2 | 2 | `high` |
-| Medium / P3 | 3 | `medium` |
-| Low / P4 | 4 | `low` |
-| Not set | 5 | `not_set` |
-
-## Severity Enum
-
-| Local | Qase.io (integer) | Qase.io (slug) |
-| ----- | ----------------- | -------------- |
-| Blocker | 1 | `blocker` |
-| Critical | 2 | `critical` |
-| Major | 3 | `major` |
-| Minor | 4 | `minor` |
-| Trivial | 5 | `trivial` |
-| Not set | 6 | `not_set` |
-
-## Type Enum
-
-| Local | Qase.io (integer) |
-| ----- | ----------------- |
-| functional | 1 |
-| smoke | 2 |
-| regression | 3 |
-| security | 4 |
-| usability | 5 |
-| performance | 6 |
-| other | 7 |
-
-## Automation Enum
-
-| Local | Qase.io (integer) |
-| ----- | ----------------- |
-| Manual / Not automated | 0 |
-| Automated | 1 |
-| To be automated | 2 |
-
-## Test Result Status
-
-| JUnit / Source | Qase.io `status` |
-| -------------- | ---------------- |
-| passed / success | `passed` |
-| failed / failure | `failed` |
-| skipped | `skipped` |
-| error / blocked | `blocked` |
-| (invalid) | `invalid` |
-
-## Local Test Case JSON Example
-
-```json
-{
-  "id": "TC-LOGIN-001",
-  "title": "Valid login",
-  "module": "Auth",
-  "priority": "High",
-  "severity": "Major",
-  "type": "functional",
-  "automation": "Planned",
-  "preconditions": "User is on login page",
-  "steps": [
-    { "action": "Enter valid email", "expected": "Email accepted" },
-    { "action": "Enter valid password", "expected": "Password accepted" },
-    { "action": "Click Login", "expected": "User is logged in" }
-  ],
-  "traceability": ["REQ-FN-001"]
-}
-```
-
-## Mapped Qase.io Payload
-
-```json
-{
-  "title": "Valid login",
-  "description": "",
-  "preconditions": "User is on login page",
-  "suite_id": 1,
-  "priority": 2,
-  "severity": 3,
-  "type": 1,
-  "automation": 2,
-  "tags": ["req:REQ-FN-001", "Auth"],
-  "steps": [
-    { "action": "Enter valid email", "expected_result": "Email accepted" },
-    { "action": "Enter valid password", "expected_result": "Password accepted" },
-    { "action": "Click Login", "expected_result": "User is logged in" }
-  ]
-}
-```
-
-## Custom Fields
-
-Qase.io supports custom fields. Map local fields to `custom_field` object:
-
-```json
-{
-  "custom_field": {
-    "1": "REQ-FN-001",
-    "2": "2024-Q1"
-  }
-}
-```
-
-Field IDs come from Qase project settings. Configure mapping per project.