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

Grid management

Configure your grid to run tests remotely (inc. Sauce labs, Browserstack and others.)

To run your tests remotely, you will need a selenium grid.
Testim can integrate with different grids:

  • Testim cloud grid - We can provide you with a private grid. If you don't already have it, contact us to find out which option fits you.
  • Local grids - If you have a selenium grid, we can integrate with it.
  • We can integrate with third party grids like Saucelabs and Browserstack.
    In this article, we'll go through the steps to set your grid so you can start running your tests remotely.

How to add a grid

  • Navigate to Company view and then to "Grids" tab.
  • Click "+" in the top right corner of the screen.
  • Choose a grid type: Custom grid, Saucelabs, or Browserstack.
  • Update the relevant fields (below you'll find details about the different options).
  • Click "Add"
    To edit / delete a grid, hover the grid setup box and click the desired option.

Note:
If your plan includes a Testim grid, your configuration should appear automatically. If it does not, please contact our support.

Custom grid

Use this option if you are running on your own selenium grid.

  • Name: The grid name to use at run time.
  • Host: The selenium grid host name (domain) or IP to use.
  • Port: The selenium grid port.
    Note: Even when running locally, Testim needs to connect to your browser to show and save test results. Please make sure your network can access services.testim.io.

Saucelabs/Browserstack grid

Use this option if you are running on Saucelabs/Browserstack grids.

  • Name: The grid name to use at run time.
  • Saucelabs/Browserstack user: Saucelabs/Browserstack user to connect.
  • Saucelabs/Browserstack key: Saucelabs/Browserstack key to connect.
  • Host: Saucelabs/Browserstack host name.
  • Port: Saucelabs/Browserstack port.

How to run on the grid

You can run your tests remotely using one of the following methods:

CLI/ CI
Add --grid parameter with the grid name.

Scheduler
Use Grid field to choose on which grid to run your tests.

Test Plan
Use Grid field to choose on which grid to run your tests.

From the editor

You can run your test on the grid directly from the test editor.

  • Click on the options arrow next to the "Run" button
  • Click on "Run on a grid".
    To change the configuration/grid/base url for that run click on "Edit".

Note: Grid parameter replaces the old host and port parameters.

Updated about a month ago

Grid management


Configure your grid to run tests remotely (inc. Sauce labs, Browserstack and others.)

Suggested Edits are limited on API Reference Pages

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