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

Test plans

Learn how to create a test plan which comprises all your tests, setup & teardown tests and a list of configuration to run with

Test plans are great If you need to do:

  • Set up your environment before your tests execute.
  • Clean up your environment after your tests execute.
  • Run your tests on several browsers and operating systems.

Create a new plan

  1. Navigate to "Automate", and then to "Plans" tab.
  2. Click "Create".

Edit your first plan

Add Name and Description to your plan.

Tests to run

  • Test List: Add the main tests you want to run by choosing one of the labels you have.
  • Setup: Check the "add before all" checkbox and add the setup tests you want to run, also by their label.
  • Teardown: Check the "add after all" checkbox and add the teardown tests you want by their label.

Please note:

  1. The tests in Test list WON'T be executed if one of the "before all" tests failed.
  2. The tests in "after all" will always run even if tests in Test list failed.
  3. The tests in "Before all" and "After all" will always run in parallel 1. Only the "Test List" can run higher parallel if it is set in the CLI.

Where to run:

  • Choose the grid you would like to execute your tests on. read here how to set up your grid.

What to run on:
Override default configuration: Set which Browsers, Operating Systems, and resolutions to run your tests on. Choose from your list of configurations or set a new one.
If not checked, each test will run with its default configuration (created alongside the test).

  • Override Start URL: Set the start URL of your web app (e.g. production or staging environment).

Running your Test Plan

In order to execute a test plan, you'll need to specify the plan name in your CLI command like this:

--test-plan "Test Plan Demo"
Note: If you add a different grid name to the CLI, it overrides the grid defined in the plan.

Share parameters between your test

When you use a plan you can share parameters between tests e.g. create an account in the setup and use those credentials throughout all tests.
You can read more on the exportsGlobal parameter in the parameter guide.

Updated 10 months ago

Test plans


Learn how to create a test plan which comprises all your tests, setup & teardown tests and a list of configuration to run with

Suggested Edits are limited on API Reference Pages

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