@nx/detox:test
Run detox test options.
Options can be configured in project.json
when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/reference/project-configuration#targets.
Run detox test options.
Options can be configured in project.json
when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/reference/project-configuration#targets.
Select a device configuration from your defined configurations, if not supplied, and there's only one configuration, detox will default to it.
Specify Detox config file path. If not supplied, detox searches for .detoxrc[.js]
or detox
section in package.json.
Artifacts (logs, screenshots, etc) root directory.
Custom arguments to pass (through) onto the app every time it is launched.
Target which builds the application.
Shutdown simulator when test is over, useful for CI scripts, to make sure detox exists cleanly with no residue
enabled
, disabled
[iOS Only] Capture *.uihierarchy
snapshots on view action errors and device.captureViewHierarchy()
calls.
Colors in log output
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.
Override the device name specified in a configuration. Useful for running a single build configuration on multiple devices.
Custom arguments to pass (through) onto the device (emulator/simulator) binary when booted.
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.
Keep the device lock file when running Detox tests.
fatal
, error
, warn
, info
, verbose
, trace
Log level: fatal
, error
, warn
, info
, verbose
, trace
.
[Jest Circus Only] Re-spawn the test runner for individual failing suite files until they pass, or <N>
times at least.
false
Reuse existing installed app (do not delete + reinstall) for a faster run.
failing
, all
, none
Save logs during each test to artifacts directory. Pass failing
to save logs of failing tests only.
failing
, all
, none
Save screen recordings of each test to artifacts directory. Pass failing
to save recordings of failing tests only.
all
, none
[iOS Only] Save Detox Instruments performance recordings of each test to artifacts directory.
manual
, failing
, all
, none
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).
A list of passthrough-arguments to use when (if) devices (Android emulator / iOS simulator) are launched by Detox.
Deprecated in Detox 20. Use deviceBootArgs
instead.
Test runner config file, defaults to e2e/mocha.opts
for mocha and e2e/config.json
for Jest.
Deprecated in Detox 20. It is default to jest.config.json. It could be specified in .detoxrc.json
all
, none
[Jest Only] Record tests and events timeline, for visual display on the chrome://tracing
tool.
Deprecated in Detox 20.
Specifies number of workers the test runner should spawn, requires a test runner with parallel execution support (Detox CLI currently supports Jest).
Deprecated in Detox 20.
In case you missed Monorepo World, it is now available for replay.