The Nx Plugin for Detox contains executors and generators for allowing your workspace to use the powerful Detox integration testing capabilities.

![Detox logo](/shared/detox-logo.png)

Detox is gray box end-to-end testing and automation library for mobile apps. It has a lot of great features:

- Cross Platform
- Runs on Devices
- Automatically Synchronized
- Test Runner Independent
- Debuggable

## Setting Up Detox

### Install applesimutils (Mac only)

[applesimutils](https://github.com/wix/AppleSimulatorUtils) is a collection of utils for Apple simulators.

```sh
brew tap wix/brew
brew install applesimutils
```

### Install Jest Globally

```sh
npm install -g jest
```

### Generating Applications

By default, when creating a mobile application, Nx will use Detox to create the e2e tests project.

```bash
nx g @nrwl/react-native:app frontend
```

### Creating a Detox E2E project for an existing project

You can create a new Detox E2E project for an existing mobile project.

If the `@nrwl/detox` package is not installed, install the version that matches your `@nrwl/workspace` version.

```sh
# yarn
yarn add --dev @nrwl/detox
```

```sh
# npm
npm install --save-dev @nrwl/detox
```

Next, generate an E2E project based on an existing project.

```sh
nx g @nrwl/detox:app your-app-name-e2e --project=your-app-name
```

Replace `your-app-name` with the app's name as defined in your `tsconfig.base.json` file or the `name` property of your `package.json`.

In addition, you need to follow [instructions at Detox](https://github.com/wix/Detox/blob/master/docs/Introduction.Android.md) to do manual setup for Android files.

## Using Detox

### Testing Applications

- Run `nx test-ios frontend-e2e` to build the iOS app and execute e2e tests with Detox for iOS (Mac only)
- Run `nx test-android frontend-e2e` to build the Android app and execute e2e tests with Detox for Android

You can run below commands:

- `nx build-ios frontend-e2e`: build the iOS app (Mac only)
- `nx build-android frontend-e2e`: build the Android app

### Testing against Prod Build

You can run your e2e test against a production build:

- `nx test-ios frontend-e2e --prod`: to build the iOS app and execute e2e tests with Detox for iOS with Release configuration (Mac only)
- `nx test-android frontend-e2e`: rto build the Android app and execute e2e tests with Detox for Android with release build type
- `nx build-ios frontend-e2e --prod`: build the iOS app using Release configuration (Mac only)
- `nx build-android frontend-e2e --prod`: build the Android app using release build type

## Configuration

### Using .detoxrc.json

If you need to fine tune your Detox setup, you can do so by modifying `.detoxrc.json` in the e2e project.

#### Change Testing Simulator/Emulator

For iOS, in terminal, run `xcrun simctl list` to view a list of simulators on your Mac. To open your active simulator, `run open -a simulator`. In `frontend-e2e/.detoxrc.json`, you could change the simulator under `devices.simulator.device`.

For Android, in terminal, run `emulator -list-avds` to view a list of emulators installed. To open your emulator, run `emulator -avd <your emulator name>`. In `frontend-e2e/.detoxrc.json`, you could change the simulator under `devices.emulator.device`.

In additon, to override the device name specified in a configuration, you could use `--device-name` option: `nx test-ios <app-name-e2e> --device-name "iPhone 11"`. The `device-name` property provides you the ability to test an application run on specific device.

```bash
nx test-ios frontend-e2e --device-name "iPhone 11"
nx test-android frontend-e2e --device-name "Pixel_4a_API_30"
```


Overview

Run the command defined in build property of the specified configuration.

build

Specify Detox config file path. If not supplied, detox searches for `.detoxrc[.js]` or `detox` section in `package.json`.

Select a device configuration from your defined configurations, if not supplied, and there's only one configuration, detox will default to it.

Run detox build

test

Run tests

Custom arguments to pass (through) onto the app every time it is launched.

Artifacts (logs, screenshots, etc) root directory.

[iOS Only] Capture `*.uihierarchy` snapshots on view action errors and `device.captureViewHierarchy()` calls.

Shutdown simulator when test is over, useful for CI scripts, to make sure detox exists cleanly with no residue

Specify Detox config file path. If not supplied, detox searches for `.detoxrc[.js]` or `detox` section in package.json.

Customize how long an action/expectation can take to complete before Detox starts querying the app why it is busy. By default, the app status will be printed if the action takes more than 10s to complete.

A list of passthrough-arguments to use when (if) devices (Android emulator / iOS simulator) are launched by Detox.

Override the device name specified in a configuration. Useful for running a single build configuration on multiple devices.

Due to problems with the adb install command on Android, Detox resorts to a different scheme for install APK's. Setting true will disable that and force usage of `adb install`, instead.

[Android Only] Launch Emulator with the specific `-gpu [gpu mode]` parameter.

Android Only] Launch Emulator in headless mode. Useful when running on CI.

Uses node's `--inspect-brk` flag to let users debug the jest/mocha test runner

[Jest Only] Whether to output logs per each running spec, in real-time. By default, disabled with multiple workers.

Log level: `fatal`, `error`, `warn`, `info`, `verbose`, `trace`.

Save logs during each test to artifacts directory. Pass `failing` to save logs of failing tests only.

[iOS Only] Save Detox Instruments performance recordings of each test to artifacts directory.

[Jest Only] Record tests and events timeline, for visual display on the `chrome://tracing` tool.

Save screen recordings of each test to artifacts directory. Pass `failing` to save recordings of failing tests only.

[Jest Circus Only] Re-spawn the test runner for individual failing suite files until they pass, or `<N>` times at least.

Reuse existing installed app (do not delete + reinstall) for a faster run.

Test runner config file, defaults to `e2e/mocha.opts` for mocha and `e2e/config.json` for Jest.

Save screenshots before and after each test to artifacts directory. Pass `failing` to save screenshots of failing tests only. 

Use Detox' custom console-logging implementation, for logging Detox (non-device) logs. Disabling will fallback to Node.js / test-runner's implementation (e.g. Jest / Mocha).

Specifies number of workers the test runner should spawn, requires a test runner with parallel execution support (Detox CLI currently supports Jest).

Run detox test

init

Add Detox Schematics

application

Create Detox Configuration for the workspace.

Generate JavaScript files rather than TypeScript files.

The name of the frontend project to test.

Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.

@nrwl/detox:application

Usage

Options

directory

framework

js

linter

name

project

skipFormat

setParserOptionsProject