Skip to content

Latest commit

 

History

History
237 lines (188 loc) · 7.04 KB

APIRef.Configuration.md

File metadata and controls

237 lines (188 loc) · 7.04 KB
Raw

Configuration Options

Configuring package.json

Device Configuration

configurations holds all the device configurations, if there is only one configuration in configurations detox build and detox test will default to it, to choose a specific configuration use --configuration param

Configuration Params Details
type Device type, available options are ios.simulator, ios.none, android.emulator, and android.attached.
binaryPath Relative path to the ipa/app due to be tested (make sure you build the app in a project relative path)
testBinaryPath (optional, Android only): relative path to the test app (apk)
device Device query, e.g. { "byType": "iPhone 11 Pro" } for iOS simulator or { "avdName": "Nexus_5X_API_29" }
build [optional] Build command (either xcodebuild, react-native run-ios, etc...), will be later available through detox CLI tool.

Example:

{
  // ...
  "detox": {
    // ...
    "configurations": {
      "ios.sim.debug": {
        "binaryPath": "ios/build/Build/Products/Debug-iphonesimulator/example.app",
        "build": "xcodebuild -project ios/example.xcodeproj -scheme example -configuration Debug -sdk iphonesimulator -derivedDataPath ios/build",
        "type": "ios.simulator",
        "device": { /* one of these or a combination of them */
          "id": "D53474CF-7DD1-4673-8517-E75DAD6C34D6",
          "type": "iPhone 11 Pro",
          "name": "MySim",
          "os": "iOS 13.0",
        }
      },
      "android.emu.release": {
        "binaryPath": "...",
        "build": "...",
        "type": "android.emulator",
        "device": {
          "avdName": "Nexus_5X_API_29",
        }
      },
      "android.att.release": {
        "binaryPath": "...",
        "build": "...",
        "type": "android.attached",
        "device": {
          "adbName": "YOGAA1BBB412",
        }
      },
    }
  }
}

Artifacts Configuration

Detox can control artifacts collection via settings from package.json:

{
  "detox": {
    "artifacts": {
      "rootDir": ".artifacts",
      "pathBuilder": "./config/pathbuilder.js",
      "plugins": {
        "instruments": { "enabled": false },
        "log": { "enabled": true },
        "screenshot": {
          "shouldTakeAutomaticSnapshots": true,
          "keepOnlyFailedTestsArtifacts": true
        },
        "video": {
          "android": {
            "bitRate": 4000000
          },
          "simulator": {
            "codec": "hevc"
          }
        }
      }
    },
    "configurations": {
      "ios.sim.release": {
        "binaryPath": "/path/to/app",
        "device": { /* ... */ },
        "artifacts": {
          "rootDir": ".artifacts/ios",
          "plugins": {
            "instruments": "all"
          }
        }
      }
    }
  }
}

As can be seen from the example above, in a specific configuration you may override individual properties from the default artifacts configuration. For instance, in the example above you can see that specifically in ios.sim.release we turn on instruments plugin.

CLI arguments (e.g., --artifacts-location, --record-logs) still have the highest priority and override their counterparts from JSON.

Also, that example demonstrates that you can use strings (identical to the ones from CLI) in parallel to the object configurations for plugins. Below you can see mappings between the string presets and the corresponding objects:

preset object
none { "enabled": false }
all { "enabled": true }
failing { "enabled": true, "keepOnlyFailedTestsArtifacts": true }
manual { "enabled": true, "shouldTakeAutomaticSnapshots": false }

Server Configuration

Detox can either initialize a server using a generated configuration, or can be overriden with a manual configuration:

  "detox": {
    ...
    "session": {
    "server": "ws://localhost:8099",
    "sessionId": "YourProjectSessionId"
    }
  }

Session can also be set per configuration:

  "detox": {
  ...
    "configurations": {
      "ios.sim.debug": {
        ...
        "session": {
          "server": "ws://localhost:8099",
          "sessionId": "YourProjectSessionId"
        }
      }
    }
  }

Test Runner Configuration

Optional: setting a test runner (Mocha as default, Jest is supported)
Mocha
  "detox": {
    ...
    "test-runner": "mocha",
    "runner-config": "path/to/mocha.opts"
  }

mocha.opts refers to --opts in https://mochajs.org/#mochaopts

Jest
  "detox": {
    ...
    "test-runner": "jest"
    "runner-config": "path/to/config.json"
  }

config.json refers to --config in https://facebook.github.io/jest/docs/en/configuration.html

NOTE: jest tests will run in band, as Detox does not currently supports parallelization.

detox-cli

Build Configuration

In your detox config (in package.json) paste your build command into the configuration's build field. The build command will be triggered when running detox build. This is only a convience method, to help you manage building multiple configurations of your app and couple them to your tests. You can also choose not to use it and provide a compiled app by yourself.

You can choose to build your project in any of these ways...

  • If there's only one configuration, you can simply use:

    detox build

  • To choose a specific configuration:

    detox build --configuration yourConfiguration

  • Building with xcodebuild:

    xcodebuild -project ios/YourProject.xcodeproj -scheme YourProject -sdk iphonesimulator -derivedDataPath ios/build

  • Building using React Native, this is the least suggested way of running your build, since it also starts a random simulator and installs the app on it.

    react-native run-ios

Note: remember to update the app path in your package.json.

Test Configuration

  • If there's only one configuration, you can simply use:

    detox test ./e2e

where ./e2e is the path to your Detox tests folder.

  • For multiple configurations, choose your configuration by passing --configuration param:

    detox test ./e2e --configuration yourConfiguration

Faster test runs with app reuse

By default the app is removed, reinstalled and launched before each run. Starting fresh is critical in CI but in dev you might be able to save time between test runs and reuse the app that was previously installed in the simulator. To do so use the reuse flag and run your tests like this:

detox test ./e2e --reuse

This is especially useful with React Native DEV mode when making Javascript code changes that are getting picked up by the packager (and thus no reinstall is needed). This can save up to 7 seconds per run! You should not use this option if you made native code changes or if your app relies on local ("disk") storage.