Automate e2e tests for Android and IOS (#296)

Changing circle ci config to run maestro e2e tests for IOS and Android. 

Also updated the tests as circle-ci's env variables were changed to use a dedicated workspace for react native tests

Author: kilian-tennyson

.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2.1
 # Default VM config to be used for macOS builds
 macos_config: &macos_config
   macos:
-    xcode: 15.3.0
+    xcode: 16.0.0
   resource_class: macos.m1.large.gen1
   shell: /bin/bash --login -eo pipefail
 
@@ -20,7 +20,8 @@ executors:
     working_directory: ~/project
 
 orbs:
-  android: circleci/[email protected]
+  android: circleci/[email protected]
+  node: circleci/[email protected]
 
 # Always run job
 run_always: &run_always
@@ -55,17 +56,13 @@ jobs:
           command: |
             corepack enable
             yarn install --cwd example
-            yarn install --cwd example/e2e
             yarn install
       - save_cache:
           key: dependencies-{{ checksum "package.json" }}
           paths: node_modules
       - save_cache:
           key: dependencies-example-{{ checksum "example/package.json" }}
           paths: example/node_modules
-      - save_cache:
-          key: dependencies-example-e2e-{{ checksum "example/package.json" }}
-          paths: example/e2e/node_modules
       - persist_to_workspace:
           root: .
           paths: .
@@ -115,18 +112,25 @@ jobs:
       JAVA_OPTS: '-Xms512m -Xmx1024m'
     executor:
       name: android/android-machine
+      tag: default
     working_directory: ~/project
     steps:
       - checkout:
           path: ~/project
+      - node/install:
+          node-version: 18.17.0
 
       - attach_workspace:
           at: ~/project
 
       - <<: *setup_env_file
 
       - run:
-          working_directory: example/e2e
+          name: Install Maestro
+          command: curl -Ls "https://get.maestro.mobile.dev" | bash
+
+      - run:
+          working_directory: example/test
           name: Build android
           command: npm run build:android
 
@@ -141,10 +145,19 @@ jobs:
           post-emulator-launch-assemble-command: echo Emulator Started
 
       - run:
-          working_directory: example/e2e
+          name: Install app on emulator
+          command: |
+            adb install -r ~/project/example/android/app/build/outputs/apk/release/app-release.apk
+
+      - run:
+          working_directory: example/test
           name: Run UI Tests
           command: npm run test:android
 
+      - store_artifacts:
+          path: ~/.maestro/tests
+          destination: maestro-tests
+
   # Build the Test App used for UI Testing and save is to the workspace. This allows it to be used by other jobs.
   ios-e2e-test:
     <<: *macos_config
@@ -155,28 +168,49 @@ jobs:
 
       - <<: *setup_env_file
 
+      - run:
+          working_directory: example/e2e
+          name: Install Maestro
+          command: curl -Ls "https://get.maestro.mobile.dev" | bash
+
       - restore_cache:
           keys:
             - pod-dependencies-{{ checksum "~/project/example/ios/Podfile" }}
       - run:
           working_directory: example/ios
           name: Install Pods
           command: pod install
+
       - save_cache:
           key: pod-dependencies-{{ checksum "~/project/example/ios/Podfile" }}
           paths:
             - ~/project/example/ios/Pods
 
       - run:
-          working_directory: example/e2e
+          working_directory: example/test
           name: Build
           command: npm run build:ios
 
       - run:
-          working_directory: example/e2e
+          name: Create and boot iPhone 15 simulator
+          command: |
+            echo "Creating iPhone 15 simulator with runtime $RUNTIME"
+            xcrun simctl create "iPhone 15" com.apple.CoreSimulator.SimDeviceType.iPhone-15 $RUNTIME
+            xcrun simctl boot "iPhone 15" || true
+
+      - run:
+          name: Install app on simulator
+          command: |
+            xcrun simctl install booted ~/project/example/test/build/Build/Products/Release-iphonesimulator/IntercomReactNativeExampleUI.app
+
+      - run:
+          working_directory: example/test
           name: Run UI Tests
           command: npm run test:ios
 
+      - store_artifacts:
+          path: ~/.maestro/tests
+          destination: maestro-tests
 
   release-to-npm:
     executor: default
@@ -224,22 +258,23 @@ workflows:
           <<: *run_always
           requires:
             - install-dependencies
-      # - android-e2e-test:
-      #     <<: *run_always
-      #     requires:
-      #       - install-dependencies
-      #       - lint
-      #       - typescript
-      #       - unit-tests
-      #       - build-package
-      # - ios-e2e-test:
-      #     <<: *run_always
-      #     requires:
-      #       - install-dependencies
-      #       - lint
-      #       - typescript
-      #       - unit-tests
-      #       - build-package
+      - android-e2e-test:
+          <<: *run_always
+          requires:
+            - install-dependencies
+            - lint
+            - typescript
+            - unit-tests
+            - build-package
+      - ios-e2e-test:
+          <<: *run_always
+          requires:
+            - install-dependencies
+            - lint
+            - typescript
+            - unit-tests
+            - build-package
+
       - release-to-npm:
           <<: *run_on_release
           context:
@@ -250,5 +285,5 @@ workflows:
             - typescript
             - unit-tests
             - build-package
-            # - ios-e2e-test
-            # - android-e2e-test
+            - ios-e2e-test
+            - android-e2e-test

example/android/app/build.gradle

@@ -42,7 +42,7 @@ react {
   // bundleAssetName = "MyApplication.android.bundle"
   //
   //   The entry file for bundle generation. Default is 'index.android.js' or 'index.js'
-  entryFile = file("index.tsx")
+  entryFile = file("../../index.tsx")
   //
   //   A list of extra flags to pass to the 'bundle' commands.
   //   See https://github.com/react-native-community/cli/blob/main/docs/commands.md#bundle

example/test/maestro/android/open-help-center.yaml

@@ -5,7 +5,9 @@ tags:
 ---
 - launchApp
 - tapOn: "Login as an Unidentified User"
+- assertVisible:
+    text: "Present Help Center"
+    enabled: true
 - tapOn: "Present Help Center"
-- assertVisible: "Help"
-- assertVisible: "Untitled Collection"
-- tapOn: "Untitled Collection"
+- assertVisible: "React Native Test Article"
+- tapOn: "React Native Test Article"

example/test/maestro/android/open-messenger.yaml

@@ -1,10 +1,13 @@
-git appId: com.example.intercomreactnative
+appId: com.example.intercomreactnative
 tags:
   - android
   - messenger
 ---
 - launchApp
 - tapOn: "Login as an Unidentified User"
+- assertVisible:
+    text: "Present Intercom"
+    enabled: true
 - tapOn: "Present Intercom"
-- tapOn: "Messenger Apps"
+- tapOn: "Messages"
 

example/test/maestro/ios/open-help-center.yaml

@@ -5,7 +5,9 @@ tags:
 ---
 - launchApp
 - tapOn: "Login as an Unidentified User"
+- assertVisible:
+    text: "Present Help Center"
+    enabled: true
 - tapOn: "Present Help Center"
-- assertVisible: "Help"
-- assertVisible: "Untitled collection"
-- tapOn: "Untitled collection"
+- assertVisible: "React Native Test Article"
+- tapOn: "React Native Test Article"

example/test/maestro/ios/open-messenger.yaml

@@ -5,6 +5,8 @@ tags:
 ---
 - launchApp
 - tapOn: "Login as an Unidentified User"
+- assertVisible:
+    text: "Present Intercom"
+    enabled: true
 - tapOn: "Present Intercom"
-- tapOn: "Messenger apps"
-
+- tapOn: "Messages"

example/test/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "intercom-react-native-example-e2e-tests",
+  "description": "Running",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "build:android": "../android/gradlew assembleRelease -Pfoss -p ../android",
+    "build:ios": "xcodebuild build -workspace ../ios/IntercomReactNativeExample.xcworkspace -scheme IntercomReactNativeExampleUI -configuration Release -sdk iphonesimulator -derivedDataPath ./build",
+    "test:android": "maestro test ./maestro/android/*.yaml",
+    "test:ios": "maestro test ./maestro/ios/*.yaml"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC"
+}