assuremind 1.2.3 → 1.4.0

package/docs/STUDIO.md

@@ -48,7 +48,7 @@ The sidebar on the left has these pages:
 | 📋 | Reports | Browse historical run results |
 | 🔧 | Variables | Manage test variables and secrets |
 | 🩺 | Self-Healing | Review and apply AI-generated selector fixes |
-| ⚙️ | Settings | Environment, browsers, healing, capture settings, MCP integration |
+| ⚙️ | Settings | Environment, browsers, healing, capture settings, MCP integration, CI/CD integration |
 | 🌿 | Git Control Center | Branch management, AI commits, push/pull, conflict resolution |
 
 ---
@@ -74,6 +74,8 @@ While data is loading, animated skeleton cards are shown so the layout never jum
 
 ## Test Editor
 
+> **Writing steps:** for a full catalog of plain-English step phrasings (UI **and** API) with examples, see [WRITING-STEPS.md](WRITING-STEPS.md).
+
 ### Suite Types
 
 Assuremind supports three suite types:
@@ -466,6 +468,19 @@ The **Device Emulation** card appears below the Browsers card. It lets you emula
 
 **Equivalent CLI flag:** `--device "iPhone 15 Pro"`
 
+### CI Config Generator
+
+Click **Generate CI Config** to produce a pipeline file from your current run settings (browsers, parallel workers, device). Pick a platform tab — **GitHub Actions**, **GitLab CI**, or **Jenkins**.
+
+- The YAML opens in a **preview** (read-only). Click **✎ Edit** to customise it — change branches, Node version, add steps, env vars, etc. Your edits apply to **Copy**, **Download**, and **Write to repo**. **↺ Reset** discards edits and regenerates from the run config.
+- **Copy** and **Download** are always available.
+- **Write to repo** writes the file into your project at its standard path:
+  - GitHub Actions → `.github/workflows/assuremind.yml`
+  - GitLab CI → `.gitlab-ci.yml`
+  - Jenkins → `Jenkinsfile`
+
+  This button only appears when **Settings → CI/CD Integration → "Write CI files to repo"** is enabled (off by default). It **only writes the file** — it does **not** commit or push. Review the change and commit it from the **Git Control Center** when you're ready.
+
 ---
 
 ## Reports
@@ -476,6 +491,7 @@ Browse all historical run results:
 - Click a run to see the **full result tree**: Suite → Case → Step
 - Each step shows: status, duration, generated code, and screenshot (on failure)
 - Failed steps show the error message and a screenshot thumbnail
+- A **Downloads** panel appears for runs that captured files (see [File Upload & Download](#file-upload--download)) — click a file to save it locally
 
 ### Lighthouse Results (Audit Suites)
 
@@ -700,6 +716,85 @@ The Faker Data modal (accessible from the Test Editor) lets you browse 100+ dyna
 
 ---
 
+## File Upload & Download
+
+### Uploading files (for upload steps)
+
+In the **Test Editor**, click the **Files** button (next to *Fake Data*) to open the file picker:
+
+1. Click **Choose a file to upload** and pick a file from your machine.
+2. It's saved into your project at **`fixtures/uploads/`** (committed with the repo, so it works in CI) and appears in the list.
+3. Click the file to insert a **`{{FILE:name}}`** token into your step. Delete files with the trash icon.
+
+The token resolves to the file's relative path at runtime, so it works with `setInputFiles`:
+
+| Step (plain English) | Generated code |
+|----------------------|----------------|
+| `Upload {{FILE:resume.pdf}} to the Resume field` | `await page.getByLabel('Resume').setInputFiles('{{FILE:resume.pdf}}');` |
+| `Upload {{FILE:resume.pdf}}` | `await page.locator('input[type="file"]').setInputFiles('{{FILE:resume.pdf}}');` |
+
+For a button that opens a native file chooser, keep the listener and the click in **one step**:
+
+```js
+const fileChooserPromise = page.waitForEvent('filechooser');
+await page.getByRole('button', { name: 'Choose File' }).click();
+(await fileChooserPromise).setFiles('{{FILE:resume.pdf}}');
+```
+
+Files inside an iframe still need `frameLocator(...)`, e.g.
+`await page.frameLocator('#frame').locator('input[type="file"]').setInputFiles('{{FILE:doc.pdf}}');`
+
+**Waiting for the upload to complete** — `setInputFiles` only attaches the file; there is no universal "upload done" event. The step waits for a completion signal:
+
+| Step (plain English) | Wait behavior |
+|----------------------|---------------|
+| `Upload {{FILE:resume.pdf}} to the Resume field` | waits for the network to settle (`waitForLoadState('networkidle')`) |
+| `Upload {{FILE:resume.pdf}} to the Resume field and wait for 'Upload complete'` | waits for the success text — **most reliable** |
+| `Upload {{FILE:photo.png}}` | uploads to the page's file input, then waits for network |
+
+**Example upload steps:**
+
+```text
+Upload {{FILE:resume.pdf}} to the Resume field
+Upload {{FILE:resume.pdf}} to the Resume field and wait for 'Upload complete'
+Upload {{FILE:photo.png}}
+Upload {{FILE:invoice.pdf}} into the Attachment input
+```
+
+### Downloads (auto-captured)
+
+You do **not** need any special code to handle downloads — just trigger them with a click. The step
+**waits until the file finishes downloading** (`waitForEvent('download')` → `await download.path()`),
+and the runner **automatically saves every download** to `results/downloads/<runId>/`. Avoid
+`download.saveAs()` / `fs` in steps — the sandbox blocks them and it isn't needed.
+
+**Example download steps:**
+
+```text
+Download the "Export CSV" link
+Click the "Export" button to download
+Download the file by clicking "Report PDF"
+Click "Download invoice" and wait for download
+```
+
+Each generates:
+```js
+const downloadPromise = page.waitForEvent('download');
+await page.getByRole('link', { name: 'Export CSV' }).click();
+const download = await downloadPromise;
+await download.path();   // resolves once the download is complete
+```
+
+To view and retrieve captured files:
+
+1. Go to **Reports → Run Reports** and click the run to expand it.
+2. A **Downloads** panel at the top lists every file captured during that run (name + size).
+3. Click any file to download it to your local machine.
+
+The panel only appears when the run produced downloads.
+
+---
+
 ## Visual Regression
 
 Visual regression is configured in **Settings** → Visual Regression and reviewed in **Reports** → Visual Diffs / Baselines tabs.

package/docs/WRITING-STEPS.md

@@ -0,0 +1,171 @@
+# Writing Test Steps
+
+A reference for describing test steps in plain English. Type a step in the **Test Editor** (or `assuremind generate`) and AssureMind turns it into Playwright code.
+
+Two engines handle generation:
+- **⚡ Template engine** — deterministic, zero AI cost. Handles the common phrasings below (marked ⚡).
+- **AI engine** — handles anything else, and (with **MCP** on) sees the real page to pick accurate locators.
+
+Tips that apply everywhere:
+- Put the **target name in quotes** for reliability: `Click the "Sign in" button`.
+- Insert dynamic data with the **Fake Data** picker (`{{FAKE_*}}`) and uploaded files with the **Files** picker (`{{FILE:name}}`).
+- Reference saved values with `{{VAR_NAME}}`; `{{BASE_URL}}` is your configured base URL.
+- Prefix any assertion with **"Soft"** to keep running on failure (`Soft verify …`).
+
+---
+
+## UI steps
+
+### Navigation ⚡
+```text
+Go to https://example.com
+Navigate to /dashboard
+Open https://demoqa.com/upload-download
+Go back
+Refresh the page
+```
+
+### Click — buttons, links, tabs ⚡
+Name the role so the right locator is used (`getByRole`):
+```text
+Click the "Login" button
+Click on "Submit"
+Click the "Dashboard" link
+Click the "Settings" tab
+Double click the "Row 1" element
+Right click the "File" element
+```
+> The role word should match the element's **actual ARIA role**. A control that looks like a button but is `<a role="button">` is still a button; a plain `<a href>` is a link.
+
+### Text input ⚡
+```text
+Enter "deepak" in the Username field
+Type {{FAKE_INTERNET_EMAIL}} in the Email field
+Fill "secret123" in the Password field          # password → getByLabel automatically
+Enter {{FAKE_NUMBER_INT}} in the Quantity field # number → spinbutton role
+Clear the Search field
+```
+
+### Dropdowns, checkboxes, radios ⚡
+```text
+Select "India" from the Country dropdown
+Check the "Remember me" checkbox
+Uncheck the "Subscribe" checkbox
+Select the "Male" radio button
+```
+
+### Keyboard ⚡
+```text
+Press Enter
+Press Escape
+Press Tab
+Press "Control+A"
+Type "hello" and press Enter
+```
+
+### Waits, scroll, hover, screenshot ⚡
+```text
+Wait for 2 seconds
+Wait for the page to load
+Scroll down
+Scroll to bottom
+Hover over the "Profile" menu
+Take a screenshot
+```
+
+### File upload ⚡
+Upload a file with the **Files** picker, then reference its `{{FILE:name}}` token:
+```text
+Upload {{FILE:resume.pdf}} to the Resume field
+Upload {{FILE:resume.pdf}} to the Resume field and wait for 'Upload complete'   # most reliable
+Upload {{FILE:photo.png}}                                                       # page's file input
+```
+
+### File download ⚡
+Downloads are auto-captured (Reports → Downloads, and attached to Allure). The step waits until the file finishes:
+```text
+Download the "Export CSV" link
+Click the "Download" button to download
+Download the file by clicking "Report PDF"
+Click "Download invoice" and wait for download
+```
+
+### Assertions ⚡
+```text
+Verify "Welcome back" is visible
+Verify "Error" is not visible
+Verify the page title is "Dashboard"
+Verify the URL contains "/dashboard"
+Verify the "Email" field has value "user@test.com"
+Soft verify "Saved successfully" is visible        # continues on failure
+```
+
+### Scenarios the AI handles (MCP recommended)
+```text
+Login as admin using {{ADMIN_EMAIL}} and {{DEFAULT_PASSWORD}}
+Click the "Submit" button inside the payment iframe
+Fill the card number "4111111111111111" in the Stripe iframe
+Accept the confirmation dialog after clicking "Delete"
+Verify the table has 5 rows
+Click the element inside the shadow DOM component
+```
+- **iframes** → wrapped in `page.frameLocator(...)` automatically.
+- **shadow DOM** → locator chaining (`page.locator('host').locator('inner')`).
+- **dialogs** → a `page.once('dialog', …)` handler is added before the trigger.
+
+---
+
+## API steps
+
+Mark a suite/case as **API** type. Steps use Playwright's `page.request` API. Use `{{BASE_URL}}` and saved variables.
+
+### Basic requests
+```text
+Send a GET request to {{BASE_URL}}/api/users and verify status is 200
+Send a POST request to {{BASE_URL}}/api/users with body { "name": "John", "email": "john@test.com" } and verify status 201
+Send a PUT request to {{BASE_URL}}/api/users/1 with body { "name": "Jane" }
+Send a DELETE request to {{BASE_URL}}/api/users/1 and verify status 204
+```
+
+### Auth — extract and reuse a token
+```text
+POST to {{BASE_URL}}/api/login with { "email": "{{ADMIN_EMAIL}}", "password": "{{DEFAULT_PASSWORD}}" }, save token as AUTH_TOKEN
+GET {{BASE_URL}}/api/profile with Authorization Bearer {{AUTH_TOKEN}} and verify status 200
+```
+- "save / store / extract … as NAME" → `context.setVariable('NAME', …)`.
+- `{{AUTH_TOKEN}}` (or `context.getVariable`) reuses it in later steps/cases.
+
+### Assertions on the response
+```text
+Verify the response status is 200
+Verify the response body has property "id"
+Verify the response field "name" equals "Admin"
+Verify the response has 5 users
+Verify the content-type header contains "application/json"
+Verify the response time is under 500 ms
+Soft verify the response status is 200
+```
+
+### Headers, query params, form bodies
+```text
+Send a GET request to {{BASE_URL}}/api/search with query { "q": "phone", "page": "1" }
+Send a POST to {{BASE_URL}}/api/upload with form { "name": "doc", "type": "pdf" }
+Send a GET to {{BASE_URL}}/api/data with header "X-Api-Key" "{{API_KEY}}"
+```
+
+---
+
+## Soft vs hard assertions
+- **Hard** (default): the test stops at the first failure.
+- **Soft**: prefix with **"Soft"** (`Soft verify …`) — failures are collected and the test keeps going. In the Recorder, use `Ctrl+Shift+Click` for a soft assertion.
+
+## Variables & dynamic data
+| Token | Resolves to |
+|-------|-------------|
+| `{{BASE_URL}}` | Configured base URL for the active environment |
+| `{{FAKE_PERSON_FULLNAME}}`, `{{FAKE_INTERNET_EMAIL}}`, … | Fresh random data each run (Fake Data picker) |
+| `{{FILE:resume.pdf}}` | `fixtures/uploads/resume.pdf` (Files picker) |
+| `{{MY_VAR}}` | A value from Variables or saved earlier with `context.setVariable` |
+
+## Editing generated code
+Every step's code is editable — expand the step (chevron) and edit the code block directly, or click the **✎** to change the instruction and **regenerate** (wand). Use this for anything the engines don't phrase exactly the way your app needs.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assuremind",
-  "version": "1.2.3",
+  "version": "1.4.0",
   "description": "AI-powered codeless UI & API automation framework",
   "author": "Deepak Hiremath",
   "license": "MIT",
@@ -41,12 +41,14 @@
     "ai",
     "codeless",
     "no-code",
+    "zero-code",
     "test-automation",
     "qa",
     "self-healing",
     "claude",
     "openai",
     "gemini",
+    "ollama",
     "ui-testing"
   ],
   "scripts": {
@@ -74,7 +76,7 @@
     "@google/generative-ai": "^0.21.0",
     "@modelcontextprotocol/sdk": "^1.29.0",
     "@playwright/mcp": "^0.0.70",
-    "@playwright/test": "^1.47.0",
+    "@playwright/test": "^1.60.0",
     "allure-commandline": "^2.38.1",
     "allure-js-commons": "^3.0.0",
     "allure-playwright": "^3.0.0",
@@ -97,10 +99,10 @@
     "pino": "^9.4.0",
     "pino-pretty": "^11.2.0",
     "pixelmatch": "^7.1.0",
-    "playwright": "^1.47.0",
+    "playwright": "^1.60.0",
     "pngjs": "^7.0.0",
     "simple-git": "^3.33.0",
-    "uuid": "^10.0.0",
+    "uuid": "11.1.1",
     "zod": "^3.23.0"
   },
   "devDependencies": {
@@ -113,12 +115,12 @@
     "@types/ws": "^8.5.0",
     "@typescript-eslint/eslint-plugin": "^8.8.0",
     "@typescript-eslint/parser": "^8.8.0",
-    "@vitest/coverage-v8": "^2.1.0",
+    "@vitest/coverage-v8": "3.2.6",
     "docx": "^9.6.1",
     "eslint": "^9.12.0",
     "prettier": "^3.3.0",
     "tsup": "^8.3.0",
     "typescript": "^5.6.0",
-    "vitest": "^2.1.0"
+    "vitest": "3.2.6"
   }
 }

package/templates/docs/WRITING-STEPS.md

@@ -0,0 +1,171 @@
+# Writing Test Steps
+
+A reference for describing test steps in plain English. Type a step in the **Test Editor** (or `assuremind generate`) and AssureMind turns it into Playwright code.
+
+Two engines handle generation:
+- **⚡ Template engine** — deterministic, zero AI cost. Handles the common phrasings below (marked ⚡).
+- **AI engine** — handles anything else, and (with **MCP** on) sees the real page to pick accurate locators.
+
+Tips that apply everywhere:
+- Put the **target name in quotes** for reliability: `Click the "Sign in" button`.
+- Insert dynamic data with the **Fake Data** picker (`{{FAKE_*}}`) and uploaded files with the **Files** picker (`{{FILE:name}}`).
+- Reference saved values with `{{VAR_NAME}}`; `{{BASE_URL}}` is your configured base URL.
+- Prefix any assertion with **"Soft"** to keep running on failure (`Soft verify …`).
+
+---
+
+## UI steps
+
+### Navigation ⚡
+```text
+Go to https://example.com
+Navigate to /dashboard
+Open https://demoqa.com/upload-download
+Go back
+Refresh the page
+```
+
+### Click — buttons, links, tabs ⚡
+Name the role so the right locator is used (`getByRole`):
+```text
+Click the "Login" button
+Click on "Submit"
+Click the "Dashboard" link
+Click the "Settings" tab
+Double click the "Row 1" element
+Right click the "File" element
+```
+> The role word should match the element's **actual ARIA role**. A control that looks like a button but is `<a role="button">` is still a button; a plain `<a href>` is a link.
+
+### Text input ⚡
+```text
+Enter "deepak" in the Username field
+Type {{FAKE_INTERNET_EMAIL}} in the Email field
+Fill "secret123" in the Password field          # password → getByLabel automatically
+Enter {{FAKE_NUMBER_INT}} in the Quantity field # number → spinbutton role
+Clear the Search field
+```
+
+### Dropdowns, checkboxes, radios ⚡
+```text
+Select "India" from the Country dropdown
+Check the "Remember me" checkbox
+Uncheck the "Subscribe" checkbox
+Select the "Male" radio button
+```
+
+### Keyboard ⚡
+```text
+Press Enter
+Press Escape
+Press Tab
+Press "Control+A"
+Type "hello" and press Enter
+```
+
+### Waits, scroll, hover, screenshot ⚡
+```text
+Wait for 2 seconds
+Wait for the page to load
+Scroll down
+Scroll to bottom
+Hover over the "Profile" menu
+Take a screenshot
+```
+
+### File upload ⚡
+Upload a file with the **Files** picker, then reference its `{{FILE:name}}` token:
+```text
+Upload {{FILE:resume.pdf}} to the Resume field
+Upload {{FILE:resume.pdf}} to the Resume field and wait for 'Upload complete'   # most reliable
+Upload {{FILE:photo.png}}                                                       # page's file input
+```
+
+### File download ⚡
+Downloads are auto-captured (Reports → Downloads, and attached to Allure). The step waits until the file finishes:
+```text
+Download the "Export CSV" link
+Click the "Download" button to download
+Download the file by clicking "Report PDF"
+Click "Download invoice" and wait for download
+```
+
+### Assertions ⚡
+```text
+Verify "Welcome back" is visible
+Verify "Error" is not visible
+Verify the page title is "Dashboard"
+Verify the URL contains "/dashboard"
+Verify the "Email" field has value "user@test.com"
+Soft verify "Saved successfully" is visible        # continues on failure
+```
+
+### Scenarios the AI handles (MCP recommended)
+```text
+Login as admin using {{ADMIN_EMAIL}} and {{DEFAULT_PASSWORD}}
+Click the "Submit" button inside the payment iframe
+Fill the card number "4111111111111111" in the Stripe iframe
+Accept the confirmation dialog after clicking "Delete"
+Verify the table has 5 rows
+Click the element inside the shadow DOM component
+```
+- **iframes** → wrapped in `page.frameLocator(...)` automatically.
+- **shadow DOM** → locator chaining (`page.locator('host').locator('inner')`).
+- **dialogs** → a `page.once('dialog', …)` handler is added before the trigger.
+
+---
+
+## API steps
+
+Mark a suite/case as **API** type. Steps use Playwright's `page.request` API. Use `{{BASE_URL}}` and saved variables.
+
+### Basic requests
+```text
+Send a GET request to {{BASE_URL}}/api/users and verify status is 200
+Send a POST request to {{BASE_URL}}/api/users with body { "name": "John", "email": "john@test.com" } and verify status 201
+Send a PUT request to {{BASE_URL}}/api/users/1 with body { "name": "Jane" }
+Send a DELETE request to {{BASE_URL}}/api/users/1 and verify status 204
+```
+
+### Auth — extract and reuse a token
+```text
+POST to {{BASE_URL}}/api/login with { "email": "{{ADMIN_EMAIL}}", "password": "{{DEFAULT_PASSWORD}}" }, save token as AUTH_TOKEN
+GET {{BASE_URL}}/api/profile with Authorization Bearer {{AUTH_TOKEN}} and verify status 200
+```
+- "save / store / extract … as NAME" → `context.setVariable('NAME', …)`.
+- `{{AUTH_TOKEN}}` (or `context.getVariable`) reuses it in later steps/cases.
+
+### Assertions on the response
+```text
+Verify the response status is 200
+Verify the response body has property "id"
+Verify the response field "name" equals "Admin"
+Verify the response has 5 users
+Verify the content-type header contains "application/json"
+Verify the response time is under 500 ms
+Soft verify the response status is 200
+```
+
+### Headers, query params, form bodies
+```text
+Send a GET request to {{BASE_URL}}/api/search with query { "q": "phone", "page": "1" }
+Send a POST to {{BASE_URL}}/api/upload with form { "name": "doc", "type": "pdf" }
+Send a GET to {{BASE_URL}}/api/data with header "X-Api-Key" "{{API_KEY}}"
+```
+
+---
+
+## Soft vs hard assertions
+- **Hard** (default): the test stops at the first failure.
+- **Soft**: prefix with **"Soft"** (`Soft verify …`) — failures are collected and the test keeps going. In the Recorder, use `Ctrl+Shift+Click` for a soft assertion.
+
+## Variables & dynamic data
+| Token | Resolves to |
+|-------|-------------|
+| `{{BASE_URL}}` | Configured base URL for the active environment |
+| `{{FAKE_PERSON_FULLNAME}}`, `{{FAKE_INTERNET_EMAIL}}`, … | Fresh random data each run (Fake Data picker) |
+| `{{FILE:resume.pdf}}` | `fixtures/uploads/resume.pdf` (Files picker) |
+| `{{MY_VAR}}` | A value from Variables or saved earlier with `context.setVariable` |
+
+## Editing generated code
+Every step's code is editable — expand the step (chevron) and edit the code block directly, or click the **✎** to change the instruction and **regenerate** (wand). Use this for anything the engines don't phrase exactly the way your app needs.