This article is a copy of https://medium.com/genymobile/scale-your-e2e-react-native-ui-testing-with-detox-on-genymotion-cloud-android-virtual-devices-b3effbc7eccc. Reproduced by courtesy of its author, Elinor Kwok.
Developing mobile applications in React Native has become more and more popular due to its cross-platform compatibility. To run end-to-end testing on React Native applications, Detox framework stands out:
- it is fast and its asynchronous operations reduces testing flakiness
- it integrates easily within the project code
As your application development code and features grow, there is a need to automate and scale those tests to reduce bugs as early as possible. Running those tests on virtual devices has an advantage : devices can be started and stopped on demand at scale.
To test your React Native application on Android, you could run them on Genymotion SaaS. It offers cloud-based Android Virtual Devices. Good news, Wix has been working on a tight integration with Genymotion SaaS to ease the run of end-to-end Detox testing for Android. The integration is not completely finished yet and made official but the core integration is already there. This tutorial is a teasing for a more detailed blogpost and documentation that Wix will release later once everything is completely integrated. For now, if you wish to test please follow these instructions.
There are different steps :
- Setup the devices to run the tests on
- Run the tests : devices are automatically started & stopped by detox
- Python 3 environment
- Android SDK platform tools with adb installed
- A working detox installation with Jest as a test runner
- gmsaas installed and configured
1. Setup Genymotion SaaS device
detox.config.js file, add
android.genyclouddevice type. You can tell which device to start by giving its recipe uuid or its name.
recipeUUID as the recipe uuid. You can refer to this example. The UUID can be retrieved using
gmsaas recipes list command line. The comprehensive list of all currently available recipes UUIDs are available here
recipeName as the name of the template to start. Please note that if several templates match the name, the first one of the list will be started. You can refer to this example.
2. Detox automatically handles the start and stop of Genymotion devices with calls to global Detox init and cleanup callback in Jest’s hooks.
At project setup, init & teardown callbacks are automatically defined in jest config file like this:
Please make sure that
globalTeardown callbacks are defined in the jest config file.
3. [OPTIONAL] If you wish to run your tests in parallel, add e2e script to run your tests in parallel in your package.json file:
"test:android-genycloud-release-ci":"detox test --configuration android.genycloud.release -l verbose --workers 2 --record-logs all --take-screenshots all
In this example it will start 2 devices and run the tests in parallel where
android-genycloud-release is the final configuration of the device to run the tests. Please refer to this guide on how to configure a device. There is also an example here.
4. Build your application
You should have a line like this in your package.json file
At the root of your project, run:
npm run build:android
5. Run your tests
This will start the devices, run the tests and stop the devices:
npm run test:android-genycloud-release-ci
You can refer to the demo-react-native-jest project for a complete example.
At the end of this tutorial, you should be able to start and stop Genymotion SaaS virtual devices directly from your detox tests. You can also refer to Detox official documentation.
If you wish to contribute to the Detox project please go through the Contribution Guide.