This article explains how to set up and use the integration between testRigor and TestRail. By connecting the two tools, you can automatically synchronize test results, create test runs in TestRail from testRigor executions, and streamline your testing workflows across both platforms.
With this integration, you can:
- Link test cases in testRigor to existing cases in TestRail.
- Automatically create test runs in TestRail when executing tests in testRigor.
- Track pass/fail results in TestRail without additional manual effort.
- Optionally configure test plans and milestones for better reporting.
Requirements
Before enabling the integration, make sure you have:
- A TestRail instance.
- A testRigor account with permissions to configure integrations.
- API access enabled in TestRail.
- A TestRail API key generated for your user instance.
- Project permissions in TestRail to create and edit test cases and runs.
How it works
- testRigor connects to TestRail via the TestRail API.
- When the integration is enabled, testRigor test cases can be linked to TestRail test cases.
- Each execution (or full rerun) in testRigor will generate a corresponding Test Run in TestRail.
- Test results are reported automatically, keeping both tools synchronized.
This means teams can design and execute tests in testRigor while maintaining a single source of truth for reporting in TestRail.
Configuration steps
1. Enable the integration in testRigor
- In testRigor, go to Settings > Integrations.
- Find the TestRail integration and toggle it On.
- A configuration form will appear.
2. Generate an API Key in TestRail
- In TestRail, navigate to Administration > Site Settings > API.
- Ensure the API is enabled and save the setting.
- Go to My Settings > API Keys.
- Click Add Key, give it a label, and generate a new key.
- Copy the key - it will only be displayed once.
3. Collect project information
You’ll need the following from TestRail:
-
Project ID - visible in the project’s URL (e.g.,
index.php?/projects/overview/1> ID =1). - (Optional) Plan ID and Milestone ID if you want to link test runs directly to specific plans or milestones.
4. Configure integration settings in testRigor
- Return to testRigor’s TestRail integration settings.
- Enter the following:
- TestRail Project ID
- API Key
- (Optional) Test Plan ID and Milestone ID
- Save your configuration.
5. Configure run behaviour (Optional)
testRigor allows you to define how test runs are handled after execution:
- Close Run if Successful (default) - Closes the TestRail run only if 100% of tests pass.
- Always Close Run - Closes the run regardless of results.
- Do Not Close Run - Leaves the run open for further updates.
Choose the option that best fits your team’s workflow.
6. Use the integration in CI/CD pipelines (Optional)
If you run tests as part of CI/CD:
- Enable the integration in testRigor.
- Go to the CI/CD tab in testRigor’s integration settings.
- Configure pipeline-specific parameters (e.g., linking results from automated builds to TestRail).
This ensures that every automated test execution is also logged in TestRail.
Linking testRigor Test Cases with TestRail
Once the TestRail integration is enabled in testRigor, each testRigor test case can be linked to its corresponding TestRail test case. This ensures that when a test is executed in testRigor, the result is automatically reported back to TestRail.
How Linking Works
- Each testRigor case stores a reference to the TestRail Case ID (e.g.,
C1234). - During execution, testRigor uses this ID to update the correct case in TestRail via API.
- If a case is not linked, testRigor cannot report results back to TestRail.
Ways to Link Cases
-
Automatic Linking via Import
- If you import test cases from TestRail into testRigor (see section Import TestRail Test Cases for Execution), the link is created automatically.
- Each imported case retains its TestRail ID, so test results flow back without any extra setup.
-
Manual Linking
- Open a test case in testRigor.
- Edit the test case and enter the TestRail Case ID in the External ID / TestRail Case ID field.
- Save the test case.
- Next time you run the test, results will be reported to that specific TestRail case.
Best Practices
- Always ensure that every automated test in testRigor is linked to a TestRail case if you want traceability.
- If your team is migrating manual tests - start by importing from TestRail to establish links automatically.
- If your team is writing new tests in testRigor - manually assign TestRail Case IDs as you go.
Import TestRail Test Cases Into testRigor
Once the integration between TestRail and testRigor is configured, you can easily import manual test cases from TestRail into testRigor for execution.
- Navigate in testRigor to the Test Cases section within your test suite.
- Click the Import Test Cases from TestRail button or tab. A modal dialog will appear.
- Choose one of the import options:
- Import All Test Cases - brings in all TestRail cases along with their steps.
- Import Selected Test Cases - lets you choose specific cases to bring in.
- Configure the additional options:
- Link imported tests with test case management system – ensures imported cases stay connected and results are reported back to TestRail automatically.
- Override already linked tests - replaces existing testRigor scripts with the latest version from TestRail at import time (use cautiously if cases are stable).
- Click Import to start.
- After import, test cases appear with “Not Executed” status and are ready for execution. Any steps not recognized as commands are automatically converted into AI-based reusable rules, simplifying conversion and reuse.
- To execute: click Rerun in Test Suite Details - or if the suite already contains cases, use Select Multiple, choose the imported cases, and click Run. testRigor’s AI will then process and execute the manual test steps.
- After execution, results sync back to TestRail, preserving test case linkage and status updates.
This new capability allows you to seamlessly convert your manual TestRail cases into automated workflows in testRigor, while keeping everything synchronized and traceable in TestRail.
Troubleshooting
- Authentication fails - Double-check that the API key is correct and not expired.
- Project ID not recognized - Verify the number matches the TestRail project URL.
- Runs not closing as expected - Review your “Close Run” setting in testRigor’s integration options.
- CI/CD sync issues - Confirm integration is enabled under both the Integrations and CI/CD tabs in testRigor.
If issues persist, consult the testRigor TestRail integration guide or contact support.
Learn more