lexxit-automation-framework 2.0.20 → 3.0.0

package/README.md

@@ -1,93 +1,282 @@
-# Playwright_V1_framework
+# Playwright Test Execution Framework
 
+A Node.js + TypeScript framework that executes Playwright-based test sets defined entirely in JSON, exposed through a REST API, with a live polling dashboard to monitor execution in real time.
 
+## Tech Stack
 
-## Getting started
+- Node.js 22, TypeScript
+- Express.js (REST API)
+- Playwright (Chromium, Firefox, Edge)
+- In-memory execution store (no database)
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+## Setup
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+```bash
+npm install
+npx playwright install
+npm run dev
+```
 
-## Add your files
+The server starts on port `5501`. On startup, the console prints the API URL and a list of available endpoints.
 
-* [Create](https://docs.gitlab.com/user/project/repository/web_editor/#create-a-file) or [upload](https://docs.gitlab.com/user/project/repository/web_editor/#upload-a-file) files
-* [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
+## Project Structure
 
 ```
-cd existing_repo
-git remote add origin https://gitlab.letitbexai.com/lexxit/playwright_v1_framework.git
-git branch -M main
-git push -uf origin main
+new_Framework/
+├── src/
+│   ├── api/
+│   │   └── server.ts            # Express server, all routes
+│   ├── runner/
+│   │   └── testRunner.ts        # Orchestrates a full test set (sequential/parallel)
+│   ├── executor/
+│   │   ├── scriptExecutor.ts    # Runs one test script (all its steps)
+│   │   ├── stepExecutor.ts      # Runs one step, routes to the correct handler
+│   │   ├── mapping.ts           # Parses step_script strings into function + args
+│   │   └── functionMap.ts       # Maps step_script function names to handler methods
+│   ├── actions/
+│   │   ├── browserManager.ts    # openBrowser, closeBrowser, navigation, video
+│   │   ├── textHandler.ts       # enterText, getText, verifyText, etc.
+│   │   ├── clickHandler.ts      # click, doubleClick, rightClick, hover, etc.
+│   │   ├── checkboxHandler.ts   # check, uncheck, toggle, verifyChecked, etc.
+│   │   ├── radiobuttonHandler.ts# select, selectByValue, selectByLabel, etc.
+│   │   └── dropdownHandler.ts   # native/combobox/multiselect dropdown actions
+│   ├── utils/
+│   │   ├── locatorService.ts    # Resolves an element from a list of xpath locators
+│   │   └── waitConditions.ts    # waitForVisible, waitForTextChange, etc.
+│   ├── validator/
+│   │   └── validator.ts         # Validates testset/testscript/step payload shapes
+│   ├── store/
+│   │   └── executionStore.ts    # In-memory live execution state, keyed by execution_id
+│   └── types/
+│       └── types.ts             # All shared TypeScript interfaces
+├── public/
+│   └── dashboard.html           # Live polling dashboard UI
+├── videos/                      # Saved test recordings (when video_enabled)
+├── tsconfig.json
+└── package.json
 ```
 
-## Integrate with your tools
+## How a Request Flows
+
+1. `POST /execute` receives the full test set JSON.
+2. The payload is validated in three layers: testset, testscript, and step.
+3. If valid, an `execution_id` (UUID) is generated and the response is returned **immediately** — the test set runs in the background.
+4. If `open_dashboard: true`, the dashboard auto-opens in your default browser (only once per server session).
+5. The dashboard polls the server and shows live step-by-step progress.
+6. Once finished, the full result (same shape as a traditional synchronous response) becomes available under `final_result`.
+
+## API Endpoints
+
+| Method | Path | Description |
+|--------|------|-------------|
+| GET | `/` | Lists all available endpoints |
+| POST | `/execute` | Submit a test set for execution |
+| GET | `/status/:execution_id` | Live status + final result of one execution |
+| GET | `/executions` | List all executions, latest first |
+| GET | `/dashboard` | Live dashboard UI |
+
+### POST /execute
 
-* [Set up project integrations](https://gitlab.letitbexai.com/lexxit/playwright_v1_framework/-/settings/integrations)
+Request body is the full test set JSON (see Request Format below).
 
-## Collaborate with your team
+Response (returned immediately, before execution finishes):
 
-* [Invite team members and collaborators](https://docs.gitlab.com/user/project/members/)
-* [Create a new merge request](https://docs.gitlab.com/user/project/merge_requests/creating_merge_requests/)
-* [Automatically close issues from merge requests](https://docs.gitlab.com/user/project/issues/managing_issues/#closing-issues-automatically)
-* [Enable merge request approvals](https://docs.gitlab.com/user/project/merge_requests/approvals/)
-* [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
+```json
+{
+  "status": "started",
+  "execution_id": "a1b2c3d4-...",
+  "dashboard_url": "http://localhost:5501/dashboard?execution_id=a1b2c3d4-...",
+  "result_url": "http://localhost:5501/status/a1b2c3d4-..."
+}
+```
+
+If validation fails, responds with `400` and an `errors` array describing every problem found, tagged by level (`testset`, `testscript`, or `step`).
+
+### GET /status/:execution_id
+
+Returns the live execution state. While running, `scripts[].steps[]` update in real time (`pending` → `running` → `pass`/`fail`/`skip`). Once finished, `final_result` is populated with the complete original-style response (status, full step results, summary).
+
+```json
+{
+  "execution_id": "a1b2c3d4-...",
+  "test_set_name": "E2E Smoke Suite",
+  "status": "pass",
+  "start_time": "2026-06-17 10:00:00",
+  "end_time": "2026-06-17 10:00:42",
+  "scripts": [
+    {
+      "test_script_uid": "d42bbbd5-...",
+      "test_case_name": "asdfasdf444",
+      "status": "pass",
+      "steps": [
+        {
+          "step_name": "Enter 'sdf' into 'First name'",
+          "status": "pass",
+          "expected_result": "'sdf' entered into 'First name' successfully",
+          "comments": "'sdf' entered into 'First name' successfully",
+          "duration": "0 seconds"
+        }
+      ]
+    }
+  ],
+  "final_result": {
+    "status": "pass",
+    "results": [ /* ... full TestScriptResult objects ... */ ],
+    "summary": {
+      "test_set_name": "E2E Smoke Suite",
+      "total_scripts": 1,
+      "passed": 1,
+      "failed": 0,
+      "duration": "12 seconds",
+      "start_time": "2026-06-17 10:00:00",
+      "end_time": "2026-06-17 10:00:12"
+    }
+  }
+}
+```
+
+## Request Format
+
+A test set request has three nested levels: testset, testscript, and step.
+
+```json
+{
+  "test_set_name": "E2E Smoke Suite",
+  "open_dashboard": true,
+  "parallel": false,
+  "stop_on_failure": true,
+  "video_enabled": true,
+  "exec_mode": { "mode": "medium", "delay_ms": 1000 },
+  "scripts": [
+    {
+      "test_script_uid": "d42bbbd5-f50f-4b71-a119-ef7294eab861",
+      "test_case_name": "asdfasdf444",
+      "voice_enabled": false,
+      "app_id": "1b040097-495d-4428-84d1-bd31ecc97e93",
+      "browser": "edge",
+      "headless": false,
+      "screenshot_mode": "on_failure",
+      "stop_on_failure": true,
+      "steps": [
+        {
+          "step_name": "Open edge",
+          "step_script": "tSetup.openBrowser('edge')",
+          "label": ""
+        },
+        {
+          "step_name": "Navigate to URL",
+          "step_script": "tSetup.navigateToURL('https://example.com')",
+          "label": ""
+        },
+        {
+          "label": "First name",
+          "locators": [
+            "//input[@id='fname']",
+            "//input[@id='fname' and @name='fname']"
+          ],
+          "obj_uid": "066d39cd-b378-40c0-aa7f-e80e6c55a530",
+          "page_uid": null,
+          "step_name": "Enter 'sdf' into 'First name'",
+          "step_script": "tSetup.enterText('xpath', '//input[@id=\"fname\"]', 'sdf')",
+          "value": "sdf"
+        },
+        {
+          "step_name": "Close Browser",
+          "step_script": "tSetup.closeBrowser()",
+          "label": ""
+        }
+      ]
+    }
+  ]
+}
+```
 
-## Test and Deploy
+### Testset-level fields
 
-Use the built-in continuous integration in GitLab.
+| Field | Type | Description |
+|-------|------|--------------|
+| `test_set_name` | string | Display name for the test set |
+| `open_dashboard` | boolean | Auto-opens the dashboard in your browser when execution starts |
+| `parallel` | boolean | Run scripts in parallel (max 10 concurrent) instead of sequentially |
+| `stop_on_failure` | boolean | Reserved for testset-level stop behavior |
+| `video_enabled` | boolean | Records a `.webm` video per script (forced `false` in `fast` exec mode) |
+| `exec_mode` | object, optional | `{ mode: 'fast' \| 'medium' \| 'slow', delay_ms?: number }`. Defaults to `fast` if omitted |
+| `scripts` | array | One or more test scripts |
 
-* [Get started with GitLab CI/CD](https://docs.gitlab.com/ci/quick_start/)
-* [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/user/application_security/sast/)
-* [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/topics/autodevops/requirements/)
-* [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/user/clusters/agent/)
-* [Set up protected environments](https://docs.gitlab.com/ci/environments/protected_environments/)
+### Testscript-level fields
 
-***
+| Field | Type | Description |
+|-------|------|--------------|
+| `test_script_uid` | string | Unique ID for this script |
+| `test_case_name` | string | Display name |
+| `app_id` | string | Application identifier |
+| `browser` | `chromium` \| `firefox` \| `edge` | Browser to launch |
+| `headless` | boolean | Run headless or headed |
+| `screenshot_mode` | `on_failure` \| `always` \| `never` | Reserved for screenshot behavior |
+| `stop_on_failure` | boolean | Skip remaining steps in this script once one fails |
+| `steps` | array | Ordered list of steps to execute |
 
-# Editing this README
+### Step-level fields
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+| Field | Type | Description |
+|-------|------|--------------|
+| `step_name` | string | Display name for the step |
+| `step_script` | string | The action to run, e.g. `tSetup.enterText('id','fname','mahesh')` |
+| `label` | string | Human-readable name of the target element, used in result messages |
+| `locators` | string[] | List of xpath locators tried together (first visible match wins) |
+| `obj_uid`, `page_uid` | string \| null | Optional metadata passed through to results |
 
-## Suggestions for a good README
+## Execution Modes
 
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+| Mode | Behavior |
+|------|----------|
+| `fast` (default) | No delay between steps. `video_enabled` is forced to `false` regardless of the request value |
+| `medium` | Waits `delay_ms` (default 1000ms if not provided) between steps. Respects `video_enabled` |
+| `slow` | Waits `delay_ms` (default 3000ms if not provided) between steps. Respects `video_enabled` |
 
-## Name
-Choose a self-explaining name for your project.
+`delay_ms` can be passed explicitly inside `exec_mode` to override the defaults for `medium`/`slow`.
 
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+## Step Script Reference
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+Steps are written as `tSetup.<functionName>(args...)`. The framework parses this string and routes it to the matching handler. Currently mapped functions:
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+| Function | Handler |
+|----------|---------|
+| `openBrowser`, `closeBrowser`, `navigateToURL`, `navigateBack`, `navigateForward`, `refreshPage`, `getTitle`, `getCurrentURL` | Browser Manager |
+| `enterText`, `typeText`, `clearText`, `getInputValue`, `appendText`, `setInputValue`, `verifyText`, `verifyValue`, `getText` | Text Handler |
+| `clickElement`, `doubleClick`, `rightClick`, `hover` | Click Handler |
+| `check_checkbox`, `uncheck_checkbox`, `verifyChecked`, `verifyUnchecked`, `verifyEnabled`, `verifyDisabled`, `verifyVisible`, `verifyHidden` | Checkbox Handler |
+| `selectRadioButton` | Radiobutton Handler |
+| `selectDropdown` | Dropdown Handler |
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+Functions not yet mapped (e.g. `dragAndDrop`, `file_upload`, `enterTextInFrame`, `verifyElementCount`, `verifyAttribute`, `acceptAlert`, `dismissAlert`, `getAlertText`, `verifyTitle`, `verifyURL`, `clickByJS`) are documented as comments in `functionMap.ts` for future implementation.
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+## Locator Resolution
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+Each step can provide multiple xpath locators as fallbacks. They're combined into a single OR-expression and the first visible, attached match is used. If the first locator in the list wasn't the one that matched, the step's `comments` field notes which position and xpath actually resolved — useful for cleaning up brittle locators over time.
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+## Live Dashboard
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+Visit `http://localhost:5501/dashboard` (or let it auto-open via `open_dashboard: true`).
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+- Left navigation lists all executions, most recent at the top.
+- Selecting an execution shows each script and its steps.
+- Steps show a spinner while running, then a pass/fail/skip badge.
+- Click any step row to expand and see its expected result and comments.
+- The dashboard polls `/executions` every 3 seconds and `/status/:execution_id` every 2 seconds — no manual refresh needed.
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+## Step Statuses
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+| Status | Meaning |
+|--------|---------|
+| `pending` | Not yet started (dashboard-only state) |
+| `running` | Currently executing (dashboard-only state) |
+| `pass` | Completed successfully |
+| `fail` | Failed |
+| `skip` | Skipped because an earlier step in the same script failed (when `stop_on_failure: true`) |
 
-## License
-For open source projects, say how it is licensed.
+## Notes
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+- Videos are saved to the `videos/` folder, named `<test_script_uid>_<timestamp>.webm`.
+- Parallel execution runs scripts in batches of up to 10 concurrently; batches are processed one after another.
+- The execution store is in-memory only — restarting the server clears all execution history.

package/npmignore

@@ -0,0 +1,8 @@
+src/
+dist/
+node_modules/
+.git/
+*.ts
+*.tgz
+Lexxit-prof/
+videos/

package/package.json

@@ -1 +1,32 @@
-{"name":"lexxit-automation-framework","version":"2.0.20","description":"Enterprise Playwright Automation Framework — Parallel, Non-blocking, Self-installing","main":"dist-obf/server.js","bin":{"lexxit-automation-framework":"./bin/lexxit-automation-framework.js"},"files":["dist-obf","bin","scripts","public"],"scripts":{"build":"tsc","start":"node dist-obf/server.js","dev":"ts-node-dev --respawn --transpile-only src/server.ts","install:browsers":"npx playwright install chromium firefox webkit","clean":"node -e \"require('fs').rmSync('dist',{recursive:true,force:true}); require('fs').rmSync('dist-obf',{recursive:true,force:true});\"","obfuscate":"javascript-obfuscator dist --output dist-obf --compact true --control-flow-flattening true --dead-code-injection true --string-array true --string-array-encoding base64 --rename-globals true","copy:public":"robocopy src\\public dist-obf\\public /E || exit 0","build:prod":"npm run clean && npm run build && npm run obfuscate && npm run copy:public","postinstall":"node scripts/postinstall.js","prepublishOnly":"npm run build:prod"},"dependencies":{"@google/genai":"^1.50.1","cors":"^2.8.5","dotenv":"^16.3.1","express":"^4.18.2","open":"^9.1.0","p-limit":"^4.0.0","playwright":"^1.40.0","say":"^0.16.0","uuid":"^9.0.0"},"devDependencies":{"@types/cors":"^2.8.17","@types/express":"^4.17.21","@types/node":"^20.10.0","@types/uuid":"^9.0.7","rimraf":"^5.0.5","ts-node-dev":"^2.0.0","typescript":"^5.3.2"}}
+{
+  "name": "lexxit-automation-framework",
+  "version": "3.0.0",
+  "description": "Playwright test execution framework with Express API",
+  "main": "dist-obf/api/server.js",
+  "scripts": {
+    "build": "tsc",
+    "obfuscate": "javascript-obfuscator dist --output dist-obf --compact true --control-flow-flattening true --dead-code-injection true --string-array true --string-array-encoding base64 --rename-globals true",
+    "build:prod": "npm run build && npm run obfuscate",
+    "start": "node dist-obf/api/server.js",
+    "dev": "ts-node src/api/server.ts"
+  },
+  "dependencies": {
+    "@playwright/test": "^1.44.0",
+    "cors": "^2.8.6",
+    "express": "^4.19.2",
+    "playwright": "^1.44.0",
+    "uuid": "^14.0.0"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.19",
+    "@types/express": "^4.17.21",
+    "@types/node": "^22.0.0",
+    "@types/uuid": "^10.0.0",
+    "javascript-obfuscator": "^4.1.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  }
+}