Skip to content

Maestro with iOS Real Device Support

Latest

Choose a tag to compare

@github-actions github-actions released this 11 Nov 14:59
· 6 commits to main since this release

iOS Real Device Testing Support

This release adds support for running Maestro tests on physical iOS devices using the --driver-host-port flag.

What's New

  • ✨ Support for physical iOS devices (not just simulators)
  • 🔧 --driver-host-port option to connect to external XCTest servers
  • 🚀 No Apple Team ID required when using custom driver port
  • 📱 Works with port forwarding for real device communication

Installation

# Download and extract the JARs
curl -L https://github.com/omnarayan/Maestro/releases/download/$TAG/maestro-jars.tar.gz -o maestro-jars.tar.gz
tar -xzf maestro-jars.tar.gz

# Copy to your Maestro installation
cp maestro-*.jar ~/.maestro/lib/

# Download and extract the iOS XCTest runner source code
curl -L https://github.com/omnarayan/Maestro/releases/download/$TAG/maestro-ios-xctest-runner-source.tar.gz -o maestro-ios-xctest-runner-source.tar.gz
tar -xzf maestro-ios-xctest-runner-source.tar.gz

Building XCTest Runner for Your Device

# Navigate to the extracted source directory
cd maestro-ios-xctest-runner

# Build for your real device (replace with your Team ID and device UDID)
DESTINATION="platform=iOS,id=<device-udid>" \
DERIVED_DATA_PATH="driver-iphoneos" \
DEVELOPMENT_TEAM=<your-team-id> \
bash build-maestro-ios-runner.sh

Usage

# Start the XCTest server on your physical device
cd maestro-ios-xctest-runner/driver-iphoneos/Build/Products
xcodebuild test-without-building \
  -xctestrun maestro-driver-ios_*.xctestrun \
  -destination "platform=iOS,id=<device-udid>"

# In another terminal, set up port forwarding (port 22087 to 7005)
# Use iproxy or pymobiledevice3 for port forwarding

# Run tests with custom driver port
maestro --driver-host-port 7005 --platform ios --udid <device-udid> test flow.yaml

Credits


Note: This is an experimental build for iOS real device testing.