testdriverai 6.2.2 → 7.0.0

package/testdriver/acceptance-sdk/type-checking-demo.js

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+
+/**
+ * Type Checking Demo
+ *
+ * This file demonstrates the strict type checking and autocomplete features
+ * of the TestDriver SDK. Open this file in VS Code and notice:
+ *
+ * 1. Method autocomplete when you type `client.`
+ * 2. Parameter autocomplete for enum values like action, direction, method
+ * 3. Inline documentation showing parameter types and descriptions
+ * 4. Type warnings if you use invalid values
+ */
+
+const TestDriver = require("../../sdk.js");
+
+async function typeCheckingDemo() {
+  const client = new TestDriver(process.env.TD_API_KEY);
+
+  await client.auth();
+  await client.connect();
+
+  // Try typing these and see the autocomplete:
+
+  // 1. Action parameter - should autocomplete: 'click', 'right-click', 'double-click', 'hover', 'drag-start', 'drag-end'
+  await client.hoverText("Submit", null, "click");
+
+  // 2. Scroll direction - should autocomplete: 'up', 'down', 'left', 'right'
+  await client.scroll("asdf", 300);
+
+  // 3. Text match method - should autocomplete: 'ai', 'turbo'
+  await client.waitForText("Welcome", 5000, "turbo");
+
+  // 4. Keyboard keys - should autocomplete all valid keys
+  await client.pressKeys(["enter", "tab", "escape"]);
+
+  // 5. Exec language - should autocomplete: 'js', 'pwsh'
+  await client.exec("js", 'console.log("Hello")', 5000);
+
+  // 6. Scroll method - should autocomplete: 'keyboard', 'mouse'
+  await client.scrollUntilText("Contact", "down", 10000);
+
+  await client.disconnect();
+}
+
+// Uncomment to run:
+// typeCheckingDemo().catch(console.error);
+
+module.exports = typeCheckingDemo;

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

@@ -0,0 +1,84 @@
+import {
+  afterAll,
+  afterEach,
+  beforeAll,
+  beforeEach,
+  describe,
+  expect,
+  it,
+} from "vitest";
+import {
+  addDashcamLog,
+  authDashcam,
+  createTestClient,
+  launchChrome,
+  setupTest,
+  startDashcam,
+  stopDashcam,
+  teardownTest,
+  waitForPage,
+} from "./setup/testHelpers.mjs";
+
+describe.sequential("Type Test", () => {
+  let testdriver;
+
+  beforeAll(async () => {
+    testdriver = createTestClient({ task: { id: "type-test-suite" } });
+    await setupTest(testdriver, { prerun: false }); // Skip prerun, we'll handle dashcam manually
+
+    // One-time dashcam setup (auth and add logs)
+    await authDashcam(testdriver);
+    await addDashcamLog(testdriver);
+    await launchChrome(testdriver);
+    await waitForPage(testdriver, "TestDriver.ai Sandbox");
+  });
+
+  beforeEach(async () => {
+    await startDashcam(testdriver);
+  }, 60000);
+
+  afterEach(async (context) => {
+    // Stop dashcam first to get the URL
+    const dashcamUrl = await stopDashcam(testdriver);
+    console.log("📤 Dashcam URL:", dashcamUrl);
+
+    // Use teardownTest to track results, but skip postrun (already stopped dashcam) and disconnect
+    await teardownTest(testdriver, {
+      task: context.task,
+      dashcamUrl: dashcamUrl, // Pass the dashcam URL we already got
+      postrun: false, // Skip postrun since we manually stopped dashcam
+      disconnect: false, // Don't disconnect, we'll do that in afterAll
+    });
+  });
+
+  afterAll(async () => {
+    await testdriver.disconnect();
+  });
+
+  it("should enter standard_user in username field", async () => {
+    await testdriver.focusApplication("Google Chrome");
+    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 () => {
+    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/verify-element-api.js

@@ -0,0 +1,89 @@
+#!/usr/bin/env node
+
+/**
+ * Verify Element class API
+ * Tests that all expected methods and properties are available
+ */
+
+async function verify() {
+  // Create a test element instance - need to access Element class directly
+  const { Element } = require("./sdk.js");
+  const elem = new Element("test", null, null, null);
+
+  console.log("Verifying Element class API...\n");
+
+  // Check methods exist
+  const methods = [
+    "find",
+    "found",
+    "click",
+    "hover",
+    "doubleClick",
+    "rightClick",
+    "mouseDown",
+    "mouseUp",
+    "getCoordinates",
+    "getResponse",
+  ];
+
+  let passed = 0;
+  let failed = 0;
+
+  console.log("Testing methods:");
+  methods.forEach((method) => {
+    if (typeof elem[method] === "function") {
+      console.log(`  ✓ ${method}()`);
+      passed++;
+    } else {
+      console.log(`  ✗ ${method}() - MISSING`);
+      failed++;
+    }
+  });
+
+  // Test property getters (should return null when element not found)
+  const props = [
+    "x",
+    "y",
+    "centerX",
+    "centerY",
+    "width",
+    "height",
+    "confidence",
+    "screenshot",
+    "boundingBox",
+    "text",
+    "label",
+  ];
+
+  console.log("\nTesting properties (should be null when not found):");
+  props.forEach((prop) => {
+    if (prop in elem) {
+      const value = elem[prop];
+      if (value === null) {
+        console.log(`  ✓ ${prop} = null`);
+        passed++;
+      } else {
+        console.log(`  ✗ ${prop} = ${value} (expected null)`);
+        failed++;
+      }
+    } else {
+      console.log(`  ✗ ${prop} - MISSING`);
+      failed++;
+    }
+  });
+
+  console.log("\n" + "=".repeat(50));
+  console.log(`Results: ${passed} passed, ${failed} failed`);
+  console.log("=".repeat(50));
+
+  if (failed > 0) {
+    process.exit(1);
+  } else {
+    console.log("\n✅ All Element API verification tests passed!");
+  }
+}
+
+verify().catch((err) => {
+  console.error("Error:", err);
+  process.exit(1);
+});

package/vitest.config.example.js

@@ -0,0 +1,19 @@
+import { defineConfig } from "vitest/config";
+import testDriverPlugin from "./interfaces/vitest-plugin.mjs";
+
+export default defineConfig({
+  plugins: [
+    testDriverPlugin({
+      apiKey: process.env.TD_API_KEY,
+      apiRoot: process.env.TD_API_ROOT || "https://testdriver-api.onrender.com",
+    }),
+  ],
+
+  test: {
+    // Optional: Configure test timeout
+    testTimeout: 30000,
+
+    // Optional: Configure hooks timeout
+    hookTimeout: 30000,
+  },
+});

package/vitest.config.mjs

@@ -0,0 +1,65 @@
+import { config } from "dotenv";
+import { defineConfig } from "vitest/config";
+import testDriverPlugin from "./interfaces/vitest-plugin.mjs";
+
+// Load environment variables from .env file
+config();
+
+export default defineConfig({
+  plugins: [
+    testDriverPlugin({
+      apiKey: process.env.TD_API_KEY,
+      apiRoot: process.env.TD_API_ROOT || "https://testdriver-api.onrender.com",
+    }),
+  ],
+
+  test: {
+    // Test file patterns
+    include: ["**/testdriver/acceptance-sdk/*.test.mjs"],
+
+    // Setup file to initialize plugin in worker processes
+    setupFiles: ["./testdriver/acceptance-sdk/setup/vitestSetup.mjs"],
+
+    // Timeout settings
+    testTimeout: 600000, // 10 minutes per test
+    hookTimeout: 600000, // 10 minutes for setup/teardown
+    teardownTimeout: 120000, // 2 minutes for teardown specifically
+
+    globalTeardown: "./testdriver/acceptance-sdk/setup/globalTeardown.mjs",
+
+    // Reporter configuration
+    reporters: [
+      "verbose", // Detailed console output with full logs
+      ["junit", { outputFile: "test-results/junit.xml" }],
+      ["json", { outputFile: "test-results/results.json" }],
+      ["html", { outputFile: "test-results/index.html" }],
+      [
+        "./interfaces/vitest-plugin.mjs",
+        {
+          apiKey: process.env.TD_API_KEY,
+          apiRoot:
+            process.env.TD_API_ROOT || "https://testdriver-api.onrender.com",
+        },
+      ], // TestDriver test recording
+    ],
+
+    // Use forks for isolation, run tests in parallel
+    pool: "forks",
+    poolOptions: {
+      forks: {
+        singleFork: false,
+        maxForks: 5, // Reduced from 10 to prevent resource contention
+        minForks: 1,
+      },
+    },
+
+    // Enable parallel execution
+    sequence: {
+      concurrent: true,
+      shuffle: false,
+    },
+
+    fileParallelism: true,
+    maxConcurrency: 5, // Reduced from 10 to match maxForks
+  },
+});

package/vitest.config.mjs.bak

@@ -0,0 +1,44 @@
+import { config } from "dotenv";
+import { defineConfig } from "vitest/config";
+
+// Load environment variables from .env file
+config();
+
+export default defineConfig({
+  test: {
+    // Test file patterns
+    include: ["**/testdriver/acceptance-sdk/*.test.mjs"],
+
+    // Timeout settings
+    testTimeout: 600000, // 2 minutes per test
+    hookTimeout: 600000, // 1 minute for setup/teardown
+
+    globalTeardown: "./testdriver/acceptance-sdk/setup/globalTeardown.mjs",
+
+    // Reporter configuration
+    reporters: [
+      "verbose", // Detailed console output with full logs
+      ["junit", { outputFile: "test-results/junit.xml" }],
+      ["json", { outputFile: "test-results/results.json" }],
+      ["html", { outputFile: "test-results/index.html" }],
+    ],
+
+    // Use forks for isolation, run tests in parallel
+    pool: "forks",
+    poolOptions: {
+      forks: {
+        singleFork: false,
+        maxForks: 10, // Run up to 10 tests in parallel
+      },
+    },
+
+    // Enable parallel execution
+    sequence: {
+      concurrent: true,
+      shuffle: false,
+    },
+
+    fileParallelism: true,
+    maxConcurrency: 10,
+  },
+});

package/.github/workflows/acceptance-v6.yml

@@ -1,169 +0,0 @@
-name: v6 Acceptance [disabled]
-
-on:
-  workflow_dispatch:
-  push:
-    branches:
-      - main
-    paths-ignore:
-      - "docs/**"
-  pull_request:
-    branches:
-      - main
-
-  schedule:
-    - cron: "0 0 * * *"
-
-jobs:
-  # Job to gather all test files
-  test-setup:
-    runs-on: ubuntu-latest
-    outputs:
-      testmo-run-id: ${{ steps.run-tests.outputs.testmo-run-id }}
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 22
-          cache: npm
-      - run: npm ci
-
-      # Optionally add a couple of fields such as the git hash and link to the build
-      - run: |
-          npx @testmo/testmo-cli automation:resources:add-field --name git --type string \
-            --value ${GITHUB_SHA:0:7} --resources resources.json
-          RUN_URL="$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"
-          npx @testmo/testmo-cli automation:resources:add-link --name build \
-            --url $RUN_URL --resources resources.json
-
-      # Create test run
-      - run: |
-          npx @testmo/testmo-cli automation:run:create \
-            --instance "$TESTMO_URL" \
-            --project-id 1 \
-            --name "TestDriver Acceptance Tests" \
-            --resources resources.json \
-            --source "TestDriver" > testmo-run-id.txt
-          ID=$(cat testmo-run-id.txt)
-          echo "testmo-run-id=$ID" >> $GITHUB_OUTPUT
-        env:
-          TESTMO_URL: ${{ secrets.TESTMO_URL }}
-          TESTMO_TOKEN: ${{ secrets.TESTMO_TOKEN }}
-        id: run-tests
-  gather:
-    name: Gather Test Files
-    runs-on: ubuntu-latest
-    outputs:
-      test_files: ${{ steps.test_list.outputs.files }}
-    steps:
-      - name: Check out repository
-        uses: actions/checkout@v2
-
-      - name: Find all test files
-        id: test_list
-        run: |
-          FILES=$(ls ./testdriver/acceptance/*.yaml)
-          FILENAMES=$(basename -a $FILES)
-          FILES_JSON=$(echo "$FILENAMES" | jq -R -s -c 'split("\n")[:-1]')
-          echo "files=$FILES_JSON" >> $GITHUB_OUTPUT
-  test:
-    needs:
-      - gather
-      - test-setup
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        test: ${{ fromJson(needs.gather.outputs.test_files) }}
-      max-parallel: 8
-      fail-fast: false
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "20"
-          cache: "npm"
-
-      - name: Install dependencies
-        run: NODE_ENV=production npm ci
-      - name: Run test in headless mode
-        run: node bin/testdriverai.js run testdriver/acceptance/${{ matrix.test }} --junit=out.xml
-        env:
-          FORCE_COLOR: 3
-          TD_API_KEY: ${{ secrets.TESTDRIVER_API_KEY }}
-          TD_WEBSITE: https://testdriver-sandbox.vercel.app
-          TD_THIS_FILE: ${{ matrix.test }}
-      - run: ls
-      - name: Upload JUnit report to Testmo
-        if: always()
-        run: |
-          npx @testmo/testmo-cli automation:run:submit-thread \
-            --instance "$TESTMO_URL" \
-            --run-id "${{ needs.test-setup.outputs.testmo-run-id }}" \
-            --results out.xml \
-        env:
-          TESTMO_URL: ${{ secrets.TESTMO_URL }}
-          TESTMO_TOKEN: ${{ secrets.TESTMO_TOKEN }}
-
-      - name: Upload test results as artifact
-        if: always()
-        uses: actions/upload-artifact@v4
-        with:
-          name: test-results-${{ matrix.test }}
-          path: out.xml
-          retention-days: 30
-
-  test-complete:
-    needs: [test-setup, test]
-    if: always()
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 19
-          cache: npm
-      - run: npm ci
-
-      # Download all test result artifacts
-      - name: Download test results
-        uses: actions/download-artifact@v4
-        with:
-          pattern: test-results-*
-          path: test-results
-          merge-multiple: true
-
-      # Debug: Check what files were downloaded
-      - name: Debug downloaded files
-        run: |
-          echo "=== Contents of test-results directory ==="
-          find test-results -type f -name "*.xml" -ls
-          echo "=== Directory structure ==="
-          ls -la test-results/
-          echo "=== XML file contents preview ==="
-          for file in test-results/*.xml; do
-            if [ -f "$file" ]; then
-              echo "--- Content of $file ---"
-              head -10 "$file"
-              echo ""
-            fi
-          done
-
-      # Mark test run completed
-      - run: |
-          npx @testmo/testmo-cli automation:run:complete \
-            --instance "$TESTMO_URL" \
-            --run-id "${{ needs.test-setup.outputs.testmo-run-id }}"
-        env:
-          TESTMO_URL: ${{ secrets.TESTMO_URL }}
-          TESTMO_TOKEN: ${{ secrets.TESTMO_TOKEN }}
-      - name: Test Summary
-        uses: test-summary/action@v2
-        with:
-          paths: "test-results/**/*.xml"
-        if: always()

package/docs/overview/comparison.mdx

@@ -1,82 +0,0 @@
----
-title: Comparison
-sidebarTitle: "Comparison"
-description: "TestDriver vs Playwright vs Selenium"
-icon: boxing-glove
----
-
-## Application support
-
-TestDriver operates a full desktop environment, so it can run any application.
-
-<div className="comparison-table">
-  | Application | TestDriver | Playwright | Selenium |
-  |:-----------------:|:---------:|:-----------:|:--------:| | Web Apps | ✅ |
-  ✅ | ✅ | | Mobile Apps | ✅ | ✅ | ✅ | | VS Code | ✅ | ✅ | ✅ | | Desktop
-  Apps | ✅ | | | | Chrome Extensions | ✅ | | |
-</div>
-
-## Testing features
-
-TestDriver is AI first.
-
-<div className="comparison-table">
-  | Feature | TestDriver | Playwright | Selenium |
-  |:--------------------:|:---------:|:----------:|:--------:| | Test Generation
-  | ✅ | | | | Adaptive Testing | ✅ | | | | Visual Assertions | ✅ | | | | Self
-  Healing | ✅ | | | | Application Switching | ✅ | | | | GitHub Actions | ✅ |
-  ✅ | | | Team Dashboard | ✅ | | | | Team Collaboration | ✅ | | |
-</div>
-
-## Test coverage
-
-TestDriver has more coverage than selector-based frameworks.
-
-<div className="comparison-table">
-| Feature            | TestDriver | Playwright | Selenium |
-|:------------------:|:----------:|:----------:|:--------:|
-| Browser Viewport   | ✅            | ✅       | ✅       |
-| Browser App        | ✅            |          |        |
-| Operating System   | ✅            |          |        |
-| PDFs               | ✅            |          |        |
-| File System        | ✅            |          |        |
-| Push Notifications | ✅            |          |        |
-| Image Content      | ✅            |          |        |
-| Video Content      | ✅            |          |        |
-| `<iframe>`         | ✅            |          |        |
-| `<canvas>`         | ✅            |          |        |
-| `<video>`          | ✅            |          |        |
-</div>
-
-## Debugging features
-
-Debugging features are powered by [Dashcam.io](https://dashcam.io).
-
-<div className="comparison-table">
-  | Feature | TestDriver | Playwright | Selenium |
-  |:------------------:|:----------:|:----------:|:--------:| | AI Summary | ✅
-  | | | | Video Replay | ✅ | ✅ | | | Browser Logs | ✅ | ✅ | | | Desktop Logs
-  | ✅ | | | | Network Requests | ✅ | ✅ | | | Team Dashboard | ✅ | | | | Team
-  Collaboration | ✅ | | |
-</div>
-
-## Web browser support
-
-TestDriver is browser agnostic and supports any version of any browser.
-
-<div className="comparison-table">
-  | Feature | TestDriver | Playwright | Selenium |
-  |:--------:|:----------:|:----------:|:--------:| | Chrome | ✅ | ✅ | ✅ | |
-  Firefox | ✅ | ✅ | ✅ | | Webkit | ✅ | ✅ | ✅ | | IE | ✅ | | ✅ | | Edge |
-  ✅ | ✅ | ✅ | | Opera | ✅ | | ✅ | | Safari | ✅ | | ✅ |
-</div>
-
-## Operating system support
-
-TestDriver currently supports Mac and Windows!
-
-<div className="comparison-table">
-  | Feature | TestDriver | Playwright | Selenium |
-  |:--------:|:----------:|:----------:|:--------:| | Windows | ✅ | ✅ | ✅ | |
-  Mac | ✅ | ✅ | ✅ | | Linux | | ✅ | ✅ |
-</div>

package/testdriver/lifecycle/prerun.yaml

@@ -1,17 +0,0 @@
-version: 6.0.0
-steps:
-  - prompt: launch chrome
-    commands:
-      - command: exec
-        lang: pwsh
-        code: dashcam track --name=TestDriver --type=application --pattern="C:\Users\testdriver\Documents\testdriver.log"
-      - command: exec
-        lang: pwsh
-        code: dashcam start
-      - command: exec
-        lang: pwsh
-        code: |
-          Start-Process "C:/Program Files/Google/Chrome/Application/chrome.exe" -ArgumentList "--start-maximized", "--guest", "https://testdriver-sandbox.vercel.app/login"
-      - command: wait-for-text
-        text: "TestDriver.ai Sandbox"
-        timeout: 60000