Detox

https://wix.github.io/Detox/
Admin
Detox is an end-to-end testing framework for mobile applications that automatically synchronizes...
Tokens:160,190
Snippets:1,427
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### Set up local documentation site with pnpm

Source: https://wix.github.io/Detox/docs/contributing/documentation

Run these commands in the website directory to install dependencies and start the local development server using pnpm.

```bash
cd website  
pnpm install  
pnpm start  

```

--------------------------------

### Set up local documentation site with npm

Source: https://wix.github.io/Detox/docs/contributing/documentation

Run these commands in the website directory to install dependencies and start the local development server using npm.

```bash
cd website  
npm install  
npm start  

```

--------------------------------

### pilot.perform() example

Source: https://wix.github.io/Detox/docs/api/pilot

Performs a series of natural language steps. The example shows how to start the app, tap a button, enter credentials, and assert a welcome message.

```javascript
await pilot.perform(  
  'Start the application',  
  'Tap on the "Login" button',  
  'Enter "user@example.com" into the email field',  
  'Enter "password123" into the password field',  
  'Press the "Submit" button',  
  'The welcome message "Hello, User!" should be displayed'  
);  

```

--------------------------------

### Set up local documentation site with Yarn

Source: https://wix.github.io/Detox/docs/contributing/documentation

Run these commands in the website directory to install dependencies and start the local development server using Yarn.

```bash
cd website  
yarn install  
yarn start  

```

--------------------------------

### detox start

Source: https://wix.github.io/Detox/docs/cli/start

Documentation for the detox start CLI command, including its options and usage examples.

```APIDOC
## detox start

### Description
Runs the `start` command of the app (or apps) from the specified configuration.

### Method
CLI command

### Endpoint
`detox start [options]`

### Parameters

#### Options
- `-C, --config-path <configPath>` (string) - Optional - Specify Detox config file path. If not supplied, Detox searches for .detoxrc[.js] or "detox" section in package.json.
- `-c, --configuration <device config>` (string) - Optional - Select a local configuration from your defined configurations to extract the app "start" scripts from it. If not supplied, and there’s only one configuration, Detox will default to it.
- `-f, --force` (boolean) - Optional - Ignore errors from the "start" scripts and continue.
- `--help` (boolean) - Optional - Show help

### Examples

If you have only one configuration, you can simply use:

```
detox start
```

To choose a specific configuration:

```
# long alias:
detox start --configuration yourConfiguration
# short alias:
detox start -c yourConfiguration
```

To forward extra arguments to the "start" script, e.g.:

```
detox start -c yourConfiguration -- --port 8082
```

To ignore errors from the "start" scripts and continue:

```
detox start -c yourConfiguration --force
```
```

--------------------------------

### Spawned command from testRunner.args example

Source: https://wix.github.io/Detox/docs/config/testRunner

The command that would be spawned from the previous configuration example.

```bash
nyc jest --bail --config e2e/jest.config.js e2e/sanity-tests  

```

--------------------------------

### Example: Launch App from URL Test

Source: https://wix.github.io/Detox/docs/guide/mocking-open-with-url

Example test that launches the app with a URL and verifies a label is visible.

```javascript
describe('launch app from URL', () => {  
    it('should handle URL successfully', async () => {  
      await device.launchApp({  
        newInstance: true,  
        url: 'scheme://some.url',  
        sourceApp: 'com.apple.mobilesafari'  
      });  
      await expect(element(by.text('a label'))).toBeVisible();  
    });  
  });  
```

--------------------------------

### Install Watchman with Homebrew

Source: https://wix.github.io/Detox/docs/contributing/code/setting-up-the-dev-environment

Install Watchman, a filesystem watching tool by Facebook, using Homebrew.

```bash
brew install watchman  
```

--------------------------------

### device.installApp(path?)

Source: https://wix.github.io/Detox/docs/api/device

Installs an app. By default, installs the app defined in the current configuration. Optionally specify another app's path.

```APIDOC
## device.installApp(path?)

### Description
By default, `installApp()` with no params will install the app file defined in the current `configuration`. To install another app, specify its path.

### Method
installApp

### Parameters
#### Path Parameters
- **path** (string) - Optional - The path to the app file to install.

### Request Example
```
await device.installApp('path/to/other/app');  
```

```

--------------------------------

### Install xcpretty with RubyGems

Source: https://wix.github.io/Detox/docs/contributing/code/setting-up-the-dev-environment

Install xcpretty, a formatter for xcodebuild, using RubyGems.

```bash
gem install xcpretty  
```

--------------------------------

### One action per step example

Source: https://wix.github.io/Detox/docs/pilot/best-practices

Example showing two separate steps for tapping a login button and entering an email, as preferred over combining actions.

```javascript
'Tap on the "Login" button',  
'Enter "user@example.com" into the "Email" field'  
```

--------------------------------

### Example: Launch with push notification

Source: https://wix.github.io/Detox/docs/guide/mocking-user-notifications

Example test that launches the app with a push notification and verifies that the notification is handled.

```javascript
describe('Launch with push notification', () => {  
  it('should handle the notification', async () => {  
    await device.launchApp({  
      newInstance: true,  
      userNotification: userNotificationPushTrigger,  
    });  
    await expect(element(by.text('From push'))).toBeVisible();  
  });  
});  
```

--------------------------------

### Run detox start with default configuration

Source: https://wix.github.io/Detox/docs/cli/start

Runs the start command of the app (or apps) from the specified configuration. Use this when you have only one configuration defined.

```bash
detox start  

```

--------------------------------

### pilot.init() example

Source: https://wix.github.io/Detox/docs/api/pilot

Initializes Pilot with a prompt handler. Must be called before any other Pilot methods. The example creates an OpenAIPromptHandler with an API key and passes it to pilot.init().

```javascript
const { pilot } = require('detox');  
const OpenAIPromptHandler = require('./OpenAIPromptHandler');  
  
beforeAll(() => {  
  const promptHandler = new OpenAIPromptHandler('YOUR_OPENAI_API_KEY');  
  pilot.init(promptHandler);  
});  

```

--------------------------------

### testRunner.args configuration example

Source: https://wix.github.io/Detox/docs/config/testRunner

Example configuration for testRunner.args that spawns 'nyc jest' with bail, config, and positional arguments.

```json
{  
  "testRunner": {  
    "args": {  
      "$0": "nyc jest",  
      "bail": true,  
      "config": "e2e/jest.config.js",  
      "_": ["e2e/sanity-tests"]  
    }  
  }  
}  

```

--------------------------------

### Install Dependencies with Yarn

Source: https://wix.github.io/Detox/docs/contributing/code/setting-up-the-dev-environment

Install all dependencies for the monorepo using Yarn.

```bash
yarn install  
```

--------------------------------

### Start React Native packager with npm start

Source: https://wix.github.io/Detox/docs/introduction/your-first-test

Start the React Native packager before running Detox tests in debug configurations. The output shows the Metro bundler welcome banner.

```bash
npm start  
  
> react-native start  
  
#                        #######  
#                   ################  
#                #########     #########  
#            #########             ##########  
#        #########        ######        #########  
#       ##########################################  
#      #####      #####################       #####  
#      #####          ##############          #####  
#      #####    ###       ######       ###    #####  
#      #####    #######            #######    #####  
#      #####    ###########    ###########    #####  
#      #####    ##########################    #####  
#      #####    ##########################    #####  
#      #####      ######################     ######  
#       ######        #############        #######  
#         #########        ####       #########  
#              #########          #########  
#                  ######### #########  
#                       #########  
#  
#  
#                    Welcome to Metro!  
#              Fast - Scalable - Integrated  

```

--------------------------------

### Choose a specific configuration with detox start

Source: https://wix.github.io/Detox/docs/cli/start

Selects a specific configuration to extract the app start scripts from. The long alias is --configuration and the short alias is -c.

```bash
# long alias:  
detox start --configuration yourConfiguration  
# short alias:  
detox start -c yourConfiguration  

```

--------------------------------

### Expected output of java -version

Source: https://wix.github.io/Detox/docs/guide/android-dev-env

This is the expected output format when Java is correctly installed. The exact version number may vary, but it should start with 'java version' and include the version in quotes.

```text
java version "17.x.x"  
...  
```

--------------------------------

### Launch the app with device.launchApp() in beforeAll

Source: https://wix.github.io/Detox/docs/introduction/your-first-test

Call device.launchApp() at least once to start the app, typically in the beforeAll hook. The app is not running when the test starts.

```javascript
describe('Example', () => {  
  beforeAll(async () => {  
    await device.launchApp();  
  });  
  
  // …  
});  

```

--------------------------------

### Install emulator image and accept licenses

Source: https://wix.github.io/Detox/docs/guide/android-dev-env

Installs a system image without Google APIs and accepts licenses. The ;default; part replaces ;google_apis;. For M1, use arm64-v8a architecture. Other APIs are supported.

```bash
$ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager "system-images;android-28;default;x86_64"  
$ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --licenses  

```

--------------------------------

### autopilot() goal example

Source: https://wix.github.io/Detox/docs/pilot/best-practices

Example of using pilot.autopilot() with a clear goal to complete checkout and verify order confirmation.

```javascript
await pilot.autopilot('Complete the checkout process and verify the order confirmation');  
```

--------------------------------

### iOS app config example (ios.app)

Source: https://wix.github.io/Detox/docs/config/apps

Example app config for an iOS app. The `type` is `ios.app`, `binaryPath` points to the built `.app` bundle, and `build` is an optional command run by `detox build`.

```json
{  
  "type": "ios.app",  
  "binaryPath": "ios/build/Build/Products/Debug-iphonesimulator/example.app",  
  "build": "xcodebuild -project ios/example.xcodeproj -scheme example -configuration Debug -sdk iphonesimulator -derivedDataPath ios/build"  
}  

```

--------------------------------

### Example: Foreground user notifications

Source: https://wix.github.io/Detox/docs/guide/mocking-user-notifications

Example test that sends a local notification to a running app and verifies it is handled.

```javascript
describe('Foreground user notifications', () => {  
  it('should handle the local notification from inside the app', async () => {  
    await device.launchApp();  
    await device.sendUserNotification(localNotification);  
    await expect(element(by.text('from local notification'))).toBeVisible();  
   });  
});  
```

--------------------------------

### Start Metro in mocked mode

Source: https://wix.github.io/Detox/docs/guide/mocking

Starts the Metro bundler with the MY_APP_MODE environment variable set to 'mocked', which triggers the sourceExts override defined in metro.config.js.

```bash
MY_APP_MODE=mocked npx react-native start  

```

--------------------------------

### pilot.autopilot() example

Source: https://wix.github.io/Detox/docs/api/pilot

Automatically generates steps to achieve a goal. The example shows a natural language goal for logging in and navigating to a profile page.

```javascript
await pilot.autoPilot('Log in and navigate to the profile page');  

```

--------------------------------

### Wrap Detox globalSetup with custom setup

Source: https://wix.github.io/Detox/docs/config/testRunner

Wrapper for `globalSetup` that calls Detox's globalSetup first, then runs your own setup function. Essential for integrating with Detox Internals API.

```javascript
module.exports = async () => {  
   await require('detox/runners/jest').globalSetup();  
   await yourGlobalSetupFunction();  
};  

```

--------------------------------

### Example log output from debugSynchronization

Source: https://wix.github.io/Detox/docs/config/logger

Example log output produced when `session.debugSynchronization` is enabled (default). It shows the app being busy with pending tasks on the main queue.

```text
15:13:07.309 detox[17005] i The app is busy with the following tasks:  
• There are 10 work items pending on the dispatch queue: "Main Queue (<OS_dispatch_queue_main: com.apple.main-thread>)".  
...  

```

--------------------------------

### Full WebView test example

Source: https://wix.github.io/Detox/docs/guide/testing-webviews

A complete test that interacts with a WebView: asserts initial state, fills fields, taps a button, and verifies the result. This is the full example provided on the page.

```javascript
it('should login successfully', async () => {  
    // Assert the welcome message is not visible before login  
    await expect(web.element(by.web.id('welcome_message'))).not.toExist();  
  
    // Fill username and password  
    await web.element(by.web.id('username')).typeText('John Doe');  
    await web.element(by.web.id('password')).typeText('123456789');  
  
    // Press the login button  
    await web.element(by.web.id('login')).tap();  
  
    // Assert the login was successful  
    await expect(web.element(by.web.id('welcome_message'))).toHaveText('Welcome, John Doe!');  
});  
```

--------------------------------

### Android app config example (android.apk)

Source: https://wix.github.io/Detox/docs/config/apps

Example app config for an Android app. The `type` is `android.apk`, `binaryPath` points to the APK, and `build` is an optional command run by `detox build`.

```json
{  
  "type": "android.apk",  
  "binaryPath": "path/to/myApp.apk",  
  "build": "cd android && ./gradlew …"  
}  

```

--------------------------------

### Bitrise workflow configuration for Detox

Source: https://wix.github.io/Detox/docs/introduction/preparing-for-ci

Example Bitrise .yml file for a workflow named 'tests'. It sets up the project, installs Detox and React Native CLIs, installs Detox utils, and runs Detox build and test commands.

```yaml
---  
format_version: 1.1.0  
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git  
trigger_map:  
- push_branch: "*"  
  workflow: tests  
workflows:  
  _tests_setup:  
    steps:  
    - activate-ssh-key: {}  
    - git-clone:  
        inputs:  
        - clone_depth: ''  
        title: Git Clone Repo  
    - script:  
        inputs:  
        - content: |-  
            #!/bin/bash  
  
            npm cache verify  
  
            npm install  
        title: Install NPM Packages  
    before_run:  
    after_run:  
  _detox_tests:  
    before_run: []  
    after_run: []  
    steps:  
    - npm:  
        inputs:  
        - command: install -g detox-cli  
        title: Install Detox CLI  
    - npm:  
        inputs:  
        - command: install -g react-native-cli  
        title: Install React Native CLI  
    - script:  
        inputs:  
        - content: |-  
            #!/bin/bash  
  
            brew tap wix/brew  
            brew install applesimutils  
        title: Install Detox Utils  
    - script:  
        inputs:  
        - content: |-  
            #!/bin/bash  
  
            detox build --configuration ios.sim.release  
        title: Detox - Build Release App  
    - script:  
        inputs:  
        - content: |-  
            #!/bin/bash  
  
            detox test --configuration ios.sim.release --cleanup  
        title: Detox - Run E2E Tests  
  tests:  
    before_run:  
    - _tests_setup  
    - _detox_tests  
    after_run: []  
  

```

--------------------------------

### Usage example for --device-boot-args

Source: https://wix.github.io/Detox/docs/cli/test

Shows how to pass boot arguments to a device using the --device-boot-args flag. The value must be specified after an equal sign and inside quotes.

```bash
--device-boot-args="-http-proxy http://1.1.1.1:8000 -no-snapshot-load"
```

--------------------------------

### Jest reportSpecs output

Source: https://wix.github.io/Detox/docs/config/testRunner

Example output when reportSpecs is enabled, showing test start and end messages with timestamps and status.

```text
18:03:36.258 detox[40125] i Sanity: should have welcome screen  
18:03:37.495 detox[40125] i Sanity: should have welcome screen [OK]  
18:03:37.496 detox[40125] i Sanity: should show hello screen after tap  
18:03:38.928 detox[40125] i Sanity: should show hello screen after tap [OK]  
18:03:38.929 detox[40125] i Sanity: should show world screen after tap  
18:03:40.351 detox[40125] i Sanity: should show world screen after tap [OK]  

```

--------------------------------

### Get platform with device.getPlatform()

Source: https://wix.github.io/Detox/docs/api/device

Returns the current device platform, 'ios' or 'android'. Example shows checking for iOS before an expectation.

```javascript
if (device.getPlatform() === 'ios') {  
  await expect(loopSwitch).toHaveValue('1');  
}  
```

--------------------------------

### Travis CI configuration for Detox

Source: https://wix.github.io/Detox/docs/introduction/preparing-for-ci

Example .travis.yml configuration to run Detox on Travis CI. It installs Node.js, applesimutils, and Detox CLI, then builds and tests the iOS app.

```yaml
language: objective-c  
osx_image: xcode8.3  
  
branches:  
  only:  
  - master  
  
env:  
  global:  
  - NODE_VERSION=stable  
  
install:  
- brew tap wix/brew  
- brew install applesimutils  
- curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.2/install.sh | bash  
- export NVM_DIR="$HOME/.nvm" && [ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"  
- nvm install $NODE_VERSION  
- nvm use $NODE_VERSION  
- nvm alias default $NODE_VERSION  
  
- npm install react-native-cli --global  
- npm install detox-cli --global  
  
script:  
- detox build --configuration ios.sim.release  
- detox test --configuration ios.sim.release --cleanup  
  

```

--------------------------------

### Initialize Detox with detox init

Source: https://wix.github.io/Detox/docs/cli/init

Run this command in the project directory to create template files: .detoxrc.js, e2e/jest.config.js, and e2e/starter.test.js.

```bash
detox init  

```

--------------------------------

### Regex matching with flags example

Source: https://wix.github.io/Detox/docs/api/matchers

Matches text starting with 'Tap' followed by alphabetic characters, case-insensitively. Supported flags include i, s, m; unsupported flags like g and y are ignored.

```javascript
element(by.text(/Tap [A-Za-z]+/i));  
```

--------------------------------

### onRunDescribeStart(event) usage

Source: https://wix.github.io/Detox/docs/api/internals

Reports that the test runner started executing a test suite, such as a beforeAll hook or a first test. Requires an installed worker. The event object contains a name property for the suite name.

```javascript
await onRunDescribeStart({  
  name: 'Suite name'  
});  
```

--------------------------------

### GitLab CI job for Detox Android

Source: https://wix.github.io/Detox/docs/introduction/preparing-for-ci

Example GitLab CI job definition for running Detox on Android. It uses the reactnativecommunity/react-native-android image, installs dependencies, creates an AVD, and runs Detox build and test commands.

```yaml
detox_e2e:  
  stage: test  
  image: reactnativecommunity/react-native-android  
  variables:  
  before_script:  
    - npm install envinfo detox-cli --global && envinfo  
    # Increase file watcher limit, see more here: https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers#the-technical-details  
    - echo fs.inotify.max_user_watches=524288 | tee -a /etc/sysctl.conf && sysctl -p  
    - mkdir -p /root/.android && touch /root/.android/repositories.cfg  
    # The Dockerimage provides two paths for sdkmanager and avdmanager, which the defaults are from $ANDROID_HOME/cmdline-tools  
    # That is not compatible with the one that Detox is using ($ANDROID_HOME/tools/bin)  
    - echo yes | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --channel=0 --verbose "system-images;android-27;default;x86_64" "emulator"  
    # Nexus 6P, API 27, XXXHDPI  
    - echo no | $ANDROID_HOME/cmdline-tools/latest/bin/avdmanager --verbose create avd --force --name "Nexus6P" --package "system-images;android-27;default;x86_64" --sdcard 200M --device 11  
    - adb start-server  
  script:  
    - npx detox build -c android.emu.release.ci  
    - npx detox test -c android.emu.release.ci --headless  
  

```

--------------------------------

### Multiple apps configuration with names

Source: https://wix.github.io/Detox/docs/config/apps

Configuration for multiple apps in the same Detox configuration. Each app gets a `name` (e.g., `driver`, `passenger`) and the configuration lists those names in `apps`. You can override build and start commands with configuration-scoped ones.

```json
{  
  "apps": {  
    "driver.ios.release": {  
      "type": "ios.app",  
      "name": "driver",  
      "binaryPath": "path/to/driver.app"  
    },  
    "passenger.ios.release": {  
      "type": "ios.app",  
      "name": "passenger",  
      "binaryPath": "path/to/passenger.app"  
    }  
  },  
  "configurations": {  
    "ios.release": {  
      "device": "simulator",  
      "apps": ["driver", "passenger"],  
      "build": "scripts/build-both-apps.sh",  
      "start": "scripts/start-both-apps.sh"  
    }  
  }  
}  

```

--------------------------------

### Install Detox dev dependency

Source: https://wix.github.io/Detox/docs/introduction/project-setup

Install Detox as a dev dependency. This is the initial install shown after adding Jest.

```bash
npm install detox --save-dev  
```

```bash
yarn add detox --dev  
```

```bash
pnpm add detox --save-dev  
```

--------------------------------

### Initialize npm package

Source: https://wix.github.io/Detox/docs/introduction/project-setup

Create a package.json in the project root. This is required before installing Detox itself.

```bash
npm init -y  
```

--------------------------------

### perform() with sequential steps

Source: https://wix.github.io/Detox/docs/pilot/best-practices

Example of using pilot.perform() with a sequence of natural language steps to navigate and add a product to the cart.

```javascript
it('should navigate and add a product to the cart', async () => {  
  await pilot.perform(  
    'Navigate to the "Products" page',  
    'Tap on the "Add to Cart" button for the first product',  
    'Verify that the "Added to Cart" pop-up is displayed'  
  );  
});  
```

--------------------------------

### Install React Native CLI Globally

Source: https://wix.github.io/Detox/docs/contributing/code/setting-up-the-dev-environment

Install the react-native-cli globally as a common dependency.

```bash
npm install react-native-cli --global  
```

--------------------------------

### device.appLaunchArgs.get

Source: https://wix.github.io/Detox/docs/api/device

Retrieves the current launch arguments, including any modifications made via `modify`.

```APIDOC
## device.appLaunchArgs.get

### Description
Retrieves the current launch arguments, including any modifications made via `modify`.

### Method
get

### Parameters
None.

### Request Example
```js
device.appLaunchArgs.get();
```

### Response
Returns an object containing the current launch arguments.
```

--------------------------------

### Install Jest version 29 for React Native

Source: https://wix.github.io/Detox/docs/introduction/project-setup

Install the latest supported Jest version as a dev dependency. The @^29 override prevents outdated versions from being installed due to package lock files.

```bash
npm install "jest@^29" --save-dev  
```

```bash
yarn add "jest@^29" --dev  
```

```bash
pnpm add "jest@^29" --save-dev  
```

--------------------------------

### List available simulators with simctl

Source: https://wix.github.io/Detox/docs/troubleshooting/running-tests

Use this command to list all available iOS simulators. Ensure the desired simulator is installed and its name matches the Detox configuration in package.json.

```bash
xcrun simctl list
```

--------------------------------

### Using --device-boot-args instead of deprecated --device-launch-args

Source: https://wix.github.io/Detox/docs/guide/migration

The --device-launch-args parameter is deprecated and superseded by --device-boot-args. Use this command to pass arguments to the device boot process.

```bash
detox test ... --device-boot-args="arg1 arg2"  

```

--------------------------------

### Install third-party driver with pnpm

Source: https://wix.github.io/Detox/docs/articles/third-party-drivers

Install a third-party driver package as a dev dependency using pnpm.

```bash
pnpm add --save-dev detox-driver-package  

```

--------------------------------

### Install third-party driver with Yarn

Source: https://wix.github.io/Detox/docs/articles/third-party-drivers

Install a third-party driver package as a dev dependency using Yarn.

```bash
yarn add --dev detox-driver-package  

```

--------------------------------

### Boot verbose visible emulator

Source: https://wix.github.io/Detox/docs/guide/android-dev-env

Starts the emulator in verbose mode with a visible window. Requires $ANDROID_HOME to be set and the emulator name to match (e.g., Pixel_API_28_AOSP).

```bash
$ANDROID_HOME/emulator/emulator -verbose @Pixel_API_28_AOSP &  
```

--------------------------------

### Install third-party driver with npm

Source: https://wix.github.io/Detox/docs/articles/third-party-drivers

Install a third-party driver package as a dev dependency using npm.

```bash
npm install --save-dev detox-driver-package  

```

--------------------------------

### testRunner.noRetryArgs custom configuration example

Source: https://wix.github.io/Detox/docs/config/testRunner

Example of customizing the noRetryArgs array to exclude specific arguments during retries.

```json
{  
  "testRunner": {  
    "noRetryArgs": ["shard", "maxWorkers", "customArg"]  
  }  
}  

```

--------------------------------

### testRunner.args._ default positional arguments example

Source: https://wix.github.io/Detox/docs/config/testRunner

Example configuration for default positional arguments using the '_' property.

```json
{  
  "args": {  
    "$0": "jest",  
    "_": ["e2e/sanity-tests"]  
  }  
}  

```

--------------------------------

### Write a test in plain text with copilot.perform

Source: https://wix.github.io/Detox/blog

Use copilot.perform with natural language commands to navigate, tap, and verify UI elements. Each string argument is a step in the test scenario.

```javascript
it('should navigate and add a product to the cart', async () => {  
  await copilot.perform(  
    'Navigate to the "Products" page',  
    'Tap on the "Add to Cart" button for the first product',  
    'Verify that the "Added to Cart" pop-up is displayed'  
  );  
});  
```

--------------------------------

### Detox init output listing generated files

Source: https://wix.github.io/Detox/docs/introduction/project-setup

Expected output from running detox init.

```text
Created a file at path: .detoxrc.js  
Created a file at path: e2e/jest.config.js  
Created a file at path: e2e/starter.test.js  
```

--------------------------------

### Install Jest test runner

Source: https://wix.github.io/Detox/docs/introduction/project-setup

Install Jest as a dev dependency. Detox provides first-class integration with Jest.

```bash
npm install jest --save-dev  
```

```bash
yarn add jest --dev  
```

```bash
pnpm add jest --save-dev  
```

--------------------------------

### Install detox-cli globally

Source: https://wix.github.io/Detox/docs/cli/overview

Installs the Detox CLI globally via npm. Use this before running any detox commands.

```bash
npm install detox-cli --global  
```

--------------------------------

### Create quickbootChoice.ini with saveOnExit=true

Source: https://wix.github.io/Detox/docs/guide/android-dev-env

Create or edit the quickbootChoice.ini file in the AVD's home directory with this content to enable saving the emulator state on exit.

```ini
saveOnExit = true  

```
Tokens:
Raw