Config plugin to auto configure detox on prebuild
npm install @config-plugins/detoxConfig plugin to auto-configure Detox when the native code is generated (npx expo prebuild).
Ensure you use versions that work together!
| expo | detox | @config-plugins/detox |
| ------ | ------- | ----------------------- |
| 53.0.0 | 20.37.0 | ^10.0.0 |
| 52.0.0 | 20.28.0 | ^9.0.0 |
| 51.0.0 | 20.20.3 | ^8.0.0 |
| 50.0.0 | 20.17.0 | ^7.0.0 |
| 49.0.0 | 20.11.0 | ^6.0.0 |
| 48.0.0 | 20.5.0 | ^5.0.0 |
| 47.0.0 | 19.13.0 | ^4.0.0 |
| 46.0.0 | 19.9.0 | ^3.0.0 |
| 45.0.0 | 19.6.9 | ^2.0.0 |
| 44.0.0 | 19.1.0 | ^1.1.0 |
| 43.0.0 | 19.1.0 | ~1.0.0 |
| 40.0.0 | 18.6.2 | ~0.0.0 |
Most notably, the minimum required Kotlin version changed from 1.3.50 in SDK 40 to 1.4.21 in SDK 43. Failure to use the correct versioning could result in Android build errors like Execution failed for task ':react-native-screens:compileDebugKotlin'. or Execution failed for task ':expo:compileDebugKotlin'..
First install the package with yarn, npm, or npx expo install.
``
npx expo install detox @config-plugins/detox
Detox is an end-to-end (e2e) testing library for iOS and Android. You can use it to automate usage of your native project. This example demonstrates how to use Detox and Jest in a native project that you build locally.
- Install with yarn or npm install
- Install iOS packages:
- Run to build and test the iOS app on a simulator (macOS only).yarn build:ios
- This combines and yarn test:ios.yarn test:ios --watch
- You can run after building to keep the tests in watch mode.yarn e2e:android
- Run to build and test the Android app on a Google emulator (Genymotion requires extra config).yarn build:android
- This combines and yarn test:android.yarn test:android --watch
- You can run after building to keep the tests in watch mode.yarn e2e:android-release
- Run to build and test the Android app in release mode.
- npx create-react-native-app -t blank
- into the projectyarn add -D detox @config-plugins/detox @babel/core @babel/runtime @types/jest babel-jest jest jest-circus ts-jest
- Install packages:
-
- touch
- Run to ensure TS is setup correctly.app.json
- Add the following plugin to your plugins array (before prebuilding). This'll automatically configure the Android native code to support Detox:`
json`
{
"plugins": ["@config-plugins/detox"]
}
- Generate the native code
- Run
The plugin provides props for extra customization. Every time you change the props or plugins, you'll need to rebuild (and prebuild) the native app. If no extra properties are added, defaults will be used.
- skipProguard (_boolean_): Disable adding proguard minification to the app/build.gradle. Defaults to false.subdomains
- (_string[] | '\'_): Hostnames to add to the network security config. Pass '' to allow all domains. Defaults to ['10.0.2.2', 'localhost'].
app.config.js
`ts`
export default {
plugins: [
[
"@config-plugins/detox",
{
skipProguard: false,
subdomains: ["10.0.2.2", "localhost"],
},
],
],
};
If the following commands fail, you can get better debug info by running a subset command:
- yarn e2e:ios: yarn ios (builds the iOS app). xcodebuild compile errors may show in a more helpful format (using xcpretty).yarn e2e:android
- : yarn android (builds the Android app). Android compile errors may show in a more helpful format.
If you get the error:
`sh
detox[98696] ERROR: DetoxRuntimeError: Cannot boot Android Emulator with the name: 'Pixel_API_28'
HINT: Make sure you choose one of the available emulators: Pixel_3_API_30,Pixel_6_Pro_API_33,Pixel_C_API_30
`
Be sure to change the first emulator name (in my case "Pixel_API_28") with one of the suggested emulators (in my case Pixel_3_API_30, Pixel_6_Pro_API_33, Pixel_C_API_30), in the detox.config.js file under devices.emulator.device.avdName. More emulators can be created in Android Studio.
---
If you get the error:
`sh`
Error: app binary not found at '/Users/.../with-detox/android/app/build/outputs/apk/debug/app-debug.apk', did you build it
It means the build step failed, ensure running yarn android, and yarn build:android works before trying yarn e2e:android again.
---
If you get the error:
`sh`
PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
Be sure to disable any proxies running on your computer that may be blocking requests (i.e. Charles Proxy). You may need to run yarn clean:android before attempting to build again.
---
If you get the error:
`sh`
CLEARTEXT communication to [some host] not permitted by network security policy
This means you're attempting to connecting over plain HTTP (not HTTPS) to a host that _isn't_ in your subdomains settings (defaults to ['10.0.2.2', 'localhost']). Set your subdomain settings appropriately. For example, if you're building Detox into a dev-client, you'll want to make sure you can connect to your Metro server:
`javascript``
module.exports = {
plugins: [
[
"@config-plugins/detox",
{
subdomains:
process.env.EAS_BUILD_PROFILE === "development"
? "*"
: ["10.0.2.2", "localhost"],
},
],
],
};