element-x-android/.github/workflows/maestro-local.yml

name: Maestro (local)

# Run this flow only when APK Build workflow completes
on:
  workflow_dispatch:
  pull_request:

permissions:
  # Private fork: actions/checkout needs contents:read to clone. Upstream is public,
  # where an empty token can still read the repo, so an empty permissions block works there and
  # fails here with `fatal: repository not found`.
  contents: read

# Enrich gradle.properties for CI/CD
env:
  # Reduced from upstream's -Xmx8g / 4 GB Kotlin daemon for the self-hosted runners.
  # Each incus container reports 48 GiB and 8 cores, so a single build has ample room —
  # but the containers are oversubscribed against their host, and two concurrent heavy
  # Gradle jobs get their daemons SIGKILLed ("the daemon has disappeared", no
  # OutOfMemoryError, no heap dump). Running the same job alone succeeds. Lower heaps
  # make two builds likelier to coexist; the real fix is sizing the containers to the
  # host. See the "Report runner capacity" step.
  GRADLE_OPTS: -Dorg.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=768m -Dfile.encoding=UTF-8 -XX:+HeapDumpOnOutOfMemoryError -XX:+UseG1GC -Dkotlin.daemon.jvm.options=-Xmx2g
  CI_GRADLE_ARG_PROPERTIES: --stacktrace --no-daemon -Dsonar.gradle.skipCompile=true --no-configuration-cache
  ARCH: x86_64
  DEVICE: pixel_7_pro
  API_LEVEL: 33
  TARGET: google_apis

jobs:
  build-apk:
    name: Build APK
    runs-on: [self-hosted, Linux, X64]
    # Secrets are not available to pull_request runs from forks, so the Maestro job below
    # cannot run for them; skip the build too, as its only consumer is that job.
    if: github.event_name == 'workflow_dispatch' || github.event.pull_request.head.repo.full_name == github.repository
    concurrency:
      group: ${{ format('maestro-build-{0}', github.ref) }}
      cancel-in-progress: true
    steps:
      - name: Free Disk Space (Ubuntu)
        # Only meaningful on GitHub's throwaway VMs. On a persistent self-hosted runner this
        # would delete dotnet/haskell/docker images from the host on every run.
        if: runner.environment == 'github-hosted'
        uses: jlumbroso/free-disk-space@54081f138730dfa15788a46383842cd2f914a1be
        with:
          # This might remove tools that are actually needed, if set to "true" but frees about 6 GB
          tool-cache: true
          # All of these default to true, but we should only need the 'android' one (and maybe swap-storage?)
          android: false
          dotnet: true
          haskell: true
          # This takes way too long to run (~2 minutes) and it saves only ~5.5GB
          large-packages: false
          docker-images: true
          swap-storage: false

      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          # Ensure we are building the branch and not the branch after being merged on develop
          # https://github.com/actions/checkout/issues/881
          ref: ${{ github.ref }}
          persist-credentials: false
      - uses: actions/setup-java@de7274f081f381c8f8158605e0321c36c376e2e6 # v6.0.1
        name: Use JDK 21
        with:
          distribution: 'temurin' # See 'Supported distributions' for available options
          java-version: '21'
      - name: Configure gradle
        uses: gradle/actions/setup-gradle@3f5f9adaf7d9fecd50b5935e54106014257a94e6 # v6.4.0
        with:
          cache-read-only: ${{ github.ref != 'refs/heads/develop' }}
      - name: Assemble debug APK
        run: ./gradlew :app:assembleGplayDebug $CI_GRADLE_ARG_PROPERTIES
        env:
          ELEMENT_ANDROID_MAPTILER_API_KEY: ${{ secrets.MAPTILER_KEY }}
          ELEMENT_ANDROID_MAPTILER_LIGHT_MAP_ID: ${{ secrets.MAPTILER_LIGHT_MAP_ID }}
          ELEMENT_ANDROID_MAPTILER_DARK_MAP_ID: ${{ secrets.MAPTILER_DARK_MAP_ID }}
      - name: Upload APK as artifact
        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
        with:
          name: elementx-apk-maestro
          path: |
            app/build/outputs/apk/gplay/debug/app-gplay-x86_64-debug.apk
          retention-days: 5
          overwrite: true
          if-no-files-found: error

  maestro-cloud:
    name: Maestro test suite
    runs-on: ubuntu-latest
    needs: [ build-apk ]
    if: github.event_name == 'workflow_dispatch' || github.event.pull_request.head.repo.full_name == github.repository
    # Allow only one to run at a time, since they use the same environment.
    # Otherwise, tests running in parallel can break each other.
    # queue: max lets several runs wait their turn instead of the default, where a
    # newly queued run cancels the one already pending (that run then never gets a verdict).
    concurrency:
      group: maestro-test
      queue: max
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          # Ensure we are building the branch and not the branch after being merged on develop
          # https://github.com/actions/checkout/issues/881
          ref: ${{ github.ref }}
          persist-credentials: false
      - name: Download APK artifact from previous job
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: elementx-apk-maestro
      - name: Enable KVM group perms
        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: Install maestro
        run: curl -fsSL "https://get.maestro.mobile.dev" | bash
      - name: Run Maestro tests in emulator
        id: maestro_test
        uses: reactivecircus/android-emulator-runner@a421e43855164a8197daf9d8d40fe71c6996bb0d # v2.38.0
        continue-on-error: true
        env:
          MAESTRO_USERNAME: maestroelement
          MAESTRO_PASSWORD: ${{ secrets.MATRIX_MAESTRO_ACCOUNT_PASSWORD }}
          MAESTRO_RECOVERY_KEY: ${{ secrets.MATRIX_MAESTRO_ACCOUNT_RECOVERY_KEY }}
          MAESTRO_ROOM_NAME: MyRoom
          MAESTRO_INVITEE1_MXID: "@maestroelement2:matrix.org"
          MAESTRO_INVITEE2_MXID: "@maestroelement3:matrix.org"
          MAESTRO_APP_ID: io.element.android.x.debug
        with:
          api-level: ${{ env.API_LEVEL }}
          arch: ${{ env.ARCH }}
          profile: ${{ env.DEVICE }}
          target: ${{ env.TARGET }}
          emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
          disable-animations: true
          disk-size: 3G
          script: |
            .github/workflows/scripts/maestro/maestro-local-with-screen-recording.sh app-gplay-x86_64-debug.apk
      - name: Set up Python
        if: always()
        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: 3.14
      - name: End all the remaining sessions of the Maestro account
        if: always()
        continue-on-error: true
        env:
          MAS_PASSWORD: ${{ secrets.MATRIX_MAESTRO_ACCOUNT_PASSWORD }}
        run: |
          pip install requests
          python3 ./tools/mas/delete_all_sessions.py --homeserver matrix.org --username maestroelement
      - name: Upload test results
        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
        with:
          name: test-results
          path: |
            ~/.maestro/tests/**
          retention-days: 5
          overwrite: true
          if-no-files-found: error
      - name: Update summary (success)
        if: steps.maestro_test.outcome == 'success'
        run: |
          echo "### Maestro tests worked :rocket:!" >> $GITHUB_STEP_SUMMARY
      - name: Update summary (failure)
        if: steps.maestro_test.outcome != 'success'
        run: |
          LOG_FILE=$(find ~/.maestro/tests/ -name maestro.log)
          echo "Log file: $LOG_FILE"
          LOG_LINES="$(tail -n 30 $LOG_FILE)"
          echo "### :x: Maestro tests failed...
          
          \`\`\`
          $LOG_LINES
          \`\`\`" >> $GITHUB_STEP_SUMMARY
      - name: Fail the workflow in case of error in test
        if: steps.maestro_test.outcome != 'success'
        run: |
          echo "Maestro tests failed. Please check the logs."
          exit 1