Integration with Jira
QMetry Automation Studio provides direct integration capabilities with Jira that allow users to seamlessly publish test failures as "Bugs" and test cases as "Issues" directly into the Jira ecosystem. Integration of Jira Project with QAS Project facilitates Issue logging in Jira on run-time when the test fails in QAS. You can also create and link bugs directly from QAS test executions.
Jira Configuration
You can configure and enable direct Jira integration with the QAS project which allows you to do seamless mapping of issues/bugs, tests, and Jira issues for improved project management and issue tracking. You can also edit the configuration as required afterward.
Note:
Currently, QAS supports Cloud Jira integration.
Only a single Jira instance can be configured in QAS.
Steps
1. Go to Project Settings and select With Jira under the Integration section.
The Integration with JIRA screen opens.
2. Jira Integration: Enable the option to configure the Jira instance with QAS.
3. Enter the following Cloud Jira details.
Required Details | Description |
---|---|
URL | Enter the Jira URL that you want to integrate with QAS. |
Enter your email ID of Jira instance. | |
API Key | QAS supports Jira authentication using API-token. Refer to https://confluence.atlassian.com/cloud/api-tokens-938839638.html to know more about how to generate API tokens. |
Jira Project Key | Enter the Project Key of the project in Jira. |
Auto Bug Create | Enable this option to create a bug automatically in the event of execution failure. The option remains disabled by default. You can keep this property enabled if you would like to automatically create a bug when any test fails during execution.
Note: If the auto-create bug feature is enabled from the configuration then the bug gets created directly without asking for details.
Refer to the Auto Bug Create section for more details. |
Auto Bug Link | Enable this option to link the created bugs with the “Task” in Jira automatically. The option remains disabled by default. Refer to the Auto Bug Link section for more details. |
Auto Bug Label | Enable this option to add a relevant label in the Jira issue automatically. The option remains disabled by default. Refer to the Auto Bug Label section for more details. |
4. Click on the Test Configuration button to test the integration and establish a connection with Jira.
Auto Bug Create
You can establish a connection between the test execution and the creation of bugs. If the option is enabled, the bug will be created automatically as and when the test fails during the execution.
→ When the option is enabled:
If a test case fails during the execution, the issue will be logged automatically as a “Bug” in Jira.
→ When the option is disabled:
If a test case fails during the execution, the issue will not be logged automatically in Jira.
In Analytics, the Create Bug icon will be available for the failed test cases using which you can log the bug for the failed scenarios.
A bug is created in Jira and the Jira Key is displayed under the JIRA BUGID column. The Key is clickable.
Clicking on the Jira Key of the bug, the bug details page opens in Jira.
The step details are displayed in the bug description showing the passed and failed steps.
The screen capture of the event at which the test failed, also gets attached as an attachment to the issue.
Auto Bug Label
Enable this option to add a relevant label in the Jira issue automatically. The option remains disabled by default.
In the following example, the created Labels represent the values in QAS. QAS-Project is the project name, QTC-660 is the key of the test case with which the bug has been linked, and QTE-1009 is the test execution key in the Analytics module.
Create Issues (Tasks) from the Test Plan module
You can create an issue directly in Jira from test cases in the Test Plan module. The issue is logged as the issue type “Task” in Jira. This feature provides a seamless workflow for users who prefer to manage their test cases within the Test Plan module while having them synchronized as issues in Jira. The synchronization would be one-way i.e. from QAS to Jira.
If the test case is already linked then the corresponding JIRA Issue ID is displayed in the test case list view in the Test Plan module.
Steps
1. Go to the Test Plan module.
2. Hover over the test case for which you want to log an issue and click on the Create Issue icon for the test case.
Note: The icon will only be visible if Jira Integration is enabled for this project in the Project Settings > With JIRA.
The logged issue ID is displayed at the top of the test case detail page.
The issue is logged as a “Task” in Jira.
Labels in Task
In the case of a Task, the Labels are created automatically if the Auto Bug Label option is enabled in the Jira Integration. The Labels are created in accordance with the test plan folder and sub-folder names, and test plan name.
Sync Task in Jira
You can sync the test case details with the Task that you logged in Jira either from the test case list view or the test case detail page. For example, if there were 5 steps in the test case earlier. So, the Task also shows 5 steps in its Description. Now, further 2 steps are added to the test case in QAS. These steps should be synced with the Task in Jira. QAS provides the ability to sync the test case details with the Task so that the Task remains well-updated.
Steps
1. Go to the Test Plan module.
2. Hover over the test case for which the Jira Issue ID of the Task is displayed.
3. Click on the Sync icon for the test case.
The Task details in Jira get updated as per the test case details in QAS.
Auto Bug Link
Enable this option to link the bugs (automatically as well as manually) with the Task in Jira automatically as and when they are logged. The option remains disabled by default.
It provides traceability of logged bugs for the test case and execution.
→ If the auto bug link is enabled
The bug logged for the failure of execution will be automatically linked with the Task created for the test case. In Jira, the Task detail page displays the linked bug in the Linked Issues section.
Disable Jira Integration
You can disable the Jira Integration with the QAS project at any time if you do not require it.
By disabling Jira Integration, users won't be able to create bugs or issues, and existing data won't be displayed. But the data will still be preserved.
Steps
1. To disable Jira Integration for the QAS project, go to Project Settings and select With Jira under the Integration section.
2. Disable the Jira Integration option at the top.
The confirmation window pops up.
3. Click “Yes” to proceed.
Synopsis
The following table summarises the impact of Auto Bug Create and Auto Bug Link configuration that you set while Jira Integration.
Configuration | Impact on manual and automatic bug creation, and linkage of bugs in Jira | |||
---|---|---|---|---|
Auto Bug Create | Auto Bug Link | Automatic bug creation on execution failure | Manual bug creation from Analytics | Automatic linkage of bug with the Task in Jira |
Enabled | Enabled | Y | N | Y |
Disabled | Disabled | N | Y | N |
Enabled | Disabled | Y | N | N |
Disabled | Enabled | N | Y | Y (Bug created manually in Analytics) |