appium-xcuitest-driver

appium-xcuitest-driver

This is an Appium driver for automating iOS applications on iOS, iPadOS, and tvOS.

[!IMPORTANT] Only macOS is supported as the host platform, as it requires Xcode and developer tools.

[!IMPORTANT] Since major version 10.0.0, this driver is only compatible with Appium 3. Use the appium driver install xcuitest command to add it to your distribution.

Documentation

The Documentation is hosted separately at https://appium.github.io/appium-xcuitest-driver

Contributing & Development

Clone this project from GitHub and run:

npm install

To watch changes during the development:

npm run watch

To run unit/functional tests:

npm test # unit
npm run e2e-test # functional

There are also a number of environment variables that can be used when running the tests locally. These include:

• REAL_DEVICE - set to anything truthy, makes the tests use real device capabilities
• _FORCE_LOGS - set to 1 to get the log output, not just spec
• PLATFORM_VERSION - change the version to run the tests against (defaults to 9.3)
• XCCONFIG_FILE - specify where the xcode config file is for a real device run (if blank, and running a real device test, it will search for the first file in the root directory of the repo with the extension "xcconfig")
• UICATALOG_REAL_DEVICE - path to the real device build of UICatalog, in case the npm installed one is not built for real device

Similar packages

Other packages similar to appium-xcuitest-driver

webdriverio

WebdriverIO is a popular testing utility for web and mobile applications. It provides a high-level API to interact with browsers and mobile devices. While it can be used with Appium to automate iOS applications, it is more general-purpose compared to appium-xcuitest-driver, which is specifically designed for iOS automation.

detox

Detox is an end-to-end testing library for mobile applications. It is designed to test React Native apps but can also be used for native iOS and Android apps. Detox provides a different approach to mobile testing by focusing on synchronization and stability, whereas appium-xcuitest-driver leverages the XCUITest framework for iOS automation.

calabash-ios

Calabash-iOS is a framework for automated acceptance testing of iOS apps. It allows you to write tests in Cucumber and execute them on iOS devices. Calabash-iOS provides a different testing approach compared to appium-xcuitest-driver, which uses the XCUITest framework and integrates with Appium for broader automation capabilities.