Run tests with Maestro Studio

Build and run mobile tests visually with Maestro Studio. Install the IDE, create Flows via screen inspection, and automate tests without writing code.

Maestro Studio is a visual IDE that simplifies mobile automation. This guide covers how to install the application and use its interactive tools to build a contact-creation Flow without writing code from scratch.

Prerequisites

Before building your test, ensure you have a running Android emulator. Access the QuickStart for further guidance on setting up your virtual environment.

1

Installation

Get started by downloading the installer for your specific operating system:

• Windows: Download MaestroStudio.exe and follow the setup wizard.

• macOS: Download MaestroStudio.dmg and drag the icon into your Applications folder.

• Linux: Download MaestroStudio.AppImage, make it executable with chmod +x, and run it.

2

Initial setup

1. Launch Maestro Studio.

2. Click Choose new workspace location to select a folder on your machine where your test files will be saved.

3. Click the No device connected status at the top and select your active virtual device from the list.

3

Create the Flow

Now you can create your first test. In this example, we will build a Flow for the Android Contacts app using Maestro's visual tools:

1. Click Create a new test and select Mobile Test.

2. Enter create_contact.yaml as the Flow name.

3. Select com.google.android.contacts from the dropdown menu.

4. Add android as a tag for the test.

5. Click Create Test. This generates a basic Flow that targets the app.

Tags are used to control which tests run. For more information, access the following pages:

• Environments and variables

• Run cloud tests from Maestro Studio

4

Test the app initialization

Before you begin building the Flow logic, test the app initialization. Click Run Locally and observe the app initializing with a clear state.

5

Interactive authoring

Now it is time to build the Flow logic. Instead of manual typing, we will use Insert Command and Inspect Screen features to build the steps.

First, click Insert Command, search for the startRecording command, and select it. This will record the device screen during the test execution.

To build the following steps of your Flow, use Inspect Screen to select the element and use the Run and Insert action to build the test as you go:

1. Allow notifications: Click Inspect Screen, click the Allow button on the device, and select Run and Insert for tapOn: Allow. This executes the tap on your device and adds the command to your YAML.

2. Create Contact: Click the Create contact button on the device and select Run and Insert for tapOn: Create contact.

3. First Name: Click the First name field, select Run and Insert for tapOn. Use Insert Command to add inputText, replacing the default text with "Jane".

4. Last Name: Click the Last name field, select Run and Insert for tapOn, and use Insert Command to add inputText with the value "Doe".

5. Phone: Use Insert Command to add tapOn: "+1" to select the phone field. Use Insert Command to add eraseText to clear any default formatting, then add inputText with the value "[phone]".

6. Save: Click the Save button and select Run and Insert for tapOn: Save.

7. Confirmation: Use Insert Command to add back to return to the list, then add stopRecording to save the test video.

6

Review and run the Flow

Your completed create_contact.yaml should look like this:

appId: com.google.android.contacts
tags:
  - android
---
- launchApp:
    clearState: true
- startRecording: recording
- tapOn: Allow
- tapOn: Create contact
- tapOn: First name
- inputText: Jane
- tapOn: Last name
- inputText: Doe
- tapOn: "+1"
- eraseText
- inputText: "[phone]"
- tapOn: Save
- back
- stopRecording

Click Run Locally to watch Maestro Studio execute these steps automatically on your device.

After a successful run, the recording file will be available in the .maestro directory.

Next steps

Now that you have created a Flow using the interactive features of Maestro Studio, you can explore more advanced capabilities:

• Environments and variables: Learn how to pass dynamic data like names or phone numbers using variables.

• Run cloud tests from Maestro Studio: Learn how to execute this Flow on using Maestro Cloud.

To learn more about test structure and advanced logic, visit the Maestro Flows documentation.