The TestRail extension brings test results directly into your Aha! Develop workflow. Enable it to see the status of tests, test cases, and test runs, including reasons why a particular test is blocked or failed. You can even create new tests as you think of them. Testing and development teams stay in their own tools of choice, and critical information flows seamlessly between them — so you can spend less time looking for it, and more time developing lovable updates.Click any of the following links to skip ahead:
Confirm user permissions
Action |
User permissions |
Install the extension |
|
Configure the extension |
|
Adjust custom layouts |
|
Pull test runs, tests, or test cases from TestRail |
|
Enable the extension for yourself |
Install the extension
To install the TestRail extension in your Aha! account, open the extension library. You need to be an administrator with customization permissions to install and apply extensions in your Aha! account, but users of any permission level can use them.
Next to TestRail, click Install.
Select your Aha! account.
Your Aha! account's Customization settings will open. (You need to be an administrator with customization permissions to access this page.)
Click TestRail to install the TestRail extension.
You will see a Success page with details about the extension and its abilities.
Open your personal settings (Settings ⚙️ → Personal -> Extensions) to ensure the TestRail extension is enabled for your user. This step exists so users only see extensions relevant to their workflows.
Configure the extension
After you install the TestRail extension, you need to connect it to your TestRail account:
TestRail Domain: Provide your TestRail domain.
TestRail API Automatic Sync Delay: This setting determines how frequently the extension should resync with TestRail (in seconds). By default, the extension will attempt to sync every hour. If you would like to disable automatic syncing, use a negative value here and sync manually.
TestRail API Username: Provide your TestRail API username. You do not need to provide a username with administrator permissions.
TestRail API Token: Provide your TestRail API token.
(Optional) Update secret: Change the secret Aha! uses to authenticate with TestRail.
Congratulations! Aha! Develop is now connected with your TestRail account.
When you first connect Aha! Develop and TestRail, the extension will import all extant tests and test cases. This initial import can take some time for large datasets. Check its status by navigating to Work -> TestRail connection and reviewing the Full TestRail data resync progress bar at the bottom of the page.
Review your custom layout
The TestRail extension will appear in a new tab on your feature and sprint custom layouts called Tests. If you do not see it immediately, you might need to click the More options ... tab on a record. From here, you can link to or create test elements and use the extension.
If you want to display the Test tab more prominently, you need to adjust the view layout for the record type(s).
Navigate to Settings ⚙️ → Account -> Custom layouts. You need to be an administrator with customization permissions to access this page.
Select the record type(s) that need to display TestRail test runs, tests, and test cases. These can be features or sprints.
Select the layout(s) you want to modify. Different teams in your Aha! account can use different record layouts, so be sure to select the right one.
Records have two types of layouts: one for when they are first created, and one for when they move through their workflow. Select the [Record] View layout tab to adjust this second option.
Drag the Tests tab to your preferred tab order. Switch between Drawer and Detail views to see what it might look like.
Hover over the Impacts workspace(s) list with your mouse to confirm that you have adjusted the right layout for your team. Lastly, click Save layout.
You can also navigate to your team settings (Settings ⚙️ → Team -> Configure -> Custom layouts) to confirm that a given team is using the appropriate record layout.
Use the extension
From a feature or a sprint, open the Tests tab.
Note: To see a sprint's drawer view, click on the sprint's name.
From here, you can do several things:
-
Features
Link to an existing test run, test, or test case
Create a new test case
-
Sprints
Link to an existing test run
Once linked, you can also review the status of any tests, test cases, or test runs, or rerun them without leaving the Aha! Develop record. While TestRail records can be Untested or Passed without comment, the extension will also explain the reason for a Blocked or Failed record in a brief comment.
Troubleshoot the extension
If the extension is giving confusing results — or you want to satisfy your own curiosity — you can review the audit logs and initiate manual syncs.
To review the extension's logs, navigate to Settings ⚙️ → Account -> Extensions, open the TestRail extension, and scroll down to the Contributions card. Here, you can see every action that users have taken with the extension. Actions that required a sync with TestRail will have a green checkmark under Last invocation on server if successful — but note that this means that the sync itself was successful, not that it returned intended results.
To see more information about a sync (called an invocation in Aha! Develop), click on one. From here, you can see general denotative data, then the actual code used to run the invocation. Review this code for any errors or unexpected behavior.
To initiate a manual sync, navigate to Work -> TestRail Connection. From here, you can update individual record types, update all tests or test cases, or initiate a complete data resync. Click the relevant Sync all link to initiate any of these actions. When you do, you will see a progress bar and will receive pop-ups about any errors, warnings, or notes.