wip: cleanup detox test CLI command

BREAKING: deprecates --workers and --no-color options because they can be passed through to Jest runner already
wix · Apr 25, 2022 · 7c7f480 · 7c7f480
1 parent de932ac
commit 7c7f480
Show file tree

Hide file tree

Showing 28 changed files with 601 additions and 734 deletions.
diff --git a/detox/local-cli/test.js b/detox/local-cli/test.js
@@ -1,165 +1,34 @@
 // @ts-nocheck
-const cp = require('child_process');
-
-const _ = require('lodash');
-const whichSync = require('which').sync;
-const unparse = require('yargs-unparser');
-
 const { composeDetoxConfig } = require('../src/configuration');
-const { loadLastFailedTests } = require('../src/utils/lastFailedTests');
+const failedTestsService = require('../src/utils/lastFailedTests');
 const log = require('../src/utils/logger').child({ __filename });
-const { parse, quote } = require('../src/utils/shellQuote');
 
-const { printEnvironmentVariables } = require('./utils/misc');
-const { prependNodeModulesBinToPATH } = require('./utils/misc');
-const splitArgv = require('./utils/splitArgv');
-const { DETOX_ARGV_OVERRIDE_NOTICE, DEVICE_LAUNCH_ARGS_DEPRECATION } = require('./utils/warnings');
+const TestRunnerCommand = require('./testCommand/TestRunnerCommand');
 
 module.exports.command = 'test';
 module.exports.desc = 'Run your test suite with the test runner specified in package.json';
-module.exports.builder = require('./utils/testCommandArgs');
-module.exports.handler = async function test(argv) {
-  const { detoxArgs, runnerArgs } = splitArgv.detox(argv);
-  const { cliConfig, runnerConfig } = await composeDetoxConfig({ argv: detoxArgs });
-
-  const forwardedArgs = await prepareArgs({
-    cliConfig,
-    runnerConfig,
-    runnerArgs,
+module.exports.builder = require('./testCommand/builder');
+module.exports.middlewares = require('./testCommand/middlewares')({ log }).ordered;
+module.exports.handler = async function test({ detoxArgs, runnerArgs, specs }) {
+  const { cliConfig, deviceConfig, runnerConfig } = await composeDetoxConfig({ argv: detoxArgs });
+  const runnerCommand = new TestRunnerCommand({
+    // TODO: retrieve from __top IPC
+    failedTestsService,
+    log,
   });
 
-  if (detoxArgs['inspect-brk']) {
-    const runnerBinary = whichSync('jest', {
-      path: prependNodeModulesBinToPATH({ ...process.env }),
-    });
+  runnerCommand
+    .setDeviceConfig(deviceConfig)
+    .replicateCLIConfig(cliConfig)
+    .setRunnerConfig(runnerConfig)
+    .assignArgv(runnerArgs)
+    .setRetries(detoxArgs.retries)
+    .setSpecs(specs);
 
-    forwardedArgs.argv.$0 = `node --inspect-brk ${require.resolve(runnerBinary)}`;
-  } else {
-    forwardedArgs.argv.$0 = runnerConfig.testRunner;
+  if (detoxArgs['inspect-brk']) {
+    runnerCommand.enableDebugMode();
   }
 
-  await runTestRunnerWithRetries(forwardedArgs, {
-    retries: detoxArgs.retries,
-  });
+  await runnerCommand.execute();
 };
 
-module.exports.middlewares = [
-  function applyEnvironmentVariableAddendum(argv, yargs) {
-    if (process.env.DETOX_ARGV_OVERRIDE) {
-      log.warn(DETOX_ARGV_OVERRIDE_NOTICE);
-
-      return yargs.parse([
-        ...process.argv.slice(2),
-        ...parse(process.env.DETOX_ARGV_OVERRIDE),
-      ]);
-    }
-
-    return argv;
-  },
-
-  function warnDeviceAppLaunchArgsDeprecation(argv) {
-    if (argv['device-boot-args'] && process.argv.some(a => a.startsWith('--device-launch-args'))) {
-      log.warn(DEVICE_LAUNCH_ARGS_DEPRECATION);
-    }
-
-    return argv;
-  }
-];
-
-async function prepareArgs({ cliConfig, runnerArgs, runnerConfig }) {
-  const { specs, passthrough } = splitArgv.jest(runnerArgs);
-
-  const argv = _.omitBy({
-    color: !cliConfig.noColor && undefined,
-    config: runnerConfig.runnerConfig /* istanbul ignore next */ || undefined,
-    maxWorkers: cliConfig.workers || undefined,
-
-    ...passthrough,
-  }, _.isUndefined);
-
-  return {
-    argv,
-
-    env: _.omitBy({
-      DETOX_APP_LAUNCH_ARGS: cliConfig.appLaunchArgs,
-      DETOX_ARTIFACTS_LOCATION: cliConfig.artifactsLocation,
-      DETOX_CAPTURE_VIEW_HIERARCHY: cliConfig.captureViewHierarchy,
-      DETOX_CLEANUP: cliConfig.cleanup,
-      DETOX_CONFIGURATION: cliConfig.configuration,
-      DETOX_CONFIG_PATH: cliConfig.configPath,
-      DETOX_DEBUG_SYNCHRONIZATION: cliConfig.debugSynchronization,
-      DETOX_DEVICE_BOOT_ARGS: cliConfig.deviceBootArgs,
-      DETOX_DEVICE_NAME: cliConfig.deviceName,
-      DETOX_FORCE_ADB_INSTALL: cliConfig.forceAdbInstall,
-      DETOX_GPU: cliConfig.gpu,
-      DETOX_HEADLESS: cliConfig.headless,
-      DETOX_LOGLEVEL: cliConfig.loglevel,
-      DETOX_READ_ONLY_EMU: cliConfig.readonlyEmu,
-      DETOX_RECORD_LOGS: cliConfig.recordLogs,
-      DETOX_RECORD_PERFORMANCE: cliConfig.recordPerformance,
-      DETOX_RECORD_TIMELINE: cliConfig.recordTimeline,
-      DETOX_RECORD_VIDEOS: cliConfig.recordVideos,
-      DETOX_REPORT_SPECS: cliConfig.jestReportSpecs,
-      DETOX_REUSE: cliConfig.reuse,
-      DETOX_TAKE_SCREENSHOTS: cliConfig.takeScreenshots,
-      DETOX_USE_CUSTOM_LOGGER: cliConfig.useCustomLogger,
-    }, _.isUndefined),
-
-    specs: _.isEmpty(specs) && runnerConfig.specs ? [runnerConfig.specs] : specs,
-  };
-}
-
-function launchTestRunner({ argv, env, specs }) {
-  const { $0: command, ...restArgv } = argv;
-  const fullCommand = [
-    command,
-    quote(unparse(_.omitBy(restArgv, _.isUndefined))),
-    specs.join(' ')
-  ].filter(Boolean).join(' ');
-
-  log.info(printEnvironmentVariables(env) + fullCommand);
-
-  cp.execSync(fullCommand, {
-    stdio: 'inherit',
-    env: _({})
-      .assign(process.env)
-      .assign(env)
-      .omitBy(_.isUndefined)
-      .tap(prependNodeModulesBinToPATH)
-      .value()
-  });
-}
-
-async function runTestRunnerWithRetries(forwardedArgs, { keepLockFile, platform, retries }) {
-  let runsLeft = 1 + retries;
-  let launchError;
-
-  do {
-    try {
-      if (launchError) {
-        const list = forwardedArgs.specs.map((file, index) => `  ${index + 1}. ${file}`).join('\n');
-        log.error(
-          `There were failing tests in the following files:\n${list}\n\n` +
-          'Detox CLI is going to restart the test runner with those files...\n'
-        );
-      }
-
-      launchTestRunner(forwardedArgs);
-      launchError = null;
-    } catch (e) {
-      launchError = e;
-
-      const lastFailedTests = await loadLastFailedTests(); // TODO: retrieve from __top IPC
-      if (_.isEmpty(lastFailedTests)) {
-        throw e;
-      }
-
-      forwardedArgs.specs = lastFailedTests;
-      forwardedArgs.env.DETOX_RERUN_INDEX = 1 + (forwardedArgs.env.DETOX_RERUN_INDEX || 0);
-    }
-  } while (launchError && --runsLeft > 0);
-
-  if (launchError) {
-    throw launchError;
-  }
-}