For teams that use Jira, TestRail comes with a Jira app (TestRail Integration for Jira) that you can install in your Jira instance for free. Once you install the TestRail Integration for Jira app, you can enable the Jira board add-on to view TestRail data relating to test results, cases, runs, milestones, and plans right within Jira issues that you’ve linked as References or Defects in TestRail.
You can also add new test cases, kick off new test runs from Jira, and review the overall progress of your testing by viewing dashboards for individual projects and overall activity in your TestRail instance.
For instructions about adding the TestRail Integration for Jira app to your Jira board, see the links below:
- Install the TestRail Jira app in Jira Cloud
- Install the TestRail Jira app in Jira Server
- Install the TestRail Jira app in Jira Data Center
TestRail Integration for Jira app dashboard
Once you have successfully installed the TestRail Integration for Jira add-on in your Jira instance, you can access it either by clicking Add-ons on the left side menu of your Jira instance or by clicking the Apps drop-down menu.
Inside this add-on, you can view your TestRail Dashboard just the same as in your TestRail instance.
You can also access your Projects through the Dashboard and on its corresponding space or from the left side menu, and you can click Go to TestRail to access your TestRail instance directly as well.
TestRail Results section in the Jira issue view
When you open an issue in your Jira board, you will see a new section available under your regular fields inside the issue called TestRail: Results.
The first time you open an issue after installing the "TestRail Integration for Jira" app, you need to click on the three horizontal dots and then TestRail: Results to display the TestRail section below the issue description.
After clicking on TestRail: Results, a new section is displayed with a Show link, which you must click to expand the section and see test information.
The new section show tabs with the information referenced in TestRail in each entity type, as you can see in the blue buttons panel in the image below.
Clicking each tab should show you all the results you link from Jira to TestRail that you specifically want to see. All the information you see will be any result linked to that specific Jira issue as a Reference and/or Defect from your TestRail instance.
For example, you could link a test case to a Jira issue. Under the Cases tab, you will see all the times that test case was tested and access them directly from the Jira issue while also getting all the information you need with a drop-down option (highlighted in the below screenshot) for each element to see extra details.
Similarly, you can see results under any of the other tab options once you've linked them in TestRail.
This information can be seen in a very similar way as you see it in your TestRail instance, making it easier to interpret and access.
Test cases and test runs widgets in the Jira issue view
To quickly link new Cases and Runs in Jira, you can do it directly from the right side menu in each issue, using the TestRail: Cases and TestRail: Runs widgets.
Once you click Open TestRail: Cases or Open TestRail: Runs, you can see the cases/runs that reference your issue.
If you click Add Test Case / Add Run, a popup window will appear, allowing you to choose a TestRail project in which you can quickly create the new case or run.
This action will take you to the Add Test Case or Add Test Run page in your TestRail instance, where you can configure a case or a run. You should notice that the Jira issue ID has already been added to the References field, thus creating traceability between the Jira issue and TestRail entity.
You can check if the reference was successfully linked to the issue by refreshing the Jira page and rechecking the corresponding tab under TestRail: Results to see the reference details.
That way, the case or run can be linked to the Jira issue and be verified for easy access from your Jira instance directly.
To link existing test cases or runs (from TestRail) to a Jira issue, you need to access the case or run from your TestRail instance and click Edit. After editing the References field in TestRail, simply click on Save and refresh the Jira issue page. The newly added details will appear in the corresponding tab, the same way as explained above.