detox 21.0.0-rc.1 → 21.0.0-rc.10

package/src/devices/common/drivers/android/cookies.d.ts

@@ -0,0 +1,11 @@
+/* eslint-disable import/no-unresolved,node/no-missing-import,node/no-unsupported-features/es-syntax */
+import GenyInstance from '../../../allocation/drivers/android/genycloud/services/dto/GenyInstance';
+import { DeviceCookie } from '../DeviceCookie';
+
+interface AndroidDeviceCookie extends DeviceCookie {
+  adbName: string;
+}
+
+interface GenycloudEmulatorCookie extends AndroidDeviceCookie {
+  instance: GenyInstance;
+}

package/src/devices/common/drivers/android/emulator/exec/EmulatorExec.js

@@ -32,19 +32,31 @@ class QueryVersionCommand extends ExecCommand {
 }
 
 class LaunchCommand extends ExecCommand {
-  constructor(emulatorName, options) {
+  constructor(options) {
     super();
     this._options = options;
-    this._args = this._getEmulatorArgs(emulatorName);
-    this.port = options.port;
+    this._args = this._getEmulatorArgs();
+  }
+
+  get adbName() {
+    return this._options.adbName;
+  }
+
+  get avdName() {
+    return this._options.avdName;
+  }
+
+  get port() {
+    return this._options.port;
   }
 
   _getArgs() {
     return this._args;
   }
 
-  _getEmulatorArgs(emulatorName) {
+  _getEmulatorArgs() {
     const {
+      avdName,
       bootArgs,
       gpuMode = this._getDefaultGPUMode(),
       headless,
@@ -64,7 +76,7 @@ class LaunchCommand extends ExecCommand {
       port ? '-port' : '',
       port ? `${port}` : '',
       ...deviceBootArgs,
-      `@${emulatorName}`
+      `@${avdName}`
     ]);
 
     return emulatorArgs;

package/src/devices/common/drivers/android/exec/ADB.js

@@ -18,6 +18,7 @@ class ADB {
 
   async devices() {
     const { stdout } = await this.adbCmd('', 'devices', { verbosity: 'high' });
+    /** @type {DeviceHandle[]} */
     const devices = _.chain(stdout)
       .trim()
       .split('\n')

package/src/devices/common/drivers/android/tools/instrumentationArgs.js

@@ -1,6 +1,7 @@
 const _ = require('lodash');
 
 const { encodeBase64 } = require('../../../../../utils/encoding');
+const { autoEscape } = require('../../../../../utils/shellUtils');
 
 const reservedInstrumentationArgs = new Set(['class', 'package', 'func', 'unit', 'size', 'perf', 'debug', 'log', 'emma', 'coverageFile']);
 const isReservedInstrumentationArg = (arg) => reservedInstrumentationArgs.has(arg);
@@ -17,7 +18,8 @@ function prepareInstrumentationArgs(args) {
       valueEncoded = encodeBase64(valueAsString);
     }
 
-    result.push('-e', key, valueEncoded);
+    const valueEscaped = hasLegacyIssues(key) ? valueEncoded : autoEscape.shell(valueEncoded);
+    result.push('-e', key, valueEscaped);
     return result;
   }, []);
 
@@ -27,6 +29,10 @@ function prepareInstrumentationArgs(args) {
   };
 }
 
+function hasLegacyIssues(key) {
+  return key === 'detoxURLBlacklistRegex';
+}
+
 module.exports = {
   prepareInstrumentationArgs,
 };

package/src/devices/common/drivers/ios/cookies.d.ts

@@ -0,0 +1,9 @@
+/* eslint-disable import/no-unresolved,node/no-missing-import,node/no-unsupported-features/es-syntax */
+import { DeviceCookie } from '../DeviceCookie';
+
+interface IosSimulatorCookie extends DeviceCookie {
+  udid: string;
+  type?: string;
+  bootArgs?: string;
+  headless?: boolean;
+}

package/src/devices/common/drivers/ios/tools/AppleSimUtils.js

@@ -288,7 +288,7 @@ class AppleSimUtils {
       // want to make sure it isn't now.
       if (err.code === 3 &&
           (err.stderr.includes(`the app is not currently running`) ||
-           err.stderr.includes(`The operation couldn’t be completed. found nothing to terminate`))) {
+           err.stderr.includes(`found nothing to terminate`))) {
         return;
       }
 
@@ -446,6 +446,8 @@ class AppleSimUtils {
         overrides.push(`--cellularMode "${flags.cellularMode}"`);
       if (flags.cellularBars)
         overrides.push(`--cellularBars "${flags.cellularBars}"`);
+      if (flags.operatorName)
+        overrides.push(`--operatorName "${flags.operatorName}"`);
       if (flags.batteryState)
         overrides.push(`--batteryState "${flags.batteryState}"`);
       if (flags.batteryLevel)

package/src/devices/cookies/index.js

@@ -1,6 +0,0 @@
-module.exports = {
-  IosSimulatorCookie: require('./IosSimulatorCookie'),
-  AttachedAndroidDeviceCookie: require('./AttachedAndroidDeviceCookie'),
-  AndroidEmulatorCookie: require('./AndroidEmulatorCookie'),
-  GenycloudEmulatorCookie: require('./GenycloudEmulatorCookie'),
-};

package/src/devices/runtime/drivers/android/genycloud/GenyCloudDriver.js

@@ -8,21 +8,22 @@ const AndroidDriver = require('../AndroidDriver');
 
 /**
  * @typedef GenycloudDriverProps
- * @property instance { GenyInstance } The DTO associated with the cloud instance
+ * @property adbName { GenyInstance } The DTO associated with the cloud instance
  */
 
 class GenyCloudDriver extends AndroidDriver {
   /**
    * @param deps { GenycloudDriverDeps }
-   * @param props { GenycloudDriverProps }
+   * @param props { GenycloudEmulatorCookie }
    */
-  constructor(deps, { instance }) {
-    super(deps, { adbName: instance.adbName });
-    this.instance = instance;
+  constructor(deps, { adbName, name }) {
+    super(deps, { adbName });
+
+    this._instanceName = name;
   }
 
   getDeviceName() {
-    return this.instance.toString();
+    return this._instanceName;
   }
 
   async setLocation(lat, lon) {

package/src/devices/runtime/drivers/ios/SimulatorDriver.js

@@ -17,7 +17,6 @@ const { launchXCUITest } = require('./XCUITestUtils');
 
 /**
  * @typedef SimulatorDriverDeps { DeviceDriverDeps }
- * @property simulatorLauncher { SimulatorLauncher }
  * @property applesimutils { AppleSimUtils }
  */
 
@@ -41,7 +40,6 @@ class SimulatorDriver extends IosDriver {
     this._bootArgs = bootArgs;
     this._headless = headless;
     this._deviceName = `${udid} (${this._type})`;
-    this._simulatorLauncher = deps.simulatorLauncher;
     this._applesimutils = deps.applesimutils;
     // TODO: allocate unique-per-worker available port.
     this._testTargetServerPort = 8997 + _.random(0, 1000);
@@ -190,9 +188,12 @@ class SimulatorDriver extends IosDriver {
   }
 
   async resetContentAndSettings() {
-    await this._simulatorLauncher.shutdown(this.udid);
+    await this.emitter.emit('beforeShutdownDevice', { deviceId: this.udid });
+    await this._applesimutils.shutdown(this.udid);
+    await this.emitter.emit('shutdownDevice', { deviceId: this.udid });
     await this._applesimutils.resetContentAndSettings(this.udid);
-    await this._simulatorLauncher.launch(this.udid, this._type, this._bootArgs, this._headless);
+    await this._applesimutils.boot(this.udid, this._bootArgs, this._headless);
+    await this.emitter.emit('bootDevice', { deviceId: this.udid });
   }
 
   getLogsPaths() {

package/src/devices/runtime/drivers/ios/XCUITestUtils.js

@@ -1,7 +1,6 @@
 const { exec } = require('child-process-promise');
 const osascript = require('node-osascript');
 
-const { execWithRetriesAndLogs } = require('../../../../utils/childProcess');
 const log = require('../../../../utils/logger').child({ cat: 'device,xcuitest' });
 
 async function launchXCUITest(
@@ -56,7 +55,7 @@ async function _runLaunchCommand(
   ).then(r => {
     log.info(`[XCUITest] XCUITest runner execution finished`);
   }).catch(e => {
-    log.error(`[XCUITest] xcodebuild error has occurred during XCUITest execution:\n${e}`);
+    log.debug(`[XCUITest] XCUITest runner execution finished with message:\n${e}`);
   });
 
   // Get firewall global state (Firewall socketfilterfw):
@@ -67,7 +66,12 @@ async function _runLaunchCommand(
   }
 
   const isServerUp = await _waitForTestTargetServerToStart(testTargetServerPort, spawnedProcess);
-  log.debug(`[XCUITest] Finished waiting for test target server to start, server is up: ${isServerUp}`);
+  if (!isServerUp) {
+    throw new Error(`[XCUITest] Test runner is not up after 90 seconds, aborting`);
+  } else {
+    const childProcess = spawnedProcess.childProcess;
+    log.debug(`[XCUITest] Test runner is up and running, PID: ${childProcess.pid}`);
+  }
 }
 
 function runXCUITest(
@@ -101,9 +105,7 @@ function runXCUITest(
   };
 
   const options = {
-    maxBuffer: 1024 * 1024 * 1024,
-    retries: 1,
-    verbosity: 'high',
+    maxBuffer: 1024 * 1024 * 10, // 10MB
   };
 
   const command = `${env.TEST_RUNNER_IS_DETOX_ACTIVE ? Object.keys(env).map(key => `${key}=${env[key]}`).join(' ') : ''} ${xcodebuildBinary} ${flags.map(flag => flag.includes(' ') ? `"${flag}"` : flag).join(' ')}`;
@@ -120,13 +122,21 @@ function runXCUITest(
     }
   }
 
-  return execWithRetriesAndLogs(command, options);
+  const result = exec(command, options);
+
+  result.childProcess.stderr.on('data', (data) => {
+    if (data.includes('Testing started completed')) {
+      result.childProcess.kill('SIGTERM');
+    }
+  });
+
+  return result;
 }
 
 function _runCommandInTerminal(command, options) {
-  const escapedCommand = command.replace(/"/g, '\\"'); // escape double quotes
+  const escapedCommand = command.replace(/"/g, '\\"');
 
-  // opens the Terminal app and runs the command in a new window, then closes the window when the command is done running.
+  // Opens the Terminal app and runs the command in a new window, then closes the window when the command is done running.
   const appleScript = `
         tell application "Terminal"
             if not running then
@@ -146,7 +156,7 @@ function _runCommandInTerminal(command, options) {
         end tell
     `;
 
-  return execWithRetriesAndLogs(`osascript -e '${appleScript}'`, options);
+  return exec(`osascript -e '${appleScript}'`, options);
 }
 
 function _allowNetworkPermissionsXCUITest() {
@@ -174,7 +184,7 @@ function _allowNetworkPermissionsXCUITest() {
     childProcess.stdin.pause();
     childProcess.kill('SIGTERM');
 
-  }, 30000);
+  }, 30000).unref();
 }
 
 async function _waitForTestTargetServerToStart(testTargetServerPort, cpPromise) {

package/src/devices/runtime/factories/android.js

@@ -3,7 +3,7 @@ const RuntimeDeviceFactory = require('./base');
 
 class RuntimeDriverFactoryAndroid extends RuntimeDeviceFactory {
   _createDriverDependencies(commonDeps) {
-    const serviceLocator = require('../../../servicelocator/android');
+    const serviceLocator = require('../../servicelocator/android');
     const adb = serviceLocator.adb;
     const aapt = serviceLocator.aapt;
     const apkValidator = serviceLocator.apkValidator;
@@ -43,23 +43,15 @@ class AndroidEmulator extends RuntimeDriverFactoryAndroid {
 
 class AndroidAttached extends RuntimeDriverFactoryAndroid {
   _createDriver(deviceCookie, deps, configs) {
-    const props = {
-      adbName: deviceCookie.adbName,
-    };
-
     const { AttachedAndroidRuntimeDriver } = require('../drivers');
-    return new AttachedAndroidRuntimeDriver(deps, props);
+    return new AttachedAndroidRuntimeDriver(deps, deviceCookie);
   }
 }
 
 class Genycloud extends RuntimeDriverFactoryAndroid {
   _createDriver(deviceCookie, deps, configs) {
-    const props = {
-      instance: deviceCookie.instance,
-    };
-
     const { GenycloudRuntimeDriver } = require('../drivers');
-    return new GenycloudRuntimeDriver(deps, props);
+    return new GenycloudRuntimeDriver(deps, deviceCookie);
   }
 }
 

package/src/devices/runtime/factories/ios.js

@@ -2,15 +2,14 @@ const RuntimeDeviceFactory = require('./base');
 
 class RuntimeDriverFactoryIos extends RuntimeDeviceFactory {
   _createDriverDependencies(commonDeps) {
-    const serviceLocator = require('../../../servicelocator/ios');
-    const applesimutils = serviceLocator.appleSimUtils;
     const { eventEmitter } = commonDeps;
 
-    const SimulatorLauncher = require('../../allocation/drivers/ios/SimulatorLauncher');
+    const AppleSimUtils = require('../../../devices/common/drivers/ios/tools/AppleSimUtils');
+    const applesimutils = new AppleSimUtils();
+
     return {
       ...commonDeps,
       applesimutils,
-      simulatorLauncher: new SimulatorLauncher({ applesimutils, eventEmitter }),
     };
   }
 }

package/src/{servicelocator → devices/servicelocator}/android/emulatorServiceLocator.js

@@ -1,4 +1,4 @@
-const { EmulatorExec } = require('../../devices/common/drivers/android/emulator/exec/EmulatorExec');
+const { EmulatorExec } = require('../../common/drivers/android/emulator/exec/EmulatorExec');
 
 class EmulatorServiceLocator {
   constructor() {

package/src/devices/servicelocator/android/genycloudServiceLocator.js

@@ -0,0 +1,17 @@
+class GenycloudServiceLocator {
+  constructor() {
+    this._exec = null;
+  }
+
+  // Note: important to keep lazy because of implicit validations that are sensitive (inside environment, in particular).
+  get exec() {
+    if (!this._exec) {
+      const Exec = require('../../allocation/drivers/android/genycloud/exec/GenyCloudExec');
+      const environment = require('../../../utils/environment');
+      this._exec = new Exec(environment.getGmsaasPath());
+    }
+    return this._exec;
+  }
+}
+
+module.exports = new GenycloudServiceLocator();

package/src/devices/servicelocator/android/index.js

@@ -0,0 +1,23 @@
+const AndroidDevicePathBuilder = require('../../../artifacts/utils/AndroidDevicePathBuilder');
+const AAPT = require('../../common/drivers/android/exec/AAPT');
+const ADB = require('../../common/drivers/android/exec/ADB');
+const ApkValidator = require('../../common/drivers/android/tools/ApkValidator');
+const { TempFileTransfer } = require('../../common/drivers/android/tools/TempFileTransfer');
+
+const AndroidServiceLocator = {
+  get emulator() {
+    return require('./emulatorServiceLocator');
+  },
+
+  get genycloud() {
+    return require('./genycloudServiceLocator');
+  },
+};
+
+AndroidServiceLocator.adb = new ADB();
+AndroidServiceLocator.aapt = new AAPT();
+AndroidServiceLocator.apkValidator = new ApkValidator(AndroidServiceLocator.aapt);
+AndroidServiceLocator.fileTransfer = new TempFileTransfer(AndroidServiceLocator.adb);
+AndroidServiceLocator.devicePathBuilder = new AndroidDevicePathBuilder();
+
+module.exports = AndroidServiceLocator;

package/src/{validation → devices/validation}/EnvironmentValidatorBase.js

@@ -1,4 +1,5 @@
 class EnvironmentValidatorBase {
+  /* istanbul ignore next */
   validate() {}
 }
 

package/src/{validation → devices/validation}/android/GenycloudEnvValidator.js

@@ -1,8 +1,8 @@
 // @ts-nocheck
 const semver = require('semver');
 
-const DetoxRuntimeError = require('../../errors/DetoxRuntimeError');
-const environment = require('../../utils/environment');
+const { DetoxRuntimeError } = require('../../../errors');
+const environment = require('../../../utils/environment');
 const EnvironmentValidatorBase = require('../EnvironmentValidatorBase');
 
 const MIN_GMSAAS_VERSION = '1.6.0';

package/src/{validation → devices/validation}/factories/index.js

@@ -7,7 +7,7 @@ class Genycloud extends EnvValidatorFactory {
     const serviceLocator = require('../../servicelocator/android');
     const exec = serviceLocator.genycloud.exec;
 
-    const GenyAuthService = require('../../devices/common/drivers/android/genycloud/services/GenyAuthService');
+    const GenyAuthService = require('../../allocation/drivers/android/genycloud/services/GenyAuthService');
     const authService = new GenyAuthService(exec);
 
     const GenycloudEnvValidator = require('../android/GenycloudEnvValidator');

package/src/{validation → devices/validation}/ios/IosSimulatorEnvValidator.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
 
-const DetoxRuntimeError = require('../../errors/DetoxRuntimeError');
-const environment = require('../../utils/environment');
+const DetoxRuntimeError = require('../../../errors/DetoxRuntimeError');
+const environment = require('../../../utils/environment');
 const EnvironmentValidatorBase = require('../EnvironmentValidatorBase');
 
 class IosSimulatorEnvValidator extends EnvironmentValidatorBase {

package/src/environmentFactory.js

@@ -2,9 +2,9 @@
 const artifactsManagerFactories = require('./artifacts/factories');
 const deviceAllocationFactories = require('./devices/allocation/factories');
 const runtimeDeviceFactories = require('./devices/runtime/factories');
+const envValidationFactories = require('./devices/validation/factories');
 const matchersFactories = require('./matchers/factories');
 const resolveModuleFromPath = require('./utils/resolveModuleFromPath');
-const envValidationFactories = require('./validation/factories');
 
 function validateConfig(deviceConfig) {
   const classes = _getFactoryClasses(deviceConfig);
@@ -36,15 +36,6 @@ function createFactories(deviceConfig) {
   return _getExternalModuleFactories(deviceConfig);
 }
 
-function createGlobalLifecycleHandler(deviceConfig) {
-  if (deviceConfig.type === 'android.genycloud') {
-    const FactoryClass = require('./devices/lifecycle/factories/GenyGlobalLifecycleHandlerFactory');
-    const factory = new FactoryClass();
-    return factory.createHandler();
-  }
-  return null;
-}
-
 function _getFactoryClasses(deviceConfig) {
   let envValidatorFactoryClass;
   let artifactsManagerFactoryClass;
@@ -115,5 +106,4 @@ function _getExternalModuleFactories(deviceConfig) {
 module.exports = {
   validateConfig,
   createFactories,
-  createGlobalLifecycleHandler,
 };

package/src/invoke.js

@@ -1,4 +1,3 @@
-const EarlGrey = require('./invoke/EarlGrey');
 const Espresso = require('./invoke/Espresso');
 const EspressoWeb = require('./invoke/EspressoWeb');
 const Invoke = require('./invoke/Invoke');
@@ -15,7 +14,6 @@ class InvocationManager {
 
 module.exports = {
   InvocationManager,
-  EarlGrey,
   Espresso: Espresso.target,
   EspressoWeb: EspressoWeb.target,
   IOS: Invoke.genericInvokeObject,

package/src/ios/expectTwo.js

@@ -6,12 +6,16 @@ const fs = require('fs-extra');
 const _ = require('lodash');
 const tempfile = require('tempfile');
 
+
 const { assertEnum, assertNormalized } = require('../utils/assertArgument');
 const { removeMilliseconds } = require('../utils/dateUtils');
 const { actionDescription, expectDescription } = require('../utils/invocationTraceDescriptions');
+const { isRegExp } = require('../utils/isRegExp');
 const log = require('../utils/logger').child({ cat: 'ws-client, ws' });
 const traceInvocationCall = require('../utils/traceInvocationCall').bind(null, log);
 
+const { webElement, webMatcher, webExpect, isWebElement } = require('./web');
+
 const assertDirection = assertEnum(['left', 'right', 'up', 'down']);
 const assertSpeed = assertEnum(['fast', 'slow']);
 
@@ -231,7 +235,7 @@ class Element {
 
   performAccessibilityAction(actionName) {
     if (typeof actionName !== 'string') throw new Error('actionName should be a string, but got ' + (actionName + (' (' + (typeof actionName + ')'))));
-    
+
     const traceDescription = actionDescription.performAccessibilityAction(actionName);
     return this.withAction('accessibilityAction', traceDescription, actionName);
   }
@@ -399,7 +403,7 @@ class By {
   }
 
   get web() {
-    throw new Error('Detox does not support by.web matchers on iOS.');
+    return webMatcher();
   }
 }
 
@@ -409,14 +413,14 @@ class Matcher {
   }
 
   label(label) {
-    if (typeof label !== 'string') throw new Error('label should be a string, but got ' + (label + (' (' + (typeof label + ')'))));
-    this.predicate = { type: 'label', value: label };
+    if (typeof label !== 'string' && !isRegExp(label)) throw new Error('label should be a string or regex, but got ' + (label + (' (' + (typeof label + ')'))));
+    this.predicate = { type: 'label', value: label.toString(), isRegex: isRegExp(label) };
     return this;
   }
 
   id(id) {
-    if (typeof id !== 'string') throw new Error('id should be a string, but got ' + (id + (' (' + (typeof id + ')'))));
-    this.predicate = { type: 'id', value: id };
+    if (typeof id !== 'string' && !isRegExp(id)) throw new Error('id should be a string or regex, but got ' + (id + (' (' + (typeof id + ')'))));
+    this.predicate = { type: 'id', value: id.toString(), isRegex: isRegExp(id) };
     return this;
   }
 
@@ -439,8 +443,8 @@ class Matcher {
   }
 
   text(text) {
-    if (typeof text !== 'string') throw new Error('text should be a string, but got ' + (text + (' (' + (typeof text + ')'))));
-    this.predicate = { type: 'text', value: text };
+    if (typeof text !== 'string' && !isRegExp(text)) throw new Error(`text should be a string or regex, but got ` + (text + (' (' + (typeof text + ')'))));
+    this.predicate = { type: 'text', value: text.toString(), isRegex: isRegExp(text) };
     return this;
   }
 
@@ -754,7 +758,7 @@ class IosExpect {
     this.waitFor = this.waitFor.bind(this);
     this.by = new By();
     this.web = this.web.bind(this);
-    this.web.element = this.web;
+    this.web.element = this.web().element;
   }
 
   element(matcher) {
@@ -762,6 +766,10 @@ class IosExpect {
   }
 
   expect(element) {
+    if (isWebElement(element)) {
+      return webExpect(this._invocationManager, element);
+    }
+
     return expect(this._invocationManager, element);
   }
 
@@ -769,8 +777,17 @@ class IosExpect {
     return waitFor(this._invocationManager, this._emitter, element);
   }
 
-  web(_matcher) {
-    throw new Error('Detox does not support web(), web.element() API on iOS.');
+  web(matcher) {
+    return {
+      element: webMatcher => {
+        if (!(matcher instanceof Matcher) && matcher !== undefined) {
+          throwMatcherError(matcher);
+        }
+
+        const webViewElement = matcher ? element(this._invocationManager, this._emitter, matcher) : undefined;
+        return webElement(this._invocationManager, this._emitter, webViewElement, webMatcher);
+      }
+    };
   }
 }