@testdriverai/agent 7.11.229-canary → 7.11.231-test

package/docs/examples/captcha-api.mdx

@@ -1,92 +0,0 @@
----
-title: "Captcha Solving Example"
-sidebarTitle: "Captcha Solving"
-description: "Example test demonstrating automatic captcha solving with reCAPTCHA and Cloudflare Turnstile support."
-icon: "shield-check"
-mode: "wide"
----
-
-## Demo Test Run
-
-Watch this test execute in a real sandbox environment:
-
-{/* captcha-api.test.mjs output */}
-<iframe 
-  src="https://api-test.testdriver.ai/api/v1/testdriver/testcase/698f7fb0d3b320ad547d9d44/replay" 
-  width="100%" 
-  height="390" 
-  style={{ border: "1px solid #333", borderRadius: "8px" }}
-  allow="fullscreen"
-/>
-
-## Source Code
-
-```javascript title="captcha-api.test.mjs" {18-20}
-/**
- * TestDriver SDK - Captcha Test
- */
-import { describe, expect, it } from "vitest";
-import { TestDriver } from "testdriverai/vitest/hooks";
-
-console.log("DEBUG: process.env.TD_OS:", process.env.TD_OS);
-
-describe("testdriver.captcha() API", () => {
-  it("should solve reCAPTCHA v3 with auto-detect", async (context) => {
-    const testdriver = TestDriver(context);
-
-    // Launch Chrome (remote debugging is enabled automatically on Linux)
-    await testdriver.provision.chrome({
-      url: "https://2captcha.com/demo/recaptcha-v3",
-    });
-
-    await testdriver.screenshot();
-
-    // Solve the captcha with just the API key - everything else is auto-detected!
-    const result = await testdriver.captcha({
-      apiKey: process.env.TWOCAPTCHA_API_KEY,
-    });
-
-    console.log("Captcha result:", result);
-    await testdriver.screenshot();
-
-    expect(result.success).toBe(true);
-  }, 180000);
-
-  it("should solve Cloudflare Turnstile", async (context) => {
-    const testdriver = TestDriver(context);
-
-    await testdriver.provision.chrome({
-      url: "https://2captcha.com/demo/cloudflare-turnstile",
-    });
-
-    await testdriver.screenshot();
-
-    const result = await testdriver.captcha({
-      apiKey: process.env.TWOCAPTCHA_API_KEY,
-    });
-
-    console.log("Turnstile result:", result);
-    await testdriver.screenshot();
-
-    expect(result.success).toBe(true);
-  }, 180000);
-});
-```
-
-## Running This Example
-
-```bash
-# Clone the TestDriver repository
-git clone https://github.com/testdriverai/testdriverai
-
-# Install dependencies
-cd testdriverai
-npm install
-
-# Run this specific example
-vitest run examples/captcha-api.test.mjs
-```
-
-<Note>
-  Make sure you have `TD_API_KEY` set in your environment. Get one at [testdriver.ai](https://testdriver.ai).
-</Note>

package/docs/examples/chrome-extension.mdx

@@ -1,156 +0,0 @@
----
-title: "Chrome Extension Test Example"
-sidebarTitle: "Chrome Extension"
-description: "Example test showing how to load Chrome extensions from local paths or the Chrome Web Store."
-icon: "chrome"
-mode: "wide"
----
-
-## Demo Test Run
-
-Watch this test execute in a real sandbox environment:
-
-{/* chrome-extension.test.mjs output */}
-<iframe 
-  src="https://api-test.testdriver.ai/api/v1/testdriver/testcase/6a8798913062df0fb9b85592/replay" 
-  width="100%" 
-  height="390" 
-  style={{ border: "1px solid #333", borderRadius: "8px" }}
-  allow="fullscreen"
-/>
-
-## Source Code
-
-```javascript title="chrome-extension.test.mjs" {31-33}
-/**
- * TestDriver SDK - Chrome Extension Test (Vitest)
- * Tests loading a Chrome extension using provision.chromeExtension()
- * 
- * This test suite covers:
- * 1. Loading extension from local path (extensionPath)
- * 2. Loading extension from Chrome Web Store (extensionId)
- */
-
-import { describe, expect, it } from "vitest";
-import { TestDriver } from "testdriverai/vitest/hooks";
-
-describe("Chrome Extension Test", () => {
-  it("should load hello-world Chrome extension from local path", async (context) => {
-
-    console.log('connecting to', process.env.TD_IP)
-
-    const testdriver = TestDriver(context, { ip: context.ip || process.env.TD_IP, cacheKey: new Date().getTime().toString() });
-    
-    // Determine OS-specific paths and commands
-    const shell = testdriver.os === 'windows' ? 'pwsh' : 'sh';
-    const extensionsDir = testdriver.os === 'windows' 
-      ? 'C:\\Users\\testdriver\\Downloads\\chrome-extensions-samples'
-      : '/tmp/chrome-extensions-samples';
-    const extensionPath = testdriver.os === 'windows'
-      ? `${extensionsDir}\\functional-samples\\tutorial.hello-world`
-      : `${extensionsDir}/functional-samples/tutorial.hello-world`;
-    
-    // Clone the Chrome extensions samples repo
-    const cloneCmd = testdriver.os === 'windows'
-      ? `git clone --depth 1 https://github.com/GoogleChrome/chrome-extensions-samples.git "${extensionsDir}"`
-      : `git clone --depth 1 https://github.com/GoogleChrome/chrome-extensions-samples.git ${extensionsDir}`;
-    
-    await testdriver.exec(shell, cloneCmd, 60000, true);
-
-    // Launch Chrome with the hello-world extension loaded
-    await testdriver.provision.chromeExtension({
-      extensionPath: extensionPath
-    });
-
-    // Navigate to testdriver.ai (extensions don't load on New Tab)
-    const addressBar = await testdriver.find("Chrome address bar");
-    await addressBar.click();
-    await testdriver.type("testdriver.ai");
-    await testdriver.pressKeys(["enter"]);
-
-    // Wait for page to load
-    const pageResult = await testdriver.assert("I can see testdriver.ai");
-    expect(pageResult).toBeTruthy();
-
-    // The hello-world extension adds a puzzle piece icon to the toolbar
-    // When clicked, it shows a popup with "Hello Extensions"
-
-    // Retry opening the extension popup and verifying it up to 3 times
-    let popupResult;
-    let lastError;
-    for (let attempt = 1; attempt <= 3; attempt++) {
-      try {
-        // Click on the extensions button (puzzle piece icon) in Chrome toolbar
-        const extensionsButton = await testdriver.find("The extensions button in the Chrome toolbar", {zoom: true, verify: true, timeout: 10000});
-        await extensionsButton.click();
-
-        // Look for the hello world extension in the extensions menu
-        const helloExtension = await testdriver.find("Hello Extensions extension in the extensions dropdown", {zoom: true, verify: true, timeout: 10000});
-        await helloExtension.click();
-
-        await testdriver.wait(2000); // wait for the popup to open
-
-        // Verify the extension popup shows "Hello Extensions" text
-        popupResult = await testdriver.assert("a popup shows with the text 'Hello Extensions'");
-        if (popupResult) break;
-      } catch (err) {
-        lastError = err;
-        console.log(`Attempt ${attempt} failed:`, err.message);
-      }
-      if (attempt < 3) {
-        // Dismiss any open popup/menu before retrying
-        await testdriver.pressKeys(["escape"]);
-        await testdriver.wait(1000);
-      }
-    }
-    if (!popupResult && lastError) throw lastError;
-    expect(popupResult).toBeTruthy();
-  });
-
-  // it("should load Loom from Chrome Web Store by extensionId", async (context) => {
-  //   const testdriver = TestDriver(context, { ip: context.ip || process.env.TD_IP});
-
-  //   // Launch Chrome with Loom loaded by its Chrome Web Store ID
-  //   // Loom ID: liecbddmkiiihnedobmlmillhodjkdmb
-  //   await testdriver.provision.chromeExtension({
-  //     extensionId: 'liecbddmkiiihnedobmlmillhodjkdmb'
-  //   });
-
-  //   // Navigate to testdriver.ai (extensions don't load on New Tab)
-  //   const addressBar = await testdriver.find("Chrome address bar");
-  //   await addressBar.click();
-  //   await testdriver.type("testdriver.ai");
-  //   await testdriver.pressKeys(["enter"]);
-
-  //   // Wait for page to load
-  //   const pageResult = await testdriver.assert("I can see testdriver.ai");
-  //   expect(pageResult).toBeTruthy();
-
-  //   // Click on the extensions button (puzzle piece icon) in Chrome toolbar
-  //   const extensionsButton = await testdriver.find("The puzzle-shaped icon in the Chrome toolbar.", {zoom: true});
-  //   await extensionsButton.click();
-
-  //   // Look for Loom in the extensions menu
-  //   const loomExtension = await testdriver.find("Loom extension in the extensions dropdown");
-  //   expect(loomExtension.found()).toBeTruthy();
-  // });
-});
-```
-
-## Running This Example
-
-```bash
-# Clone the TestDriver repository
-git clone https://github.com/testdriverai/testdriverai
-
-# Install dependencies
-cd testdriverai
-npm install
-
-# Run this specific example
-vitest run examples/chrome-extension.test.mjs
-```
-
-<Note>
-  Make sure you have `TD_API_KEY` set in your environment. Get one at [testdriver.ai](https://testdriver.ai).
-</Note>

package/docs/examples/drag-and-drop.mdx

@@ -1,100 +0,0 @@
----
-title: "Drag and Drop Test Example"
-sidebarTitle: "Drag and Drop"
-description: "Example test demonstrating drag and drop interactions using mouseDown and mouseUp."
-icon: "arrows-up-down-left-right"
-mode: "wide"
----
-
-## Demo Test Run
-
-Watch this test execute in a real sandbox environment:
-
-{/* drag-and-drop.test.mjs output */}
-<iframe 
-  src="https://api-test.testdriver.ai/api/v1/testdriver/testcase/69a62b42fc0ac3cc632a918b/replay" 
-  width="100%" 
-  height="390" 
-  style={{ border: "1px solid #333", borderRadius: "8px" }}
-  allow="fullscreen"
-/>
-
-## Source Code
-
-```javascript title="drag-and-drop.test.mjs" {33-34,38-39}
-/**
- * TestDriver SDK - Drag and Drop Test
- */
-
-import { describe, expect, it } from "vitest";
-import { TestDriver } from "testdriverai/vitest/hooks";
-
-const isLinux = (process.env.TD_OS || "linux") === "linux";
-
-describe("Drag and Drop Test", () => {
-  it.skipIf(isLinux)(
-    'should drag "New Text Document" to "Recycle Bin"',
-    async (context) => {
-      const testdriver = TestDriver(context, { ip: context.ip || process.env.TD_IP, headless: true });
-      await testdriver.provision.chrome({ url: 'http://testdriver-sandbox.vercel.app/login' });
-
-      //
-      // Show the desktop
-      await testdriver.pressKeys(["win", "d"]);
-
-      // Open the context menu
-      await testdriver.pressKeys(["shift", "f10"]);
-
-      // Hover over "New" in the context menu
-      const newOption = await testdriver.find(
-        "New, new option in the open context menu on the desktop",
-      );
-      await newOption.hover();
-
-      // Click "Text Document" in the context menu
-      const textDocOption = await testdriver.find(
-        "Text Document, text document option in the new submenu of the desktop context menu",
-      );
-      await textDocOption.click();
-
-      // Unfocus the "Text Document" text field
-      await testdriver.pressKeys(["esc"]);
-
-      // Drag the "New Text Document" icon to the "Recycle Bin"
-      const textDoc = await testdriver.find(
-        "New Text Document, new text document icon in the center of the desktop",
-      );
-      await textDoc.mouseDown();
-
-      const recycleBin = await testdriver.find(
-        "Recycle Bin, recycle bin icon in the top left corner of the desktop",
-      );
-      await recycleBin.mouseUp();
-
-      // Assert "New Text Document" icon is not on the Desktop
-      const result = await testdriver.assert(
-        'the "New Text Document" icon is not visible on the Desktop',
-      );
-      expect(result).toBeTruthy();
-    },
-  );
-});
-```
-
-## Running This Example
-
-```bash
-# Clone the TestDriver repository
-git clone https://github.com/testdriverai/testdriverai
-
-# Install dependencies
-cd testdriverai
-npm install
-
-# Run this specific example
-vitest run examples/drag-and-drop.test.mjs
-```
-
-<Note>
-  Make sure you have `TD_API_KEY` set in your environment. Get one at [testdriver.ai](https://testdriver.ai).
-</Note>

package/docs/examples/formatted-logging.mdx

@@ -1,74 +0,0 @@
----
-title: "Formatted Logging Test"
-sidebarTitle: "Formatted Logging"
-description: "TestDriver SDK - Formatted Logging Demo Demonstrates nice Vitest-style formatted logs for Dashcam replay."
-icon: "play"
----
-
-## Overview
-
-TestDriver SDK - Formatted Logging Demo Demonstrates nice Vitest-style formatted logs for Dashcam replay
-
-Review the source code below to understand the implementation details and patterns used.
-
-## Live Test Run
-
-Watch this test execute in a real sandbox environment:
-
-{/* formatted-logging.test.mjs output */}
-<iframe 
-  src="https://api-test.testdriver.ai/api/v1/testdriver/testcase/69c873a714b73310c7839450/replay" 
-  width="100%" 
-  height="600" 
-  style={{ border: "1px solid #333", borderRadius: "8px" }}
-  allow="fullscreen"
-/>
-
-## Source Code
-
-```javascript title="formatted-logging.test.mjs"
-/**
- * TestDriver SDK - Formatted Logging Demo
- * Demonstrates nice Vitest-style formatted logs for Dashcam replay
- */
-
-import { describe, expect, it } from "vitest";
-import { TestDriver } from "testdriverai/vitest/hooks";
-
-describe("Formatted Logging Test", () => {
-  it("should demonstrate formatted logs in dashcam replay", async (context) => {
-    const testdriver = TestDriver(context, { ip: context.ip || process.env.TD_IP, 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();
-  });
-});
-```
-
-## Running This Example
-
-```bash
-# Clone the TestDriver repository
-git clone https://github.com/testdriverai/testdriverai
-
-# Install dependencies
-cd testdriverai
-npm install
-
-# Run this specific example
-vitest run examples/formatted-logging.test.mjs
-```
-
-<Note>
-  Make sure you have `TD_API_KEY` set in your environment. Get one at [testdriver.ai](https://testdriver.ai).
-</Note>

package/docs/examples/hover-text.mdx

@@ -1,70 +0,0 @@
----
-title: "Clicking on Text Example"
-sidebarTitle: "Hover Text"
-description: "Example test that finds and clicks on text elements using natural language descriptions."
-icon: "hand-pointer"
-mode: "wide"
----
-
-## Demo Test Run
-
-Watch this test execute in a real sandbox environment:
-
-{/* hover-text.test.mjs output */}
-<iframe 
-  src="https://api-test.testdriver.ai/api/v1/testdriver/testcase/6ad6b60a022b6043aeec2bf1/replay" 
-  width="100%" 
-  height="390" 
-  style={{ border: "1px solid #333", borderRadius: "8px" }}
-  allow="fullscreen"
-/>
-
-## Source Code
-
-```javascript title="hover-text.test.mjs" {13-15,18-20}
-/**
- * TestDriver SDK - Hover Text Test (Vitest)
- * Converted from: testdriver/acceptance/hover-text.yaml
- */
-
-import { describe, expect, it } from "vitest";
-import { TestDriver } from "testdriverai/vitest/hooks";
-
-describe("Hover Text Test", () => {
-  it("should click Sign In and verify error message", async (context) => {
-    const testdriver = TestDriver(context, { ip: context.ip || process.env.TD_IP});
-    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();
-  });
-});
-```
-
-## Running This Example
-
-```bash
-# Clone the TestDriver repository
-git clone https://github.com/testdriverai/testdriverai
-
-# Install dependencies
-cd testdriverai
-npm install
-
-# Run this specific example
-vitest run examples/hover-text.test.mjs
-```
-
-<Note>
-  Make sure you have `TD_API_KEY` set in your environment. Get one at [testdriver.ai](https://testdriver.ai).
-</Note>

package/docs/examples/match-image.mdx

@@ -1,97 +0,0 @@
----
-title: "Matching an Image By Pixel"
-sidebarTitle: "Pixel Based Match"
-description: "Example test demonstrating pixel-based image matching to locate UI elements."
-icon: "image"
-mode: "wide"
----
-
-## Demo Test Run
-
-Watch this test execute in a real sandbox environment:
-
-{/* match-image.test.mjs output */}
-<iframe 
-  src="https://api-test.testdriver.ai/api/v1/testdriver/testcase/69c8738c14b73310c783941d/replay" 
-  width="100%" 
-  height="390" 
-  style={{ border: "1px solid #333", borderRadius: "8px" }}
-  allow="fullscreen"
-/>
-
-## Source Code
-
-```javascript title="match-image.test.mjs" {42}
-/**
- * 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 "testdriverai/vitest/hooks";
-
-/**
- * Perform login flow for SauceLabs demo app
- * @param {TestDriver} client - TestDriver client
- * @param {string} username - Username (default: 'standard_user')
- */
-async function performLogin(client, username = "standard_user") {
-  await client.focusApplication("Google Chrome");
-  const password = await client.extract("the password");
-  const usernameField = await client.find(
-    "username input",
-  );
-  await usernameField.click();
-  await client.type(username);
-  await client.pressKeys(["tab"]);
-  await client.type(password, { secret: true });
-  await client.pressKeys(["tab"]);
-  await client.pressKeys(["enter"]);
-}
-
-// Get the directory of the current module
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-describe("Match Image Test", () => {
-  it.skip("should match shopping cart image and verify empty cart", async (context) => {
-    const testdriver = TestDriver(context, { ip: context.ip || process.env.TD_IP, 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();
-  });
-});
-```
-
-## Running This Example
-
-```bash
-# Clone the TestDriver repository
-git clone https://github.com/testdriverai/testdriverai
-
-# Install dependencies
-cd testdriverai
-npm install
-
-# Run this specific example
-vitest run examples/match-image.test.mjs
-```
-
-<Note>
-  Make sure you have `TD_API_KEY` set in your environment. Get one at [testdriver.ai](https://testdriver.ai).
-</Note>

package/docs/examples/scroll-keyboard.mdx

@@ -1,80 +0,0 @@
----
-title: "Scrolling with Keyboard Test Example"
-sidebarTitle: "Scrolling with Keyboard"
-description: "Example test demonstrating page scrolling using keyboard-based scroll controls."
-icon: "scroll"
-mode: "wide"
----
-
-## Demo Test Run
-
-Watch this test execute in a real sandbox environment:
-
-{/* scroll-keyboard.test.mjs output */}
-<iframe 
-  src="https://api-test.testdriver.ai/api/v1/testdriver/testcase/6ad6b600022b6043aeec2bf0/replay" 
-  width="100%" 
-  height="390" 
-  style={{ border: "1px solid #333", borderRadius: "8px" }}
-  allow="fullscreen"
-/>
-
-## Source Code
-
-```javascript title="scroll-keyboard.test.mjs" {26}
-/**
- * TestDriver SDK - Scroll Keyboard Test (Vitest)
- * Converted from: testdriver/acceptance/scroll-keyboard.yaml
- */
-
-import { describe, expect, it } from "vitest";
-import { TestDriver } from "testdriverai/vitest/hooks";
-
-describe("Scroll Keyboard Test", () => {
-  it("should navigate to webhamster.com and scroll with keyboard", async (context) => {
-    const testdriver = TestDriver(context, { ip: context.ip || process.env.TD_IP, 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(
-      "the URL in the omnibox", {zoom: true}
-    );
-    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", { amount: 1000 });
-
-    // Assert the page is scrolled down
-    const result = await testdriver.assert("The text 'The Hamster Dance' is not visible on the webpage content. It's ok if it's visible in the tab title.");
-
-    expect(result).toBeTruthy();
-  });
-});
-```
-
-## Running This Example
-
-```bash
-# Clone the TestDriver repository
-git clone https://github.com/testdriverai/testdriverai
-
-# Install dependencies
-cd testdriverai
-npm install
-
-# Run this specific example
-vitest run examples/scroll-keyboard.test.mjs
-```
-
-<Note>
-  Make sure you have `TD_API_KEY` set in your environment. Get one at [testdriver.ai](https://testdriver.ai).
-</Note>