APIRef.TestLifecycle.md

id	title
APIRef.TestLifecycle	Test Lifecycle

Detox is test runner independent, and we encourage you to choose your own test runner, but for the sake of demonstration we will use mocha's syntax.

Initial Setup

The setup phase happens inside detox.init(). This is the phase where detox reads its configuration, starts a server, loads its expection library and starts a simulator.

const config = require('../package.json').detox;

before(async () => {
  await detox.init(config);
});

Of course, you can add any of your initilizations in this phase.

Before and after each test

Despite being a recent and still an optional formation, detox.beforeEach and detox.afterEach lifecycle functions are highly recommended to be called in your test setups.

The newer features (including test artifacts: video recordings, screenshots, logs) are not expected to work without those calls.

BREAKING CHANGE: Signatures of detox.beforeEach() and detox.afterEach() used to be (string, string, TestStatus), but in the new Detox version they expect an object like:
{ title: string; fullName: string; status: "running" | "passed" | "failed"; }.

TIP: This API is still apt to change in future, thus to minimize the risks, you are encouraged to switch to the built-in adapters for mocha and jest like in examples here: mocha adapter example, jest adapter example.

If nevertheless you use another test runner with Detox (not mocha and not jest), then you have to implement a logic similar to the one below. Futurewise, consider refactoring it to an adapter and sharing with Detox project (e.g. adapter for ava.js or tape):

let testSummary;

beforeEach(async function () {
  testSummary = {
    title: this.currentTest.title,
    fullName: this.currentTest.fullTitle(),
    status: 'running',
  };

 await detox.beforeEach(testSummary);
});

afterEach(async function () {
  testSummary.status = this.currentTest.state || 'failed';
  await detox.afterEach(testSummary);
});

Teardown

The cleanup phase should happen after all the tests have finished, can be initiated using detox.cleanup(). This is the phase where detox-server shuts down. The simulator will also shut itself down if --cleanup flag is added to detox test

after(async () => {
  await detox.cleanup();
});

Repeating Setup For All Tests

A good practice for testing in general is to have decoupled tests, meaning that each test has the same starting point, and the tests can run in any order and still produce the same results. We strongly encourage either restarting your application or restart react-native (if your application is built with it).

Reloading React Native

  beforeEach(async () => {
    await device.reloadReactNative();
  });

Reloading The Entire App

  beforeEach(async () => {
    await device.launchApp({newInstance: true});
  });