The following article is a reproduction of Run your mobile automated tests on Genymotion Cloud Android Virtual Devices with CircleCI authored and autorized by Ellinor Kwok.
Efficiently testing mobile apps at every stage of the application lifecycle is challenging, even more with Android fragmented market. Many companies are adopting tools to help them create, automate and orchestrate tests on mobile devices. Among them are continuous integration and deployment (CI/CD) tools. Having a CI tool isn’t enough, we also need devices to run tests on. By partnering with CircleCI, we help providing the full continuous integration workflow.
Genymotion SaaS (Cloud) provides Android virtual devices on the Cloud with various configurations and Android versions. CircleCI is a cloud continuous integration server to help teams get faster builds, shorter feedback lifecycles and simplified pipeline maintenance.
The integration of Genymotion SaaS is now available on CircleCI as an Orb, so QA engineers can now easily integrate Genymotion SaaS in their test cases on CircleCI and reuse jobs, commands and executors to run their test on chosen devices.
In this article, we are going to cover Espresso written tests but you can also use any other testing framework.
To run tests in parallel with CircleCI i.e running your tests on several devices at the same time, you also need to have a CircleCI plan that supports more than one job at a time.
1. Create your test workflow with config.yml file
Before setting up your Android project on CircleCI, let’s create the workflow to build the application, start Genymotion SaaS devices, run the tests and stop the devices.
For this, everything is done through a config.yml file in .circleci/ directory in your project root directory.
Genymotion SaaS Cloud account credentials need to be set as environment variables:
GMCLOUD_SAAS_EMAIL: it is the email of your Cloud account; if you don’t have an account, please create it first on https://cloud.geny.io.
GMCLOUD_SAAS_PASSWORD: it is the password for your Cloud account.
We will cover two examples :
Start/Stop Genymotion SaaS devices with a single predefined job or with orb commands in your own job.
Start & Stop Genymotion SaaS devices
Several parameters are used :
recipe_uuid : Recipe UUID is the identifier used when starting an instance, it can be retrieved using gmsaas recipes list command line. The comprehensive list of all currently available recipes UUIDs are available here.
adb_serial_port : it is the port through which the instance will be connected to ADB, for example:
If you do not specify any ADB serial ports, it will be generated randomly.
Use the job defined with the orb
With this single job, authentication on Genymotion SaaS, start & stop devices steps are included in the
genymotion-saas/run_testsstep. Only the
recipe_uuid is required,
adb_serial_port is optional. It needs to be directly used in the workflow.
Runnig tests after a commit
All steps are done with genymotion-saas-orb job
Use orb commands in your own job
To start a device (
adb_serial_port is optional)
To stop a device after running the tests
So a job that runs tests on an Android 9 devices will look like:
Run the tests
The tests are run between start & stop instance steps. To run espresso tests, we use the
connectedDebugAndroidTest gradle command:
Scale your tests by running your tests in parallel
genymotion-saas/start-instance step starts one Android virtual device. To start several devices you need to define as many jobs as many devices you wish to start.
android10 are jobs with
genymotion-saas/start-instance steps that start respectively an Android 9 & Android 10 devices. To start these devices in parallel, you need to have subscribed to the CircleCI plan that enables more than one job to run in parallel.
Run tests in parallel
2. Get running on CircleCI
You are now all setup to run your tests on Genymotion SaaS virtual devices. Please refer to the official documentation on how to setup your project to run on CircleCI
At the end of this tutorial, you should be able to create a Continuous Integration workflow for your application to run your tests at scale.
Genymotion SaaS (Cloud) orb is open-source, so feel free to create an issue or contribute.
The Android application code sample and the config.yml file used in this tutorial is available on Github
Enjoy running your automated tests on Genymotion SaaS from CircleCI!
Thanks to the CircleCI team (special thanks to Kyle Tryon) for all their help!