Appium Android Driver

Appium Android Driver is a test automation tool for Android devices. Appium Android Driver automates native, hybrid and mobile web apps, tested on simulators, emulators and real devices. Appium Android Driver is part of the Appium mobile test automation tool.

Note: Issue tracking for this repo has been disabled. Please use the main Appium issue tracker instead.

Installation

npm install appium-android-driver

Usage

Import Android Driver, set desired capabilities and create a session:

import { AndroidDriver } from `appium-android-driver`

let defaultCaps = {
  app: 'path/to/your.apk',
  deviceName: 'Android',
  platformName: 'Android'
};

let driver = new AndroidDriver();
await driver.createSession(defaultCaps);

Run commands:

await driver.setOrientation('LANDSCAPE');
console.log(await driver.getOrientation()); // -> 'LANDSCAPE'

Specifying and selecting devices/emulators

The driver will attempt to connect to a device/emulator based on these properties in the desiredCapabilities object:

1. avd: Launch or connect to the emulator with the given name.
2. udid: Connect to the device with the given UDID.
3. platformVersion: Connect to the first device or active emulator whose OS begins with the desired OS. This means platformVersion: 5 will take the first 5x device from the output of adb devices if there are multiple available.

If none of these capabilities are given, the driver will connect to the first device or active emulator returned from the output of adb devices.

If more than one of these capabilities are given, the driver will only use first the capability in the order above. That is, avd takes priority over udid, which takes priority over platformVersion.

Commands

| Command | |----------------------------| | activateIMEEngine | | availableIMEEngines | | back | | background | | clear | | click | | complexTap | | deactivateIMEEngine | | defaultContextName | | defaultWebviewName | | doKey | | doTouchAction | | doTouchDrag | | drag | | elementDisplayed | | elementEnabled | | elementSelected | | fakeFlick | | fakeFlickElement | | findElOrEls | | fixRelease | | flick | | getActiveIMEEngine | | getAlertText | | getAttribute | | getContexts | | getCurrentActivity | | getCurrentContext | | getDeviceTime | | getDisplayDensity | | getLocationInView | | getLog | | getLogTypes | | getName | | getNetworkConnection | | getOrientation | | getPageSource | | getScreenshot | | getSize | | getStrings | | getSystemBars | | getText | | getWindowSize | | hideKeyboard | | installApp | | isAppInstalled | | isIMEActivated | | isKeyboardShown | | isLocked | | isWebContext | | keyevent | | keys | | lock | | longPressKeyCode | | onChromedriverStop | | openNotifications | | openSettingsActivity | | parseTouch | | performGesture | | performMultiAction | | performTouch | | pinchClose | | pinchOpen | | postAcceptAlert | | postDismissAlert | | pressKeyCode | | pullFile | | pullFolder | | pushFile | | removeApp | | replaceValue | | reset | | setAlertText | | setContext | | setGeoLocation | | setLocation | | setNetworkConnection | | setOrientation | | setValue | | setUrl | | startActivity | | startChromedriverProxy | | stopChromedriverProxies | | suspendChromedriverProxy | | swipe | | tap | | toggleData | | toggleFlightMode | | toggleLocationServices | | toggleSetting | | toggleWiFi | | touchDown | | touchLongClick | | touchMove | | touchUp | | unlock | | unlockWithHelperApp | | unlockWithUIAutomation | | wrapBootstrapDisconnect | | fingerprint | | sendSMS | | gsmCall | | gsmSignal | | gsmVoice | | powerAC | | powerCapacity | | networkSpeed |

API Notes

lock behaves differently in Android than it does in iOS. In Android it does not take any arguments, and locks the screen and returns immediately.

Development

Transpile ES2015 code

gulp transpile

Watch

npm run watch

Test

npm test

Some tests need particular emulators. Currently they are twofold:

1. API level 25: either set ANDROID_25_AVD environment variable to the name of avd, or defaults to "Nexus_5_API_25". If neither exist, the tests are skipped.
2. API level 24: either set ANDROID_24_NO_GMS_AVD environment variable to the name of avd, or defaults to "Nexus_5_API_24". If neither exist, the tests are skipped.

Some tests also also need a specific version of Chromedriver (specifically, 2.20), which is available in the test/assets folder, or can be specified with the CHROME_2_20_EXECUTABLE environment variable.