testdriverai 7.0.0 → 7.1.0

package/examples/test-recording-example.test.js

@@ -1,166 +0,0 @@
-/**
- * Example Vitest test file demonstrating TestDriver test recording
- *
- * This example shows how to:
- * 1. Use TestDriver SDK in tests
- * 2. Associate dashcam recordings with tests
- * 3. Record custom test metadata
- *
- * Run with: npx vitest run examples/test-recording-example.test.js
- */
-
-import { afterAll, beforeAll, describe, test } from "vitest";
-import TestDriverSDK from "../sdk.js";
-
-// Initialize TestDriver client
-let client;
-let runId;
-
-beforeAll(async () => {
-  // Connect to TestDriver
-  client = new TestDriverSDK({
-    apiKey: process.env.TD_API_KEY || "your-api-key",
-  });
-
-  await client.connect();
-
-  // Create a test run (usually done by the Vitest reporter, but shown here for demo)
-  runId = `example-${Date.now()}`;
-
-  const testRun = await client.createTestRun({
-    runId,
-    suiteName: "Example Test Suite",
-    platform: "windows",
-    git: {
-      repo: "testdriverai/cli",
-      branch: "main",
-      commit: "abc123",
-    },
-  });
-
-  console.log("Test run created:", testRun.runId);
-});
-
-afterAll(async () => {
-  // Complete the test run
-  await client.completeTestRun({
-    runId,
-    status: "passed",
-    totalTests: 3,
-    passedTests: 3,
-    failedTests: 0,
-  });
-
-  await client.disconnect();
-});
-
-describe("Login Tests", () => {
-  test("should display login page", async () => {
-    const testStart = Date.now();
-
-    try {
-      // Your test logic here
-      await client.click("Login");
-
-      // Record the test result
-      await client.recordTestCase({
-        runId,
-        testName: "should display login page",
-        testFile: "examples/test-recording-example.test.js",
-        suiteName: "Login Tests",
-        status: "passed",
-        startTime: testStart,
-        endTime: Date.now(),
-        duration: Date.now() - testStart,
-      });
-    } catch (error) {
-      // Record failure
-      await client.recordTestCase({
-        runId,
-        testName: "should display login page",
-        testFile: "examples/test-recording-example.test.js",
-        status: "failed",
-        errorMessage: error.message,
-        errorStack: error.stack,
-      });
-      throw error;
-    }
-  });
-
-  test("should login with valid credentials", async () => {
-    const testStart = Date.now();
-
-    try {
-      // Test logic
-      await client.type("username", "testuser");
-      await client.type("password", "password123");
-      await client.click("Submit");
-
-      // Wait for dashboard
-      await client.waitForText("Dashboard");
-
-      // Record success
-      await client.recordTestCase({
-        runId,
-        testName: "should login with valid credentials",
-        testFile: "examples/test-recording-example.test.js",
-        suiteName: "Login Tests",
-        status: "passed",
-        startTime: testStart,
-        endTime: Date.now(),
-        duration: Date.now() - testStart,
-        // Associate with dashcam replay (if you have the URL)
-        replayUrl: process.env.DASHCAM_REPLAY_URL,
-      });
-    } catch (error) {
-      await client.recordTestCase({
-        runId,
-        testName: "should login with valid credentials",
-        testFile: "examples/test-recording-example.test.js",
-        status: "failed",
-        errorMessage: error.message,
-        errorStack: error.stack,
-      });
-      throw error;
-    }
-  });
-
-  test("should show error with invalid credentials", async () => {
-    const testStart = Date.now();
-
-    try {
-      await client.type("username", "wrong");
-      await client.type("password", "wrong");
-      await client.click("Submit");
-
-      await client.waitForText("Invalid credentials");
-
-      await client.recordTestCase({
-        runId,
-        testName: "should show error with invalid credentials",
-        testFile: "examples/test-recording-example.test.js",
-        suiteName: "Login Tests",
-        status: "passed",
-        startTime: testStart,
-        endTime: Date.now(),
-        duration: Date.now() - testStart,
-        steps: [
-          { action: "type", target: "username", value: "wrong" },
-          { action: "type", target: "password", value: "wrong" },
-          { action: "click", target: "Submit" },
-          { action: "waitForText", target: "Invalid credentials" },
-        ],
-      });
-    } catch (error) {
-      await client.recordTestCase({
-        runId,
-        testName: "should show error with invalid credentials",
-        testFile: "examples/test-recording-example.test.js",
-        status: "failed",
-        errorMessage: error.message,
-        errorStack: error.stack,
-      });
-      throw error;
-    }
-  });
-});

package/mcp-server/AI_GUIDELINES.md

@@ -1,57 +0,0 @@
-# TestDriver MCP Server - AI Agent Guidelines
-
-## Essential Workflow
-
-1. **Always connect first**: Call `testdriver_connect` before any other operations
-2. **Verify with screenshots**: Screenshots are automatically captured after actions - review them to confirm success
-3. **Wait before interacting**: Use `waitForText` or `waitForImage` before clicking/typing to ensure elements are ready
-4. **Assert expectations**: After critical actions, use `assert` to verify the expected outcome
-5. **Share debugger URL**: After connecting, share the debugger URL with users so they can watch in real-time
-
-## Common Patterns
-
-### Login Flow
-
-```
-1. connect() - start sandbox
-2. getScreenshot() - see initial state
-3. hoverText("Username") - click username field
-4. type("user@example.com") - enter username
-5. hoverText("Password") - click password field
-6. type("password123") - enter password
-7. hoverText("Login") - click login button
-8. waitForText("Welcome") - wait for success
-9. assert("the user is logged in") - verify outcome
-10. getScreenshot() - capture final state
-```
-
-### Form Testing
-
-```
-1. Always wait for form elements before interacting
-2. Take screenshots before and after form submission
-3. Assert success/error messages appear
-4. Use remember() to capture dynamic values (order IDs, timestamps, etc.)
-```
-
-## Best Practices
-
-- **Be patient**: Always wait for elements before clicking
-- **Be specific**: Use descriptive text in hoverText/assert (e.g., "the blue Submit button" not just "Submit")
-- **Verify everything**: Check screenshots to ensure actions succeeded
-- **Handle errors**: If an action fails, take a screenshot to diagnose
-- **Save tests**: Use `createTestFromActions` to save successful workflows
-
-## Common Mistakes to Avoid
-
-❌ Don't click elements that may not have loaded yet
-✅ Do use `waitForText` first
-
-❌ Don't assume actions succeeded without verification
-✅ Do check screenshots and use assertions
-
-❌ Don't chain many actions without pauses
-✅ Do add small waits between rapid actions
-
-❌ Don't forget to share the debugger URL
-✅ Do tell users where to watch the live VM screen

package/test-find-api.js

@@ -1,73 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Quick test of the new find() API
- * This is a simple smoke test to verify the Element class works
- */
-
-const TestDriver = require("../sdk");
-
-async function testFindAPI() {
-  console.log("Testing new find() API...\n");
-
-  const client = new TestDriver("test-key", {
-    logging: false,
-  });
-
-  // Test 1: Create element without connecting
-  console.log("✓ Test 1: Creating Element instance");
-  const element = client.find("test element");
-  console.log("  Element description:", element.description);
-  console.log("  Element found():", element.found());
-  console.log("  Element coordinates:", element.getCoordinates());
-
-  // Test 2: Verify element methods exist
-  console.log("\n✓ Test 2: Verifying Element methods");
-  console.log("  Has find():", typeof element.find === "function");
-  console.log("  Has click():", typeof element.click === "function");
-  console.log("  Has hover():", typeof element.hover === "function");
-  console.log(
-    "  Has doubleClick():",
-    typeof element.doubleClick === "function",
-  );
-  console.log("  Has rightClick():", typeof element.rightClick === "function");
-  console.log("  Has mouseDown():", typeof element.mouseDown === "function");
-  console.log("  Has mouseUp():", typeof element.mouseUp === "function");
-  console.log("  Has found():", typeof element.found === "function");
-  console.log(
-    "  Has getCoordinates():",
-    typeof element.getCoordinates === "function",
-  );
-
-  // Test 3: Verify error handling for clicking unfound element
-  console.log("\n✓ Test 3: Error handling for unfound element");
-  try {
-    await element.click();
-    console.log("  ❌ Should have thrown error");
-  } catch (error) {
-    console.log("  ✓ Correctly throws error:", error.message);
-  }
-
-  // Test 4: Verify TypeScript types exist (if running from TypeScript)
-  console.log("\n✓ Test 4: SDK methods");
-  console.log("  Has find():", typeof client.find === "function");
-  console.log(
-    "  Has deprecated hoverText():",
-    typeof client.hoverText === "undefined" ? "not yet connected" : "exists",
-  );
-  console.log(
-    "  Has deprecated waitForText():",
-    typeof client.waitForText === "undefined" ? "not yet connected" : "exists",
-  );
-
-  console.log("\n✅ All basic tests passed!");
-  console.log(
-    "\nNote: Full integration tests require connection to TestDriver sandbox.",
-  );
-  console.log("See examples/sdk-find-example.js for complete usage examples.");
-}
-
-testFindAPI().catch((error) => {
-  console.error("Test failed:", error);
-  process.exit(1);
-});

package/test-prompt-cache.js

@@ -1,96 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Simple test to verify prompt caching functionality
- *
- * This test demonstrates that:
- * 1. First .prompt() call makes an API request and caches the YAML response
- * 2. Second .prompt() call with the same prompt uses the cached YAML
- * 3. Cache can be disabled with TD_NO_PROMPT_CACHE=true
- */
-
-const TestDriver = require("./sdk.js");
-const promptCache = require("./agent/lib/cache.js");
-
-async function testPromptCache() {
-  console.log("Testing prompt caching functionality...\n");
-
-  const client = new TestDriver(process.env.TD_API_KEY, {
-    os: "linux",
-    logging: true,
-  });
-
-  try {
-    // Connect to sandbox
-    console.log("Connecting to sandbox...");
-    await client.connect();
-    console.log("Connected!\n");
-
-    const testPrompt = "click the search button";
-
-    // Clear cache for this prompt to start fresh
-    const cachePath = promptCache.getCachePath(testPrompt);
-    console.log(`Cache path for "${testPrompt}": ${cachePath}\n`);
-
-    // Test 1: First call (should make API request and cache)
-    console.log("Test 1: First .ai() call (should cache the response)");
-    const stats1 = promptCache.getCacheStats();
-    console.log(`Cache before: ${stats1.count} files`);
-
-    await client.ai(testPrompt);
-
-    const stats2 = promptCache.getCacheStats();
-    console.log(`Cache after: ${stats2.count} files`);
-    console.log(
-      `Cache hit: ${promptCache.hasCache(testPrompt) ? "YES" : "NO"}\n`,
-    );
-
-    // Test 2: Second call (should use cache)
-    console.log(
-      "Test 2: Second .ai() call with same prompt (should use cache)",
-    );
-    console.log('Look for "(using cached response)" message above...\n');
-    await client.ai(testPrompt);
-
-    // Test 3: Third call with cache disabled (should make API call)
-    console.log(
-      "\nTest 3: Third .ai() call with cache=false (should bypass cache)",
-    );
-    await client.ai(testPrompt, false);
-
-    // Test 4: Show cache contents
-    console.log("\nTest 4: Cache contents");
-    const cachedYaml = promptCache.readCache(testPrompt);
-    if (cachedYaml) {
-      console.log("Cached YAML preview (first 500 chars):");
-      console.log(cachedYaml.substring(0, 500));
-      console.log("...\n");
-    }
-
-    // Test 5: Cache statistics
-    console.log("Test 5: Cache statistics");
-    const finalStats = promptCache.getCacheStats();
-    console.log(`Total cached prompts: ${finalStats.count}`);
-    console.log(`Cache files:`, finalStats.files.slice(0, 5));
-
-    console.log("\n✅ Prompt caching test completed!");
-    console.log("\nTo disable caching, pass false: client.ai(prompt, false)");
-    console.log("To clear cache, delete .testdriver/.cache/*.yaml files");
-  } catch (error) {
-    console.error("❌ Test failed:", error.message);
-    throw error;
-  } finally {
-    // Disconnect
-    await client.disconnect();
-  }
-}
-
-// Run the test
-if (require.main === module) {
-  testPromptCache().catch((error) => {
-    console.error("Test error:", error);
-    process.exit(1);
-  });
-}
-
-module.exports = testPromptCache;

package/test-sandbox-render.js

@@ -1,28 +0,0 @@
-const TestDriver = require("./sdk.js");
-
-async function test() {
-  console.log("Testing sandbox rendering...");
-
-  const client = new TestDriver(process.env.TD_API_KEY, {
-    os: process.env.TEST_PLATFORM || "linux",
-    headless: false, // Should open browser
-    logging: true,
-  });
-
-  try {
-    console.log("Connecting to sandbox...");
-    const instance = await client.connect();
-    console.log("Connected to instance:", instance);
-
-    // Wait a bit to see if browser opens
-    await new Promise((resolve) => setTimeout(resolve, 5000));
-
-    await client.disconnect();
-    console.log("Test completed successfully");
-  } catch (error) {
-    console.error("Test failed:", error);
-    process.exit(1);
-  }
-}
-
-test();

package/test-sdk-methods.js

@@ -1,15 +0,0 @@
-const SDK = require("./sdk.js");
-
-const client = new SDK("test-key");
-
-// Get all public methods (non-private, non-constructor)
-const methods = Object.getOwnPropertyNames(Object.getPrototypeOf(client))
-  .filter((m) => !m.startsWith("_") && m !== "constructor")
-  .sort();
-
-console.log("Public SDK Methods:");
-console.log(methods.join(", "));
-console.log("\nTotal:", methods.length, "methods");
-
-// Check if commands will be set up after connect
-console.log("\nCommands before connect:", client.commands);

package/test-sdk-refactor.js

@@ -1,53 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Quick test to verify SDK refactoring works correctly
- */
-
-const TestDriver = require("./sdk.js");
-
-async function test() {
-  console.log("Testing SDK refactor...\n");
-
-  // Test 1: SDK construction
-  console.log("✓ Test 1: Creating SDK instance");
-  const client = new TestDriver(process.env.TD_API_KEY || "test-key", {
-    logging: false,
-  });
-
-  console.log("  - agent exists:", !!client.agent);
-  console.log("  - emitter exists:", !!client.emitter);
-  console.log("  - config exists:", !!client.config);
-  console.log("  - session exists:", !!client.session);
-  console.log("  - apiClient exists:", !!client.apiClient);
-  console.log("  - analytics exists:", !!client.analytics);
-  console.log("  - sandbox exists:", !!client.sandbox);
-  console.log("  - system exists:", !!client.system);
-
-  // Test 2: Check agent methods are accessible
-  console.log("\n✓ Test 2: Checking agent methods");
-  console.log(
-    "  - agent.exploratoryLoop exists:",
-    typeof client.agent.exploratoryLoop,
-  );
-  console.log("  - agent.buildEnv exists:", typeof client.agent.buildEnv);
-  console.log(
-    "  - agent.getRecentSandboxId exists:",
-    typeof client.agent.getRecentSandboxId,
-  );
-
-  // Test 3: Check SDK methods
-  console.log("\n✓ Test 3: Checking SDK methods");
-  console.log("  - ai() exists:", typeof client.ai);
-  console.log("  - auth() exists:", typeof client.auth);
-  console.log("  - connect() exists:", typeof client.connect);
-  console.log("  - disconnect() exists:", typeof client.disconnect);
-
-  console.log("\n✅ All basic tests passed!");
-}
-
-test().catch((error) => {
-  console.error("\n❌ Test failed:", error.message);
-  console.error(error.stack);
-  process.exit(1);
-});

package/test-stack-trace.mjs

@@ -1,57 +0,0 @@
-/**
- * Quick test to verify stack trace filtering works
- */
-
-// Mock the MatchError similar to commands.js
-class MatchError extends Error {
-  constructor(message, fatal = false) {
-    super(message);
-    this.fatal = fatal;
-    this.attachScreenshot = true;
-  }
-}
-
-// Simulate SDK wrapper with stack filtering (improved version)
-class TestSDK {
-  constructor() {
-    const command = async (message) => {
-      // Simulate the command throwing an error
-      throw new MatchError(`AI Assertion failed: ${message}`, true);
-    };
-
-    // Wrap the method with proper stack trace handling
-    this.assert = async function (...args) {
-      // Capture the call site for better error reporting
-      const callSite = {};
-      Error.captureStackTrace(callSite, this.assert);
-
-      try {
-        return await command(...args);
-      } catch (error) {
-        // Replace the stack trace to point to the actual caller
-        if (Error.captureStackTrace && callSite.stack) {
-          const errorMessage = error.stack?.split("\n")[0];
-          const callerStack = callSite.stack?.split("\n").slice(1);
-          error.stack = errorMessage + "\n" + callerStack.join("\n");
-        }
-        throw error;
-      }
-    }.bind(this);
-  }
-}
-
-// Test it
-async function runTest() {
-  const client = new TestSDK();
-
-  try {
-    console.log("Testing stack trace...\n");
-    await client.assert("home page appears"); // Line 42 - this should show in stack
-  } catch (error) {
-    console.log("Error caught!");
-    console.log("Stack trace:");
-    console.log(error.stack);
-  }
-}
-
-runTest();