Android AWS Device Farm Tests workflow (Picovoice/leopard)

The Android AWS Device Farm Tests workflow from Picovoice/leopard, explained and optimized by Latchkey.

CI health: D - needs work

Point runs-on at Latchkey and get caching, run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: Picovoice/leopard.github/workflows/android-devicefarm.ymlLicense Apache-2.0View source

What it does

This is the Android AWS Device Farm Tests workflow from the Picovoice/leopard repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

workflow (.yml)

name: Android AWS Device Farm Tests

on:
  workflow_dispatch:
  push:
    branches: [ master ]
    paths:
      - 'binding/android/LeopardTestApp/**'
      - '.github/workflows/android-devicefarm.yml'
      - 'resources/audio_samples/**'
      - 'resources/.test/**'
      - 'script/automation/devicefarm.py'
  pull_request:
    branches: [ master, 'v[0-9]+.[0-9]+' ]
    paths:
      - 'binding/android/LeopardTestApp/**'
      - '.github/workflows/android-devicefarm.yml'
      - 'resources/audio_samples/**'
      - 'resources/.test/**'
      - 'script/automation/devicefarm.py'

defaults:
  run:
    working-directory: binding/android/LeopardTestApp

jobs:
  build:
    name: Run Android Tests on AWS Device Farm
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3

    - name: Installing Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.10'
    - run:
        pip3 install requests boto3

    - name: set up JDK 17
      uses: actions/setup-java@v3
      with:
        java-version: '17'
        distribution: 'temurin'

    - name: Copy test_resources
      run: ./copy_test_resources.sh

    - name: Inject AccessKey
      run: echo pvTestingAccessKey="${{secrets.PV_VALID_ACCESS_KEY}}" >> local.properties

    - name: Inject Device
      run: echo pvTestingDevice="cpu:1" >> local.properties

    - name: Inject Android keystore variables
      run: |
        echo storePassword="${{secrets.ANDROID_RELEASE_KEYSTORE_PASSWORD}}" >> local.properties
        echo keyPassword="${{secrets.ANDROID_RELEASE_KEYSTORE_PASSWORD}}" >> local.properties
        echo keyAlias=picovoice >> local.properties
        echo storeFile=../picovoice.jks >> local.properties

    - name: Setup Android keystore file
      run: echo "${{secrets.ANDROID_RELEASE_KEYSTORE_FILE_B64}}" | base64 -d > picovoice.jks

    - name: Grant execute permission for gradlew
      run: chmod +x gradlew

    - name: Build app
      run: ./gradlew assembleEnDebug

    - name: Build androidTest
      run: ./gradlew assembleEnDebugAndroidTest

    - name: Run tests on AWS Device Farm
      run: python3 ../../../script/automation/devicefarm.py
        --type android
        --run_name leopard-android-unit
        --app_path "leopard-test-app/build/outputs/apk/en/debug/leopard-test-app-en-debug.apk"
        --test_path "leopard-test-app/build/outputs/apk/androidTest/en/debug/leopard-test-app-en-debug-androidTest.apk"
        --aws_id "${{secrets.AWS_DEVICE_FARM_ACCESS_KEY_ID}}"
        --aws_secret "${{secrets.AWS_DEVICE_FARM_ACCESS_KEY_SECRET}}"
        --project_arn "${{secrets.AWS_DEVICE_FARM_PROJECT_ARN}}"
        --test_spec_arn "${{secrets.AWS_DEVICE_FARM_ANDROID_TEST_SPEC_ARN}}"
        --device_pool_arn "${{secrets.AWS_DEVICE_FARM_ANDROID_DEVICE_POOL_ARN}}"

  build-integ:
    name: Run Android Integration Tests on AWS Device Farm
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3

    - name: Installing Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.10'
    - run:
        pip3 install requests boto3

    - name: set up JDK 17
      uses: actions/setup-java@v3
      with:
        java-version: '17'
        distribution: 'temurin'

    - name: Copy test_resources
      run: ./copy_test_resources.sh

    - name: Inject AccessKey
      run: echo pvTestingAccessKey="${{secrets.PV_VALID_ACCESS_KEY}}" >> local.properties

    - name: Inject Device
      run: echo pvTestingDevice="cpu:1" >> local.properties

    - name: Inject Android keystore variables
      run: |
        echo storePassword="${{secrets.ANDROID_RELEASE_KEYSTORE_PASSWORD}}" >> local.properties
        echo keyPassword="${{secrets.ANDROID_RELEASE_KEYSTORE_PASSWORD}}" >> local.properties
        echo keyAlias=picovoice >> local.properties
        echo storeFile=../picovoice.jks >> local.properties

    - name: Setup Android keystore file
      run: echo "${{secrets.ANDROID_RELEASE_KEYSTORE_FILE_B64}}" | base64 -d > picovoice.jks

    - name: Grant execute permission for gradlew
      run: chmod +x gradlew

    - name: Build app
      run: ./gradlew assembleEnRelease

    - name: Build androidTest
      run: ./gradlew assembleEnReleaseAndroidTest -DtestBuildType=integ

    - name: Run tests on AWS Device Farm
      run: python3 ../../../script/automation/devicefarm.py
        --type android
        --run_name leopard-android-integ
        --app_path "leopard-test-app/build/outputs/apk/en/release/leopard-test-app-en-release.apk"
        --test_path "leopard-test-app/build/outputs/apk/androidTest/en/release/leopard-test-app-en-release-androidTest.apk"
        --aws_id "${{secrets.AWS_DEVICE_FARM_ACCESS_KEY_ID}}"
        --aws_secret "${{secrets.AWS_DEVICE_FARM_ACCESS_KEY_SECRET}}"
        --project_arn "${{secrets.AWS_DEVICE_FARM_PROJECT_ARN}}"
        --test_spec_arn "${{secrets.AWS_DEVICE_FARM_ANDROID_TEST_SPEC_ARN}}"
        --device_pool_arn "${{secrets.AWS_DEVICE_FARM_ANDROID_DEVICE_POOL_ARN}}"

The same workflow, on Latchkey

Estimated ~20% faster on cache hits, plus fewer wasted runs and a safer supply chain. Added and changed lines are highlighted.

name: Android AWS Device Farm Tests
 
on:
  workflow_dispatch:
  push:
    branches: [ master ]
    paths:
      - 'binding/android/LeopardTestApp/**'
      - '.github/workflows/android-devicefarm.yml'
      - 'resources/audio_samples/**'
      - 'resources/.test/**'
      - 'script/automation/devicefarm.py'
  pull_request:
    branches: [ master, 'v[0-9]+.[0-9]+' ]
    paths:
      - 'binding/android/LeopardTestApp/**'
      - '.github/workflows/android-devicefarm.yml'
      - 'resources/audio_samples/**'
      - 'resources/.test/**'
      - 'script/automation/devicefarm.py'
 
defaults:
  run:
    working-directory: binding/android/LeopardTestApp
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    name: Run Android Tests on AWS Device Farm
    runs-on: latchkey-small
 
    steps:
    - uses: actions/checkout@v3
 
    - name: Installing Python
      uses: actions/setup-python@v5
      with:
        cache: 'pip'
        python-version: '3.10'
    - run:
        pip3 install requests boto3
 
    - name: set up JDK 17
      uses: actions/setup-java@v3
      with:
        java-version: '17'
        distribution: 'temurin'
 
    - name: Copy test_resources
      run: ./copy_test_resources.sh
 
    - name: Inject AccessKey
      run: echo pvTestingAccessKey="${{secrets.PV_VALID_ACCESS_KEY}}" >> local.properties
 
    - name: Inject Device
      run: echo pvTestingDevice="cpu:1" >> local.properties
 
    - name: Inject Android keystore variables
      run: |
        echo storePassword="${{secrets.ANDROID_RELEASE_KEYSTORE_PASSWORD}}" >> local.properties
        echo keyPassword="${{secrets.ANDROID_RELEASE_KEYSTORE_PASSWORD}}" >> local.properties
        echo keyAlias=picovoice >> local.properties
        echo storeFile=../picovoice.jks >> local.properties
 
    - name: Setup Android keystore file
      run: echo "${{secrets.ANDROID_RELEASE_KEYSTORE_FILE_B64}}" | base64 -d > picovoice.jks
 
    - name: Grant execute permission for gradlew
      run: chmod +x gradlew
 
    - name: Build app
      run: ./gradlew assembleEnDebug
 
    - name: Build androidTest
      run: ./gradlew assembleEnDebugAndroidTest
 
    - name: Run tests on AWS Device Farm
      run: python3 ../../../script/automation/devicefarm.py
        --type android
        --run_name leopard-android-unit
        --app_path "leopard-test-app/build/outputs/apk/en/debug/leopard-test-app-en-debug.apk"
        --test_path "leopard-test-app/build/outputs/apk/androidTest/en/debug/leopard-test-app-en-debug-androidTest.apk"
        --aws_id "${{secrets.AWS_DEVICE_FARM_ACCESS_KEY_ID}}"
        --aws_secret "${{secrets.AWS_DEVICE_FARM_ACCESS_KEY_SECRET}}"
        --project_arn "${{secrets.AWS_DEVICE_FARM_PROJECT_ARN}}"
        --test_spec_arn "${{secrets.AWS_DEVICE_FARM_ANDROID_TEST_SPEC_ARN}}"
        --device_pool_arn "${{secrets.AWS_DEVICE_FARM_ANDROID_DEVICE_POOL_ARN}}"
 
  build-integ:
    timeout-minutes: 30
    name: Run Android Integration Tests on AWS Device Farm
    runs-on: latchkey-small
 
    steps:
    - uses: actions/checkout@v3
 
    - name: Installing Python
      uses: actions/setup-python@v5
      with:
        cache: 'pip'
        python-version: '3.10'
    - run:
        pip3 install requests boto3
 
    - name: set up JDK 17
      uses: actions/setup-java@v3
      with:
        java-version: '17'
        distribution: 'temurin'
 
    - name: Copy test_resources
      run: ./copy_test_resources.sh
 
    - name: Inject AccessKey
      run: echo pvTestingAccessKey="${{secrets.PV_VALID_ACCESS_KEY}}" >> local.properties
 
    - name: Inject Device
      run: echo pvTestingDevice="cpu:1" >> local.properties
 
    - name: Inject Android keystore variables
      run: |
        echo storePassword="${{secrets.ANDROID_RELEASE_KEYSTORE_PASSWORD}}" >> local.properties
        echo keyPassword="${{secrets.ANDROID_RELEASE_KEYSTORE_PASSWORD}}" >> local.properties
        echo keyAlias=picovoice >> local.properties
        echo storeFile=../picovoice.jks >> local.properties
 
    - name: Setup Android keystore file
      run: echo "${{secrets.ANDROID_RELEASE_KEYSTORE_FILE_B64}}" | base64 -d > picovoice.jks
 
    - name: Grant execute permission for gradlew
      run: chmod +x gradlew
 
    - name: Build app
      run: ./gradlew assembleEnRelease
 
    - name: Build androidTest
      run: ./gradlew assembleEnReleaseAndroidTest -DtestBuildType=integ
 
    - name: Run tests on AWS Device Farm
      run: python3 ../../../script/automation/devicefarm.py
        --type android
        --run_name leopard-android-integ
        --app_path "leopard-test-app/build/outputs/apk/en/release/leopard-test-app-en-release.apk"
        --test_path "leopard-test-app/build/outputs/apk/androidTest/en/release/leopard-test-app-en-release-androidTest.apk"
        --aws_id "${{secrets.AWS_DEVICE_FARM_ACCESS_KEY_ID}}"
        --aws_secret "${{secrets.AWS_DEVICE_FARM_ACCESS_KEY_SECRET}}"
        --project_arn "${{secrets.AWS_DEVICE_FARM_PROJECT_ARN}}"
        --test_spec_arn "${{secrets.AWS_DEVICE_FARM_ANDROID_TEST_SPEC_ARN}}"
        --device_pool_arn "${{secrets.AWS_DEVICE_FARM_ANDROID_DEVICE_POOL_ARN}}"

What changed

Run on Latchkey managed runners with one line (runs-on), which apply the fixes below automatically and self-heal transient failures. This example uses latchkey-small; pick the runner size that fits the job.
Cancel superseded runs when a branch or PR gets a newer push.
Cache dependency installs on the setup step so they are served from cache.
Add a job timeout so a hung step cannot burn hours of runner time.

This workflow runs 2 jobs per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow

actions/checkout actions/setup-python actions/setup-java