Skip to main content

Sample iOS mobile tests project in Katalon Studio

This sample demonstrates iOS testing fundamentals in Katalon Studio.

The application under test is the Coffee Timer application, which contains different timers for different coffee types.

You can learn more about mobile testing in these guides:Introduction to mobile testing

Requirements​

  • iOS setup. To set up Xcode simulators/ real iOS devices, you can refer to this document: [Mobile] iOS Setup.

Open the sample iOS test project​

In Katalon Studio​

To open the iOS sample project, in Katalon Studio, go to File > New Sample Project > Sample iOS Mobile Tests Project.

Open iOS sample project

Alternatively, you can download the iOS sample project from our GitHub repository: iOS sample.

In Katalon Studio - Platform Edition​

On Katalon TestOps, open a project and clone this sample iOS test from our GitHub repository: iOS sample. See: Upload Test Scripts from a Git Repository.

In Katalon Studio - Platform Edition, open that project by going to File > Open Project.

Prepare the iOS application file​

The Coffee Timer application located in the App folder of this sample project is pre-built and signed by the Katalon team to only run on Katalon devices.

The sample coffee timer application

As part of the iOS development procedure, to execute the sample test cases with your iOS devices, you need to build and sign the Coffee Timer application for your iOS devices.

  1. Open the Coffee Timer.xcodeproj project file with Xcode. To find the project save location, go to <your-project-folder> > App > Your-First-iOS-App > Coffee Timer. Double-click the Coffee Timer.xcodeproj file.

    Open Coffee Timer Xcode project

  2. After opening the project in Xcode, select a registered iOS device to launch the apps.

    Choose the iOS device

  3. In the General tab, set the deployment iOS version and select the device type in the Deployment Info section.

    Choose the iOS system

  4. Switch to the Signing & Capabilities tab, check the Automatically manage signing box, then choose the team that has your device registered in the Apple Developer Portal.

  5. To build the .ipa file, click Product > Build.

  6. To archive the .ipa file, click Product > Archive. If the archive builds successfully, it appears in the Archives organizer.

  7. To open the Archives organizer, choose Window > Organizer and click Archives.

  8. Select the archive you want to export, then click Distribute App and follow the instructions to get the .ipa file. Here, we choose a development provisioning profile to export the Coffee Timer.ipa file.

    Build the Coffee Timer.ipa

  9. Verify the .ipa file, do as follows:

    • Navigate to Window > Devices and Simulators in Xcode.
    • Choose your device from the Devices list.

    • Click Add (+) to browse the .ipa file.

      Add the .ipa file to Xcode devices

    • Once installed successfully, the application appears in the Installed Apps section.

      Add the .ipa file to Xcode devices

  10. Put the Coffee Time.ipa file into the App folder of the sample project. Katalon will use this file to start the Coffee Time application.

For iOS simulators​

To execute the sample test cases with Xcode simulators, you need to prepare an .app file.

  1. Open the Coffee Timer.xcodeproj project file with Xcode. To find the project save location, go to <your-project-folder> > App > Your-First-iOS-App > Coffee Timer. Double-click the Coffee Timer.xcodeproj file.
    Open Coffee Timer Xcode project

  2. After opening the project in Xcode, choose one of the iOS simulators to launch the apps.
    Choose the iOS simulators

  3. To build the .app file, click Product > Build.

    When the build is finished, to find the .app file, go to ~/Library/Developer/Xcode/DerivedData/Coffee Timer/Build/Products/Debug-iphonesimulator/Coffee Timer.app.

    Note:

    To quickly search for the DerivedData folder, copy and paste the following path ~/Library/Developer/Xcode/DerivedData into the Spotlight Search.

  4. Copy and paste the Coffee Time.app file into the App folder of the sample project. Katalon will use this file to start the Coffee Time application.

For real iOS devices​

To execute mobile testing with real iOS devices, you need to prepare an .ipa file.

  1. Open the Coffee Timer.xcodeproj project file with Xcode. To find the project save location, go to <your-project-folder> > App > Your-First-iOS-App > Coffee Timer. Double-click the Coffee Timer.xcodeproj file.
    Open Coffee Timer Xcode project

  2. After opening the project in Xcode, select a registered iOS device to launch the apps.
    Choose the iOS device

  3. In the General tab, set the deployment iOS version and select the device type in the Deployment Info section.
    Choose the iOS system

  4. Switch to the Signing & Capabilities tab, check the Automatically manage signing box, then choose the team that has your device registered in the Apple Developer Portal.
  5. To build the .ipa file, click Product > Build.
  6. To archive the .ipa file, click Product > Archive. If the archive builds successfully, it appears in the Archives organizer.
  7. To open the Archives organizer, choose Window > Organizer and click Archives.
  8. Select the archive you want to export, then click Distribute App and follow the instructions to get the .ipa file. Here, we choose a development provisioning profile to export the Coffee Timer.ipa file.
    Build the Coffee Timer.ipa

  9. Verify the .ipa file.
    1. Navigate to Window > Devices and Simulators in Xcode.
    2. Choose your device from the Devices list.
    3. Click Add (+) to browse the .ipa file.

    Add the .ipa file to Xcode devices

    Once installed successfully, the application appears in the Installed Apps.

    Add the .ipa file to Xcode devices

  10. Put the Coffee Time.ipa file into the App folder of the sample project. Katalon will use this file to start the Coffee Time application.

iOS sample project components​

Test cases​

Sample test cases

There are two test cases for different purposes:

The Mexican Coffee Timer test case starts and stops the timer for making a Mexican coffee. In this example, we run the test case with a real iOS device.

  • Start the Coffee Timer.ipa application. Here, we use the sample.Common.startApplication custom keyword to run the application.
  • Tap Mexican. We set the timeout for 0 seconds.
  • Tap Start. We set the timeout for 0 seconds.
  • Tap 3:19. We set the timeout for 0 seconds.
  • Tap Stop. We set the timeout for 0 seconds.
  • Tap Back. We set the timeout for 0 seconds.
  • Close the application.

You can see the test script as follows:

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

CustomKeywords.'sample.Common.startAppliucation'()

Mobile.verifyElementText(findTestObject('Spy/XCUIElementTypeStaticText - Mexican'), 'Mexican')

Mobile.tap(findTestObject('XCUIElementTypeStaticText - Mexican'), 0)

Mobile.tap(findTestObject('XCUIElementTypeButton - Start'), 0)

Mobile.tap(findTestObject('XCUIElementTypeStaticText - 319'), 0)

Mobile.tap(findTestObject('XCUIElementTypeButton - Stop'), 0)

Mobile.tap(findTestObject('XCUIElementTypeButton - Back'), 0)

Mobile.closeApplication()

The Verify the main list test case verifies the list of the coffee name in the application. In this example, we run the test case with a real iOS device.

  • Start the Coffee Timer.ipa application. Here, we use the sample.Common.startApplication custom keyword to run the application.
  • Verify if the application is showing the Mexican item.
  • Verify if the application is showing the Colombian item.
  • Verify if the application is showing the Coffees item.
  • Close the application.

You can see the test script as follows:

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

CustomKeywords.'sample.Common.startAppliucation'()

Mobile.verifyElementText(findTestObject('Spy/XCUIElementTypeStaticText - Mexican'), 'Mexican')

MobileBuiltInKeywords.verifyElementText(findTestObject('Spy/XCUIElementTypeStaticText - Colombian'), 'Colombian')

MobileBuiltInKeywords.verifyElementText(findTestObject('Spy/XCUIElementTypeStaticText - Coffees'), 'Coffees')

Mobile.closeApplication()

Test suites​

To access the test suite in this project, in the Test Explorer panel, go to the Test Suites > Smoke Tests folder. This test suite combines the two test cases shown above.

Test Suites

Execute iOS tests​

To execute a test case or a test suite in the sample project, follow these steps:
  1. Select the test case/test suite you want to execute.
  2. On the main toolbar, click on the Run dropdown menu and select iOS as the device type.
    Execute iOS

  3. In the displayed iOS Devices dialog, select an iOS device or Xcode simulator, then click OK.
    Choose iOS device

  4. Observe the test result in the Log Viewer tab.
    View results