Launchers / Automated tests

Testim Launcher (testim.jar)

The Testim launcher allows interfacing with Testim execution plateform.

Configuration

The testim.xml file is just a template and must NOT be edited. It's used by the system to build dynamically the form that the user will be able to fill in from the GUI when creating a custom execution configuration.

Parameter Description
Testim
Testim URL This must indicate the URL of Testim server

Default value is: https://api.testim.io
API Key This must indicate the API Key to authenticate to the server.

Default value is: PAK-hdRIBXXXXXXXXXXX
Grid name This must indicate the name of the grid to use for execution.

Default value is: xxxxxx
JSON options This must indicate a json string containing the options you want to use for the execution.

Default value is: "parallel": 2, "resultLabels": xstudio

These values can be changed while creating the campaign session from XQual.
Note about file path parameters:
Any parameter referring to a file or folder path (for instance Test root path) can be provided either using \ separator (if the tests are going to be executed on a Windows agent) or / separator (if the tests are going to be executed on a linux or MacOSX agent).

On windows, if you provide a path containing an OS-localizable folder such as C:\Program Files, always prefer the English version (i.e. NOT C:\Programmes if you're using a french-localized Windows) or the corresponding native environment variable (i.e. %PROGRAMFILES%).


Process

The tests are executed by the launcher using this syntax:

Get the test id from its name

tests/search?name=<testName>

Run the test

tests/run/<testId>
The body contains a json with all the options.

Wait for the test to complete

runs/executions/<testExecutionId>
Until execution result is 'Passed', 'Failed', 'Aborted' or 'Timeout'.



The test will be marked as passed or failed depending on the status reported by Testim in the json returned.
Start time, browser, duration are also reported.