From 5387c45414ce31828510f4a7a11e67a3715d9d6e Mon Sep 17 00:00:00 2001 From: Salakar Date: Sat, 25 Aug 2018 13:57:57 +0100 Subject: [PATCH] [tests] misc readme --- tests/README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/tests/README.md b/tests/README.md index 6983a9df..e99e3f21 100755 --- a/tests/README.md +++ b/tests/README.md @@ -23,6 +23,8 @@ Our tests are powered by [Jet ✈️](https://github.com/invertase/jet). npm install -g detox-cli ``` +--- + ### Step 1: Install test project dependencies NPM install at project root and also inside tests directory. @@ -35,6 +37,8 @@ cd tests/ && npm i cd tests/ios && pod install --repo-update ``` +--- + ### Step 2: Start Build & Packager Scripts 1. First, start the build script to compile the library and watch for changes; @@ -55,6 +59,8 @@ cd tests/ && npm run packager-jet > ⚠️ Also ensure that all existing packagers are terminated and that you have no React Native debugger tabs open on your browsers. +--- + ### Step 3: Build Native App The first build for each platform will take a while. Subsequent builds are much much quicker ⚡️ @@ -73,7 +79,9 @@ cd tests/ && npm run build-android cd tests/ && npm run build-ios ``` -### Step 4: Run the tests +--- + +### Step 4: Finally, run the tests This action will launch a new simulator (if not already open) and run the tests on it. @@ -107,6 +115,8 @@ Coverage is output to the root directory of the project: `react-native-firebase/ open `react-native-firebase/coverage/lcov-report/index.html` in your browser after running tests to view coverage output. +--- + ### Running specific tests Mocha supports the `.only` syntax, e.g. instead of `describe(...) || it(...)` you can use `describe.only(...) || it.only(...)` to only run that specific context or test.