To get your Detox tests up and running, you'll need to install some global dependencies:
- Install the latest version of Homebrew
- Make sure you have Node installed (at least 8.6.0). If you don't:
If you use NVM:
nvm install nodeOr if you'd prefer to install directly from Homebrew
brew update && brew install node- Install `applesimutils, which will allow Detox to communicate with the iOS simulator:
brew tap wix/brew && brew install applesimutils- Install the Detox CLI
yarn global add detox-cliYou'll need to set the Detox configuration settings in package.json to run Detox tests on a simulator name + OS version that is installed in your environment.
In Xcode, open Window -> Devices and Simulators
Tap the Simulators tab at the top of the modal.
On the left hand side of the modal screen, select iPhone 11 (or some other Simulator)
Note the iOS version value displayed on the left hand side below the name of the device being simulated. For example "iOS 13.2.2 (17B102)" This is the value displayed if iPhone 11 is selected in the left hand list under iOS.
Set the iOS value that matches the simulator to be tested in the Detox configuration settings found in the package.json generated for your new project.
Example:
"device": { "name": "iPhone 11", "os": "iOS 13.2" }
NOTE: as of October 2021, do not set the iOS value to 15.0 or higher, or a Detox crash may occur. This is a Detox issue that is well documented and should be fixed soon.
We've gotten you started with ./e2e/firstTest.spec.js, which tests that the two main example screens render properly.
Note that in order to pick up elements by ID, we've added the testID prop to the component.
- Start the packager
yarn start
(Expo-only note: for testing production code, start the packager with yarn start --no-dev --minify)
- Run the app
In a separate terminal window from the packager:
yarn build:e2e
(Expo-only note: this is unnecessary for Expo apps)
- Run the tests
yarn test:e2e
For more information, make sure to check out the official Detox Docs