Detox 20

.editorconfig

@@ -0,0 +1,30 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+tab_width = 4
+trim_trailing_whitespace = true
+
+[{*.ats,*.cts,*.mts,*.ts}]
+indent_size = 2
+tab_width = 2
+
+[detox/index.d.ts]
+indent_size = 4
+tab_width = 4
+
+[{*.cjs,*.js}]
+indent_size = 2
+tab_width = 2
+
+[{*.md,*.mdx}]
+indent_size = 2
+tab_width = 2
+
+[{*.har,*.jsb2,*.jsb3,*.json,.babelrc,.eslintrc,.prettierrc,.stylelintrc,bowerrc,jest.config}]
+indent_size = 2

.github/ISSUE_TEMPLATE/BUG_REPORT_ANDROID.yml

@@ -42,13 +42,13 @@ body:
  id: environment
  attributes:
  label: In what environment did this happen?
- description: "Note: the test-runner is set in your detox configuration file (e.g. package.json, detox.config)."
+ description: "Note: the test runner is Jest by default, unless overridden via testRunner property in your detox configuration file (e.g. package.json, detox.config)."
  value: "Detox version:
  \nReact Native version:
  \nNode version:
  \nDevice model:
  \nAndroid version:
- \nTest-runner (select one): jest-circus / jest+jasmine / mocha / other"
+ \nTest-runner (select one): jest / other"
  - type: textarea
  id: detox-logs
  attributes:

.github/ISSUE_TEMPLATE/BUG_REPORT_IOS.yml

@@ -42,15 +42,15 @@ body:
  id: environment
  attributes:
  label: In what environment did this happen?
- description: "Note: the test-runner is set in your detox configuration file (e.g. package.json, detox.config)."
+ description: "Note: the test runner is Jest by default, unless overridden via testRunner property in your detox configuration file (e.g. package.json, detox.config)."
  value: "Detox version:
  \nReact Native version:
  \nNode version:
  \nDevice model:
  \niOS version:
  \nmacOS version:
  \nXcode version:
- \nTest-runner (select one): jest-circus / jest+jasmine / mocha / other"
+ \nTest-runner (select one): jest / other"
  - type: textarea
  id: detox-logs
  attributes:

.github/ISSUE_TEMPLATE/BUG_REPORT_OTHER.yml

@@ -37,11 +37,11 @@ body:
  id: environment
  attributes:
  label: In what environment did this happen?
- description: "Note: the test-runner is set in your detox configuration file (e.g. package.json, detox.config)."
+ description: "Note: the test runner is Jest by default, unless overridden via testRunner property in your detox configuration file (e.g. package.json, detox.config)."
  value: "Detox version:
  \nReact Native version:
  \nNode version:
- \nTest-runner (select one): jest-circus / jest+jasmine / mocha / other"
+ \nTest-runner (select one): jest / other"
  - type: textarea
  id: detox-logs
  attributes:

.github/ISSUE_TEMPLATE/HELP_WITH_USING_DETOX.yml

@@ -16,10 +16,10 @@ body:
  id: environment
  attributes:
  label: Your environment
- description: "Note: the test-runner is set in your detox configuration file (e.g. package.json, detox.config)."
+ description: "Note: the test runner is set in your detox configuration file (e.g. package.json, detox.config)."
  value: "Detox version:
  \nReact Native version:
  \nNode version:
  \nDevice model:
  \nOS:
- \nTest-runner (select one): jest-circus / jest+jasmine / mocha / other"
+ \nTest-runner (select one): jest / other"

.github/workflows/rapid-test.yml

@@ -47,6 +47,14 @@ jobs:
  - name: Typings
  run: npm test
  working-directory: detox/test
- - name: Unit tests
+ - name: Unit tests (Linux)
+ if: matrix.os == 'ubuntu-latest'
  run: npm run unit
  working-directory: detox
+ - name: Unit tests (Windows)
+ if: matrix.os == 'windows-latest'
+ run: npm run unit -- --coverageThreshold "{}"
+ working-directory: detox
+ - name: Integration tests
+ run: npm run integration
+ working-directory: detox/test

.gitignore

@@ -41,8 +41,10 @@ jspm_packages
 
 ################
 # JetBrains
+# IDE
 ################
 .idea
+.vscode
 
 ## File-based project format:
 *.iws

.markdownlintrc

@@ -1,5 +1,5 @@
 {
- "first-line-heading": { "level": 2 },
+ "first-line-heading": { "level": 1 },
  "heading-style": { "style": "atx" },
  "hr-style": { "style": "---" },
  "ol-prefix": { "style": "one_or_ordered" },

.remarkignore

@@ -2,3 +2,4 @@ node_modules
 Pods
 /detox/ios
 /detox/test/ios
+/website

.retext-spell.dic

@@ -14,7 +14,9 @@ C5
 CLI
 CMD
 CocoaPods
+CommonJS
 Detox
+Docusaurus
 E2E/M
 ES5
 Genymotion
@@ -47,7 +49,10 @@ TLS
 TeamCity
 TypeScript
 UDID/M
+UUID/M
 UI/M
+UML/M
+Vitest
 WebDriver
 Wix
 XCTest
@@ -68,13 +73,14 @@ blob/M
 blogpost/M
 breakpoint/M
 bundler
+bunyan
 cancelled
 cheatsheet/M
 codebase/M
 config/M
-config/M
 customization/M
 de
+deallocate/M
 debuggable
 dedupe
 destructure/M
@@ -99,6 +105,7 @@ lockfile/M
 macOS
 matcher/M
 minification/M
+minified
 minSdkVersion
 monorepo
 multistep
@@ -129,6 +136,7 @@ repo/M
 responder/M
 roadmap/M
 runtimes
+se
 snapshotting
 subdirectories
 subdirectory/M
@@ -149,7 +157,9 @@ unobfuscated
 unregister/M
 util/M
 v12.x
+v20
 webhook/M
 websocket/M
 xcodebuild
+xcpretty
 ᵃ

CONTRIBUTING.md

@@ -1,5 +1,5 @@
-## Contributing to Detox
+# Contributing to Detox
 
 'So thrilled to know you want to contribute to Detox! 💙
 
-For learning how to do so, please refer to our [contribution guide!](docs/Guide.Contributing.md).
+For learning how to do so, please refer to our [contribution guide!](docs/guide/contributing.md).

README.md

@@ -45,12 +45,12 @@ High velocity native mobile development requires us to adopt continuous integrat
 
 The most difficult part of automated testing on mobile is the tip of the testing pyramid - E2E. The core problem with E2E tests is flakiness - tests are usually not deterministic. We believe the only way to tackle flakiness head on is by moving from black box testing to gray box testing. That’s where Detox comes into play.
 
-- **Cross Platform:** Write cross-platform tests in JavaScript. Currently supports iOS and Android.
-- **Runs on Devices** (not yet supported on iOS): Gain confidence to ship by testing your app on a device/simulator just like a real user.
+- **Cross Platform:** Write cross-platform end-to-end tests in JavaScript. Currently supports iOS and Android.
+- **Debuggable:** Modern async-await API allows breakpoints in asynchronous tests to work as expected.
 - **Automatically Synchronized:** Stops flakiness at the core by monitoring asynchronous operations in your app.
-- **Made For CI:** Execute your E2E tests on CI platforms like Travis without grief.
-- **Test Runner Independent:** Use Jest, Mocha, AVA, or any other JavaScript test runner you like (spoiler: we have our favorite).
-- **Debuggable:** Modern `async`-`await` API allows breakpoints in asynchronous tests to work as expected.
+- **Made For CI:** Execute your E2E tests on CI platforms like Travis CI, Circle CI or Jenkins without grief.
+- **Runs on Devices:** Gain confidence to ship by testing your app on a device/simulator just like a real user (not yet supported on iOS).
+- **Test Runner Agnostic:** Detox provides a set of APIs to use with any test runner without it. It comes with [Jest](https://jestjs.io) integration out of the box.
 
 ## Supported Versions
 
@@ -67,7 +67,7 @@ Detox is built from the ground up to support React Native projects as well as pu
 The following React Native versions have been tested:
 
 | iOS | Android |
-|-----------------|---------------------------------------------------------------------------------------------------------------------------|
+| --------------- | ------------------------------------------------------------------------------------------------------------------------- |
 | 0.68.x - 0.69.7 | 0.68.x - 0.69.7 -<br/>Visibility edge-case: see this [RN issue](https://github.com/facebook/react-native/issues/23870) \* |
 
 Future versions are most likely supported, but have not been tested yet. Please open issues if you find specific issues with newer React Native versions.

detox/README.md

@@ -1,4 +1,4 @@
-## Detox
+# Detox
 
 Graybox End-to-End Tests and Automation Library for Mobile
 

detox/__tests__/setupJest.js

@@ -1,4 +1,6 @@
 jest.mock('proper-lockfile');
+jest.mock('signal-exit');
+jest.mock('../src/logger/DetoxLogger');
 
 const path = require('path');
 
@@ -36,5 +38,5 @@ function callCli(modulePath, cmd) {
  });
 }
 
+// @ts-ignore
 global.callCli = callCli;
-global.IS_RUNNING_DETOX_UNIT_TESTS = true;

detox/android/detox/src/full/java/com/wix/detox/Detox.java

@@ -9,10 +9,7 @@
 import com.wix.detox.config.DetoxConfig;
 import com.wix.detox.espresso.UiControllerSpy;
 
-import java.util.concurrent.TimeUnit;
-
 import androidx.annotation.NonNull;
-import androidx.test.espresso.IdlingPolicies;
 import androidx.test.platform.app.InstrumentationRegistry;
 import androidx.test.rule.ActivityTestRule;
 
@@ -77,28 +74,6 @@ public final class Detox {
  private static final LaunchIntentsFactory sIntentsFactory = new LaunchIntentsFactory();
  private static ActivityTestRule sActivityTestRule;
 
- /**
- * Specification of values to use for Espresso's {@link IdlingPolicies} timeouts.
- * <br/>Overrides Espresso's defaults as they tend to be too short (e.g. when running a heavy-load app
- * on suboptimal CI machines).
- *
- * @deprecated Use {@link com.wix.detox.config.DetoxConfig}.
- */
- @Deprecated
- public static class DetoxIdlePolicyConfig {
- /** Directly binds to {@link IdlingPolicies#setMasterPolicyTimeout(long, TimeUnit)}. Applied in seconds. */
- public Integer masterTimeoutSec = 120;
- /** Directly binds to {@link IdlingPolicies#setIdlingResourceTimeout(long, TimeUnit)}. Applied in seconds. */
- public Integer idleResourceTimeoutSec = 60;
-
- private com.wix.detox.config.DetoxIdlePolicyConfig toNewConfig() {
- com.wix.detox.config.DetoxIdlePolicyConfig newConfig = new com.wix.detox.config.DetoxIdlePolicyConfig();
- newConfig.masterTimeoutSec = masterTimeoutSec;
- newConfig.idleResourceTimeoutSec = idleResourceTimeoutSec;
- return newConfig;
- }
- }
-
  private Detox() {
  }
 
@@ -128,20 +103,6 @@ public static void runTests(ActivityTestRule activityTestRule, DetoxConfig detox
  runTests(activityTestRule, getAppContext(), detoxConfig);
  }
 
- /**
- * Same as the default {@link #runTests(ActivityTestRule)} method, but allows for the explicit specification of
- * a custom idle-policy configuration. Note: review {@link DetoxIdlePolicyConfig} for defaults.
- *
- * @param idlePolicyConfig The custom idle-policy configuration to pass in; Will be applied into Espresso via
- * the {@link IdlingPolicies} API.
- *
- * @deprecated Use {@link #runTests(ActivityTestRule, DetoxConfig)}
- */
- @Deprecated
- public static void runTests(ActivityTestRule activityTestRule, DetoxIdlePolicyConfig idlePolicyConfig) {
- runTests(activityTestRule, getAppContext(), idlePolicyConfig);
- }
-
  /**
  * <p>
  * Use this method only if you have a React Native application and it
@@ -161,24 +122,6 @@ public static void runTests(ActivityTestRule activityTestRule, @NonNull final Co
  runTests(activityTestRule, context, new DetoxConfig());
  }
 
- /**
- * Same as {@link #runTests(ActivityTestRule, Context)}, but allows for the explicit specification of
- * a custom idle-policy configuration. Note: review {@link DetoxIdlePolicyConfig} for defaults.
- *
- *
- * @param idlePolicyConfig The custom idle-policy configuration to pass in; Will be applied into Espresso via
- * the {@link IdlingPolicies} API.
- *
- * @deprecated Use {@link #runTests(ActivityTestRule, Context, DetoxConfig)}
- */
- @Deprecated
- public static void runTests(ActivityTestRule activityTestRule, @NonNull final Context context, DetoxIdlePolicyConfig idlePolicyConfig) {
- DetoxConfig config = new DetoxConfig();
- config.idlePolicyConfig = idlePolicyConfig.toNewConfig();
-
- runTests(activityTestRule, context, config);
- }
-
  /**
  * Same as {@link #runTests(ActivityTestRule, Context)}, but allows for the explicit specification of
  * various configurations. Note: review {@link DetoxConfig} for defaults.
@@ -214,7 +157,7 @@ public static void startActivityFromUrl(String url) {
  }
 
  public static void startActivityFromNotification(String dataFilePath) {
- Bundle notificationData = new NotificationDataParser(dataFilePath).parseNotificationData();
+ Bundle notificationData = new NotificationDataParser(dataFilePath).toBundle();
  Intent intent = sIntentsFactory.intentWithNotificationData(getAppContext(), notificationData, false);
  launchActivitySync(intent);
  }
@@ -225,7 +168,7 @@ private static Intent extractInitialIntent() {
  if (sLaunchArgs.hasUrlOverride()) {
  intent = sIntentsFactory.intentWithUrl(sLaunchArgs.getUrlOverride(), true);
  } else if (sLaunchArgs.hasNotificationPath()) {
- Bundle notificationData = new NotificationDataParser(sLaunchArgs.getNotificationPath()).parseNotificationData();
+ Bundle notificationData = new NotificationDataParser(sLaunchArgs.getNotificationPath()).toBundle();
  intent = sIntentsFactory.intentWithNotificationData(getAppContext(), notificationData, true);
  } else {
  intent = sIntentsFactory.cleanIntent();

detox/android/detox/src/full/java/com/wix/detox/NotificationDataParser.kt

@@ -6,13 +6,13 @@ import com.wix.detox.common.TextFileReader
 import org.json.JSONObject
 
 internal class NotificationDataParser(private val notificationPath: String) {
- fun parseNotificationData(): Bundle {
- val rawData = readNotificationData()
+ fun toBundle(): Bundle {
+ val rawData = readNotificationFromFile()
  val json = JSONObject(rawData)
  val payload = json.getJSONObject("payload")
  return JsonConverter(payload).toBundle()
  }
 
- private fun readNotificationData()
+ private fun readNotificationFromFile()
  = TextFileReader(notificationPath).read()
 }