testdriverai 7.3.1 → 7.3.3

package/examples/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 "../lib/vitest/hooks.mjs";
+
+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();
+  });
+});

package/examples/installer.test.mjs

@@ -0,0 +1,49 @@
+/**
+ * TestDriver SDK - Installer Test (Vitest)
+ * Tests the provision.installer() method for downloading and installing apps
+ */
+
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../lib/vitest/hooks.mjs";
+
+const isLinux = (process.env.TD_OS || "linux") === "linux";
+
+describe("Provision Installer", () => {
+  it.skipIf(!isLinux)(
+    "should download and install a .deb package on Linux",
+    async (context) => {
+      const testdriver = TestDriver(context, { ip: context.ip || process.env.TD_IP });
+      
+      // Install bat (a cat clone with syntax highlighting) using provision.installer
+      const filePath = await testdriver.provision.installer({
+        url: 'https://github.com/sharkdp/bat/releases/download/v0.24.0/bat_0.24.0_amd64.deb',
+      });
+
+      // Verify the file was downloaded
+      expect(filePath).toContain('bat');
+
+      // Verify bat was installed by running it
+      await testdriver.exec('sh', 'bat --version', 10000);
+    },
+  );
+
+  it.skipIf(!isLinux)(
+    "should download a shell script and verify it exists",
+    async (context) => {
+      const testdriver = TestDriver(context, { ip: context.ip || process.env.TD_IP });
+      
+      // Download a shell script (nvm installer)
+      const filePath = await testdriver.provision.installer({
+        url: 'https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh',
+        launch: false, // Don't auto-run the script
+      });
+
+      // Verify the file was downloaded
+      expect(filePath).toContain('install.sh');
+
+      // Verify the file is executable
+      const result = await testdriver.exec('sh', `ls -la "${filePath}"`, 10000);
+      expect(result).toBeTruthy();
+    },
+  );
+});

package/examples/launch-vscode-linux.test.mjs

@@ -0,0 +1,54 @@
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../lib/vitest/hooks.mjs";
+
+const isLinux = (process.env.TD_OS || "linux") === "linux";
+
+describe("Launch VS Code on Linux", () => {
+  it.skipIf(!isLinux)(
+    "should launch VS Code on Debian/Ubuntu",
+    async (context) => {
+      const testdriver = TestDriver(context, { ip: context.ip || process.env.TD_IP });
+      
+      // provision.vscode() automatically calls ready() and starts dashcam
+      await testdriver.provision.vscode();
+
+      // Wait for VS Code to launch (polls every 5s until found or timeout)
+      const vsCodeWindow = await testdriver.find(
+        "Visual Studio Code window",
+        { timeout: 60000 }
+      );
+      expect(vsCodeWindow.found()).toBeTruthy();
+    },
+  );
+
+  it.skipIf(!isLinux)(
+    "should install and use a VS Code extension",
+    async (context) => {
+      const testdriver = TestDriver(context, { ip: context.ip || process.env.TD_IP });
+      
+      // Launch VS Code with the Prettier extension installed
+      await testdriver.provision.vscode({
+        extensions: ["esbenp.prettier-vscode"],
+      });
+
+      const vsCodeWindow = await testdriver.find(
+        "Visual Studio Code window",
+        { timeout: 60000 }
+      );
+
+      expect(vsCodeWindow.found()).toBeTruthy();
+
+      // Open the extensions panel to verify Prettier is installed
+      await testdriver.pressKeys(["ctrl", "shift", "x"]);
+      
+      // Wait for extensions panel to open
+      await new Promise((resolve) => setTimeout(resolve, 2000));
+
+      // Assert that Prettier extension is visible in the installed extensions
+      const prettierVisible = await testdriver.assert(
+        "Prettier extension is visible in the extensions panel or sidebar",
+      );
+      expect(prettierVisible).toBeTruthy();
+    },
+  );
+});

package/examples/match-image.test.mjs

@@ -0,0 +1,54 @@
+/**
+ * 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 "../lib/vitest/hooks.mjs";
+
+/**
+ * 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();
+  });
+});

package/examples/no-provision.test.mjs

@@ -0,0 +1,23 @@
+/**
+ * TestDriver SDK - Assert Test (Vitest)
+ * Converted from: testdriver/acceptance/assert.yaml
+ */
+
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../lib/vitest/hooks.mjs";
+
+describe("Assert Test", () => {
+  it("should assert the testdriver login page shows", async (context) => {
+    const testdriver = TestDriver(context, {
+      ip: context.ip || process.env.TD_IP,
+    });
+    
+    // Assert the TestDriver.ai Sandbox login page is displayed
+    const result = await testdriver.assert(
+      "A desktop is visible",
+    );
+
+    expect(result).toBeTruthy();
+  });
+});
+

package/examples/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 "../lib/vitest/hooks.mjs";
+
+describe("Press Keys Test", () => {
+  it("should create tabs and navigate using keyboard shortcuts", 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' });
+
+    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/examples/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 "../lib/vitest/hooks.mjs";
+
+describe.skip("Prompt Test", () => {
+  it("should execute AI-driven prompts", 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' });
+
+    //
+    // 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.act("log in");
+
+    const result = await testdriver.assert("the testdriver sandbox is visible");
+    expect(result).toBeTruthy();
+  });
+});

package/examples/scroll-keyboard.test.mjs

@@ -0,0 +1,37 @@
+/**
+ * TestDriver SDK - Scroll Keyboard Test (Vitest)
+ * Converted from: testdriver/acceptance/scroll-keyboard.yaml
+ */
+
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../lib/vitest/hooks.mjs";
+
+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(
+      "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", { 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();
+  });
+});

package/examples/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 "../lib/vitest/hooks.mjs";
+
+describe("Scroll Until Image Test", () => {
+  it.skip("should scroll until brown colored house image appears", 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 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/examples/scroll-until-text.test.mjs

@@ -0,0 +1,67 @@
+/**
+ * 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";
+
+/**
+ * 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"]);
+}
+
+describe("Scroll Until Text Test", () => {
+  it('should scroll until "testdriver socks" appears', 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);
+
+    // Scroll until text appears
+    await testdriver.focusApplication("Google Chrome");
+
+    await testdriver.find('TestDriver.ai Sandbox heading').click();
+
+    // Scroll until text appears
+    let found = false;
+    let scrollCount = 0;
+    const maxScrolls = 10;
+    
+    while (!found && scrollCount < maxScrolls) {
+      const findResult = await testdriver.find("testdriver socks product text is fully visible");
+
+      if (findResult.found()) {
+        found = true;
+      } else {
+        await testdriver.scroll();
+        scrollCount++;
+      }
+    }
+    
+    if (!found) {
+      throw new Error(`Failed to find "testdriver socks" after ${maxScrolls} scrolls`);
+    }
+
+    // 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/examples/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 "../lib/vitest/hooks.mjs";
+
+describe("Scroll Test", () => {
+  it("should navigate and scroll down the page", 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' });
+
+    // 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", { amount: 1000 });
+
+    // Assert page is scrolled
+    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();
+  });
+});

package/examples/type.test.mjs

@@ -0,0 +1,45 @@
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "../lib/vitest/hooks.mjs";
+
+describe("Type Test", () => {
+  it("should enter standard_user in username field", 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' });
+
+    //
+    const usernameField = await testdriver.find(
+      "Username, input field for username",
+    );
+    await usernameField.click();
+    await testdriver.type("standard_user");
+
+    const result = await testdriver.assert(
+      'the username field contains "standard_user"',
+    );
+    expect(result).toBeTruthy();
+  });
+
+  it("should show validation message when clicking Sign In without password", 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' });
+
+    // First fill in username
+    const usernameField = await testdriver.find(
+      "Username, input field for username",
+    );
+    await usernameField.click();
+    await testdriver.type("standard_user");
+
+    //
+    const signInButton = await testdriver.find(
+      "Sign in, black button below the password field",
+    );
+    await signInButton.click();
+
+    await testdriver.focusApplication("Google Chrome");
+    const result = await testdriver.assert(
+      "Please fill out this field is visible near the password field",
+    );
+    expect(result).toBeTruthy();
+  });
+});

package/examples/windows-installer.test.mjs

@@ -0,0 +1,53 @@
+/**
+ * TestDriver SDK - Windows Installer Example (Vitest)
+ * 
+ * This example demonstrates how to download and install a Windows application
+ * using PowerShell commands, then launch and interact with it.
+ * 
+ * Based on the v6 GitButler provisioning workflow.
+ * 
+ * Run: TD_OS=windows vitest run examples/windows-installer.test.mjs
+ */
+
+import { describe, it } from "vitest";
+import { TestDriver } from "../lib/vitest/hooks.mjs";
+
+const isLinux = (process.env.TD_OS || "linux") === "linux";
+
+describe("Windows App Installation", () => {
+    
+  it.skipIf(isLinux)("should download, install, and launch GitButler on Windows", async (context) => {
+    // Alternative approach using provision.installer helper
+    const testdriver = TestDriver(context, { 
+      ip: context.ip || process.env.TD_IP,
+      os: 'windows'
+    });
+
+    // Download the MSI installer
+    const installerPath = await testdriver.provision.installer({
+      url: 'https://app.gitbutler.com/downloads/release/windows/x86_64/msi',
+      launch: false, // Don't auto-launch, we'll install manually
+    });
+
+    console.log('Installer downloaded to:', installerPath);
+
+    // Install the MSI silently (the file might not have an extension, so we try MSI first)
+    await testdriver.exec('pwsh', 
+      `Start-Process msiexec.exe -ArgumentList "/i \`"${installerPath}\`" /qn /norestart" -Wait`,
+      120000
+    );
+
+    // Verify installation by checking if executable exists
+    const verifyScript = `
+      $exePath = "C:\\Program Files\\GitButler\\gitbutler-tauri.exe"
+      if (Test-Path $exePath) {
+          Write-Host "GitButler installed successfully at $exePath"
+      } else {
+          Write-Error "GitButler not found"
+          exit 1
+      }
+    `;
+
+    await testdriver.exec('pwsh', verifyScript, 5000);
+  });
+});

package/jsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "target": "ES2022",
+    "checkJs": true,
+    "strict": false,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "baseUrl": ".",
+    "typeRoots": ["."]
+  },
+  "include": [
+    "**/*.js",
+    "**/*.mjs",
+    "**/*.d.ts",
+    "sdk.d.ts",
+    "lib/**/*.d.ts",
+    "interfaces/**/*.d.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "build"
+  ]
+}

package/lib/vitest/hooks.mjs

@@ -191,6 +191,7 @@ const lifecycleHandlers = new WeakMap();
  * });
  */
 export function TestDriver(context, options = {}) {
+  console.log("[DEBUG hooks entry] options:", JSON.stringify(options));
   if (!context || !context.task) {
     throw new Error(
       'TestDriver() requires Vitest context. Pass the context parameter from your test function: test("name", async (context) => { ... })',
@@ -246,6 +247,8 @@ export function TestDriver(context, options = {}) {
     config.apiRoot = process.env.TD_API_ROOT;
   }
 
+  console.log("[DEBUG hooks] options.preview:", options.preview, "config.preview:", config.preview);
+
   const testdriver = new TestDriverSDK(apiKey, config);
   testdriver.__vitestContext = context.task;
   testdriver._debugOnFailure = mergedOptions.debugOnFailure || false;