test: Restructure Maestro tests for easy config management (#6613)

Fishbowler · Rohit3523 · web-flow · commit 75ac4d2ef52b · 2025-09-02T13:29:09.000-03:00
Co-authored-by: Rohit Bansal &lt;40559587+Rohit3523@users.noreply.github.com&gt;
diff --git a/.maestro/README.md b/.maestro/README.md
@@ -3,36 +3,41 @@
 ## Overview and Folder Structure
 
 ```
-|-- .maestro
-    |-- helpers
-    |   |-- setup.yaml
-    |   |-- launch-app.yaml
-    |   |-- navigate-to-login.yaml
-    |-- onboarding
-    |   |-- login.yaml
-    |   |-- register.yaml
-    |   |-- workspace.yaml
-    |-- more-tests
-    |   |-- test-1.yaml
-    |   |-- test-2.yaml
-    |   |-- test-3.yaml
-    └── scripts
-        ├── data-setup.js
-        ├── data.js
-        ├── e2e_account.js
-        └── random.js
+/.maestro
+├── helpers
+│   └── <global utility subflows>
+├── scripts
+│   └── <javascript test helpers>
+├── tests
+│   ├── onboarding
+│   │   ├── login
+│   │   │   ├── login.yaml
+│   │   │   └── <other tests>
+│   │   └── other subfeature
+│   │       └── <other tests>
+│   ├── teams
+│   │   ├── utils
+│   │   │   └── <utility subflows>
+│   │   └── <teams tests>
+│   └── other feature
+│       ├── feature-test-1.yaml
+│       └── feature-test-2.yaml
+└── config.yaml
 ```
 
 ## Folders
 
 ### `helpers`
+
 - Contains shared functions, YAML templates, or parameterized actions that can be reused across multiple flows
 - Use this to avoid repeating common UI navigation or setup steps in different test files
 
 ### `scripts`
+
 Contains the scripts that are going to be executed by the flows before running the tests:
 
 #### `data.js`
+
 - Contains seeds to common test data, like server url, public channels, etc
 - Currently we point to https://mobile.rocket.chat as main server
   - Pointing to a local server is not recommended yet, as you would need to create a few public channels and change some permissions
@@ -41,31 +46,40 @@ Contains the scripts that are going to be executed by the flows before running t
   - It's hard to keep track of where each value is used
 
 #### `e2e_account.js`
+
 - Contains user and password with correct permissions on main server
   - Check `e2e_account.example.js` for structure
 - It needs to be added manually on local (it's already set on CI)
 
+### `tests`
+
+Contains anything Maestro should actually run and treat as "a test".
+
 ## Prerequisites
 
 Before running Maestro tests, you need to have your app running. You have two options:
 
 ### Option 1: Use Release Build (Recommended)
+
 Create a release version APK or IPA file and install it on your device/simulator.
 
 **Note**: It's good practice to use the release version for E2E testing as it closely matches the production environment.
 
 #### Android Production Build
+
 ```bash
 ./gradlew bundleOfficialRelease
 ```
 
 #### iOS Production Build (Simulator)
+
 Build Experimental app for Simulator:
 ```bash
 bundle exec fastlane build_experimental_simulator
 ```
 
 ### Option 2: Development Build
+
 Start the app in development mode:
 ```bash
 yarn android  # for Android
@@ -83,4 +97,4 @@ maestro test .maestro
 
 # Test a specific file
 maestro test .maestro/tests-folder-1/login.yaml
-```
+```
diff --git a/.maestro/config.yml b/.maestro/config.yml
@@ -1,9 +1,5 @@
 appId: chat.rocket.reactnative
 flows:
-  - onboarding/*
-  - onboarding/login/*
-  - onboarding/register/*
-  - onboarding/workspace/*
-  - teams/*
+  - tests/**
 excludeTags:
   - 'util'
diff --git a/.maestro/tests/onboarding/change-password.yaml b/.maestro/tests/onboarding/change-password.yaml
@@ -1,15 +1,15 @@
 appId: chat.rocket.reactnative
 name: Required Password Change
 onFlowStart:
-  - runFlow: '../helpers/setup.yaml'
+  - runFlow: '../../helpers/setup.yaml'
   - evalScript: ${output.createdUser = output.utils.createUserWithPasswordChange()}
 onFlowEnd:
   - evalScript: ${output.utils.deleteCreatedUsers()}
 
 ---
-- runFlow: ../helpers/launch-app.yaml
+- runFlow: ../../helpers/launch-app.yaml
 - runFlow:
-    file: ../helpers/login.yaml
+    file: ../../helpers/login.yaml
     env:
       USERNAME: ${output.createdUser.username}
       PASSWORD: ${output.createdUser.password}
@@ -38,9 +38,9 @@ onFlowEnd:
     id: change-password-view-set-new-password-button
 - assertVisible:
     id: rooms-list-view
-- runFlow: ../helpers/logout.yaml
+- runFlow: ../../helpers/logout.yaml
 - runFlow:
-    file: ../helpers/login.yaml
+    file: ../../helpers/login.yaml
     env:
       USERNAME: ${output.createdUser.username}
       PASSWORD: 123456
diff --git a/.maestro/tests/onboarding/forgot-password.yaml b/.maestro/tests/onboarding/forgot-password.yaml
@@ -1,12 +1,12 @@
 appId: chat.rocket.reactnative
 name: Forgot Password
 onFlowStart:
-  - runFlow: '../helpers/setup.yaml'
+  - runFlow: '../../helpers/setup.yaml'
   - evalScript: ${output.createdUser = output.utils.createUser()}
 
 ---
-- runFlow: ../helpers/launch-app.yaml
-- runFlow: ../helpers/navigate-to-login.yaml
+- runFlow: ../../helpers/launch-app.yaml
+- runFlow: ../../helpers/navigate-to-login.yaml
 - tapOn:
     id: 'login-view-forgot-password'
 - extendedWaitUntil:
diff --git a/.maestro/tests/onboarding/legal.yaml b/.maestro/tests/onboarding/legal.yaml
@@ -1,18 +1,18 @@
 appId: chat.rocket.reactnative
 name: Legal
 onFlowStart:
-  - runFlow: '../helpers/setup.yaml'
+  - runFlow: '../../helpers/setup.yaml'
 
 ---
-- runFlow: '../helpers/launch-app.yaml'
-- runFlow: '../helpers/navigate-to-workspace.yaml'
+- runFlow: '../../helpers/launch-app.yaml'
+- runFlow: '../../helpers/navigate-to-workspace.yaml'
 - assertVisible:
     id: 'login-view-more'
 - tapOn:
     id: 'login-view-more'
 - assertVisible:
     id: 'legal-view'
-- runFlow: ../helpers/go-back.yaml
+- runFlow: ../../helpers/go-back.yaml
 - scrollUntilVisible:
     element:
       text: 'Create an account'
diff --git a/.maestro/tests/onboarding/login/invalid-credentials.yaml b/.maestro/tests/onboarding/login/invalid-credentials.yaml
@@ -1,13 +1,13 @@
 appId: chat.rocket.reactnative
 name: Login (Invalid Credentials)
 onFlowStart:
-  - runFlow: '../../helpers/setup.yaml'
+  - runFlow: '../../../helpers/setup.yaml'
 onFlowEnd:
   - evalScript: ${output.utils.deleteCreatedUsers()}
 
 ---
-- runFlow: ../../helpers/launch-app.yaml
-- runFlow: ../../helpers/navigate-to-login.yaml
+- runFlow: ../../../helpers/launch-app.yaml
+- runFlow: ../../../helpers/navigate-to-login.yaml
 - tapOn:
     id: 'login-view-email'
 - inputText: 'someusername'
diff --git a/.maestro/tests/onboarding/login/login.yaml b/.maestro/tests/onboarding/login/login.yaml
@@ -1,14 +1,14 @@
 appId: chat.rocket.reactnative
 name: Login
 onFlowStart:
-  - runFlow: ../../helpers/setup.yaml
+  - runFlow: ../../../helpers/setup.yaml
   - evalScript: ${output.createdUser = output.utils.createUser()}
 onFlowComplete:
   - evalScript: ${output.utils.deleteCreatedUsers()}
 
 ---
-- runFlow: ../../helpers/launch-app.yaml
-- runFlow: ../../helpers/navigate-to-login.yaml
+- runFlow: ../../../helpers/launch-app.yaml
+- runFlow: ../../../helpers/navigate-to-login.yaml
 - tapOn:
     id: 'login-view-email'
 - inputText: ${output.createdUser.email}
diff --git a/.maestro/tests/onboarding/register/create-account.yaml b/.maestro/tests/onboarding/register/create-account.yaml
@@ -1,12 +1,12 @@
 appId: chat.rocket.reactnative
 name: Create Account
 onFlowStart:
-  - runFlow: '../../helpers/setup.yaml'
+  - runFlow: '../../../helpers/setup.yaml'
   - evalScript: ${output.user = output.randomUser()}
 
 ---
-- runFlow: ../../helpers/launch-app.yaml
-- runFlow: ../../helpers/navigate-to-register.yaml
+- runFlow: ../../../helpers/launch-app.yaml
+- runFlow: ../../../helpers/navigate-to-register.yaml
 - tapOn:
     id: register-view-name
 - inputText: ${output.user.name}
diff --git a/.maestro/tests/onboarding/register/email-used.yaml b/.maestro/tests/onboarding/register/email-used.yaml
@@ -1,12 +1,12 @@
 appId: chat.rocket.reactnative
 name: Create Account (Email Already Used)
 onFlowStart:
-  - runFlow: '../../helpers/setup.yaml'
+  - runFlow: '../../../helpers/setup.yaml'
   - evalScript: ${output.user = output.utils.createUser()}
 
 ---
-- runFlow: ../../helpers/launch-app.yaml
-- runFlow: ../../helpers/navigate-to-register.yaml
+- runFlow: ../../../helpers/launch-app.yaml
+- runFlow: ../../../helpers/navigate-to-register.yaml
 - tapOn:
     id: register-view-name
 - inputText: ${output.user.name}
diff --git a/.maestro/tests/onboarding/register/username-used.yaml b/.maestro/tests/onboarding/register/username-used.yaml
@@ -1,12 +1,12 @@
 appId: chat.rocket.reactnative
 name: Create Account (Username Already Used)
 onFlowStart:
-  - runFlow: '../../helpers/setup.yaml'
+  - runFlow: '../../../helpers/setup.yaml'
   - evalScript: ${output.user = output.utils.createUser()}
 
 ---
-- runFlow: ../../helpers/launch-app.yaml
-- runFlow: ../../helpers/navigate-to-register.yaml
+- runFlow: ../../../helpers/launch-app.yaml
+- runFlow: ../../../helpers/navigate-to-register.yaml
 - tapOn:
     id: register-view-name
 - inputText: ${output.user.name}
diff --git a/.maestro/tests/onboarding/roomslist.yaml b/.maestro/tests/onboarding/roomslist.yaml
@@ -1,13 +1,13 @@
 appId: chat.rocket.reactnative
 name: Rooms List
 onFlowStart:
-  - runFlow: '../helpers/setup.yaml'
+  - runFlow: '../../helpers/setup.yaml'
 onFlowEnd:
   - evalScript: ${output.utils.deleteCreatedUsers()}
 
 ---
-- runFlow: ../helpers/launch-app.yaml
-- runFlow: ../helpers/login.yaml
+- runFlow: ../../helpers/launch-app.yaml
+- runFlow: ../../helpers/login.yaml
 
 - assertVisible:
     id: 'rooms-list-view'
@@ -18,6 +18,6 @@ onFlowEnd:
 - assertVisible:
     id: 'rooms-list-view-sidebar'
 - runFlow:
-    file: ../helpers/search-room.yaml
+    file: ../../helpers/search-room.yaml
     env:
       ROOM: general
diff --git a/.maestro/tests/onboarding/server-history.yaml b/.maestro/tests/onboarding/server-history.yaml
@@ -1,14 +1,14 @@
 appId: chat.rocket.reactnative
 name: Server History
 onFlowStart:
-  - runFlow: '../helpers/setup.yaml'
+  - runFlow: '../../helpers/setup.yaml'
 onFlowEnd:
   - evalScript: ${output.utils.deleteCreatedUsers()}
 
 ---
-- runFlow: ../helpers/launch-app.yaml
-- runFlow: ../helpers/login.yaml
-- runFlow: ../helpers/logout.yaml
+- runFlow: ../../helpers/launch-app.yaml
+- runFlow: ../../helpers/login.yaml
+- runFlow: ../../helpers/logout.yaml
 
 - assertVisible:
     id: 'servers-history-button'
@@ -26,8 +26,8 @@ onFlowEnd:
 - assertVisible: ${output.createdUser.username}
 
 # we are going back to add workspace from login screen
-- runFlow: ../helpers/go-back.yaml
-- runFlow: ../helpers/go-back.yaml
+- runFlow: ../../helpers/go-back.yaml
+- runFlow: ../../helpers/go-back.yaml
 
 - extendedWaitUntil:
     visible:
diff --git a/.maestro/tests/onboarding/workspace/invalid-workspace.yaml b/.maestro/tests/onboarding/workspace/invalid-workspace.yaml
@@ -2,7 +2,7 @@ appId: chat.rocket.reactnative
 name: Invalid Workspace
 
 ---
-- runFlow: ../../helpers/launch-app.yaml
+- runFlow: ../../../helpers/launch-app.yaml
 - tapOn:
     text: 'Workspace URL. Required.'
 - inputText:
diff --git a/.maestro/tests/onboarding/workspace/valid-workspace.yaml b/.maestro/tests/onboarding/workspace/valid-workspace.yaml
@@ -1,10 +1,10 @@
 appId: chat.rocket.reactnative
 name: Valid Workspace
 onFlowStart:
-  - runFlow: '../../helpers/setup.yaml'
+  - runFlow: '../../../helpers/setup.yaml'
 
 ---
-- runFlow: ../../helpers/launch-app.yaml
+- runFlow: ../../../helpers/launch-app.yaml
 - tapOn:
     text: 'Workspace URL. Required.'
 - inputText:
diff --git a/.maestro/tests/teams/convert-team.yaml b/.maestro/tests/teams/convert-team.yaml
diff --git a/.maestro/tests/teams/create-team.yaml b/.maestro/tests/teams/create-team.yaml
diff --git a/.maestro/tests/teams/team.yaml b/.maestro/tests/teams/team.yaml
diff --git a/.maestro/tests/teams/utils/close-action-sheet.yaml b/.maestro/tests/teams/utils/close-action-sheet.yaml
diff --git a/.maestro/tests/teams/utils/create-channel.yaml b/.maestro/tests/teams/utils/create-channel.yaml
diff --git a/.maestro/tests/teams/utils/open-action-sheet.yaml b/.maestro/tests/teams/utils/open-action-sheet.yaml
