appium-e2e.yml

name: Appium E2E Tests

on:
  workflow_call:
    inputs:
      platform:
        description: 'Target platform: android or ios'
        required: true
        type: string
      app-artifact:
        description: 'Name of the uploaded artifact containing the app binary'
        required: true
        type: string
      app-filename:
        description: 'Filename of the app binary inside the artifact'
        required: true
        type: string
      sdk-type:
        description: 'SDK type: react-native, flutter, capacitor, unity, cordova, dotnet, ios, or android'
        required: true
        type: string
      device:
        description: 'BrowserStack device name'
        required: false
        type: string
      os-version:
        description: 'Device OS version'
        required: false
        type: string
      build-name:
        description: 'Label for the BrowserStack session'
        required: false
        type: string

jobs:
  e2e:
    runs-on: ubuntu-latest
    steps:
      - name: Download app artifact
        uses: actions/download-artifact@v8
        with:
          name: ${{ inputs.app-artifact }}

      - name: Checkout sdk-shared (for test files)
        uses: actions/checkout@v6
        with:
          repository: OneSignal/sdk-shared
          path: _sdk-shared

      - name: Set up Vite+
        uses: voidzero-dev/setup-vp@v1
        with:
          working-directory: _sdk-shared/appium
          cache: true
          run-install: true

      - name: Upload app to BrowserStack
        id: bs-upload
        env:
          BROWSERSTACK_USERNAME: ${{ secrets.BROWSERSTACK_USERNAME }}
          BROWSERSTACK_ACCESS_KEY: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
          APP_FILENAME: ${{ inputs.app-filename }}
        run: |
          RESPONSE=$(curl -s -u "$BROWSERSTACK_USERNAME:$BROWSERSTACK_ACCESS_KEY" \
            -X POST "https://api-cloud.browserstack.com/app-automate/upload" \
            -F "file=@${APP_FILENAME}")
          APP_URL=$(echo "$RESPONSE" | jq -r '.app_url')
          if [ "$APP_URL" = "null" ] || [ -z "$APP_URL" ]; then
            echo "::error::Failed to upload app to BrowserStack: $RESPONSE"
            exit 1
          fi
          echo "app-url=$APP_URL" >> "$GITHUB_OUTPUT"
          echo "Uploaded app to BrowserStack: $APP_URL"

      - name: Run Appium tests
        working-directory: _sdk-shared/appium
        env:
          BROWSERSTACK_USERNAME: ${{ secrets.BROWSERSTACK_USERNAME }}
          BROWSERSTACK_ACCESS_KEY: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
          BROWSERSTACK_APP_URL: ${{ steps.bs-upload.outputs.app-url }}
          SDK_TYPE: ${{ inputs.sdk-type }}
          PLATFORM: ${{ inputs.platform }}
          DEVICE: ${{ inputs.device }}
          OS_VERSION: ${{ inputs.os-version }}
          BUILD_NAME: ${{ inputs.build-name }}
          ONESIGNAL_APP_ID: ${{ vars.APPIUM_ONESIGNAL_APP_ID }}
          ONESIGNAL_API_KEY: ${{ secrets.APPIUM_ONESIGNAL_API_KEY }}
        # Retry only on BrowserStack session-creation failures (queue
        # timeouts, parallel-limit hits, transient hub errors). Real test
        # failures still fail the job on the first attempt.
        run: |
          set +e
          MAX_ATTEMPTS=10
          WDIO_TIMEOUT="25m"
          if [ "$PLATFORM" = "ios" ]; then
            WDIO_TIMEOUT="60m"
          fi
          for attempt in $(seq 1 "$MAX_ATTEMPTS"); do
            echo "::group::Appium attempt $attempt of $MAX_ATTEMPTS"
            LOG_FILE="$RUNNER_TEMP/wdio-attempt-$attempt.log"
            timeout --signal=TERM --kill-after=30s "$WDIO_TIMEOUT" \
              vpx wdio run "wdio.${PLATFORM}.conf.ts" 2>&1 | tee "$LOG_FILE"
            STATUS=${PIPESTATUS[0]}
            echo "::endgroup::"
            if [ "$STATUS" -eq 0 ]; then
              exit 0
            fi
            if [ "$STATUS" -eq 124 ]; then
              SLEEP=$((30 * attempt))
              echo "WDIO did not complete within ${WDIO_TIMEOUT}; retrying in ${SLEEP}s..."
              sleep "$SLEEP"
              continue
            fi
            if grep -qE 'Failed to create a session|aborted due to timeout when running .*\/session|PARALLEL_TEST_LIMIT_REACHED|All parallel tests are currently in use' "$LOG_FILE"; then
              SLEEP=$((30 * attempt))
              echo "Session-creation failure detected; retrying in ${SLEEP}s..."
              sleep "$SLEEP"
              continue
            fi
            echo "Test failure (not a session-creation error); not retrying."
            exit "$STATUS"
          done
          echo "::error::Exhausted $MAX_ATTEMPTS attempts due to session-creation failures."
          exit 1

      - name: Upload test results
        if: always()
        uses: actions/upload-artifact@v7
        with:
          name: appium-results-${{ inputs.platform }}-${{ inputs.sdk-type }}
          path: _sdk-shared/appium/results/
          if-no-files-found: ignore