detox 19.13.0 → 20.0.0

package/local-cli/init.js

@@ -1,47 +1,20 @@
 const fs = require('fs');
 const path = require('path');
+const util = require('util');
 
-const DetoxRuntimeError = require('../src/errors/DetoxRuntimeError');
-const log = require('../src/utils/logger').child({ __filename });
+const detox = require('../internals');
 
 const jestTemplates = require('./templates/jest');
-const mochaTemplates = require('./templates/mocha');
 
 let exitCode = 0;
 
 module.exports.command = 'init';
-module.exports.desc = 'Scaffold initial E2E test folder structure for a specified test runner';
-module.exports.builder = {
-  runner: {
-    alias: 'r',
-    demandOption: true,
-    describe: 'test runner name (supported values: mocha, jest)',
-    group: 'Configuration:',
-    default: 'jest',
-  }
-};
-
-module.exports.handler = async function init(argv) {
-  const { runner } = argv;
-
-  switch (runner) {
-    case 'mocha':
-      createMochaFolderE2E();
-      break;
-    case 'jest':
-      createJestFolderE2E();
-      break;
-    default:
-      throw new DetoxRuntimeError([
-        `Convenience scaffolding for \`${runner}\` test runner is not supported currently.\n`,
-        'Supported runners at the moment are: `mocha` and `jest`:',
-        '* detox init -r mocha',
-        '* detox init -r jest\n',
-        `If it is not a typo, and you plan to work with \`${runner}\` runner, then you have to create test setup files manually.`,
-        'HINT: Try running one of the commands above, look what it does, and take similar steps for your use case.',
-      ].join('\n'));
-  }
+module.exports.desc = 'Creates template files to get you started with Detox';
+module.exports.builder = {};
 
+module.exports.handler = async function init() {
+  createDetoxConfig();
+  createJestFolderE2E();
   process.exit(exitCode); // eslint-disable-line
 };
 
@@ -72,58 +45,74 @@ function createFile(filename, content) {
 
   try {
     fs.writeFileSync(filename, content);
-    log.info(`Created a file at path: ${filename}`);
+    detox.log.info(`Created a file at path: ${filename}`);
   } catch (err) {
     reportError({ err }, `Failed to create a file at path: ${filename}`);
   }
 }
 
-function createMochaFolderE2E() {
-  createFolder('e2e', {
-    '.mocharc.json': mochaTemplates.runnerConfig,
-    'init.js': mochaTemplates.initjs,
-    'firstTest.spec.js': mochaTemplates.firstTest
-  });
-
-  createFile('.detoxrc.json', JSON.stringify({
-    testRunner: 'mocha',
-    runnerConfig: 'e2e/.mocharc.json',
-    ...createDefaultConfigurations(),
-  }, null, 2));
-}
-
 function createJestFolderE2E() {
   createFolder('e2e', {
-    'config.json': jestTemplates.runnerConfig,
-    'environment.js': jestTemplates.environment,
-    'firstTest.e2e.js': jestTemplates.firstTest,
+    'jest.config.js': jestTemplates.runnerConfig,
+    'starter.test.js': jestTemplates.starter,
   });
+}
 
-  createFile('.detoxrc.json', JSON.stringify({
-    testRunner: 'jest',
-    runnerConfig: 'e2e/config.json',
-    skipLegacyWorkersInjection: true,
-    ...createDefaultConfigurations(),
-  }, null, 2));
+function createDetoxConfig() {
+  createFile('.detoxrc.js',
+    '/** @type {Detox.DetoxConfig} */\n' +
+    'module.exports = ' +
+    util.inspect(createDefaultConfigurations(), { compact: false, depth: Infinity }) +
+    ';\n'
+  );
 }
 
+/** @returns {Detox.DetoxConfig} */
 function createDefaultConfigurations() {
   return {
+    testRunner: {
+      args: {
+        $0: 'jest',
+        config: 'e2e/jest.config.js',
+      },
+      jest: {
+        setupTimeout: 120000,
+      },
+    },
     apps: {
-      ios: {
+      'ios.debug': {
         type: 'ios.app',
-        binaryPath: 'SPECIFY_PATH_TO_YOUR_APP_BINARY',
+        binaryPath: 'ios/build/Build/Products/Debug-iphonesimulator/YOUR_APP.app',
+        build: 'xcodebuild -workspace ios/YOUR_APP.xcworkspace -scheme YOUR_APP -configuration Debug -sdk iphonesimulator -derivedDataPath ios/build',
       },
-      android: {
+      'ios.release': {
+        type: 'ios.app',
+        binaryPath: 'ios/build/Build/Products/Release-iphonesimulator/YOUR_APP.app',
+        build: 'xcodebuild -workspace ios/YOUR_APP.xcworkspace -scheme YOUR_APP -configuration Release -sdk iphonesimulator -derivedDataPath ios/build',
+      },
+      'android.debug': {
+        type: 'android.apk',
+        binaryPath: 'android/app/build/outputs/apk/debug/app-debug.apk',
+        build: 'cd android ; ./gradlew assembleDebug assembleAndroidTest -DtestBuildType=debug ; cd -',
+        reversePorts: [8081],
+      },
+      'android.release': {
         type: 'android.apk',
-        binaryPath: 'SPECIFY_PATH_TO_YOUR_APP_BINARY',
+        binaryPath: 'android/app/build/outputs/apk/release/app-release.apk',
+        build: 'cd android ; ./gradlew assembleRelease assembleAndroidTest -DtestBuildType=release ; cd -',
       },
     },
     devices: {
       simulator: {
         type: 'ios.simulator',
         device: {
-          type: 'iPhone 11',
+          type: 'iPhone 12',
+        },
+      },
+      attached: {
+        type: 'android.attached',
+        device: {
+          adbName: '.*',
         },
       },
       emulator: {
@@ -134,19 +123,35 @@ function createDefaultConfigurations() {
       },
     },
     configurations: {
-      ios: {
+      'ios.sim.debug': {
         device: 'simulator',
-        app: 'ios',
+        app: 'ios.debug',
+      },
+      'ios.sim.release': {
+        device: 'simulator',
+        app: 'ios.release',
+      },
+      'android.att.debug': {
+        device: 'attached',
+        app: 'android.debug',
+      },
+      'android.att.release': {
+        device: 'attached',
+        app: 'android.release',
+      },
+      'android.emu.debug': {
+        device: 'emulator',
+        app: 'android.debug',
       },
-      android: {
+      'android.emu.release': {
         device: 'emulator',
-        app: 'android',
+        app: 'android.release',
       },
     },
   };
 }
 
 function reportError(...args) {
-  log.error(...args);
+  detox.log.error(...args);
   exitCode = 1;
 }

package/local-cli/rebuild-framework-cache.js

@@ -4,7 +4,7 @@ const path = require('path');
 
 const fs = require('fs-extra');
 
-const log = require('../src/utils/logger').child({ __filename });
+const log = require('../src/utils/logger').child({ cat: 'cli' });
 
 module.exports.command = 'rebuild-framework-cache';
 module.exports.desc = 'Rebuilds a cached Detox framework for the current environment in ~/Library/Detox. The cached framework is unique for each combination of Xcode and Detox version. (macOS only)';

package/local-cli/reset-lock-file.js

@@ -0,0 +1,16 @@
+const { log } = require('../internals');
+const DeviceRegistry = require('../src/devices/DeviceRegistry');
+const { getDetoxLibraryRootPath } = require('../src/utils/environment');
+
+
+module.exports.command = 'reset-lock-file';
+module.exports.desc = 'Resets all Detox lock files. Useful when you need to run multiple `detox test` commands in parallel with --keepLockFile.';
+
+module.exports.handler = async function resetLockFile() {
+  await Promise.all([
+    DeviceRegistry.forIOS().reset(),
+    DeviceRegistry.forAndroid().reset(),
+  ]);
+
+  log.info(`Cleaned lock files from: ${getDetoxLibraryRootPath()}`);
+};

package/local-cli/templates/jest.js

@@ -1,41 +1,19 @@
 const firstTestContent = require('./firstTestContent');
 
-const runnerConfig = `{
-    "maxWorkers": 1,
-    "testEnvironment": "./environment",
-    "testRunner": "jest-circus/runner",
-    "testTimeout": 120000,
-    "testRegex": "\\\\.e2e\\\\.js$",
-    "reporters": ["detox/runners/jest/streamlineReporter"],
-    "verbose": true
-}
+const runnerConfig = `\
+/** @type {import('@jest/types').Config.InitialOptions} */
+module.exports = {
+  rootDir: '..',
+  testMatch: ['<rootDir>/e2e/**/*.test.js'],
+  testTimeout: 120000,
+  maxWorkers: 1,
+  globalSetup: 'detox/runners/jest/globalSetup',
+  globalTeardown: 'detox/runners/jest/globalTeardown',
+  reporters: ['detox/runners/jest/reporter'],
+  testEnvironment: 'detox/runners/jest/testEnvironment',
+  verbose: true,
+};
 `;
 
-const environmentJsContent = `const {
-  DetoxCircusEnvironment,
-  SpecReporter,
-  WorkerAssignReporter,
-} = require('detox/runners/jest-circus');
-
-class CustomDetoxEnvironment extends DetoxCircusEnvironment {
-  constructor(config, context) {
-    super(config, context);
-
-    // Can be safely removed, if you are content with the default value (=300000ms)
-    this.initTimeout = 300000;
-
-    // This takes care of generating status logs on a per-spec basis. By default, Jest only reports at file-level.
-    // This is strictly optional.
-    this.registerListeners({
-      SpecReporter,
-      WorkerAssignReporter,
-    });
-  }
-}
-
-module.exports = CustomDetoxEnvironment;
-`;
-
-exports.environment = environmentJsContent;
-exports.firstTest = firstTestContent;
+exports.starter = firstTestContent;
 exports.runnerConfig = runnerConfig;

package/local-cli/test.js

@@ -1,290 +1,32 @@
-// @ts-nocheck
-const cp = require('child_process');
-const path = require('path');
+const detox = require('../internals');
 
-const _ = require('lodash');
-const whichSync = require('which').sync;
-const unparse = require('yargs-unparser');
-
-const { composeDetoxConfig } = require('../src/configuration');
-const DeviceRegistry = require('../src/devices/DeviceRegistry');
-const GenyDeviceRegistryFactory = require('../src/devices/allocation/drivers/android/genycloud/GenyDeviceRegistryFactory');
-const DetoxRuntimeError = require('../src/errors/DetoxRuntimeError');
-const { loadLastFailedTests, resetLastFailedTests } = require('../src/utils/lastFailedTests');
-const log = require('../src/utils/logger').child({ __filename });
-const { parse, quote } = require('../src/utils/shellQuote');
-
-const { readJestConfig } = require('./utils/jestInternals');
-const { getPlatformSpecificString, 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, deviceConfig, runnerConfig } = await composeDetoxConfig({ argv: detoxArgs });
-  const [platform] = deviceConfig.type.split('.');
-  const runner = deduceTestRunner(runnerConfig.testRunner);
-
-  const prepareArgs = choosePrepareArgs({
-    cliConfig,
-    runner,
-    detoxArgs,
-  });
-
-  const forwardedArgs = await prepareArgs({
-    cliConfig,
-    deviceConfig,
-    runnerConfig,
-    runnerArgs,
-    platform,
-  });
+module.exports.desc = 'Run your test suites with the test runner specified in the project\'s Detox config';
+module.exports.builder = require('./testCommand/builder');
+module.exports.middlewares = require('./testCommand/middlewares').default;
+
+module.exports.handler = async function test({ detoxArgs, runnerArgs }) {
+  try {
+    const opts = {
+      argv: detoxArgs,
+      testRunnerArgv: runnerArgs,
+      workerId: null,
+    };
+
+    const config = await detox.resolveConfig(opts);
+    if (!config.cli.inspectBrk) {
+      await detox.init(opts);
+    }
 
-  if (detoxArgs['inspect-brk']) {
-    const runnerBinary = whichSync(runner, {
-      path: prependNodeModulesBinToPATH({ ...process.env }),
+    const runnerCommand = new TestRunnerCommand({
+      config,
+      env: process.env,
     });
 
-    forwardedArgs.argv.$0 = `node --inspect-brk ${require.resolve(runnerBinary)}`;
-  } else {
-    forwardedArgs.argv.$0 = runnerConfig.testRunner;
+    await runnerCommand.execute();
+  } finally {
+    await detox.cleanup();
   }
-
-  const retries = runner === 'jest' ? detoxArgs.retries : 0;
-  await runTestRunnerWithRetries(forwardedArgs, {
-    keepLockFile: cliConfig.keepLockFile,
-    platform,
-    retries,
-  });
 };
-
-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;
-  }
-];
-
-function choosePrepareArgs({ cliConfig, detoxArgs, runner }) {
-  if (runner === 'mocha') {
-    if (cliConfig.workers) {
-      log.warn('Cannot use -w, --workers. Parallel test execution is only supported with Jest');
-    }
-
-    if (detoxArgs.retries > 0) {
-      log.warn('Cannot use -R, --retries. The test retry mechanism is only supported with Jest runner');
-    }
-
-    if (cliConfig.recordTimeline) {
-      log.warn('Cannot use --record-timeline. This artifact type is only supported with Jest runner');
-    }
-
-    return prepareMochaArgs;
-  }
-
-  if (runner === 'jest') {
-    return prepareJestArgs;
-  }
-
-  throw new DetoxRuntimeError({
-    message: `"${runner}" is not supported in Detox CLI tools.`,
-    hint: `You can still run your tests with the runner's own CLI tool`
-  });
-}
-
-function deduceTestRunner(command) {
-  if (command.includes('mocha')) {
-    return 'mocha';
-  }
-
-  if (command.includes('jest')) {
-    return 'jest';
-  }
-
-  return command;
-}
-
-function prepareMochaArgs({ cliConfig, runnerArgs, runnerConfig, platform }) {
-  const { specs, passthrough } = splitArgv.mocha(runnerArgs);
-  const configParam = path.extname(runnerConfig.runnerConfig) === '.opts'
-    ? 'opts'
-    : 'config';
-
-  const platformFilter = getPlatformSpecificString(platform);
-
-  return {
-    argv: {
-      [configParam]: runnerConfig.runnerConfig /* istanbul ignore next */ || undefined,
-      cleanup: Boolean(cliConfig.cleanup) || undefined,
-      colors: !cliConfig.noColor && undefined,
-      configuration: cliConfig.configuration || undefined,
-      gpu: cliConfig.gpu || undefined,
-      // TODO: check if we can --grep from user
-      grep: platformFilter || undefined,
-      invert: Boolean(platformFilter) || undefined,
-      headless: Boolean(cliConfig.headless) || undefined,
-      loglevel: cliConfig.loglevel || undefined,
-      reuse: cliConfig.reuse || undefined,
-      'artifacts-location': cliConfig.artifactsLocation || undefined,
-      'config-path': cliConfig.configPath /* istanbul ignore next */ || undefined,
-      'debug-synchronization': isFinite(cliConfig.debugSynchronization) ? cliConfig.debugSynchronization : undefined,
-      'device-name': cliConfig.deviceName || undefined,
-      'force-adb-install': platform === 'android' && cliConfig.forceAdbInstall || undefined,
-      'record-logs': cliConfig.recordLogs || undefined,
-      'record-performance': cliConfig.recordPerformance || undefined,
-      'record-videos': cliConfig.recordVideos || undefined,
-      'take-screenshots': cliConfig.takeScreenshots || undefined,
-      'capture-view-hierarchy': cliConfig.captureViewHierarchy || undefined,
-      'use-custom-logger': cliConfig.useCustomLogger && 'true' || undefined,
-
-      ...passthrough,
-    },
-    env: _.omitBy({
-      DETOX_APP_LAUNCH_ARGS: cliConfig.appLaunchArgs,
-      DETOX_DEVICE_BOOT_ARGS: cliConfig.deviceBootArgs,
-    }, _.isUndefined),
-    specs: _.isEmpty(specs) ? [runnerConfig.specs] : specs,
-  };
-}
-
-async function prepareJestArgs({ cliConfig, deviceConfig, runnerArgs, runnerConfig, platform }) {
-  const { specs, passthrough } = splitArgv.jest(runnerArgs);
-  const platformFilter = getPlatformSpecificString(platform);
-
-  const argv = _.omitBy({
-    color: !cliConfig.noColor && undefined,
-    config: runnerConfig.runnerConfig /* istanbul ignore next */ || undefined,
-    testNamePattern: platformFilter ? `^((?!${platformFilter}).)*$` : undefined,
-    maxWorkers: cliConfig.workers || (runnerConfig.skipLegacyWorkersInjection ? undefined : 1),
-
-    ...passthrough,
-  }, _.isUndefined);
-
-  const hasMultipleWorkers = runnerConfig.skipLegacyWorkersInjection
-    ? (await readJestConfig(argv)).globalConfig.maxWorkers > 1
-    : cliConfig.workers > 1;
-
-  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: platform === 'android' ? cliConfig.forceAdbInstall : undefined,
-      DETOX_GPU: cliConfig.gpu,
-      DETOX_HEADLESS: cliConfig.headless,
-      DETOX_LOGLEVEL: cliConfig.loglevel,
-      DETOX_READ_ONLY_EMU: deviceConfig.type === 'android.emulator' && hasMultipleWorkers ? true : undefined,
-      DETOX_RECORD_LOGS: cliConfig.recordLogs,
-      DETOX_RECORD_PERFORMANCE: cliConfig.recordPerformance,
-      DETOX_RECORD_TIMELINE: cliConfig.recordTimeline,
-      DETOX_RECORD_VIDEOS: cliConfig.recordVideos,
-      DETOX_REPORT_SPECS: _.isUndefined(cliConfig.jestReportSpecs)
-        ? !hasMultipleWorkers
-        : `${cliConfig.jestReportSpecs}` === 'true',
-      DETOX_REUSE: cliConfig.reuse,
-      DETOX_START_TIMESTAMP: Date.now(),
-      DETOX_TAKE_SCREENSHOTS: cliConfig.takeScreenshots,
-      DETOX_USE_CUSTOM_LOGGER: cliConfig.useCustomLogger,
-    }, _.isUndefined),
-
-    specs: _.isEmpty(specs) ? [runnerConfig.specs] : specs,
-  };
-}
-
-async function resetLockFile({ platform }) {
-  if (platform === 'ios') {
-    await DeviceRegistry.forIOS().reset();
-  }
-
-  if (platform === 'android') {
-    await DeviceRegistry.forAndroid().reset();
-    await GenyDeviceRegistryFactory.forGlobalShutdown().reset();
-  }
-}
-
-function launchTestRunner({ argv, env, specs }) {
-  const { $0: command, ...restArgv } = argv;
-  const fullCommand = [
-    command,
-    quote(unparse(_.omitBy(restArgv, _.isUndefined))),
-    specs.join(' ')
-  ].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'
-        );
-      }
-
-      if (!keepLockFile) {
-        await resetLockFile({ platform });
-      }
-
-      await resetLastFailedTests();
-      launchTestRunner(forwardedArgs);
-      launchError = null;
-    } catch (e) {
-      launchError = e;
-
-      const lastFailedTests = await loadLastFailedTests();
-      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;
-  }
-}