testdriverai 7.0.0 → 7.1.1

package/{testdriver/acceptance-sdk → test/testdriver}/hover-text.test.mjs

@@ -3,29 +3,15 @@
  * Converted from: testdriver/acceptance/hover-text.yaml
  */
 
-import { afterEach, beforeEach, describe, expect, it } from "vitest";
-import {
-  createTestClient,
-  setupTest,
-  teardownTest,
-} from "./setup/testHelpers.mjs";
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../lib/vitest/hooks.mjs";
 
 describe("Hover Text Test", () => {
-  let testdriver;
+  it("should click Sign In and verify error message", async (context) => {
+    const testdriver = TestDriver(context, { headless: true, newSandbox: true, cacheKey: 'hover-text-test' });
+    await testdriver.provision.chrome({ url: 'http://testdriver-sandbox.vercel.app/login' });
 
-  beforeEach(async (context) => {
-    testdriver = createTestClient({ task: context.task });
-
-    await setupTest(testdriver);
-  });
-
-  afterEach(async (context) => {
-    await teardownTest(testdriver, { task: context.task });
-  });
-
-  it("should click Sign In and verify error message", async () => {
     // Click on Sign In button using new find() API
-    await testdriver.focusApplication("Google Chrome");
 
     const signInButton = await testdriver.find(
       "Sign In, black button below the password field",

package/{testdriver/acceptance-sdk → test/testdriver}/match-image.test.mjs

@@ -5,32 +5,20 @@
 
 import path, { dirname } from "path";
 import { fileURLToPath } from "url";
-import { afterEach, beforeEach, describe, expect, it } from "vitest";
-import {
-  createTestClient,
-  performLogin,
-  setupTest,
-  teardownTest,
-} from "./setup/testHelpers.mjs";
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../lib/vitest/hooks.mjs";
+import { performLogin } from "./setup/testHelpers.mjs";
 
 // Get the directory of the current module
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
 describe("Match Image Test", () => {
-  let testdriver;
+  it("should match shopping cart image and verify empty cart", async (context) => {
+    const testdriver = TestDriver(context, { headless: true });
+    await testdriver.provision.chrome({ url: 'http://testdriver-sandbox.vercel.app/login' });
 
-  beforeEach(async (context) => {
-    testdriver = createTestClient({ task: context.task });
-
-    await setupTest(testdriver);
-  });
-
-  afterEach(async (context) => {
-    await teardownTest(testdriver, { task: context.task });
-  });
-
-  it("should match shopping cart image and verify empty cart", async () => {
+    //
     // Perform login first
     await performLogin(testdriver);
 

package/{testdriver/acceptance-sdk → test/testdriver}/press-keys.test.mjs

@@ -3,28 +3,14 @@
  * Converted from: testdriver/acceptance/press-keys.yaml
  */
 
-import { afterEach, beforeEach, describe, expect, it } from "vitest";
-import {
-  createTestClient,
-  setupTest,
-  teardownTest,
-} from "./setup/testHelpers.mjs";
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../lib/vitest/hooks.mjs";
 
 describe("Press Keys Test", () => {
-  let testdriver;
+  it("should create tabs and navigate using keyboard shortcuts", async (context) => {
+    const testdriver = TestDriver(context, { headless: true });
+    await testdriver.provision.chrome({ url: 'http://testdriver-sandbox.vercel.app/login' });
 
-  beforeEach(async (context) => {
-    testdriver = createTestClient({ task: context.task });
-
-    await setupTest(testdriver);
-  });
-
-  afterEach(async (context) => {
-    await teardownTest(testdriver, { task: context.task });
-  });
-
-  it("should create tabs and navigate using keyboard shortcuts", async () => {
-    await testdriver.focusApplication("Google Chrome");
     const signInButton = await testdriver.find(
       "Sign In, black button below the password field",
     );

package/{testdriver/acceptance-sdk → test/testdriver}/prompt.test.mjs

@@ -3,27 +3,15 @@
  * Converted from: testdriver/acceptance/prompt.yaml
  */
 
-import { afterEach, beforeEach, describe, expect, it } from "vitest";
-import {
-  createTestClient,
-  setupTest,
-  teardownTest,
-} from "./setup/testHelpers.mjs";
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../lib/vitest/hooks.mjs";
 
 describe.skip("Prompt Test", () => {
-  let testdriver;
+  it("should execute AI-driven prompts", async (context) => {
+    const testdriver = TestDriver(context, { headless: true });
+    await testdriver.provision.chrome({ url: 'http://testdriver-sandbox.vercel.app/login' });
 
-  beforeEach(async (context) => {
-    testdriver = createTestClient({ task: context.task });
-
-    await setupTest(testdriver);
-  });
-
-  afterEach(async (context) => {
-    await teardownTest(testdriver, { task: context.task });
-  });
-
-  it("should execute AI-driven prompts", async () => {
+    //
     // Note: The SDK doesn't have a direct equivalent to YAML prompts without commands.
     // This would typically be handled by the AI agent interpreting natural language.
     // For SDK usage, you need to use explicit commands.
@@ -37,7 +25,7 @@ describe.skip("Prompt Test", () => {
     // This test is skipped as it requires explicit SDK implementation
     // You would need to implement these as explicit SDK calls
 
-    await testdriver.ai("log in");
+    await testdriver.act("log in");
 
     const result = await testdriver.assert("the testdriver sandbox is visible");
     expect(result).toBeTruthy();

package/{testdriver/acceptance-sdk → test/testdriver}/scroll-keyboard.test.mjs

@@ -3,29 +3,15 @@
  * Converted from: testdriver/acceptance/scroll-keyboard.yaml
  */
 
-import { afterEach, beforeEach, describe, expect, it } from "vitest";
-import {
-  createTestClient,
-  setupTest,
-  teardownTest,
-} from "./setup/testHelpers.mjs";
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../lib/vitest/hooks.mjs";
 
 describe("Scroll Keyboard Test", () => {
-  let testdriver;
+  it("should navigate to webhamster.com and scroll with keyboard", async (context) => {
+    const testdriver = TestDriver(context, { headless: true });
+    await testdriver.provision.chrome({ url: 'http://testdriver-sandbox.vercel.app/login' });
 
-  beforeEach(async (context) => {
-    testdriver = createTestClient({
-      task: context.task,
-      redrawThreshold: 0.5, // Higher threshold for scroll test
-    });
-    await setupTest(testdriver);
-  });
-
-  afterEach(async (context) => {
-    await teardownTest(testdriver, { task: context.task });
-  });
-
-  it("should navigate to webhamster.com and scroll with keyboard", async () => {
+    //
     // Navigate to https://www.webhamster.com/
     await testdriver.focusApplication("Google Chrome");
     const urlBar = await testdriver.find(

package/{testdriver/acceptance-sdk → test/testdriver}/scroll-until-image.test.mjs

@@ -3,27 +3,15 @@
  * Converted from: testdriver/acceptance/scroll-until-image.yaml
  */
 
-import { afterEach, beforeEach, describe, expect, it } from "vitest";
-import {
-  createTestClient,
-  setupTest,
-  teardownTest,
-} from "./setup/testHelpers.mjs";
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../lib/vitest/hooks.mjs";
 
 describe("Scroll Until Image Test", () => {
-  let testdriver;
+  it("should scroll until brown colored house image appears", async (context) => {
+    const testdriver = TestDriver(context, { headless: true });
+    await testdriver.provision.chrome({ url: 'http://testdriver-sandbox.vercel.app/login' });
 
-  beforeEach(async (context) => {
-    testdriver = createTestClient({ task: context.task });
-
-    await setupTest(testdriver);
-  });
-
-  afterEach(async (context) => {
-    await teardownTest(testdriver, { task: context.task });
-  });
-
-  it("should scroll until brown colored house image appears", async () => {
+    //
     // Navigate to Wikipedia page
     await testdriver.pressKeys(["ctrl", "l"]);
     await testdriver.type("https://en.wikipedia.org/wiki/Leonardo_da_Vinci");

package/test/testdriver/scroll-until-text.test.mjs

@@ -0,0 +1,28 @@
+/**
+ * TestDriver SDK - Scroll Until Text Test (Vitest)
+ * Converted from: testdriver/acceptance/scroll-until-text.yaml
+ */
+
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../lib/vitest/hooks.mjs";
+import { performLogin } from "./setup/testHelpers.mjs";
+
+describe("Scroll Until Text Test", () => {
+  it('should scroll until "testdriver socks" appears', async (context) => {
+    const testdriver = TestDriver(context, { headless: true });
+    await testdriver.provision.chrome({ url: 'http://testdriver-sandbox.vercel.app/login' });
+
+    //
+    // Perform login first
+    await performLogin(testdriver);
+
+    // Scroll until text appears
+    await testdriver.focusApplication("Google Chrome");
+    await testdriver.scrollUntilText({ text: "testdriver socks", direction: "down" });
+
+    // Assert testdriver socks appears on screen
+    await testdriver.focusApplication("Google Chrome");
+    const result = await testdriver.assert("TestDriver Socks appears on screen");
+    expect(result).toBeTruthy();
+  });
+});

package/{testdriver/acceptance-sdk → test/testdriver}/scroll.test.mjs

@@ -1,33 +1,24 @@
 /**
  * TestDriver SDK - Scroll Test (Vitest)
  * Converted from: testdriver/acceptance/scroll.yaml
+ * 
+ * UPDATED: Now using chrome preset for automatic setup
  */
 
-import { afterEach, beforeEach, describe, expect, it } from "vitest";
-import {
-  createTestClient,
-  setupTest,
-  teardownTest,
-} from "./setup/testHelpers.mjs";
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../lib/vitest/hooks.mjs";
 
 describe("Scroll Test", () => {
-  let testdriver;
+  it("should navigate and scroll down the page", async (context) => {
+    const testdriver = TestDriver(context, { headless: true });
+    await testdriver.provision.chrome({ url: 'http://testdriver-sandbox.vercel.app/login' });
 
-  beforeEach(async (context) => {
-    testdriver = createTestClient({ task: context.task });
+    // Give Chrome a moment to fully render the UI
+    await new Promise(resolve => setTimeout(resolve, 2000));
 
-    await setupTest(testdriver);
-  });
-
-  afterEach(async (context) => {
-    await teardownTest(testdriver, { task: context.task });
-  });
-
-  it("should navigate and scroll down the page", async () => {
-    // Navigate to webhamster.com
-    await testdriver.focusApplication("Google Chrome");
+    // Navigate to webhamster.com - just look for the domain, not the full path
     const urlBar = await testdriver.find(
-      "testdriver-sandbox.vercel.app/login, the URL in the omnibox showing the current page",
+      "testdriver-sandbox.vercel.app, the URL in the address bar",
     );
     await urlBar.click();
     await testdriver.pressKeys(["ctrl", "a"]);
@@ -44,7 +35,7 @@ describe("Scroll Test", () => {
     await testdriver.scroll("down", 1000);
 
     // Assert page is scrolled
-    const result = await testdriver.assert("the page is scrolled down");
+    const result = await testdriver.assert("the page is scrolled down, the hamster dance heading is not visible on the page");
     expect(result).toBeTruthy();
   });
 });

package/test/testdriver/setup/lifecycleHelpers.mjs

@@ -0,0 +1,262 @@
+/**
+ * Lifecycle Helpers
+ * Shared lifecycle hook functions (prerun, postrun)
+ * 
+ * LEGACY: These helpers are thin wrappers around the new Dashcam class.
+ * For new code, prefer using the Dashcam class directly:
+ * 
+ * import { Dashcam } from 'testdriverai/core';
+ * const dashcam = new Dashcam(client);
+ * await dashcam.auth();
+ */
+
+import Dashcam from '../../../lib/core/Dashcam.js';
+
+// Module-level cache to maintain Dashcam instance state across helper calls
+const dashcamInstances = new WeakMap();
+
+/**
+ * Get or create Dashcam instance for a client
+ * @private
+ * @param {TestDriver} client 
+ * @param {object} options 
+ * @returns {Dashcam}
+ */
+function getDashcam(client, options = {}) {
+  if (!dashcamInstances.has(client)) {
+    dashcamInstances.set(client, new Dashcam(client, options));
+  }
+  return dashcamInstances.get(client);
+}
+
+/**
+ * Authenticate dashcam with API key
+ * @deprecated Use `new Dashcam(client)` and `dashcam.auth()` instead
+ * @param {TestDriver} client - TestDriver client
+ * @param {string} apiKey - Dashcam API key (default: 4e93d8bf-3886-4d26-a144-116c4063522d)
+ */
+export async function authDashcam(
+  client,
+  apiKey = "4e93d8bf-3886-4d26-a144-116c4063522d",
+) {
+  const dashcam = getDashcam(client, { apiKey });
+  await dashcam.auth();
+}
+
+/**
+ * Add log file tracking to dashcam
+ * @deprecated Use `new Dashcam(client)` and `dashcam.addFileLog()` instead
+ * @param {TestDriver} client - TestDriver client
+ * @param {string} logName - Name for the log in dashcam (default: "TestDriver Log")
+ */
+export async function addDashcamLog(client, logName = "TestDriver Log") {
+  const dashcam = getDashcam(client);
+  const logPath = client.os === "windows" 
+    ? "C:\\Users\\testdriver\\Documents\\testdriver.log"
+    : "/tmp/testdriver.log";
+  
+  // Create log file first
+  if (client.os === "windows") {
+    await client.exec("pwsh", `New-Item -ItemType File -Path "${logPath}" -Force`, 10000, true);
+  } else {
+    await client.exec("sh", `touch ${logPath}`, 10000, true);
+  }
+  
+  await dashcam.addFileLog(logPath, logName);
+}
+
+/**
+ * Start dashcam recording
+ * @deprecated Use `new Dashcam(client)` and `dashcam.start()` instead
+ * @param {TestDriver} client - TestDriver client
+ */
+export async function startDashcam(client) {
+  const dashcam = getDashcam(client);
+  await dashcam.start();
+}
+
+/**
+ * Stop dashcam recording and retrieve URL
+ * @deprecated Use `new Dashcam(client)` and `dashcam.stop()` instead
+ * @param {TestDriver} client - TestDriver client
+ * @returns {Promise<string|null>} Dashcam URL if available
+ */
+export async function stopDashcam(client) {
+  console.log("🎬 Stopping dashcam and retrieving URL...");
+  const dashcam = getDashcam(client);
+  const url = await dashcam.stop();
+  
+  if (url) {
+    console.log("✅ Found dashcam URL:", url);
+    console.log("🎥 Dashcam URL:", url);
+  } else {
+    console.warn("⚠️  No replay URL found in dashcam output");
+  }
+  
+  return url;
+}
+
+/**
+ * Launch Chrome browser with guest mode
+ * @param {TestDriver} client - TestDriver client
+ * @param {string} url - URL to open (default: https://testdriver-sandbox.vercel.app/)
+ */
+export async function launchChrome(
+  client,
+  url = "http://testdriver-sandbox.vercel.app/",
+) {
+  const shell = client.os === "windows" ? "pwsh" : "sh";
+
+  if (client.os === "windows") {
+    await client.exec(
+      "pwsh",
+      `Start-Process "C:/Program Files/Google/Chrome/Application/chrome.exe" -ArgumentList "--start-maximized", "--guest", "${url}"`,
+      30000,
+    );
+  } else {
+    await client.exec(
+      shell,
+      `google-chrome --start-maximized --disable-fre --no-default-browser-check --no-first-run --guest "${url}" >/dev/null 2>&1 &`,
+      30000,
+    );
+  }
+}
+
+/**
+ * Launch Chrome for Testing browser with guest mode
+ * @param {TestDriver} client - TestDriver client
+ * @param {string} url - URL to open (default: https://testdriver-sandbox.vercel.app/)
+ */
+export async function launchChromeForTesting(
+  client,
+  url = "http://testdriver-sandbox.vercel.app/",
+) {
+  const shell = client.os === "windows" ? "pwsh" : "sh";
+
+  if (client.os === "windows") {
+    // Windows Chrome for Testing path would need to be determined
+    // For now, fallback to regular Chrome on Windows
+    await client.exec(
+      "pwsh",
+      `Start-Process "C:/Program Files/Google/Chrome/Application/chrome.exe" -ArgumentList "--start-maximized", "--guest", "${url}"`,
+      30000,
+    );
+  } else {
+    await client.exec(
+      shell,
+      `chrome-for-testing --start-maximized --disable-fre --no-default-browser-check --no-first-run --guest "${url}" >/dev/null 2>&1 &`,
+      30000,
+    );
+  }
+}
+
+/**
+ * Launch Chrome for Testing with a Chrome extension loaded
+ * @param {TestDriver} client - TestDriver client
+ * @param {string} extensionId - Chrome Web Store extension ID (e.g., "cjpalhdlnbpafiamejdnhcphjbkeiagm" for uBlock Origin)
+ * @param {string} url - URL to open (default: https://testdriver-sandbox.vercel.app/)
+ * @example
+ * // Launch with uBlock Origin extension
+ * await launchChromeExtension(client, "cjpalhdlnbpafiamejdnhcphjbkeiagm");
+ * 
+ * // Launch with multiple extensions (comma-separated)
+ * await launchChromeExtension(client, "cjpalhdlnbpafiamejdnhcphjbkeiagm,nngceckbapebfimnlniiiahkandclblb");
+ */
+export async function launchChromeExtension(
+  client,
+  extensionId,
+  url = "http://testdriver-sandbox.vercel.app/",
+) {
+  const shell = client.os === "windows" ? "pwsh" : "sh";
+
+  if (client.os === "windows") {
+    // Windows Chrome for Testing path would need to be determined
+    // For now, fallback to regular Chrome on Windows
+    await client.exec(
+      "pwsh",
+      `Start-Process "C:/Program Files/Google/Chrome/Application/chrome.exe" -ArgumentList "--start-maximized", "--load-extension=${extensionId}", "${url}"`,
+      30000,
+    );
+  } else {
+    await client.exec(
+      shell,
+      `chrome-for-testing --start-maximized --disable-fre --no-default-browser-check --no-first-run --load-extension=${extensionId} "${url}" >/dev/null 2>&1 &`,
+      30000,
+    );
+  }
+}
+
+/**
+ * Wait for page to load by polling for text
+ * @param {TestDriver} client - TestDriver client
+ * @param {string} text - Text to wait for
+ * @param {number} maxAttempts - Maximum number of attempts (default: 60)
+ * @param {number} pollInterval - Interval between polls in ms (default: 5000)
+ */
+export async function waitForPage(
+  client,
+  text,
+  maxAttempts = 60,
+  pollInterval = 5000,
+) {
+  console.log("Waiting for page to load, looking for text:", text);
+  let element;
+  for (let i = 0; i < maxAttempts; i++) {
+    element = await client.find(text);
+    if (element.found()) break;
+    await new Promise((resolve) => setTimeout(resolve, pollInterval));
+  }
+}
+
+/**
+ * Run prerun lifecycle hooks
+ * Implements lifecycle/prerun.yaml functionality
+ * @param {TestDriver} client - TestDriver client
+ */
+export async function runPrerun(client) {
+  await authDashcam(client);
+  await addDashcamLog(client);
+  await startDashcam(client);
+  await launchChrome(client);
+  await waitForPage(client, "TestDriver.ai Sandbox");
+}
+
+/**
+ * Run prerun lifecycle hooks with Chrome for Testing
+ * Implements lifecycle/prerun.yaml functionality using Chrome for Testing
+ * @param {TestDriver} client - TestDriver client
+ */
+export async function runPrerunChromeForTesting(client) {
+  await authDashcam(client);
+  await addDashcamLog(client);
+  await startDashcam(client);
+  await launchChromeForTesting(client);
+  await waitForPage(client, "TestDriver.ai Sandbox");
+}
+
+/**
+ * Run prerun lifecycle hooks with Chrome extension loaded
+ * Implements lifecycle/prerun.yaml functionality with a Chrome extension
+ * @param {TestDriver} client - TestDriver client
+ * @param {string} extensionId - Chrome Web Store extension ID to load
+ * @example
+ * // Launch with uBlock Origin extension
+ * await runPrerunChromeExtension(client, "cjpalhdlnbpafiamejdnhcphjbkeiagm");
+ */
+export async function runPrerunChromeExtension(client, extensionId) {
+  await authDashcam(client);
+  await addDashcamLog(client);
+  await startDashcam(client);
+  await launchChromeExtension(client, extensionId);
+  await waitForPage(client, "TestDriver.ai Sandbox");
+}
+
+/**
+ * Run postrun lifecycle hooks
+ * Implements lifecycle/postrun.yaml functionality
+ * @param {TestDriver} client - TestDriver client
+ * @returns {Promise<string|null>} Dashcam URL if available
+ */
+export async function runPostrun(client) {
+  return await stopDashcam(client);
+}

package/{testdriver/acceptance-sdk → test/testdriver}/setup/testHelpers.mjs

@@ -11,26 +11,26 @@ import path, { dirname } from "path";
 import { fileURLToPath } from "url";
 import TestDriver from "../../../sdk.js";
 import {
-  addDashcamLog,
-  authDashcam,
-  launchChrome,
-  runPostrun,
-  runPrerun,
-  startDashcam,
-  stopDashcam,
-  waitForPage,
+    addDashcamLog,
+    authDashcam,
+    launchChrome,
+    runPostrun,
+    runPrerun,
+    startDashcam,
+    stopDashcam,
+    waitForPage,
 } from "./lifecycleHelpers.mjs";
 
 // Re-export lifecycle helpers for backward compatibility
 export {
-  addDashcamLog,
-  authDashcam,
-  launchChrome,
-  runPostrun,
-  runPrerun,
-  startDashcam,
-  stopDashcam,
-  waitForPage
+    addDashcamLog,
+    authDashcam,
+    launchChrome,
+    runPostrun,
+    runPrerun,
+    startDashcam,
+    stopDashcam,
+    waitForPage
 };
 
 // Get the directory of the current module
@@ -264,7 +264,7 @@ export function createTestClient(options = {}) {
     apiKey: process.env.TD_API_KEY,
     apiRoot: process.env.TD_API_ROOT || "https://testdriver-api.onrender.com",
     // headless: false,
-    // newSandbox: true, 
+    newSandbox: true, 
     // ip: '18.217.194.23'
     // ...clientOptions,
     // cache: false,
@@ -522,7 +522,11 @@ export async function teardownTest(client, options = {}) {
         }
 
         // Note: Duration is calculated by Vitest and passed via result.duration
-        // We don't need to track start time ourselves
+        // We include it in the test result file so the reporter can use it
+
+        // Get duration from Vitest result
+        const result = options.task.result?.();
+        const duration = result?.duration || 0;
 
         // Write test result with dashcam URL, platform, and metadata
         const testResult = {
@@ -536,6 +540,7 @@ export async function teardownTest(client, options = {}) {
             : null,
           platform: client.os, // Include platform from SDK client (source of truth)
           timestamp: Date.now(),
+          duration: duration, // Include duration from Vitest
         };
 
         fs.writeFileSync(testResultFile, JSON.stringify(testResult, null, 2));
@@ -614,9 +619,9 @@ export async function performLogin(
   await usernameField.click();
   await client.type(username);
 
-  // Enter password
+  // Enter password (marked as secret so it's not logged or stored)
   await client.pressKeys(["tab"]);
-  await client.type(password);
+  await client.type(password, { secret: true });
 
   // Submit form
   await client.pressKeys(["tab"]);