Skip to content

retyui/Using-GitHub-Actions-to-run-your-Maestro-Flows

Repository files navigation

Run Maestro Flows on CI

In this repo you can find examples of how to run your Maestro Flows on CI using:

MyApp React Native

I created a simple React Native and added a few Maestro Flows to it.

⚠️ Warn: Maestro 1.30.x supports only Android API 26 (Android 8.0) and higher.

Info iOS Android
  • Minimal Android API version is 21 (Android 5.0).
  • Minimal iOS version is 12.4
  • React Native version: 0.72.3
  • New Arch: No
ios.mp4
android.mp4

GitHub Actions (macos-12)

  • Config android-and-ios-github-actions-macos.yaml include Android & iOS e2e workflows
  • Good choice for open-source projects (as is free for public repos)
  • macos-12 can be used for Android and iOS
  • Limitations:
    • price: $0.08
    • 5 concurrent jobs
    • slow android runs but much stable than ubuntu-latest
iOS ver. time
iOS 16 6m 15s
Android API & Arch default google_apis google_apis_playstore
26 x86 5m 44s 8m 29s 11m 39s
26 x86_64 6m 3s 8m 6s
27 x86 6m 47s 8m 40s 12m 4s
27 x86_64 5m 42s
28 x86 6m 10s 9m 8s 8m 9s
28 x86_64 4m 46s 10m 15s 10m 23s
29 x86 4m 40s 9m 10s 12m 2s
29 x86_64 7m 19s 7m 31s 9m 30s
30 x86 8m 46s 14m 8s
30 x86_64 6m 17s 13m 46s 16m 21s
31 x86_64 6m 58s 9m 42s 13m 12s
32 x86_64 16m 19s 16m 53s
33 x86_64 14m 1s 25m 57s
34 x86_64 13m 53s 12m 47s

See here all runs above.

GitHub Actions (ubuntu-latest, ubuntu-*, ...)

Using a linux runner actually is not a good idea for Android e2e tests. For a longer answer please refer to this issue.

  • Config android-github-actions-ubuntu.yaml include Android e2e workflows
  • Limitations:
    • very slow (the fastest run took about 10 min);
    • android API 30 (Android 11) and higher is not supported;
    • flaky tests results;

I tried to run all combinations of android api, arch & target but only several of them was successful :(

List of "stable" combinations:

api level arch target time
26 x86 default 16m 45s
26 x86 google_apis 25m 45s
26 x86_64 default 13m 45s
27 x86 default 13m 38s
27 x86_64 default 12m 28s
28 x86 default 17m 54s
28 x86_64 default 12m 45s

All runs above cost: 113min * $0.008 = $0.904

List of errors that you may get:

Launch emulator:

  • Error: Timeout waiting for emulator to boot

Maestro errors:

  • java.io.IOException: pm list packages --user 0 dev.mobile.maestro.test
  • java.util.concurrent.TimeoutException: Maestro instrumentation could not be initialized
  • java.util.concurrent.TimeoutException: Maestro Android driver did not start up in time

adb commands:

  • adb: failed to install app-release.apk: cmd: Failure calling service package: Broken pipe (32)
  • adb: failed to install app-release.apk: Performing Streamed Install

GitHub Actions timeout-minutes: 90:

  • Error: The operation was canceled.

A custom ubuntu runners much faster and cheaper than GitHub Actions. Also, KVM virtualization is enabled 🎉

Android API & Arch default google_apis google_apis_playstore
26 x86 2m 11s 2m 30s 2m 50s
26 x86_64 1m 56s 2m 39s
27 x86 2m 4s 2m 48s 2m 48s
27 x86_64 1m 57s
28 x86 2m 4s 2m 58s 2m 51s
28 x86_64 2m 15s 3m 0s 2m 56s
29 x86 1m 50s 2m 36s 2m 48s
29 x86_64 8m 28s 3m 31s 3m 45s
30 x86 2m 37s 3m 16s
30 x86_64 2m 35s 3m 19s 5m 46s
31 x86_64 2m 12s 2m 59s 4m 51s
32 x86_64 3m 27s 3m 56s
33 x86_64 3m 21s 3m 28s
34 x86_64 3m 1s 4m 28s

All 35 runs above cost me $0.62 and took 154min using 2vCPU (info from billing portal page)

Using Genymotion SaaS you can create a remote adb connection to a virtual device and run your Maestro E2E tests on it.

version time
Android 13 2m 04s
Android 12 2m 04s
Android 11 1m 46s
Android 10 2m 30s
Android 9 2m 10s
Android 8.1 2m 18s
Android 8 2m 05s

On dashboard 7 all runs above took 10min and cost $0.5

  • Config codemagic.yaml include Android & iOS e2e workflows
  • Provide 500 free build minutes per month on macOS M1 Standard VM (instance_type: mac_mini_m1) standard VM
  • To use instance_type: linux you need to add credit card
  • The Codemagic annual plan gives you a fixed-price plan with the following benefits:
    • 3 concurrencies (with access to Mac mini M2, macOS M1 & Intel, Linux, and Windows instances)
    • Unlimited build minutes 😱
platform instance_type cpu ram time price
Android 11 linux (4) x64 Intel(R) Xeon(R) CPU 16GB 4m 13s $0.015/min
iPhone 14 mac_mini_m1 (4) arm64 Apple M1 (Virtual) 8GB 3m 49s $0.095/min

On billing details page: two runs above took 9min and cost $0.45 (ios: $0.38, android: $0.07)

platform time
Android API 29 1m 10s
Android API 30 1m 21s
Android API 31 1m 8s
Android API 33 1m 10s
iOS 15 0m 49s
iOS 16 1m 9s

More info about runs above...

Nice to know:

  • Samsung Remote Test Lab
  • BrowserStack App Automate

About

Using GitHub Actions to run your Maestro Flows

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published