Awesome

Appium

Appium is an open source, cross-platform test automation tool for native, hybrid and mobile web and desktop apps, tested on simulators (iOS), emulators (Android), and real devices (iOS, Android, Windows, Mac).

Supported Platforms

• iOS
• Android
• Windows
• Mac

See the platform support doc for more detailed information.

Why Appium?

1. You don't have to recompile your app or modify it in any way, due to use of standard automation APIs on all platforms.
2. You can write tests with your favorite dev tools using any WebDriver-compatible language such as Java, Objective-C, JavaScript with Node.js (in promise, callback or generator flavors), PHP, Python, Ruby, C#, Clojure, or Perl with the Selenium WebDriver API and language-specific client libraries.
3. You can use any testing framework.

Investing in the WebDriver protocol means you are betting on a single, free and open protocol for testing that has become a defacto standard. Don't lock yourself into a proprietary stack.

If you use Apple's UIAutomation library without Appium you can only write tests using JavaScript and you can only run tests through the Instruments application. Similarly, with Google's UiAutomator you can only write tests in Java. Appium opens up the possibility of true cross-platform native mobile automation. Finally!

I don't get it yet...

If you're new to Appium, or want a fuller description of what this is all about, please read our Introduction to Appium Concepts.

Requirements

Your environment needs to be setup for the particular mobile platforms that you want to run tests on. See below for particular platform requirements.

If you want to run Appium via an npm install, hack with or contribute to Appium, you will need node.js and npm 4 or greater (use n or brew install node to install Node.js. Make sure you have not installed Node or Appium with sudo, otherwise you'll run into problems). We recommend the latest stable version.

To verify that all of Appium's dependencies are met you can use appium-doctor. Install it with npm install -g appium-doctor (or run it from source), then run appium-doctor and supply the --ios or --android flags to verify that all of the dependencies are set up correctly.

You also need to download the Appium client for your language so you can write tests. The Appium clients are simple extensions to the WebDriver clients. You can see the list of clients and links to download instructions at the Appium clients list.

iOS Requirements

• Mac OS X 10.10 or higher, 10.11.1 recommended
• XCode >= 6.0, 7.1.1 recommended
• Apple Developer Tools (iPhone simulator SDK, command line tools)
• Ensure you read our documentation on setting yourself up for iOS testing!

Android Requirements

• Android SDK API >= 17 (Additional features require 18/19)
• Appium supports Android on OS X, Linux and Windows. Make sure you follow the directions for setting up your environment properly for testing on different OSes:
  • linux
  • osx
  • windows

Windows Requirements

• Windows 10
• Documentation

Mac Requirements

• Mac OS X 10.7 +
• Documentation

Quick Start

Kick up an Appium server, and then run a test written in your favorite WebDriver-compatible language! You can run an Appium server using node.js or using the application, see below.

Using Node.js

$ npm install -g appium
$ appium

As we said above, you may want to run appium-doctor to ensure your system is set up properly:

$ npm install -g appium-doctor
$ appium-doctor

Using the Appium Desktop App

• Download the Appium app
• Run it!

Writing Tests for Appium

The main guide for getting started writing and running tests is the running tests doc, which includes explanations for iOS, Android, and Android older devices. If you're interested in testing on physical hardware, you might be interested in our real devices guide.

(Note: If you're automating iOS 10+, be sure to check out our XCUITest Migration Guide since Apple's automation support has changed significantly since iOS 10, with corresponding changes in Appium).

Essentially, we support a subset of the Selenium WebDriver JSON Wire Protocol, and extend it so that you can specify mobile-targeted desired capabilities to run your test through Appium.

You find elements by using a subset of WebDriver's element-finding strategies. See finding elements for detailed information. We also have several extensions to the JSON Wire Protocol for automating mobile gestures like tap, flick, and swipe.

You can also automate web views in hybrid apps! See the hybrid app guide

This repository contains many examples of tests in a variety of different languages!

For the full list of Appium doc pages, visit this directory.

How It Works

Appium drives various native automation frameworks and provides an API based on Selenium's WebDriver JSON wire protocol.

For new iOS versions (9.3 and up), Appium drives Apple's XCUITest library. Our support for XCUITest utilizes Facebook's WebDriverAgent project.

For older iOS versions (9.3 and below), Appium drives Apple's UIAutomation library, using a strategy which is based on Dan Cuellar's work on iOS Auto.

Android support uses the UiAutomator framework for newer platforms and Selendroid for older Android platforms.

Windows support uses Microsoft's WinAppDriver

Contributing

Please take a look at our contribution documentation for instructions on how to build, test and run Appium from source.

Roadmap

Interested in where Appium is heading in the future? Check out the Roadmap

Project History, Credits & Inspiration

• History
• Credits

User Forums

Announcements and debates often take place on the Discussion Group, be sure to sign up!

Troubleshooting

We put together a troubleshooting guide. Please have a look here first if you run into any problems. It contains instructions for checking a lot of common errors and how to get in touch with the community if you're stumped.

Using Robots

Using Appium with Tapster and other robots is possible, check out the Appium Robots project!

License