How to Connect Physical Devices to Bitrise.io
Why physical devices? Isn’t an emulator enough?
Android SDK provides an emulator which can also be started in headless mode in a CI environment. However, this is a theory as, in practice, there is a major issue which makes emulating very inconvenient.
On a machine without KVM (Linux) or HAXM (macOS, Windows), the Android emulator is very slow. How slow? You can check out the details in this thread on the bitrise discussion forum. That’s because virtual machines, provided by Google Compute Engine and used by bitrise.io, do not support hardware acceleration. This limitation is applicable to more than just bitrise.
Another advantage of real devices is that they support a bunch of features not available on the emulator. For example WiFi, Bluetooth, NFC or USB. See all the limitations in emulator documentation. Finally, real devices contain device or vendor-specific stuff, such as preinstalled system apps and specific behaviors, which do not need to occur on emulators.
Clouds over the farm
There are several options for connecting devices to bitrise.io. One of the easiest and effortless ones is to use a cloud-hosted device farm. Such farms are offered by Google (Firebase Test Lab), Amazon (AWS Device Farm) or Bitbar (public cloud). However, it may not necessarily be the cheapest solution, especially if you already have physical devices. Let’s check how they can be used on bitrise.io!
Local device on a remote host
Android Debug Bridge (ADB) allows you to run the client and server on different machines. The server will be the one running on the machine which your devices are connected to, while the client needs to be started on a CI machine. If you use ADB with
-H <server hostname or IP> on the client side, it will just use devices connected to a server instead of its local ones.
As easy as pie! Well, not really. There are several inconveniences that need to be considered. Firstly, this method is not supported by the Android Gradle Plugin. This forces you to use the ADB commandline manually with the additional parameter. Moreover, device serial numbers need to be known in advance, somehow. If you have many devices with different characteristics – such as manufacturer, OS version, screen size, whether it is a smartphone, phablet, tablet or something else etc – you also need to know which one will have which serial. Finally, these devices won’t be cleaned up/restored to their original state before usage.
STF to the rescue!
Thankfully, there is a tool called Open STF which can solve the aforementioned issues. STF is an acronym for Smartphone Test Farm. Its core feature is interactive remote control of devices from the web browser. However, it also has a REST API and supports remote debugging.
Putting all that stuff together
Several things will be needed to connect physical devices to bitrise.io. The first and most obvious part is a device. Most modern (supporting API level 14+) models should work. However, there are known issues with certain models (e.g. ZTE Max Pro 981). Some others, like various Xiaomi smartphones, require additional steps to be performed before connection. USB debugging also has to be enabled in the device development settings.
The most important part is a properly configured STF instance. For testing and evaluation purposes with up to several devices you can deploy STF on a single machine, even on your laptop. Just install required dependencies and run a local instance. However, if you want to use dozens or hundreds of devices, you will need to split a farm between many machines. See deployment documentation and setup examples for more information. Make sure that the
--public-ip parameter is specified, as STF won’t be accessible from different hosts otherwise.
If you can control your device(s) on a farm using a web browser, then it’s time to setup access. Go to the settings panel and generate an access token, as you can see in the picture below. On the right, you can also add ADB keys, so generate one pair using
adb keygen if you don’t have it yet.
There has to be a reliable internet connection between bitrise.io and your farm. You can just expose a farm on a public IP: however, it is not much secure option, especially when default, mock authorization is used. Some kind of VPN may be used for secure connections. There is a ready-to-use step for Cisco VPN. For other VPN types, you need to perform a connection setup yourself, probably using script step; see the tutorial on bitrise devcenter for more info.
Finally, you can add a Open STF Connect step to your workflow. The recommended step order is as follows:
- Compile Android tests, usually using Gradle Runner step with
- Connect to a VPN (if needed)
- Connect to the STF
- Perform the tests, usually using Gradle Unit test step with
- Disconnect from the STF
With this setup, devices are occupied only for the minimum required period of time, not for the entire build time. It is important that the disconnection steps have the
Run if previous Step failed option enabled, so the devices will be always returned to the pool, even if the tests fail. Otherwise, they will be occupied until they exceed their inactivity timeout periods (15 minutes by default).
Bitrise workflow example
Here is the complete example of the workflow using STF in workflow editor:
And as a
Note that the Open STF Connect step exposes 2 additional parameters:
device_number_limit, allowing you to use only a subset of connected devices.
Connecting bitrise.io with Open STF is pretty much easy. On Bitrise, you just need to add ready-to-use steps and configure them. Setting up a device farm requires some amount of work but, properly configured, it doesn’t need much maintenance (devices are restored to the previous state after usage). Note that the same devices on STF can also be used by QA or developers. Unless you need physical interaction (e.g. detected by accelerometer or gyroscope) they can be connected to the farm all the time.