appium-android-driver

What is appium-android-driver?

The appium-android-driver npm package is a driver for Appium that allows you to automate Android applications. It provides a set of tools and APIs to interact with Android devices and emulators, enabling you to perform various actions such as launching apps, interacting with UI elements, and running automated tests.

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

Launching an Android App

This feature allows you to launch an Android application on a specified device or emulator. The code sample demonstrates how to create a session and launch an app using the appium-android-driver.

const { AndroidDriver } = require('appium-android-driver');
const driver = new AndroidDriver();
await driver.createSession({
  platformName: 'Android',
  deviceName: 'emulator-5554',
  app: '/path/to/your/app.apk'
});

Interacting with UI Elements

This feature allows you to interact with UI elements within the Android application. The code sample shows how to find an element by its ID and perform a click action on it.

const { AndroidDriver } = require('appium-android-driver');
const driver = new AndroidDriver();
await driver.createSession({
  platformName: 'Android',
  deviceName: 'emulator-5554',
  app: '/path/to/your/app.apk'
});
await driver.elementById('elementId').click();

Running Automated Tests

This feature allows you to run automated tests on your Android application. The code sample demonstrates how to create a session, interact with UI elements, and retrieve text from an element for validation.

const { AndroidDriver } = require('appium-android-driver');
const driver = new AndroidDriver();
await driver.createSession({
  platformName: 'Android',
  deviceName: 'emulator-5554',
  app: '/path/to/your/app.apk'
});
await driver.elementById('elementId').click();
const text = await driver.elementById('textElementId').getText();
console.log(text);

Other packages similar to appium-android-driver

webdriverio

WebdriverIO is a popular automation framework that supports multiple platforms, including Android. It provides a rich set of APIs for interacting with web and mobile applications. Compared to appium-android-driver, WebdriverIO offers a more comprehensive solution for cross-platform automation.

detox

Detox is an end-to-end testing library for mobile applications, specifically designed for React Native apps. It provides tools for automating interactions with Android and iOS applications. While appium-android-driver focuses on general Android automation, Detox is tailored for React Native, offering a more specialized solution.

README

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.

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'

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
getLocationInView
getLog
getLogTypes
getName
getNetworkConnection
getOrientation
getPageSource
getScreenshot
getSize
getStrings
getText
getWindowSize
hideKeyboard
installApp
isAppInstalled
isIMEActivated
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
wrapBootstrapDisconnect

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.

Watch

npm run watch

Test

npm test