Add pre-push hook to run Maestro on emulator

[androiddevcoding]

Use case

Automatically check UI scripts for every git push before pushing to the remote repository. This will protect against accidental regressions and noisy commits.

Proposal

Add a sample pre-push hook and installation instructions to the repository

• AVD check/launch script
• wait for sys.boot_completed
• launch maestro test
• logging
• fail push on errors
• configuration via env: AVD_NAME, MAESTRO_DIR, BOOT_TIMEOUT, MAESTRO_SKIP

Anything else?

No response

[linear]

MAE-343

[Fishbowler]

Perhaps this would belong better in the maestro-docs repository? If so, I can transfer it.

It's not a feature I think would be tolerated by all teams - a git hook that adds more than 10s might be seen as a bit hostile. But I'm not against having it there for teams who want it.

[androiddevcoding]

I recently created a small automation script in .sh that fully covers my needs without relying on CI/CD. I don’t have a full pipeline, and I didn’t want to limit myself in terms of automation. That’s why I wrote a script called maestro_emulator_check.sh, which runs on pre-push. As a result, my tests now run far more often than when I triggered them manually. I believe this approach could also be useful for others, so I’m happy to share it if you see value in it.

Here’s what the script does:

1. checks for the presence of Android SDK, adb, emulator, and Maestro
2. starts the emulator if it’s not running
3. waits until the system is fully booted
4. builds a fresh APK using Gradle
5. locates the generated APK by the configured path
6. installs the APK onto the emulator using adb install -r
7. runs Maestro test flows from the specified directory
8. logs every step into .git/maestro-logs/

I don’t need CI/CD for small projects pre-push validation is enough for me. The script performs the core function I care about: if the tests fail, the code simply doesn’t get pushed. In practice, it works like a lightweight local pipeline, but faster and more convenient for day-to-day development. Example use script log:

[Fishbowler]

Yeah! Let's move this over into the docs, and we can turn it into a howto!

[Fishbowler]

If you add the script, I'll work out how to get it into a sensible shape in the docs?

Work out how you'd like crediting on the page. Some folks in the docs are just name checked, some have LI or GH profile links.

[androiddevcoding]

Work out how you'd like crediting on the page. Some folks in the docs are just name checked, some have LI or GH profile links.

My GitHub page should be enough.

I’ve prepared an article for my proposal - you can review it here: https://www.codingpas.ru/posts/android-ui-tests-maestro-pre-push/

I’m ready to open a Pull Request. Please take a look at the article - it includes my script and explanations. I’d like to add this to the maestro-docs repo. Would you be okay with that? Any recommendations before I submit the PR?

[Fishbowler]

That's a great article!

Definitely open a PR - add a link to the article in /community/articles-and-tutorials.md

❤️