Jira Integration

Working with Jira

Prerequisites:

Configure Jira integration

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

Install and Use Katalon's Jira add-on from Atlassian Marketplace

Katalon Studio provides a free Jira add-on to help create a seamless integration. This add-on gives you several benefits:

  • Adding a Gherkin custom field to help you design your test case in a consistent and concise way. The content will be populated right into your Katalon Studio automation scripts automatically.
  • Presenting the latest execution result and artifacts right inside the issue page.
  • Looking up Katalon Studio execution result status using Jira's JQL syntax.

Jira Server

Installation

Install Katalon BDD - Test Automation for Jira here.

To install the add-on, please follow Atlassian's instruction.

Gherkin custom field

Only availabe for Jira Server Version

This add-on adds a custom field type to Jira called Katalon Gherkin. This custom field lets you write descriptions for your test cases and stories in Gherkin syntax. Gherkin keywords such as GivenWhenThen will be highlighted automatically. Once imported to Katalon Studio, the content of Katalon Gherkin field will be populated into test cases description.

To create Katalon Gherkin custom field, please follow Atlassian's instruction.

Jira Cloud

Install and Use Katalon BDD custom field in Jira Cloud

A new version of the Katalon BDD Add-on for Jira Cloud which supports BDD editor is available here.

Install the Katalon BDD add-on

To add the Katalon BDD custom field to Jira Cloud, from Jira settings -> Select Apps-> Select Find new apps -> Enter “BDD Katalon” in Filter apps-> Get app.

Create the Katalon BDD custom field

  • From Jira settings -> Select Issues ->in FIELDS tab, select Custom fields -> Add custom field.
  • Select a Field Type: Text Field (multi-line). Remember to associate it with issue types you want.

  • Provide a name and its description -> Create.
  • Associate the custom field to multiple screens by checkbox.

Enable the Katalon add-on and custom field

In Project settings -> Scroll down to the bottom then select Katalon BDD -> Select the field you’ve created, then Click Add -> Select issue types to show this field with BDD editor -> Click Save.

Try the BDD editor

In the selected issue, you need to enable the Katalon BDD Fields.

To edit content in Katalon BDD Field, click the pencil icon and write a Gherkin content, then click the check icon. Make sure the content starts with Feature.

View Katalon Studio Test Execution Result on Jira

Once Jira is integrated with Katalon Studio and the add-on is enabled in Jira Cloud, a panel called TEST RESULT inside the issue page enables users to directly view the test result. In the new view of the issue page, just click Test Result. The result includes the execution status (PASSED, FAILED, INCOMPLETE, ERROR) and test artifact attachments (e.g. logs, screenshots, etc.).

Note: In Katalon Studio, the test case imported from Jira should be executed in Test Suite to view the test result.

JQL Syntax

Katalon Studio test execution status can be queried via JQL. The syntax is as following:

"Katalon Status"=<status>

Where Status value can be one of the following:

Status Description
PASSED The automation tests that executed successfully.
FAILED The automation tests that failed to execute at certain steps.
INCOMPLETE The automation tests that did not finish running all the steps due to other factors such as wrong syntax, power shortage, disconnected network, etc.
ERROR The automation tests that have some errors occurred.

For example, to search for all issues that have failed in Katalon Studio test execution_:_

Use JQL Syntax to query all issues with a particular execution status

Katalon Studio's test execution status can be queried via JQL. The syntax is as follows:

"Katalon Status"="STATUS"

For example, to search for the issues with PASSED status:

Feedback