Kaixa, a simple and customizable way to write Katalon tests

Kaixa is pronounced "Kaisha" and is taken from the Catalan word for "box" as in "toolbox"

Quickstart

You need node and npm installed. Visit nodejs.org to install those.

1. Navigate to your Katalon project in terminal

cd ~/Katalon\ Studio/MyProject

2. Add Kaixa using the npm init kaixa command

npm init kaixa

Updating Kaixa

To update Kaixa, just repeat steps 1 and 2 whenever you want to update your version of Kaixa.

cd ~/Katalon\ Studio/MyProject
npm init kaixa

Writing Tests

1. Create a test and switch to "script" view

2. Use Kaixa functions to write your test

That's it! Here's an example:

// Log in
Kaixa.typeInto('#username', 'TestUser');
Kaixa.typeInto('#password', '149t8q23y');
Kaixa.click('#login-button');

// Do something interesting
Kaixa.click('.btn-interesting');

// Close the tool
Kaixa.click('#close-button');

// Clean everything up
Kaixa.done();

Functions by Category:

Interactions – interact with stuff on the page

Browser Actions – interact with the browser

  • done - close the browser and clean up
  • closeWindow - just close the current window

Harvard Functions – special functions for interacting with Harvard services

Canvas & LTI Functions – special functions for Canvas apps

Intelligent Waiting – wait better

Assertions – make sure your app behaves properly

Handy Functions – useful utilities

Elements – deal with elements

Data – get data from the page or elements

Logging – write to the log

  • log - add something to the log

Defaults – set behavior defaults