|iOS||9, 10||Not supported on Windows|
1.1 Libraries and application
- node and npm
- A Mac with Xcode and the Xcode Command Line Developer Tools.
- An Apple Developer ID and a valid Developer Account with a configured distribution certificate and provisioning profile.
- Your .ipa application must also be able to run on your device. The central requirements are the same: to have a build of your app (an
.ipafile) signed with a development provisioning profile. A good overview of the process can be found here and here.
- An iPad or iPhone. Make sure this has been set up for development in Xcode. See this article for more information.
- An Android device if you want to execute tests on it.
2. Setup environment
Below command will install the latest version of Appium
If you with to install different version, then include version number (x.x.x) in this command:
Ignore this step if you just want to use Android device
Open Xcode > Preferences > Accounts: Add developer’s Apple ID
Open Terminal and enter following command to initialize WebDriverAgent project:
- Open project WebDriverAgent.xcodeproj within folder WebDriverAgent in Xcode.
- Select target WebDriverAgentLib, in the Signing section, check Automatically manage signing and select the team.
- Then on the menu bar, select Product > Build
- Repeat the last two steps for WebDriverAgentRunner
Xcode may fail to create a provisioning profile for the
This necessitates manually changing the bundle id for the target by going into the "Build Settings" tab, and changing the "Product Bundle Identifier" from
com.facebook.WebDriverAgentRunnerto something that Xcode will accept:
Build WebDriverAgent to verify all above steps worked
where <udid> is your Device ID
- In case this dialog is displayed, select Always Allow.
If this was successful, the output should end with something like:
Test Suite 'All tests' started at 2017-01-23 15:49:12.585 Test Suite 'WebDriverAgentRunner.xctest' started at 2017-01-23 15:49:12.586 Test Suite 'UITestingUITests' started at 2017-01-23 15:49:12.587 Test Case '-[UITestingUITests testRunner]' started. t = 0.00s Start Test at 2017-01-23 15:49:12.588 t = 0.00s Set Up
To completely verify, you can try accessing the WebDriverAgent server status (note: you must be on the same network as the device, and know its IP address, from Settings => Wi-Fi => Current Network)
3. Setup Devices
- Turn on the phone’s developer mode (go to Settings > Developer options).
- Connect your Android Phone to your computer via a USB cable. Just confirm if prompted for accepting/trusting the phone.
- Connect your iOS Devices to your computer via a USB cable. Just confirm if prompted for accepting/trusting the phone.
- Enable the service UI automation on the device :
- Connect the iOS device to Xcode
- Settings on the iOS device > Developer > turn ON UIAutomation
- To test an iOS native application file (.ipa or .app file), make sure the application file is already built and signed properly to deploy on the device. Follow these steps to check if an application file is already built and signed correctly:
- Open Xcode and navigate to Window/Devices
- Choose your device from the Devices list
- Press the “+” button and choose you application file
- If installed successfully, the application will appear in the Installed Apps section as shown below.
Once setting up successfully, follow the following guides to perform mobile testing in Katalon Studio
Troubleshoot common issues
Issue / Error Message
|xcodebuild exited with code '65' and signal 'null'||Your .ipa application is not signed correctly.||Sign and rebuild the WebDriverAgent XCode project with your developer certificate.|
|"Carthage not found" error message is displayed||You are using Appium 1.7 with Katalon Studio version less than 188.8.131.52||Use Katalon Studio v184.108.40.206 to address this issue.|
|Real device is not displayed on device list of Katalon Studio|
UIAutomation is not turned on
Check if UIAutomation is turned on:
Credit to :
with some adjustments to Katalon Studio settings