The TestRail integration allows you to connect Ranorex Studio and TestRail. You can import and export tests, synchronize between the two programs, and report results from test runs in Ranorex Studio to TestRail in real time.
Getting started
Before we can start connecting to TestRail, we first need to make sure it’s configured correctly. Please refer to the respective sections of the TestRail User Guide for more information.
Configuring TestRail
Note
To make the following settings, you will need to have Admin privileges in TestRail.
Enable API
TestRail’s API needs to be enabled so Ranorex Studio and TestRail can interact.
Go to Administration > Site Settings > API and check the Enable API option.
Permissions
Depending on how you use the TestRail integration, you will need certain permissions. To set them, go to Administration > Users & Roles and create a role with the appropriate permissions or change the permissions of an existing role. Then assign that role to the respective users.
- Importing into Ranorex Studio: No permissions are required.
- Exporting to existing projects: Add/Edit Cases & Sections, Suites.
- Exporting to new projects: You need to be an admin on TestRail.
- Reporting results to an existing TestRail run: Add/Edit Test Results.
- Reporting results to a new TestRail run: Add/Edit Runs & Plans.
Automation Type field
TestRail 5.5 and later:
The Automation Type drop-down field is already present by default. Simply set it to Ranorex.
TestRail 5.4 and earlier:
You will need to add a custom field to the user interface for importing and exporting to work correctly.
Go to Administration > Customizations > Case Fields and add a field with the following values:
- Label: Automation Type
- System Name: automation_type
- Type: Dropdown
Click Add Projects & Options and specify Ranorex as Option 1. Click the Selected Projects tab and apply the field to your projects.
Required custom fields
If you have required custom fields in TestRail, all of them should have default values set. Otherwise, an error will occur during exporting and synchronizing because Ranorex Studio won’t know what value to populate the required custom field with.
Fixing this error is explained in Importing, exporting, synchronizing.
Starting the TestRail wizard and signing in
In Ranorex Studio, open the solution you want to work with. Then go to Tools > TestRail integration > Start TestRail wizard. The wizard’s welcome screen will appear. Before you continue, make sure you’ve configured TestRail correctly. Then click Continue.
The Connect to TestRail screen will appear. Enter the server address and your credentials.
Note
The server address applies to both the TestRail on-premises and the cloud solution. You can find it in the address box of your browser.
You can save your credentials, so you won’t have to sign in again.
Click Sign in to connect to TestRail. When you start the TestRail wizard again already signed in, you can just click Continue on this screen.
The Import/Export screen will appear. Go to Importing, exporting, synchronizing to find out how this feature works.