feat(config): launch app manually (wix#2540)

bitumnus · Dec 24, 2020 · 5c5e573 · 5c5e573
1 parent 4f107c3
commit 5c5e573
Show file tree

Hide file tree

Showing 23 changed files with 530 additions and 78 deletions.
diff --git a/detox/local-cli/test.js b/detox/local-cli/test.js
@@ -2,6 +2,7 @@ const _ = require('lodash');
 const cp = require('child_process');
 const path = require('path');
 const unparse = require('yargs-unparser');
+const whichSync = require('which').sync;
 const { parse, quote } = require('./utils/shellQuote');
 const splitArgv = require('./utils/splitArgv');
 const DetoxRuntimeError = require('../src/errors/DetoxRuntimeError');
@@ -37,7 +38,11 @@ module.exports.handler = async function test(argv) {
   });
 
   if (detoxArgs['inspect-brk']) {
-    forwardedArgs.argv.$0 = `node --inspect-brk ${runnerConfig.testRunner}`;
+    const runnerBinary = whichSync(runner, {
+      path: prependNodeModulesBinToPATH({ ...process.env }),
+    });
+
+    forwardedArgs.argv.$0 = `node --inspect-brk ${require.resolve(runnerBinary)}`;
   } else {
     forwardedArgs.argv.$0 = runnerConfig.testRunner;
   }

diff --git a/detox/local-cli/test.test.js b/detox/local-cli/test.test.js
@@ -573,7 +573,7 @@ describe('CLI', () => {
     });
 
     test.each([
-      ['--inspect-brk e2eFolder', /^node --inspect-brk jest .* e2eFolder$/, {}],
+      ['--inspect-brk e2eFolder', /^node --inspect-brk .*jest\.js .* e2eFolder$/, {}],
       ['-d e2eFolder', / e2eFolder$/, { debugSynchronization: 3000 }],
       ['--debug-synchronization e2eFolder', / e2eFolder$/, { debugSynchronization: 3000 }],
       ['-r e2eFolder', / e2eFolder$/, { reuse: true }],
@@ -660,7 +660,8 @@ describe('CLI', () => {
 
     test('--inspect-brk should prepend "node --inspect-brk" to the command', async () => {
       await run('--inspect-brk');
-      expect(cliCall().command).toMatch(RegExp(`^node --inspect-brk ${testRunner}`));
+      const absolutePathToTestRunnerJs = require.resolve(`.bin/${testRunner}`);
+      expect(cliCall().command).toMatch(RegExp(`^node --inspect-brk ${absolutePathToTestRunnerJs}`));
     });
 
     test('should append $DETOX_ARGV_OVERRIDE to detox test ... command and print a warning', async () => {

diff --git a/detox/local-cli/utils/misc.js b/detox/local-cli/utils/misc.js
@@ -28,6 +28,8 @@ function prependNodeModulesBinToPATH(env) {
   if (!env[PATH].startsWith(nodeBinariesPath)) {
     env[PATH] = nodeBinariesPath + env[PATH];
   }
+
+  return env[PATH];
 }
 
 module.exports = {

diff --git a/detox/package.json b/detox/package.json
@@ -113,6 +113,7 @@
       "src/utils/logger.js",
       "src/utils/onTerminate.js",
       "src/utils/pipeCommands.js",
+      "src/utils/pressAnyKey.js",
       "src/utils/sleep.js",
       "AAPT.js",
       "ADB.js",

diff --git a/detox/src/Detox.js b/detox/src/Detox.js
@@ -153,6 +153,7 @@ class Detox {
     });
 
     this.device = new Device({
+      behaviorConfig: this._behaviorConfig,
       deviceConfig: this._deviceConfig,
       emitter: this._eventEmitter,
       deviceDriver,

diff --git a/detox/src/Detox.test.js b/detox/src/Detox.test.js
@@ -130,6 +130,7 @@ describe('Detox', () => {
 
       it('should instantiate Device', () =>
         expect(Device).toHaveBeenCalledWith({
+          behaviorConfig: detoxConfig.behaviorConfig,
           deviceConfig: detoxConfig.deviceConfig,
           emitter: expect.anything(),
           deviceDriver: expect.anything(),

diff --git a/detox/src/configuration/composeArtifactsConfig.js b/detox/src/configuration/composeArtifactsConfig.js
@@ -29,17 +29,7 @@ function composeArtifactsConfig({
     }),
     extendArtifactsConfig(deviceConfig.artifacts),
     extendArtifactsConfig(detoxConfig.artifacts),
-    extendArtifactsConfig({
-      rootDir: 'artifacts',
-      pathBuilder: null,
-      plugins: {
-        log: 'none',
-        screenshot: 'manual',
-        video: 'none',
-        instruments: 'none',
-        timeline: 'none',
-      },
-    }),
+    extendArtifactsConfig(false),
   );
 
   artifactsConfig.rootDir = buildDefaultArtifactsRootDirpath(
@@ -53,6 +43,20 @@ function composeArtifactsConfig({
 }
 
 function extendArtifactsConfig(config) {
+  if (config === false) {
+    return extendArtifactsConfig({
+      rootDir: 'artifacts',
+      pathBuilder: null,
+      plugins: {
+        log: 'none',
+        screenshot: 'manual',
+        video: 'none',
+        instruments: 'none',
+        timeline: 'none',
+      },
+    });
+  }
+
   const p = config && config.plugins;
   if (!p) {
     return config;

diff --git a/detox/src/configuration/composeArtifactsConfig.test.js b/detox/src/configuration/composeArtifactsConfig.test.js
@@ -63,6 +63,28 @@ describe('composeArtifactsConfig', () => {
     });
   });
 
+  it('should disable global artifacts config if deviceConfig.artifacts = false', () => {
+    expect(composeArtifactsConfig({
+      configurationName: 'abracadabra',
+      deviceConfig: {
+        artifacts: false,
+      },
+      detoxConfig: {
+        artifacts: {
+          ...schemes.allArtifactsConfiguration,
+          rootDir: 'otherPlace',
+          pathBuilder: _.noop,
+        }
+      },
+      cliConfig: {},
+    })).toMatchObject({
+      pathBuilder: expect.objectContaining({
+        rootDir: expect.stringMatching(/^artifacts[\\\/]abracadabra\.\d{4}/),
+      }),
+      plugins: schemes.pluginsDefaultsResolved,
+    });
+  });
+
   it('should use CLI config', () => {
     expect(composeArtifactsConfig({
       configurationName: 'abracadabra',

diff --git a/detox/src/configuration/composeBehaviorConfig.js b/detox/src/configuration/composeBehaviorConfig.js
@@ -1,35 +1,43 @@
 const _ = require('lodash');
 
 function composeBehaviorConfig({ cliConfig, detoxConfig, deviceConfig, userParams }) {
-  return _.defaultsDeep(
-    {
-      init: {
-        reinstallApp: cliConfig.reuse ? false : undefined,
+  return _.chain({})
+    .defaultsDeep(
+      {
+        init: {
+          reinstallApp: cliConfig.reuse ? false : undefined,
+        },
+        cleanup: {
+          shutdownDevice: cliConfig.cleanup ? true : undefined,
+        },
       },
-      cleanup: {
-        shutdownDevice: cliConfig.cleanup ? true : undefined,
+      userParams && {
+        init: {
+          exposeGlobals: userParams.initGlobals,
+          launchApp: userParams.launchApp,
+          reinstallApp: negateDefined(userParams.reuse),
+        },
       },
-    },
-    userParams && {
-      init: {
-        exposeGlobals: userParams.initGlobals,
-        launchApp: userParams.launchApp,
-        reinstallApp: negateDefined(userParams.reuse),
-      },
-    },
-    deviceConfig.behavior,
-    detoxConfig.behavior,
-    {
-      init: {
-        exposeGlobals: true,
-        reinstallApp: true,
-        launchApp: true,
-      },
-      cleanup: {
-        shutdownDevice: false,
-      },
-    }
-  );
+      deviceConfig.behavior,
+      detoxConfig.behavior,
+      {
+        init: {
+          exposeGlobals: true,
+          reinstallApp: undefined,
+          launchApp: true,
+        },
+        launchApp: 'auto',
+        cleanup: {
+          shutdownDevice: false,
+        },
+      }
+    )
+    .tap(config => {
+      if (config.init.reinstallApp === undefined) {
+        config.init.reinstallApp = config.launchApp !== 'manual';
+      }
+    })
+    .value();
 }
 
 function negateDefined(x) {

diff --git a/detox/src/configuration/composeBehaviorConfig.test.js b/detox/src/configuration/composeBehaviorConfig.test.js
@@ -27,12 +27,28 @@ describe('composeBehaviorConfig', () => {
         reinstallApp: true,
         launchApp: true,
       },
+      launchApp: 'auto',
       cleanup: {
         shutdownDevice: false,
       },
     })
   });
 
+  describe('if a custom config has only .launchApp = "manual" override', () => {
+    beforeEach(() => {
+      detoxConfig = {
+        behavior: { launchApp: 'manual' }
+      };
+    });
+
+    it('should implicitly override behavior.init.reinstallApp = false', () => {
+      const expected = _.cloneDeep(detoxConfig.behavior);
+      const actual = composed();
+
+      expect(actual.init.reinstallApp).toBe(false);
+    });
+  });
+
   describe('if detox config is set', () => {
     beforeEach(() => {
       detoxConfig = {
@@ -42,6 +58,7 @@ describe('composeBehaviorConfig', () => {
             reinstallApp: false,
             launchApp: false,
           },
+          launchApp: 'manual',
           cleanup: {
             shutdownDevice: true,
           },
@@ -65,6 +82,7 @@ describe('composeBehaviorConfig', () => {
               reinstallApp: true,
               launchApp: true,
             },
+            launchApp: 'auto',
             cleanup: {
               shutdownDevice: false,
             },
@@ -95,6 +113,7 @@ describe('composeBehaviorConfig', () => {
               reinstallApp: true,
               launchApp: false,
             },
+            launchApp: 'auto',
             cleanup: {
               shutdownDevice: false,
             }
@@ -114,6 +133,7 @@ describe('composeBehaviorConfig', () => {
                 reinstallApp: false,
                 launchApp: false,
               },
+              launchApp: 'auto',
               cleanup: {
                 shutdownDevice: true,
               }
@@ -124,4 +144,3 @@ describe('composeBehaviorConfig', () => {
     });
   });
 });
-
diff --git a/detox/src/devices/Device.js b/detox/src/devices/Device.js
@@ -1,9 +1,17 @@
 const _ = require('lodash');
 const debug = require('../utils/debug'); // debug utils, leave here even if unused
 const { traceCall } = require('../utils/trace');
+const log = require('../utils/logger').child({ __filename });
 
 class Device {
-  constructor({ deviceConfig, deviceDriver, emitter, sessionConfig }) {
+  constructor({
+    behaviorConfig,
+    deviceConfig,
+    deviceDriver,
+    emitter,
+    sessionConfig
+  }) {
+    this._behaviorConfig = behaviorConfig;
     this._deviceConfig = deviceConfig;
     this._sessionConfig = sessionConfig;
     this._emitter = emitter;
@@ -22,9 +30,9 @@ class Device {
   }
 
   async launchApp(params = {newInstance: false}, bundleId) {
-    return traceCall('launchApp', () =>
-      this._doLaunchApp(params, bundleId));
+    return traceCall('launchApp', () => this._doLaunchApp(params, bundleId));
   }
+
   async _doLaunchApp(params, bundleId) {
     const payloadParams = ['url', 'userNotification', 'userActivity'];
     const hasPayload = this._assertHasSingleParam(payloadParams, params);
@@ -67,11 +75,16 @@ class Device {
       }
     }
 
-    const processId = await this.deviceDriver.launchApp(this._deviceId, _bundleId, this._prepareLaunchArgs(baseLaunchArgs), params.languageAndLocale);
+    let processId;
+    if (this._behaviorConfig.launchApp === 'manual') {
+      processId = await this.deviceDriver.waitForAppLaunch(this._deviceId, _bundleId, this._prepareLaunchArgs(baseLaunchArgs), params.languageAndLocale);
+    } else {
+      processId = await this.deviceDriver.launchApp(this._deviceId, _bundleId, this._prepareLaunchArgs(baseLaunchArgs), params.languageAndLocale);
+      await this.deviceDriver.waitUntilReady();
+      await this.deviceDriver.waitForActive();
+    }
     this._processes[_bundleId] = processId;
 
-    await this.deviceDriver.waitUntilReady();
-    await this.deviceDriver.waitForActive();
     await this._emitter.emit('appReady', {
       deviceId: this._deviceId,
       bundleId: _bundleId,

diff --git a/detox/src/devices/Device.test.js b/detox/src/devices/Device.test.js
@@ -61,6 +61,10 @@ describe('Device', () => {
       expect(this.driver.launchApp).toHaveBeenCalledWith(device._deviceId, device._bundleId, expectedArgs, languageAndLocale);
     }
 
+    expectWaitForLaunchCalled(device, expectedArgs, languageAndLocale) {
+      expect(this.driver.waitForAppLaunch).toHaveBeenCalledWith(device._deviceId, device._bundleId, expectedArgs, languageAndLocale);
+    }
+
     expectReinstallCalled() {
       expect(this.driver.uninstallApp).toHaveBeenCalled();
       expect(this.driver.installApp).toHaveBeenCalled();
@@ -90,6 +94,7 @@ describe('Device', () => {
 
   function schemeDevice(scheme, configuration, overrides) {
     const device = new Device(_.merge({
+      behaviorConfig: {},
       deviceConfig: scheme.configurations[configuration],
       deviceDriver: driverMock.driver,
       sessionConfig: scheme.session,
@@ -142,6 +147,17 @@ describe('Device', () => {
       driverMock.expectLaunchCalled(device, expectedArgs);
     });
 
+    it(`given behaviorConfig.launchApp == 'manual' should wait for the app launch`, async () => {
+      const expectedArgs = expectedDriverArgs;
+      const device = validDevice({
+        behaviorConfig: { launchApp: 'manual' }
+      });
+      await device.launchApp();
+
+      expect(driverMock.driver.launchApp).not.toHaveBeenCalled();
+      driverMock.expectWaitForLaunchCalled(device, expectedArgs);
+    });
+
     it(`args should launch app and emit appReady`, async () => {
       driverMock.driver.launchApp = async () => 42;
 

diff --git a/detox/src/devices/drivers/DeviceDriverBase.js b/detox/src/devices/drivers/DeviceDriverBase.js
@@ -27,7 +27,11 @@ class DeviceDriverBase {
   }
 
   async launchApp() {
-    return await Promise.resolve('');
+    return await Promise.resolve(NaN);
+  }
+
+  async waitForAppLaunch() {
+    return await Promise.resolve(NaN);
   }
 
   async takeScreenshot(deviceId, screenshotName) {