Opium builds on top of Appium and facilitates remote test execution and device interaction across local networks. Opium has 2 components:
- this project, also called the Opium Hive: allows remote device registration using Opium Agents and exposes a simple REST api to see the available devices
- Opium Agents which register mobile devices and sends the relevant connection information to the Hive
mvn clean package
java -jar opium.jar
The project starts by default on port 2020
APIs exposed are available under http://localhost:2020/swagger-ui.html
The most important APIs
GET /devicewhich lists all the available devices registered at a certain momentPOST /executeused to send the command to start AppiumDELETE /executeused to stop Appium Once Appium is started you can interact directly with the Appium server using the IP received in the/deviceresponse and using the port sent when Appium started.
A typical use case will look as follows:
- call
GET /device - pick an appropiate device based on Android version, device type, etc
- do a
POST /executeand start the Appium server for that device by sending the Appium start paramters(like-p 9999for example), device hash and host IP address - once Appium started, interact execute the tests against the Appium instance
- when tests are finished, stop the Appium instance using
DELETE /executeby sending the running port(9999above for example), device hash and IP address of the host
The Hive uses in memory persistence. Even if the Hive fails and needs restart, all agents will re-register within 10 seconds.
The Hive continuosly monitors agents availability and will remove any unavailable device within 5 seconds of unavailability.
Opium only works with Android devices.
Opium needs Opium Agents deployed on the computers were the Android devices will be connected. Furthermore, Appium needs to be installed in order to further run the automated tests.
Tested on Windows, Ubuntu and OS X.