Enhance Android E2E workflow with Test Butler integration and configu…

…ration updates

.github/workflows/e2e-android.yml

@@ -70,7 +70,7 @@ jobs:
         run: echo "[]" > ~/.local/share/Detox/device.registry.state.lock
 
       - name: Get device name
-        if: ${{ success() || failure() }}
+        if: success() || failure()
         id: device
         run: node -e "console.log('AVD_NAME=' + require('./example/.detoxrc').devices.emulator.device.avdName)" >> $GITHUB_OUTPUT
 
@@ -95,6 +95,7 @@ jobs:
             --take-screenshots all \
             --capture-view-hierarchy enabled \
             --maxWorkers=1  \
+            --detectOpenHandles \
             --debug-synchronization 500 \
             -l trace \
             --cleanup

example/.detoxrc.js

@@ -15,13 +15,15 @@ module.exports = {
   },
   skipLegacyWorkersInjection: true,
   testRunner: {
+    detached: true,
+    forwardEnv: true,
     args: {
       $0: 'jest',
       config: 'e2e/jest.config.js',
-      maxWorkers: process.env.CI ? 2 : undefined,
+      maxWorkers: 1,
     },
     jest: {
-      setupTimeout: 120000,
+      setupTimeout: 1200000,
     },
   },
   artifacts: {
@@ -31,7 +33,7 @@ module.exports = {
       video: process.env.CI ? 'failing' : undefined,
       timeline: process.env.CI ? 'all' : undefined,
       instruments: process.env.CI ? 'all' : undefined,
-      uiHierarchy: process.env.DETOX_ARGV_OVERRIDE ? 'enabled' : undefined,
+      uiHierarchy: 'enabled',
     },
   },
   apps: {

example/android/app/build.gradle

@@ -85,7 +85,8 @@ android {
         versionCode 1
         versionName "1.0"
         testBuildType System.getProperty('testBuildType', 'debug')
-        testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner'
+        // testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner'
+        testInstrumentationRunner 'com.iterable.reactnativesdk.example.DetoxTestAppJUnitRunner'
     }
     signingConfigs {
         debug {
@@ -116,7 +117,6 @@ android {
 }
 
 dependencies {
-    androidTestImplementation('com.wix:detox:+')
     implementation 'androidx.appcompat:appcompat:1.1.0'
     // The version of react-native is set by the React Native Gradle Plugin
     implementation("com.facebook.react:react-android")
@@ -126,6 +126,10 @@ dependencies {
     } else {
         implementation jscFlavor
     }
+
+    // androidTestImplementation('com.wix:detox:+')
+    androidTestImplementation 'com.wix:detox:+'
+    androidTestImplementation 'com.linkedin.testbutler:test-butler-library:2.2.1'
 }
 
 apply from: file("../../node_modules/react-native-vector-icons/fonts.gradle")

example/android/app/src/androidTest/java/com/iterable.reactnativesdk.example/DetoxTestAppJUnitRunner.java

@@ -0,0 +1,21 @@
+package iterable.reactnativesdk.example;
+
+import android.os.Bundle;
+
+import com.linkedin.android.testbutler.TestButler;
+
+import androidx.test.runner.AndroidJUnitRunner;
+
+public class DetoxTestAppJUnitRunner extends AndroidJUnitRunner {
+    @Override
+    public void onStart() {
+        TestButler.setup(getTargetContext());
+        super.onStart();
+    }
+
+    @Override
+    public void finish(int resultCode, Bundle results) {
+        TestButler.teardown(getTargetContext());
+        super.finish(resultCode, results);
+    }
+}

example/android/app/src/androidTest/java/com/iterable.reactnativesdk.example/TestButlerProbe.java

@@ -0,0 +1,49 @@
+package iterable.reactnativesdk.example;
+
+import android.content.pm.PackageManager;
+import android.util.Log;
+import android.view.Surface;
+
+import com.linkedin.android.testbutler.TestButler;
+
+import androidx.test.platform.app.InstrumentationRegistry;
+
+class TestButlerProbe {
+
+    private static final String LOG_TAG = TestButlerProbe.class.getSimpleName();
+    private static final String TEST_BUTLER_PACKAGE_NAME = "com.linkedin.android.testbutler";
+
+    private TestButlerProbe() {
+    }
+
+    static void assertReadyIfInstalled() {
+        Log.i(LOG_TAG, "Test butler service verification started...");
+
+        if (!isTestButlerServiceInstalled()) {
+            Log.w(LOG_TAG, "Test butler not installed on device - skipping verification");
+            return;
+        }
+
+        assertTestButlerServiceReady();
+        Log.i(LOG_TAG, "Test butler service is up and running!");
+    }
+
+    static private boolean isTestButlerServiceInstalled() {
+        try {
+            PackageManager pm = InstrumentationRegistry.getInstrumentation().getTargetContext().getPackageManager();
+            pm.getPackageInfo(TEST_BUTLER_PACKAGE_NAME, 0);
+            return true;
+        } catch (PackageManager.NameNotFoundException e) {
+            return false;
+        }
+    }
+
+    static private void assertTestButlerServiceReady() {
+        try {
+            // This has no effect if test-butler is running. However, if it is not, then unlike TestButler.setup(), it would hard-fail.
+            TestButler.setRotation(Surface.ROTATION_0);
+        } catch (Exception e) {
+            throw new RuntimeException("Test butler service is NOT ready!", e);
+        }
+    }
+}

example/android/build.gradle

@@ -21,10 +21,11 @@ buildscript {
  allprojects {
     repositories {
         google()
-        maven { // (4)
+        mavenCentral()
+        maven {
             url("$rootDir/../node_modules/detox/Detox-android")
         }
-        maven { url 'https://www.jitpack.io' }
+        // maven { url 'https://www.jitpack.io' }
     }
 }
 

example/e2e/globalSetup.js

@@ -0,0 +1,29 @@
+import { execSync } from 'child_process';
+
+import { pathExists, ensureDir } from 'fs-extra';
+
+import { resolveConfig } from 'detox/internals';
+import { globalSetup } from 'detox/runners/jest';
+
+export default async function customGlobalSetup() {
+  const config = await resolveConfig();
+  if (config.device.type === 'android.emulator') {
+    await downloadTestButlerAPK();
+  }
+
+  await globalSetup();
+}
+
+async function downloadTestButlerAPK() {
+  const version = '2.2.1';
+  const artifactUrl = `https://repo1.maven.org/maven2/com/linkedin/testbutler/test-butler-app/${version}/test-butler-app-${version}.apk`;
+  const filePath = `cache/test-butler-app.apk`;
+
+  await ensureDir('cache');
+  if (!(await pathExists(filePath))) {
+    console.log(`\nDownloading Test-Butler APK v${version}...`);
+    execSync(`curl -f -o ${filePath} ${artifactUrl}`);
+  }
+}
+
+module.exports = customGlobalSetup;

example/e2e/jest.config.js

@@ -4,9 +4,11 @@ module.exports = {
   testMatch: ['<rootDir>/e2e/**/*.test.js'],
   testTimeout: 1200000,
   maxWorkers: 1,
-  globalSetup: 'detox/runners/jest/globalSetup',
+  // globalSetup: 'detox/runners/jest/globalSetup',
+  globalSetup: './e2e/globalSetup.js',
   globalTeardown: 'detox/runners/jest/globalTeardown',
   reporters: ['detox/runners/jest/reporter'],
   testEnvironment: 'detox/runners/jest/testEnvironment',
+  setupFilesAfterEnv: ['./e2e/setup.js'],
   verbose: true,
 };

example/e2e/setup.js

@@ -0,0 +1,17 @@
+import { device } from 'detox';
+
+// eslint-disable-next-line no-undef
+beforeAll(async () => {
+  await device.launchApp({
+    /**
+     * Uncomment the following lines to enable verbose logging of
+     * synchronization issues.
+     * See: https://wix.github.io/Detox/docs/next/troubleshooting/synchronization
+     */
+    // launchArgs: {
+    //   DTXEnableVerboseSyncSystem: 'YES',
+    //   DTXEnableVerboseSyncResources: 'YES',
+    // },
+    newInstance: true,
+  });
+});