CircleCI orbs integration

Orbs are shareable packages of configuration elements such as jobs, commands, and executors. They facilitate streamlined integration across various projects. For further details on orbs, refer to the Orbs overview in the CircleCI documentation.

This guide demonstrates how to use the Katalon orb for executing Katalon tests within your CircleCI CI/CD pipeline. For optimal functionality and access to new features, download the latest Katalon orb on CircleCI: katalon/katalon-studio.

Note:

• Katalon TestOps CI is an easier way to execute or schedule Katalon Studio tests remotely. See Schedule test runs in TestOps.

Setup and configuration

• An active Katalon Runtime Engine license. See Activate a KRE license.

To run your test with the Katalon orb, you need to establish a connection between your Katalon project on GitHub and CircleCI. Follow these steps to set up and configure your project:

Prepare your project in GitHub

1. Log in to CircleCI using your GitHub account.
   
   
   
2. Use an existing repository on GitHub or create a new one to store your Katalon project code.
3. To execute a test in CircleCI, create a .circleci folder within your GitHub repository and add a .yml file that contains the necessary Katalon commands (for example, katalon-studio-samples/ci-samples/.circleci/config.yml). Commit these changes to your repository.
   Below is an example of what the config.yml file might include.

   

   Note:

   • You can only configure katalonstudio/run to run Katalon tests in the orb source code. For the supported options, see Command-line syntax.

Configure environment variables in CircleCI

4. Download the latest Katalon orb from CircleCI.
5. In CircleCI, select Go to Application.
   
   
   
6. The Application page appears. Choose a Git organization.
   
7. In your preferred project, choose Project Settings.
   
   
   
8. Once on the Project Settings page, choose Environment Variables from the left sidebar.
   
   
   
9. Select Add Environment Variable or Import Variables to set values in your project, for example, KATALON_API_KEY.
   
   
   

   Note:

   • To secure your project settings, you need to get the API Key from ​Katalon TestOps​.

   • Set KATALON_API_KEY​ as an environment variable in CircleCI. Do not store this API Key in the source code. See also ​How to create API Keys in Katalon TestOps.

Execute tests with Katalon orb

Katalon orb automatically executes Katalon tests after each commit to the configured GitHub repository.

To execute tests with Katalon orb and download test execution reports, follow these steps:

1. Go to CircleCI, navigate to Project > Branch, and select Run Pipeline.
   
   
   
2. After running Katalon tests in CircleCI, you can download test execution reports in the ARTIFACTS tab.
   
   
   

Usage examples

Note:

• For CI sample projects of Katalon Studio, see CI samples.

Below is an example of using the Katalon orb to execute a test suite with the latest version of Katalon Studio.

version: 2.1
orbs:
    katalon-studio: katalon/katalon-studio@23.0.11
    
workflows:
  build:
    jobs:
        - katalon-studio/run:
                version: "latest"
                command_arguments: '-browserType="Chrome" -retry=2 -statusDelay=15 -testSuitePath="Test Suites/TS_RegressionTest"'