Added Parallel Test Execution documentation.

wix · Jun 27, 2018 · 95ad14b · 95ad14b
1 parent bd11fc5
commit 95ad14b
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 0 deletions.
diff --git a/docs/Guide.ParallelTestExecution.md b/docs/Guide.ParallelTestExecution.md
@@ -0,0  1,38 @@
 ---
 id: Guide.ParallelTestExecution
 title: Parallel Test Execution
 ---
 
 ## Parallel Test Execution
 Detox can leverage multi worker support of JS test runners ([Jest](http://jestjs.io/docs/en/cli#maxworkers-num), [AVA](https://github.com/avajs/ava#process-isolation), etc.).
 
 By default `detox test` will run the test runner with one worker (it will pass `--maxWorkers=1` to Jest cli, Mocha is unaffected). Worker count can be controlled by adding `--workers n` to `detox test`, read more in [detox-cli section](APIRef.DetoxCLI.md#test).
 
 #### Lock file
 Simulators/emulators run on a different process, outside of node, and require some sort of lock mechanism to make sure only one process controlls a simulator in a given time. Therefore, Detox 7.4.0 introduced `device.registry.state.lock`, a lock file controlled by Detox, that registers all in-use simulators.
 
 The lock file location is determined by the OS, and [defined here](https://github.com/wix/detox/blob/master/detox/src/utils/appdatapath.js).
 
 **MacOS:** <br>
 `~/Library/Detox/device.registry.state.lock`<br>
 **Linux:** <br>
 `~/.local/share/Detox/device.registry.state.lock`<br>
 **Windows:** <br>
 `$LOCALAPPDATA/data/Detox/device.registry.state.lock`<br>
 or<br>
 `$USERPROFILE/Application Data/Detox/device.registry.state.lock`
 
 #### Device creation
 While running with multiple workers, Detox might not have an available simulator for every worker.
 If no simulator is available for that worker, the worker will create one with the name `{name}-Detox`.
 
 ### IMPORTANT NOTE
 Each worker is responsible of removing the deviceId from the list in `device.registry.state.lock`. Exiting a test runner abruptly (using ctrl c / ⌘ c) will not give the worker a chance to deregister the device from the lock file, resulting in an inconsistent state, which ca result in creation of unnecessary new simulators. 
 
 * detox-cli makes sure `device.registry.state.lock` is cleaned whenever it executes.
 * If you use Detox without detox-cli make sure you delete or reset the lock file before running tests.
 
 	```sh
 	echo "[]" > ~/Library/Detox/device.registry.state.lock
 	```
 
diff --git a/docs/README.md b/docs/README.md
@@ -44,6  44,7 @@ sidebar_label: Overview
 - [Advanced Mocking With Detox](Guide.Mocking.md)
 - [Migration Between Detox Versions](Guide.Migration.md)
 - [Use Jest as Test Runner](Guide.Jest.md)
 - [Parallel Test Execution](Guide.ParallelTestExecution.md)
 
 ## Under The Hood