Jira Integration

Katalon Studio can integrate with both Jira Cloud and Jira Server. This integration helps you:

  • Link a Katalon Studio project with a Jira project.
  • Import Test Cases from Jira to Katalon Studio to create test cases and run BDD tests.
  • Automatically submit test results and test reports to the linked Jira issue.
  • Submit Bugs to Jira.

Prerequisites:

  • An active Katalon Studio Enterprise license.
  • The Jira Integration plugin for Katalon Studio installed. You can find the plugin here: Jira Integration.
  • The Katalon Studio and TestOps integration plugin for Jira installed. You can download the plugin from the Atlassian Marketplace website here: Katalon Studio and TestOps integration.

Configure Jira Integration

To enable Jira Integration, follow these steps:

  1. Go to Project > Settings > Plugins > JIRA.

    Jira Configuration in Katalon
  2. Select the Enable integration box.

  3. In the Authentication section, fill in the criteria as shown below:

    Server URL
    For Jira Cloud: https://<site_name>.atlassian.net
    For Jira Server: http(s)://domain without any trailing parts, for example, /secure.
    Username  Your username or the registered email of the Atlassian account.
    Password/API Token
    The Atlassian Cloud's API token. To learn more about generating API in Atlassian, you can refer to the Atlassian document: Manage Atlassian token for your Atlassian account.
    Enable Jira Configuration in Katalon
    • Hit Connect to start the authentication process. A pop-up dialog indicates that the Atlassian account connects successfully.
    Connect Jira Configuration successfully in Katalon
  4. After successfully authenticating with Jira, all relevant JIRA Projects and Issue Types will be retrieved and displayed under the Submit Options section. You can specify the default project and the default issue type for submission here.

    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 To use the test case name as a summary for submitted tickets.
    Attach Screenshot to Jira ticket To include taken screenshots during test execution in submitted tickets.
    Attach Log to Jira ticket To include the execution log in submitted tickets.
    Submit Options
  5. Click Apply and Close to complete the Jira integration.

    Notice:

    Jira Intergration configuration is available in the project scope only. If you want to intergrate Jira in another Katalon project, you have to repeat the above steps.

    Note:

    If you want to enable Jira integration with Katalon TestOps, you can refer to this document: TestOps - Jira Integration.

Execute Test Cases with Jira Integration

There are three main steps to execute test cases imported from Jira in Katalon. However, if you don't want to run BDD tests or you are integrating Jira Server with Katalon, you can skip Step 1.

Step 1: Import BDD custom fields (Applicable to Jira Cloud Integration)

From Katalon Studio version 7.8.0 onwards, you can also import the BDD custom fields to Katalon Studio when importing BDD feature files for Jira Cloud Integration. To learn more about adding BDD custom fields in Jira via Katalon BDD, you can refer to this document here: Configure Jira BDD Settings.

Follow these steps:

  1. Go to Project > Settings > Plugins > Jira.

  2. In the Fetch Options section, check the Enable retrieving content of the specified custom field box.

    Enable the BDD custom field in Jira Cloud
  3. Select a custom field from the drop-down list.

    Note:

    Only existing custom field ID is valid for this configuration. In case you can not find the custom field in the dropdown list, click Fetch Custom Fields to fetch the latest list from the connected Jira Cloud.

  4. Click Apply and Close to apply your settings.

Step 2: Import Test Cases from Jira

Katalon Studio allows you to pull test cases from Jira and link Jira issues to Katalon. Follow these steps:

  1. From the Katalon toolbar, select Jira Integration Jira Intergration icon > Import Test Case from JIRA JQL. An Import Test Case from JIRA JQL dialog opens.

    Import test case from Jira
  2. In the opened dialog:

    • Fill the JIRA Query Language (JQL) script of the desired test case in the Jira JQL box. To find out the JQL script of your test case, you can refer to the Atlassian document here: Search for issues using JQL

      For example, we want to import test cases from the TDAP project with Bug type and Complete status. After searching for the Jira ticket using the JQL query, copy and paste the JQL script into the Jira JQL box:

      JQL query from Jira Copy and paste JQL script into the Jira JQL
    • By default, the Import BDD feature files box is selected. This option allows you to import BDD feature files to run BDD tests. In case you don't want to run BDD tests, uncheck this option. To learn more about BDD testing, you can refer to this document here: BDD Testing Framework (Cucumber Integration)

      Import the BDD feature files
  3. In the Test Case Folder Selection dialog, select the destination to store the issues. Click OK. A Jira Issues dialog opens.

    Choose the destination for Jira test cases
  4. In the Jira Issues dialog, click OK to import the test case from Jira.

    Notice:

    You can only import test cases from a Jira ticket once. You can not repeat this action.

    Link the Jira issue

    As a result, Katalon opens a new test case with:

    Test Case Name
    Jira ticket's summary/subject
    Test Description
    Jira ticket's content
    With the selected Import BDD feature files box from Step 2

     Katalon creates a new feature file in Include\Feature with:

    - The feature file's name is the same as the test case's name.

    - The feature file's content is the BDD content from Jira. For Jira Cloud integration, if the Enable retrieving content of the specified custom field option in Project Settings is enabled, it also displays the BDD custom field in the content.

     - A Run Feature File step is also added in the test script.

    Final results after importing test cases Final results after importing BDD feature files

Step 3: Run the test case

After importing the test case from Jira, you can continue to add additional steps in the test case as needed. Then hit Run to run the test case.

View Test Results in Jira

To view test results in Jira, follow these steps:

  1. Add the associated test cases to a test suite. After a test suite execution, Katalon Studio automatically uploads the latest test result and attaches a .zip file that contains test reports to the linked Jira ticket.

  2. To view the test results, open the linked Jira ticket, click Open Test Results in the Details group.

    Click on the Open test results in the Jira issue See results of test case in the Jira issue

    Notes:

    You can quickly find the test execution status via the JQL query. The syntax is as follows:

    "Katalon Status"=<status>
    

    For example, to search for all issues that have failed in the Katalon Studio test execution, type "Katalon Status"=FAIL in the search bar. Katalon Studio supports five test statuses: Passed, Failed, Incomplete, Error, and Skipped.

Submit an issue to Jira

After executing a test suite, you can submit an issue to Jira directly from the test reports page.

Follow these steps:

  1. Go to Reports in the Test Explorer panel and double-click to open the test reports you want to review for issues.

  2. In the opened test report, click Bug Bug icon. A Linked Jira issues dialog opens.

    Click the Bug icon
  3. Click Add to choose your submit options.

    Choose your submit options

    The issue submission options include:

    Option Description Steps to take 
    Create as New To create a new issue on Jira.

    After choosing this option:

    1. A JIRA native submission form opens in the pop-up browserYou might be prompted to sign in to your Atlassian account. You only have to do this once.

    2 After signing in, fill in the JIRA native submission form to submit the issue.

    Create as Sub Issue To create a sub-task for an existing Jira issue.

    After choosing this option:

    1. A Create as JIRA Sub Task dialog opens. Fill in the ID of an existing Jira issue to create a sub-task within. Click OK to open JIRA native submission form.

    Create a sub task

    2. You might be prompted to sign in to your Atlassian account. You only have to do this once.

    - After signing in, fill in the JIRA native submission form to submit the issue.

    Link to existing Issue This option adds the execution details of the test to an existing JIRA issue. You need to provide the ID of the existing JIRA issue for this.

    After choosing this option: 

    - A Link to JIRA Issue dialog opens. Fill in the ID of an existing Jira issue. Click OK. The test case execution files will be attached to the linked JIRA Issue.

    Create a linked issue

    Note:

    • By default, the submitted ticket includes the Summary, Description, Screenshots and Logs of the test case. You can configure the default submission form from the Submit Options section in the Jira integration settings.
    • To quickly navigate to a linked JIRA issue, click the hyperlink embedded in the ticket's ID.
    Jira Issues Hyperlink

Feedback