testdriver-e2e-testing

Imported from sickn33/agentic-awesome-skills (skills/testdriver-e2e-testing/SKILL.md). Install upstream with npx skills add sickn33/agentic-awesome-skills --skill testdriver-e2e-testing. Copyright stays with the author (Apache-2.0).

TestDriver End-to-End Testing

External tool prerequisite

Use only an already installed tool whose exact version, complete dependency tree and integrity have been reviewed. This skill does not bootstrap tools or activate external plugins. If the prerequisite is missing, stop that executable path and report it; continue with static analysis when possible. A separate installation task must pin immutable artifacts, stage them outside active agent directories with lifecycle scripts disabled, inspect every bundled file and executable entry point (including tests and hooks), and obtain approval before activation or host configuration changes. Do not substitute a same-named workspace script or fetch a moving branch.

Overview

TestDriver is an AI code reviewer that actually runs your app. It automatically runs every pull request in a real desktop sandbox, finds bugs, and builds regression tests. Tests control browsers and native applications using natural language element descriptions and AI vision, and run as Vitest suites. This skill teaches an agent how to author, run, and debug TestDriver tests.

When to Use This Skill

• Use when you need to write an end-to-end test for a web or desktop application
• Use when automating a UI workflow that has no stable selectors (canvas, Electron, native apps)
• Use when the user asks to verify that a page or flow works ("check if the login page works")
• Use when debugging a failing TestDriver test

How It Works

Step 1: Set up the project

testdriverai init

This scaffolds package.json, example tests, vitest.config.mjs, and a GitHub Actions workflow. The user must set TD_API_KEY in .env (get a key at https://console.testdriver.ai/team).

Step 2: Write a test

Tests are Vitest suites using the TestDriver hooks:

import { describe, expect, it } from "vitest";
import { TestDriver } from "testdriverai/vitest/hooks";

describe("Login", () => {
  it("signs in successfully", async (context) => {
    const testdriver = TestDriver(context);
    await testdriver.provision.chrome({ url: "https://example.com/login" });

    const email = await testdriver.find("email input field");
    await email.click();
    await testdriver.type("user@example.com");

    const submit = await testdriver.find("Sign In button");
    await submit.click();

    const result = await testdriver.assert("the dashboard is visible");
    expect(result).toBeTruthy();
  });
});

Step 3: Run and iterate

vitest run tests/login.test.mjs

Screenshots are captured automatically before and after every command and saved to .testdriver/screenshots/, named with the source line number for easy debugging.

Examples

Example 1: Testing a desktop (Electron) app

await testdriver.provision.electron({ appPath: "./dist/my-app" });
const menu = await testdriver.find("File menu in the menu bar");
await menu.click();

Example 2: Waiting for slow elements

const done = await testdriver.find("Loading complete indicator", { timeout: 30000 });
await done.click();

Best Practices

• ✅ Use specific element descriptions ("blue Sign In button in the header", not "button")
• ✅ Set both testTimeout and hookTimeout to 900000 in vitest.config.mjs
• ✅ Add assert() calls for verifiable pass/fail conditions
• ✅ Always await every TestDriver call
• ❌ Do not use npx vitest; run vitest run directly
• ❌ Do not rely on CSS selectors; TestDriver locates elements visually

Limitations

• Requires a TestDriver API key (TD_API_KEY) and network access to provision sandboxes.
• Only works with Vitest as the test runner.
• This skill does not replace environment-specific validation, testing, or expert review.

Security & Safety Notes

Remote sandbox execution and automatic screenshots can transmit application data and consume account quota. Use synthetic accounts, verify allowed app/network destinations and retention, and avoid capturing real secrets or personal records. The installed tool’s actual local/remote execution mode must be confirmed rather than inferred from this guide; initialization workflows can change CI and require source review.

• testdriverai init writes project files to the current directory; run it only in a project you intend to modify.
• The TD_API_KEY credential belongs in .env (gitignored by the scaffold). Never commit it.
• Tests execute inside an isolated remote sandbox, not on the local machine.

Common Pitfalls

• Problem: Cleanup hooks fail with a 10s timeout. Solution: Set hookTimeout: 900000 in vitest.config.mjs; sandbox teardown and recording uploads take longer than Vitest's default.
• Problem: Scrolling does nothing. Solution: An input field has focus. Press Escape or click the page background first, then scroll.

Related Skills

• @webapp-testing - Playwright-based alternative for local web apps with stable DOM selectors