Skip to main content
Version: legacy

Use Katalon plugins for Jenkins integration on Ubuntu

  • Katalon TestOps CI is an easier way to execute Katalon Studio tests remotely or schedule remote Katalon Studio execution. Learn more

This tutorial will walk you through basic steps to run Katalon Studio’s web UI tests using our plugin for Jenkins on a headless Ubuntu machine i.e. a machine without any display.

If you are interested in using Docker images instead, see

Install Jenkins

To install Jenkins, follow the official instructions by Jenkins.

Install Google Chrome

wget -O google-chrome-stable_current_amd64.deb
sudo dpkg -i google-chrome-stable_current_amd64.deb
sudo apt -y -f install

Install Xvfb

From Wikipedia:

"Xvfb or X virtual framebuffer is a display server implementing the X11 display server protocol. In contrast to other display servers, Xvfb performs all graphical operations in virtual memory without showing any screen output. From the point of view of the client, it acts exactly like any other X display server, serving requests and sending events and errors as appropriate. However, no output is shown. This virtual server does not require the computer it is running on to have any kind of graphics adapter, a screen or any input device. Only a network layer is necessary."

sudo apt install -y xvfb

Install Katalon plugin for Jenkins

Go to Manage Jenkins > Manage Plugins > Available and find Katalon plugin on the list.

jenkins plugin

Create and configure a new Jenkins project

To keep it simple, I will use Freestyle project.

jenkins docker

The sample Katalon Studio project can be cloned from Github.

source code management

Next, add and configure the build step Execute Katalon Studio tests provided by Katalon plugin for Jenkins.

  • Katalon Studio will be downloaded and installed automatically based on the version you specify.
  • Leave out -runMode in the arguments list.
  • If you want to learn more about xvfb-run configuration please see its manual. If you are not sure, only change the resolution 1024x768x24 and leave other options as-is.

execute katalon studio tests

publish test result report

If for some network conditions the Katalon Studio package cannot be downloaded, you can install it manually and specify its location.

me@ubuntu:~$ sudo su
root@ubuntu:~$ su jenkins
jenkins@ubuntu:~$ wget
jenkins@ubuntu:~$ tar -xzf Katalon_Studio_Linux_64-5.10.1.tar.gz
jenkins@ubuntu:~$ cd Katalon_Studio_Linux_64-5.10.1 && pwd

The last command will print the location you need (/var/lib/jenkins/Katalon_Studio_Linux_64-5.10.1).

Run the Jenkins job

Go to the Jenkins project page (e.g. at http://localhost:8060/jenkins/job/test/ if its name is “test”), click Build Now.

After it is complete, you can find the report in the Last Successful Artifacts section.