mobile-dev-inc/maestro

Painless Mobile UI Automation

maestro's Issues

"Below" not working on app settings

Hello,

Here is my flow:

appId: com.android.settings
---
- launchApp
- tapOn: 
    below:
        text: "Apps"

Below or event Above keywords don't work in the Android app settings (Android 12).
Maestro selects the first element of the list instead.

Here is a video:

untitled.1.mp4

maestro_android package does not exists

import maestro_android.MaestroDriverGrpc
import maestro_android.deviceInfoRequest
import maestro_android.tapRequest
import maestro_android.viewHierarchyRequest

above classess not found.

Reset app state when running a test

When I run a test, the app state should be reset. Otherwise, the tests won't be deterministic (for my use case).
For example: After a fresh install, we show a GDPR screen and after the user accepts it, it won't be shown again.
It's mainly an issue while I am writing tests locally. I always need to reset the app by hand.

Typo "embrases"

On https://maestro.mobile.dev/ embrases should be embraces I tihnk

Multiple Taps happening on Jetpack Compose app

I'm trying out version 1.4.0 of Maestro on a Jetpack Compose app, and wrote this yaml:

appId: dev.sanskar.photoplay
---
- launchApp
- tapOn: "Thor: Love and Thunder"
- tapOn: "Add To Watchlist"
- tapOn: "MCU"
- tapOn: "Save"
- back
- tapOn: "Thor: Love and Thunder"
- tapOn: "Add To Watchlist"

But, as observed in the video, there are multiple taps on the MCU entry. I was expecting only one tap to happen. Could it be because the list recomposes on tap?

Is CI integration via Github Actions possible?

A couple questions since the documentation for running on CI is a bit sparse: https://maestro.mobile.dev/getting-started/running-flows-on-ci

• I assume there's a bunch of setup that's necessary in order to make sure you can get the iOS sim and Android emu working on whatever your CI platform is first, right? Is it similar to the basic setup that Detox recommends going through?
• Would it be possible to run Maestro tests if our CI flow is set up to run via Github Actions?

[Android] Tap action on switch wrongfully invokes multiple taps

Here is a video demo of the bug: https://www.youtube.com/watch?v=CxzJXZMOhIY

Even though only one tap action was specified, four tap-actions are being invoked on the view.

The app is just a androidx.appcompat.widget.SwitchCompat in a FrameLayout, no additional logic on the view. Same happens with com.google.android.material.switchmaterial.SwitchMaterial

Match substrings with `text=<regex>` and `id=<regex>`

It would be nice to be able to have tapOn: button find a button with text == My button with a long name. Today we need to write tapOn: .*button.*. Same request for the id matcher.

I can't run " maestro test {path of file yaml} " after install Java for iOS Developer

I download java because when run maestro test /Users/paponsupamongkonchai/MaestroYAML/flow_ios_test.yaml first time log of terminal introduce downlod Java for run command of maestro

Then download and install Java so I run again in terminal maestro test /Users/paponsupamongkonchai/MaestroYAML/flow_ios_test.yaml it's show this message about version Java not support in Java version 55.0

=======See Log Below=======

paponsupamongkonchai@Papons-MacBook-Pro ~ % maestro test /Users/paponsupamongkonchai/MaestroYAML/flow_ios_test.yaml
Exception in thread "main" java.lang.UnsupportedClassVersionError: idb/CompanionServiceGrpc has been compiled by a more recent version of the Java Runtime (class file version 55.0), this version of the Java Runtime only recognizes class file versions up to 52.0
	at java.lang.ClassLoader.defineClass1(Native Method)
	at java.lang.ClassLoader.defineClass(ClassLoader.java:756)
	at java.security.SecureClassLoader.defineClass(SecureClassLoader.java:142)
	at java.net.URLClassLoader.defineClass(URLClassLoader.java:473)
	at java.net.URLClassLoader.access$100(URLClassLoader.java:74)
	at java.net.URLClassLoader$1.run(URLClassLoader.java:369)
	at java.net.URLClassLoader$1.run(URLClassLoader.java:363)
	at java.security.AccessController.doPrivileged(Native Method)
	at java.net.URLClassLoader.findClass(URLClassLoader.java:362)
	at java.lang.ClassLoader.loadClass(ClassLoader.java:418)
	at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:355)
	at java.lang.ClassLoader.loadClass(ClassLoader.java:351)
	at ios.idb.IdbIOSDevice.<init>(IdbIOSDevice.kt:58)
	at maestro.Maestro$Companion.ios(Maestro.kt:291)
	at maestro.Maestro$Companion.ios(Maestro.kt:287)
	at maestro.cli.util.MaestroFactory.createIos(MaestroFactory.kt:58)
	at maestro.cli.util.MaestroFactory.autoDetectPlatform(MaestroFactory.kt:66)
	at maestro.cli.util.MaestroFactory.createMaestro(MaestroFactory.kt:33)
	at maestro.cli.command.TestCommand.call(TestCommand.kt:58)
	at maestro.cli.command.TestCommand.call(TestCommand.kt:30)
	at picocli.CommandLine.executeUserObject(CommandLine.java:1933)
	at picocli.CommandLine.access$1200(CommandLine.java:145)
	at picocli.CommandLine$RunLast.executeUserObjectOfLastSubcommandWithSameParent(CommandLine.java:2332)
	at picocli.CommandLine$RunLast.handle(CommandLine.java:2326)
	at picocli.CommandLine$RunLast.handle(CommandLine.java:2291)
	at picocli.CommandLine$AbstractParseResultHandler.execute(CommandLine.java:2159)
	at picocli.CommandLine.execute(CommandLine.java:2058)
	at maestro.cli.AppKt.main(App.kt:74)

Ability to launch specific Activity on Android

I'm not sure what this would look like from a cross-platform perspective, but it would be useful to be able to launch directly into a specific screen (perhaps with a specific intent). One counter argument is that maestro should only be able to do what a user can. That said, launching a specific Activity feels like a pretty common need.

[Question] Click on view by Id. A real example of tapOn : "id"

I am trying to tap on a particular icon, using its viewId. I use tapOn: "like_icon".

I have tried to click on some views by their Id but none has worked for me.

Open app with deep link

Would be nice to be able to open the app with a deep link:

1. For some E2E tests, we are directly starting a flow with a deep link because the logic before is handled with a different E2E test.
2. We also want to E2E test if the apps open correctly when we send a deep link to the system.

TapOn toolbar item clicks on notification instead

Directly after starting our app a notification is shown because a foreground service is started. But also directly after starting the app I want to click on an item in the toolbar. Unfortunately most of the time maestro clicks on the notification instead of waiting until the notification is gone and the toolbar item is not obscured. Can I manually add some waiting time here or how can I handle this? Thanks!

Wait for result before Tap on point.

After launching my App, I need to tap on a specific XY location on the home screen. But the view is already tapped on the splash screen, before the home screen loads. The same happens when there is a loading screen, and you need to tap on the location after the screen is loaded.

How to run idb_companion --udid {id of the iOS device} for iOS Developer

In my case when run idb_companion --udid {id of the iOS device} .
Result not show same tutorial it's show "Companion will stay alive if target goes offline" only

Command to clear keychain info for the app?

In the iOS app that we're testing, user session data persists to the keychain, even after removing and re-installing the app. Due to this a clearState property does not seem to be sufficient to get a clean state of the app in a such a scenario, as the previously logged in user will stay logged in.
In Appium we found a workaround for this being to force reset iOS Simulator itself when establishing session capabilities, as it is not capable of cleaning the keychain for a specific app (frankly, not sure that iOS even allows this technically).

Is something like clearing keychain info or a clean simulator restart command possibly coming in future versions of Maestro?

Ability to swipe starting at a view

We have the ability to swipe via coordinates today, but that's brittle and difficult to figure out what the right coordinates are. It would be nice to be able to say "Swipe left 1 inch starting from this view".

Screen.Recording.2022-08-15.at.11.54.01.AM.mov

Command to copy text

Would love to have the option to copy the text from a view so it can be checked against some other view. This would also bring in discussion a new assert - assertTextEquals - or something similar.

Incorrect InputText on iOS : ""

Hello,

Here is my flow:

appId: com.apple.MobileAddressBook
---
- launchApp
- tapOn: "John Appleseed"
- tapOn: "Modifier"
- tapOn: "Ajouter un numéro"
- inputText: 123123
- tapOn: "OK"

And running it on a French simulator gives "" instead of 123123:

Screen.Recording.2022-09-01.at.21.37.03.mp4

[Feature] Extend `launchApp` to allow permissions

eg:

- launchApp:
      clearState: true
      permissions: { notifications: 'YES', location: 'always' }

Command to set a Geo location

This appears to be doable:

• Android
• iOS

Maestro hierarchy : Channel ManagedChannelImpl was not shutdown properly!!!

Hello,

On iOS, when running maestro hierarchy, the command ends with:

Sep 03, 2022 9:59:57 AM io.grpc.internal.ManagedChannelOrphanWrapper$ManagedChannelReference cleanQueue
SEVERE: *~*~*~ Channel ManagedChannelImpl{logId=1, target=localhost:7001} was not shutdown properly!!! ~*~*~*
    Make sure to call shutdown()/shutdownNow() and wait until awaitTermination() returns true.
java.lang.RuntimeException: ManagedChannel allocation site
	at io.grpc.internal.ManagedChannelOrphanWrapper$ManagedChannelReference.<init>(ManagedChannelOrphanWrapper.java:93)
	at io.grpc.internal.ManagedChannelOrphanWrapper.<init>(ManagedChannelOrphanWrapper.java:53)
	at io.grpc.internal.ManagedChannelOrphanWrapper.<init>(ManagedChannelOrphanWrapper.java:44)
	at io.grpc.internal.ManagedChannelImplBuilder.build(ManagedChannelImplBuilder.java:630)
	at io.grpc.internal.AbstractManagedChannelImplBuilder.build(AbstractManagedChannelImplBuilder.java:297)
	at maestro.drivers.AndroidDriver.<init>(AndroidDriver.kt:55)
	at maestro.Maestro$Companion.android(Maestro.kt:297)
	at maestro.Maestro$Companion.android$default(Maestro.kt:296)
	at maestro.cli.util.MaestroFactory.createAndroid(MaestroFactory.kt:54)
	at maestro.cli.util.MaestroFactory.autoDetectPlatform(MaestroFactory.kt:63)
	at maestro.cli.util.MaestroFactory.createMaestro(MaestroFactory.kt:33)
	at maestro.cli.command.PrintHierarchyCommand.run(PrintHierarchyCommand.kt:36)
	at picocli.CommandLine.executeUserObject(CommandLine.java:1919)
	at picocli.CommandLine.access$1200(CommandLine.java:145)
	at picocli.CommandLine$RunLast.executeUserObjectOfLastSubcommandWithSameParent(CommandLine.java:2332)
	at picocli.CommandLine$RunLast.handle(CommandLine.java:2326)
	at picocli.CommandLine$RunLast.handle(CommandLine.java:2291)
	at picocli.CommandLine$AbstractParseResultHandler.execute(CommandLine.java:2159)
	at picocli.CommandLine.execute(CommandLine.java:2058)
	at maestro.cli.AppKt.main(App.kt:74)

Compose tap on test tag

Hello everyone, is there a way to tap on a compose component with

Modifier.testTag("email_test_id")

- tapOn:
    optional: false
    id: "email_test_id"

[Feature] Call external functions within the yaml

Background
Sometimes we need to manipulate some other services that we cannot do via the apps UI, it would be useful if we could call some of our own external functions.

Example
In order to log in to my account, I need to enter a pin code sent via text.
I can retrieve this pincode via a /pin endpoint.
By running his function and storing the variable returned, I can continue with my tests

yaml example:

- launchApp
- tapOn:
    id: "LoginButton"
- inputText: "[phone]"
- tapOn:
    id: "Next"
- function: loginPin()
    output: { LOGIN_PIN }
- inputText: ${{ LOGIN_PIN }}

Is this in any projected roadmap at all?

[Question] Contexts, Dynamics, And Test Reports

Hi there! I have a few questions:

• How can I read info from the current context? For example:
  • Read text from label A, pass the text to text field B
  • I need some data from the network
• How can I scroll or swipe specify component? such as swipe on an image view? Or double-tap it?
• How can I customize the timeout for waiting for a component to be visible?
  • My app took a long time to launch, the maestro just assert failed. I need the maestro to wait for a few seconds more time
• How can I find a component by class or type? Not all buttons have text
• Where can I find the test report?

Thank you!

Question: how to assert on snackbars?

I was trying to make a test to verify a snackbar appears. But the snackbar seems to dissappear (long delay) before Maestro can detect it. I am basically asserting visibility on the snackbar text.
Am I doing something wrong?

hierarchy CLI command only showing "text" and "bounds" attributes?

The hierarchy command seems like such a great improvement compared to endless nesting you have to scroll through in Appium's inspector tree view! However, it seems to only return text and bounds attributes for the found views at the moment but not the id, for instance.
Are more attributes output support is planned in future? Thanks!

Support for long press

We've been trying maestro intertnally and it's great btw!

Some of our tests require long press actions but I don't think that's currently supported. Is it something we missed in the documentation?
Or if indeed not supported, any plans for it?

Windows support?

I can only see getting started steps for mac and Linux.

Does maestro currently support windows?
If not do you have a timeline for when we could expect to have windows support?

'no android devices found'

adb is connected. I can run adb shell no problem.

Command to stop the app

Something like:

- stopApp
- stopApp:
     appId: {package name or bundle id}

how to clear input field?

I want to clear the text field and input a new value.

Double tap "emulating" for text selection does not work because it has a delay

- tapOn: "http.*"
- tapOn: "http.*"

Flow:

appId: com.delivery.boy.fl
---
- launchApp
- tapOn:
    id: ".*button_menu"
- tapOn: "Server Address"
# want to select text and replace it
- tapOn: "http.*"
- tapOn: "http.*"
- inputText: "http://url:80/"
# want to select text and replace it
- tapOn: "ok"
- back
- back
- tapOn: "Login"
- inputText: "p1"
- tapOn: "Password"
- inputText: "0000"
- tapOn: 
    id: ".*button_login"

How can i do this? Thanks in advance for your reply.

SHA-256 Mismatch while installing through homebrew on M1

Problem:
When I am installing maestro through homebrew, it is giving SHA-256 checksum mismatch issue. Although It is working fine on my intel mac machine.

[QUESTION] Maestro roadmap?

Hello,

I have been trying maestro for a PoC in my company cause the project it seems promising (congratulations). But it seems the project is in an early stage due to the lack o functionality(timeout configuration, grab elements by data-testid(or other attributes), scroll to a specific element, dynamic content etc.

I am interested in seeing how the tool evolves, is there a public roadmap?

Thanks in advance 😄

resource-id should be printed out as null in view hierarchy

There is some confusion as for which fields to expect in maestro hierarchy output. I.e. clickable attribute is set to null when it is missing but resource-id is just missing from the output entirely.

Support running Maestro on USB-connected devices

Currently, Maestro only works over the network (or on a local emulator) and does not support USB-connected devices due to a limitation in dadb

Add support for flutter element keys

It seems maestro does not support tap on flutter elements using key. This will be helpful to automate app build in flutter - similar to id/text, support for key for flutter element will help.

Troubleshooting steps when an active emulator is not found are not clear

Looking at the documentation, I understand that there is a way to explicitly connect to a specific physical Android device over WiFi pairing, whereas in case with emulators Maestro is expected to always automatically connect to any emulator that is currently running.

That is unfortunately does not work for me and I'm not entirely sure where to look for troubleshooting steps 🤔

When I execute adb devices I get the following output, which is what I expect - got one single Android emulator currently running on my machine:

List of devices attached
emulator-5554	device`

However, when I try to obtain the hierarchy or execute a flow (e.g. maestro -p android hierarchy), I get the following error

java.lang.IllegalStateException: No android devices found.
	at maestro.cli.util.MaestroFactory.createAndroid(MaestroFactory.kt:51)
	at maestro.cli.util.MaestroFactory.createMaestro(MaestroFactory.kt:35)
	at maestro.cli.command.PrintHierarchyCommand.run(PrintHierarchyCommand.kt:36)
	at picocli.CommandLine.executeUserObject(CommandLine.java:1919)
	at picocli.CommandLine.access$1200(CommandLine.java:145)
	at picocli.CommandLine$RunLast.executeUserObjectOfLastSubcommandWithSameParent(CommandLine.java:2332)
	at picocli.CommandLine$RunLast.handle(CommandLine.java:2326)
	at picocli.CommandLine$RunLast.handle(CommandLine.java:2291)
	at picocli.CommandLine$AbstractParseResultHandler.execute(CommandLine.java:2159)
	at picocli.CommandLine.execute(CommandLine.java:2058)
	at maestro.cli.AppKt.main(App.kt:74)

What would you suggest to try to make it work? Are there perhaps any troubleshooting steps that could be added to the documentation for cases like this?

Using Maestro programmatically accept a yaml file as argument

How I would like to use Maestro:
Developers can write tests with the Maestro CLI locally and add them to a folder in our app repository.
For running them on the CI, I would use the programmatic approach and create a small script to get all files from this folder and run them one by one with the programmatic approach.
Why? Our CI system runs on Linux, so I can not install the Maestro CLI with brew.

InputText is written wrongly

As stated in the screenshot below, instead of writing [email protected], the driver does not write the @ symbol but adds the quotes instead

Support screen recording start/stop commands

Text not found

Recording:
https://youtu.be/smpECXx0B1Y?t=524

Allow printing hierarchy while running maestro test in continuous mode

maestro hierarchy times out if you're running maestro -c test in another window. This is actually a very common use case while iterating on a flow. We should support running both simulataneously.

Android driver timeout when running on GitHub Actions

I've tried to add Maestro to my project with this PR and after running the tests on GitHub Actions, I received the following error:

java.util.concurrent.TimeoutException: Maestro Android driver did not start up in time
	at maestro.drivers.AndroidDriver.awaitLaunch(AndroidDriver.kt:104)
	at maestro.drivers.AndroidDriver.open(AndroidDriver.kt:78)
	at maestro.Maestro$Companion.android(Maestro.kt:305)
	at maestro.Maestro$Companion.android$default(Maestro.kt:303)
	at maestro.cli.util.MaestroFactory.createAndroid(MaestroFactory.kt:54)
	at maestro.cli.util.MaestroFactory.createMaestro(MaestroFactory.kt:35)
	at maestro.cli.command.TestCommand.call(TestCommand.kt:58)
	at maestro.cli.command.TestCommand.call(TestCommand.kt:30)
	at picocli.CommandLine.executeUserObject(CommandLine.java:1933)
	at picocli.CommandLine.access$1200(CommandLine.java:145)
	at picocli.CommandLine$RunLast.executeUserObjectOfLastSubcommandWithSameParent(CommandLine.java:2332)
	at picocli.CommandLine$RunLast.handle(CommandLine.java:2326)
	at picocli.CommandLine$RunLast.handle(CommandLine.java:2291)
	at picocli.CommandLine$AbstractParseResultHandler.execute(CommandLine.java:2[159](https://github.com/AdamMc331/TOA/runs/8240575616?check_suite_focus=true#step:5:163))
	at picocli.CommandLine.execute(CommandLine.java:2058)
	at maestro.cli.AppKt.main(App.kt:74)

Additional notes:

Here is my action workflow setup:

- name: Run Tests
        uses: reactivecircus/android-emulator-runner@v2
        with:
          api-level: 29
          script: |
            maestro --platform android test maestro_tests/login.yaml
            maestro --platform android test maestro_tests/create_task.yaml
            maestro --platform android test maestro_tests/mark_task_as_done.yaml
            maestro --platform android test maestro_tests/undo_mark_task_as_done.yaml

The maestro commands should run as soon as the emulator is up and running. I noticed that my APK was not yet installed, so I am trying this again with that step first, but I don't think they're related, as I would have expected some package not found error & not a driver timeout.

Subflows and integrate them into other flows

Would be nice to have "subflows" wich can be written without an appId or launchApp command and they can be called from other flows.
Our use case: When we want to test our checkout flow the user needs to enter the billing details (name, phone number etc.) after this the user can select a payment method. Of course, we want to test the checkout flow with different payment methods but currently, we need to do a lot of copy and paste because of the billing details screen which is error-prone and annoying ;)

ElementNotFound error should expose `hierarchyRoot` as a `val`

Today, the constructor parameter is unused:

maestro/maestro-client/src/main/java/maestro/Errors.kt

Lines 26 to 29 in b367a2c

	class ElementNotFound(
	message: String,
	hierarchyRoot: TreeNode,
	) : MaestroException(message)

Command to take screenshots

Is there any command planned to take screenshots?
This would be very handy to document changes between different versions of an app.

Add capability to run a set of flows

When integrating Maestro in a CI, it could be handly to run a set of flows in one go

React native support?

The provided examples only mention iOS and Android. Given that React native compiles to native components, it should work in theory. Do you have any guidance for React Native apps?

Scroll to a specific view

Would be nice to have a command to scroll to a specific view in the list.
E.g.

• scrollTo
  text: "Text"