Jira Integration

Estimated reading time: 4 minutes

Prerequisites:

Configuration

You need to enable JIRA Integration in order to submit issues to JIRA. This setting is available at Project > Settings > Integration > JIRA.

  1. Select Enable integration option. The settings will be available for configuration.
  • Jira Cloud

    • Server URL must be in the form https://<site_name>.atlassian.net.
    • Use a Atlassian Cloud's API token for Password. See instructions here.
  • Jira Server

    • Server URL must be in the form http(s)://domain without any trailing parts e.g. /secure.
    • Use username instead of email for Username.
  1. Specify information regarding your JIRA Server and login credential then click Connect button.

  2. After successfully authenticating with JIRA, all relevant JIRA Projects and Issue Types will be retrieved and displayed under Submit Options. You can specify the default project and issue type for submission here.

The fields for setting include:

Field Description
Default JIRA Project The default JIRA project to submit tickets.
Default JIRA Issue Type The default JIRA Issue type to create when submitting tickets.
Use Test Case name as Summary for JIRA ticket The Katalon Test Case Name will be used as a summary for submitted tickets.
Attach Screenshot to JIRA ticket Any taken screenshot during execution will be included in submitted tickets.
Attach Log to JIRA ticket The execution log will be included in submitted tickets.

  1. Click OK button to complete the JIRA Integration setup.

Integrate Test Case

  1. Prepare Jira JQL Script

  2. Open Jira Integration > click Import Test Case from JIRA JQL

  3. Enter the Jira JQL. Click OK.

  4. The Test Case Folder Selection window will appear. Choose the destination to store the issues. Click OK.

  5. The Jira Issues window will appear. Click OK.

If your test cases have already been linked to a JIRA ticket, Katalon Studio will not sync them again.

Import BDD Feature Files

Jira Integration also allows you to import Jira BDD Feature Files to Katalon Studio.

When importing test cases from Jira, please check Link to BDD Feature File > OK > Choose the destination to store the issues.

A new Feature File (with the same name as the test case) will be created with the content from Jira BDD. Moreover, a RunFeature step will be created in the linked test case to Jira.

View Test Results on Jira

After you have successfully integrated test cases, test execution results will be automatically created in the associated Jira ticket. Review the status and attachments of Katalon Studio test cases right inside Jira.

Submit an Issue to Jira

Bug submission options will be available in Test Reports after JIRA Integration setup is successfully configured.

  1. Open a test execution in Reports that you want to review for issues. In Test Cases Table, a dedicated column for JIRA Integration will be enabled. Test-Cases-Table

  2. Click on the bug icon to display the list of related JIRA issues associated with the selected Test Case. The issues are shown in the following screen. JIRA issues associated

  3. Select submit option under the Add command. Create new Jira ticket The bug submission options include:

Option Description
Create as New A new Issue will be submitted to JIRA.
Create as Sub Issue A sub-task for an existing JIRA issue will be created. You will be asked to provide the ID of the existing JIRA issue to create a sub-task within.

Link to existing Issue This option will append execution details to an existing JIRA issue. You will be asked to provide the ID of the existing JIRA issue for this.

  1. In case of creating a new JIRA issue (or Sub-task), a JIRA native submission form will be displayed. The following is an example form for creating a new JIRA issue: JIRA native submission form

  2. Based on your preferences in JIRA Integration settings, the Summary, Screenshots, Logs, Reporter, and Description of test cases will be populated and attached accordingly. Once done, click on the Create button at bottom of the form.

  3. A created JIRA issue will have its ID recorded in the Linked JIRA issues list so that you can quickly navigate there from Katalon Studio. You can also edit linked JIRA issue or remove the linking of the created JIRA issue.Linked JIRA issues

  4. Once clicked on ID, you will be taken to JIRA issues page accordingly as shown below

JIRA issues page

User Contributed Notes