pw-automation-framework 2.0.1

package/README.md

@@ -0,0 +1,93 @@
+# Playwright_V1_framework
+
+
+
+## Getting started
+
+To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+
+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)!
+
+## Add your files
+
+* [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:
+
+```
+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
+```
+
+## Integrate with your tools
+
+* [Set up project integrations](https://gitlab.letitbexai.com/lexxit/playwright_v1_framework/-/settings/integrations)
+
+## Collaborate with your team
+
+* [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/)
+
+## Test and Deploy
+
+Use the built-in continuous integration in GitLab.
+
+* [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/)
+
+***
+
+# Editing this README
+
+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.
+
+## Suggestions for a good README
+
+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.
+
+## Name
+Choose a self-explaining name for your project.
+
+## 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.
+
+## 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.
+
+## 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.
+
+## 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.
+
+## 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.
+
+## 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.
+
+## Roadmap
+If you have ideas for releases in the future, it is a good idea to list them in the README.
+
+## Contributing
+State if you are open to contributions and what your requirements are for accepting them.
+
+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.
+
+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.
+
+## Authors and acknowledgment
+Show your appreciation to those who have contributed to the project.
+
+## License
+For open source projects, say how it is licensed.
+
+## 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.

package/bin/lexxit-automation-framework.js

@@ -0,0 +1,427 @@
+#!/usr/bin/env node
+
+'use strict';
+
+const { execSync, spawn } = require('child_process');
+const path = require('path');
+const fs = require('fs');
+const os = require('os');
+const http = require('http');
+
+const args = process.argv.slice(2);
+const command = args[0];
+
+const COLORS = {
+  reset: '\x1b[0m',
+  green: '\x1b[32m',
+  yellow: '\x1b[33m',
+  red: '\x1b[31m',
+  cyan: '\x1b[36m',
+  bold: '\x1b[1m',
+};
+
+function info(msg)    { console.log(`${COLORS.cyan}[lexxit]${COLORS.reset} ${msg}`); }
+function success(msg) { console.log(`${COLORS.green}✔${COLORS.reset} ${msg}`); }
+function warn(msg)    { console.log(`${COLORS.yellow}⚠${COLORS.reset} ${msg}`); }
+function error(msg)   { console.log(`${COLORS.red}✖${COLORS.reset} ${msg}`); }
+
+// ── Package root = one level up from /bin ──────────────────────────────────
+const PKG_ROOT = path.join(__dirname, '..');
+const DIST_SERVER = path.join(PKG_ROOT, 'dist', 'server.js');
+const PID_FILE = path.join(os.tmpdir(), 'lexxit-automation-framework.pid');
+const PORT = 3000;
+
+// ── Command router ─────────────────────────────────────────────────────────
+if (command === 'start') {
+  startFramework();
+} else if (command === 'stop') {
+  stopFramework();
+} else if (command === 'status') {
+  checkStatus();
+} else {
+  printHelp();
+}
+
+function printHelp() {
+  console.log(`
+${COLORS.bold}lexxit-automation-framework${COLORS.reset}
+
+Usage:
+  lexxit-automation-framework start    Start the local agent on port ${PORT}
+  lexxit-automation-framework stop     Stop the running agent
+  lexxit-automation-framework status   Check if agent is running
+`);
+}
+
+// ── START ───────────────────────────────────────────────────────────────────
+
+function startFramework() {
+  info('Starting lexxit-automation-framework...');
+
+  // 1. Check if already running
+  pingHealth((isRunning) => {
+    if (isRunning) {
+      success(`Framework already running on http://localhost:${PORT}`);
+      return;
+    }
+
+    // 2. Ensure dist/server.js exists
+    if (!fs.existsSync(DIST_SERVER)) {
+      info('dist/server.js not found — building project first...');
+      try {
+        execSync('npm run build', {
+          cwd: PKG_ROOT,
+          stdio: 'inherit',
+        });
+        success('Build complete.');
+      } catch (e) {
+        error('Build failed. Please run "npm run build" manually inside the framework folder.');
+        process.exit(1);
+      }
+    }
+
+    if (!fs.existsSync(DIST_SERVER)) {
+      error(`Still cannot find: ${DIST_SERVER}`);
+      error('Please run "npm run build" inside your lexxit-automation-framework folder.');
+      process.exit(1);
+    }
+
+    // 3. Launch server
+    info(`Launching server: ${DIST_SERVER}`);
+
+    const isWindows = os.platform() === 'win32';
+
+    // On Windows we use a slightly different spawn approach
+    const child = isWindows
+      ? spawn(process.execPath, [DIST_SERVER], {
+          detached: true,
+          stdio: 'ignore',
+          cwd: PKG_ROOT,
+          env: { ...process.env, PORT: String(PORT) },
+          windowsHide: true,
+        })
+      : spawn(process.execPath, [DIST_SERVER], {
+          detached: true,
+          stdio: 'ignore',
+          cwd: PKG_ROOT,
+          env: { ...process.env, PORT: String(PORT) },
+        });
+
+    child.unref();
+
+    // Save PID for stop command
+    try {
+      fs.writeFileSync(PID_FILE, String(child.pid));
+      info(`PID ${child.pid} saved to ${PID_FILE}`);
+    } catch (e) {
+      warn('Could not save PID file.');
+    }
+
+    // 4. Wait up to 30 seconds for server to be ready
+    info(`Waiting for framework on http://localhost:${PORT}/api/health ...`);
+    waitForHealth(30, 1000, () => {
+      success(`lexxit-automation-framework is running on http://localhost:${PORT}`);
+      success('You can now use the web app to run tests.');
+    });
+  });
+}
+
+// ── STOP ────────────────────────────────────────────────────────────────────
+
+function stopFramework() {
+  if (!fs.existsSync(PID_FILE)) {
+    warn('No PID file found — framework may not be running.');
+    return;
+  }
+
+  const pid = parseInt(fs.readFileSync(PID_FILE, 'utf8').trim(), 10);
+
+  if (isNaN(pid)) {
+    warn('Invalid PID file. Deleting it.');
+    fs.unlinkSync(PID_FILE);
+    return;
+  }
+
+  try {
+    process.kill(pid, 'SIGTERM');
+    fs.unlinkSync(PID_FILE);
+    success(`Framework stopped (PID: ${pid})`);
+  } catch (e) {
+    // Process may have already exited
+    warn(`Could not kill PID ${pid} — it may have already stopped.`);
+    if (fs.existsSync(PID_FILE)) fs.unlinkSync(PID_FILE);
+  }
+}
+
+// ── STATUS ──────────────────────────────────────────────────────────────────
+
+function checkStatus() {
+  info('Checking framework status...');
+  pingHealth((isRunning) => {
+    if (isRunning) {
+      success(`Framework is RUNNING on http://localhost:${PORT}`);
+    } else {
+      warn('Framework is NOT running.');
+      info('Start it with: lexxit-automation-framework start');
+    }
+  });
+}
+
+// ── HELPERS ─────────────────────────────────────────────────────────────────
+
+/**
+ * Single health ping — calls callback(true/false)
+ */
+function pingHealth(callback) {
+  const req = http.get(
+    `http://localhost:${PORT}/api/health`,
+    { timeout: 1500 },
+    (res) => {
+      callback(res.statusCode === 200);
+    }
+  );
+  req.on('error', () => callback(false));
+  req.on('timeout', () => {
+    req.destroy();
+    callback(false);
+  });
+}
+
+/**
+ * Retries health check every `intervalMs` up to `maxRetries` times.
+ * Calls onSuccess() when server responds, exits process on timeout.
+ */
+function waitForHealth(maxRetries, intervalMs, onSuccess) {
+  let attempts = 0;
+
+  const interval = setInterval(() => {
+    attempts++;
+    process.stdout.write(`\r${COLORS.cyan}[lexxit]${COLORS.reset} Attempt ${attempts}/${maxRetries}...`);
+
+    pingHealth((isRunning) => {
+      if (isRunning) {
+        clearInterval(interval);
+        process.stdout.write('\n');
+        onSuccess();
+      } else if (attempts >= maxRetries) {
+        clearInterval(interval);
+        process.stdout.write('\n');
+        error('Framework did not start in time.');
+        error(`Try running directly to see errors:`);
+        console.log(`  node "${DIST_SERVER}"`);
+        process.exit(1);
+      }
+    });
+  }, intervalMs);
+}
+
+
+
+// #!/usr/bin/env node
+
+// /**
+//  * lexxit-automation-framework CLI
+//  * Usage: lexxit-automation-framework start
+//  */
+
+// const { execSync, spawn } = require("child_process");
+// const path = require("path");
+// const os = require("os");
+// const fs = require("fs");
+
+// const args = process.argv.slice(2);
+// const command = args[0];
+
+// const COLORS = {
+//   reset: "\x1b[0m",
+//   green: "\x1b[32m",
+//   yellow: "\x1b[33m",
+//   red: "\x1b[31m",
+//   cyan: "\x1b[36m",
+//   bold: "\x1b[1m",
+// };
+
+// function log(color, prefix, msg) {
+//   console.log(`${color}${prefix}${COLORS.reset} ${msg}`);
+// }
+
+// function info(msg) { log(COLORS.cyan, "[lexxit]", msg); }
+// function success(msg) { log(COLORS.green, "✔", msg); }
+// function warn(msg) { log(COLORS.yellow, "⚠", msg); }
+// function error(msg) { log(COLORS.red, "✖", msg); }
+
+// // ─── COMMANDS ────────────────────────────────────────────────────────────────
+
+// if (command === "start") {
+//   startFramework();
+// } else if (command === "stop") {
+//   stopFramework();
+// } else if (command === "status") {
+//   checkStatus();
+// } else {
+//   console.log(`
+// ${COLORS.bold}lexxit-automation-framework${COLORS.reset}
+
+// Usage:
+//   lexxit-automation-framework start    Start the local agent on port 3000
+//   lexxit-automation-framework stop     Stop the running agent
+//   lexxit-automation-framework status   Check if agent is running
+// `);
+//   process.exit(0);
+// }
+
+// // ─── START ───────────────────────────────────────────────────────────────────
+
+// function startFramework() {
+//   info("Starting lexxit-automation-framework...");
+
+//   // Check if already running
+//   try {
+//     const http = require("http");
+//     const req = http.get("http://localhost:3000/api/health", (res) => {
+//       if (res.statusCode === 200) {
+//         success("Framework already running on http://localhost:3000");
+//         process.exit(0);
+//       }
+//     });
+//     req.on("error", () => {
+//       // Not running — proceed to start
+//       launchServer();
+//     });
+//     req.setTimeout(1000, () => {
+//       req.destroy();
+//       launchServer();
+//     });
+//   } catch {
+//     launchServer();
+//   }
+// }
+
+// function launchServer() {
+//   const serverEntry = resolveServerEntry();
+
+//   if (!serverEntry) {
+//     error("Could not locate framework server entry point.");
+//     process.exit(1);
+//   }
+
+//   info(`Launching server from: ${serverEntry}`);
+
+//   // Detached spawn so it survives terminal close
+//   const child = spawn(process.execPath, [serverEntry], {
+//     detached: true,
+//     stdio: "ignore",
+//     env: { ...process.env, PORT: "3000" },
+//   });
+
+//   child.unref();
+
+//   // Write PID file for stop command
+//   const pidFile = getPidFilePath();
+//   fs.writeFileSync(pidFile, String(child.pid));
+
+//   // Wait for server to be ready
+//   info("Waiting for framework to be ready...");
+//   waitForHealth(10, () => {
+//     success("lexxit-automation-framework is running on http://localhost:3000");
+//     success(`PID: ${child.pid} (saved to ${pidFile})`);
+//   });
+// }
+
+// function resolveServerEntry() {
+//   // Look for the framework's main server file
+//   // Adjust this path to match your lexxit-automation-framework structure
+//   const candidates = [
+//     path.join(__dirname, "../src/server.ts"),
+//     path.join(__dirname, "../index.ts"),
+//     path.join(__dirname, "../server.ts"),
+//     path.join(__dirname, "../src/index.ts"),
+//   ];
+
+//   for (const candidate of candidates) {
+//     if (fs.existsSync(candidate)) return candidate;
+//   }
+//   return null;
+// }
+
+// // ─── STOP ────────────────────────────────────────────────────────────────────
+
+// function stopFramework() {
+//   const pidFile = getPidFilePath();
+
+//   if (!fs.existsSync(pidFile)) {
+//     warn("No running framework found (no PID file).");
+//     return;
+//   }
+
+//   const pid = parseInt(fs.readFileSync(pidFile, "utf8").trim(), 10);
+
+//   try {
+//     process.kill(pid, "SIGTERM");
+//     fs.unlinkSync(pidFile);
+//     success(`Framework stopped (PID: ${pid})`);
+//   } catch (e) {
+//     error(`Failed to stop framework: ${e.message}`);
+//     fs.unlinkSync(pidFile);
+//   }
+// }
+
+// // ─── STATUS ──────────────────────────────────────────────────────────────────
+
+// function checkStatus() {
+//   const http = require("http");
+
+//   info("Checking framework status...");
+
+//   const req = http.get("http://localhost:3000/api/health", (res) => {
+//     let data = "";
+//     res.on("data", (chunk) => (data += chunk));
+//     res.on("end", () => {
+//       success("Framework is RUNNING on http://localhost:3000");
+//       try {
+//         const json = JSON.parse(data);
+//         console.log("  Response:", JSON.stringify(json, null, 2));
+//       } catch {}
+//     });
+//   });
+
+//   req.on("error", () => {
+//     warn("Framework is NOT running.");
+//   });
+
+//   req.setTimeout(2000, () => {
+//     req.destroy();
+//     warn("Framework is NOT responding (timeout).");
+//   });
+// }
+
+// // ─── HELPERS ─────────────────────────────────────────────────────────────────
+
+// function waitForHealth(retries, onSuccess) {
+//   if (retries === 0) {
+//     error("Framework did not start in time. Check for errors.");
+//     process.exit(1);
+//   }
+
+//   const http = require("http");
+
+//   setTimeout(() => {
+//     const req = http.get("http://localhost:3000/api/health", (res) => {
+//       console.log('response is :::::::::::::::::::', res)
+//       if (res.statusCode === 200) {
+//         onSuccess();
+//       } else {
+//         waitForHealth(retries - 1, onSuccess);
+//       }
+//     });
+//     req.on("error", () => waitForHealth(retries - 1, onSuccess));
+//     req.setTimeout(1000, () => {
+//       req.destroy();
+//       waitForHealth(retries - 1, onSuccess);
+//     });
+//   }, 1000);
+// }
+
+// function getPidFilePath() {
+//   return path.join(os.tmpdir(), "lexxit-automation-framework.pid");
+// }

package/dist/app.d.ts

@@ -0,0 +1,2 @@
+declare const app: import("express-serve-static-core").Express;
+export default app;

package/dist/app.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const express_1 = __importDefault(require("express"));
+const cors_1 = __importDefault(require("cors"));
+const path_1 = __importDefault(require("path"));
+const api_routes_1 = __importDefault(require("./routes/api.routes"));
+const app = (0, express_1.default)();
+app.use((0, cors_1.default)({ origin: "*" }));
+app.use(express_1.default.json({ limit: "20mb" }));
+app.use(express_1.default.urlencoded({ extended: true }));
+app.use(express_1.default.static(path_1.default.join(__dirname, "public")));
+// Live dashboard — serves the HTML shell; JS reads executionId from URL
+app.get("/dashboard/:executionId", (_req, res) => {
+    res.sendFile(path_1.default.join(__dirname, "public", "dashboard.html"));
+});
+// Multi-execution queue monitor
+app.get("/queue-monitor", (_req, res) => {
+    res.sendFile(path_1.default.join(__dirname, "public", "queue-monitor.html"));
+});
+app.use("/api", api_routes_1.default);
+app.use((_req, res) => res.status(404).json({ error: "Not found" }));
+exports.default = app;
+//# sourceMappingURL=app.js.map

package/dist/app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":";;;;;AAAA,sDAA8B;AAC9B,gDAAwB;AACxB,gDAAwB;AACxB,qEAA4C;AAE5C,MAAM,GAAG,GAAG,IAAA,iBAAO,GAAE,CAAC;AAEtB,GAAG,CAAC,GAAG,CAAC,IAAA,cAAI,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AAC/B,GAAG,CAAC,GAAG,CAAC,iBAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;AACzC,GAAG,CAAC,GAAG,CAAC,iBAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAChD,GAAG,CAAC,GAAG,CAAC,iBAAO,CAAC,MAAM,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;AAExD,wEAAwE;AACxE,GAAG,CAAC,GAAG,CAAC,yBAAyB,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;IAC/C,GAAG,CAAC,QAAQ,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAC,CAAC;AACjE,CAAC,CAAC,CAAC;AAEH,gCAAgC;AAChC,GAAG,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;IACtC,GAAG,CAAC,QAAQ,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,oBAAoB,CAAC,CAAC,CAAC;AACrE,CAAC,CAAC,CAAC;AAEH,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,oBAAS,CAAC,CAAC;AAE3B,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;AAErE,kBAAe,GAAG,CAAC"}

package/dist/controllers/controller.d.ts

@@ -0,0 +1,57 @@
+import { Request, Response } from "express";
+export declare class ApiController {
+    /**
+     * POST /api/run-test
+     * ------------------
+     * Enqueues execution, returns 202 + executionId immediately.
+     * The caller opens the dashboard and subscribes to SSE for live updates.
+     * Call GET /api/result/:executionId when done to get the full formatted result.
+     */
+    static runTest(req: Request, res: Response): Promise<void>;
+    /**
+     * GET /api/stream/:executionId
+     * ----------------------------
+     * SSE endpoint — dashboard subscribes here for live step events.
+     * Replays all past events immediately for late-connecting clients.
+     */
+    static stream(req: Request, res: Response): void;
+    /**
+     * GET /api/result/:executionId
+     * ----------------------------
+     * Returns the FULL formatted result once execution is complete.
+     * Returns 202 if still running (poll until 200).
+     *
+     * Response matches the standard format:
+     * {
+     *   "status": "pass|fail",
+     *   "results": [{ "test_script_uid": "...", "status": "...", "results": [...] }]
+     * }
+     */
+    static getResult(req: Request, res: Response): void;
+    /**
+     * GET /api/status/:executionId
+     * ----------------------------
+     * Lightweight status check (progress only, no full results).
+     */
+    static getStatus(req: Request, res: Response): void;
+    /**
+     * DELETE /api/cancel/:executionId
+     */
+    static cancelExecution(req: Request, res: Response): void;
+    /**
+     * DELETE /api/cancel-all
+     */
+    static cancelAll(_req: Request, res: Response): void;
+    /**
+     * GET /api/queue
+     */
+    static getQueue(_req: Request, res: Response): void;
+    /**
+     * GET /api/health
+     */
+    static health(_req: Request, res: Response): void;
+    /**
+     * GET /api/actions
+     */
+    static listActions(_req: Request, res: Response): void;
+}