detox 20.0.11-prerelease.0 → 20.0.13-prerelease.0

package/local-cli/test.test.js

@@ -8,6 +8,8 @@ jest.mock('../src/devices/DeviceRegistry');
 jest.mock('../src/devices/allocation/drivers/android/genycloud/GenyDeviceRegistryFactory');
 jest.mock('./utils/jestInternals');
 
+const cp = require('child_process');
+const cpSpawn = cp.spawn;
 const os = require('os');
 const path = require('path');
 
@@ -28,6 +30,10 @@ describe('CLI', () => {
   let GenyDeviceRegistryFactory;
   let jestInternals;
 
+  afterEach(() => {
+    cp.spawn = cpSpawn;
+  });
+
   beforeEach(() => {
     _cliCallDump = undefined;
     _env = process.env;
@@ -46,6 +52,7 @@ describe('CLI', () => {
           $0: os.platform() === 'win32' ? `node ${executable}` : executable,
           config: 'e2e/config.json'
         },
+        forwardEnv: true,
       },
       configurations: {
         single: {
@@ -108,11 +115,14 @@ describe('CLI', () => {
     });
 
     test('should not override environment variables', () => {
-      expect(cliCall().env).toEqual({ DETOX_CONFIG_SNAPSHOT_PATH: expect.any(String) });
+      expect(cliCall().env).toEqual({
+        DETOX_CONFIG_PATH: expect.any(String),
+        DETOX_CONFIG_SNAPSHOT_PATH: expect.any(String)
+      });
     });
 
     test('should hint essential environment variables', () => {
-      expect(cliCall().fullCommand).toMatch(/^DETOX_CONFIG_PATH=.*\bexecutable/);
+      expect(cliCall().fullCommand).toMatch(/\bDETOX_CONFIG_PATH=.*\bexecutable\b/);
     });
   });
 
@@ -129,7 +139,7 @@ describe('CLI', () => {
 
   test.each([['-l'], ['--loglevel']])('%s <value> should be passed as environment variable', async (__loglevel) => {
     await run(__loglevel, 'trace');
-    expect(cliCall().env).not.toHaveProperty('DETOX_LOGLEVEL');
+    expect(cliCall().env).toHaveProperty('DETOX_LOGLEVEL');
     expect(cliCall().fullCommand).toMatch(/ DETOX_LOGLEVEL="trace" /);
   });
 
@@ -139,11 +149,28 @@ describe('CLI', () => {
   });
 
   test.each([['-R'], ['--retries']])('%s <value> should execute unsuccessful run N extra times', async (__retries) => {
+    function toTestResult(testFilePath) {
+      return {
+        testFilePath,
+        success: false,
+        isPermanentFailure: false,
+      };
+    }
+
     const context = require('../internals');
-    context.session.testFilesToRetry = ['e2e/failing1.test.js', 'e2e/failing2.test.js'];
-    context.session.testFilesToRetry.splice = jest.fn()
-      .mockImplementationOnce(() => ['e2e/failing1.test.js', 'e2e/failing2.test.js'])
-      .mockImplementationOnce(() => ['e2e/failing2.test.js']);
+
+    jest.spyOn(cp, 'spawn')
+      .mockImplementationOnce((...args) => {
+        context.session.testResults = ['e2e/failing1.test.js', 'e2e/failing2.test.js'].map(toTestResult);
+        return cpSpawn(...args);
+      })
+      .mockImplementationOnce((...args) => {
+        context.session.testResults = ['e2e/failing2.test.js'].map(toTestResult);
+        return cpSpawn(...args);
+      })
+      .mockImplementationOnce((...args) => {
+        return cpSpawn(...args);
+      });
 
     mockExitCode(1);
 
@@ -154,18 +181,35 @@ describe('CLI', () => {
     expect(cliCall(2).argv).toEqual([expect.stringMatching(/executable$/), '--config', 'e2e/config.json', 'e2e/failing2.test.js']);
   });
 
-  test.each([['-R'], ['--retries']])('%s <value> should bail if has permanently failed tests', async (__retries) => {
-    const context = require('../internals');
-    context.session.failedTestFiles = ['e2e/failing1.test.js'];
-    context.session.testFilesToRetry = ['e2e/failing2.test.js'];
+  describe('when there are permanently failed tests', () => {
+    beforeEach(() => {
+      const context = require('../internals');
+      context.session.testResults = ['e2e/failing1.test.js', 'e2e/failing2.test.js'].map((testFilePath, index) => ({
+        testFilePath,
+        success: false,
+        isPermanentFailure: index > 0,
+      }));
 
-    mockExitCode(1);
+      mockExitCode(1);
+    });
 
-    await run(__retries, 2).catch(_.noop);
+    test.each([['-R'], ['--retries']])('%s <value> should not bail by default', async (__retries) => {
+      await run(__retries, 2).catch(_.noop);
 
-    expect(cliCall(0).env).not.toHaveProperty('DETOX_RERUN_INDEX');
-    expect(cliCall(0).argv).toEqual([expect.stringMatching(/executable$/), '--config', 'e2e/config.json']);
-    expect(cliCall(1)).toBe(null);
+      expect(cliCall(0).argv).toEqual([expect.stringMatching(/executable$/), '--config', 'e2e/config.json']);
+      expect(cliCall(1).env).not.toHaveProperty('DETOX_RERUN_INDEX');
+      expect(cliCall(1).argv).toEqual([expect.stringMatching(/executable$/), '--config', 'e2e/config.json', 'e2e/failing1.test.js']);
+      // note that it does not take the permanently failed test
+    });
+
+    test.each([['-R'], ['--retries']])('%s <value> should bail if configured', async (__retries) => {
+      detoxConfig.testRunner.bail = true;
+      await run(__retries, 2).catch(_.noop);
+
+      expect(cliCall(0).env).not.toHaveProperty('DETOX_RERUN_INDEX');
+      expect(cliCall(0).argv).toEqual([expect.stringMatching(/executable$/), '--config', 'e2e/config.json']);
+      expect(cliCall(1)).toBe(null);
+    });
   });
 
   test.each([['-R'], ['--retries']])('%s <value> should not restart test runner if there are no failing tests paths', async (__retries) => {
@@ -178,7 +222,11 @@ describe('CLI', () => {
 
   test.each([['-R'], ['--retries']])('%s <value> should retain -- <...explicitPassthroughArgs>', async (__retries) => {
     const context = require('../internals');
-    context.session.testFilesToRetry = ['tests/failing.test.js'];
+    context.session.testResults = [{
+      testFilePath: 'tests/failing.test.js',
+      success: false,
+      isPermanentFailure: false,
+    }];
 
     mockExitCode(1);
 
@@ -190,111 +238,111 @@ describe('CLI', () => {
 
   test.each([['-r'], ['--reuse']])('%s <value> should be passed as environment variable', async (__reuse) => {
     await run(__reuse);
-    expect(cliCall().env).not.toHaveProperty('DETOX_REUSE');
+    expect(cliCall().env).toHaveProperty('DETOX_REUSE');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_REUSE=true /);
   });
 
   test.each([['-u'], ['--cleanup']])('%s <value> should be passed as environment variable', async (__cleanup) => {
     await run(__cleanup);
-    expect(cliCall().env).not.toHaveProperty('DETOX_CLEANUP');
+    expect(cliCall().env).toHaveProperty('DETOX_CLEANUP');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_CLEANUP=true /);
   });
 
   test.each([['-d'], ['--debug-synchronization']])('%s <value> should be passed as environment variable', async (__debug_synchronization) => {
     await run(__debug_synchronization, 5000);
-    expect(cliCall().env).not.toHaveProperty('DETOX_DEBUG_SYNCHRONIZATION');
+    expect(cliCall().env).toHaveProperty('DETOX_DEBUG_SYNCHRONIZATION');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_DEBUG_SYNCHRONIZATION=5000 /);
   });
 
   test.each([['-d'], ['--debug-synchronization']])('%s <value> should be passed as 0 when given false', async (__debug_synchronization) => {
     await run(__debug_synchronization, false);
-    expect(cliCall().env).not.toHaveProperty('DETOX_DEBUG_SYNCHRONIZATION');
+    expect(cliCall().env).toHaveProperty('DETOX_DEBUG_SYNCHRONIZATION');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_DEBUG_SYNCHRONIZATION=0 /);
   });
 
   test.each([['-d'], ['--debug-synchronization']])('%s <value> should have default value = 3000', async (__debug_synchronization) => {
     await run(`${__debug_synchronization}`);
-    expect(cliCall().env).not.toHaveProperty('DETOX_DEBUG_SYNCHRONIZATION');
+    expect(cliCall().env).toHaveProperty('DETOX_DEBUG_SYNCHRONIZATION');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_DEBUG_SYNCHRONIZATION=3000 /);
   });
 
   test.each([['-a'], ['--artifacts-location']])('%s <value> should be passed as environment variable', async (__artifacts_location) => {
     await run(__artifacts_location, '/tmp');
-    expect(cliCall().env).not.toHaveProperty('DETOX_ARTIFACTS_LOCATION');
+    expect(cliCall().env).toHaveProperty('DETOX_ARTIFACTS_LOCATION');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_ARTIFACTS_LOCATION="\/tmp" /);
   });
 
   test('--record-logs <value> should be passed as environment variable', async () => {
     await run('--record-logs', 'all');
-    expect(cliCall().env).not.toHaveProperty('DETOX_RECORD_LOGS');
+    expect(cliCall().env).toHaveProperty('DETOX_RECORD_LOGS');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_RECORD_LOGS="all" /);
   });
 
   test('--take-screenshots <value> should be passed as environment variable', async () => {
     await run('--take-screenshots', 'failing');
-    expect(cliCall().env).not.toHaveProperty('DETOX_TAKE_SCREENSHOTS');
+    expect(cliCall().env).toHaveProperty('DETOX_TAKE_SCREENSHOTS');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_TAKE_SCREENSHOTS="failing" /);
   });
 
   test('--record-videos <value> should be passed as environment variable', async () => {
     await run('--record-videos', 'failing');
-    expect(cliCall().env).not.toHaveProperty('DETOX_RECORD_VIDEOS');
+    expect(cliCall().env).toHaveProperty('DETOX_RECORD_VIDEOS');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_RECORD_VIDEOS="failing" /);
   });
 
   test('--record-performance <value> should be passed as environment variable', async () => {
     await run('--record-performance', 'all');
-    expect(cliCall().env).not.toHaveProperty('DETOX_RECORD_PERFORMANCE');
+    expect(cliCall().env).toHaveProperty('DETOX_RECORD_PERFORMANCE');
     expect(cliCall().fullCommand).toMatch(/\DETOX_RECORD_PERFORMANCE="all" /);
   });
 
   test('--capture-view-hierarchy <value> should be passed as environment variable', async () => {
     await run('--capture-view-hierarchy', 'enabled');
-    expect(cliCall().env).not.toHaveProperty('DETOX_CAPTURE_VIEW_HIERARCHY');
+    expect(cliCall().env).toHaveProperty('DETOX_CAPTURE_VIEW_HIERARCHY');
     expect(cliCall().fullCommand).toMatch(/\DETOX_CAPTURE_VIEW_HIERARCHY="enabled" /);
   });
 
   test('--jest-report-specs, set explicitly, should be passed as an environment variable', async () => {
     await run('--jest-report-specs');
-    expect(cliCall().env).not.toHaveProperty('DETOX_REPORT_SPECS');
+    expect(cliCall().env).toHaveProperty('DETOX_REPORT_SPECS');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_REPORT_SPECS=true /);
   });
 
   test.each([['-H'], ['--headless']])('%s <value> should be passed as environment variable', async (__headless) => {
     await run(__headless);
-    expect(cliCall().env).not.toHaveProperty('DETOX_HEADLESS');
+    expect(cliCall().env).toHaveProperty('DETOX_HEADLESS');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_HEADLESS=true /);
   });
 
   test('--gpu <value> should be passed as environment variable', async () => {
     await run('--gpu', 'angle_indirect');
-    expect(cliCall().env).not.toHaveProperty('DETOX_GPU');
+    expect(cliCall().env).toHaveProperty('DETOX_GPU');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_GPU="angle_indirect" /);
   });
 
   test('--device-boot-args should be passed as an environment variable (without deprecation warnings)', async () => {
     await run('--device-boot-args="--verbose"');
-    expect(cliCall().env).not.toHaveProperty('DETOX_DEVICE_BOOT_ARGS');
+    expect(cliCall().env).toHaveProperty('DETOX_DEVICE_BOOT_ARGS');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_DEVICE_BOOT_ARGS="--verbose" /);
     expect(logger().warn).not.toHaveBeenCalledWith(DEVICE_LAUNCH_ARGS_DEPRECATION);
   });
 
   test('--device-launch-args should serve as a deprecated alias to --device-boot-args', async () => {
     await run(`--device-launch-args="--verbose"`);
-    expect(cliCall().env).not.toHaveProperty('DETOX_DEVICE_BOOT_ARGS');
+    expect(cliCall().env).toHaveProperty('DETOX_DEVICE_BOOT_ARGS');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_DEVICE_BOOT_ARGS="--verbose" /);
     expect(logger().warn).toHaveBeenCalledWith(DEVICE_LAUNCH_ARGS_DEPRECATION);
   });
 
   test('--app-launch-args should be passed as an environment variable', async () => {
     await run(`--app-launch-args="--debug yes"`);
-    expect(cliCall().env).not.toHaveProperty('DETOX_APP_LAUNCH_ARGS');
+    expect(cliCall().env).toHaveProperty('DETOX_APP_LAUNCH_ARGS');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_APP_LAUNCH_ARGS="--debug yes" /);
   });
 
   test('--use-custom-logger false should be prevent passing environment variable', async () => {
     await run(`--use-custom-logger=false`);
-    expect(cliCall().env).not.toHaveProperty('DETOX_USE_CUSTOM_LOGGER');
+    expect(cliCall().env).toHaveProperty('DETOX_USE_CUSTOM_LOGGER');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_USE_CUSTOM_LOGGER=false /);
   });
 
@@ -308,13 +356,13 @@ describe('CLI', () => {
   test('--force-adb-install should be passed as environment variable', async () => {
     singleConfig().device.type = 'android.emulator';
     await run(`--force-adb-install`);
-    expect(cliCall().env).not.toHaveProperty('DETOX_FORCE_ADB_INSTALL');
+    expect(cliCall().env).toHaveProperty('DETOX_FORCE_ADB_INSTALL');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_FORCE_ADB_INSTALL=true /);
   });
 
   test.each([['-n'], ['--device-name']])('%s <value> should be passed as environment variable', async (__device_name) => {
     await run(__device_name, 'TheDevice');
-    expect(cliCall().env).not.toHaveProperty('DETOX_DEVICE_NAME');
+    expect(cliCall().env).toHaveProperty('DETOX_DEVICE_NAME');
     expect(cliCall().fullCommand).toMatch(/\bDETOX_DEVICE_NAME="TheDevice" /);
   });
 

package/local-cli/testCommand/TestRunnerCommand.js

@@ -13,43 +13,20 @@ const { escapeSpaces } = require('../../src/utils/shellUtils');
 class TestRunnerCommand {
   constructor() {
     this._argv = {};
-    this._env = {};
+    this._cli2env = {};
     this._envHint = {};
+    this._envFwd = {};
     this._retries = 0;
     /** @type {Detox.DetoxDeviceConfig} */
     this._deviceConfig = null;
   }
 
-  /**
-   * @param {Detox.DetoxDeviceConfig} config
-   * @returns {this}
-   */
-  setDeviceConfig(config) {
-    this._deviceConfig = config;
-
-    return this;
-  }
-
-  /**
-   * @param {Detox.DetoxTestRunnerConfig} config
-   * @returns {this}
-   */
-  setRunnerConfig(config) {
-    this._argv = config.args;
-    this._retries = config.inspectBrk ? 0 : config.retries;
-    if (config.inspectBrk || config.forwardEnv) {
-      this._env = this._envHint;
-    }
-
-    return this;
-  }
-
   /**
    * @param {Partial<Readonly<DetoxInternals.CLIConfig>>} cliConfig
    * @returns {this}
    */
   replicateCLIConfig(cliConfig) {
-    this._envHint = _.omitBy({
+    this._cli2env = _.omitBy({
       DETOX_APP_LAUNCH_ARGS: cliConfig.appLaunchArgs,
       DETOX_ARTIFACTS_LOCATION: cliConfig.artifactsLocation,
       DETOX_CAPTURE_VIEW_HIERARCHY: cliConfig.captureViewHierarchy,
@@ -77,6 +54,37 @@ class TestRunnerCommand {
       DETOX_USE_CUSTOM_LOGGER: cliConfig.useCustomLogger,
     }, _.isUndefined);
 
+    this._envHint = _(process.env)
+      .mapKeys((_value, key) => key.toUpperCase())
+      .pickBy((_value, key) => key.startsWith('DETOX_'))
+      .omit(['DETOX_CONFIG_SNAPSHOT_PATH'])
+      .value();
+
+    return this;
+  }
+
+  /**
+   * @param {Detox.DetoxDeviceConfig} config
+   * @returns {this}
+   */
+  setDeviceConfig(config) {
+    this._deviceConfig = config;
+
+    return this;
+  }
+
+  /**
+   * @param {Detox.DetoxTestRunnerConfig} config
+   * @returns {this}
+   */
+  setRunnerConfig(config) {
+    this._argv = config.args;
+    this._retries = config.inspectBrk ? 0 : config.retries;
+    if (config.forwardEnv) {
+      this._envFwd = this._cli2env;
+      Object.assign(this._envHint, this._cli2env);
+    }
+
     return this;
   }
 
@@ -99,13 +107,20 @@ class TestRunnerCommand {
       } catch (e) {
         launchError = e;
 
-        const { failedTestFiles, testFilesToRetry } = detox.session;
-        if (!_.isEmpty(failedTestFiles) || _.isEmpty(testFilesToRetry)) {
+        const failedTestFiles = detox.session.testResults.filter(r => !r.success);
+
+        const { bail } = detox.config.testRunner;
+        if (bail && failedTestFiles.some(r => r.isPermanentFailure)) {
+          throw e;
+        }
+
+        const testFilesToRetry = failedTestFiles.filter(r => !r.isPermanentFailure).map(r => r.testFilePath);
+        if (_.isEmpty(testFilesToRetry)) {
           throw e;
         }
 
         if (--runsLeft > 0) {
-          this._argv._ = testFilesToRetry.splice(0, Infinity);
+          this._argv._ = testFilesToRetry;
           // @ts-ignore
           detox.session.testSessionIndex++; // it is always a primary context, so we can update it
         }
@@ -129,7 +144,7 @@ class TestRunnerCommand {
         stdio: 'inherit',
         env: _({})
           .assign(process.env)
-          .assign(this._env)
+          .assign(this._envFwd)
           .omitBy(_.isUndefined)
           .tap(prependNodeModulesBinToPATH)
           .value()

package/local-cli/utils/jestInternals.js

@@ -4,6 +4,7 @@ const path = require('path');
 
 const _ = require('lodash');
 const resolveFrom = require('resolve-from');
+const semver = require('semver');
 
 const { DetoxRuntimeError } = require('../../src/errors');
 
@@ -50,7 +51,9 @@ function resolveJestCliArgs() {
 
   try {
     const jestCliManifest = resolveJestDependency(jestLocation, 'jest-cli/package.json');
-    const argsJsFile = path.join(path.dirname(jestCliManifest), 'build/cli/args.js');
+    const jestCliVersion = require(jestCliManifest).version;
+    const argsJsFilePath = semver.gt(jestCliVersion, '29.1.2') ? 'build/args.js' : 'build/cli/args.js';
+    const argsJsFile = path.join(path.dirname(jestCliManifest), argsJsFilePath);
 
     return require(argsJsFile);
   } catch (e) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "detox",
   "description": "E2E tests and automation for mobile",
-  "version": "20.0.11-prerelease.0",
+  "version": "20.0.13-prerelease.0",
   "bin": {
     "detox": "local-cli/cli.js"
   },
@@ -92,7 +92,7 @@
     "yargs-unparser": "^2.0.0"
   },
   "peerDependencies": {
-    "jest": "28.x.x || ^27.2.5"
+    "jest": "29.x.x || 28.x.x || ^27.2.5"
   },
   "peerDependenciesMeta": {
     "jest": {
@@ -184,5 +184,5 @@
       }
     }
   },
-  "gitHead": "bd5998c15067ee02fc7cd65ae28e55847a4387c9"
+  "gitHead": "7fef4609b820542ce27263e0c2cd1f03a2ae02fe"
 }

package/runners/jest/reporters/DetoxReporter.js

@@ -1,5 +1,25 @@
-const { VerboseReporter: JestVerboseReporter } = require('@jest/reporters'); // eslint-disable-line node/no-extraneous-require
+const resolveFrom = require('resolve-from');
+/** @type {typeof import('@jest/reporters').VerboseReporter} */
+const JestVerboseReporter = require(resolveFrom(process.cwd(), '@jest/reporters')).VerboseReporter;
 
-class DetoxReporter extends JestVerboseReporter {}
+const { config, reportTestResults } = require('../../../internals');
+
+class DetoxReporter extends JestVerboseReporter {
+  /**
+   * @param {import('@jest/test-result').TestResult} testResult
+   */
+  async onTestResult(test, testResult, results) {
+    await super.onTestResult(test, testResult, results);
+
+    await reportTestResults([{
+      success: !testResult.failureMessage,
+      testFilePath: testResult.testFilePath,
+      testExecError: testResult.testExecError,
+      isPermanentFailure: config.testRunner.jest.retryAfterCircusRetries
+        ? false
+        : testResult.testResults.some(r => r.status === 'failed' && r.invocations > 1)
+    }]);
+  }
+}
 
 module.exports = DetoxReporter;