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 Library

Keep track of your tests

The Test Library screen (Test List -> Tests) is where you will manage your tests. Tests can be arranged in folders. All folders and tests within the current project are listed on this screen and you can perform a variety of actions on each of these tests, as described below.

Viewing the Test Library

The Test Library screen displays a list of tests and folders with the following information:

  • Name - the name of the test or folder.
  • Author - the author of the test or folder.
  • Kind - indicates whether the item is a test or folder.
  • Label - a list of labels that were added to the test. For more information, see Labels.
  • Last Runs - indicates the status of the last 10 remote runs. Each vertical line represents a test run. Green lines indicate passed tests. Red lines indicate failed tests. Yellow lines indicate passed tests that only passed after a retry. If less than ten tests have been run, the remaining lines will be grey. The or icon indicates the status of the most recent test. indicates failed; indicates passed. Click the indicator to access the Test runs screen. For more information, see Test runs.

Filtering the Test Library

You can filter your tests by label, author, and the shared steps that they contain.
To filter the Test Library:

  1. Click the Advanced filters icon.

The Filter Tests pane opens on the right hand side.

  1. In the Filter Test pane select one or more filter criteria.

📘

You can also search for criteria within each section of the Filter Test pane by clicking on the Search (magnifying glass) icon and entering your search criteria in the search box that opens.

  1. Click Apply.
    The filter is applied, and only those tests that meet the criteria are shown.

📘

You can remove the filters by clicking on Reset filters and then Apply in the bottom of the Filter Test pane.

  1. Click the "X" in the upper right of the Filter Test pane to close it.

📘

Closing the Filter Test pane without resetting the filters will not reset them, and only the tests that meet the filter criteria will be shown. To view all of your tests and folders again, you will need to reopen the Filter Test pane and click Reset filters.

Search text box

You can use the search text box to find tests or folders based on their names, descriptions, and labels. The process for searching based on labels is slightly different than searching based on names and descriptions. In both cases, you enter your search criteria in the Search library box.

Examples of Special Syntax:

  • AND Searches: Adding a second search term (separated by a space) will act as an AND search. In the case of labels, your second term needs to be preceded by the term label:.
  • Exclusion Searches: Preceding a search term with a minus sign (without a space) will act a NOT search. If you have more than one term, be sure to add a space between the terms. In the case of labels, your second term needs to be preceded by the term label.

To search by names and descriptions:

  1. In the Search library text box, enter any text from the name or description of the tests or folders you want to find.
    The resulting list is filtered immediately as you type each character.

To search by labels:

  1. In the Search library text box, enter the text label: followed by the complete name of the label (without a space between them).
    The filtered list is shown after you enter the complete name of the label.

Label search example:
If you've labeled all the tests that still fail with the "Failed" label, you can filter as follows:

label:Failed
  • Exclusion - use the - modifier to exclude a specific label or name/string. For example, if you want to get all the tests in the label "sanity" that didn't fail:
label:sanity -label:failed

📘

Whether you search by names/descriptions or labels, the resulting list includes results in a flat view, so all tests or folders that are nested within folders that match the search criteria will also be shown. To view the location of any of the results, click on its row. The location is shown on the bottom of the screen.

Opening a test

You can open a test in the Editor by double-clicking on the desired test. If the test is inside a folder or sub-folder, you need to drill-down by double clicking on each folder and sub-folder until you reach the desired test and then double-click on the test to open it.

📘

When you open a folder, a breadcrumbs navigation appears at the top of the page, enabling you to navigate back to the root folder.

Running tests

You can run a test or multiple tests directly from the Test Library.
To run tests:

  1. Click on the test name to select it.

📘

You can select multiple tests by holding down the ctrl/cmd key and then clicking on each of the desired tests.
If there are no folders in your Test Library, you can also select all of your tests by holding down the ctrl/cmd key + A on the keyboard.

  1. Click the Play icon (or right-click on the test name and choose Play from the right-click menu).

The Run Test Locally window opens.

  1. If you would like to run the test in Incognito mode, select Run in Incognito mode.
  2. If you would like the test to use a different base URL than the one originally configured in the test, select Override Base URL and enter the URL in the field that is shown. For more information, see Base URL.
  3. Click OK.

🚧

Avoid touching your mouse and keyboard while the test is running.

The Suite Runs tab of the Runs screen opens at the same time as the AUT (application under test) browser. The test is run in the AUT browser, and you can view the results in the Suite Runs tab.

Exporting to CSV

You can export a list of your tests to a csv file. The following information is included for each test: name, description, label/s, last run status, author, and path.
To export test information to csv:

  1. Click on the Export to CSV icon.

The csv file is downloaded to your local machine.
Note: when searching/filtering the CSV will only contain the matching items.

Updated 2 months ago

Test Library


Keep track of your tests

Suggested Edits are limited on API Reference Pages

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