ci: run E2E suites in demo apps

.changeset/clever-mirrors-dream.md

@@ -0,0 +1,5 @@
+---
+'@callstack/brownfield-navigation': minor
+---
+
+e2e tests

.github/actions/appleapp-road-test/action.yml

@@ -1,15 +1,25 @@
 name: Apple road test (selected RN app & AppleApp)
-description: Package the given RN app as XCFramework, and build the corresponding AppleApp variant
+description: Package the given RN app as XCFramework, build the corresponding AppleApp variant, and optionally run Detox E2E
 
 inputs:
   variant:
-    description: 'AppleApp yarn command variant to run (expo or vanilla)'
+    description: 'AppleApp yarn command variant to run (vanilla or expo<version>)'
     required: true
 
   rn-project-path:
     description: 'Path to the RN project to build'
     required: true
 
+  run-e2e:
+    description: 'Run Detox E2E after packaging (uses Debug build instead of Release road-test build)'
+    required: false
+    default: 'false'
+
+  e2e-artifact-name:
+    description: 'Name prefix for Detox artifacts uploaded on failure'
+    required: false
+    default: 'detox-appleapp'
+
 runs:
   using: composite
   steps:
@@ -31,6 +41,13 @@ runs:
       run: brew install ccache
       shell: bash
 
+    - name: Install applesimutils
+      if: inputs.run-e2e == 'true'
+      run: |
+        brew tap wix/brew
+        brew install applesimutils
+      shell: bash
+
     - name: Enable ccache
       run: echo "$(brew --prefix)/opt/ccache/libexec" >> $GITHUB_PATH
       shell: bash
@@ -55,8 +72,27 @@ runs:
         restore-keys: |
           ${{ runner.os }}-rnapp-${{ inputs.variant }}-ios-pods-
 
+    - name: Brownfield codegen (RN ${{ inputs.variant }} app)
+      if: inputs.variant == 'vanilla' && inputs.run-e2e == 'true'
+      run: yarn codegen
+      working-directory: ${{ inputs.rn-project-path }}
+      shell: bash
+
+    # RN 0.84+ defaults to prebuilt RNCore during pod install. For the Detox packaging
+    # step we build RN from source so native deps (e.g. react-native-screens) link against
+    # the same headers as the Debug simulator XCFramework. Road-test builds without E2E
+    # keep the default prebuilt path for faster CI.
+    - name: Install pods (RN ${{ inputs.variant }} app, E2E)
+      if: inputs.variant == 'vanilla' && inputs.run-e2e == 'true'
+      env:
+        RCT_USE_PREBUILT_RNCORE: '0'
+      run: |
+        cd ${{ inputs.rn-project-path }}/ios
+        pod install
+      shell: bash
+
     - name: Install pods (RN ${{ inputs.variant }} app)
-      if: inputs.variant == 'vanilla'
+      if: inputs.variant == 'vanilla' && inputs.run-e2e != 'true'
       run: |
         cd ${{ inputs.rn-project-path }}/ios
         pod install
@@ -79,10 +115,97 @@ runs:
     # == AppleApp ==
 
     - name: Build Brownfield iOS native app (${{ inputs.variant }})
+      if: inputs.run-e2e != 'true'
       run: |
         yarn run build:example:ios-consumer:${{ inputs.variant }}
       shell: bash
 
+    - name: Resolve AppleApp E2E settings
+      if: inputs.run-e2e == 'true'
+      run: |
+        node <<'NODE'
+        const { getAppleAppDetoxVariant } = require('./apps/brownfield-example-shared-tests/detox-appleapp-variants.cjs');
+        const variant = getAppleAppDetoxVariant(process.env.APPLEAPP_VARIANT);
+        const append = (key, value) => {
+          const fs = require('node:fs');
+          fs.appendFileSync(process.env.GITHUB_ENV, `${key}=${value}\n`);
+        };
+        append('APPLEAPP_XCFRAMEWORK_APP', variant.xcframeworkApp);
+        append('APPLEAPP_E2E_CONFIGURATION', variant.configuration);
+        append('APPLEAPP_E2E_BUILD_SCRIPT', variant.e2eBuildScript);
+        append('APPLEAPP_E2E_TEST_SCRIPT', variant.e2eTestScript);
+        NODE
+      env:
+        APPLEAPP_VARIANT: ${{ inputs.variant }}
+      shell: bash
+
+    - name: Copy XCFrameworks into AppleApp
+      if: inputs.run-e2e == 'true'
+      run: node prepareXCFrameworks.js --appName "$APPLEAPP_XCFRAMEWORK_APP"
+      working-directory: apps/AppleApp
+      shell: bash
+
+    - name: Restore Detox build cache (AppleApp)
+      if: inputs.run-e2e == 'true'
+      uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5
+      with:
+        path: apps/AppleApp/build
+        key: ${{ runner.os }}-e2e-appleapp-${{ inputs.variant }}-build-${{ hashFiles(format('{0}/ios/Podfile.lock', inputs.rn-project-path), 'apps/AppleApp/Brownfield Apple App.xcodeproj/project.pbxproj', 'apps/brownfield-example-shared-tests/e2e/**') }}
+        restore-keys: |
+          ${{ runner.os }}-e2e-appleapp-${{ inputs.variant }}-build-
+
+    - name: Install Detox iOS artifacts
+      if: inputs.run-e2e == 'true'
+      run: node node_modules/detox/scripts/postinstall.js
+      working-directory: apps/AppleApp
+      shell: bash
+
+    - name: Detox build (AppleApp ${{ inputs.variant }})
+      if: inputs.run-e2e == 'true'
+      run: yarn "$APPLEAPP_E2E_BUILD_SCRIPT"
+      working-directory: apps/AppleApp
+      shell: bash
+
+    - name: Verify embedded JS bundle in BrownfieldLib (E2E)
+      if: inputs.run-e2e == 'true'
+      run: |
+        set -euo pipefail
+        PRODUCTS_DIR="apps/AppleApp/build/Build/Products/${APPLEAPP_E2E_CONFIGURATION}-iphonesimulator"
+        APP_PATH="$(find "$PRODUCTS_DIR" -maxdepth 1 -name '*.app' -print -quit)"
+        if [[ -z "$APP_PATH" ]]; then
+          echo "error: no .app under $PRODUCTS_DIR" >&2
+          exit 1
+        fi
+        EXECUTABLE_PATH="$APP_PATH/$(basename "$APP_PATH" .app)"
+        if [[ ! -f "$EXECUTABLE_PATH" ]]; then
+          echo "error: $EXECUTABLE_PATH missing — host app target produced an invalid .app (no bundle executable)." >&2
+          echo "Check AppleApp target membership for BrownfieldAppleApp.swift and related sources." >&2
+          exit 1
+        fi
+        BUNDLE_PATH="$APP_PATH/Frameworks/BrownfieldLib.framework/main.jsbundle"
+        if [[ ! -f "$BUNDLE_PATH" ]]; then
+          echo "error: $BUNDLE_PATH missing — E2E needs the packaged ${APPLEAPP_XCFRAMEWORK_APP} bundle, not Metro." >&2
+          echo "Re-run: yarn brownfield:package:ios (${APPLEAPP_XCFRAMEWORK_APP}) && node prepareXCFrameworks.js --appName ${APPLEAPP_XCFRAMEWORK_APP}" >&2
+          exit 1
+        fi
+        echo "App executable OK: $EXECUTABLE_PATH ($(wc -c < "$EXECUTABLE_PATH") bytes)"
+        echo "Embedded bundle OK: $BUNDLE_PATH ($(wc -c < "$BUNDLE_PATH") bytes)"
+      shell: bash
+
+    - name: Detox test (AppleApp ${{ inputs.variant }})
+      if: inputs.run-e2e == 'true'
+      run: yarn "$APPLEAPP_E2E_TEST_SCRIPT"
+      working-directory: apps/AppleApp
+      shell: bash
+
+    - name: Upload Detox artifacts on failure
+      if: failure() && inputs.run-e2e == 'true'
+      uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+      with:
+        name: ${{ inputs.e2e-artifact-name }}-${{ inputs.variant }}-ios
+        path: apps/AppleApp/artifacts
+        if-no-files-found: ignore
+
     # ==============
 
     - name: Log ccache stats

.github/actions/setup/action.yml

@@ -17,6 +17,10 @@ runs:
         cache: 'yarn'
 
     - name: Install dependencies
+      env:
+        # Monorepo has detox in multiple workspaces; parallel postinstalls race on
+        # $HOME/Library/Detox/ios/framework. E2E jobs run postinstall once later.
+        DETOX_DISABLE_POSTINSTALL: '1'
       run: yarn install
       shell: bash
 

.github/workflows/ci.yml

@@ -5,11 +5,16 @@ on:
     branches: [main]
   pull_request:
     branches: [main]
+  workflow_dispatch:
 
 concurrency:
-  group: pr-${{ github.event.pull_request.number }}
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+  actions: write
+
 jobs:
   filter:
     name: Detect changed paths
@@ -35,14 +40,18 @@ jobs:
               - 'packages/**'
             rnapp:
               - 'apps/RNApp/**'
+              - 'apps/brownfield-example-shared-tests/**'
             expo54:
               - 'apps/ExpoApp54/**'
+              - 'apps/brownfield-example-shared-tests/**'
             expo55:
               - 'apps/ExpoApp55/**'
+              - 'apps/brownfield-example-shared-tests/**'
             androidapp:
               - 'apps/AndroidApp/**'
             appleapp:
               - 'apps/AppleApp/**'
+              - 'apps/brownfield-example-shared-tests/**'
             ci:
               - '.github/**'
 
@@ -168,8 +177,9 @@ jobs:
           rn-project-maven-path: com/rnapp/brownfieldlib
 
   ios-appleapp-vanilla:
-    name: iOS road test (AppleApp - Vanilla)
+    name: iOS road test & E2E (AppleApp - Vanilla)
     runs-on: macos-26
+    timeout-minutes: 90
     needs: [filter, build-lint]
     if: |
       always() &&
@@ -185,15 +195,18 @@ jobs:
       - name: Checkout
         uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
 
-      - name: Run RNApp -> AppleApp road test (Vanilla)
+      - name: Run RNApp -> AppleApp road test & Detox E2E (Vanilla)
         uses: ./.github/actions/appleapp-road-test
         with:
           variant: vanilla
           rn-project-path: apps/RNApp
+          run-e2e: 'true'
+          e2e-artifact-name: detox-appleapp-vanilla
 
   ios-appleapp-expo:
-    name: iOS road test (AppleApp - Expo ${{ matrix.version }})
+    name: iOS road test${{ matrix.run-e2e == 'true' && ' & E2E' || '' }} (AppleApp - Expo ${{ matrix.version }})
     runs-on: macos-26
+    timeout-minutes: ${{ matrix.run-e2e == 'true' && 90 || 60 }}
     needs: [filter, build-lint]
     if: |
       always() &&
@@ -209,14 +222,19 @@ jobs:
       matrix:
         include:
           - version: '54'
+            run-e2e: 'false'
           - version: '55'
+            run-e2e: 'true'
 
     steps:
       - name: Checkout
         uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
 
-      - name: Run ExpoApp -> AppleApp road test (Expo ${{ matrix.version }})
+      - name: Run ExpoApp -> AppleApp road test${{ matrix.run-e2e == 'true' && ' & Detox E2E' || '' }} (Expo ${{ matrix.version }})
         uses: ./.github/actions/appleapp-road-test
         with:
           variant: expo${{ matrix.version }}
           rn-project-path: apps/ExpoApp${{ matrix.version }}
+          run-e2e: ${{ matrix.run-e2e }}
+          e2e-artifact-name: detox-appleapp-expo${{ matrix.version }}
+

apps/AppleApp/.detoxrc.cjs

@@ -0,0 +1,10 @@
+const {
+  createAppleAppIosSimDebugDetoxConfig,
+} = require('../brownfield-example-shared-tests/detox-rc-appleapp-ios-sim-debug.cjs');
+
+/** @type {import('detox').DetoxConfig} */
+module.exports = createAppleAppIosSimDebugDetoxConfig({
+  scheme: 'Brownfield Apple App Vanilla',
+  configuration: 'Debug Vanilla',
+  appBinaryName: 'Brownfield Apple App (RNApp)',
+});

apps/AppleApp/.detoxrc.expo55.cjs

@@ -0,0 +1,17 @@
+const {
+  createAppleAppIosSimDebugDetoxConfig,
+} = require('../brownfield-example-shared-tests/detox-rc-appleapp-ios-sim-debug.cjs');
+const {
+  getAppleAppDetoxVariant,
+} = require('../brownfield-example-shared-tests/detox-appleapp-variants.cjs');
+
+const variant = getAppleAppDetoxVariant('expo55');
+
+/** @type {import('detox').DetoxConfig} */
+module.exports = createAppleAppIosSimDebugDetoxConfig({
+  scheme: variant.scheme,
+  configuration: variant.configuration,
+  appBinaryName: variant.appBinaryName,
+  detoxConfiguration: variant.detoxConfiguration,
+  jestConfigPath: 'e2e/jest.config.expo55.cjs',
+});

apps/AppleApp/Brownfield Apple App.xcodeproj/project.pbxproj

@@ -144,62 +144,9 @@
 		7A1B2C3D4E5F60718293A202 /* Brownfield Apple App (ExpoAppBeta).app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "Brownfield Apple App (ExpoAppBeta).app"; sourceTree = BUILT_PRODUCTS_DIR; };
 /* End PBXFileReference section */
 
-/* Begin PBXFileSystemSynchronizedBuildFileExceptionSet section */
-		79B8BE822FB7270F00B94C6F /* Exceptions for "Brownfield Apple App" folder in "Brownfield Apple App (ExpoApp54)" target */ = {
-			isa = PBXFileSystemSynchronizedBuildFileExceptionSet;
-			membershipExceptions = (
-				Assets.xcassets,
-				BrownfieldAppleApp.swift,
-				components/ContentView.swift,
-				components/GreetingCard.swift,
-				components/MaterialCard.swift,
-				components/MessagesView.swift,
-				components/ReferralsScreen.swift,
-				components/SettingsScreen.swift,
-				components/Toast.swift,
-			);
-			target = 79B8BE682FB7270E00B94C6F /* Brownfield Apple App (ExpoApp54) */;
-		};
-		79B8BE9C2FB7273600B94C6F /* Exceptions for "Brownfield Apple App" folder in "Brownfield Apple App (ExpoApp55)" target */ = {
-			isa = PBXFileSystemSynchronizedBuildFileExceptionSet;
-			membershipExceptions = (
-				Assets.xcassets,
-				BrownfieldAppleApp.swift,
-				components/ContentView.swift,
-				components/GreetingCard.swift,
-				components/MaterialCard.swift,
-				components/MessagesView.swift,
-				components/ReferralsScreen.swift,
-				components/SettingsScreen.swift,
-				components/Toast.swift,
-			);
-			target = 79B8BE832FB7273600B94C6F /* Brownfield Apple App (ExpoApp55) */;
-		};
-		7A1B2C3D4E5F60718293A203 /* Exceptions for "Brownfield Apple App" folder in "Brownfield Apple App (ExpoAppBeta)" target */ = {
-			isa = PBXFileSystemSynchronizedBuildFileExceptionSet;
-			membershipExceptions = (
-				Assets.xcassets,
-				BrownfieldAppleApp.swift,
-				components/ContentView.swift,
-				components/GreetingCard.swift,
-				components/MaterialCard.swift,
-				components/MessagesView.swift,
-				components/ReferralsScreen.swift,
-				components/SettingsScreen.swift,
-				components/Toast.swift,
-			);
-			target = 7A1B2C3D4E5F60718293A301 /* Brownfield Apple App (ExpoAppBeta) */;
-		};
-/* End PBXFileSystemSynchronizedBuildFileExceptionSet section */
-
 /* Begin PBXFileSystemSynchronizedRootGroup section */
 		793C76A92EEBF938008A2A34 /* Brownfield Apple App */ = {
 			isa = PBXFileSystemSynchronizedRootGroup;
-			exceptions = (
-				79B8BE822FB7270F00B94C6F /* Exceptions for "Brownfield Apple App" folder in "Brownfield Apple App (ExpoApp54)" target */,
-				79B8BE9C2FB7273600B94C6F /* Exceptions for "Brownfield Apple App" folder in "Brownfield Apple App (ExpoApp55)" target */,
-				7A1B2C3D4E5F60718293A203 /* Exceptions for "Brownfield Apple App" folder in "Brownfield Apple App (ExpoAppBeta)" target */,
-			);
 			path = "Brownfield Apple App";
 			sourceTree = "<group>";
 		};

apps/AppleApp/Brownfield Apple App/E2eTestIds.swift

@@ -0,0 +1,10 @@
+import Foundation
+
+/// Keep in sync with `@callstack/brownfield-example-shared-tests` `e2eTestIds`.
+enum E2eTestIds {
+    static let appleAppGreeting = "brownfield-e2e-appleapp-greeting"
+    static let appleAppPostMessageSend = "brownfield-e2e-appleapp-post-message-send"
+    static let appleAppPostMessageToast = "brownfield-e2e-appleapp-post-message-toast"
+    static let appleAppNativeSettings = "brownfield-e2e-appleapp-native-settings"
+    static let appleAppNativeReferrals = "brownfield-e2e-appleapp-native-referrals"
+}