Set up Katalon AI Agent
This document shows you how to set up Katalon AI Agent for autonomous test generation with TrueTest.
- You must be the Administrator of your Katalon Account. See: Administrative Roles and Permissions.
- You must have a Git script repository configured in TestOps with the Write permission. See: Configure a Git repository in TestOps.
Add application under test
To configure autonomous test generation, first you need to define an application under test (AUT). The AUT specifies the production environment where Katalon AI can track all user interactions and leverage them in generating test cases.
Follow these steps:
Configure the application under test
After the AUT is defined, you need to install the event tracking agent in your application, provide the development environment and link with the test project.
- Install TrueTest on your application. You can manually add the tracking snippet in the AUT source code or use Google Tag Manager.
- Add Test Environment(s).
- Link Project(s).
After configuring the three components, navigate back to the Application Under Test list and check the Activation Date, Last Data Received Date data columns, and the Active status. These items signify that the Katalon AI Agent has successfully tracked data from the AUT.
Install TrueTest snippet
A developer or someone with access to the codebase of the AUT must add the tracking code snippet provided by Katalon. The code snippet should be pasted into the <HEAD> element of the HTML code of the AUT. Once the code snippet is added, the AUT should be saved, built, and deployed to the production environment.
TrueTest also provides the option to install with Google Tag Manager.
Follow one of the two steps below to install the code snippet:
Add test environment
To generate test cases with the traffic collected from the production site, Katalon AI Agent needs a test environment to gain context about the login mechanism of your AUT.
To add a test environment, follow these steps:
Environment URL should follow the correct pattern with the appropriate protocol and should not contain unnecessary trailing slashes. For example, a valid domain can be https://qe.your-app.com.
For login method, there are two options: No Authentication or Others for custom login script.
Logging in with custom script requires you to commit the script in your linked project: Link project.
You can use the record and playback feature in Katalon Studio to record the login actions on your test environment. This will help generate a corresponding login script. See: Record and playback in Katalon Studio.
There are three ways to use the custom script.
Link project
Once test cases are generated, TrueTest needs to store the tests in a repository.
The Git script repository must be configured with Write permission.
Data privacy configuration (optional)
TrueTest has a filtering mechanism to exclude sensitive information from user's application under test, see: Protect user data privacy.
Additionally, users have the option to manually specify which fields or elements should be excluded while TrueTest is collecting data. To do so, simply add CSS class katalon-excluded
to the UI elements that you do not want their values to be captured.