lexxit-automation-framework 2.0.19 → 3.0.0

package/src/actions/checkboxHandler.ts

@@ -0,0 +1,276 @@
+import { Page } from 'playwright';
+import { ScreenshotMode, StepResult} from '../types/types';
+import { LocatorService } from '../utils/locatorService';
+import { BaseHandler } from './baseHandler';
+import { DEFAULT_SCREENSHOT_MODE } from '../config';
+
+export class CheckboxHandler extends BaseHandler {
+  protected page: Page;
+
+ constructor(page: Page, screenshotMode: ScreenshotMode = DEFAULT_SCREENSHOT_MODE) {
+  super();
+  this.page = page;
+  this.screenshotMode = screenshotMode;
+  this.setupNetworkCapture(page);
+}
+
+  //  // ─── Helpers ───────────────────────────────────────────────────────────────
+
+  // private getStartTime(): string {
+  //   return new Date().toISOString();
+  // }
+
+  // private getDuration(startMs: number): number {
+  //   return Date.now() - startMs;
+  // }
+
+  // private buildResult(
+  //   status: 'PASS' | 'FAIL',
+  //   expected_result: string,
+  //   comments: string,
+  //   startMs: number,
+  //   startTime: string,
+  //   step_name: string = '',
+  //   uid: string | null = null,
+  //   obj_uid: string | null = null,
+  //   page_uid: string | null = null
+  // ): StepResult {
+  //   return {
+  //     uid,
+  //     obj_uid,
+  //     page_uid,
+  //     step_name,
+  //     step_script: '',
+  //     status,
+  //     expected_result,
+  //     comments,
+  //     duration:   this.getDuration(startMs),
+  //     start_time: startTime
+  //   };
+  // }
+
+  // private async captureScreenshot(isFailure: boolean): Promise<string | undefined> {
+  //   if (this.screenshotMode === 'never') return undefined;
+  //   if (this.screenshotMode === 'on_failure' && !isFailure) return undefined;
+  //   try {
+  //     if (!this.page || this.page.isClosed()) return undefined;
+  //     const buf = await this.page.screenshot({ type: 'png', fullPage: false });
+  //     return buf.toString('base64');
+  //   } catch {
+  //     return undefined;
+  //   }
+  // }
+
+  // private classifyError(error: any): string {
+  //   const msg: string = error?.message || String(error);
+
+  //   if (msg.includes('Element not found') || msg.includes('not visible')) {
+  //     return `Element not found or not visible: ${msg}`;
+  //   }
+  //   if (msg.includes('Timeout') || msg.includes('timeout')) {
+  //     return `Timeout error - element took too long to respond: ${msg}`;
+  //   }
+  //   if (msg.includes('not enabled')) {
+  //     return `Element is disabled: ${msg}`;
+  //   }
+  //   if (msg.includes('detached')) {
+  //     return `Element got detached from DOM: ${msg}`;
+  //   }
+  //   if (msg.includes('Target closed') || msg.includes('has been closed')) {
+  //     return `Browser or page closed unexpectedly: ${msg}`;
+  //   }
+  //   if (msg.includes('intercepts pointer events')) {
+  //     return `Element is covered by another element: ${msg}`;
+  //   }
+
+  //   return `Unexpected error: ${msg}`;
+  // }
+
+  // private appendMatchedLocatorInfo(comments: string, matchedIndex: number, matchedXPath: string): string {
+  //   if (matchedIndex > 0) {
+  //     return `${comments} (Matched locator at position ${matchedIndex}: ${matchedXPath})`;
+  //   }
+  //   return comments;
+  // }
+
+  // ─── check ─────────────────────────────────────────────────────────────────
+
+  async check(label: string, locators: string[], step_name: string = 'Check checkbox'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `'${label}' checked successfully`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      await resolved.element.check();
+
+      const comments = this.appendMatchedLocatorInfo(expected, resolved.matchedIndex, resolved.matchedXPath);
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+
+  // ─── uncheck ───────────────────────────────────────────────────────────────
+
+  async uncheck(label: string, locators: string[], step_name: string = 'Uncheck checkbox'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `'${label}' unchecked successfully`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      await resolved.element.uncheck();
+
+      const comments = this.appendMatchedLocatorInfo(expected, resolved.matchedIndex, resolved.matchedXPath);
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+
+  // ─── toggle ────────────────────────────────────────────────────────────────
+
+  async toggle(label: string, locators: string[], step_name: string = 'Toggle checkbox'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `'${label}' toggled successfully`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      const isChecked = await resolved.element.isChecked();
+
+      if (isChecked) {
+        await resolved.element.uncheck();
+      } else {
+        await resolved.element.check();
+      }
+
+      const comments = this.appendMatchedLocatorInfo(expected, resolved.matchedIndex, resolved.matchedXPath);
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+
+  // ─── isChecked ─────────────────────────────────────────────────────────────
+
+  async isChecked(label: string, locators: string[], step_name: string = 'Check if checkbox is checked'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `'${label}' checked state retrieved successfully`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      const checked = await resolved.element.isChecked();
+
+      const comments = this.appendMatchedLocatorInfo(
+        `'${label}' is ${checked ? 'checked' : 'unchecked'}`,
+        resolved.matchedIndex,
+        resolved.matchedXPath
+      );
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+
+  // ─── verifyChecked ─────────────────────────────────────────────────────────
+
+  async verifyChecked(label: string, locators: string[], step_name: string = 'Verify checkbox is checked'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `'${label}' is checked`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      const checked = await resolved.element.isChecked();
+
+      if (!checked) {
+        const failComments = this.appendMatchedLocatorInfo(`'${label}' is not checked`, resolved.matchedIndex, resolved.matchedXPath);
+        // const sc = await this.captureScreenshot(true);
+        return this.buildResult('FAIL', expected, failComments, startMs, startTime, step_name);
+      }
+
+      const comments = this.appendMatchedLocatorInfo(expected, resolved.matchedIndex, resolved.matchedXPath);
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+
+  // ─── verifyUnchecked ───────────────────────────────────────────────────────
+
+  async verifyUnchecked(label: string, locators: string[], step_name: string = 'Verify checkbox is unchecked'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `'${label}' is unchecked`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      const checked = await resolved.element.isChecked();
+
+      if (checked) {
+        const failComments = this.appendMatchedLocatorInfo(`'${label}' is checked`, resolved.matchedIndex, resolved.matchedXPath);
+        // const sc = await this.captureScreenshot(true);
+        return this.buildResult('FAIL', expected, failComments, startMs, startTime, step_name);
+      }
+
+      const comments = this.appendMatchedLocatorInfo(expected, resolved.matchedIndex, resolved.matchedXPath);
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+
+  // ─── isEnabled ─────────────────────────────────────────────────────────────
+
+  async isEnabled(label: string, locators: string[], step_name: string = 'Check if checkbox is enabled'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `'${label}' enabled state retrieved successfully`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      const enabled = await resolved.element.isEnabled();
+
+      const comments = this.appendMatchedLocatorInfo(
+        `'${label}' is ${enabled ? 'enabled' : 'disabled'}`,
+        resolved.matchedIndex,
+        resolved.matchedXPath
+      );
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+
+  // ─── isVisible ─────────────────────────────────────────────────────────────
+
+  async isVisible(label: string, locators: string[], step_name: string = 'Check if checkbox is visible'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `'${label}' visibility state retrieved successfully`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      const visible = await resolved.element.isVisible();
+
+      const comments = this.appendMatchedLocatorInfo(
+        `'${label}' is ${visible ? 'visible' : 'not visible'}`,
+        resolved.matchedIndex,
+        resolved.matchedXPath
+      );
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+}