Skip to main content

CI/CD Integration Overview

Katalon Runtime Engine supports running your tests in several CI environments. Test execution in CI/CD pipeline provides the following advantages:
  • Being quick and easy: you don't have to install Katalon Studio manually.
  • Being able to work even on machines without displays.
  • Allocating an isolated virtual display (e.g., Xvbf for Jenkins) that increases the stability of execution.

Below are the supported CI environments and their sample configurations.

Supported CIExample configuration
CLI environments run_chrome.bat, run_chrome.sh
Azure DevOps Integrationazure-pipelines.yml
AWS CodeBuild Integrationbuildspec.yml
Bamboo Add-onKatalon Studio for Bamboo
Bitbucketbitbucket-pipelines.yml
Buildkitebuildkite.yml
CircleCI - Katalon Orbcircleci.yml
CodeShipcodeship-services.yml, codeship-steps.yml
Katalon Docker Imagedocker-compose.yml
GitHub ActionKatalon Studio GitHub Action
GitLabgitlab-ci.yml
Google Cloud Buildcloudbuild.yml
Harness Integration.harness
Jenkins Integration OverviewJenkinsfile
TeamCity PluginTeamCity Plugin
Travistravis.yml

Use TestCloud in CI/CD pipelines

From Katalon Runtime Engine (KRE) version 8.6.5, to execute tests in TestCloud environments, you only need a TestCloud subscription or trial; Katalon Runtime Engine license is not required. This also enables you to use TestCloud in any CI/CD pipelines configured with KRE.

Test suite execution

To trigger test suite execution with TestCloud environments from KRE, you need to specify the following arguments:

Command-line argumentDescriptionData typeMandatory
-browserType="TestCloud"

The browser type used for test suite execution. The "TestCloud" value means you are using TestCloud environments.

StringRequired (for single test suite execution)
-testcloudEnvironmentId

The ID of the environment which corresponds to a combination of OS, browser type and browser version to execute. This ID can be generated with Command Builder.

StringRequired (for single test suite execution)
-testcloudTunnelAllow the execution to be performed via TestCloud Tunnel.BooleanOptional
For example, with GitHub Actions, to execute a test suite from KRE command to TestCloud environment, you can use the following workflow template:
name: CI
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]

jobs:
build:
runs-on: windows-latest
steps:
- name: Checkout
uses: actions/checkout@v3.0
- name: Katalon Studio Github Action
uses: katalon-studio/katalon-studio-github-action@v3.0
with:
version: '8.6.5'
projectPath: '${{ github.workspace }}'
args: '-noSplash -retry=0 -testSuiteCollectionPath="Test Suites/Sample Test Suite" -browserType="TestCloud" -testcloudEnvironmentId="256" -apiKey= ${{ secrets.API_KEY }} --config -webui.autoUpdateDrivers=true'

Test suite collection execution

The TestCloud environments for individual test suites are already included in the test suite collection file. See: Manage test suite collections in Katalon Studio.

Therefore, the browserType and testcloudEnvironmentId arguments are not required. The test suites configured with TestCloud are automatically uploaded to TestCloud environments.KS test suite collection run configuration