Katalon

https://docs.katalon.com/
Admin
Katalon is a unified quality engineering platform that combines test automation, management,...
Tokens:637,449
Snippets:8,473
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Start the Katalium Server Frontend

Source: https://docs.katalon.com/katalon-platform/plugins-and-add-ons/katalium-server/contributing-guidelines-for-katalium-server

Commands to install dependencies and launch the React-based GUI in development mode.

```bash
cd web
npm install
npm run start
```

--------------------------------

### Complete Kobiton driver sample

Source: https://docs.katalon.com/katalon-studio/integrations/test-execution/kobiton-integration-with-katalon-studio

A full example of the driver initialization code used to replace the standard start application keyword.

```groovy
import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject
import org.openqa.selenium.remote.DesiredCapabilities
import com.kms.katalon.core.appium.driver.AppiumDriverManager
import com.kms.katalon.core.configuration.RunConfiguration as RunConfiguration
import com.kms.katalon.core.mobile.driver.MobileDriverType
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as Mobile
import com.kms.katalon.core.util.internal.PathUtil as PathUtil
import internal.GlobalVariable as GlobalVariable
import io.appium.java_client.android.AndroidDriver

'Instead of using Start Application keyword, we use the below code to create a similar driver so that other Mobile built-in keywords can re-use this driver.'
String kobitonServerUrl = "https://katalon-integration:xxxxxxxxx@api.kobiton.com/wd/hub";
DesiredCapabilities capabilities = new DesiredCapabilities();
capabilities.setCapability("sessionName", "Automation test session");
capabilities.setCapability("sessionDescription", ""); 
capabilities.setCapability("deviceOrientation", "portrait");  
capabilities.setCapability("captureScreenshots", true); 
capabilities.setCapability("browserName", "chrome"); 
capabilities.setCapability("deviceGroup", "KOBITON"); 
capabilities.setCapability("deviceName", "Galaxy J3(2016)");
```

--------------------------------

### Gradle Version Output

Source: https://docs.katalon.com/katalon-studio/manage-projects/project-settings/libraries-management

Example output showing the installed Gradle version and environment details.

```text
------------  
Gradle 7.5.1  
------------  
Build time: 2022-08-05 21:17:56 UTC   
Revision: d1daa0cbf1a0103000b71484e1dbfe096e095918   
Kotlin: 1.6.21   
Groovy: 3.0.10   
Ant: Apache Ant(TM) version 1.10.11 compiled on July 10 2021   
JVM: 17.0.17 (Homebrew 17.0.17+0)   
OS: Mac OS X 15.6.1 aarch64
```

--------------------------------

### Start Application with Absolute and Relative Paths

Source: https://docs.katalon.com/katalon-studio/keywords/keyword-description-in-katalon-studio/mobile-keywords/mobile-start-application

Examples demonstrating how to launch an application using either an absolute or relative file path, followed by closing the application.

```Groovy
import static com.kms.katalon.core.checkpoint.CheckpointFactory.findCheckpoint
import static com.kms.katalon.core.testcase.TestCaseFactory.findTestCase
import static com.kms.katalon.core.testdata.TestDataFactory.findTestData
import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject
import com.kms.katalon.core.checkpoint.Checkpoint as Checkpoint
import com.kms.katalon.core.checkpoint.CheckpointFactory as CheckpointFactory
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as MobileBuiltInKeywords
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as Mobile
import com.kms.katalon.core.model.FailureHandling as FailureHandling
import com.kms.katalon.core.testcase.TestCase as TestCase
import com.kms.katalon.core.testcase.TestCaseFactory as TestCaseFactory
import com.kms.katalon.core.testdata.TestData as TestData
import com.kms.katalon.core.testdata.TestDataFactory as TestDataFactory
import com.kms.katalon.core.testobject.ObjectRepository as ObjectRepository
import com.kms.katalon.core.testobject.TestObject as TestObject
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WSBuiltInKeywords
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WS
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUiBuiltInKeywords
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
import internal.GlobalVariable as GlobalVariable

'Start application on current selected android device'
Mobile.startApplication('C:\Users\admin\androidfile.apk', true)

'Close application on current selected android device'
Mobile.closeApplication()
```

```Groovy
import static com.kms.katalon.core.checkpoint.CheckpointFactory.findCheckpoint
import static com.kms.katalon.core.testcase.TestCaseFactory.findTestCase
import static com.kms.katalon.core.testdata.TestDataFactory.findTestData
import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject
import com.kms.katalon.core.checkpoint.Checkpoint as Checkpoint
import com.kms.katalon.core.checkpoint.CheckpointFactory as CheckpointFactory
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as MobileBuiltInKeywords
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as Mobile
import com.kms.katalon.core.model.FailureHandling as FailureHandling
import com.kms.katalon.core.testcase.TestCase as TestCase
import com.kms.katalon.core.testcase.TestCaseFactory as TestCaseFactory
import com.kms.katalon.core.testdata.TestData as TestData
import com.kms.katalon.core.testdata.TestDataFactory as TestDataFactory
import com.kms.katalon.core.testobject.ObjectRepository as ObjectRepository
import com.kms.katalon.core.testobject.TestObject as TestObject
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WSBuiltInKeywords
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WS
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUiBuiltInKeywords
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
import internal.GlobalVariable as GlobalVariable

'Start application on current selected android device'
Mobile.startApplication('\androidfile.apk', true)

'Close application on current selected android device'
Mobile.closeApplication()
```

--------------------------------

### Run iOS application in background

Source: https://docs.katalon.com/katalon-studio/keywords/keyword-description-in-katalon-studio/mobile-keywords/mobile-run-the-ios-app-in-the-background-and-wait

Example demonstrating how to start an iOS application, move it to the background for 10 seconds, and then close it.

```Groovy
import static com.kms.katalon.core.checkpoint.CheckpointFactory.findCheckpoint
import static com.kms.katalon.core.testcase.TestCaseFactory.findTestCase
import static com.kms.katalon.core.testdata.TestDataFactory.findTestData
import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject
import com.kms.katalon.core.checkpoint.Checkpoint as Checkpoint
import com.kms.katalon.core.checkpoint.CheckpointFactory as CheckpointFactory
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as MobileBuiltInKeywords
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as Mobile
import com.kms.katalon.core.model.FailureHandling as FailureHandling
import com.kms.katalon.core.testcase.TestCase as TestCase
import com.kms.katalon.core.testcase.TestCaseFactory as TestCaseFactory
import com.kms.katalon.core.testdata.TestData as TestData
import com.kms.katalon.core.testdata.TestDataFactory as TestDataFactory
import com.kms.katalon.core.testobject.ObjectRepository as ObjectRepository
import com.kms.katalon.core.testobject.TestObject as TestObject
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WSBuiltInKeywords
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WS
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUiBuiltInKeywords
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
import internal.GlobalVariable as GlobalVariable

'Start application on current selected iOS device'
Mobile.startApplication(GlobalVariable.G_iOSApp, false)

'Run the appication in background and wait for 10 seconds'
Mobile.runIOSAppInBackgroundAndWait(10)

'Close application on current selected iOS device'
Mobile.closeApplication()
```

--------------------------------

### Example macOS/Linux Jenkinsfile for Katalon Tests

Source: https://docs.katalon.com/katalon-studio/integrations/cicd-integrations/jenkins-integration/execute-katalon-studio-tests-with-jenkins-pipeline-script-jenkinsfile

An example Jenkinsfile for macOS/Linux, showing how to run Katalon Studio tests. Adjust the paths and parameters according to your specific setup.

```groovy
pipeline {
    agent any
    stages {
        stage('Test') {
            steps {
                sh '''
                cd  /Users/yen.nguyen/Downloads/Katalon_Studio_Engine_MacOS-8.1.0/Katalon\ Studio\ Engine.app/Contents/MacOS
                ./katalonc  -projectPath="/Users/yen.nguyen/Downloads/ci-samples-master/test.prj" -browserType="Chrome" -retry=0 -statusDelay=15 -testSuitePath="Test Suites/TS_RegressionTest" -apiKey="<user API key>" -orgID=<Katalon_OrgID>
                '''

            }

        }

    }

}
```

--------------------------------

### Short Directory Path Example

Source: https://docs.katalon.com/katalon-studio/troubleshooting/troubleshoot-common-exceptions/how-to-overcome-kre-long-path-issue-on-windows

When manually installing Katalon Test Engine - Local, place the folder in a short directory path to mitigate the long path issue.

```text
C:/Users/KRE_10.3.2  

```

--------------------------------

### Full Kobiton Mobile Test Script

Source: https://docs.katalon.com/katalon-studio/integrations/test-execution/kobiton-integration-with-katalon-studio

A complete test script example demonstrating the workflow of starting an application on Kobiton, navigating the UI, and verifying dialog text.

```Groovy
import static com.kms.katalon.core.testcase.TestCaseFactory.findTestCase
Mobile.comment('Story: Verify correct alarm message')
Mobile.comment('Given that user has started an application')'Get full directory's path of android application'
//def appPath = PathUtil.relativeToAbsolutePath(GlobalVariable.G_AndroidApp, RunConfiguration.getProjectDir())
Mobile.startApplication('kobiton-store:v488518', false)
Mobile.comment('And he navigates the application to Activity form')
Mobile.tap(findTestObject('Application/android.widget.TextView - App'), 10)
Mobile.tap(findTestObject('Application/App/android.widget.TextView-Activity'), 10)
Mobile.comment('When he taps on the Custom Dialog button')
Mobile.tap(findTestObject('Application/App/Activity/android.widget.TextView-Custom Dialog'), 10)
'Get displayed message on the dialog'
def message = Mobile.getText(findTestObject('Application/App/Activity/Custom Dialog/android.widget.TextViewCustomDialog'),10)
Mobile.comment('Then the correct dialog message should be displayed')
Mobile.verifyEqual(message, 'Example of how you can use a custom Theme.Dialog theme to make an activity that looks like a customized dialog, here with an ugly frame.')
Mobile.closeApplication()
```

--------------------------------

### Install mcp-proxy using uv

Source: https://docs.katalon.com/katalon-studio/studioassist/mcp-servers/azure-devops-mcp-bridge-best-practices

Use the 'uv' tool to install the mcp-proxy package. This is the recommended installation method.

```bash
install mcp-proxy  
```

--------------------------------

### Get Mobile Element Width

Source: https://docs.katalon.com/katalon-studio/keywords/keyword-description-in-katalon-studio/mobile-keywords/mobile-get-element-width

Use this keyword to retrieve the width of a mobile element. Ensure the element is correctly identified and the timeout is set appropriately. This example also includes setup for starting and closing the mobile application.

```Groovy
import static com.kms.katalon.core.testcase.TestCaseFactory.findTestCase
import static com.kms.katalon.core.testdata.TestDataFactory.findTestData
import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject
import internal.GlobalVariable as GlobalVariable
import com.kms.katalon.core.configuration.RunConfiguration as RunConfiguration
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as Mobile
import com.kms.katalon.core.util.internal.PathUtil as PathUtil

'Get full directory\'s path of android application'
def appPath = PathUtil.relativeToAbsolutePath(GlobalVariable.G_AndroidApp, RunConfiguration.getProjectDir())

'Start application on current selected android\'s device'
Mobile.startApplication(appPath, false)

Mobile.tap(findTestObject('Application/android.widget.TextView - App'), 10)

Mobile.tap(findTestObject('Application/App/android.widget.TextView-Activity'), 10)

Mobile.tap(findTestObject('Application/App/Activity/android.widget.TextView-Custom Dialog'), 10)

'Drag and drop a button into another frame'
Mobile.getElementWidth(findTestObject('Application/App/Activity/android.widget.Button'), 10)

'Close application on current selected android\'s device'
Mobile.closeApplication()
```

--------------------------------

### Get Text from Mobile Element

Source: https://docs.katalon.com/katalon-studio/keywords/keyword-description-in-katalon-studio/mobile-keywords/mobile-get-text

Use this keyword to retrieve the text content of a specified mobile element. Ensure the element is correctly identified and within the specified timeout period. This example demonstrates starting an app, navigating to a custom dialog, getting its message, and verifying it.

```Groovy
import static com.kms.katalon.core.testcase.TestCaseFactory.findTestCase
import static com.kms.katalon.core.testdata.TestDataFactory.findTestData
import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject
import internal.GlobalVariable as GlobalVariable
import com.kms.katalon.core.configuration.RunConfiguration as RunConfiguration
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as Mobile
import com.kms.katalon.core.util.internal.PathUtil as PathUtil
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WS
import static com.kms.katalon.core.checkpoint.CheckpointFactory.findCheckpoint
import com.kms.katalon.core.model.FailureHandling as FailureHandling
import com.kms.katalon.core.testcase.TestCase as TestCase
import com.kms.katalon.core.testdata.TestData as TestData
import com.kms.katalon.core.testobject.TestObject as TestObject
import com.kms.katalon.core.checkpoint.Checkpoint as Checkpoint

'Start application on current selected android's device'
Mobile.startApplication(GlobalVariable.G_AndroidApp, false)

Mobile.tap(findTestObject('Application/android.widget.TextView - App'), 10)

Mobile.tap(findTestObject('Application/App/android.widget.TextView-Activity'), 10)

Mobile.tap(findTestObject('Application/App/Activity/android.widget.TextView-Custom Dialog'), 10)

'Get displayed message on the dialog'
def message = Mobile.getText(findTestObject('Application/App/Activity/Custom Dialog/android.widget.TextViewCustomDialog'), 
    10)

'Verify if displayed message is correct'
Mobile.verifyEqual(message, 'Example of how you can use a custom Theme.Dialog theme to make an activity that looks like a customized dialog, here with an ugly frame.')

'Close application on current selected android's device'
Mobile.closeApplication()
```

--------------------------------

### Prepare Installation Directory

Source: https://docs.katalon.com/katalon-platform/administer/katalon-platform-packages/katalon-platform-on-premises/katalon-on-premises-deployment-guide-v3.0.0

Commands to create the installation directory and copy the package file.

```bash
mkdir -p /katalon/katalon-3.0.0/
```

```bash
cp katalon-op-3.0.0.zip  /katalon/katalon-3.0.0/
```

--------------------------------

### Set Appium Installation Path

Source: https://docs.katalon.com/docs/execute/katalon-runtime-engine/command-line-syntax-in-katalon-runtime-engine

Provide the `appiumDirectory` argument with the path to your Appium installation, for example, `/opt/homebrew/lib/node_modules/appium`.

```bash
appiumDirectory=<path>
```

--------------------------------

### Get Android App Path and Start Application

Source: https://docs.katalon.com/katalon-studio/get-started/sample-projects/mobile/sample-android-mobile-project-in-katalon-studio

This snippet demonstrates how to get the absolute path of an Android application using `PathUtil.relativeToAbsolutePath` and then start the application using `Mobile.startApplication`. It's used in test cases to ensure the application is ready for interaction.

```Groovy
/Get full directory's path of android application/  
def appPath = PathUtil.relativeToAbsolutePath(GlobalVariable.G_AndroidApp, RunConfiguration.getProjectDir())  

/Start the AUT/  
Mobile.startApplication(appPath, false)  

```

```Groovy
/Get full directory's path of android application/  
def appPath = PathUtil.relativeToAbsolutePath(GlobalVariable.G_AndroidApp, RunConfiguration.getProjectDir())  

/Start the AUT/  
Mobile.startApplication(appPath, false)  

```

--------------------------------

### Navigate to Installation Directory

Source: https://docs.katalon.com/katalon-platform/administer/katalon-platform-packages/katalon-platform-on-premises/katalon-on-premises-deployment-guide-v3.0.0

Change to the extracted directory and list its contents.

```bash
cd katalon-op
ls -al
```

--------------------------------

### Resolve Node Installation Issues

Source: https://docs.katalon.com/katalon-studio/release-notes/katalon-studio-release-notes-version-10.x

Execute these commands to resolve dependency setup failures related to Node installation on macOS/Linux environments.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
brew update
brew uninstall node
brew install node
```

--------------------------------

### Create a GET RESTful request

Source: https://docs.katalon.com/katalon-studio/test-objects/api-test-objects/web-services-builder-in-katalon-studio

This example demonstrates how to create a GET request using the RestRequestObjectBuilder, including setting parameters and headers, and sending the request.

```APIDOC
## Create a GET RESTful request

### Description
This example demonstrates how to create a GET request using the RestRequestObjectBuilder, including setting parameters and headers, and sending the request.

### Method
GET

### Endpoint
http://jsonplaceholder.typicode.com/comments

### Parameters
#### Query Parameters
- **postId** (string) - Required - The ID of the post to retrieve comments for.
- **id** (string) - Required - The ID of the comment to retrieve.

#### Request Body
None

### Request Example
```groovy
import com.kms.katalon.core.testobject.ConditionType as ConditionType
import com.kms.katalon.core.testobject.RestRequestObjectBuilder
import com.kms.katalon.core.testobject.TestObjectProperty as TestObjectProperty
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WS

'Create a new GET object using builder'
def builder = new RestRequestObjectBuilder()
def requestObject = builder
    .withRestRequestMethod("GET")
    .withRestUrl("http://jsonplaceholder.typicode.com/comments")
    .withRestParameters([
        new TestObjectProperty("postId", ConditionType.EQUALS, "1"),
        new TestObjectProperty("id", ConditionType.EQUALS, "1")
    ])
    .withHttpHeaders([
        new TestObjectProperty("Content-Type", ConditionType.EQUALS, "application/json")
    ])
    .build()
'Send a request'
def response = WS.sendRequest(requestObject)

'Verify if comment\'s email after sending request is correct or not'
WS.verifyElementPropertyValue(response, '[0].email', 'Eliseo@gardner.biz')
```

### Response
#### Success Response (200)
- **[0].email** (string) - The email address of the comment.
```

--------------------------------

### Install libimobiledevice (Katalon Studio before 9.1.0)

Source: https://docs.katalon.com/katalon-studio/manage-projects/set-up-projects/mobile-testing/ios/mobile-set-up-ios-real-devices

Install libimobiledevice version 1.2.0 or newer using Homebrew. This command handles different architectures.

```bash
brew tap kozyrap/libimobiledevice; (brew install --HEAD kozyrap/libimobiledevice/libimobiledevice || arch -arm64 brew install kozyrap/libimobiledevice/libimobiledevice) && brew unlink libimobiledevice && brew link libimobiledevice
```

--------------------------------

### Start Existing Application

Source: https://docs.katalon.com/katalon-studio/keywords/keyword-description-in-katalon-studio/mobile-keywords/mobile-start-existing-application

This keyword is used to start an Appium driver and activate an installed application by its given application ID. Note that this keyword is not supported on cloud devices.

```APIDOC
## POST /startExistingApplication

### Description
This keyword is to start an Appium driver and to activate an installed application by its given application ID.

### Method
POST

### Endpoint
/startExistingApplication

### Parameters
#### Query Parameters
- **AppId** (String) - Required - ID of the tested application that's either the package name of an Android app or the bundle identifier of an iOS app.

### Request Example
```json
{
  "AppId": "com.facebook.katana"
}
```

### Response
#### Success Response (200)
- **status** (String) - Indicates the success or failure of the operation.
- **message** (String) - Provides details about the operation's outcome.

#### Response Example
```json
{
  "status": "SUCCESS",
  "message": "Application started successfully."
}
```
```

--------------------------------

### Switching Windows Application Context

Source: https://docs.katalon.com/katalon-studio/keywords/keyword-description-in-katalon-studio/windows-keywords/windows-switch-to-application

Demonstrates starting an application, switching to the desktop, and returning control to the application.

```Groovy
"Start the note pad application"
Windows.startApplication('C:\Windows\System32\notepad.exe')

"Switch to control the desktop"
Windows.switchToDesktop()

// Do some stuffs with the desktop

"Switch back to control the note pad application"
Windows.switchToApplication()
```

--------------------------------

### Initialize Kobiton mobile driver

Source: https://docs.katalon.com/katalon-studio/integrations/test-execution/kobiton-integration-with-katalon-studio

Replaces the standard Mobile.startApplication keyword by manually creating an Appium driver instance for Kobiton devices.

```groovy
import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject
import org.openqa.selenium.remote.DesiredCapabilities
import com.kms.katalon.core.appium.driver.AppiumDriverManager
import com.kms.katalon.core.configuration.RunConfiguration as RunConfiguration
import com.kms.katalon.core.mobile.driver.MobileDriverType
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as Mobile
import com.kms.katalon.core.util.internal.PathUtil as PathUtil
import internal.GlobalVariable as GlobalVariable
import io.appium.java_client.android.AndroidDriver

//Mobile.startApplication('kobiton-store:10717', false)
String kobitonServerUrl = "https://katalon-integration:xxxxxxxxxxxxxxx@api.kobiton.com/wd/hub";
DesiredCapabilities capabilities = new DesiredCapabilities();
capabilities.setCapability("sessionName", "Automation test session");
capabilities.setCapability("sessionDescription", ""); 
capabilities.setCapability("deviceOrientation", "portrait");  
capabilities.setCapability("captureScreenshots", true); 
capabilities.setCapability("browserName", "chrome"); 
capabilities.setCapability("deviceGroup", "KOBITON"); 
capabilities.setCapability("deviceName", "Galaxy J3(2016)");
capabilities.setCapability("platformVersion", "6.0.1");
capabilities.setCapability("platformName", "Android"); 
capabilities.setCapability("app", "kobiton-store:v488518")

AppiumDriverManager.createMobileDriver(MobileDriverType.ANDROID_DRIVER, capabilities, new URL(kobitonServerUrl))
```

--------------------------------

### Start Appium Server

Source: https://docs.katalon.com/katalon-studio/test-objects/mobile-test-objects/find-the-locator-of-a-mobile-application-element

Command to start the Appium server with a specific base path.

```bash
appium --base-path /wd/hub
```

--------------------------------

### Get Attribute of a Web Element

Source: https://docs.katalon.com/katalon-studio/keywords/keyword-description-in-katalon-studio/web-ui-keywords/webui-get-attribute

Use this keyword to retrieve the value of a specific attribute from a web element. Ensure the TestObject is correctly identified and the attribute name is accurate. This example demonstrates getting the 'class' attribute of a button.

```Groovy
import static com.kms.katalon.core.checkpoint.CheckpointFactory.findCheckpoint
import static com.kms.katalon.core.testcase.TestCaseFactory.findTestCase
import static com.kms.katalon.core.testdata.TestDataFactory.findTestData
import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject
import com.kms.katalon.core.checkpoint.Checkpoint as Checkpoint
import com.kms.katalon.core.checkpoint.CheckpointFactory as CheckpointFactory
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as MobileBuiltInKeywords
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as Mobile
import com.kms.katalon.core.model.FailureHandling as FailureHandling
import com.kms.katalon.core.testcase.TestCase as TestCase
import com.kms.katalon.core.testcase.TestCaseFactory as TestCaseFactory
import com.kms.katalon.core.testdata.TestData as TestData
import com.kms.katalon.core.testdata.TestDataFactory as TestDataFactory
import com.kms.katalon.core.testobject.ObjectRepository as ObjectRepository
import com.kms.katalon.core.testobject.TestObject as TestObject
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WSBuiltInKeywords
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WS
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUiBuiltInKeywords
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
import internal.GlobalVariable as GlobalVariable
import org.openqa.selenium.Keys as Keys

'Open browser and navigate to demo AUT site'
WebUI.openBrowser('http://demoaut.katalon.com/')

'Get 'class' attribute value of make appointment button'
attribute = WebUI.getAttribute(findTestObject('Page_CuraHomepage/btn_MakeAppointment'), 'class')

'Verify if 'class' attribute value is correct for the button.'
WebUI.verifyMatch(attribute, 'btn btn-dark btn-lg', false)

'Close browser'
WebUI.closeBrowser()
```

--------------------------------

### startApplicationWithTitle

Source: https://docs.katalon.com/katalon-studio/keywords/keyword-description-in-katalon-studio/windows-keywords/windows-start-application-with-title

Starts a Windows application at a given path and attaches to the window using the provided title.

```APIDOC
## startApplicationWithTitle

### Description
Starts the Windows driver and the application at the specified absolute path. If the main window is not automatically detected, it uses the provided window title to locate the application.

### Parameters
#### Path Parameters
- **appFile** (String) - Required - Absolute path to the Windows application.
- **windowTitle** (String) - Required - Title of the opening application window (supports full text, partial text, or regex).
- **matchingStrategy** (StringMatchingStrategy) - Optional - Strategy to match the window title (CONTAINS, REGEXP, EXACT).
- **flowControl** (FailureHandling) - Optional - Failure handling schema to determine execution flow.

### Returns
- **StepFailedException** - Throws an error if the driver fails to start, the application cannot be launched, the file does not exist, or no window matches the criteria.

### Request Example
Windows.startApplicationWithTitle('C:\\Program Files\\Microsoft Office\\root\\Office16\\EXCEL.exe', 'Excel')
```

--------------------------------

### Install libimobiledevice (Katalon Studio 9.1.0+)

Source: https://docs.katalon.com/katalon-studio/manage-projects/set-up-projects/mobile-testing/ios/mobile-set-up-ios-real-devices

Install the libimobiledevice library using Homebrew. This library is necessary for communication with iOS devices.

```bash
brew install libimobiledevice
```

--------------------------------

### User Profile Path Example

Source: https://docs.katalon.com/katalon-studio/get-started/install-katalon-studio

Example of a user-writable directory path for application resources. Ensure the directory structure exists or create it manually.

```plaintext
C:\Users\<your-username>\.yourapp\config\resources
```

--------------------------------

### Identify ChromeDriver Version Mismatch Error

Source: https://docs.katalon.com/katalon-studio/manage-projects/set-up-projects/mobile-testing/testing-web-app-on-mobile-browsers-in-katalon-studio

Example of the error message displayed when the installed ChromeDriver is incompatible with the Chrome browser version.

```text
error: No Chromedriver found that can automate Chrome '<chrome_version>'
```

--------------------------------

### Install libwebkitgtk-3.0-0 on Linux

Source: https://docs.katalon.com/katalon-studio/manage-projects/set-up-projects/api-testing/configure-linux-for-web-service-testing-in-katalon-studio

Use this command in the terminal to install the necessary package for Web Service response viewing in Katalon Studio on Linux.

```bash
apt-get install libwebkitgtk-3.0-0
```

--------------------------------

### Specify Pre-installed Katalon Studio Version

Source: https://docs.katalon.com/katalon-platform/integrations/cicd-integrations/jenkins-integration/execute-katalon-tests-on-jenkins-with-testcloud-environment

Use this format in the 'Use pre-installed Katalon Studio' box to point to a local installation directory.

```text
<Katalon Test Engine - Local  stored folder>-<Katalon Test Engine - Local  pre-installed-version>
```

--------------------------------

### Start an existing mobile application

Source: https://docs.katalon.com/katalon-studio/keywords/keyword-description-in-katalon-studio/mobile-keywords/mobile-start-existing-application

Activates an installed application on a mobile device using its application ID. This keyword is not compatible with cloud devices.

```Groovy
'Start an installed Facebook app on the selected Android device'
Mobile.startExistingApplication("com.facebook.katana")
```

--------------------------------

### Start Windows Application

Source: https://docs.katalon.com/katalon-studio/keywords/keyword-description-in-katalon-studio/windows-keywords/windows-start-application

Use this keyword to start a Windows application by providing the absolute path to its executable file. Ensure the path is correct for the test machine.

```keyword
"Start the note pad application"
Windows.startApplication('C:\\Windows\\System32\\notepad.exe')
```

--------------------------------

### Clone Sample Project using Git

Source: https://docs.katalon.com/katalon-platform/analyze/visual-testing-legacy/robot-framework-integration-with-visual-testing

Clone the sample Katalon TestOps Robot project from GitHub to your local machine to get started.

```bash
git clone https://github.com/katalon-studio-samples/katalon-testops-robot-sample.git  

```

--------------------------------

### Tap and Hold Mobile Element

Source: https://docs.katalon.com/katalon-studio/keywords/keyword-description-in-katalon-studio/mobile-keywords/mobile-tap-and-hold

Example of starting an application, performing a tap and hold action for 10 seconds, and interacting with subsequent elements.

```groovy
import static com.kms.katalon.core.testcase.TestCaseFactory.findTestCase
import static com.kms.katalon.core.testdata.TestDataFactory.findTestData
import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject
import internal.GlobalVariable as GlobalVariable
import com.kms.katalon.core.configuration.RunConfiguration as RunConfiguration
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as Mobile
import com.kms.katalon.core.util.internal.PathUtil as PathUtil

'Start application on current selected android's device'
Mobile.startApplication(GlobalVariable.G_AndroidApp, false)

'Tap and hold app control for 10 seconds'
Mobile.tapAndHold(findTestObject('Application/android.widget.TextView - App'),10, 10)

Mobile.tap(findTestObject('Application/App/android.widget.TextView-Activity'), 10)

Mobile.tap(findTestObject('Application/App/Activity/android.widget.TextView-Custom Dialog'), 10)

'Check on subscribe checkbox'
Mobile.checkElement(findTestObject('Application/App/Activity/android.widget.Check - Subscribe'), 10)

'Close application on current selected android's device'
Mobile.closeApplication()
```

--------------------------------

### Login and Navigate to Shop Page

Source: https://docs.katalon.com/katalon-studio/get-started/sample-projects/data-driven-test/sample-webui-project-with-data-driven-testing-shopping-cart-sample-in-katalon-studio

This snippet shows the initial steps of a test case: logging into the application using a custom keyword, waiting for the shop link to be present, and clicking it. It relies on global variables for timeouts and test objects.

```Groovy
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WS
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
import internal.GlobalVariable as GlobalVariable

CustomKeywords.'sample.Login.loginIntoApplicationWithGlobalVariable'()

WebUI.waitForElementPresent(findTestObject('Pages/Shop page/lnkShop'), GlobalVariable.waitPresentTimeout)

WebUI.click(findTestObject('Pages/Shop page/lnkShop'))
```

--------------------------------

### Start Application and Get Driver Title - Katalon

Source: https://docs.katalon.com/katalon-studio/keywords/keyword-description-in-katalon-studio/windows-keywords/windows-get-driver

Use `Windows.startApplication` to launch an app and `Windows.getDriver().getTitle()` to retrieve its title. Ensure the application path is correct.

```Groovy
"Start the note pad application"
Windows.startApplication('C:\\Windows\\System32\\notepad.exe')

"Get the application title"
Windows.getDriver().getTitle()
```

--------------------------------

### Install mcp-proxy

Source: https://docs.katalon.com/katalon-studio/studioassist/mcp-servers/mcp-servers-and-tools-in-studioassist

Use either UV or pipx to install the mcp-proxy tool.

```bash
uv tool install mcp-proxy
```

```bash
pipx install mcp-proxy
```

--------------------------------

### Full tunnelconfig example

Source: https://docs.katalon.com/katalon-testcloud/local-testing-with-testcloud/private-database-testing

A complete configuration file example including connection settings and multiple TCP forwarding rules.

```text
allow_hosts = []  
api_key = 'xxxxx'  
group = 'yyyyy'  
inactive_tunnel_timeout = 0  
organization_id = 1111  
private_tunnel = false  
proxy_host = ''  
proxy_password = ''  
proxy_port = ''  
proxy_username = ''  
relay_protocol = ''  
retry = 3  
server = 'https://tunnel-manager.katalon.com'  
team_id = 1111  
tenant = 'TestOps'  
username = 'demouser@katalon.com'  
forwarding_mode = "static"  
  
[tcp]  
QA_BOOKS_DB = "50000:qa-books-postgresql.rds.amazonaws.com:5432"  
STAGING_BOOKS_DB = "50001:staging-books-postgresql.rds.amazonaws.com:5432"  
QA_USERS_DB = "59999:qa-users-sqlserver.rds.amazonaws.com:1433"  
STAGING_USERS_DB = "60000:staging-users-sqlserver.rds.amazonaws.com:1433"  

```

--------------------------------

### Install Carthage (Katalon Studio before 9.1.0)

Source: https://docs.katalon.com/katalon-studio/manage-projects/set-up-projects/mobile-testing/ios/mobile-set-up-ios-real-devices

Install Carthage via Homebrew. Carthage is a dependency manager required for older Appium versions.

```bash
brew install carthage
```

--------------------------------

### Example PostgreSQL Database List Output

Source: https://docs.katalon.com/katalon-platform/administer/katalon-platform-packages/katalon-platform-on-premises/katalon-on-premises-deployment-guide-v3.0.0

This is an example output from the \l command in psql, showing the 'k1', 'keycloak', and 'kit' databases along with other default PostgreSQL databases.

```text
psql (14.12 (Ubuntu 14.12-0ubuntu0.22.04.1))
SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off)
Type "help" for help.

postgres=# \l
                              List of databases
   Name    |  Owner   | Encoding | Collate |  Ctype  |   Access privileges   
-----------+----------+----------+---------+---------+-----------------------
 k1        | postgres | UTF8     | C.UTF-8 | C.UTF-8 | 
 keycloak  | postgres | UTF8     | C.UTF-8 | C.UTF-8 | 
 kit       | postgres | UTF8     | C.UTF-8 | C.UTF-8 | 
 postgres  | postgres | UTF8     | C.UTF-8 | C.UTF-8 | 
template0 | postgres | UTF8     | C.UTF-8 | C.UTF-8 | =c/postgres          +
           |          |          |         |         | postgres=CTc/postgres
template1 | postgres | UTF8     | C.UTF-8 | C.UTF-8 | =c/postgres          +
           |          |          |         |         | postgres=CTc/postgres
(6 rows)

postgres=# 

```

--------------------------------

### Get Mobile Device Height

Source: https://docs.katalon.com/katalon-studio/keywords/keyword-description-in-katalon-studio/mobile-keywords/mobile-get-device-height

Use this snippet to retrieve the physical height of the mobile device and store it in a variable. Ensure the application is started before calling this keyword and closed afterward.

```Groovy
import static com.kms.katalon.core.checkpoint.CheckpointFactory.findCheckpoint
import static com.kms.katalon.core.testcase.TestCaseFactory.findTestCase
import static com.kms.katalon.core.testdata.TestDataFactory.findTestData
import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject
import com.kms.katalon.core.checkpoint.Checkpoint as Checkpoint
import com.kms.katalon.core.checkpoint.CheckpointFactory as CheckpointFactory
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as MobileBuiltInKeywords
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as Mobile
import com.kms.katalon.core.model.FailureHandling as FailureHandling
import com.kms.katalon.core.testcase.TestCase as TestCase
import com.kms.katalon.core.testcase.TestCaseFactory as TestCaseFactory
import com.kms.katalon.core.testdata.TestData as TestData
import com.kms.katalon.core.testdata.TestDataFactory as TestDataFactory
import com.kms.katalon.core.testobject.ObjectRepository as ObjectRepository
import com.kms.katalon.core.testobject.TestObject as TestObject
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WSBuiltInKeywords
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WS
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUiBuiltInKeywords
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
import internal.GlobalVariable as GlobalVariable

'Start application on current selected android device'
Mobile.startApplication(GlobalVariable.G_AndroidApp, false)

'Get device's physical height'
height = Mobile.getDeviceHeight()

'Close application on current selected android device'
Mobile.closeApplication()
```

--------------------------------

### Sample Command Arguments for TestCloud

Source: https://docs.katalon.com/katalon-platform/integrations/cicd-integrations/jenkins-integration/execute-katalon-tests-on-jenkins-with-testcloud-environment

Example command arguments for executing tests with TestCloud configurations. Ensure the API key is replaced with a valid credential.

```bash
-projectPath=/tmp/project -retry=0 -statusDelay=15 -testSuitePath="Test Suites/TS_RegressionTest" -browserType="TestCloud" -testcloudEnvironmentId="87" -testcloudTunnel="false" -apikey=<INPUT_YOUR_API_KEY_HERE>
```
Tokens:
Raw