How devicelab-dev/maestro-runner works
maestro-runner executes existing Maestro YAML UI flows against mobile devices, simulators, browsers, or Appium-backed cloud sessions. The principal path is CLI invocation, flow validation and parsing, step execution, platform-driver commands, then test reports. Distinct branches cover device/emulator management, platform automation, Flutter/React Native support, JavaScript scripting, parallel runs, and cloud providers. Relationships among sampled modules follow the source index and excerpts; broader capability links are supported by the README, while unsampled implementation details are not inferred.
Main entry points: cli CLI commands · android.go Android CLI · ios.go iOS CLI · flow_runner.go Flow executor
Components 24
Invocation and flows
- CLI commands
pkg/cli - npm launcher
npm/maestro-runner/lib/resolve.js - Flow validator
pkg/validator/validator.go - Flow parser
pkg/flow/parser.go
Execution services
- Flow executor
pkg/executor/flow_runner.go - Parallel runner
pkg/executor/runner.go - Flow scripting
pkg/executor/scripting.go - JavaScript engine
pkg/jsengine/engine.go - Flutter support
pkg/flutter/wrapper.go
Platform automation
- Android CLI
pkg/cli/android.go - iOS CLI
pkg/cli/ios.go - DeviceLab driver
pkg/device/devicelab_driver.go - UIAutomator2 driver
pkg/uiautomator2/client.go - WDA driver
pkg/driver/wda/client.go - DeviceLab iOS
pkg/driver/devicelab_ios/client.go - Legacy iOS agent
pkg/driver/devicelab_ios_legacy/client.go - Appium driver
pkg/driver/appium/client.go
Device and cloud
- Device management
pkg/device - Android emulators
pkg/emulator/manager.go - iOS simulators
pkg/simulator/manager.go - Cloud sessions
pkg/cloud
Run results
- Report generation
pkg/report - Live report index
pkg/report/index.go
Other components
- Test author
Connections 27
- Test author → CLI commands: runs flows
- Test author → npm launcher: launches via npm
- npm launcher → CLI commands: resolves binary
npm/maestro-runner/lib/resolve.js - CLI commands → Flow validator: preflight checks
- CLI commands → Flow parser: loads flow
- Flow parser → Flow executor: provides steps
- Flow executor → Flow scripting: dispatches scripts
pkg/executor/flow_runner.go - Flow scripting → JavaScript engine: evaluates JavaScript
pkg/executor/scripting.go - Flow executor → Report generation: records results
pkg/executor/flow_runner.go - Flow executor → DeviceLab driver: executes commands
- Flow executor → Appium driver: executes commands
- CLI commands → Android CLI: selects platform
- CLI commands → iOS CLI: selects platform
- Android CLI → DeviceLab driver: uses default driver
- Android CLI → UIAutomator2 driver: selects driver
- iOS CLI → WDA driver: selects driver
- iOS CLI → DeviceLab iOS: uses default driver
- iOS CLI → Legacy iOS agent: selects legacy driver
- iOS CLI → iOS simulators: manages simulators
- Android CLI → Android emulators: manages emulators
- Android CLI → Device management: discovers devices
pkg/cli/android.go - iOS CLI → Flutter support: supports Flutter
- Android CLI → Flutter support: supports Flutter
- CLI commands → Parallel runner: runs in parallel
- CLI commands → Cloud sessions: configures cloud
- Cloud sessions → Appium driver: uses Appium
- Report generation → Live report index: updates index
pkg/report/index.go