@elliemae/smoked-suite 26.2.16 → 26.2.17

package/dist/cjs/base-test/index.js

@@ -0,0 +1,246 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var base_test_exports = {};
+__export(base_test_exports, {
+  BaseTest: () => BaseTest
+});
+module.exports = __toCommonJS(base_test_exports);
+var import_test = require("@playwright/test");
+var import_auth = require("../auth/index.js");
+var import_page_setup = require("../page-setup/index.js");
+var import_monocartCoverage = require("../monocartCoverage/index.js");
+const DEFAULT_NAVIGATION_TIMEOUT = 6e4;
+const DEFAULT_ELEMENT_TIMEOUT = 5e3;
+class BaseTest {
+  auth = new import_auth.AuthManager();
+  pageSetup = new import_page_setup.PageSetup();
+  /** Whether sessionStorage was injected via `addInitScript`. */
+  sessionInjectedViaInitScript = false;
+  /** Top-level Playwright page. Used for navigation, auth, and interaction. */
+  page;
+  /**
+   * Alias for {@link page}. Available after calling a navigation
+   * method such as {@link goToEmAdminUI}. Pass to page objects
+   * via a callback: `() => this.appFrame`.
+   */
+  appFrame;
+  // ─── Credentials ─────────────────────────────────────────────────────────────
+  /**
+   * Return the credentials used for the encw login flow.
+   *
+   * Reads from environment variables with local-development defaults:
+   *
+   * | Variable            | Default       |
+   * |---------------------|---------------|
+   * | `ENCW_INSTANCE_ID`  | `BE11226875`  |
+   * | `ENCW_USER_ID`      | `admin`       |
+   * | `ENCW_PASSWORD`     | `Password#!23` |
+   *
+   * Override this method to supply different credentials.
+   */
+  getCredentials() {
+    return {
+      instanceId: process.env.ENCW_INSTANCE_ID ?? "BE11226875",
+      username: process.env.ENCW_USER_ID ?? "admin",
+      password: process.env.ENCW_PASSWORD ?? "Password#!23"
+    };
+  }
+  // ─── Auth orchestration ──────────────────────────────────────────────────────
+  /**
+   * Ensure the browser has a valid encw session.
+   *
+   * - First test in a worker: performs the full login flow and
+   *   snapshots session storage.
+   * - Subsequent tests: session is injected during
+   *   {@link navigateToApp}.
+   *
+   * This method does **not** navigate to any app route.
+   */
+  async ensureAuth() {
+    await this.pageSetup.apply(this.page);
+    if (!this.auth.hasValidAuth() && import_auth.AuthManager.loadFromFile()) {
+      const state = import_auth.AuthManager.getAuthState();
+      if (state) {
+        await this.page.addInitScript((entries) => {
+          for (const [key, value] of Object.entries(entries)) {
+            sessionStorage.setItem(key, value);
+          }
+        }, state.sessionEntries);
+        this.sessionInjectedViaInitScript = true;
+      }
+    }
+    if (this.auth.hasValidAuth()) {
+      return;
+    }
+    await this.auth.login(this.page, this.getCredentials());
+    await this.auth.capture(this.page);
+  }
+  // ─── App navigation ────────────────────────────────────────────────────────
+  /**
+   * Navigate to an application route.
+   *
+   * Handles auth injection (for cached sessions) and page navigation.
+   * @param route - URL path to navigate to (e.g. `/admin`).
+   */
+  async navigateToApp(route) {
+    if (this.sessionInjectedViaInitScript) {
+      await this.page.goto(route, { waitUntil: "domcontentloaded" });
+      return;
+    }
+    if (this.auth.hasValidAuth()) {
+      await this.page.goto("", { waitUntil: "domcontentloaded" });
+      await this.auth.inject(this.page);
+    }
+    await this.page.goto(route, {
+      waitUntil: "domcontentloaded"
+    });
+  }
+  /**
+   * Log in to encw and navigate to the **em-admin-ui** app.
+   * After this method returns, {@link page} is on the admin route.
+   */
+  async goToEmAdminUI() {
+    await this.navigateToApp("/admin");
+  }
+  /**
+   * Log in to encw and navigate to the **pipeline** app.
+   * After this method returns, {@link page} is on the pipeline route.
+   */
+  async goToPipeline() {
+    await this.navigateToApp("/pipeline");
+  }
+  // ─── Navigation helpers ──────────────────────────────────────────────────────
+  /**
+   * Navigate to a URL path.
+   * @param path    - Absolute URL path (e.g. `/admin/oneadmin/migrate`).
+   * @param options - Navigation options forwarded to Playwright.
+   */
+  async goto(path, options = {}) {
+    const {
+      waitUntil = "domcontentloaded",
+      timeout = DEFAULT_NAVIGATION_TIMEOUT
+    } = options;
+    await this.page.goto(path, { waitUntil, timeout });
+  }
+  /**
+   * Wait for an element to be visible on the page.
+   * @param selector - CSS selector.
+   * @param options  - Timeout and expected state.
+   * @param options.timeout
+   * @param options.state
+   */
+  async waitForElement(selector, options = {}) {
+    const { timeout = DEFAULT_ELEMENT_TIMEOUT, state = "visible" } = options;
+    await this.page.locator(selector).waitFor({ timeout, state });
+  }
+  /** Playwright's `expect` — exposed for assertions inside test methods. */
+  get expect() {
+    return import_test.expect;
+  }
+  // ─── Lifecycle hooks ─────────────────────────────────────────────────────────
+  /**
+   * Called once before all tests in a describe block.
+   * Override in a subclass to add one-time setup logic.
+   * Note: `this.page` is not available in this hook.
+   */
+  async beforeAll() {
+  }
+  /**
+   * Called once after all tests in a describe block.
+   * Override in a subclass to add one-time teardown logic.
+   * Note: `this.page` is not available in this hook.
+   */
+  async afterAll() {
+  }
+  /**
+   * Called before each test. Override in a subclass to add setup
+   * logic (e.g. `await this.goToEmAdminUI()`).
+   */
+  async beforeEach() {
+  }
+  /** Called after each test. Override to add teardown logic. */
+  async afterEach() {
+  }
+  // ─── Test runner ─────────────────────────────────────────────────────────────
+  static toReadableTitle(methodName) {
+    const withoutPrefix = methodName.replace(/^test/, "");
+    return withoutPrefix.replace(/([A-Z])/g, " $1").toLowerCase().trim();
+  }
+  /**
+   * Register all `test*` methods in this class with Playwright.
+   *
+   * Call once at module level after the class definition:
+   * ```ts
+   * class MySpec extends BaseTest { ... }
+   * MySpec.run();
+   * ```
+   */
+  static run() {
+    const TestClass = this;
+    const className = TestClass.name;
+    const proto = TestClass.prototype;
+    const testMethods = Object.getOwnPropertyNames(proto).filter(
+      (name) => name.startsWith("test") && typeof proto[name] === "function"
+    );
+    if (testMethods.length === 0) {
+      console.warn(
+        `No test methods found in ${className}. Test methods must start with 'test'.`
+      );
+      return;
+    }
+    import_test.test.describe(className, () => {
+      let instance;
+      import_test.test.beforeAll(async () => {
+        (0, import_monocartCoverage.startCoverage)();
+        instance = new TestClass();
+        if (typeof instance.beforeAll === "function") {
+          await instance.beforeAll();
+        }
+      });
+      import_test.test.beforeEach(async ({ page }) => {
+        instance = new TestClass();
+        instance.page = page;
+        instance.appFrame = page;
+        await instance.ensureAuth();
+        await (0, import_monocartCoverage.trackPage)(page);
+        if (typeof instance.beforeEach === "function") {
+          await instance.beforeEach();
+        }
+      });
+      import_test.test.afterEach(async () => {
+        if (typeof instance.afterEach === "function") {
+          await instance.afterEach();
+        }
+        await (0, import_monocartCoverage.untrackPage)(instance.page);
+      });
+      import_test.test.afterAll(async () => {
+        await (0, import_monocartCoverage.stopCoverage)();
+        if (typeof instance.afterAll === "function") {
+          await instance.afterAll();
+        }
+      });
+      for (const methodName of testMethods) {
+        const title = TestClass.toReadableTitle(methodName);
+        (0, import_test.test)(title, async () => {
+          await instance[methodName]();
+        });
+      }
+    });
+  }
+}

package/dist/cjs/index.js

@@ -30,6 +30,7 @@ var index_exports = {};
 __export(index_exports, {
   AuthManager: () => import_auth.AuthManager,
   BasePage: () => import_base_page.BasePage,
+  BaseTest: () => import_base_test.BaseTest,
   PageSetup: () => import_page_setup.PageSetup,
   createBrowserStackConfig: () => import_browserstack.createBrowserStackConfig,
   createPlaywrightConfig: () => import_playwright_config.createPlaywrightConfig,
@@ -38,6 +39,7 @@ __export(index_exports, {
   writeBrowserStackConfig: () => import_browserstack.writeBrowserStackConfig
 });
 module.exports = __toCommonJS(index_exports);
+var import_base_test = require("./base-test/index.js");
 var import_base_page = require("./base-page/index.js");
 var import_auth = require("./auth/index.js");
 var import_page_setup = require("./page-setup/index.js");

package/dist/esm/base-test/index.js

@@ -0,0 +1,231 @@
+import { test, expect } from "@playwright/test";
+import { AuthManager } from "../auth/index.js";
+import { PageSetup } from "../page-setup/index.js";
+import {
+  startCoverage,
+  stopCoverage,
+  trackPage,
+  untrackPage
+} from "../monocartCoverage/index.js";
+const DEFAULT_NAVIGATION_TIMEOUT = 6e4;
+const DEFAULT_ELEMENT_TIMEOUT = 5e3;
+class BaseTest {
+  auth = new AuthManager();
+  pageSetup = new PageSetup();
+  /** Whether sessionStorage was injected via `addInitScript`. */
+  sessionInjectedViaInitScript = false;
+  /** Top-level Playwright page. Used for navigation, auth, and interaction. */
+  page;
+  /**
+   * Alias for {@link page}. Available after calling a navigation
+   * method such as {@link goToEmAdminUI}. Pass to page objects
+   * via a callback: `() => this.appFrame`.
+   */
+  appFrame;
+  // ─── Credentials ─────────────────────────────────────────────────────────────
+  /**
+   * Return the credentials used for the encw login flow.
+   *
+   * Reads from environment variables with local-development defaults:
+   *
+   * | Variable            | Default       |
+   * |---------------------|---------------|
+   * | `ENCW_INSTANCE_ID`  | `BE11226875`  |
+   * | `ENCW_USER_ID`      | `admin`       |
+   * | `ENCW_PASSWORD`     | `Password#!23` |
+   *
+   * Override this method to supply different credentials.
+   */
+  getCredentials() {
+    return {
+      instanceId: process.env.ENCW_INSTANCE_ID ?? "BE11226875",
+      username: process.env.ENCW_USER_ID ?? "admin",
+      password: process.env.ENCW_PASSWORD ?? "Password#!23"
+    };
+  }
+  // ─── Auth orchestration ──────────────────────────────────────────────────────
+  /**
+   * Ensure the browser has a valid encw session.
+   *
+   * - First test in a worker: performs the full login flow and
+   *   snapshots session storage.
+   * - Subsequent tests: session is injected during
+   *   {@link navigateToApp}.
+   *
+   * This method does **not** navigate to any app route.
+   */
+  async ensureAuth() {
+    await this.pageSetup.apply(this.page);
+    if (!this.auth.hasValidAuth() && AuthManager.loadFromFile()) {
+      const state = AuthManager.getAuthState();
+      if (state) {
+        await this.page.addInitScript((entries) => {
+          for (const [key, value] of Object.entries(entries)) {
+            sessionStorage.setItem(key, value);
+          }
+        }, state.sessionEntries);
+        this.sessionInjectedViaInitScript = true;
+      }
+    }
+    if (this.auth.hasValidAuth()) {
+      return;
+    }
+    await this.auth.login(this.page, this.getCredentials());
+    await this.auth.capture(this.page);
+  }
+  // ─── App navigation ────────────────────────────────────────────────────────
+  /**
+   * Navigate to an application route.
+   *
+   * Handles auth injection (for cached sessions) and page navigation.
+   * @param route - URL path to navigate to (e.g. `/admin`).
+   */
+  async navigateToApp(route) {
+    if (this.sessionInjectedViaInitScript) {
+      await this.page.goto(route, { waitUntil: "domcontentloaded" });
+      return;
+    }
+    if (this.auth.hasValidAuth()) {
+      await this.page.goto("", { waitUntil: "domcontentloaded" });
+      await this.auth.inject(this.page);
+    }
+    await this.page.goto(route, {
+      waitUntil: "domcontentloaded"
+    });
+  }
+  /**
+   * Log in to encw and navigate to the **em-admin-ui** app.
+   * After this method returns, {@link page} is on the admin route.
+   */
+  async goToEmAdminUI() {
+    await this.navigateToApp("/admin");
+  }
+  /**
+   * Log in to encw and navigate to the **pipeline** app.
+   * After this method returns, {@link page} is on the pipeline route.
+   */
+  async goToPipeline() {
+    await this.navigateToApp("/pipeline");
+  }
+  // ─── Navigation helpers ──────────────────────────────────────────────────────
+  /**
+   * Navigate to a URL path.
+   * @param path    - Absolute URL path (e.g. `/admin/oneadmin/migrate`).
+   * @param options - Navigation options forwarded to Playwright.
+   */
+  async goto(path, options = {}) {
+    const {
+      waitUntil = "domcontentloaded",
+      timeout = DEFAULT_NAVIGATION_TIMEOUT
+    } = options;
+    await this.page.goto(path, { waitUntil, timeout });
+  }
+  /**
+   * Wait for an element to be visible on the page.
+   * @param selector - CSS selector.
+   * @param options  - Timeout and expected state.
+   * @param options.timeout
+   * @param options.state
+   */
+  async waitForElement(selector, options = {}) {
+    const { timeout = DEFAULT_ELEMENT_TIMEOUT, state = "visible" } = options;
+    await this.page.locator(selector).waitFor({ timeout, state });
+  }
+  /** Playwright's `expect` — exposed for assertions inside test methods. */
+  get expect() {
+    return expect;
+  }
+  // ─── Lifecycle hooks ─────────────────────────────────────────────────────────
+  /**
+   * Called once before all tests in a describe block.
+   * Override in a subclass to add one-time setup logic.
+   * Note: `this.page` is not available in this hook.
+   */
+  async beforeAll() {
+  }
+  /**
+   * Called once after all tests in a describe block.
+   * Override in a subclass to add one-time teardown logic.
+   * Note: `this.page` is not available in this hook.
+   */
+  async afterAll() {
+  }
+  /**
+   * Called before each test. Override in a subclass to add setup
+   * logic (e.g. `await this.goToEmAdminUI()`).
+   */
+  async beforeEach() {
+  }
+  /** Called after each test. Override to add teardown logic. */
+  async afterEach() {
+  }
+  // ─── Test runner ─────────────────────────────────────────────────────────────
+  static toReadableTitle(methodName) {
+    const withoutPrefix = methodName.replace(/^test/, "");
+    return withoutPrefix.replace(/([A-Z])/g, " $1").toLowerCase().trim();
+  }
+  /**
+   * Register all `test*` methods in this class with Playwright.
+   *
+   * Call once at module level after the class definition:
+   * ```ts
+   * class MySpec extends BaseTest { ... }
+   * MySpec.run();
+   * ```
+   */
+  static run() {
+    const TestClass = this;
+    const className = TestClass.name;
+    const proto = TestClass.prototype;
+    const testMethods = Object.getOwnPropertyNames(proto).filter(
+      (name) => name.startsWith("test") && typeof proto[name] === "function"
+    );
+    if (testMethods.length === 0) {
+      console.warn(
+        `No test methods found in ${className}. Test methods must start with 'test'.`
+      );
+      return;
+    }
+    test.describe(className, () => {
+      let instance;
+      test.beforeAll(async () => {
+        startCoverage();
+        instance = new TestClass();
+        if (typeof instance.beforeAll === "function") {
+          await instance.beforeAll();
+        }
+      });
+      test.beforeEach(async ({ page }) => {
+        instance = new TestClass();
+        instance.page = page;
+        instance.appFrame = page;
+        await instance.ensureAuth();
+        await trackPage(page);
+        if (typeof instance.beforeEach === "function") {
+          await instance.beforeEach();
+        }
+      });
+      test.afterEach(async () => {
+        if (typeof instance.afterEach === "function") {
+          await instance.afterEach();
+        }
+        await untrackPage(instance.page);
+      });
+      test.afterAll(async () => {
+        await stopCoverage();
+        if (typeof instance.afterAll === "function") {
+          await instance.afterAll();
+        }
+      });
+      for (const methodName of testMethods) {
+        const title = TestClass.toReadableTitle(methodName);
+        test(title, async () => {
+          await instance[methodName]();
+        });
+      }
+    });
+  }
+}
+export {
+  BaseTest
+};

package/dist/esm/index.js

@@ -1,3 +1,4 @@
+import { BaseTest } from "./base-test/index.js";
 import { BasePage } from "./base-page/index.js";
 import { AuthManager } from "./auth/index.js";
 import { PageSetup } from "./page-setup/index.js";
@@ -11,6 +12,7 @@ import {
 export {
   AuthManager,
   BasePage,
+  BaseTest,
   PageSetup,
   createBrowserStackConfig,
   createPlaywrightConfig,

package/dist/types/lib/base-test/index.d.ts

@@ -0,0 +1,126 @@
+import { Page, Expect } from '@playwright/test';
+import { Credentials, GotoOptions } from '../types.js';
+/**
+ * Base class for Playwright test specs that run against
+ * apps hosted inside the encw (Encompass Web) shell.
+ *
+ * **Responsibilities (delegated to focused collaborators):**
+ * - {@link AuthManager} — encw login + session-storage caching
+ * - {@link PageSetup} — init scripts, overlay suppression, route blocks
+ *
+ * **Usage pattern:**
+ * ```ts
+ * class MySpec extends BaseTest {
+ *   async beforeEach() {
+ *     await this.goToEmAdminUI();
+ *   }
+ *   async testSomething() { ... }
+ * }
+ * MySpec.run();
+ * ```
+ */
+export declare class BaseTest {
+    private readonly auth;
+    private readonly pageSetup;
+    /** Whether sessionStorage was injected via `addInitScript`. */
+    private sessionInjectedViaInitScript;
+    /** Top-level Playwright page. Used for navigation, auth, and interaction. */
+    protected page: Page;
+    /**
+     * Alias for {@link page}. Available after calling a navigation
+     * method such as {@link goToEmAdminUI}. Pass to page objects
+     * via a callback: `() => this.appFrame`.
+     */
+    protected appFrame: Page;
+    /**
+     * Return the credentials used for the encw login flow.
+     *
+     * Reads from environment variables with local-development defaults:
+     *
+     * | Variable            | Default       |
+     * |---------------------|---------------|
+     * | `ENCW_INSTANCE_ID`  | `BE11226875`  |
+     * | `ENCW_USER_ID`      | `admin`       |
+     * | `ENCW_PASSWORD`     | `Password#!23` |
+     *
+     * Override this method to supply different credentials.
+     */
+    protected getCredentials(): Credentials;
+    /**
+     * Ensure the browser has a valid encw session.
+     *
+     * - First test in a worker: performs the full login flow and
+     *   snapshots session storage.
+     * - Subsequent tests: session is injected during
+     *   {@link navigateToApp}.
+     *
+     * This method does **not** navigate to any app route.
+     */
+    ensureAuth(): Promise<void>;
+    /**
+     * Navigate to an application route.
+     *
+     * Handles auth injection (for cached sessions) and page navigation.
+     * @param route - URL path to navigate to (e.g. `/admin`).
+     */
+    protected navigateToApp(route: string): Promise<void>;
+    /**
+     * Log in to encw and navigate to the **em-admin-ui** app.
+     * After this method returns, {@link page} is on the admin route.
+     */
+    protected goToEmAdminUI(): Promise<void>;
+    /**
+     * Log in to encw and navigate to the **pipeline** app.
+     * After this method returns, {@link page} is on the pipeline route.
+     */
+    protected goToPipeline(): Promise<void>;
+    /**
+     * Navigate to a URL path.
+     * @param path    - Absolute URL path (e.g. `/admin/oneadmin/migrate`).
+     * @param options - Navigation options forwarded to Playwright.
+     */
+    protected goto(path: string, options?: GotoOptions): Promise<void>;
+    /**
+     * Wait for an element to be visible on the page.
+     * @param selector - CSS selector.
+     * @param options  - Timeout and expected state.
+     * @param options.timeout
+     * @param options.state
+     */
+    protected waitForElement(selector: string, options?: {
+        timeout?: number;
+        state?: 'visible' | 'attached' | 'hidden';
+    }): Promise<void>;
+    /** Playwright's `expect` — exposed for assertions inside test methods. */
+    protected get expect(): Expect;
+    /**
+     * Called once before all tests in a describe block.
+     * Override in a subclass to add one-time setup logic.
+     * Note: `this.page` is not available in this hook.
+     */
+    beforeAll(): Promise<void>;
+    /**
+     * Called once after all tests in a describe block.
+     * Override in a subclass to add one-time teardown logic.
+     * Note: `this.page` is not available in this hook.
+     */
+    afterAll(): Promise<void>;
+    /**
+     * Called before each test. Override in a subclass to add setup
+     * logic (e.g. `await this.goToEmAdminUI()`).
+     */
+    beforeEach(): Promise<void>;
+    /** Called after each test. Override to add teardown logic. */
+    afterEach(): Promise<void>;
+    private static toReadableTitle;
+    /**
+     * Register all `test*` methods in this class with Playwright.
+     *
+     * Call once at module level after the class definition:
+     * ```ts
+     * class MySpec extends BaseTest { ... }
+     * MySpec.run();
+     * ```
+     */
+    static run(): void;
+}

package/dist/types/lib/index.d.ts

@@ -1,3 +1,4 @@
+export { BaseTest } from './base-test/index.js';
 export { BasePage } from './base-page/index.js';
 export { AuthManager } from './auth/index.js';
 export { PageSetup } from './page-setup/index.js';