ci(android): revert to emulator-runner action

fadi-george · fadi-george · commit 98964d6d1a44 · 2026-04-16T13:23:56.000-07:00
diff --git a/.github/actions/appium-local-android/action.yml b/.github/actions/appium-local-android/action.yml
@@ -1,5 +1,5 @@
 name: 'Appium E2E - Local Android'
-description: 'Boot an Android emulator, start Appium, and run the shared OneSignal Appium E2E tests against a local .apk. Uses raw sdkmanager/avdmanager/emulator commands so each phase is a separate, cacheable, debuggable step.'
+description: 'Boot an Android emulator via reactivecircus/android-emulator-runner, start Appium, and run the shared OneSignal Appium E2E tests against a local .apk.'
 
 inputs:
   app-path:
@@ -34,7 +34,7 @@ inputs:
     description: 'Port Appium listens on'
     required: false
     default: '4723'
-  boot-timeout-seconds:
+  emulator-boot-timeout:
     description: 'Max seconds to wait for emulator boot completion'
     required: false
     default: '900'
@@ -45,172 +45,126 @@ runs:
     - name: Setup Bun
       uses: oven-sh/setup-bun@v2
 
-    - name: Resolve paths
+    - name: Resolve appium dir
       shell: bash
       run: |
         APPIUM_DIR=$(cd "${{ github.action_path }}/../../../appium" && pwd -P)
         echo "APPIUM_DIR=$APPIUM_DIR" >> "$GITHUB_ENV"
 
-        if [ -z "${ANDROID_HOME:-}" ]; then
-          if [ -n "${ANDROID_SDK_ROOT:-}" ]; then
-            ANDROID_HOME="$ANDROID_SDK_ROOT"
-          else
-            ANDROID_HOME="/usr/local/lib/android/sdk"
-          fi
-          echo "ANDROID_HOME=$ANDROID_HOME" >> "$GITHUB_ENV"
-        fi
-
-        CMDLINE_BIN=$(ls -d "$ANDROID_HOME"/cmdline-tools/*/bin 2>/dev/null | tail -1 || true)
-        if [ -z "$CMDLINE_BIN" ]; then
-          echo "::error::No Android cmdline-tools found under $ANDROID_HOME/cmdline-tools/"
-          ls -la "$ANDROID_HOME/cmdline-tools" 2>/dev/null || true
-          exit 1
-        fi
-        echo "$CMDLINE_BIN" >> "$GITHUB_PATH"
-        echo "$ANDROID_HOME/emulator" >> "$GITHUB_PATH"
-        echo "$ANDROID_HOME/platform-tools" >> "$GITHUB_PATH"
-        echo "Using cmdline-tools at: $CMDLINE_BIN"
-
     - name: Enable KVM
       shell: bash
       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: Cache Android system image
+    - name: AVD cache
       uses: actions/cache@v4
+      id: avd-cache
       with:
-        path: ${{ env.ANDROID_HOME }}/system-images/android-${{ inputs.api-level }}/${{ inputs.target }}/${{ inputs.arch }}
-        key: android-sysimg-${{ inputs.api-level }}-${{ inputs.target }}-${{ inputs.arch }}
-
-    - name: Install SDK packages
-      shell: bash
-      env:
-        API_LEVEL: ${{ inputs.api-level }}
-        TARGET: ${{ inputs.target }}
-        ARCH: ${{ inputs.arch }}
-      run: |
-        yes | sdkmanager --licenses >/dev/null 2>&1 || true
-        sdkmanager --install \
-          "platforms;android-$API_LEVEL" \
-          "system-images;android-$API_LEVEL;$TARGET;$ARCH" \
-          "emulator" \
-          "platform-tools" > /tmp/sdkmanager.log 2>&1 || {
-            echo "::error::sdkmanager install failed"
-            tail -40 /tmp/sdkmanager.log
-            exit 1
-          }
-
-    - name: Create AVD
-      shell: bash
-      env:
-        API_LEVEL: ${{ inputs.api-level }}
-        TARGET: ${{ inputs.target }}
-        ARCH: ${{ inputs.arch }}
-        PROFILE: ${{ inputs.profile }}
-      run: |
-        echo "no" | avdmanager create avd \
-          -n test \
-          -k "system-images;android-$API_LEVEL;$TARGET;$ARCH" \
-          -d "$PROFILE" \
-          --force
+        path: |
+          ~/.android/avd/*
+          ~/.android/adb*
+        key: avd-${{ inputs.api-level }}-${{ inputs.target }}-${{ inputs.arch }}-${{ inputs.profile }}
 
-    - name: Boot emulator
+    - name: Create AVD snapshot
+      if: steps.avd-cache.outputs.cache-hit != 'true'
+      uses: reactivecircus/android-emulator-runner@v2
+      with:
+        api-level: ${{ inputs.api-level }}
+        target: ${{ inputs.target }}
+        arch: ${{ inputs.arch }}
+        profile: ${{ inputs.profile }}
+        ram-size: 4096M
+        heap-size: 1024M
+        disable-animations: false
+        force-avd-creation: false
+        emulator-options: -no-window -gpu swiftshader_indirect -no-boot-anim -no-snapshot-save
+        emulator-boot-timeout: ${{ inputs.emulator-boot-timeout }}
+        script: echo "Generated AVD snapshot for caching"
+
+    # reactivecircus/android-emulator-runner@v2 executes `script:` line-by-line
+    # via separate `sh -c` calls, which breaks multi-line constructs and state
+    # (e.g. APPIUM_PID=$! ends up in a throwaway shell). We stage the full test
+    # flow to a file here and invoke it from the action as a single line.
+    - name: Stage Appium test script
       shell: bash
-      env:
-        BOOT_TIMEOUT: ${{ inputs.boot-timeout-seconds }}
       run: |
-        nohup "$ANDROID_HOME/emulator/emulator" \
-          -avd test \
-          -no-window -no-audio -no-boot-anim \
-          -gpu swiftshader_indirect \
-          -no-snapshot-save \
-          -memory 4096 \
-          > emulator.log 2>&1 &
-        echo "EMULATOR_PID=$!" >> "$GITHUB_ENV"
-
-        adb wait-for-device
-
-        echo "Waiting for boot completion (timeout ${BOOT_TIMEOUT}s)..."
-        deadline=$(( $(date +%s) + BOOT_TIMEOUT ))
-        while :; do
-          boot=$(adb shell getprop sys.boot_completed 2>/dev/null | tr -d '\r' || true)
-          if [ "$boot" = "1" ]; then
-            break
-          fi
-          if [ "$(date +%s)" -ge "$deadline" ]; then
-            echo "::error::Emulator boot timed out"
-            echo "--- emulator.log (last 100 lines) ---"
-            tail -100 emulator.log || true
-            exit 1
-          fi
-          sleep 2
-        done
-        adb shell input keyevent 82 >/dev/null 2>&1 || true
-        echo "Emulator booted"
+        cat > "$RUNNER_TEMP/appium-android.sh" <<'SCRIPT_EOF'
+        #!/usr/bin/env bash
+        set -euo pipefail
 
-    - name: Install Appium and driver
-      shell: bash
-      run: |
+        echo "::group::Install Appium + uiautomator2 driver"
         bun add -g appium@3
         appium driver install uiautomator2
+        echo "::endgroup::"
 
-    - name: Start Appium
-      shell: bash
-      env:
-        APPIUM_PORT: ${{ inputs.appium-port }}
-      run: |
-        appium --port "$APPIUM_PORT" --log-level error > appium.log 2>&1 &
-        echo "APPIUM_PID=$!" >> "$GITHUB_ENV"
-        i=0
-        while [ "$i" -lt 30 ]; do
+        echo "::group::Start Appium"
+        appium --port "$APPIUM_PORT" --log-level error > "$GITHUB_WORKSPACE/appium.log" 2>&1 &
+        APPIUM_PID=$!
+        echo "APPIUM_PID=$APPIUM_PID"
+
+        for _ in $(seq 1 60); do
           if curl -sf "http://localhost:$APPIUM_PORT/status" >/dev/null; then
-            echo "Appium ready"
-            exit 0
+            break
           fi
           sleep 1
-          i=$((i + 1))
         done
-        echo "::error::Appium did not become ready on port $APPIUM_PORT"
-        cat appium.log || true
-        exit 1
+        if ! curl -sf "http://localhost:$APPIUM_PORT/status" >/dev/null; then
+          echo "::error::Appium did not become ready on port $APPIUM_PORT"
+          tail -100 "$GITHUB_WORKSPACE/appium.log" || true
+          exit 1
+        fi
+        echo "Appium ready"
+        echo "::endgroup::"
 
-    - name: Install test dependencies
-      shell: bash
-      working-directory: ${{ env.APPIUM_DIR }}
-      run: bun install --frozen-lockfile
+        echo "::group::Install test dependencies"
+        cd "$APPIUM_DIR"
+        bun install --frozen-lockfile
+        echo "::endgroup::"
+
+        echo "::group::Run WDIO tests"
+        set +e
+        bunx wdio run wdio.android.conf.ts
+        WDIO_EXIT=$?
+        set -e
+        echo "::endgroup::"
+
+        echo "::group::Stop Appium"
+        kill "$APPIUM_PID" 2>/dev/null || true
+        echo "::endgroup::"
+
+        exit "$WDIO_EXIT"
+        SCRIPT_EOF
+        chmod +x "$RUNNER_TEMP/appium-android.sh"
 
     - name: Run Appium tests
-      shell: bash
-      working-directory: ${{ env.APPIUM_DIR }}
+      uses: reactivecircus/android-emulator-runner@v2
       env:
-        SDK_TYPE: ${{ inputs.sdk-type }}
-        PLATFORM: android
+        APPIUM_PORT: ${{ inputs.appium-port }}
         APP_PATH: ${{ inputs.app-path }}
+        SDK_TYPE: ${{ inputs.sdk-type }}
         ONESIGNAL_APP_ID: ${{ inputs.onesignal-app-id }}
         ONESIGNAL_API_KEY: ${{ inputs.onesignal-api-key }}
-      run: bunx wdio run wdio.android.conf.ts
-
-    - name: Shut down emulator and Appium
-      if: always()
-      shell: bash
-      run: |
-        adb emu kill 2>/dev/null || true
-        if [ -n "${APPIUM_PID:-}" ]; then
-          kill "$APPIUM_PID" 2>/dev/null || true
-        fi
-        if [ -n "${EMULATOR_PID:-}" ]; then
-          kill "$EMULATOR_PID" 2>/dev/null || true
-        fi
-
-    - name: Upload Appium + emulator logs
+      with:
+        api-level: ${{ inputs.api-level }}
+        target: ${{ inputs.target }}
+        arch: ${{ inputs.arch }}
+        profile: ${{ inputs.profile }}
+        ram-size: 4096M
+        heap-size: 1024M
+        disable-animations: true
+        force-avd-creation: false
+        emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -no-boot-anim
+        emulator-boot-timeout: ${{ inputs.emulator-boot-timeout }}
+        script: bash "$RUNNER_TEMP/appium-android.sh"
+
+    - name: Upload Appium + test results
       if: always()
       uses: actions/upload-artifact@v5
       with:
         name: appium-local-android-${{ inputs.sdk-type }}
         path: |
           ${{ env.APPIUM_DIR }}/results/
-          ${{ github.workspace }}/emulator.log
           ${{ github.workspace }}/appium.log
         if-no-files-found: ignore
