mobile-dev-inc/maestro

Add `visibilityPercentage` param for `assertVisible` command

Open

#1,780 opened on Jul 8, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Kotlin (6,111 stars) (306 forks)batch import
enhancementgood first issuemaestro cli

Description

Is your feature request related to a problem? Please describe. In web testing frameworks, you can frequently specify the % visibility required for an assert-visible statement to succeed. This is useful in cases such as carousels or scrolling, where the edge of an element may be visible (and thus the selector available to Maestro), but the majority of the element still invisible to the user.

Describe the solution you'd like A percentVisible param that can be passed to assertVisible.

- assertVisible: 
    - percentVisible: 50
    - text: Foo text

Describe alternatives you've considered Workarounds typically require adding dynamic test id's. They generally work, but not in all situations, and it's always less than ideal to have to add test id's rather than work with user-facing text.

Additional context Brought up in Slack - https://mobile-dev-inc.slack.com/archives/C05EV48H5FB/p1720029677051159

Contributor guide

Tech stack
kotlinandroid
Domain
testingmobile
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
KotlinMaestro command structureMobile testing concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
First, identify where the `assertVisible` command is defined in the Maestro codebase. Likely in the `maestro core` module. Look for existing command classes handling visibility checks, such as `AssertVisibleCommand.kt`. Then, modify the command to accept an optional `percentVisible` parameter and apply the visibility threshold in the underlying check. Review how other commands handle optional parameters (e.g., in YAML deserialization). Finally, add tests and documentation. Check the Slack thread for any additional context.