Test Suite

A test suite is a collection of multiple test cases. In other words, a test suite contains all the test materials required to conduct a test execution.

Since v5.9, Katalon Studio support Test Case duplication within the same Test Suite.

Create a new Test Suite

From menu

The most simple way is to go to File > New > Test Suite.

Fill in the name of the test suite and the description (optional).

From a Test Case

Here's another way to create a test suite: Navigate to the Add to test suite button after you have finished scripting a test case.

There are two options to add test cases:

  • Add to an existing test suite (for you to locate the test cases in an existing test suite)
  • Add to a new test suite (for you to locate the test cases in a new test suite)

Modify Execution Information

You can manage additional configurations for test suite execution by expanding the Execution Information section, as below:

Field Description

Page load timeout:

 

The timeout period allowed to wait for a page to be loaded. You can choose among the following options:

 

Retry:

The maximum number of retries for execution until it is successfully passed. You can opt to retry only failed test cases.

 

Mail Recipients

The list of recipients who would receive the execution report once the test suite finishes its execution.

There's also another list of recipients who will be receiving all the reports from Katalon by default. Refer to Emails Settings for more details.

Last run:

The datetime when the test suite was last executed. You can quickly open the report of this execution by clicking on the Last run hyperlink.

 

Manage Test Case List

There are several ways to add Test Cases into Test Suites. You can drag and drop the Test Case into Test Suites or using the Test Suite editor to manually add the test case.

Note: Test Cases can be duplicated in the same Test Suite.

Open a test suite, then select option to add Add Test Case from command toolbar.

All test cases in Katalon Studio are displayed in the Test Case Browser dialog for you to select your preferred options. The selected test cases will be added in the test case list accordingly.

The checkbox at the end of test case row is checked by default. It means that the test case will be executed when running a test suite.

Dynamic Test Suite (Dynamic Test Cases List)

Dynamic Test Suite is a test suite in which a collection of multiple test cases are added to NOT in a manual way but via search query. This feature only works when you have already installed the plugin that defines the querying syntax. In case there is no installed plugin, the Query Provider is set to “No query provider available.” by default.

Currently, there are three plugins from Katalon Store, which enable this feature by providing query search function and returning any matched test cases or test suites of the query statement.

After installing one of those plugins, go to Katalon Studio and click Reload Plugins. Learn more about how to reload plugins.

Query Provider: the query syntax standard of a plugin that is currently applied. For example, when you successfully install the Basic Search For Dynamic Test Suite plugin, the query syntax standard becomes "Built-in".

Query: this search box allows you to input the query syntax manually. For example: id=(Test Cases/Simple Examples/Katalon Shop/Custom-keyword samples/Order and check out a single product).

Query Builder provides a convenient way to create and run query in Katalon Studio.

  • Id: to search by the exact IDs of a test artifact.
  • Name: to search by the name of a test artifact.
  • Tag: to search by the tag linked to test artifacts.
  • Comment: to search by the comments attached to test artifacts.
  • Description: to search by the description associated with test artifacts.

Note: Search criteria are applied to all test artifacts including test case, test suite, folder, and etc.

Preview: to view the results after having the searching query.

Execute a Test Suite

Open a test case/test suite, then select the environment to run the test case from Run command of the main toolbar. You can also execute the test case using console mode

If you simply click on the Run button, the test case will be executed using the default browser defined in Execution Settings.

Execution EnvironmentExecution Guide
BrowsersSimply select to execute your test on one of the supported browsers (Chrome, Firefox, IE, Safari, Edge)
Mobile BrowsersSimply select to execute your test on one of the supported devices (Android, iOS)
Mobile

Before executing your test, check if you have set up the environment for mobile testing for Windows or for macOS. Select your device among those listed in Katalon Studio.

 

Troubleshooting

If there is no device listed, please make sure the Developer Mode on the phone is turned on, try to unplug and reconnect several times until you are prompted for accepting/trusting this device.

RemoteMake sure you have set up default configuration for the remote environment in project settings. Refer to Introduction to Desired Capabilities for more details.
CustomMake sure you have set up default configuration for the remote environment in project settings. Refer to Custom Execution for more details. When you have set up your custom environment, simply select it from the drop-down list.

The Job Progress will be triggered automatically to show the progress while your test case/test suite is being executed.

Feedback