ios.yaml

name: e2e-iOS

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}-ios
  cancel-in-progress: true

permissions:
  contents: read

on:
  pull_request:
    paths-ignore:
      - 'docs/**'
      - 'website/**'
      - '**/example/**'
      - '!**/example/integration_test/**'
      - '**/flutterfire_ui/**'
      - '**.md'
  push:
    branches:
      - main
    paths-ignore:
      - 'docs/**'
      - 'website/**'
      - '**/example/**'
      - '!**/example/integration_test/**'
      - '**/flutterfire_ui/**'
      - '**.md'
  workflow_call:
    inputs:
      nightly_test_mode:
        type: boolean
        default: false

jobs:
  ios:
    permissions:
      contents: read
    runs-on: macos-15
    timeout-minutes: ${{ inputs.nightly_test_mode && 5 || 60 }}
    strategy:
      fail-fast: false
      matrix:
        working_directory:
          ['tests', 'packages/cloud_firestore/cloud_firestore/example']
        exclude:
          - working_directory: ${{ inputs.nightly_test_mode && 'packages/cloud_firestore/cloud_firestore/example' || 'none' }}
    steps:
      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10
      - uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a
        name: Install Node.js 20
        with:
          node-version: '20'
      - name: Xcode
        run: sudo xcode-select -s /Applications/Xcode_16.4.app/Contents/Developer
      - uses: actions/setup-java@1bcf9fb12cf4aa7d266a90ae39939e61372fe520
        with:
          distribution: 'temurin'
          java-version: '21'
      - uses: hendrikmuhs/ccache-action@d62db5f07c26379fc4b4e0916f098a92573c3b03
        name: Xcode Compile Cache
        with:
          key: xcode-cache-${{ runner.os }}
          save: "${{ github.ref == 'refs/heads/main' }}"
          max-size: 700M
      - uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9
        continue-on-error: true
        name: Pods Cache
        id: pods-cache
        with:
          # Must match the save path exactly
          path: tests/ios/Pods
          key: pods-v3-${{ runner.os }}-ios-${{ hashFiles('tests/pubspec.lock') }}
          restore-keys: pods-v3-${{ runner.os }}-ios
      - name: 'Install Tools'
        run: |
          sudo npm i -g firebase-tools
          echo "FIREBASE_TOOLS_VERSION=$(npm firebase --version)" >> $GITHUB_ENV
      - name: Firebase Emulator Cache
        id: firebase-emulator-cache
        uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9
        continue-on-error: true
        with:
          # The firebase emulators are pure javascript and java, OS-independent
          enableCrossOsArchive: true
          # Must match the save path exactly
          path: ~/.cache/firebase/emulators
          key: firebase-emulators-v3-${{ env.FIREBASE_TOOLS_VERSION }}
          restore-keys: firebase-emulators-v3
      - uses: subosito/flutter-action@1a449444c387b1966244ae4d4f8c696479add0b2
        with:
          channel: 'stable'
          cache: true
          flutter-version: '3.41.9'
          cache-key: "flutter-:os:-:channel:-:version:-:arch:-:hash:"
          pub-cache-key: "flutter-pub-:os:-:channel:-:version:-:arch:-:hash:"
      - uses: bluefireteam/melos-action@705015c3d2bc4ab94201ac24accb2bbe070cf533
        with:
          run-bootstrap: false
          melos-version: '5.3.0'
      - name: 'Bootstrap package'
        run: melos bootstrap --scope tests && melos bootstrap --scope "cloud_firestore*"
      - name: 'Free up space'
        run: |
          sudo rm -rf \
            /usr/local/share/.cache \
            /opt/microsoft/msedge \
            /opt/microsoft/powershell \
            /opt/pipx \
            /usr/lib/mono \
            /usr/local/julia* \
            /usr/local/lib/android \
            /usr/local/share/chromium \
            /usr/local/share/powershell \
            /usr/share/dotnet
          df -h /
      - name: 'Build Application'
        working-directory: ${{ matrix.working_directory }}
        run: |
          export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
          export CCACHE_SLOPPINESS=clang_index_store,file_stat_matches,include_file_ctime,include_file_mtime,ivfsoverlay,pch_defines,modules,system_headers,time_macros
          export CCACHE_FILECLONE=true
          export CCACHE_DEPEND=true
          export CCACHE_INODECACHE=true
          ccache -s
          flutter build ios --no-codesign --simulator --debug --target=./integration_test/e2e_test.dart --dart-define=CI=true
          ccache -s
      - name: Start Firebase Emulator
        run: sudo chown -R 501:20 "/Users/runner/.npm" && cd ./.github/workflows/scripts && ./start-firebase-emulator.sh
      - uses: futureware-tech/simulator-action@e89aa8f93d3aec35083ff49d2854d07f7186f7f5
        id: simulator
        with:
          # List of available simulators: https://github.com/actions/runner-images/blob/main/images/macos/macos-15-Readme.md#installed-simulators
          model: "iPhone 16"
      - name: Ensure Simulator Ready
        env:
          SIMULATOR: ${{ steps.simulator.outputs.udid }}
          ENSURE_BOOT_IF_NEEDED: "0"
        run: .github/workflows/scripts/ensure-simulator-ready.sh
      - name: 'E2E Tests'
        working-directory: ${{ matrix.working_directory }}
        env:
          SIMULATOR: ${{ steps.simulator.outputs.udid }}
        run: |
          # Uncomment following line to have simulator logs printed out for debugging purposes.
          # xcrun simctl spawn booted log stream --predicate 'eventMessage contains "flutter"' &
          # Once the integration test runner has launched, leave it running rather
          # than starting a second app instance from a retry.
          flutter test integration_test/e2e_test.dart -d "$SIMULATOR" --timeout 10x --dart-define=CI=true
      - name: Save Firestore Emulator Cache
        # Branches can read main cache but main cannot read branch cache. Avoid LRU eviction with main-only cache.
        if: github.ref == 'refs/heads/main'
        uses: actions/cache/save@27d5ce7f107fe9357f9df03efb73ab90386fccae
        continue-on-error: true
        with:
          # The firebase emulators are pure javascript and java, OS-independent
          enableCrossOsArchive: true
          key: ${{ steps.firebase-emulator-cache.outputs.cache-primary-key }}
          # Must match the restore paths exactly
          path: ~/.cache/firebase/emulators
      - name: Save Pods Cache
        # Branches can read main cache but main cannot read branch cache. Avoid LRU eviction with main-only cache.
        if: github.ref == 'refs/heads/main'
        uses: actions/cache/save@27d5ce7f107fe9357f9df03efb73ab90386fccae
        continue-on-error: true
        with:
          key: ${{ steps.pods-cache.outputs.cache-primary-key }}
          # Must match the restore paths exactly
          path: tests/ios/Pods