[WIP] Run Android tests using Detox on GitHub Actions

.github/workflows/detox.yml

@@ -0,0 +1,73 @@
+name: Detox Android
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: macos-latest
+    timeout-minutes: 15
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+
+      - uses: c-hive/gha-yarn-cache@v1
+      - name: Yarn
+        run: |
+          cd ExampleProject
+          yarn install --frozen-lockfile
+
+      - name: Use specific Java version for sdkmanager to work
+        uses: joschi/setup-jdk@v2
+        with:
+          java-version: '8'
+          architecture: 'x64'
+
+      - name: Cache Gradle Wrapper
+        uses: actions/cache@v2
+        with:
+          path: ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-wrapper-${{ hashFiles('gradle/wrapper/gradle-wrapper.properties') }}
+
+      - name: Cache Gradle Dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.gradle/caches
+          key: ${{ runner.os }}-gradle-caches-${{ hashFiles('gradle/wrapper/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-caches-
+
+      - name: Download Android Emulator Image
+        run: |
+          echo "y" | $ANDROID_HOME/tools/bin/sdkmanager --install "system-images;android-29;google_apis;x86"
+          echo "no" | $ANDROID_HOME/tools/bin/avdmanager create avd --force --name Pixel_3a_API_30_x86 --device "Nexus 5X" -k 'system-images;android-29;google_apis;x86'
+          $ANDROID_HOME/emulator/emulator -list-avds
+
+      - name: Android Emulator
+        timeout-minutes: 10
+        continue-on-error: true
+        run: |
+          echo "Starting emulator"
+          nohup $ANDROID_HOME/emulator/emulator -avd Pixel_3a_API_30_x86 -no-audio -no-snapshot -no-window &
+          $ANDROID_HOME/platform-tools/adb wait-for-device shell 'while [[ -z $(getprop sys.boot_completed | tr -d '\r') ]]; do sleep 1; done; input keyevent 82'
+          $ANDROID_HOME/platform-tools/adb devices
+          echo "Emulator started"
+
+      - name: Build for detox
+        run: |
+          cd ExampleProject
+          mkdir -p android/app/src/main/assets
+          yarn run react-native bundle --platform android --dev false --entry-file index.js --bundle-output android/app/src/main/assets/index.android.bundle --assets-dest android/app/src/main/res/
+          yarn run build-detox-android
+
+      - name: Android Detox
+        run: |
+          cd ExampleProject
+          yarn run test-detox-android

.gitignore

@@ -54,3 +54,5 @@ buck-out/
 
 # Bundle artifact
 *.jsbundle
+ExampleProject/android/app/src/main/assets/index.android.bundle
+android/app/src/main/res/raw/app.json

ExampleProject/.detoxrc.json

@@ -0,0 +1,44 @@
+{
+  "testRunner": "jest",
+  "runnerConfig": "e2e/config.json",
+  "apps": {
+    "ios": {
+      "type": "ios.app",
+      "binaryPath": "SPECIFY_PATH_TO_YOUR_APP_BINARY"
+    },
+    "android.debug": {
+      "type": "android.apk",
+      "binaryPath": "android/app/build/outputs/apk/debug/app-debug.apk",
+      "build": "cd android && ./gradlew assembleDebug assembleAndroidTest -DtestBuildType=debug --no-daemon && cd .."
+    },
+    "android.release": {
+      "type": "android.apk",
+      "binaryPath": "android/app/build/outputs/apk/release/app-release.apk",
+      "build": "cd android && ./gradlew assembleRelease assembleAndroidTest -DtestBuildType=release --no-daemon && cd .."
+    }
+  },
+  "devices": {
+    "simulator": {
+      "type": "ios.simulator",
+      "device": {
+        "type": "iPhone 11"
+      }
+    },
+    "emulator": {
+      "type": "android.emulator",
+      "device": {
+        "avdName": "Pixel_3a_API_30_x86"
+      }
+    }
+  },
+  "configurations": {
+    "ios": {
+      "device": "simulator",
+      "app": "ios"
+    },
+    "android.debug": {
+      "device": "emulator",
+      "app": "android.debug"
+    }
+  }
+}

ExampleProject/App.js

@@ -64,7 +64,7 @@ function Row({label, value}) {
     <View
       style={styles.row}
       accessibilityLabel={`${label}: ${value?.toString() ?? 'unknown'}`}>
-      <Text style={styles.label}>{label}:</Text>
+      <Text style={styles.label}>{`${label}: `}</Text>
       <Text style={styles.value}>{value?.toString() ?? 'unknown'}</Text>
     </View>
   );
@@ -98,7 +98,6 @@ const styles = StyleSheet.create({
     fontSize: 16,
     color: '#444',
     fontWeight: '700',
-    marginRight: 5,
   },
   value: {
     fontSize: 16,

ExampleProject/android/app/build.gradle

@@ -136,6 +136,8 @@ android {
         targetSdkVersion rootProject.ext.targetSdkVersion
         versionCode 1
         versionName "1.0"
+        testBuildType System.getProperty('testBuildType', 'debug')  // This will later be used to control the test apk build type
+        testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner'
     }
     splits {
         abi {
@@ -210,6 +212,8 @@ dependencies {
     } else {
         implementation jscFlavor
     }
+
+    androidTestImplementation('com.wix:detox:+')
 }
 
 // Run this once to be able to run the application with BUCK

ExampleProject/android/app/src/androidTest/java/com/example/DetoxTest.java

@@ -0,0 +1,32 @@
+// Replace "com.example" here and below with your app's package name from the top of MainActivity.java
+package com.example;
+
+import com.wix.detox.Detox;
+import com.wix.detox.config.DetoxConfig;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import androidx.test.ext.junit.runners.AndroidJUnit4;
+import androidx.test.filters.LargeTest;
+import androidx.test.rule.ActivityTestRule;
+
+@RunWith(AndroidJUnit4.class)
+@LargeTest
+public class DetoxTest {
+    @Rule
+    // Replace 'MainActivity' with the value of android:name entry in
+    // <activity> in AndroidManifest.xml
+    public ActivityTestRule<MainActivity> mActivityRule = new ActivityTestRule<>(MainActivity.class, false, false);
+
+    @Test
+    public void runDetoxTests() {
+        DetoxConfig detoxConfig = new DetoxConfig();
+        detoxConfig.idlePolicyConfig.masterTimeoutSec = 90;
+        detoxConfig.idlePolicyConfig.idleResourceTimeoutSec = 60;
+        detoxConfig.rnContextLoadTimeoutSec = (com.example.BuildConfig.DEBUG ? 180 : 60);
+
+        Detox.runTests(mActivityRule, detoxConfig);
+    }
+}

ExampleProject/android/build.gradle

@@ -34,5 +34,9 @@ allprojects {
         google()
         jcenter()
         maven { url 'https://www.jitpack.io' }
+        maven {
+            // All of Detox' artifacts are provided via the npm module
+            url "$rootDir/../node_modules/detox/Detox-android"
+        }
     }
 }

ExampleProject/e2e/config.json

@@ -0,0 +1,8 @@
+{
+    "testEnvironment": "./environment",
+    "testRunner": "jest-circus/runner",
+    "testTimeout": 120000,
+    "testRegex": "\\.e2e\\.js$",
+    "reporters": ["detox/runners/jest/streamlineReporter"],
+    "verbose": true
+}

ExampleProject/e2e/environment.js

@@ -0,0 +1,23 @@
+const {
+  DetoxCircusEnvironment,
+  SpecReporter,
+  WorkerAssignReporter,
+} = require('detox/runners/jest-circus');
+
+class CustomDetoxEnvironment extends DetoxCircusEnvironment {
+  constructor(config, context) {
+    super(config, context);
+
+    // Can be safely removed, if you are content with the default value (=300000ms)
+    this.initTimeout = 300000;
+
+    // This takes care of generating status logs on a per-spec basis. By default, Jest only reports at file-level.
+    // This is strictly optional.
+    this.registerListeners({
+      SpecReporter,
+      WorkerAssignReporter,
+    });
+  }
+}
+
+module.exports = CustomDetoxEnvironment;

ExampleProject/e2e/test.e2e.js

@@ -0,0 +1,42 @@
+/* eslint-disable no-undef */
+
+describe('Example', () => {
+  beforeAll(async () => {
+    await device.launchApp();
+    await device.reloadReactNative();
+  });
+
+  it('isJailBroken', async () => {
+    await expect(element(by.label('isJailBroken: true'))).toBeVisible();
+  });
+
+  it('canMockLocation', async () => {
+    await expect(element(by.label('canMockLocation: false'))).toBeVisible();
+  });
+
+  it('trustFall', async () => {
+    await expect(element(by.label('trustFall: true'))).toBeVisible();
+  });
+
+  it('hookDetected', async () => {
+    await expect(element(by.label('hookDetected: false'))).toBeVisible();
+  });
+
+  it('isOnExternalStorage', async () => {
+    await expect(element(by.label('isOnExternalStorage: false'))).toBeVisible();
+  });
+
+  it('AdbEnabled', async () => {
+    await expect(element(by.label('AdbEnabled: true'))).toBeVisible();
+  });
+
+  it('isDevelopmentSettingsMode', async () => {
+    await expect(
+      element(by.label('isDevelopmentSettingsMode: false')),
+    ).toBeVisible();
+  });
+
+  it('isDebuggedMode', async () => {
+    await expect(element(by.label('isDebuggedMode: true'))).toBeVisible();
+  });
+});

ExampleProject/package.json

@@ -7,7 +7,9 @@
     "ios": "react-native run-ios",
     "start": "react-native start",
     "test": "jest",
-    "lint": "eslint ."
+    "lint": "eslint .",
+    "build-detox-android": "detox build -c android.debug",
+    "test-detox-android": "detox test -c android.debug"
   },
   "dependencies": {
     "jail-monkey": "../",
@@ -19,9 +21,13 @@
     "@babel/runtime": "^7.12.5",
     "@react-native-community/eslint-config": "^2.0.0",
     "babel-jest": "^26.6.3",
+    "detox": "^18.13.0",
     "eslint": "7.14.0",
     "jest": "^26.6.3",
+    "jest-circus": "^26.6.3",
+    "jest-environment-node": "^26.6.2",
     "metro-react-native-babel-preset": "^0.64.0",
+    "mocha": "^8.4.0",
     "react-test-renderer": "17.0.1"
   },
   "jest": {