This guide explains how to enable testRigor features directly inside TestRail using a custom UI script. Once configured, you can access testRigor options from within your TestRail interface to automate test suites, cases, and runs using AI-powered execution, without leaving TestRail.
With this integration, you can:
- Link test suites in TestRail to new/existing testRigor suites
- Link test cases in TestRail to new/existing testRigor cases
- Start testRigor automated tests from within TestRail
Requirements
Before enabling the integration, make sure you have:
- A TestRail instance
- A testRigor account
- API access enabled in TestRail.
- The following two testRigor URLs added to the CSP list:
- Project permissions in TestRail to create and edit test cases and runs.
Configuration Steps
- Login to TestRail
- Go to Admin section
- Navigate to Site Settings → API → Enable API (checkbox should be checked)
- Click on “Save settings”
- Navigate to Site Settings → Security
- Enable the “CSP - Allow access TestRail to remote addresses" checkbox
- Enter “https://app.testrigor.com” and "https://cdn.testrigor.com" into the CSP input.
- Click on “Save settings”
- Navigate to Customizations → UI Scripts
- Click on “Add UI Script” and you will see the following
-
Replace the content of the text area with:
name: testRigor UI Integration description: Shows testRigor options to automate suites, cases and runs. author: testRigor version: 1.0 includes: . excludes: js: $(document).ready( function() { var domain = "https://cdn.testrigor.com"; var mjs = document.createElement("script"); mjs.type = "text/javascript"; mjs.src = domain + "/testrail-ui-plugin.min.js"; var mcss = document.createElement('link'); mcss.rel = "stylesheet"; mcss.type = "text/css"; mcss.href = domain + "/testrail-ui-plugin.min.css"; $("head").append(mcss, mjs); } ); - Check the "This UI script is active" checkbox
- Click on “Add UI Script”