Integrations in Katalon Platform
Katalon Platform supports numerous integrations with third-party platforms and functionalities such as project management, test execution frameworks, test scripts migration and CI/CD.
An asterisk(*) indicates the integration will work for most users but has not been tested for every use case.
Integrate Katalon Studio with other Katalon Platform tools
| Products | Supported Katalon Studio versions |
|---|---|
| Katalon TestCloud | v8.2.5+ |
| Katalon TestOps | v7.0.0+ |
| Katalon TestOps Private Instance | v8.3.5+ |
| Katalon Recorder | v7.8.0+ |
Cloud device integrations
| Product | Description | Supported Katalon Studio versions |
|---|---|---|
| TestCloud | Execute tests on the cloud with the most popular browsers, operating systems, and mobile devices. See: Supported environments for Katalon TestCloud. | |
| AWS Device Farm | Execute your Katalon test scripts with devices provided on AWS Device Farm by using aws-device-farm-integration. | |
| App Center | Execute your Katalon test scripts with devices provided on App Center Test by using sideload to package Katalon projects in JUnit format. | |
| BrowserStack | Execute your tests on BrowserStack Selenium Grid from your Katalon Studio instance. You can also try our cloud-based test environment, see TestCloud overview. | v7.0.0+ |
| CircleCI | Set up a CircleCI test environment to schedule and execute tests remotely with Katalon TestOps. | |
| Docker image |
| |
| Kubernetes | Create a Kubernetes (EKS) test environment to execute or schedule Test Runs in Katalon TestOps. | |
| Kobiton |
| v7.0.1+ |
| LambdaTest | Run your tests on LambdaTest Selenium Grid from your Katalon Studio instance. | v7.8.0+ |
| Sauce Labs | Execute tests with Sauce Labs profiles and view Katalon test execution results on Sauce Labs using the Sauce Labs Integration from Katalon Store. You can also try our cloud-based test environment, see Katalon TestCloud overview. | v7.0.0+ |
| Custom integration | Define desired capabilities in different environments for a Katalon project. | v7.0.0+ |
| pCloudy* | Execute mobile and web automation tests with Katalon Studio on pCloudy mobile devices and browsers. |
ALM integrations
| Products | Description | Supported Katalon Studio versions |
|---|---|---|
| Azure DevOps Test Plans |
| v8.0.0+ |
| Git | Store and access test scripts for execution, see: | v7.0.0+ |
| Jira |
| v7.0.0+ |
| Rally | Link Katalon Studio test cases and view test execution results in Rally using the Rally Integration plugin from the Katalon Store. | v7.0.0+ |
| SeaLights | Produce test suites that consist of suggested test cases based on analytics retrieved from SeaLights and report test results back. | |
| Slack |
| |
| TestLink | Manage Katalon tests on TestLink and view test results on TestLink after execution. | v7.0.0+ |
| TestRail |
| v7.6.5+ |
| qTest | Map Katalon tests and upload test results to qTest. | v7.0.1+ |
| Custom ALM integration | Integrate with other tools using plugins or custom plugins on Katalon Store. | v7.0.0+ |
| Zephyr Scale* | Integrate Zephyr Scale Cloud in JIRA with Katalon Studio. |
CI/CD integrations
Integrate Katalon projects into your CI/CD pipeline and set up your tests to be triggered when there is a new update in your project.
| Products | Versions | Description | Supported Katalon Studio versions |
|---|---|---|---|
| AWS CodeBuild | Integrate AWS CodeBuild with Katalon Docker image. See our sample on GitHub: buildspec.yml. | ||
| Run Katalon projects with Azure DevOps using Visual Studio Marketplace extension: Katalon for Azure DevOps. | |||
| Bamboo | Bamboo Server v6.0.0+ | Download, deploy, and execute Katalon Studio tests on the Bamboo CI server automatically using the plugin on Atlassian marketplace: Katalon Studio for Bamboo. | v7.8.0+ |
| BitBucket |
| ||
| BuildKite | See our BuildKite sample pipeline on GitHub: .buildkite/pipeline.yml. | ||
| CircleCI | Execute Katalon tests with your CircleCI CI/CD pipeline using Katalon Orb: katalon/katalon-studio. | v7.8.0+ | |
| CloudBees CodeShip | See our CodeShip sample pipeline on GitHub: | ||
| GitHub Actions | Automate Katalon Studio projects execution using Katalon Studio GitHub Action on GitHub marketplace. | v7.8.0+ | |
| GitLab CI/CD | Integrate your Katalon Studio project and run your GitLab CI/CD jobs in a Docker container built from the Katalon Studio Docker image. See our GitLab sample pipeline on GitHub: .gitlab-ci.yml. | ||
| Google Cloud Build | Integrate and execute your Katalon project with Google Cloud Build. | ||
| Harness CI | Set up a Workflow with Harness FirstGen and execute the tests in a Kubernetes cluster farm. | ||
| Jenkins | Integrate Jenkins with Katalon Runtime Engine and execute Katalon tests with Jenkins. See our Jenkins sample pipeline on GitHub: Jenkins. | v7.8.0+ | |
| TeamCity | Integrate TeamCity with Katalon Runtime Engine and execute Katalon tests with TeamCity using the Katalon Studio Runner plugin on JetBrains marketplace. | v7.8.0+ | |
| Travis CI | Sync Katalon projects with Travis CI and execute Katalon tests. See our Travis CI sample pipeline on GitHub: .travis.yml. |
Framework integrations
You can upload test results from other frameworks to the Katalon Platform.
| Products | Description |
|---|---|
| Mocha | Submit test results from the Mocha framework to Katalon TestOps. Sample project: Katalon TestOps JavaScript Reporters. |
| Jest | Submit test results from the Jest framework to Katalon TestOps. Sample project: Katalon TestOps JavaScript Reporters. |
| Pytest | Submit test results from the Pytest framework to Katalon TestOps. Sample project: TestOps Pytest sample. |
| Extent Reports | A customizable HTML reporting library for Java and .NET leveraging from Katalon Studio test suite report. |
| Cypress* | Submit test results from the Cypress framework to Katalon TestOps. |
| Playwright* | Submit test results from the Playwright framework to Katalon TestOps. |
Jira integration for Katalon Platform
The Jira integration combines test execution capabilities from Katalon and issue tracking from Jira to provide you with a seamless workflow between both platforms.
Jira integration in Katalon TestOps
To enable Katalon TestOps - Jira integration, follow this guide: Enable Katalon TestOps - Jira integration for test management.
Katalon TestOps - Jira integration allows you to:
- Link test cases to Jira requirements. See Link test cases to Jira requirements.
- Link test runs to a populated Jira release. See Link test runs to a release in TestOps.
- Link test runs to Jira defects. See Link test runs to Jira defects in Katalon TestOps.
- View test results in Jira Test Results gadget. See View test results in the Jira Test Results gadget.
BDD testing with Jira - Katalon Studio integration
If you want to conduct BDD testing and manage them in Jira, refer to Manage BDD test cases with Jira integration.
Next, to import BDD test cases for execution in Katalon Studio, you need to configure Jira integration in Katalon Studio. See Enable Jira integration in Katalon Studio.
Katalon Studio provides a seamless Jira integration that allows you to:
- Write BDD scenarios in Jira tickets.
- Import BDD test cases from Jira to Katalon Studio.
- Link test execution results with the corresponding Jira tickets.
You can also view the test results in Katalon TestOps. See View BDD test results in Katalon TestOps.
BDD Testing Framework (Cucumber integration)
For better performance, you should clean up the Katalon workspace frequently. Navigate to File > Clean up.
Behavior-driven development (BDD) testing framework allows you to create test cases in plain English. BDD testing framework focuses on the behavior of the product and user acceptance criteria. Cucumber is a BDD framework tool to write test cases, which uses Gherkin, an ordinary language parser, that permits writing scripts in English.
The integration of the Cucumber framework in Katalon Studio allows you to include Cucumber test hooks, which work at the start and the end of a scenario in a behavior-driven development (BDD) test. To learn more about test hooks in the Cucumber framework, you can refer to this Cucumber document: Cucumber Hooks reference.
With the BDD testing framework in Katalon Studio, you can:
Create or add a feature file.
Define and link steps.
Set the default package for step definitions.
Run your feature file.
Add your feature file to a test case.
View BDD report files generated from Katalon Studio.
Upload and view BDD reports on Katalon TestOps.
To start working with BDD feature files and use test hooks for your BDD framework, see Working with BDD feature files in Katalon Studio.
To learn how to create BDD test cases, see Create BDD test case in Katalon Studio.
You can download the sample project here on our GitHub repository: Katalon BDD Cucumber Tests.
Migration from other tools
| Tools | Description | Supported Katalon Studio versions |
|---|---|---|
| JUnit | Migrate your test cases from JUnit projects to Katalon Studio. | |
| Postman | Import RESTful test requests from Postman to Katalon Studio. | v7.8.0+ |
| Selenium | Migrate your test cases from Selenium to Katalon Studio. | v7.4.0+ |
| Selenium IDE | Import a Selenium IDE version 3 project for execution with Katalon Studio. | v7.5.10+ |
| SoapUI | Import SOAP requests to Katalon Studio. | v7.8.0+ |
| TestNG | Migrate your test cases from TestNG to Katalon Studio. | |
| TestProject* | Migrate your test cases from TestProject to Katalon Studio. |
Other integrations
| Products | Description | Supported Katalon Studio versions |
|---|---|---|
| Applitools | Visual-based testing for record and script modes. You can also try our Visual Testing add-on in Katalon Platform, see: Visual Testing overview. | v6.1.2+ |
| SAP Scripting Tracker | Combine Katalon Studio with SAP Scripting Tracker for Windows. | v7.0.0+ |
| Selenium Grid | Execute your scripts on remote machines by using Selenium Grid. | |
| Axe API* | Evaluate if your website follows the Web Content Accessibility Guidelines (WCAG). | |
| Canvas automation* | Automate actions on HTML canvas elements, which is not accessible via DOM (by Xpath, CSS, or Property). | |
| Microsoft Dynamics 365* | Automate test cases on Microsoft Dynamics 365 with Katalon Studio. | |
| OctoPerf* | Conduct performance testing with OctoPerf and track results with Katalon Platform. | |
| Oracle Cloud* | Automate test cases on Oracle Web platform with Katalon Studio. | |
| OTP use cases* | Automate extracting OTP (one-time password) from different platforms with Katalon Studio. | |
| PowerBI* | Automate Power BI applications with Katalon Studio. | |
| QR code scanning* | Automate QR code scanning on mobile devices with Katalon Studio. | |
| Salesforce* | Automate Salesforce applications with Katalon Studio. | |
| Upload file for web application* | Automate uploading file to web applications with Katalon Studio. | |
| SikuliX* | Automate actions on desktops computer with SikuliX library on Katalon Studio. |