iOS Devices

Eggplant Gateway can be used to test against iOS devices from Windows, Linux, and macOS machines, and supports testing on real, physical iOS devices over Wi-Fi and USB.

info

Supported iOS versions:

• Eggplant Gateway supports all major iOS versions except versions between 17 and 17.3 on Windows, Linux and MacOS.

Getting Started

Before you can use the Eggplant Gateway to connect to iOS, you must:

1. Have access to an iOS Provisioning Profile which allows you to sign iOS applications and run iOS applications signed with your developer certificate on your devices.
2. Have a copy of the relevant developer disk images on your local machine.
   • For devices running iOS 16 and earlier:
     • On a Mac machine, make sure the latest version of Xcode is installed.
       • When Xcode is installed you can use the default /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/DeviceSupport folder as developerDiskLocation.
     • On Windows or linux you need to copy the appropriate developer disks from a MacOS pc with Xcode installed.
       • Navigate to the /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/DeviceSupport folder on a Mac machine.
       • Create a zip archive that contains the contents of this folder.
       • Copy this zip archive to your Windows or linux PC and unzip it.
   • For devices running iOS 17.4 and later
     • (on Linux) Open a shell and run sudo apt install net-tools.
     • The developer disks are mounted automatically. Note that this requires internet connection. Eggplant Gateway automatically fetches the personalized developer disk.
3. Install iTunes (on Windows) or usbmuxd (on Linux).

Enabling Automation on Your iOS Device

1. Establish trust between your PC and your device.
   • Connect your iOS device to your PC using an USB cable.
   • The pop-up Trust this Device will appear on your iOS device, tap Trust. It can take up to one minute for your iOS device and your machine to initiate the pairing process.
2. Enable developer mode on your device (iOS 16 and later).
   • In the Settings app on your iOS device select Privacy & Security then scroll down and tap Developer Mode.
   • Turn on the Developer Mode toggle at the top.
   • A prompt will appear at the bottom asking you to reboot your iOS device for enabling the feature. Tap Restart to proceed. Your iOS device will now reboot.
   • Once the device is restarted and unlocked, a prompt should appear on the screen asking you whether you wish to turn on Developer Mode on your device. Tap Turn On. When you do that, iOS will enable Developer Mode on your iOS device and you should be able to connect.

Creating a Connection

To create an Eggplant Gateway connection to an iOS device, run the following command:

epgw add ios
--name <name> (REQUIRED)
--udid <udid>
--provisioningProfile <path> (REQUIRED)
--developerCertificate <path> (REQUIRED) 
--developerCertificatePassword <password> (REQUIRED)
--developerDiskLocation <path> (iOS17.4 or later devices with compulsory internet connection omit this option)

For example, for iOS 16 or earlier devices:

epgw add ios --name ios --provisioningProfile "C:\" --developerCertificate "C:\" --developerCertificatePassword "****" --developerDiskLocation "C:\"

Or for iOS 17.4 or later devices:

The available options are:

Key	Description
name	The connection name.
udid	The UDID of the device on which to run the Xcode UI Test. You can omit this parameter if exactly one iOS device is connected to your computer.
provisioningProfile	The path to the provisioning profile to use when installing WebDriverAgent.
developerCertificate	The path to the developer certificate to use to resign WebDriverAgent.
developerCertificatePassword	The password to use to retrieve the private key of the developer certificate.
developerDiskLocation	The path to the directory which stores the developer disk images. Note that iOS17.4 or later devices with compulsory internet connection omit this option.
help	Show help and usage information.

Start a Connection

Open a new terminal window and run epgw vnc <name>, where name is the name of your Gateway connection.
For example, epgw vnc ios.

• Eggplant Gateway will start:
  • A VNC server at port 5900
  • A WebDriver server at port 5000

Known Issues

• Currently we do support a limited set of VNC extensions. To have a full overview please refer to the Supported SenseTalk Commands.

• On rare occasions tiny lines may appear on the screen or the SUT window may blink.

Connecting to Eggplant Functional

Start Eggplant Functional and manually add your device to the connection list.