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

Testim overview

Testim is the fastest way to resilient end-to-end tests, your way—in code, codeless, or both.

At Testim, we too are developers and testers, striving to release quality software faster. We built Testim because writing stable end-to-end tests was just too hard. We were the first to build an AI-based functional test automation solution. Since we launched in late 2014, we've been adding features, improving quality, and evolving our solution with customers every day. To read more about our product features, pricing, or even some of our latest blogs, check out Testim.io.

📘

Testim Products

Testim has two products, Testim Automate and Testim Root Cause.

Testim Automate

Testim Automate is a full-featured test automation platform enabling fast authoring of stable tests.

Author tests—your way

There are two ways to create tests in Testim—record them using the Testim Extension or code them in your IDE. Actually, there's a third and recommended approach for those who want to code—record the test, export it as code and modify it in your IDE.

Record a test - Generally, the fastest way to write a test is to record it. This is fairly easy to do, using the Testim Extension. You simply start a recording within the Testim visual editor, record steps in your application by clicking, selecting menu options, typing in text, etc. The result is a step-by-step test that can be edited within the visual editor. The great part about recording a test is that it uses Testim's algorithm to uniquely identify each element and its parameters. Our AI uses what we call, Smart Locators to evaluate hundreds of attributes and score them so that if elements change, your tests don’t break.

Code your first test with the Testim Dev Kit - As mentioned above, the fastest way to code a test is to first record a user flow and then export that test to code. You can also start by writing a test directly in code calling on the Testim JavaScript API to create user actions like "click", "scroll", or "drag and drop". You can run your test locally from your IDE and debug it in real-time.

Customize tests

Testim has many features built into the visual test editor to help you customize your tests. You can also export your test as code and customize it your IDE, the choice is yours.

Visual test editor

We've built a lot of features right into the editor so there's no need to write code if you don't want to. Here are a few examples (Hint: There are waaaay more, just search for what you need):

  • Groups - You can group steps and reuse them. You can nest groups within groups. Grouping helps you architect tests so that you aren't repeatedly creating the same steps. You can also create more efficient test architecture by reusing proven steps.
  • Validations - Ensure the output of a test matches the expected output. You can configure validations for data, PDFs, email, Word docs, and much more.
  • Conditions - Configure a step or group of steps to run (or skip) if certain conditions are met (or absent).
  • Smart Locators - These make your tests stable. However, you may want to adjust the settings so that they are more or less strict, or even prioritize different attributes. We give you the information to see how Smart Locators are weighting attributes and the ability to override.
  • Loops - Run the same step multiple times until you get the expected output.
  • Data-driven testing - Integrate test data to push input or boundary conditions. Link a CSV, Excel, or JSON file to reference your data.
  • Custom validation and actions - Okay, for this one you do need to write some code. But it does give you the flexibility to execute in the browser on any step.

Edit code in your IDE

Since you can write tests in your IDE, of course, you can edit them there as well. Add loops, waits, IFs, fors, or whatever coding magic you want, because it's code. See the full Dev Kit API

Execute your tests

Run and troubleshoot your tests locally. When you are ready, you can schedule, trigger by CI or run on demand. Tests can be parallelized and across all browsers on our test cloud or any Selenium-compatible test cloud.

Test grid - Also known as a test cloud, test grids allow you to test multiple virtual (and sometimes physical) devices and configurations in parallel. It can greatly speed up test execution.

Cross-browser - You will want to make sure that your application runs the same way in Safari as it does in Edge. Cross-browser support lets you simulate different desktop and mobile web browsers in parallel.

CI integrations - We easily integrate with Continuous Integration tools so that your tests can run automatically at desired process points.

Report results

Regardless of how your tests were created (code or codeless) when they run, you will see the results in Testim so you can troubleshoot and capture bugs. You'll also want to show your team all of the great work you've been doing and that releases are ready to ship.

Root cause analysis - We aggregate error types so that you can quickly identify problems that are affecting multiple tests. You'll have tools including screenshots, console logs, and HTML DOM info at your fingertips.

Test results - Measure team and test suite performance. See how tests are trending over time.

Bug capture - Bug reporting is really easy with our capture tool. Capture screenshots, video, add a description of the error and then pop it into a bug tracker—in less than 60 seconds.

Root Cause is a Testim led open-source project and cloud service that provides troubleshooting capabilities for Puppeteer and Playwright tests.

Root Cause OSS Local

Root Cause OSS Local is an open-source project, which is maintained on GitHub www.github.com/testimio/root-cause. The locally installed version of Root Cause captures screenshots, network HAR files, and console logs from each test run and saves them to a local drive. The screenshots highlight the action taken at each step and are easily viewed in succession through an intuitive UI to demonstrate the test flow or to identify where a test failed. Additionally, the console logs are parsed to each test step and the network HAR is available to help troubleshoot failed steps.

Root Cause Cloud

Root Cause Cloud is a SaaS-based service where you can store and share your Puppeteer and Playwright test results online for better collaboration. Root Cause Cloud offers all the features that are available in the Root Cause OSS Local version, but instead of storing the screenshots and log data locally, they are stored, accessed and shared online. In addition, Root Cause Cloud offers access to test lists, test run history, aggregated statistics, historical trends, and much more.

📘

Changelog

See what's new with Testim. We publish a running list of new features on the Testim changelog.

Updated 21 days ago


Testim overview


Testim is the fastest way to resilient end-to-end tests, your way—in code, codeless, or both.

Suggested Edits are limited on API Reference Pages

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