Android CI Testing Example with Selectel Mobile Farm

This project provides an example setup for running automated Android tests using Selectel Mobile Farm, integrated with CI/CD pipelines such as GitHub Actions or GitLab CI. This setup allows you to run tests on real Android devices in the cloud using Espresso framework.

CI/CD Configuration Files

CI/CD Configuration Files include steps to set up the Android SDK, obtain authentication tokens, and connect to a remote device in Selectel Mobile Farm.

This repository includes the following CI configuration files:

GitHub Actions

ci.yml: This file is designed to run Android tests using GitHub Actions.

GitLab CI (Optional)

.gitlab-ci.yml: If you are using GitLab CI instead of GitHub Actions, you can use this file.

Key Considerations

Environment variables

Ensure you have properly set up all of the tokens used inside CI/CD file. These include your service user's USER_NAME and PASSWORD, PROJECT_NAME, ACCOUNT_NAME, DEVICE_SERIAL.

Selectel Authorization Tokens:

• Mobile Farm supports only Selectel Keystone authorization tokens.
• Provided tokens are valid for one day. Be careful when exposing tokens inside pipeline.
• You can always refer to the docs about Selectel authorization if you having any troubles obtaining the X-Auth-Token.

ADB keys

To successfully use ADB for remote device connections, you must meet the following requirements:

1. Default Key Pair Location: Ensure the ADB key pair is stored in the default location. For example on Ubuntu:
   • ~/.android/adbkey - default private key location,
   • ~/.android/adbkey.pub - default public key location.
2. Store Public Key in Mobile Farm: The ADB public key must be uploaded and stored in the Mobile Farm system. Refer to the Swagger documentation for details required for storing the key.
3. Unique Public Key: Each ADB public key must be unique within the Mobile Farm. Attempting to upload a duplicate key will result in errors.
4. Device Assignment: The device must be assigned to the user initiating the connection within the Mobile Farm. Refer to the Swagger documentation for details required for assigning a device to user.
5. Remote connection: The device must have it's ADB remote connection session to be started. Refer to the Swagger documentation for details required for starting remote connect session.

Device Screen State:

Ensure that the device screen is not locked before running the tests. Ensure that no other activities or pop-ups are blocking the device screen during testing, as this might interfere with the tests.

Espresso Testing:

• Espresso tests do not support the execution of tests in the middle of a user's journey.
• Ensure your tests follow a clear sequence without interruption.

Device Assignment:

When assigning devices, make sure you are using the correct device serial number (provided as an environment variable DEVICE_SERIAL) which is present inside the project you specify by an environment variable PROJECT_NAME.

Remote Device Considerations:

Since the device is hosted remotely, there may be a slight delay when communicating with the device, especially if the CI runner is geographically distant from the device. During ADB operations, such as adb connect and adb devices, it may take extra time for the command to reach the device and receive a response. This is normal, and you may want to adjust the timeouts in your CI pipeline if you notice delays in the connection or device readiness. Ensure that your CI pipeline has sufficient wait times (e.g., sleep 1) between device commands to avoid timing issues related to latency.

Pipeline customization

You can modify CI/CD configuration file by your needs. For example:

• Use multiple devices.
• Store ADB keys inside the repository so you won't have to generate them every time during pipeline execution.
• Add devices to a farm during pipeline execution.
• For more information checkout our Swagger documentation.