Allow passthrough arguments using DETOX_TEST_RUNNER_FLAGS

Author: Edward Drapkin

detox/local-cli/detox-test.js

@@ -89,6 +89,14 @@ function run() {
   }
 }
 
+function collectExtraArgs() {
+  if (process.env.DETOX_TEST_RUNNER_FLAGS) {
+    return (process.env.DETOX_TEST_RUNNER_FLAGS + '').trim();
+  } else {
+    return '';
+  }
+}
+
 function getConfigFor(keys, fallback) {
   for (let i = 0; i < keys.length; i++) {
     const key = keys[i];
@@ -123,7 +131,7 @@ function runMocha() {
   const binPath = path.join('node_modules', '.bin', 'mocha');
   const command = `${binPath} ${testFolder} ${configFile} ${configuration} ${loglevel} ${color} ` +
     `${cleanup} ${reuse} ${debugSynchronization} ${platformString} ${headless} ` +
-    `${logs} ${screenshots} ${videos} ${artifactsLocation} ${deviceName}`;
+    `${logs} ${screenshots} ${videos} ${artifactsLocation} ${deviceName} ${collectExtraArgs()}`;
 
   console.log(command);
   cp.execSync(command, {stdio: 'inherit'});
@@ -135,7 +143,7 @@ function runJest() {
   const platformString = platform ? shellQuote(`--testNamePattern=^((?!${getPlatformSpecificString(platform)}).)*$`) : '';
   const binPath = path.join('node_modules', '.bin', 'jest');
   const color = program.color ? '' : ' --no-color';
-  const command = `${binPath} ${testFolder} ${configFile}${color} --maxWorkers=${program.workers} ${platformString}`;
+  const command = `${binPath} ${testFolder} ${configFile}${color} --maxWorkers=${program.workers} ${platformString} ${collectExtraArgs()}`;
   const detoxEnvironmentVariables = {
     configuration: program.configuration,
     loglevel: program.loglevel,

docs/APIRef.DetoxCLI.md

@@ -62,6 +62,7 @@ Initiating your test suite
 | -w, --workers                                 | [iOS Only] Specifies number of workers the test runner should spawn, requires a test runner with parallel execution support (Detox CLI currently supports Jest) |
 | -n, --device-name [name]                                 | Override the device name specified in a configuration. Useful for running a single build configuration on multiple devices. |
 > NOTE: such log levels as `silly` and `wss` are deprecated since detox@8.1.0 and will be removed in 9.0.0.
+> NOTE: extra arguments to the test runner (either Jest or Mocha) can be passed through using the DETOX_TEST_RUNNER_FLAGS environment variable
 
 ### build
 Run a command defined in 'configuration.build'