Skip to content

feat: Introduce maestro for UI testing #5013

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
Apr 25, 2025
Merged

feat: Introduce maestro for UI testing #5013

merged 20 commits into from
Apr 25, 2025

Conversation

facumenzella
Copy link
Contributor

@facumenzella facumenzella commented Apr 23, 2025

Motivation

I've been exploring adding some UI integration tests to cover some basics for customer center. This PR introduces the first test, together with maestro + tuist.

Description

This PR contains two main components:

Maestro

The new example project rc-maestro contains a folder called maestro with a defined structure to add new tests:

  • config.yaml points to the available flows
  • utils folder with "sub-flows" to use in other proper flows
  • `customer_center/feature/test.yaml with different test cases for customer center.

This is called by running maestro test maestro from the root of the example project. The app must be installed before running the command.

Tuist

To avoid adding yet another sample project to our manually maintained workspace, I went this way and quickly introduced tuist. The setup is not final, because we need to migrate more stuff in order to get all the benefits but we will get there eventually.

To generate the rc-maestro project:

  1. Install mise https://mise.jdx.dev/installing-mise.html (manage tuist versions)
  2. tuist generate

The xcodeproj and xcworkspace are ignored, and can be generated whenever you need the project.

Important

This is not yet integrated in the CI, and some tests might conflict with each other. The plan is to add a cleanup flow to make sure each test leaves the simulator ready.

@facumenzella facumenzella marked this pull request as ready for review April 23, 2025 13:22
@facumenzella facumenzella requested a review from a team April 23, 2025 13:22
Copy link
Member

@ajpallares ajpallares left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Amazing work! Once everything is set up, it's great how easy it seems to be to create tests with Maestro.
A couple of comments though. The main one being that I do really think we should be gitignoring the Derived/ folder

@facumenzella facumenzella added the pr:feat A new feature label Apr 24, 2025
Copy link
Member

@JayShortway JayShortway left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really excited for this (Maestro + Tuist)! Just checked the Maestro flows and they look good! 💪

@facumenzella facumenzella enabled auto-merge April 25, 2025 10:23
@facumenzella facumenzella added this pull request to the merge queue Apr 25, 2025
Merged via the queue into main with commit 06d4721 Apr 25, 2025
12 checks passed
@facumenzella facumenzella deleted the feat/maestro-ios branch April 25, 2025 10:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants