iOS device access #

This article will introduce the preparations for connecting iOS devices to Sonic.

Access common configuration #

1. Connect the device to the computer via USB
2. Click【Trust】Computer
3. Build WebDriverAgent into the device (required for the first connection, please refer to the construction tutorial below)
4. Settings related to webpage debugging: Settings → Safari → Advanced → Open [Webpage Inspector]
5. Turn off the phone lock screen password: Settings → Face ID and password → turn off the password (if it is not turned off, the sonic may always display the connection and the phone is blocked on the password input page when using it remotely)

iOS16 special configuration #

iOS16 needs to manually enable the developer options.

1. Open Settings and enter [Privacy and Security].
2. Click [Developer Mode].
3. If a pop-up prompting to restart appears, click Restart.
4. If you are asked whether to enable the developer mode after startup, click Open.

Support of iOS17 and above #

Currently, Sonic is not compatible with iOS17 and above devices on Windows and Linux platforms, so iOS17 and above machines must be connected to the Agent deployed on MacOS.

1. Agent needs to install iproxy and ideviceinstaller

brew install usbmuxd
brew install ideviceinstaller

2. In Agent's config/application-sonic-agent.yml, configure wda-xcode-project-path to the WebDriverAgent.xcodeproj path

After completion, confirm that WebDriverAgent can be built to the device for testing:

# replace ${wda-xcode-project-path} to your xcodeproj path, replace ${device_udId} to your device udId

xcodebuild -project ${wda-xcode-project-path} -scheme WebDriverAgentRunner -destination 'id=${device_udId}' test

Preparations are complete.

Build WebDriverAgent into the device #

Build wda to your iOS device.

Preparations: Mac, Xcode, developer account.

1. Pull the WebDriverAgent project of Sonic. (This project is same as appium/WebDriverAgent.)

git clone https://github.com/SonicCloudOrg/sonic-ios-wda.git

2. Change the Signing Team in WebDriverAgentLib and WebDriverAgentRunner to your own developer account.

3. Modify Product Bundle Identifier in Build Settings in WebDriverAgentRunner For your own custom package name (preferably keep the end of WebDriverAgentRunner)

4. Select WebDriverAgentRunner as the build target for Scheme, and select the target device on the right. Then select Product -> Build to build. if you want to test Whether WebDriverAgent can run normally, you can also select Product -> Test to view the operation log.

5. Build complete! You can configure the corresponding custom BundleId in the yml file in the config folder on the Agent side.

Build the ipa file #

If you only want to build it once and then package it into wda.ipa to share with other devices, you can refer to this method.

The phone udId must be under the developer account.

$ xcodebuild build-for-testing -scheme WebDriverAgentRunner -sdk iphoneos -configuration Release -derivedDataPath /tmp/derivedDataPath
$ cd /tmp/derivedDataPath
$ cd Build/Products/Release-iphoneos
$ mkdir Payload && mv *.app Payload
$ zip -r WDA.ipa Payload
$ sib app install -p WDA.ipa

Frequently Asked Questions (Q&A) #

Q1: Failed to start after packaging wda.

A1: Please check whether the bundleId configured in yml is consistent, whether the device trusts the certificate, and whether the device trusts the computer.

Q2: No screen appears after use, but the key operation is normal.

A1: The solution can refer to this post.