TestRail integrates with Jira Server so that you can autofill and push bug reports to Jira during testing, link issues to test results, look up issue details from TestRail, and track requirement coverage and traceability.
Additionally, with TestRail’s Integration for Jira server app, you can directly see linked test results and test case links inside Jira, review metric dashboards, and create new test cases from Jira.
This guide will walk you through the steps of integrating TestRail with your Jira Server or Data Center instance.
Get a TestRail instance
Already using TestRail? You are all set and you can skip this step! If you are not yet using TestRail, simply register your free trial. You can either get TestRail Server for a self-hosted installation or use TestRail Cloud for a SaaS solution hosted by us.
- If your Jira Server or Data Center instance is running on your private network behind a firewall, then we recommend you use a TestRail Server instance because your TestRail instance must be able to access your Jira instance via https.
- If your Jira Server or Data Center instance is reachable over the Internet, you can also use our TestRail Cloud edition (we can also provide the list of our cloud IPs for the integration if required by your IT team).
Configure Jira integration in TestRail
Configuring the Jira integration in TestRail is easy. Simply select Administration > Integration to start configuring your settings. We recommend using the simple Jira configuration wizard at the top of the page. Simply click the Configure Jira Integration button to get started:
This will automatically help you set up the required Jira URLs, the defect integration to push/lookup Jira issues as well as the reference/requirement integration.
For Jira Server integration, you should use the “Jira REST” (Jira Server 5.x, 6.x, 7.x and later) plugin, and authenticate the integration using your Jira username and password combination.
The wizard also automatically configures the integration with User Variables so that each user can enter their own Jira integration settings (otherwise the entered fallback user is used). To configure the Jira user, each user can simply enter the details under their My Settings page by clicking on their name in the top right corner of the TestRail interface.
Each user can simply enter her/his Jira login details for the integration. Please make sure that the users enter their Jira username and not their email address for the integration.
Manual Jira configuration
Do you prefer to configure the Jira integration manually or need to customize, extend, or change the integration? No problem, you can also easily configure the Jira integration from TestRail’s side manually with a few simple steps.
You can also configure different integrations for different projects. To do so, simply configure the integration for each project under Administration > Projects > edit a project > Defects / References tabs. Learn more about configuring the integration manually or how to customize and adjust the integration here:
- Manual Jira configuration
- Jira custom fields and issue links
- Defect variables to map users
- Building a custom defect plugin
Get the "TestRail Integration for Jira" app
The optional (but highly recommended!) Jira Server add-on allows you to directly review related test results, test case links, TestRail dashboard statistics and new case buttons directly from inside Jira.
To get started, simply activate the TestRail add-on for Jira Server from the Atlassian Marketplace:
Alternatively, you or your Jira administrator to enable the add-on directly from Jira under Settings > Apps > Find New Apps, then search for TestRail.
From there, click the TestRail app > Get App > Get It Now .
Next, simply configure the add-on with your TestRail address and key. From Jira’s administration area, select Manage apps, expand the TestRail for Jira Test Management app, and click Configure. Then simply configure your TestRail address and integration key and any additional optional settings.
You can also limit the add-on to select Jira user groups or projects to hide the integration from users who don’t currently use TestRail.
You can only link one TestRail project to one Jira project at a time. You can, however, link multiple Jira projects to different TestRail projects within the same TestRail instance.
If you have several Jira projects, and a TestRail instance associated with all of them, you can connect a new TestRail instance by either deselecting an existing Jira project, or creating a new one.