[WIP] test: add e2e testing infrastructure (iOS + Android)

.github/workflows/e2e_test.yml

@@ -0,0 +1,130 @@
+name: e2e
+
+on:
+  workflow_dispatch:
+  pull_request:
+    paths-ignore:
+      - 'README.md'
+      - '**/*.png'
+
+permissions:
+  contents: read
+
+concurrency:
+  group: e2e-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  flutter_version: "3.x"
+
+jobs:
+  android:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: "17"
+
+      - uses: subosito/flutter-action@v2
+        with:
+          flutter-version: ${{ env.flutter_version }}
+          channel: stable
+          cache-key: flutter-:os:-:channel:-:version:-:arch:-:hash:-${{ hashFiles('**/pubspec.lock') }}
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+          bundler-cache: true
+          working-directory: sample_app/android
+
+      - name: Bootstrap
+        run: |
+          flutter pub global activate melos
+          melos bootstrap
+          dart pub global activate patrol_cli
+
+      - name: Enable KVM
+        run: |
+          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+          sudo udevadm control --reload-rules
+          sudo udevadm trigger --name-match=kvm
+
+      - name: Run e2e (Android emulator)
+        uses: reactivecircus/android-emulator-runner@v2
+        with:
+          api-level: 34
+          arch: x86_64
+          profile: pixel_6
+          script: cd sample_app/android && bundle exec fastlane run_e2e_test device:emulator-5554 mock_server_branch:main
+
+      - name: Upload Allure results
+        if: always()
+        env:
+          ALLURE_TOKEN: ${{ secrets.ALLURE_TOKEN }}
+        run: cd sample_app/android && bundle exec fastlane allure_upload
+
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: e2e-android-logs
+          path: |
+            sample_app/stream-chat-test-mock-server/logs
+            sample_app/build/app/reports
+
+  ios:
+    runs-on: macos-15
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: subosito/flutter-action@v2
+        with:
+          flutter-version: ${{ env.flutter_version }}
+          channel: stable
+          cache-key: flutter-:os:-:channel:-:version:-:arch:-:hash:-${{ hashFiles('**/pubspec.lock') }}
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+          bundler-cache: true
+          working-directory: sample_app/ios
+
+      - name: Bootstrap
+        run: |
+          flutter pub global activate melos
+          melos bootstrap
+          dart pub global activate patrol_cli
+
+      - name: Cache CocoaPods
+        uses: actions/cache@v4
+        with:
+          path: |
+            sample_app/ios/Pods
+            ~/Library/Caches/CocoaPods
+          key: pods-${{ runner.os }}-${{ hashFiles('pubspec.lock', 'sample_app/ios/Podfile') }}
+          restore-keys: pods-${{ runner.os }}-
+
+      - name: Boot simulator
+        run: |
+          device_id=$(xcrun simctl list devices available --json \
+            | python3 -c "import sys,json;d=json.load(sys.stdin);print(next(x['udid'] for r in d['devices'].values() for x in r if x['name'].startswith('iPhone')))")
+          echo "device_id=$device_id" >> "$GITHUB_ENV"
+          xcrun simctl boot "$device_id"
+
+      - name: Run e2e (iOS simulator)
+        run: |
+          cd sample_app/ios && bundle exec fastlane run_e2e_test device:${{ env.device_id }} mock_server_branch:main verbose:true
+
+      - name: Upload Allure results
+        if: always()
+        env:
+          ALLURE_TOKEN: ${{ secrets.ALLURE_TOKEN }}
+        run: cd sample_app/ios && bundle exec fastlane allure_upload
+
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: e2e-ios-logs
+          path: sample_app/stream-chat-test-mock-server/logs

.github/workflows/e2e_test_cron.yml

@@ -0,0 +1,196 @@
+name: E2E Tests Nightly
+
+on:
+  schedule:
+    - cron: "0 1 * * 1-5" # weeknights at 01:00 UTC
+  workflow_dispatch:
+    inputs:
+      mock_server_branch:
+        description: "Mock server branch"
+        type: string
+        required: true
+        default: main
+
+permissions:
+  contents: read
+
+concurrency:
+  group: e2e-nightly-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  flutter_version: "3.x"
+  mock_server_branch: ${{ github.event.inputs.mock_server_branch || 'main' }}
+
+jobs:
+  setup:
+    if: github.repository == 'GetStream/stream-chat-flutter'
+    runs-on: ubuntu-latest
+    outputs:
+      launch_id: ${{ steps.launch.outputs.launch_id }}
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+          bundler-cache: true
+          working-directory: sample_app/android
+      - id: launch
+        env:
+          ALLURE_TOKEN: ${{ secrets.ALLURE_TOKEN }}
+        run: cd sample_app/android && bundle exec fastlane allure_launch
+
+  android:
+    needs: setup
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        api-level: [34, 31, 28]
+    env:
+      ALLURE_LAUNCH_ID: ${{ needs.setup.outputs.launch_id }}
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: "17"
+
+      - uses: subosito/flutter-action@v2
+        with:
+          flutter-version: ${{ env.flutter_version }}
+          channel: stable
+          cache-key: flutter-:os:-:channel:-:version:-:arch:-:hash:-${{ hashFiles('**/pubspec.lock') }}
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+          bundler-cache: true
+          working-directory: sample_app/android
+
+      - name: Bootstrap
+        run: |
+          flutter pub global activate melos
+          melos bootstrap
+          dart pub global activate patrol_cli
+
+      - name: Enable KVM
+        run: |
+          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+          sudo udevadm control --reload-rules
+          sudo udevadm trigger --name-match=kvm
+
+      - name: Run e2e (Android emulator)
+        uses: reactivecircus/android-emulator-runner@v2
+        timeout-minutes: 90
+        with:
+          api-level: ${{ matrix.api-level }}
+          arch: x86_64
+          profile: pixel_6
+          emulator-options: -no-snapshot-save -no-window -no-audio -no-boot-anim -gpu swiftshader_indirect
+          script: cd sample_app/android && bundle exec fastlane run_e2e_test device:emulator-5554 mock_server_branch:${{ env.mock_server_branch }}
+
+      - name: Upload Allure results
+        if: success() || failure()
+        env:
+          ALLURE_TOKEN: ${{ secrets.ALLURE_TOKEN }}
+        run: cd sample_app/android && bundle exec fastlane allure_upload
+
+      - uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: e2e-nightly-android-${{ matrix.api-level }}
+          path: sample_app/stream-chat-test-mock-server/logs
+
+  ios:
+    needs: setup
+    runs-on: macos-15
+    strategy:
+      fail-fast: false
+      matrix:
+        device: ["iPhone 16", "iPhone 15"]
+    env:
+      ALLURE_LAUNCH_ID: ${{ needs.setup.outputs.launch_id }}
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: subosito/flutter-action@v2
+        with:
+          flutter-version: ${{ env.flutter_version }}
+          channel: stable
+          cache-key: flutter-:os:-:channel:-:version:-:arch:-:hash:-${{ hashFiles('**/pubspec.lock') }}
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+          bundler-cache: true
+          working-directory: sample_app/ios
+
+      - name: Bootstrap
+        run: |
+          flutter pub global activate melos
+          melos bootstrap
+          dart pub global activate patrol_cli
+
+      - name: Cache CocoaPods
+        uses: actions/cache@v4
+        with:
+          path: |
+            sample_app/ios/Pods
+            ~/Library/Caches/CocoaPods
+          key: pods-${{ runner.os }}-${{ hashFiles('pubspec.lock', 'sample_app/ios/Podfile') }}
+          restore-keys: pods-${{ runner.os }}-
+
+      - name: Boot simulator
+        run: |
+          device_id=$(xcrun simctl list devices available --json \
+            | python3 -c "import sys,json;d=json.load(sys.stdin);print(next(x['udid'] for r in d['devices'].values() for x in r if x['name']=='${{ matrix.device }}'))")
+          echo "device_id=$device_id" >> "$GITHUB_ENV"
+          xcrun simctl boot "$device_id"
+
+      - name: Run e2e (iOS simulator)
+        run: cd sample_app/ios && bundle exec fastlane run_e2e_test device:${{ env.device_id }} mock_server_branch:${{ env.mock_server_branch }} verbose:true
+
+      - name: Upload Allure results
+        if: success() || failure()
+        env:
+          ALLURE_TOKEN: ${{ secrets.ALLURE_TOKEN }}
+        run: cd sample_app/ios && bundle exec fastlane allure_upload
+
+      - uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: e2e-nightly-ios-${{ matrix.device }}
+          path: sample_app/stream-chat-test-mock-server/logs
+
+  cleanup:
+    needs: [setup, android, ios]
+    if: always() && cancelled() && needs.setup.outputs.launch_id != ''
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+          bundler-cache: true
+          working-directory: sample_app/android
+      - name: Remove Allure launch
+        env:
+          ALLURE_TOKEN: ${{ secrets.ALLURE_TOKEN }}
+          ALLURE_LAUNCH_ID: ${{ needs.setup.outputs.launch_id }}
+        run: cd sample_app/android && bundle exec fastlane allure_launch_removal
+
+  slack:
+    name: Slack Report
+    runs-on: ubuntu-latest
+    needs: [android, ios]
+    if: failure() && github.event_name == 'schedule'
+    steps:
+      - uses: 8398a7/action-slack@v3
+        with:
+          status: failure
+          text: "Nightly e2e failed 🌙"
+          fields: repo,commit,author,workflow
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_NIGHTLY_CHECKS }}

.gitignore

@@ -2,6 +2,14 @@
 *.class
 *.log
 *.pyc
+# E2E: mock-server checkout cloned by the `start_mock_server` Fastlane lane
+/sample_app/stream-chat-test-mock-server/
+# E2E: Patrol-generated test bundle (regenerated on every `patrol test`)
+/sample_app/integration_test/test_bundle.dart
+# E2E: Allure results assembled from test runs
+/sample_app/allure-results/
+# E2E: allurectl binary downloaded by the Fastlane allure lanes
+/sample_app/allurectl
 *.swp
 .DS_Store
 .atom/

melos.yaml

@@ -83,6 +83,9 @@ command:
       package_info_plus: ">=9.0.1 <11.0.0"
       path: ^1.9.1
       path_provider: ^2.1.5
+      # Pin to the last method-channel release: 2.3.x switches to a JNI/native-
+      # assets impl whose Gradle `copyJniLibs` task breaks the e2e build on CI.
+      path_provider_android: 2.2.23
       photo_manager: ^3.9.0
       photo_view: ^0.15.0
       rate_limiter: ^1.0.0
@@ -125,6 +128,7 @@ command:
       freezed: ^3.0.0
       json_serializable: ^6.13.2
       mocktail: ^1.0.5
+      patrol: ^4.6.1
       path: ^1.9.1
       path_provider_platform_interface: ^2.1.2
       plugin_platform_interface: ^2.1.8
@@ -204,12 +208,21 @@ scripts:
     # `docs_*` are excluded — their goldens commit only the platform/macOS
     # variant and would fail on Linux CI runners. They're regenerated by
     # `update:goldens:docs` on a dedicated macOS workflow instead.
+    # Note: `flutter test` runs `test/` only, so `integration_test/` (the e2e
+    # suite, run via Patrol) is never picked up here.
     run: melos exec -c 4 --fail-fast --ignore="docs_*" -- "flutter test --coverage"
     description: Run Flutter tests for a specific package in this project.
     packageFilters:
       flutter: true
       dirExists: test
 
+  e2e:run:
+    run: melos exec -c 1 --depends-on="patrol" -- "patrol test"
+    description: >
+      Run the Patrol e2e suite. Start the mock-server driver first
+      (`fastlane start_mock_server`), or use the `run_e2e_test` Fastlane lane to
+      orchestrate the mock server and tests in one step.
+
   update:goldens:
     run: melos exec -c 1 --depends-on="alchemist" -- "flutter test --tags golden --update-goldens"
     description: Update golden files for all packages in this project.