/appium-xcuitest-driver

Appium iOS driver, backed by Apple XCUITest

Primary LanguageJavaScriptApache License 2.0Apache-2.0

appium-xcuitest-driver

NPM version Downloads

Release

This is an Appium driver for automating iOS applications on iOS, iPadOS, and tvOS. You can add it to your Appium 2+ server install:

appium driver install xcuitest

Documentation

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

Contributing & Development

To install the project check it out from GitHub and run:

npm install

To watch changes during the development:

npm run watch

To run unit/functional tests:

npm test
npm e2e-test

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