appium-xcuitest-driver

What is appium-xcuitest-driver?

The appium-xcuitest-driver is a driver for Appium that allows you to automate iOS applications using the XCUITest framework. It is used for running tests on iOS devices and simulators, providing a robust and flexible way to interact with iOS applications programmatically.

What are appium-xcuitest-driver's main functionalities?

Launching an iOS application

This code sample demonstrates how to launch an iOS application using the appium-xcuitest-driver. It sets up the WebDriverIO client with the necessary capabilities and then launches the app.

const wdio = require('webdriverio');
const opts = {
  port: 4723,
  capabilities: {
    platformName: 'iOS',
    platformVersion: '14.4',
    deviceName: 'iPhone 12',
    app: '/path/to/your.app',
    automationName: 'XCUITest'
  }
};
const client = await wdio.remote(opts);
await client.init();
await client.launchApp();

Finding and interacting with elements

This code sample shows how to find an element by its accessibility ID and perform a click action on it. The appium-xcuitest-driver allows you to interact with various UI elements in the iOS application.

const element = await client.$('~elementId');
await element.click();

Taking a screenshot

This code sample demonstrates how to take a screenshot of the current screen in the iOS application. The screenshot is saved to the specified path.

const screenshot = await client.saveScreenshot('/path/to/screenshot.png');

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.

README

appium-xcuitest-driver

This is an Appium driver for automating iOS applications on iOS, iPadOS, and tvOS. You can add it to your Appium 2+ server install: (Only macOS is supported as the host platform, as it requires Xcode and developer tools.)

appium driver install xcuitest

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

Changelog

8.3.1 (2025-02-06)

Miscellaneous Chores

• bump wda version to 9.0.3 (b645987)