fastlane-plugin-developer_device_platform

Run Android instrumentation tests on Google Cloud Developer Device Platform (Device Run) from fastlane.

Firebase Test Lab is deprecated and shuts down on September 30, 2027. Developer Device Platform is its successor on Google Cloud. This plugin wraps gcloud beta device-run so Android instrumentation tests can keep running from a fastlane lane.

1. Uploads the app and test APKs to Cloud Storage and submits a Device Run session (one job per device).
2. Waits for the session to complete, streaming gcloud's progress to the fastlane log.
3. Reads the full session report, prints a per-job result table and the Cloud Console link.
4. Optionally downloads the artifacts (junit.xml, logcat.txt, video.mp4, ...) to a local directory.
5. Fails the lane unless the session result is PASSED (configurable).

• Google Cloud CLI 580.0.0 or newer with the beta component on the machine running fastlane (gcloud components update && gcloud components install beta). On GitHub Actions, pin version in google-github-actions/setup-gcloud; its default latest can resolve to an older release that predates Device Run.

• A Google Cloud project with billing enabled and the APIs turned on:

  gcloud services enable devicerun.googleapis.com devicestreaming.googleapis.com testing.googleapis.com

• The account running the tests needs roles/devicerun.admin and roles/serviceusage.serviceUsageConsumer on the project (see the quickstart).

• Authentication for gcloud. Either log in interactively (gcloud auth login) or pass a service account key with service_account_key_file (see Authentication).

fastlane add_plugin developer_device_platform

lane :instrumentation_tests do
  gradle(task: "assembleDebug assembleDebugAndroidTest")

  developer_device_platform(
    project_id: "my-gcp-project",
    devices: ["shiba-34", "tokay-36"],
    apps: ["app/build/outputs/apk/debug/app-debug.apk"],
    test_apk: "app/build/outputs/apk/androidTest/debug/app-debug-androidTest.apk",
    orchestrator_version: "auto",
    instrumentation_timeout: "15m",
    video: "on-failure",
    download_dir: "build/device-run"
  )
end

Find device IDs with gcloud beta device-run devices list (for example --filter="HARDWARE_TYPE=PHYSICAL AND OS_VERSION=35"). An ID is <model>-<api level>, such as shiba-34, or a descriptive name for virtual devices, such as mediumphone-arm-34.

Inputs may also be gs:// URIs, in which case nothing is uploaded:

developer_device_platform(
  devices: ["mediumphone-arm-34"],
  apps: ["gs://my-bucket/app-debug.apk"],
  test_apk: "gs://my-bucket/app-debug-androidTest.apk",
  sharding_option: "smart",
  smart_sharding_target_duration: "5m",
  smart_sharding_record_name: "nightly",
  flaky_test_attempts: 2,
  flaky_test_retry_level: "test"
)

Options mirror the flags of gcloud beta device-run sessions submit instrumentation. Every option except the hash-valued ones (additional_test_options, other_files_to_push, labels) can also be set through the environment variable DEVELOPER_DEVICE_PLATFORM_<OPTION>; array values are comma-separated.

The action returns a Fastlane::DeveloperDevicePlatform::Session (or the session ID when async is true) and sets:

session = developer_device_platform(devices: ["shiba-34"], test_apk: "test.apk", fail_on_failure: false)
session.jobs.each { |job| puts "#{job.display_name}: #{job.result} #{job.message}" }

Artifacts land in gs://BUCKET/automation/sessions/SESSION_ID/job-NNN/: a junit.xml per job, and test_result.xml, instrument.log, logcat.txt, video recordings and pulled files under execution-NNN/. With download_dir the same tree is copied to <download_dir>/<SESSION_ID>/ and the junit.xml paths are exposed in DEVELOPER_DEVICE_PLATFORM_JUNIT_FILES for JUnit reporters.

Interrupting fastlane while it waits (Ctrl-C, or a cancelled CI job) cancels the Device Run session before exiting, so no job keeps running unattended.

On CI, the simplest setup is a service account key passed through service_account_key_file. The plugin hands it to gcloud via CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE, so the global gcloud configuration is left untouched. If your CI already authenticates gcloud (for example with Workload Identity Federation through google-github-actions/auth), omit the option and the active credentials are used.

Device Run reads inputs and writes results through its own service agent (service-PROJECT_NUMBER@gcp-sa-devicerun.iam.gserviceaccount.com). When you point bucket_name at a bucket in another project, grant that agent roles/storage.objectViewer on it (see Share storage).

bundle install
bundle exec rake        # rspec + rubocop
bundle exec fastlane action developer_device_platform

The gcloud integration is exercised against a fake gcloud executable in spec/fixtures, so the test suite needs neither credentials nor network access.

MIT