appium-uiautomator2-server/README.md

A netty server with uiautomator2 handlers

# appium-uiautomator2-server

[![NPM version](http://img.shields.io/npm/v/appium-uiautomator2-server.svg)](https://npmjs.org/package/appium-uiautomator2-server)
[![Downloads](http://img.shields.io/npm/dm/appium-uiautomator2-server.svg)](https://npmjs.org/package/appium-uiautomator2-server)

A netty server that runs on the device listening for commands and executes using UiAutomator V2.

## building project

build the android project using below commands

`./gradlew clean assembleServerDebug assembleServerDebugAndroidTest`

You can also build with specific version name and version code using this command.
`./gradlew -PversionName=8.0.0 -PversionCode=300 clean assembleServerDebug assembleServerDebugAndroidTest`

## Starting server

push both src and test apks to the device and execute the instrumentation tests.

`adb shell am instrument -w io.appium.uiautomator2.server.test/androidx.test.runner.AndroidJUnitRunner`

## run unitTest

build the unitTest flavor using the below commands

`./gradlew clean assembleE2ETestDebug assembleE2ETestDebugAndroidTest`

unitTest flavor contains tests for handlers and can be invoked by using following command

`./gradlew clean connectedE2ETestDebugAndroidTest`

the above command takes care about installing the AUT apk in to the testing device/emulator before running the tests.

you can also invoke the test using below command

`adb shell am instrument -w io.appium.uiautomator2.e2etest.test/androidx.test.runner.AndroidJUnitRunner`

Note: AUT apk should be installed before executing above command.

## Development tests

Server JVM unit tests (including XPath 2.0 selector coverage) and the vendored PsychoPath processor suite:

```bash
npm run test                  # rebuilds vendor JAR, runs app unit tests
npm run test:vendor-xpath2    # runs upstream XPath2 processor tests
```

The XPath 2.0 engine is vendored from Eclipse WTP; see [`vendor/README.md`](vendor/README.md) for build details, local patches, and troubleshooting.

## Other Sections

* [WIKI](https://github.com/appium/appium-uiautomator2-server/wiki)
* [Version Release](https://github.com/appium/appium-uiautomator2-server/blob/master/doc/release.md)
* [Vendored dependencies](vendor/README.md)