action.yml

name: React Native Harness
description: Run React Native Harness tests on iOS, Android or Web
inputs:
  runner:
    description: The runner to use (must match a runner name defined in your harness config)
    required: true
    type: string
  app:
    description: The path to the app (.app for iOS, .apk for Android). Not required for web.
    required: false
    type: string
  projectRoot:
    description: The project root directory
    required: false
    type: string
  uploadVisualTestArtifacts:
    description: Whether to upload visual test diff and actual images as artifacts
    required: false
    type: boolean
    default: 'true'
  harnessArgs:
    description: Additional arguments to pass to the Harness CLI
    required: false
    type: string
    default: ''
  packageManager:
    description: Package manager to use instead of auto-detection (npm, yarn, pnpm, bun, or deno)
    required: false
    type: string
    default: ''
  cacheAvd:
    description: Whether to cache the AVD
    required: false
    type: boolean
    default: 'true'
  preRunHook:
    description: Shell script to run in bash immediately before Harness starts
    required: false
    type: string
    default: ''
  afterRunHook:
    description: Shell script to run in bash immediately after Harness finishes
    required: false
    type: string
    default: ''
runs:
  using: 'composite'
  steps:
    - name: Load React Native Harness configuration
      id: load-config
      shell: bash
      env:
        INPUT_RUNNER: ${{ inputs.runner }}
        INPUT_PROJECTROOT: ${{ inputs.projectRoot }}
        HARNESS_AVD_CACHING: ${{ inputs.cacheAvd }}
      run: |
        node ${{ github.action_path }}/actions/shared/index.cjs
    - name: Verify native app input
      if: fromJson(steps.load-config.outputs.config).platformId != 'web'
      shell: bash
      run: |
        if [ -z "${{ inputs.app }}" ]; then
          echo "Error: app input is required for native runners"
          echo "Please provide the path to the built app (.apk for Android, .app for iOS)"
          exit 1
        fi
    - name: Metro cache
      uses: actions/cache@v4
      with:
        path: ${{ steps.load-config.outputs.projectRoot }}/.harness/metro-cache
        key: ${{ runner.os }}-metro-cache-${{ hashFiles('**/bun.lock', '**/bun.lockb', '**/package-lock.json', '**/npm-shrinkwrap.json', '**/pnpm-lock.yaml', '**/yarn.lock', '**/metro.config.js', '**/metro.config.cjs', '**/metro.config.mjs', '**/metro.config.ts', '**/babel.config.js', '**/babel.config.cjs', '**/babel.config.mjs', '**/babel.config.ts', '**/babel.config.json') }}
        restore-keys: |
          ${{ runner.os }}-metro-cache-

    # ── iOS ──────────────────────────────────────────────────────────────────
    # iOS simulator boot and app installation are handled by Harness itself.
    # ── Android ──────────────────────────────────────────────────────────────
    - name: Verify Android config
      if: ${{ fromJson(steps.load-config.outputs.config).platformId == 'android' && fromJson(steps.load-config.outputs.config).config.device.type == 'emulator' }}
      shell: bash
      run: |
        if [ '${{ fromJson(steps.load-config.outputs.config).config.device.avd }}' = 'null' ]; then
          echo "Error: AVD config is required for Android emulators"
          echo "Please define the 'avd' property in the runner config"
          exit 1
        fi
    - name: Get architecture of the runner
      id: arch
      if: ${{ fromJson(steps.load-config.outputs.config).platformId == 'android' && fromJson(steps.load-config.outputs.config).config.device.type == 'emulator' }}
      shell: bash
      run: |
        case "${{ runner.arch }}" in
          X64)
            echo "arch=x86_64" >> $GITHUB_OUTPUT
            ;;
          ARM64)
            echo "arch=arm64-v8a" >> $GITHUB_OUTPUT
            ;;
          ARM32)
            echo "arch=armeabi-v7a" >> $GITHUB_OUTPUT
            ;;
          *)
            echo "arch=x86_64" >> $GITHUB_OUTPUT
            ;;
        esac
    - name: Enable KVM group perms
      if: ${{ fromJson(steps.load-config.outputs.config).platformId == 'android' && fromJson(steps.load-config.outputs.config).config.device.type == 'emulator' }}
      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
        ls /dev/kvm
    - name: Compute AVD cache key
      id: avd-key
      if: ${{ fromJson(steps.load-config.outputs.config).platformId == 'android' && fromJson(steps.load-config.outputs.config).config.device.type == 'emulator' && fromJson(steps.load-config.outputs.config).action.avdCachingEnabled }}
      shell: bash
      run: |
        CACHE_CONFIG='${{ toJson(fromJson(steps.load-config.outputs.config).action.avdCacheConfig) }}'
        AVD_CONFIG_HASH=$(printf '%s' "$CACHE_CONFIG" | sha256sum | cut -d' ' -f1)
        AVD_NAME='${{ fromJson(steps.load-config.outputs.config).config.device.name }}'
        ARCH="${{ steps.arch.outputs.arch }}"
        CACHE_KEY="avd-$AVD_NAME-$ARCH-$AVD_CONFIG_HASH"
        echo "key=$CACHE_KEY" >> $GITHUB_OUTPUT
    - name: Restore AVD cache
      uses: actions/cache/restore@v4
      id: avd-cache
      if: ${{ fromJson(steps.load-config.outputs.config).platformId == 'android' && fromJson(steps.load-config.outputs.config).config.device.type == 'emulator' && fromJson(steps.load-config.outputs.config).action.avdCachingEnabled }}
      with:
        path: |
          ~/.android/avd
          ~/.android/adb*
        key: ${{ steps.avd-key.outputs.key }}
    # ── Web ──────────────────────────────────────────────────────────────────
    - name: Install Playwright Browsers
      if: fromJson(steps.load-config.outputs.config).platformId == 'web'
      shell: bash
      run: npx playwright install --with-deps chromium

    # ── Shared ───────────────────────────────────────────────────────────────
    - name: Detect Package Manager
      id: detect-pm
      shell: bash
      working-directory: ${{ steps.load-config.outputs.projectRoot }}
      run: |
        if [ -n "${{ inputs.packageManager }}" ]; then
          case "${{ inputs.packageManager }}" in
            pnpm)
              echo "manager=pnpm" >> $GITHUB_OUTPUT
              echo "runner=pnpm exec " >> $GITHUB_OUTPUT
              ;;
            yarn)
              echo "manager=yarn" >> $GITHUB_OUTPUT
              echo "runner=yarn " >> $GITHUB_OUTPUT
              ;;
            bun)
              echo "manager=bun" >> $GITHUB_OUTPUT
              echo "runner=bunx " >> $GITHUB_OUTPUT
              ;;
            deno)
              echo "manager=deno" >> $GITHUB_OUTPUT
              echo "runner=deno run -A npm:" >> $GITHUB_OUTPUT
              ;;
            npm)
              echo "manager=npm" >> $GITHUB_OUTPUT
              echo "runner=npx " >> $GITHUB_OUTPUT
              ;;
            *)
              echo "Error: Unsupported packageManager '${{ inputs.packageManager }}'"
              echo "Supported values: npm, yarn, pnpm, bun, deno"
              exit 1
              ;;
          esac
        elif [ -f "pnpm-lock.yaml" ]; then
          echo "manager=pnpm" >> $GITHUB_OUTPUT
          echo "runner=pnpm exec " >> $GITHUB_OUTPUT
        elif [ -f "yarn.lock" ]; then
          echo "manager=yarn" >> $GITHUB_OUTPUT
          echo "runner=yarn " >> $GITHUB_OUTPUT
        elif [ -f "bun.lock" ] || [ -f "bun.lockb" ]; then
          echo "manager=bun" >> $GITHUB_OUTPUT
          echo "runner=bunx " >> $GITHUB_OUTPUT
        elif [ -f "deno.lock" ]; then
          echo "manager=deno" >> $GITHUB_OUTPUT
          echo "runner=deno run -A npm:" >> $GITHUB_OUTPUT
        else
          echo "manager=npm" >> $GITHUB_OUTPUT
          echo "runner=npx " >> $GITHUB_OUTPUT
        fi
    - name: Run E2E tests
      id: run-tests
      shell: bash
      working-directory: ${{ steps.load-config.outputs.projectRoot }}
      env:
        PRE_RUN_HOOK: ${{ inputs.preRunHook }}
        AFTER_RUN_HOOK: ${{ inputs.afterRunHook }}
        HARNESS_RUNNER: ${{ inputs.runner }}
        HARNESS_APP_PATH: ${{ inputs.app }}
        HARNESS_AVD_CACHING: ${{ inputs.cacheAvd }}
      run: |
        export HARNESS_PROJECT_ROOT="$PWD"

        set +e
        ${{ steps.detect-pm.outputs.runner }}react-native-harness --harnessRunner ${{ inputs.runner }} ${{ inputs.harnessArgs }}
        harness_exit_code=$?
        set -e

        echo "harness_exit_code=$harness_exit_code" >> "$GITHUB_OUTPUT"

        if [ "$harness_exit_code" -ne 0 ]; then
          exit "$harness_exit_code"
        fi
    - name: Upload visual test artifacts
      if: always() && inputs.uploadVisualTestArtifacts == 'true'
      uses: actions/upload-artifact@v4
      with:
        name: visual-test-diffs-${{ fromJson(steps.load-config.outputs.config).platformId }}
        path: |
          ${{ steps.load-config.outputs.projectRoot }}/**/__image_snapshots__/**/*-diff.png
          ${{ steps.load-config.outputs.projectRoot }}/**/__image_snapshots__/**/*-actual.png
        if-no-files-found: ignore
    - name: Save AVD cache
      if: ${{ always() && fromJson(steps.load-config.outputs.config).platformId == 'android' && fromJson(steps.load-config.outputs.config).config.device.type == 'emulator' && fromJson(steps.load-config.outputs.config).action.avdCachingEnabled && steps.avd-cache.outputs.cache-hit != 'true' }}
      uses: actions/cache/save@v4
      with:
        path: |
          ~/.android/avd
          ~/.android/adb*
        key: ${{ steps.avd-key.outputs.key }}
    - name: Upload crash report artifacts
      if: always()
      uses: actions/upload-artifact@v4
      with:
        name: harness-crash-reports-${{ fromJson(steps.load-config.outputs.config).platformId }}
        path: ${{ steps.load-config.outputs.projectRoot }}/.harness/crash-reports/**/*
        if-no-files-found: ignore