axe-appium3-webdriveragent

Package bundling WebDriverAgent with axeDevToolsMobile.

This is Deque's fork of appium/WebDriverAgent, modified to add axe accessibility scanning. It bundles the axe DevTools XCUI framework, which requires a valid axe DevTools Mobile licence; see the LICENSE file included in this package.

WebDriverAgent is a WebDriver server implementation for iOS that can be used to remote control iOS devices. It allows you to launch & kill applications, tap & scroll views or confirm view presence on a screen. This makes it a perfect tool for application end-to-end testing or general purpose device automation. It works by linking XCTest.framework and calling Apple's API to execute commands directly on a device. WebDriverAgent is developed for end-to-end testing and is successfully adopted by Appium via XCUITest driver.

Features

• Both iOS and tvOS platforms are supported with devices & simulators
• Implements most of WebDriver Spec
• Implements part of Mobile JSON Wire Protocol Spec
• USB support for devices is implemented via appium-ios-device library and has zero dependencies on third-party tools.
• Easy development cycle as it can be launched & debugged directly via Xcode
• Use Mac2Driver to automate macOS apps

Getting Started On This Repository

You need to have Node.js installed for this project.

After it is finished you can simply open WebDriverAgent.xcodeproj and start WebDriverAgentRunner test and start sending requests.

More about how to start WebDriverAgent here.

Multiple displays

See Multiple displays for display selection, capture, and active-app detection.

See Hinge angle for reading angles, sending simulated hinge events, runtime requirements, and physical-device testing feedback.

Known Issues

If you are having some issues please checkout wiki first.

For Contributors

If you want to help us out, you are more than welcome to. However please make sure you have followed the guidelines in CONTRIBUTING.

Creating Bundles

pnpm run bundle

Then, you find WebDriverAgentRunner-Runner-sim-<version>.zip for iOS and WebDriverAgentRunner-Runner-tv_sim-<version>.zip for tvOS files in the current directory.

License

See the LICENSE file included in this package. The WebDriverAgent sources are BSD-licensed; the bundled axe DevTools XCUI framework is proprietary and requires a valid axe DevTools Mobile licence. Licences for third-party dependencies are listed in LICENSE-3RD-PARTY.md.

Have fun!

Supported Node version

this repo is regularly synced with public repo because of which the supported node versions are ^20.19.0 || ^22.12.0 || >=24.0.0. Restricting the node version to just >=24.0.0 may break functionality for the end users.