Testim Documentation

Welcome to the Testim documentation. You'll find comprehensive guides to help you get started quickly, example code snippets, and tips for being more productive. You will also find details about advanced features that allow you to customize Testim to fit your environment or special testing conditions. Don't worry, we'll support you if you get stuck. Let's jump right in!

Guides    Changelog

Getting started with Root Cause OSS

Testim Root Cause

Root Cause Node.js Installation

In order to use Root Cause, first install the Root Cause Node.js package:
(You may also use the yarn equivalent commands)

npm install @testim/root-cause -D

Using Root Cause with standalone Node code (for custom scenarios, no test runner)

Root Cause can be used as a root cause analysis (RCA) enhancement tool to any Node code test by simply adding a few lines of code to your test (no need for a test runner). Root Cause will collect root cause analysis information, such as located elements, screenshots, console logs, and other Puppeteer calls automatically and display them in an easy-to-use viewer (as explained below):
For a working example, see our examples repository

const rootcause = require('@testim/root-cause');
 
rootcause.launch({ testName: "My Root Cause test" }, async page => {
    // use the page object normally like you regularly would
 
    await page.goto('https://example.com');
    await page.click('a');
});

Updated 24 days ago


What's Next

Integrate with your test runner and view test results

Root Cause Jest integration
Root Cause Mocha integration
Viewing local results / Root Cause CLI

Getting started with Root Cause OSS


Testim Root Cause

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.