TestRail Integration for Jira add-on - TestRail

TestRail for Jira Add-on

For teams that use Jira, TestRail comes with a Jira app 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 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.

Once you have successfull installed the TestRail Integration for Jira add-on in your Jira instance, you can access it by clicking Add-ons on the left side menu of your Jira instance or on the upper menu, 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.

Functionality of the add-on in a Jira issue

When you open an issue in your Jira board, you will see a new field available under your regular fields inside the issue, called TestRail: Results. Click show to expand the field.

The new field should show tabs with the information referenced in TestRail:

  • All Results
  • Tests
  • Cases
  • Runs
  • Plans
  • Milestones

Clicking each tab should show you all the results you link from Jira to TestRail that you specifically want to see. All the information that you see will be any type of result that is linked to that specific Jira issue as a Reference from your TestRail instance.

For example, you could link a test case to a Jira issue, and under the Cases tab you will see all the times that case was tested, and access them directly from the Jira issue, while also getting all the information you need with a drop-down option for each element to see extra details. That kind of link can be done for any of the other tab options.

This information can be seen in a very similar way as you see it in your TestRail instance, so it makes it easier and more simple to interpret and to access it.

Linking results to Jira issues

To quickly link new Cases and Runs, you can do it directly from the right side menu in each issue, next to the fields:

  • TestRail Cases
  • TestRail Runs

Once you click Open TestRail: Cases or Open TestRail: Runs, click Add Case / Run. A new small window appears requesting to choose the TestRail project in which the case / run is in. After choosing, you can then click Add Case / Run again.

This 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. From there, add the Jira issue name in the References field (alongside any other detail relevant to the result to be linked to Jira) so that this result can be linked to the issue directly, finally saving your changes.

You can check if the result was successfully linked to the issue by refreshing the Jira page, and accessing the issue one more time to check the corresponding tab under TestRail: Results to see the name of the result.

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 your TestRail instance.

Please Note: To link existing cases or runs to a Jira issue, you need to access the case or run from your TestRail instance and click Edit. You will be able to edit the References field with the Jira issue name, and once you save changes and refresh your Jira issue, your case or run should appear in the corresponding tab, the same way as explained above.