detox 20.0.11-prerelease.0 → 20.0.12-prerelease.0

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-javadoc.jar.md5

@@ -0,0 +1 @@
+83f58f2114c4c11df13dc19fb48ec8f3

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-javadoc.jar.sha1

@@ -0,0 +1 @@
+79e4ecf9e3a592932f8ee594c287345fbcb50ccc

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-javadoc.jar.sha256

@@ -0,0 +1 @@
+b9135f4a994d21ab1543c223940ba2eae57411c514b6b5ede58db8179ef48ec5

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-javadoc.jar.sha512

@@ -0,0 +1 @@
+035992cf8193c98d4335ca7f94842ca794a8a40f94f437a076eee068d930a86623d1e6d7755f624fcad632e092faa445b83557ae297c2ba7f05131848c251fa4

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-sources.jar.md5

@@ -0,0 +1 @@
+6a09651b807ee852e1fbb3e374bc95ca

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-sources.jar.sha1

@@ -0,0 +1 @@
+c3769eddce862d29deba41c68b1c3457056d746c

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-sources.jar.sha256

@@ -0,0 +1 @@
+3263d7cca6d9ae2a88716ef6aa4cd936d47b6c27888c7b3c40c6f745e3407d60

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0-sources.jar.sha512

@@ -0,0 +1 @@
+190e018641c86048d3c8f61efcdd8694d91b099c863f7740898f311bfb2e927179ceed13502e6efad6a915846271c0fc46177a7ac692cdda1899a9ca320dc852

package/Detox-android/com/wix/detox/{20.0.11-prerelease.0/detox-20.0.11-prerelease.0.pom → 20.0.12-prerelease.0/detox-20.0.12-prerelease.0.pom}

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.wix</groupId>
   <artifactId>detox</artifactId>
-  <version>20.0.11-prerelease.0</version>
+  <version>20.0.12-prerelease.0</version>
   <packaging>aar</packaging>
   <name>Detox</name>
   <description>Gray box end-to-end testing and automation library for mobile apps</description>

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0.pom.md5

@@ -0,0 +1 @@
+0493506a4e0ab469402bb1ec8060d6be

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0.pom.sha1

@@ -0,0 +1 @@
+368ca67e6718ee04781403230f984973b7226f4e

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0.pom.sha256

@@ -0,0 +1 @@
+516654dfdf2f2ef5dc08619ab644dd4aeca1a2603bad93520897a6206b43554d

package/Detox-android/com/wix/detox/20.0.12-prerelease.0/detox-20.0.12-prerelease.0.pom.sha512

@@ -0,0 +1 @@
+d02dc795d31bf3818e6682da9bbef6399c611cfcd5ed9189f8ff9edad231bd5c98c66b0582fc86cd1843abcaf57cda394cb47e3ba5be641325357b656dcc9585

package/Detox-android/com/wix/detox/maven-metadata.xml

@@ -3,11 +3,11 @@
   <groupId>com.wix</groupId>
   <artifactId>detox</artifactId>
   <versioning>
-    <latest>20.0.11-prerelease.0</latest>
-    <release>20.0.11-prerelease.0</release>
+    <latest>20.0.12-prerelease.0</latest>
+    <release>20.0.12-prerelease.0</release>
     <versions>
-      <version>20.0.11-prerelease.0</version>
+      <version>20.0.12-prerelease.0</version>
     </versions>
-    <lastUpdated>20220930144845</lastUpdated>
+    <lastUpdated>20221011170939</lastUpdated>
   </versioning>
 </metadata>

package/Detox-android/com/wix/detox/maven-metadata.xml.md5

@@ -1 +1 @@
-7298eb41c092e9d6471b11d8c4072549
+79cf31a8db7ad74ff1286cd11496ad71

package/Detox-android/com/wix/detox/maven-metadata.xml.sha1

@@ -1 +1 @@
-d59581aa200215423697a398b1e30952dbcad89d
+0d7ee0e81eefa10376669b9858bd76020fde79ca

package/Detox-android/com/wix/detox/maven-metadata.xml.sha256

@@ -1 +1 @@
-964eb89f375a8ac845a5d63eaa867d544a7fdc4b0cd9abe539417827895a9b6a
+d36ef71b4b4869d33efcc8332d5a8ba0e78539d934e0bf9879af9ff9a47a8f29

package/Detox-android/com/wix/detox/maven-metadata.xml.sha512

@@ -1 +1 @@
-8b8c26e1906aff908931afb6a7e095bd0d4eb3b08df4061c5b3645c0a6c9e1dc3cc0e9415f7e7a4b5bd7aec76c1e8f2de11388067b1e4d33cfcc2d6eb595933e
+91d5852150f7da4be8a3758d64a7eb28bede7863ac6d34e56b81b1587b837c935a4e5af1e5476c0beb90ada1a154efc3028ae6e4f7878699d2942aba64293579

package/index.d.ts

@@ -11,6 +11,7 @@
 import { BunyanDebugStreamOptions } from 'bunyan-debug-stream';
 
 declare global {
+    const detox: Detox.DetoxExportWrapper;
     const device: Detox.DetoxExportWrapper['device'];
     const element: Detox.DetoxExportWrapper['element'];
     const waitFor: Detox.DetoxExportWrapper['waitFor'];
@@ -20,6 +21,7 @@ declare global {
 
     namespace NodeJS {
         interface Global {
+            detox: Detox.DetoxExportWrapper;
             device: Detox.DetoxExportWrapper['device'];
             element: Detox.DetoxExportWrapper['element'];
             waitFor: Detox.DetoxExportWrapper['waitFor'];
@@ -137,9 +139,13 @@ declare global {
              */
             jest?: {
                 /**
-                 * Device init timeout
+                 * Environment setup timeout
                  */
-                initTimeout?: number | undefined;
+                setupTimeout?: number | undefined;
+                /**
+                 * Environment teardown timeout
+                 */
+                teardownTimeout?: number | undefined;
                 /**
                  * Insist on CLI-based retry mechanism even when the failed tests have been handled
                  * by jest.retryTimes(n) mechanism from Jest Circus.
@@ -152,6 +158,16 @@ declare global {
              * Retries count. Zero means a single attempt to run tests.
              */
             retries?: number;
+            /**
+             * When true, tells Detox CLI to cancel next retrying if it gets
+             * at least one report about a permanent test suite failure.
+             * Has no effect, if {@link DetoxTestRunnerConfig#retries} is
+             * undefined or set to zero.
+             *
+             * @default false
+             * @see {DetoxInternals.DetoxTestFileReport#isPermanentFailure}
+             */
+            bail?: boolean;
             /**
              * Custom handler to process --inspect-brk CLI flag.
              * Use it when you rely on another test runner than Jest.

package/internals.d.ts

@@ -54,14 +54,13 @@ declare global {
       onRunFinish(event: unknown): Promise<void>;
 
       /**
-       * Reports to Detox CLI about failed tests that could have been re-run if
+       * Reports to Detox CLI about passed and failed test files.
+       * The failed test files might be re-run again if
        * {@link Detox.DetoxTestRunnerConfig#retries} is set to a non-zero.
        *
-       * @param testFilePaths array of failed test files' paths
-       * @param permanent whether the failure is permanent, and the tests
-       * should not be re-run.
+       * @param testResults - reports about test files
        */
-      reportFailedTests(testFilePaths: string[], permanent?: boolean): Promise<void>;
+      reportTestResults(testResults: DetoxTestFileReport[]): Promise<void>;
       // endregion
 
       readonly config: RuntimeConfig;
@@ -92,7 +91,7 @@ declare global {
       testRunnerArgv: Record<string, unknown>;
       override: Partial<Detox.DetoxConfig>;
       /** @inheritDoc */
-      global: NodeJS.Global;
+      global: NodeJS.Global | {};
       /**
        * Worker ID. Used to distinguish allocated workers in parallel test execution environment.
        *
@@ -111,7 +110,7 @@ declare global {
        * {@link DetoxInternals.Facade#setup} might override {@link Console} methods
        * to integrate it with Detox loggeing subsystem.
        */
-      global: NodeJS.Global;
+      global: NodeJS.Global | {};
       /**
        * Worker ID. Used to distinguish allocated workers in parallel test execution environment.
        *
@@ -120,25 +119,48 @@ declare global {
       workerId: string;
     };
 
+    type DetoxTestFileReport = {
+      /**
+       * Global or relative path to the failed test file.
+       */
+      testFilePath: string;
+      /**
+       * Whether the test passed or not.
+       */
+      success: boolean;
+      /**
+       * Top-level error if the entire test file failed.
+       */
+      testExecError?: { name?: string; message: string; stack?: string; };
+      /**
+       * If the test failed, it should tell whether the failure is permanent.
+       * Permanent failure means that the test file should not be re-run.
+       *
+       * @default false
+       * @see {Detox.DetoxTestRunnerConfig#retries}
+       */
+      isPermanentFailure?: boolean;
+    };
+
     type SessionState = Readonly<{
       /**
        * Randomly generated ID for the entire Detox test session, including retries.
        */
       id: string;
       /**
-       * Permanently failed test file paths.
+       * Results of test file executions. Primarily used for Detox CLI retry mechanism.
        */
-      failedTestFiles: string[];
-      /**
-       * Failed test file paths suggested to retry via Detox CLI mechanism.
-       */
-      testFilesToRetry: string[];
+      testResults: DetoxTestFileReport[];
       /**
        * Retry index of the test session: 0..retriesCount.
        */
       testSessionIndex: number;
       /**
-       * TODO
+       * Count of Detox contexts with a worker installed.
+       * Oversimplified, it reflects the count of allocated devices in the current test session.
+       *
+       * @see {Facade#init}
+       * @see {Facade#installWorker}
        */
       workersCount: number;
     }>;

package/local-cli/cli.js

@@ -1,8 +1,11 @@
 #!/usr/bin/env node
+const fs = require('fs');
+
+const _ = require('lodash');
 const yargs = require('yargs');
 
+const logger = require('../internals').log.child({ cat: 'cli' });
 const DetoxError = require('../src/errors/DetoxError');
-const logger = require('../src/utils/logger').child({ cat: 'cli' });
 
 yargs
   .scriptName('detox')
@@ -25,12 +28,11 @@ yargs
   .wrap(yargs.terminalWidth() * 0.9)
   .fail(function(msg, err, program) {
     if (err) {
-      const lines = DetoxError.format(err).split('\n');
-      for (const line of lines) {
-        logger.error(line);
-      }
+      logger.error(DetoxError.format(err));
       // eslint-disable-next-line no-console
       console.error('');
+      // @ts-ignore
+      _.attempt(() => fs.unlinkSync(logger.file));
       // eslint-disable-next-line no-process-exit
       process.exit(1);
     }

package/local-cli/init.js

@@ -76,7 +76,7 @@ function createDefaultConfigurations() {
         config: 'e2e/jest.config.js',
       },
       jest: {
-        initTimeout: 120000,
+        setupTimeout: 120000,
       },
     },
     apps: {

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/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;
@@ -139,11 +145,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 +177,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).env).not.toHaveProperty('DETOX_RERUN_INDEX');
+      expect(cliCall(0).argv).toEqual([expect.stringMatching(/executable$/), '--config', 'e2e/config.json']);
+      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 +218,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);
 

package/local-cli/testCommand/TestRunnerCommand.js

@@ -99,13 +99,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
         }

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.12-prerelease.0",
   "bin": {
     "detox": "local-cli/cli.js"
   },
@@ -184,5 +184,5 @@
       }
     }
   },
-  "gitHead": "bd5998c15067ee02fc7cd65ae28e55847a4387c9"
+  "gitHead": "3cd7feb90f69058ec124fa085cdacc8d167161a7"
 }

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.invocations > 1)
+    }]);
+  }
+}
 
 module.exports = DetoxReporter;