detox 20.22.0-smoke.0 → 20.22.0

package/src/ios/system.js

@@ -0,0 +1,124 @@
+const { DetoxRuntimeError } = require('../errors');
+const { assertTraceDescription } = require('../utils/assertArgument');
+const { systemActionDescription, expectDescription } = require('../utils/invocationTraceDescriptions');
+const log = require('../utils/logger').child({ cat: 'ws-client, ws' });
+const traceInvocationCall = require('../utils/traceInvocationCall').bind(null, log);
+
+
+class SystemExpect {
+  constructor(xcuitestRunner, element) {
+    this._xcuitestRunner = xcuitestRunner;
+    this.element = element;
+    this.modifiers = [];
+  }
+
+  toExist() {
+    const traceDescription = expectDescription.toExist();
+    return this.expect('toExist', traceDescription);
+  }
+
+  get not() {
+    this.modifiers.push('not');
+    return this;
+  }
+
+  createInvocation(systemExpectation) {
+    return {
+      type: 'systemExpectation',
+      systemPredicate: this.element.matcher.predicate,
+      ...(this.element.index !== undefined && { systemAtIndex: this.element.index }),
+      ...(this.modifiers.length !== 0 && { systemModifiers: this.modifiers }),
+      systemExpectation
+    };
+  }
+
+  expect(expectation, traceDescription) {
+    assertTraceDescription(traceDescription);
+
+    const invocation = this.createInvocation(expectation);
+    traceDescription = expectDescription.full(traceDescription, this.modifiers.includes('not'));
+    return _executeInvocation(this._xcuitestRunner, invocation, traceDescription);
+  }
+}
+
+class SystemElement {
+  constructor(xcuitestRunner, matcher, index) {
+    this._xcuitestRunner = xcuitestRunner;
+    this.matcher = matcher;
+    this.index = index;
+  }
+
+  atIndex(index) {
+    if (typeof index !== 'number' || index < 0) throw new DetoxRuntimeError(`index should be an integer, got ${index} (${typeof index})`);
+    this.index = index;
+    return this;
+  }
+
+  tap() {
+    const traceDescription = systemActionDescription.tap();
+    return this.withAction('tap', traceDescription);
+  }
+
+  withAction(action, traceDescription) {
+    assertTraceDescription(traceDescription);
+
+    const invocation = {
+      type: 'systemAction',
+      systemPredicate: this.matcher.predicate,
+      ...(this.index !== undefined && { systemAtIndex: this.index }),
+      systemAction: action
+    };
+    traceDescription = systemActionDescription.full(traceDescription);
+    return _executeInvocation(this._xcuitestRunner, invocation, traceDescription);
+  }
+}
+
+class SystemElementMatcher {
+  label(label) {
+    if (typeof label !== 'string') throw new DetoxRuntimeError('label should be a string, but got ' + (label + (' (' + typeof label + ')')));
+    this.predicate = { type: 'label', value: label.toString() };
+    return this;
+  }
+
+  type(type) {
+    if (typeof type !== 'string') throw new DetoxRuntimeError('type should be a string, but got ' + (type + (' (' + typeof type + ')')));
+    this.predicate = { type: 'type', value: type.toString() };
+    return this;
+  }
+}
+
+function systemMatcher() {
+  return new SystemElementMatcher();
+}
+
+function systemElement(xcuitestRunner, matcher) {
+  if (!(matcher instanceof SystemElementMatcher)) {
+    throwSystemMatcherError(matcher);
+  }
+
+  return new SystemElement(xcuitestRunner, matcher);
+}
+
+function throwSystemMatcherError(param) {
+  const paramDescription = JSON.stringify(param);
+  throw new DetoxRuntimeError(`${paramDescription} is not a Detox system matcher. More about system matchers here: https://wix.github.io/Detox/docs/api/system`);
+}
+
+function systemExpect(xcuitestRunner, element) {
+  return new SystemExpect(xcuitestRunner, element);
+}
+
+function _executeInvocation(xcuitestRunner, invocation, traceDescription) {
+  return traceInvocationCall(traceDescription, invocation, xcuitestRunner.execute(invocation));
+}
+
+function isSystemElement(element) {
+  return element instanceof SystemElement;
+}
+
+module.exports = {
+  systemMatcher,
+  systemElement,
+  systemExpect,
+  isSystemElement
+};

package/src/ios/web.js

@@ -1,8 +1,7 @@
-const assert = require('assert');
-
 const _ = require('lodash');
 
 const { DetoxRuntimeError } = require('../errors');
+const { assertTraceDescription } = require('../utils/assertArgument');
 const { webViewActionDescription, expectDescription } = require('../utils/invocationTraceDescriptions');
 const log = require('../utils/logger').child({ cat: 'ws-client, ws' });
 const traceInvocationCall = require('../utils/traceInvocationCall').bind(null, log);
@@ -48,7 +47,7 @@ class WebExpect {
   }
 
   expect(expectation, traceDescription, ...params) {
-    assert(traceDescription, `must provide trace description for expectation: \n ${JSON.stringify(expectation)}`);
+    assertTraceDescription(traceDescription);
 
     const invocation = this.createInvocation(expectation, ...params);
     traceDescription = expectDescription.full(traceDescription, this.modifiers.includes('not'));
@@ -170,7 +169,7 @@ class WebElement {
   }
 
   withAction(action, traceDescription, ...params) {
-    assert(traceDescription, `must provide trace description for action: \n ${JSON.stringify(action)}`);
+    assertTraceDescription(traceDescription);
 
     const invocation = {
       type: 'webAction',

package/src/matchers/factories/index.js

@@ -12,19 +12,20 @@ class Android extends MatchersFactory {
 }
 
 class Ios extends MatchersFactory {
-  createMatchers({ invocationManager, eventEmitter }) {
+  createMatchers({ invocationManager, runtimeDevice, eventEmitter }) {
     const IosExpect = require('../../ios/expectTwo');
-    return new IosExpect({ invocationManager, emitter: eventEmitter });
+    const XCUITestRunner = require('../../ios/XCUITestRunner');
+    const xcuitestRunner = new XCUITestRunner({ simulatorId: runtimeDevice.id });
+
+    return new IosExpect({
+      invocationManager,
+      xcuitestRunner,
+      emitter: eventEmitter
+    });
   }
 }
 
 class External extends MatchersFactory {
-  static validateModule(module, path) {
-    if (!module.ExpectClass) {
-      throw new DetoxRuntimeError(`The custom driver at '${path}' does not export the ExpectClass property`);
-    }
-  }
-
   constructor(module, path) {
     super();
     External.validateModule(module, path);
@@ -32,6 +33,12 @@ class External extends MatchersFactory {
     this._module = module;
   }
 
+  static validateModule(module, path) {
+    if (!module.ExpectClass) {
+      throw new DetoxRuntimeError(`The custom driver at '${path}' does not export the ExpectClass property`);
+    }
+  }
+
   createMatchers(deps) {
     return new this._module.ExpectClass(deps);
   }

package/src/utils/assertArgument.js

@@ -1,4 +1,4 @@
-const DetoxRuntimeError = require('../errors/DetoxRuntimeError');
+const { DetoxInternalError, DetoxRuntimeError } = require('../errors');
 
 function firstEntry(obj) {
   return Object.entries(obj)[0];
@@ -61,6 +61,14 @@ function assertUndefined(arg) {
   throw new DetoxRuntimeError(`${key} expected to be undefined, but got ${value} (${typeof value})`);
 }
 
+function assertTraceDescription(arg) {
+  if (arg !== undefined) {
+    return true;
+  }
+
+  throw new DetoxInternalError(`traceDescription expected to be defined, but got undefined`);
+}
+
 module.exports = {
   assertEnum,
   assertNormalized,
@@ -68,5 +76,6 @@ module.exports = {
   assertString,
   assertDuration,
   assertPoint,
-  assertUndefined
+  assertUndefined,
+  assertTraceDescription
 };

package/src/utils/environment.js

@@ -1,3 +1,4 @@
+const crypto = require('crypto');
 const fs = require('fs');
 const os = require('os');
 const path = require('path');
@@ -171,24 +172,40 @@ function throwMissingGmsaasError() {
   throw new DetoxRuntimeError(`Failed to locate Genymotion's gmsaas executable. Please add it to your $PATH variable!\nPATH is currently set to: ${process.env.PATH}`);
 }
 
-function getDetoxVersion() {
+const getDetoxVersion = _.once(() => {
   return require(path.join(__dirname, '../../package.json')).version;
-}
+});
 
-let _iosFrameworkPath;
-async function getFrameworkPath() {
-  if (!_iosFrameworkPath) {
-    _iosFrameworkPath = _doGetFrameworkPath();
-  }
+const getBuildFolderName = _.once(async () => {
+  const detoxVersion = getDetoxVersion();
+  const xcodeVersion = await exec('xcodebuild -version').then(result => result.stdout.trim());
 
-  return _iosFrameworkPath;
-}
+  return crypto.createHash('sha1')
+      .update(`${detoxVersion}\n${xcodeVersion}\n`)
+      .digest('hex');
+});
 
-async function _doGetFrameworkPath() {
-  const detoxVersion = getDetoxVersion();
-  const sha1 = (await exec(`(echo "${detoxVersion}" && xcodebuild -version) | shasum | awk '{print $1}'`)).stdout.trim();
-  return `${DETOX_LIBRARY_ROOT_PATH}/ios/${sha1}/Detox.framework`;
-}
+const getFrameworkDirPath = `${DETOX_LIBRARY_ROOT_PATH}/ios/framework`;
+
+const getFrameworkPath = _.once(async () => {
+  const buildFolder = await getBuildFolderName();
+  return `${getFrameworkDirPath}/${buildFolder}/Detox.framework`;
+});
+
+const getXCUITestRunnerDirPath = `${DETOX_LIBRARY_ROOT_PATH}/ios/xcuitest-runner`;
+
+const getXCUITestRunnerPath = _.once(async () => {
+  const buildFolder = await getBuildFolderName();
+  const derivedDataPath = `${getXCUITestRunnerDirPath}/${buildFolder}`;
+  const xctestrunPath = await exec(`find ${derivedDataPath} -name "*.xctestrun" -print -quit`)
+      .then(result => result.stdout.trim());
+
+  if (!xctestrunPath) {
+    throw new DetoxRuntimeError(`Failed to find .xctestrun file in ${derivedDataPath}`);
+  }
+
+  return xctestrunPath;
+});
 
 function getDetoxLibraryRootPath() {
   return DETOX_LIBRARY_ROOT_PATH;
@@ -219,7 +236,10 @@ module.exports = {
   getAndroidSdkManagerPath,
   getGmsaasPath,
   getDetoxVersion,
+  getFrameworkDirPath,
   getFrameworkPath,
+  getXCUITestRunnerDirPath,
+  getXCUITestRunnerPath,
   getAndroidSDKPath,
   getAndroidEmulatorPath,
   getDetoxLibraryRootPath,

package/src/utils/invocationTraceDescriptions.js

@@ -43,6 +43,10 @@ module.exports = {
     getTitle: () => 'get title',
     full: (actionDescription) => `perform web view action: ${actionDescription}`
   },
+  systemActionDescription: {
+    tap: () => `tap`,
+    full: (actionDescription) => `perform system action: ${actionDescription}`
+  },
   expectDescription: {
     waitFor: (actionDescription) => `wait for expectation while ${actionDescription}`,
     waitForWithTimeout: (expectDescription, timeout) => `${expectDescription} with timeout (${timeout} ms)`,

package/Detox-android/com/wix/detox/20.22.0-smoke.0/detox-20.22.0-smoke.0-sources.jar.md5

@@ -1 +0,0 @@
-c4f4ccfd2fcba821086c7873260e855f

package/Detox-android/com/wix/detox/20.22.0-smoke.0/detox-20.22.0-smoke.0-sources.jar.sha1

@@ -1 +0,0 @@
-592e743660ec3256a4fbf492f9b426522512f62b

package/Detox-android/com/wix/detox/20.22.0-smoke.0/detox-20.22.0-smoke.0-sources.jar.sha256

@@ -1 +0,0 @@
-d88429a82475ff09df92573cf92a97b2787c7f62d371faafa004a39308f08b3f

package/Detox-android/com/wix/detox/20.22.0-smoke.0/detox-20.22.0-smoke.0-sources.jar.sha512

@@ -1 +0,0 @@
-cc8a61587f9e6c0ac85925cfbf3bb13ef42e2051f40675c88d80a7de82dedcc60fc46633575aef42721876eaad742bb107bd7e0e9f532903db9adc0a83115031

package/Detox-android/com/wix/detox/20.22.0-smoke.0/detox-20.22.0-smoke.0.pom.md5

@@ -1 +0,0 @@
-08b5bbe3db6b9be9616306b3570f7cb3

package/Detox-android/com/wix/detox/20.22.0-smoke.0/detox-20.22.0-smoke.0.pom.sha1

@@ -1 +0,0 @@
-dad3ec9cb42187fbe4f7a9b51fd24dd23fa45530

package/Detox-android/com/wix/detox/20.22.0-smoke.0/detox-20.22.0-smoke.0.pom.sha256

@@ -1 +0,0 @@
-c7190cb71ca0226b2f23abf05f3522989f319f68f8300c17bf31eb547ded8b66

package/Detox-android/com/wix/detox/20.22.0-smoke.0/detox-20.22.0-smoke.0.pom.sha512

@@ -1 +0,0 @@
-f0b4f5f51b5dec733b11d1af4b0bc77017895bbb17833f50a6640df7882f605dbc18569494d9aaece54270cf7fe87bf7060000d4802349d8e109b188bdd730b4

package/Detox-android/com/wix/detox-legacy/20.22.0-smoke.0/detox-legacy-20.22.0-smoke.0-sources.jar.md5

@@ -1 +0,0 @@
-49feaf179a792588002f3946ebac055e

package/Detox-android/com/wix/detox-legacy/20.22.0-smoke.0/detox-legacy-20.22.0-smoke.0-sources.jar.sha1

@@ -1 +0,0 @@
-9505116d7cfb3b316e86ac32d28d903d35627852

package/Detox-android/com/wix/detox-legacy/20.22.0-smoke.0/detox-legacy-20.22.0-smoke.0-sources.jar.sha256

@@ -1 +0,0 @@
-441dc5808b355d05ab08c63bde1d1a8fbb908fb7e268b3ea17d03cbb391b1ef4

package/Detox-android/com/wix/detox-legacy/20.22.0-smoke.0/detox-legacy-20.22.0-smoke.0-sources.jar.sha512

@@ -1 +0,0 @@
-acbb6862e83102362156aaa16d0c7b5daa77dced0ad2a4bc100b5efcb1a3418b6f6f1c9bf60d255c9e215192aa2141fcd0d0633e620e7de724d1452850348141

package/Detox-android/com/wix/detox-legacy/20.22.0-smoke.0/detox-legacy-20.22.0-smoke.0.pom.md5

@@ -1 +0,0 @@
-bff85a185e636b4f4b6f382af440ea16

package/Detox-android/com/wix/detox-legacy/20.22.0-smoke.0/detox-legacy-20.22.0-smoke.0.pom.sha1

@@ -1 +0,0 @@
-d3d2aa3a8d5cadc566cf10a7da2a2ad698fd6f7d

package/Detox-android/com/wix/detox-legacy/20.22.0-smoke.0/detox-legacy-20.22.0-smoke.0.pom.sha256

@@ -1 +0,0 @@
-de03cc9848d2a6c0270536ff68c49f60c7bb654cd88ffe99f8e37a87d361350a

package/Detox-android/com/wix/detox-legacy/20.22.0-smoke.0/detox-legacy-20.22.0-smoke.0.pom.sha512

@@ -1 +0,0 @@
-22870bcbdaa0a9c7a061947742541588a41bd20753006af39eceb089882b57fcea144874247c16320c8d9c096db043f666e862f93732eb898db26e9024d5bc8f

package/scripts/build_universal_framework.sh

@@ -1,14 +0,0 @@
-#!/bin/bash -e
-
-SCRIPTPATH="$( cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
-
-XCODEVERSION=$(xcodebuild -version | grep -oEi "([0-9]*(\.[0-9]*)+)")
-if [ "${XCODEVERSION}" == "`echo -e "${XCODEVERSION}\n12.0" | sort --version-sort -r | head -n1`" ]; then
-  echo "Xcode 12 and above; using modern script for building the framework to support Apple Silicon"
-  FRAMEWORK_SCRIPT="build_universal_framework_modern.sh"
-else
-  echo "Xcode 11 and below; using legacy script for building"
-  FRAMEWORK_SCRIPT="build_universal_framework_legacy.sh"
-fi
-
-"${SCRIPTPATH}/${FRAMEWORK_SCRIPT}" "$@"

package/scripts/build_universal_framework_legacy.sh

@@ -1,76 +0,0 @@
-#!/bin/bash -e
-
-PROJECT=$1
-OUTPUT_DIR=$2
-CONFIGURATION=Release
-PROJECT_NAME=Detox
-
-set -e
-
-function remove_arch() {
-    lipo -create "${1}" "${2}" -output "${3}"
-}
-
-# Make sure the output directory exists
-
-mkdir -p "${OUTPUT_DIR}"
-rm -fr "${OUTPUT_DIR}/${PROJECT_NAME}.framework"
-
-TEMP_DIR=$(mktemp -d "$TMPDIR"DetoxBuild.XXXX)
-echo TEMP_DIR = "${TEMP_DIR}"
-
-# Step 0. Xcode version
-
-XCODEVERSION=$(xcodebuild -version | grep -oEi "([0-9]*(\.[0-9]*)+)")
-echo "Xcode ${XCODEVERSION}"
-USE_NEW_BUILD_SYSTEM="YES"
-if [ "${XCODEVERSION}" != "`echo -e "${XCODEVERSION}\n11.0" | sort --version-sort -r | head -n1`" ]; then
-  USE_NEW_BUILD_SYSTEM="NO"
-fi
-echo "Using -UseNewBuildSystem=${USE_NEW_BUILD_SYSTEM}"
-
-# Step 1. Build Device and Simulator versions
-
-BUILD_IOS=`xcodebuild -project "${PROJECT}" -UseNewBuildSystem=${USE_NEW_BUILD_SYSTEM} -scheme Detox -configuration "${CONFIGURATION}" -arch arm64  -sdk iphoneos        ONLY_ACTIVE_ARCH=NO VALID_ARCHS=arm64  -showBuildSettings  | awk -F= '/TARGET_BUILD_DIR/{x=$NF; gsub(/^[ \t]+|[ \t]+$/,"",x); print x}'`
-BUILD_SIM=`xcodebuild -project "${PROJECT}" -UseNewBuildSystem=${USE_NEW_BUILD_SYSTEM} -scheme Detox -configuration "${CONFIGURATION}" -arch x86_64 -sdk iphonesimulator ONLY_ACTIVE_ARCH=NO VALID_ARCHS=x86_64 -showBuildSettings  | awk -F= '/TARGET_BUILD_DIR/{x=$NF; gsub(/^[ \t]+|[ \t]+$/,"",x); print x}'`
-
-echo ${BUILD_IOS}
-echo ${BUILD_SIM}
-
-xcodebuild -project "${PROJECT}" -UseNewBuildSystem=${USE_NEW_BUILD_SYSTEM} -scheme Detox -configuration "${CONFIGURATION}" -arch arm64  -sdk iphoneos        ONLY_ACTIVE_ARCH=NO clean build VALID_ARCHS=arm64 -quiet
-xcodebuild -project "${PROJECT}" -UseNewBuildSystem=${USE_NEW_BUILD_SYSTEM} -scheme Detox -configuration "${CONFIGURATION}" -arch x86_64 -sdk iphonesimulator ONLY_ACTIVE_ARCH=NO       build VALID_ARCHS=x86_64 -quiet
-
-# Step 2. Copy the framework structure (from iphoneos build) to the universal folder
-
-cp -fR "${BUILD_IOS}/${PROJECT_NAME}.framework" "${TEMP_DIR}/"
-
-# Step 3. Copy Swift modules from iphonesimulator build (if it exists) to the copied framework directory
-
-SIMULATOR_SWIFT_MODULES_DIR="${BUILD_SIM}/${PROJECT_NAME}.framework/Modules/${PROJECT_NAME}.swiftmodule/."
-if [ -d "${SIMULATOR_SWIFT_MODULES_DIR}" ]; then
-cp -fR "${SIMULATOR_SWIFT_MODULES_DIR}" "${TEMP_DIR}/${PROJECT_NAME}.framework/Modules/${PROJECT_NAME}.swiftmodule"
-fi
-
-# Step 4. Create universal binary file using lipo and place the combined executable in the copied framework directory
-
-remove_arch "${BUILD_SIM}/${PROJECT_NAME}.framework/${PROJECT_NAME}" "${BUILD_IOS}/${PROJECT_NAME}.framework/${PROJECT_NAME}" "${TEMP_DIR}/${PROJECT_NAME}.framework/${PROJECT_NAME}"
-
-# Step 5. Create universal binaries for embedded frameworks
-
-for SUB_FRAMEWORK in $( ls "${TEMP_DIR}/${PROJECT_NAME}.framework/Frameworks" ); do
-if [ -d "${TEMP_DIR}/${PROJECT_NAME}.framework/Frameworks/$SUB_FRAMEWORK" ]; then
-echo "Processing ${SUB_FRAMEWORK} as a dir"
-BINARY_NAME="${SUB_FRAMEWORK%.*}"
-
-remove_arch "${BUILD_SIM}/${PROJECT_NAME}.framework/Frameworks/${SUB_FRAMEWORK}/${BINARY_NAME}" "${BUILD_IOS}/${PROJECT_NAME}.framework/Frameworks/${SUB_FRAMEWORK}/${BINARY_NAME}" "${TEMP_DIR}/${PROJECT_NAME}.framework/Frameworks/${SUB_FRAMEWORK}/${BINARY_NAME}"
-
-else
-echo "Processing ${SUB_FRAMEWORK} as a file"
-
-remove_arch "${BUILD_SIM}/${PROJECT_NAME}.framework/Frameworks/${SUB_FRAMEWORK}" "${BUILD_IOS}/${PROJECT_NAME}.framework/Frameworks/${SUB_FRAMEWORK}" "${TEMP_DIR}/${PROJECT_NAME}.framework/Frameworks/${SUB_FRAMEWORK}"
-
-fi
-done
-
-mv "${TEMP_DIR}/${PROJECT_NAME}.framework" "${OUTPUT_DIR}"/
-rm -fr "${TEMP_DIR}"

package/scripts/build_universal_framework_modern.sh

@@ -1,28 +0,0 @@
-#!/bin/bash -e
-
-PROJECT=$1
-OUTPUT_DIR=$2
-CONFIGURATION=Release
-PROJECT_NAME=Detox
-
-# Make sure the output directory exists
-
-mkdir -p "${OUTPUT_DIR}"
-rm -fr "${OUTPUT_DIR}/${PROJECT_NAME}.framework"
-
-# Step 0. Xcode version
-
-USE_NEW_BUILD_SYSTEM="YES"
-echo "Using -UseNewBuildSystem=${USE_NEW_BUILD_SYSTEM}"
-
-# Step 1. Build Device and Simulator versions
-
-BUILD_SIM=`xcodebuild -project "${PROJECT}" -scheme "Detox" -UseNewBuildSystem=${USE_NEW_BUILD_SYSTEM} -configuration "${CONFIGURATION}" -sdk iphonesimulator -destination "generic/platform=iOS Simulator" build -showBuildSettings  | awk -F= '/TARGET_BUILD_DIR/{x=$NF; gsub(/^[ \t]+|[ \t]+$/,"",x); print x}'`
-
-echo ${BUILD_SIM}
-
-xcodebuild -project "${PROJECT}" -scheme "Detox" -UseNewBuildSystem=${USE_NEW_BUILD_SYSTEM} -configuration "${CONFIGURATION}" -sdk iphonesimulator -destination "generic/platform=iOS Simulator" build -quiet
-
-# Step 2. Copy the framework to output folder
-
-cp -fR "${BUILD_SIM}/${PROJECT_NAME}.framework" "${OUTPUT_DIR}"/