coffmark / maestro-docs

Documentation repository for maestro.mobile.dev

description
Maestro is the simplest and most effective mobile UI testing framework.

What is Maestro?

{% embed url="https://vimeo.com/767721667/d972c5f08e" %}

Why Maestro?

Maestro is built on learnings from its predecessors (Appium, Espresso, UIAutomator, XCTest) and allows you to easily define and test your Flows.

{% hint style="info" %} What are Flows? Think of Flows as parts of the user journey in your app. Login, Checkout and Add to Cart are three examples of possible Flows that can be defined and tested using Maestro. {% endhint %}

• Built-in tolerance to flakiness. UI elements will not always be where you expect them, screen tap will not always go through, etc. Maestro embraces the instability of mobile applications and devices and tries to counter it.
• Built-in tolerance to delays. No need to pepper your tests with sleep() calls. Maestro knows that it might take time to load the content (i.e. over the network) and automatically waits for it (but no longer than required).
• Blazingly fast iteration. Tests are interpreted, no need to compile anything. Maestro is able to continuously monitor your test files and rerun them as they change.
• Declarative yet powerful syntax. Define your tests in a yaml file.
• Simple setup. Maestro is a single binary that works anywhere.

Examples

Twitter

Simple Examples

{% tabs %} {% tab title="Android" %}

# flow_contacts_android.yaml

appId: com.android.contacts
---
- launchApp
- tapOn: "Create new contact"
- tapOn: "First Name"
- inputText: "John"
- tapOn: "Last Name"
- inputText: "Snow"
- tapOn: "Save"

{% endtab %}

{% tab title="iOS" %}

# flow_contacts_ios.yaml

appId: com.apple.MobileAddressBook
---
- launchApp
- tapOn: "John Appleseed"
- tapOn: "Edit"
- tapOn: "Add phone"
- inputText: "123123"
- tapOn: "Done"

{% endtab %} {% endtabs %}

Platform Support

Platform	Support
iOS	✅
Android	✅
ReactNative	✅
Flutter	✅

Resources

• Blog Post: Introducing: Maestro — Painless Mobile UI Automation
• GitHub Repository: https://github.com/mobile-dev-inc/maestro
• Public Slack Channel: Join the workspace, then head to the #maestro channel

Get Started

Get started by installing the Maestro CLI: