A Comprehensive Analysis of Jira Integration with Katalon Studio:
If you’ve been following our preceding guide on integrating qTest with Jira, you’d have gained a lot of insights. We’re back with a fresh guide to help you understand test automation for Jira through Katalon Studio.
Recommended IPTV Service Providers
- IPTVGREAT – Rating 4.8/5 ( 600+ Reviews )
- IPTVRESALE – Rating 5/5 ( 200+ Reviews )
- IPTVGANG – Rating 4.7/5 ( 1200+ Reviews )
- IPTVUNLOCK – Rating 5/5 ( 65 Reviews )
- IPTVFOLLOW -Rating 5/5 ( 48 Reviews )
- IPTVTOPS – Rating 5/5 ( 43 Reviews )
Let’s first get familiar with Katalon Studio and Jira before discussing the Jira integration process.
=> Click Here To Explore The Full Jira Tutorial Series
Educational Outcomes:
- Katalon Studio: An Introduction
- Integrating Jira with Katalon Studio
- Principal Features of Katalon Studio
- Jira: A Brief Intro
- Advantages of Jira Add-on
- How to Install Katalon’s Jira Add-on
- The Gherkin Custom Field
- Setting Up Integration Between Katalon Studio and Jira
- How to Generate Test Cases in Katalon Studio from Jira Issues
- Sharing Katalon Execution Results & Logs with Jira Issues
- Reporting Bugs to Jira from Katalon Studio
- Reviewing Katalon Studio Test Execution Results via JQL
- Closing Remarks
Katalon Studio: An Introduction
Katalon Studio is a robust and free-of-charge automation solution for web, Android, iOS, and API testing across both, Windows and macOS, environments. It delivers a simple and intuitive UI, supports multiple platforms, and incorporates built-in Jira integration. With Katalon Studio, it’s easy to establish projects, create and run tests, view reports, and manage tests.
Integrating Jira with Katalon Studio
Principal Features of Katalon Studio
- Katalon Studio provides inbuilt project templates to help organize test cases, object repository, and keywords.
- It comes with a built-in Selenium framework and stable web-drivers implementation, which saves time on installation.
- The integration of Katalon Studio with Jenkins, GIT, Jira, and qTest is seamless due to pre-installed plugins.
- The tool facilitates recording and automatic test generation using the recording utility and predefined keywords.
- Katalon Studio supports the creation of advanced test scripts and accommodates both, coded and codeless, test designing.
- The tool features an intelligent object capturing feature with advanced object property identification.
- Supports page objects, data-driven testing, and BDD, which enhances productivity.
- Katalon Studio is capable of conducting tests through multiple configurations and data sets.
- It offers variable execution modes, including remote execution with CI integration console.
- The tool can handle dynamic failures and also includes an auto retry feature.
- It offers advanced report viewing with extensive logging and screenshots.
- Enhances team collaboration and sharing capabilities.
For a deeper understanding of Katalon Studio, you can see their official website here. Following are some additional resources on Katalon Studio:
- Testing Mobile Applications Using Katalon Studio & Kobiton’s Cloud-Based Device Farm
- Katalon Studio Tutorial: A Free Test Automation Software You’ve Been Seeking
- Fixing Frequent Web UI Test Automation Concerns Using the Free Katalon Studio Toolkit
Jira: A Brief Intro
Jira is a typically used tool for planning, tracking, and releasing software, and is incredibly popular among agile teams. In this guide, we’re more concerned with how Katalon Studio integrates with Jira and won’t go into an elaborate explanation of Jira itself. If you wish to comprehensively understand Jira, you can refer to our Jira Tutorial Series.
Katalon Studio provides a Jira add-on which allows smooth integration between these tools. Let’s proceed to understand the installation and usage process for Katalon’s Jira add-on.
Advantages of Jira Add-on
Katalon Studio’s free Jira add-on offers several significant benefits:
- It introduces a custom field type to Jira named “Katalon Gherkin” that permits the design of test cases in a concise and consistent manner. The Gherkin custom field content is automatically included into the Katalon Studio automation scripts.
- The latest test execution results and artifacts are directly displayed on the issue page within Jira.
- You can conveniently refer to Katalon Studio execution result status using Jira’s JQL syntax.
How to Install Katalon’s Jira Add-on
To install the Katalon BDD Test Automation add-on for Jira, you can click here. Do note that as of now, only Jira Server is supported.
Follow the steps below for the installation:
- Log into your Jira instance as an admin.
- Click on the admin dropdown and select Add-ons.
- Click on “Find new add-ons” which is located on the left-hand side of the page.
- Search for “Katalon BDD – Test Automation for Jira”. Add-on versions compatible with your Jira instance will be displayed.
- Click “Install” to download and install the add-on.
- Upon successful installation, a dialog box saying “Installed and ready to go” will appear. Click “Close” to close it.
- The add-on is now ready for use!
The Gherkin Custom Field
Post-installation, you’ll notice that a custom field type named “Katalon Gherkin” has been added to your Jira instance. This field allows you to jot down test case descriptions and stories using Gherkin syntax.
Specific Gherkin keywords such as “Then”, “When”, and “Given” are automatically highlighted. When the issue is imported into Katalon Studio, the content of the Jira Gherkin custom field will populate the Katalon test case description.
Here are the steps to add the Gherkin Custom field:
- Navigate to “Issues”.
- Select “Fields” -> “Custom Fields” and click “Add Custom Field”.
- Choose “Advanced”.
- Select “Katalon Gherkin” and click “Next”.
- Configure the field.
- Click “Create” to establish the field.
- Click “Submit” to complete adding the Gherkin custom field.
This is a sample screenshot demonstrating how the Katalon Gherkin custom field appears in a Jira issue:
For more details on custom fields confidentialisation in Jira, you can refer to the official Jira documentation.
Setting Up Integration Between Katalon Studio and Jira
Here are the steps to configure Jira integration in Katalon Studio:
- Navigate to Project -> Settings -> Integration -> Jira in Katalon Studio.
- Check the “Enable Integration” checkbox. The settings for configuration will become accessible.
- Specify the server URL, username, and password for Jira. Click the “Connect” button.
- Once you successfully connect with Jira, all relevant Jira projects and issue types will reflect under the submit options. Select the default Jira project and issue type for submission at this stage.
- Make any other configurations as necessary.
- Click on “Apply” and then “OK” to finish setting up the Jira integration.
How to Generate Test Cases in Katalon Studio from Jira Issues
Once you complete the Jira integration setup, you’ll notice a Jira symbol in the Katalon Studio menu bar.
Follow these steps to sync Jira test cases with Katalon Studio:
- Prepare the Jira Query Language (JQL) script for sorting and searching test case outcomes in Jira.
- Click the Jira icon present in the Katalon Studio menu bar.
- Enter your JQL script from step 1 in the dialog box that opens and click “OK”.
- Select the target location for new issues and then click “OK”.
- Verify whether the Jira test cases have been successfully synced in the “Tests Explorer” in Katalon Studio.
Sharing Katalon Execution Results & Logs with Jira Issues
Katalon Studio test execution results are synced automatically with related Jira issues. Within Jira, you can check the status and attachments (logs) of Katalon Studio test cases in the “Katalon Execution Result” section. This section presents the test status and includes the execution log as attachments.
Reporting Bugs to Jira from Katalon Studio
Post-Jira integration setup, reporting bugs to Jira from Katalon Studio becomes simple. You’ll find options to submit bugs for every failed test case in Katalon Studio Test Reports. You can create a new Jira issue or link to an existing issue by clicking the Jira bug icon and submit the bug report. The linked Jira issues will display the ID, summary, and status of each issue.
Reviewing Katalon Studio Test Execution Results via JQL
You can use JQL syntax to fetch Katalon Studio test execution results from Jira. The syntax is: “Katalon Status”=<status>, where status can be either “PASSED”, “FAILED”, “INCOMPLETE”, or “ERROR”. For instance, to look for all test cases with an “ERROR” status, your JQL search should be: “Katalon Status”=”ERROR”.
Closing Remarks
We believe this guide gave you an in-depth understanding of the integration process between Jira and Katalon Studio. You can download Katalon Studio for free from the official website here. Feel free to discover more about Jira and Katalon Studio integration by clicking the links provided throughout the guide.