testdriverai 6.2.2 → 7.1.0

package/testdriver/acceptance-sdk/formatted-logging.test.mjs

@@ -0,0 +1,26 @@
+/**
+ * TestDriver SDK - Formatted Logging Demo
+ * Demonstrates nice Vitest-style formatted logs for Dashcam replay
+ */
+
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../src/vitest/hooks.mjs";
+
+describe("Formatted Logging Test", () => {
+  it("should demonstrate formatted logs in dashcam replay", async (context) => {
+    const testdriver = TestDriver(context, { headless: true });
+    await testdriver.provision.chrome({ url: 'http://testdriver-sandbox.vercel.app/login' });
+
+    // Find and click - logs will be nicely formatted
+    const signInButton = await testdriver.find(
+      "Sign In, black button below the password field",
+    );
+    await signInButton.click();
+
+    // Assert - logs will show pass/fail with nice formatting
+    const result = await testdriver.assert(
+      "an error shows that fields are required",
+    );
+    expect(result).toBeTruthy();
+  });
+});

package/testdriver/acceptance-sdk/hooks-example.test.mjs

@@ -0,0 +1,38 @@
+/**
+ * TestDriver Hooks API Demo
+ * Demonstrates the new React-style hooks for Vitest
+ * 
+ * This is the SIMPLEST way to use TestDriver with Vitest!
+ */
+
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../src/vitest/hooks.mjs";
+
+describe("Hooks API Demo", () => {
+  it("should use hooks for automatic lifecycle management", async (context) => {
+    // ✨ One line gets you TestDriver + Dashcam with full auto-lifecycle!
+    const testdriver = TestDriver(context, { headless: true });
+    await testdriver.provision.chrome({ url: 'http://testdriver-sandbox.vercel.app/login' });
+    
+    // Everything is automatic:
+    // - Sandbox connection ✅
+    // - Dashcam recording ✅
+    // - Chrome launch ✅
+    // - Recording stop ✅
+    // - Cleanup ✅
+    
+    await testdriver.focusApplication("Google Chrome");
+
+    const signInButton = await testdriver.find(
+      "Sign In, black button below the password field",
+    );
+    await signInButton.click();
+
+    const result = await testdriver.assert(
+      "an error shows that fields are required",
+    );
+    expect(result).toBeTruthy();
+    
+    // That's it! Dashcam URL automatically registered with the test run
+  });
+});

package/testdriver/acceptance-sdk/hover-image.test.mjs

@@ -0,0 +1,34 @@
+/**
+ * TestDriver SDK - Hover Image Test (Vitest)
+ * Converted from: testdriver/acceptance/hover-image.yaml
+ */
+
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../src/vitest/hooks.mjs";
+import { performLogin } from "./setup/testHelpers.mjs";
+
+describe("Hover Image Test", () => {
+  it("should click on shopping cart icon and verify empty cart", async (context) => {
+    const testdriver = TestDriver(context, { headless: true });
+    
+    // provision.chrome() automatically calls ready() and starts dashcam
+    await testdriver.provision.chrome({
+      url: 'http://testdriver-sandbox.vercel.app/login',
+    });
+
+    // Perform login first
+    await performLogin(testdriver);
+
+    // Click on the shopping cart icon
+    await testdriver.focusApplication("Google Chrome");
+    const cartIcon = await testdriver.find(
+      "shopping cart icon next to the Cart text in the top right corner",
+    );
+
+    await cartIcon.click();
+
+    // Assert that you see an empty shopping cart
+    const result = await testdriver.assert("Your cart is empty");
+    expect(result).toBeTruthy();
+  });
+});

package/testdriver/acceptance-sdk/hover-text-with-description.test.mjs

@@ -0,0 +1,38 @@
+/**
+ * TestDriver SDK - Hover Text With Description Test (Vitest)
+ * Converted from: testdriver/acceptance/hover-text-with-description.yaml
+ */
+
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../src/vitest/hooks.mjs";
+import { performLogin } from "./setup/testHelpers.mjs";
+
+describe("Hover Text With Description Test", () => {
+  it("should add TestDriver Hat to cart and verify", 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);
+
+    // Click on "Add to Cart" under TestDriver Hat
+    await testdriver.focusApplication("Google Chrome");
+    const addToCartButton = await testdriver.find(
+      "Add to Cart, add to cart button under TestDriver Hat",
+    );
+    await addToCartButton.click();
+
+    // Click on the cart
+    await testdriver.focusApplication("Google Chrome");
+    const cartButton = await testdriver.find(
+      "Cart, cart button in the top right corner",
+    );
+    await cartButton.click();
+
+    // Assert the TestDriver Hat is in the cart
+    await testdriver.focusApplication("Google Chrome");
+    const result = await testdriver.assert("TestDriver Hat is in the cart");
+    expect(result).toBeTruthy();
+  });
+});

package/testdriver/acceptance-sdk/hover-text.test.mjs

@@ -0,0 +1,27 @@
+/**
+ * TestDriver SDK - Hover Text Test (Vitest)
+ * Converted from: testdriver/acceptance/hover-text.yaml
+ */
+
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../src/vitest/hooks.mjs";
+
+describe("Hover Text Test", () => {
+  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' });
+
+    // Click on Sign In button using new find() API
+
+    const signInButton = await testdriver.find(
+      "Sign In, black button below the password field",
+    );
+    await signInButton.click();
+
+    // Assert that an error shows that fields are required
+    const result = await testdriver.assert(
+      "an error shows that fields are required",
+    );
+    expect(result).toBeTruthy();
+  });
+});

package/testdriver/acceptance-sdk/match-image.test.mjs

@@ -0,0 +1,36 @@
+/**
+ * TestDriver SDK - Match Image Test (Vitest)
+ * Converted from: testdriver/acceptance/match-image.yaml
+ */
+
+import path, { dirname } from "path";
+import { fileURLToPath } from "url";
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../src/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", () => {
+  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' });
+
+    //
+    // Perform login first
+    await performLogin(testdriver);
+
+    // Match and click the shopping cart icon
+    const cartImagePath = path.resolve(
+      __dirname,
+      "../../_testdriver/acceptance/screenshots/cart.png",
+    );
+    await testdriver.matchImage(cartImagePath, "click");
+
+    // Assert that you see an empty shopping cart
+    const result = await testdriver.assert("Your cart is empty");
+    expect(result).toBeTruthy();
+  });
+});

package/testdriver/acceptance-sdk/presets-example.test.mjs

@@ -0,0 +1,87 @@
+/**
+ * Examples demonstrating TestDriver Presets
+ * 
+ * Presets provide pre-configured setups for common applications,
+ * reducing boilerplate and making tests easier to write.
+ */
+
+import { test } from 'vitest';
+import { chromePreset, createPreset, electronPreset, vscodePreset } from '../../src/presets/index.mjs';
+
+test('Chrome preset - simple navigation', async (context) => {
+  const { browser } = await chromePreset(context, {
+    url: 'http://testdriver-sandbox.vercel.app/',
+  });
+
+  // Browser is already open and focused on the URL
+  const result = await browser.find('main heading text');
+  console.log('Found heading:', result);
+}, 60000);
+
+test('Chrome preset - with custom options', async (context) => {
+  const { browser, dashcam } = await chromePreset(context, {
+    url: 'https://google.com',
+    maximized: false,
+    guest: false,
+    dashcam: true, // Dashcam auto-starts and auto-stops
+  });
+
+  await browser.find('search box').type('testdriverai');
+  console.log('Dashcam recording:', dashcam.isRecording());
+}, 60000);
+
+test.skip('VS Code preset - basic usage', async (context) => {
+  const { vscode } = await vscodePreset(context, {
+    workspace: '/tmp/test-project',
+  });
+
+  // VS Code is already open with the workspace loaded
+  await vscode.find('File menu').click();
+  await vscode.find('New File').click();
+}, 60000);
+
+test.skip('VS Code preset - with extensions', async (context) => {
+  const { vscode } = await vscodePreset(context, {
+    workspace: '/tmp/test-project',
+    extensions: ['ms-python.python'],
+    dashcam: true,
+  });
+
+  // Extensions are pre-installed, dashcam auto-recording
+  await vscode.find('Python extension').click();
+}, 120000);
+
+test.skip('Custom preset - Electron app', async (context) => {
+  const { app } = await electronPreset(context, {
+    appPath: '/path/to/electron/app',
+    args: ['--enable-logging'],
+  });
+
+  await app.find('main window').click();
+}, 60000);
+
+test.skip('Custom preset - create your own', async (context) => {
+  // Create a custom preset for your application
+  const firefoxPreset = createPreset({
+    name: 'Firefox Browser',
+    defaults: { os: 'linux', dashcam: true },
+    async setup(context, client, dashcam, options) {
+      const { url } = options;
+      
+      // Launch Firefox
+      await client.exec('sh', `firefox "${url}" >/dev/null 2>&1 &`, 30000);
+      await client.focusApplication('Firefox');
+      
+      return {
+        browser: client,
+      };
+    },
+  });
+
+  // Use your custom preset
+  const { browser } = await firefoxPreset(context, {
+    url: 'https://example.com',
+  });
+
+  await browser.find('page content').click();
+}, 60000);

package/testdriver/acceptance-sdk/press-keys.test.mjs

@@ -0,0 +1,50 @@
+/**
+ * TestDriver SDK - Press Keys Test (Vitest)
+ * Converted from: testdriver/acceptance/press-keys.yaml
+ */
+
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../src/vitest/hooks.mjs";
+
+describe("Press Keys Test", () => {
+  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' });
+
+    const signInButton = await testdriver.find(
+      "Sign In, black button below the password field",
+    );
+    await signInButton.click();
+
+    // Open new tab
+    await testdriver.pressKeys(["ctrl", "t"]);
+
+    // Poll for "Learn more" to appear
+    let learnMore = await testdriver.find("Learn more");
+    for (let i = 0; i < 10; i++) {
+      learnMore = await learnMore.find();
+      if (learnMore.found()) break;
+      await new Promise((resolve) => setTimeout(resolve, 500));
+    }
+
+    // Open DevTools
+    await testdriver.pressKeys(["ctrl", "shift", "i"]);
+
+    // Poll for "Elements" to appear
+    let elements = await testdriver.find("Elements");
+    for (let i = 0; i < 10; i++) {
+      elements = await elements.find();
+      if (elements.found()) break;
+      await new Promise((resolve) => setTimeout(resolve, 500));
+    }
+
+    // Open another tab and navigate
+    await testdriver.pressKeys(["ctrl", "t"]);
+    await testdriver.type("google.com");
+    await testdriver.pressKeys(["enter"]);
+
+    // Assert Google appears
+    const result = await testdriver.assert("google appears");
+    expect(result).toBeTruthy();
+  });
+});

package/testdriver/acceptance-sdk/prompt.test.mjs

@@ -0,0 +1,33 @@
+/**
+ * TestDriver SDK - Prompt Test (Vitest)
+ * Converted from: testdriver/acceptance/prompt.yaml
+ */
+
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../src/vitest/hooks.mjs";
+
+describe.skip("Prompt Test", () => {
+  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' });
+
+    //
+    // 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.
+
+    // Original prompts were:
+    // 1. "log in"
+    // 2. "add an item to the cart"
+    // 3. "click on the cart icon"
+    // 4. "complete checkout"
+
+    // 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");
+
+    const result = await testdriver.assert("the testdriver sandbox is visible");
+    expect(result).toBeTruthy();
+  });
+});

package/testdriver/acceptance-sdk/scroll-keyboard.test.mjs

@@ -0,0 +1,38 @@
+/**
+ * TestDriver SDK - Scroll Keyboard Test (Vitest)
+ * Converted from: testdriver/acceptance/scroll-keyboard.yaml
+ */
+
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../src/vitest/hooks.mjs";
+
+describe("Scroll Keyboard Test", () => {
+  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' });
+
+    //
+    // Navigate to https://www.webhamster.com/
+    await testdriver.focusApplication("Google Chrome");
+    const urlBar = await testdriver.find(
+      "testdriver-sandbox.vercel.app/login, the URL in the omnibox showing the current page",
+    );
+    await urlBar.click();
+    await testdriver.pressKeys(["ctrl", "a"]);
+    await testdriver.type("https://www.webhamster.com/");
+    await testdriver.pressKeys(["enter"]);
+
+    // Scroll down with keyboard 1000 pixels
+    const heading = await testdriver.find(
+      "The Hamster Dance, large heading at top of page",
+    );
+    await heading.click();
+    await testdriver.scroll("down", 1000);
+
+    // Assert the page is scrolled down
+    const result = await testdriver.assert(
+      "the hamster dance heading is not visible",
+    );
+    expect(result).toBeTruthy();
+  });
+});

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

@@ -0,0 +1,39 @@
+/**
+ * TestDriver SDK - Scroll Until Image Test (Vitest)
+ * Converted from: testdriver/acceptance/scroll-until-image.yaml
+ */
+
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../src/vitest/hooks.mjs";
+
+describe("Scroll Until Image Test", () => {
+  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' });
+
+    //
+    // Navigate to Wikipedia page
+    await testdriver.pressKeys(["ctrl", "l"]);
+    await testdriver.type("https://en.wikipedia.org/wiki/Leonardo_da_Vinci");
+    await testdriver.pressKeys(["enter"]);
+
+    // sleep for 5 seconds
+    await new Promise((r) => setTimeout(r, 5000));
+
+    // Click on heading
+    const heading = await testdriver.find(
+      "Leonardo Da Vinci, the page heading",
+      0,
+    );
+    await heading.click();
+
+    // Scroll until image appears
+    await testdriver.scrollUntilImage("a brown colored house", "down", 10000);
+
+    // Assert image of brown colored house appears on screen
+    const result = await testdriver.assert(
+      "image of brown colored house appears on screen",
+    );
+    expect(result).toBeTruthy();
+  });
+});

package/testdriver/acceptance-sdk/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 "../../src/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/scroll.test.mjs

@@ -0,0 +1,41 @@
+/**
+ * TestDriver SDK - Scroll Test (Vitest)
+ * Converted from: testdriver/acceptance/scroll.yaml
+ * 
+ * UPDATED: Now using chrome preset for automatic setup
+ */
+
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../../src/vitest/hooks.mjs";
+
+describe("Scroll Test", () => {
+  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' });
+
+    // Give Chrome a moment to fully render the UI
+    await new Promise(resolve => setTimeout(resolve, 2000));
+
+    // Navigate to webhamster.com - just look for the domain, not the full path
+    const urlBar = await testdriver.find(
+      "testdriver-sandbox.vercel.app, the URL in the address bar",
+    );
+    await urlBar.click();
+    await testdriver.pressKeys(["ctrl", "a"]);
+    await testdriver.type("https://www.webhamster.com/");
+    await testdriver.pressKeys(["enter"]);
+
+    // Wait for page to load and click heading
+    const heading = await testdriver.find(
+      "The Hamster Dance, large heading at top of page",
+    );
+    await heading.click();
+
+    // Scroll down
+    await testdriver.scroll("down", 1000);
+
+    // Assert page is scrolled
+    const result = await testdriver.assert("the page is scrolled down, the hamster dance heading is not visible on the page");
+    expect(result).toBeTruthy();
+  });
+});

package/testdriver/acceptance-sdk/setup/globalTeardown.mjs

@@ -0,0 +1,11 @@
+/**
+ * Vitest Global Teardown
+ * Saves test results and dashcam URLs after all tests complete
+ */
+
+import { saveTestResults } from "./testHelpers.mjs";
+
+export default async function globalTeardown() {
+  console.log("\n🎬 Saving test results and dashcam URLs...");
+  saveTestResults();
+}