DOCSEARCHbyAlgolia
Submit Docs

Testplane Documentation

website·Indexed 32 days ago

https://testplane.io

An end-to-end testing solution for browser automation. Features include the Testplane MCP for AI agent interaction with DOM structures, a built-in HTML Reporter with a plugin SDK, and support for both WebDriver and Chrome DevTools Protocol (CDP). The platform provides tools for test selectivity, a standalone API for browser instance management, and integration with GitHub Actions.

Tokens
227.2K
Snippets
1.3K
Records
1.6K
Agent score
68%

What's inside Testplane

  1. Overview of Testplane AI integration tools

    Testplane provides a suite of AI integration tools designed to transform generic coding agents into Testplane experts. These tools enable agents to write, inspect, debug, and fix tests by providing token-efficient DOM snapshots, handling authentication securely, and allowing agents to investigate failures from CI reports or debug via a REPL.

  2. Overview of the Testplane htmlReporter API

    v8
    The htmlReporter object is added to the testplane object and provides an API to customize the HTML report, manage its data storage, and manipulate the report databases. Key components include interfaces for saving assets (images, reports, snapshots) and methods for merging databases and adding custom menu items.

  3. Overview of the stat-reporter plugin for Testplane

    The stat-reporter plugin provides test run statistics for Testplane. It generates reports split by browser, displaying the status (passed/failed), total tests, passed/failed/skipped counts, retries, and total execution duration. Reports can be output to the console, as an HTML file, or as a JSON file; these formats are not mutually exclusive and can be used simultaneously.

  4. Overview of Testplane Time Travel

    v8
    Time Travel is a Testplane UI tool that records and replays test progress by capturing snapshots of the actual DOM tree rather than videos or screenshots. This allows for efficient storage (average snapshot size ~200KB) and the ability to use browser DevTools to inspect selectors and attributes during replay. It is available in both the GUI and static CI reports.

  5. Overview of Testplane v8 capabilities

    v8
    Testplane is a tool for automating user scenario testing in web interfaces. It integrates WebDriverIO v9 commands, the Chrome DevTools Protocol (CDP), and Mocha syntax. Key capabilities include parallel test execution across different browsers and platforms, automatic stitching of large images that exceed the viewport, and a comprehensive HTML report for managing large volumes of test results.

  6. Overview of Testplane AI integration capabilities

    v8

    Testplane provides a suite of tools to transform generic coding agents into Testplane experts. These tools enable AI agents to:

    • Explore applications using token-efficient DOM snapshots.
    • Generate new tests based on actual application state.
    • Handle authentication securely without exposing secrets.
    • Investigate failures using CI reports.
    • Debug tests via a REPL.
    • Analyze Time Travel snapshots to adjust tests as the application evolves.

  7. Overview of @testplane/test-repeater

    v8
    The @testplane/test-repeater plugin is used to run a specific test or group of tests a set number of times, regardless of whether the tests pass or fail. This is primarily used to verify test stability. It can be configured to run each attempt in a new browser session to prevent browser degradation or side effects from previous runs.

  8. Overview of testplane E2E testing framework

    testplane is an open-source end-to-end (E2E) testing framework designed to work at any scale, across any browser, and on any platform. It supports modern browsers, real Android/iOS devices, and Smart TVs/IoT devices via Appium. Key capabilities include:

    • Scalability: Supports remote browser grids (e.g., BrowserStack), sharding, parallel execution, and test isolation.
    • Extensibility: Features a plugin system for custom reporters, execution logic, and commands.
    • Visual Testing: Includes visual assertions, a UI for screenshot management, and multiple diff modes.
    • Reliability: Combines auto-wait, browser context isolation, smart retries, and automatic animation handling to reduce test flakiness.
    • Tooling: Provides an HTML reporter, a responsive GUI mode, a tests/plugin profiler, and live test editing.

  9. Overview of Testplane configuration sections

    v8

    Testplane configuration is divided into several functional sections:

    • browsers: (Mandatory) Settings for browsers where tests will run.
    • sets: Binds groups of tests to specific browsers for targeted execution (e.g., desktop vs mobile).
    • system: System-level settings like subprocess counts and WebDriver debug mode.
    • plugins: Integration of external plugins.
    • prepareBrowser: A function to prepare the browser or add commands to the browser object before tests run.
    • prepareEnvironment: A function to set environment variables or supplement config parameters.
    • devServer: Configuration for automatically launching a development server before tests.
    • lastFailed: Configuration for rerunning only the tests that failed in the previous run.

  10. Overview of @testplane/retry-progressive

    v8
    The @testplane/retry-progressive plugin allows Testplane to perform additional retries on tests that fail due to infrastructural issues (e.g., network blinks, DNS problems, browser crashes, or session timeouts) rather than developer errors. It triggers these retries only if the error message matches a predefined set of patterns.

  11. Overview of @testplane/retry-limiter

    v8
    The @testplane/retry-limiter plugin is designed to limit the number of retries for failed tests and the duration during which retries are permitted. This is particularly useful in CI environments to prevent wasting hardware resources and developer time when a large number of tests fail due to infrastructure issues or broken project code.

  12. Overview of Testplane MCP capabilities

    v8

    Testplane MCP allows AI agents to interact with browsers in real-time to analyze page states and generate tests based on actual DOM structures. Key capabilities include:

    • Enhanced Test Generation: AI agents can open pages, analyze layouts, and perform actions (like clicking or filling forms) to ensure generated tests use selectors that actually exist on the page.
    • Browser Process Automation: Automates repetitive tasks, such as extracting data from images (e.g., payment receipts) and inputting that data into web forms.