[MOB-8855] Improve E2E tests and fix them on Android (#683)

a7medev · web-flow · commit e1d10c1a4daa · 2022-05-24T12:48:42.000+02:00
* Configure Detox on Android

* Add e2e elements testing utility

* Add bug reporting e2e testing flow

* Add ESLint config for Detox

* Move e2e test data into `mock-data.js` utility

* Run `test_android` CI job using Android Orb

* Fix `e2e_android` CI job by running on Android Orb

* Enable `e2e_android` and `test_android` CI jobs

* Upgrade Detox to v19.5.7

* Set `test_android`'s working dir to InstabugSample

* Fix typo in CI config `android/run-tests` arg name

Change `working_directory` to `working-directory`

* Set sample's Android compile and target SDK to 31

* Upgrade Gradle to fix SDK 31 issues
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,4 +1,6 @@
-version: 2
+version: 2.1
+orbs:
+  android: circleci/android@2.0
 jobs:
   danger:
     docker:
@@ -70,24 +72,22 @@ jobs:
           path: InstabugSample/test-results
 
   test_android:
+    executor:
+      name: android/android-machine
+      tag: "2022.03.1"
     working_directory: ~/project/InstabugSample
-    docker:
-      - image: circleci/android@sha256:793ae9aa1777ba7fc375109978b307ed03a49be468295a8778d588eba0670e4b
-    environment:
-      JVM_OPTS: -Xmx3200m
     steps:
       - checkout:
           path: ~/project
-      - run: yarn
-      - run:
-          name: chmod permissions
-          command: cd android && chmod +x ./gradlew
       - run:
-          name: Download Dependencies
-          command: cd android && ./gradlew androidDependencies
+          name: Install Yarn
+          command: npm install -g yarn
       - run:
-          name: Run UnitTest
-          command: cd android && ./gradlew test
+          name: Install Node Packages
+          command: yarn
+      - android/run-tests:
+          working-directory: ./android
+          test-command: ./gradlew test
 
   test_ios:
     macos:
@@ -146,62 +146,37 @@ jobs:
           command: detox test --configuration ios.sim.release --cleanup
 
   e2e_android:
-    macos:
-      xcode: "10.2.0"
-    working_directory: ~/project/InstabugSample
+    executor:
+      name: android/android-machine
+      tag: "2022.03.1"
+    working_directory: ~/project/InstabugSample/android
     steps:
       - checkout:
           path: ~/project
-      - run:
-          name: Install Android SDK
-          command: |
-            HOMEBREW_NO_AUTO_UPDATE=1 brew tap homebrew/cask
-            HOMEBREW_NO_AUTO_UPDATE=1 brew cask install android-sdk
-      - run:
-          name: Accept Android SDK Licenses
-          command: (yes | sdkmanager --licenses) || true
-      - run:
-          name: Setup Android Environment Variables
-          command: |
-            echo 'export JAVA_HOME=`/usr/libexec/java_home -v 1.8`' >> $BASH_ENV
-            echo 'export ANDROID_HOME=/usr/local/share/android-sdk' >> $BASH_ENV
-            echo 'export ANDROID_SDK_ROOT=/usr/local/share/android-sdk' >> $BASH_ENV
-            echo 'export PATH=$PATH:$ANDROID_HOME/tools:$ANDROID_HOME/platform-tools' >> $BASH_ENV
-      - run:
-          name: SDK Manager - Download Emulator Image
-          command: (yes | sdkmanager "platform-tools" "platforms;android-27" "extras;intel;Hardware_Accelerated_Execution_Manager" "build-tools;27.0.3" "system-images;android-27;google_apis;x86" "emulator" --verbose) || true
-      - run:
-          name: AVD Manager - Setup Emulator
-          command: avdmanager create avd -n Nexus_6P_API_27 -k "system-images;android-27;google_apis;x86" -g google_apis -d "Nexus 6P"
-      - run:
-          name: Run Emulator in background
-          command: /usr/local/share/android-sdk/emulator/emulator @Nexus_6P_API_27 -noaudio -no-boot-anim -no-window
-          background: true
-      - run:
-          name: Install Node Packages
-          command: sudo yarn
-      - run:
-          name: Generate Android Keystore
-          command: cd android/app && keytool -genkey -v -keystore debug.keystore -storepass android -alias androiddebugkey -keypass android -keyalg RSA -keysize 2048 -validity 10000 -dname "CN=AA, OU=AA, O=AA, L=AA, S=AA, C=EG"
-      - run:
-          name: Make gradlew Executable
-          command: cd android && chmod +x ./gradlew
-      - run:
-          name: Download Android Dependencies
-          command: cd android && ./gradlew androidDependencies
+      - run: 
+          name: Install Yarn
+          command: npm install --global yarn
       - run:
           name: Install Detox CLI
-          command: sudo npm install -g detox-cli
+          command: npm install --global detox-cli
       - run:
-          name: Detox - Build Release App
-          command: |
-            sudo chmod -R 777 /Users/distiller/project/InstabugSample/node_modules/instabug-reactnative
-            detox build --configuration android.emu.release
+          name: Install Node Packages
+          command: yarn
+      - android/create-avd:
+          avd-name: Nexus_6P_API_27
+          install: true
+          system-image: system-images;android-27;default;x86
+      - android/start-emulator:
+          avd-name: Nexus_6P_API_27
+          no-window: true
+          post-emulator-launch-assemble-command: |
+              rm -rf ~/.gradle/caches
+              ./gradlew androidDependencies
+              cd ..
+              detox build -c android.emu.release
       - run:
           name: Detox - Run E2E Tests
-          command: |
-            sudo chmod -R 777 /Users/distiller/Library/Detox
-            detox test --configuration android.emu.release --cleanup
+          command: cd .. && detox test -c android.emu.release
 
   publish:
     macos:
@@ -216,7 +191,6 @@ jobs:
       - run: cd project && Escape react-native publish
 
 workflows:
-  version: 2
   publish:
     jobs:
       - danger:
@@ -226,15 +200,15 @@ workflows:
       - test_android
       - test_ios
       - e2e_ios
-      # - e2e_android
+      - e2e_android
       - hold:
           requires:
             - test_module
             - test_sample
-            # - test_android
+            - test_android
             - test_ios
             - e2e_ios
-            # - e2e_android
+            - e2e_android
           type: approval
           filters:
             branches:
diff --git a/InstabugSample/.eslintrc.js b/InstabugSample/.eslintrc.js
@@ -1,4 +1,16 @@
 module.exports = {
   root: true,
   extends: '@react-native-community',
+  overrides: [
+    {
+      files: ['__e2e__/**.js'],
+      env: { jest: true },
+      globals: {
+        device: false,
+        waitFor: false,
+        element: false,
+        by: false,
+      },
+    },
+  ],
 };
diff --git a/InstabugSample/__e2e__/firstTest.e2e.js b/InstabugSample/__e2e__/firstTest.e2e.js
diff --git a/InstabugSample/__e2e__/report-bug.e2e.js b/InstabugSample/__e2e__/report-bug.e2e.js
@@ -0,0 +1,21 @@
+import { getElement } from './utils/elements';
+import mockData from './utils/mock-data';
+
+beforeEach(async () => {
+  await device.launchApp();
+});
+
+beforeEach(async () => {
+  await device.reloadReactNative();
+});
+
+it('reports a bug', async () => {
+  await getElement('floatingButton').tap();
+  await getElement('reportBugMenuItem').tap();
+
+  await getElement('emailField').typeText(mockData.email);
+  await getElement('commentField').typeText(mockData.bugComment);
+  await getElement('sendBugButton').tap();
+
+  await expect(getElement('thanksMessage')).toBeVisible();
+});
diff --git a/InstabugSample/__e2e__/utils/elements.js b/InstabugSample/__e2e__/utils/elements.js
@@ -0,0 +1,48 @@
+import { device, element, by } from 'detox';
+
+const elements = {
+  floatingButton: {
+    ios: () => element(by.id('IBGFloatingButtonAccessibilityIdentifier')),
+    android: () => element(by.type('android.widget.ImageButton')),
+  },
+  reportBugMenuItem: () => element(by.text('Report a bug')),
+  emailField: {
+    ios: () => element(by.id('IBGBugInputViewEmailFieldAccessibilityIdentifier')),
+    android: () => element(by.type('android.widget.EditText')).atIndex(0),
+  },
+  commentField: {
+    ios: () => element(by.id('IBGBugInputViewCommentFieldAccessibilityIdentifier')),
+    android: () => element(by.type('android.widget.EditText')).atIndex(1),
+  },
+  sendBugButton: {
+    ios: () => element(by.id('IBGBugVCNextButtonAccessibilityIdentifier')),
+    android: () => element(by.type('androidx.appcompat.widget.ActionMenuView')),
+  },
+  thanksMessage: {
+    ios: () => element(by.text('Thank you')),
+    android: () => element(by.text('Thank you!')),
+  },
+};
+
+/**
+ * Get element based on current platform.
+ *
+ * @param {keyof elements} name
+ */
+export function getElement(name) {
+  if (!elements.hasOwnProperty(name)) {
+    throw new Error(`Element with name ${name} does not exist.`);
+  }
+
+  const el = elements[name];
+
+  if (typeof el === 'function') {
+    return el();
+  }
+
+  if (device.getPlatform() === 'ios') {
+    return el.ios();
+  }
+
+  return el.android();
+}
diff --git a/InstabugSample/__e2e__/utils/mock-data.js b/InstabugSample/__e2e__/utils/mock-data.js
@@ -0,0 +1,4 @@
+export default {
+  email: 'rn_e2e@instabug.com',
+  bugComment: 'This is a test bug',
+};
diff --git a/InstabugSample/android/app/build.gradle b/InstabugSample/android/app/build.gradle
@@ -137,7 +137,8 @@ android {
         versionCode 1
         versionName "1.0"
         multiDexEnabled true
-
+        testBuildType System.getProperty('testBuildType', 'debug')  // This will later be used to control the test apk build type
+        testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner'
     }
     splits {
         abi {
diff --git a/InstabugSample/android/app/src/androidTest/java/com/instabugsample/DetoxTest.java b/InstabugSample/android/app/src/androidTest/java/com/instabugsample/DetoxTest.java
@@ -1,6 +1,7 @@
 package com.instabugsample;
 
 import com.wix.detox.Detox;
+import com.wix.detox.config.DetoxConfig;
 
 import org.junit.Rule;
 import org.junit.Test;
@@ -19,6 +20,11 @@ public class DetoxTest {
 
     @Test
     public void runDetoxTests() {
-        Detox.runTests(mActivityRule);
+        DetoxConfig detoxConfig = new DetoxConfig();
+        detoxConfig.idlePolicyConfig.masterTimeoutSec = 90;
+        detoxConfig.idlePolicyConfig.idleResourceTimeoutSec = 60;
+        detoxConfig.rnContextLoadTimeoutSec = (com.instabugsample.BuildConfig.DEBUG ? 180 : 60);
+
+        Detox.runTests(mActivityRule, detoxConfig);
     }
 }
diff --git a/InstabugSample/android/app/src/main/AndroidManifest.xml b/InstabugSample/android/app/src/main/AndroidManifest.xml
@@ -9,9 +9,11 @@
       android:icon="@mipmap/ic_launcher"
       android:roundIcon="@mipmap/ic_launcher_round"
       android:allowBackup="false"
-      android:theme="@style/AppTheme">
+      android:theme="@style/AppTheme"
+      android:networkSecurityConfig="@xml/network_security_config">
       <activity
         android:name=".MainActivity"
+        android:exported="true"
         android:label="@string/app_name"
         android:configChanges="keyboard|keyboardHidden|orientation|screenSize|uiMode"
         android:launchMode="singleTask"
diff --git a/InstabugSample/android/app/src/main/res/xml/network_security_config.xml b/InstabugSample/android/app/src/main/res/xml/network_security_config.xml
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<network-security-config>
+    <domain-config cleartextTrafficPermitted="true">
+        <domain includeSubdomains="true">10.0.2.2</domain>
+        <domain includeSubdomains="true">localhost</domain>
+    </domain-config>
+</network-security-config>
diff --git a/InstabugSample/android/build.gradle b/InstabugSample/android/build.gradle
@@ -1,19 +1,41 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 
+subprojects { 
+    ext {
+        compileSdk = rootProject.ext.compileSdkVersion
+        minSdk = rootProject.ext.minSdkVersion
+        targetSdk = rootProject.ext.targetSdkVersion
+    }
+    afterEvaluate { subproject ->
+        if((subproject.plugins.hasPlugin('android') || subproject.plugins.hasPlugin('android-library'))) {
+            android {
+                compileSdkVersion rootProject.ext.compileSdkVersion
+                buildToolsVersion rootProject.ext.buildToolsVersion
+                defaultConfig {
+                    minSdkVersion rootProject.ext.minSdkVersion
+                    targetSdkVersion rootProject.ext.targetSdkVersion
+                }
+            }
+        }
+    }
+}
+
 buildscript {
     ext {
-        buildToolsVersion = "30.0.2"
+        buildToolsVersion = "31.0.0"
         minSdkVersion = 21
-        compileSdkVersion = 30
-        targetSdkVersion = 30
+        compileSdkVersion = 31
+        targetSdkVersion = 31
         ndkVersion = "21.4.7075529"
+        kotlinVersion = "1.5.30"
     }
     repositories {
         google()
         mavenCentral()
     }
     dependencies {
-        classpath("com.android.tools.build:gradle:4.2.2")
+        classpath("com.android.tools.build:gradle:7.0.4")
+        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion")
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }
diff --git a/InstabugSample/android/gradle/wrapper/gradle-wrapper.properties b/InstabugSample/android/gradle/wrapper/gradle-wrapper.properties
@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.9-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
diff --git a/InstabugSample/package.json b/InstabugSample/package.json
@@ -23,7 +23,7 @@
     "@babel/runtime": "^7.15.4",
     "@react-native-community/eslint-config": "^3.0.1",
     "babel-jest": "^27.2.5",
-    "detox": "^18.22.1",
+    "detox": "^19.5.7",
     "eslint": "^7.32.0",
     "jest": "^27.2.5",
     "metro-react-native-babel-preset": "^0.66.2",
diff --git a/InstabugSample/yarn.lock b/InstabugSample/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +export default {
 +  email: '[email protected]',
 +  bugComment: 'This is a test bug',
 +};