Tools: Jira Manual Configuration - TestRail

Manual Jira Configuration

We usually recommend using our easy integration wizard for Jira from TestRail’s Administration area under Administration > Integration. Simply select the relevant article below to get started:

You can alternatively configure the integration manually and this also only takes a few minutes. This topic explains how to integrate TestRail with Jira manually (both Jira Server as well as Jira Cloud).

There are currently three ways to integrate TestRail with Jira:

  • Using defect URLs to link test results to Jira
  • Using the defect plugin for Jira to push and look up Jira issues
  • Using reference URLs and the reference integration to link test cases to Jira

You don’t have to use all listed integration options and you can mix and match the integration with other tools. Configuring the integration usually only takes a few minutes and this guide explains how to configure the integration and how it works.

Defect URLs

The defect URLs are used to let TestRail know how to access your JIRA instance. Once the URLs have been configured, a new Add link appears next to the Defects field in the Add Test Result dialog. This link allows you to jump to Jira’s Create Issue form to report a new bug. Additionally, entered issue IDs are linked to your Jira instance to make it easier to track the status of your issues.

To configure Jira’s URLs in TestRail, select Administration > Integration. You can alternatively enter separate bug tracker URLs for each project under Administration > Projects.

Use the following example URLs to configure the addresses:

JIRA Cloud
Defect View Url: https://name.atlassian.net/browse/%id%
Defect Add Url:  https://name.atlassian.net/secure/CreateIssue!default.jspa

JIRA installation
Defect View Url: http://your-server/jira/browse/%id%
Defect Add Url:  http://your-server/jira/secure/CreateIssue!default.jspa

Reference URLs

The reference URLs are used to link test cases to issues stored in Jira via the References field. Once the URLs have been configured, issue IDs entered in the References field are linked to your Jira instance to make it easier to jump to related issues, feature specifications or requirements.

To configure Jira’s URLs for the References field, select Administration > Integration. You can alternatively enter separate reference URLs for each project under Administration > Projects.

Use the following example URLs to integrate TestRail with Jira:

JIRA Cloud
Reference View Url: https://name.atlassian.net/browse/%id%
Reference Add Url:  https://name.atlassian.net/secure/CreateIssue!default.jspa

JIRA installation
Reference View Url: http://your-server/jira/browse/%id%
Reference Add Url:  http://your-server/jira/secure/CreateIssue!default.jspa

Defect plugins

Defect plugins can be used to implement a deeper bug tracker integration and TestRail comes with ready-to-use Jira defect plugins. The Jira integration plugins have been split out into two separate plugins to handle cloud and server Jira integrations separately. As of 29th April 2019, Atlassian deprecated user password functionality in their cloud version of Jira so as to align with European GDPR regulations.

For TestRail, this means that cloud and server Jira integration need to be treated somewhat differently. In a nutshell:

  • For Jira server integration, you should use the JIRA REST plugin (Jira Server 5.x, 6.x, 7.x, and later), and authenticate the integration using your Jira username and password combination.
  • For Jira cloud integration, you should use the Jira Cloud plugin, and authenticate the integration using your Jira email address and Jira API token.

To configure the defect plugin, select Administration > Integration and select the relevant Jira defect plugin in the Defect Plugin dropdown list. The next step is to configure all the necessary connection settings in the Configuration field. Project-specific plugins and configuration settings can optionally be specified under Administration > Projects.

When the defect plugin has been configured, a new Push link is shown next to the Defects field in the Add Test Result dialog. Clicking the link will open a popup dialog that enables you to push a bug report to Jira without leaving TestRail.

Once the test result is added, hovering the mouse cursor over an issue ID will open a window with useful information and status details about the issue in Jira.

Jira Reference Plugin

Reference plugins can be used to retrieve additional information from IDs entered into the References field of TestRail entities, such as test cases, test runs, and milestones. The Reference Plugin is configured on the References tab of the integration settings in the same manner the Defect Plugin is configured.

The plugin supports hovering over Reference IDs but does not support a Push dialog for the References field. It is also possible to customize the fields which appear via link hovering and add custom fields, as described above.

If you have the Defect Plugin already configured for Jira, you can simply copy your [connection] and [hover.fields] sections from the Defect Plugin into the Reference plugin configuration. Alternatively, you can choose different fields to be displayed for References and Defects.

Attachments

The Jira Defect Plugin supports submitting attachments to Jira as well. This field can be turned on and off, but cannot be customized. To submit one or more attachments to Jira, simply drag the attachment to the attachments or description areas of the push dialog or click on the area to choose an attachment from your file system.

Additional Customizations

TestRail also supports custom defect plugins. If your team uses TestRail Server, it is possible to futther customize the defect plugin (or build your own) to support additional field types or other data. Please see our documentation here for additional information.