Atama/test end to end using maestro

.github/workflows/e2e.yml

@@ -0,0 +1,150 @@
+name: 🎭 E2E Tests
+
+env:
+  EXPO_PUBLIC_API_URL: ${{ vars.API_URL }}
+  EXPO_PUBLIC_AUTH_URL: ${{ vars.AUTH_URL }}
+  EXPO_PUBLIC_OPENAPI_URL: ${{ vars.OPENAPI_URL }}
+
+on:
+  workflow_dispatch:
+  pull_request:
+    types: [closed]
+    branches: [main]
+
+jobs:
+  build-apk:
+    name: 🔨 Build APK
+    if: (github.event_name == 'pull_request' && github.event.pull_request.merged == true) || github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🗑 Free disk space
+        uses: jlumbroso/free-disk-space@main
+        with:
+          android: false
+          dotnet: true
+          haskell: true
+          large-packages: true
+          swap-storage: true
+
+      - name: 🏗 Setup repo
+        uses: actions/checkout@v5
+
+      - name: 🏗 Setup pnpm
+        uses: pnpm/action-setup@v5
+        with:
+          version: 10
+
+      - name: 🏗 Setup Node
+        uses: actions/setup-node@v5
+        with:
+          node-version: 'lts/*'
+          cache: 'pnpm'
+
+      - name: 🏗 Setup Java
+        uses: actions/setup-java@v5
+        with:
+          distribution: temurin
+          java-version: '17'
+
+      - name: 📦 Install dependencies
+        run: pnpm install
+
+      - name: 🔑 Generate debug keystore
+        run: |
+          mkdir -p $HOME/.android
+          keytool -genkeypair -v \
+            -keystore $HOME/.android/debug.keystore \
+            -storepass android \
+            -alias androiddebugkey \
+            -keypass android \
+            -keyalg RSA \
+            -keysize 2048 \
+            -validity 10000 \
+            -dname "CN=Android Debug,O=Android,C=US"
+
+      - name: 🔨 Prebuild & Build APK (release)
+        env:
+          JAVA_TOOL_OPTIONS: "-XX:MaxMetaspaceSize=2048m -Dfile.encoding=UTF-8"
+          GRADLE_OPTS: "-Xmx4096m -XX:MaxMetaspaceSize=2048m -Dfile.encoding=UTF-8"
+        run: |
+          APP_ENV=staging npx expo prebuild --clean --platform android
+          cd android && ./gradlew assembleRelease --no-daemon \
+            -PreactNativeArchitectures=x86_64 \
+            -x lintVitalRelease \
+            --max-workers=2 \
+            -Pkotlin.compiler.execution.strategy=in-process \
+            -Pandroid.injected.signing.store.file=$HOME/.android/debug.keystore \
+            -Pandroid.injected.signing.store.password=android \
+            -Pandroid.injected.signing.key.alias=androiddebugkey \
+            -Pandroid.injected.signing.key.password=android
+
+      - name: 📤 Upload APK artifact
+        uses: actions/upload-artifact@v7
+        with:
+          name: app-release
+          path: android/app/build/outputs/apk/release/app-release.apk
+          retention-days: 1
+
+  e2e-full:
+    name: 🎭 Full E2E Tests
+    needs: build-apk
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🏗 Enable KVM
+        run: sudo chmod 777 /dev/kvm
+
+      - name: 🏗 Setup repo
+        uses: actions/checkout@v5
+
+      - name: 🏗 Setup pnpm
+        uses: pnpm/action-setup@v5
+        with:
+          version: 10
+
+      - name: 🏗 Setup Node
+        uses: actions/setup-node@v5
+        with:
+          node-version: 'lts/*'
+          cache: 'pnpm'
+
+      - name: 📦 Install dependencies
+        run: pnpm install
+
+      - name: 📥 Download APK artifact
+        uses: actions/download-artifact@v8
+        with:
+          name: app-release
+          path: android/app/build/outputs/apk/release/
+
+      - name: 📦 Cache Maestro
+        uses: actions/cache@v5
+        with:
+          path: ~/.maestro
+          key: maestro-${{ runner.os }}
+
+      - name: 🎭 Install Maestro
+        run: |
+          if [ ! -f "$HOME/.maestro/bin/maestro" ]; then
+            curl -Ls "https://get.maestro.mobile.dev" | bash
+          fi
+          echo "$HOME/.maestro/bin" >> $GITHUB_PATH
+
+      - name: 🤖 Run full E2E tests on emulator
+        uses: reactivecircus/android-emulator-runner@v2
+        with:
+          api-level: 34
+          arch: x86_64
+          force-avd-creation: false
+          disable-animations: true
+          pre-emulator-launch-script: |
+            echo "persist.sys.locale=en-US" >> $HOME/.android/avd/test.avd/config.ini
+            echo "persist.sys.language=en" >> $HOME/.android/avd/test.avd/config.ini
+            echo "persist.sys.country=US" >> $HOME/.android/avd/test.avd/config.ini
+          script: |
+            adb kill-server
+            adb start-server
+            adb wait-for-device
+            sleep 5
+            adb uninstall com.bearstudio.startuinative.staging || true
+            adb install android/app/build/outputs/apk/release/app-release.apk
+            pnpm test:e2e

.maestro/flows/books.yaml

@@ -0,0 +1,15 @@
+# Tests the books tab navigation and book detail screen.
+# Relies on sign-in.yaml having run first (session state is preserved).
+# Run standalone: maestro test .maestro/flows/sign-in.yaml .maestro/flows/books.yaml
+appId: com.bearstudio.startuinative.staging
+---
+- launchApp
+
+- tapOn: 'Books'
+- waitForAnimationToEnd
+
+- tapOn:
+    index: 0
+    below: 'Books'
+- back
+- assertVisible: 'Books'

.maestro/flows/sign-in.yaml

@@ -0,0 +1,10 @@
+# Tests the complete authentication journey from a clean app state.
+# Run: maestro test .maestro/flows/sign-in.yaml
+appId: com.bearstudio.startuinative.staging
+---
+- launchApp:
+    clearState: true
+
+- runFlow: ../utils/handle-onboarding.yaml
+
+- runFlow: ../utils/login.yaml

.maestro/flows/sign-out.yaml

@@ -0,0 +1,18 @@
+# Tests the logout flow from the account tab.
+# Relies on sign-in.yaml having run first (session state is preserved).
+# Run standalone: maestro test .maestro/flows/sign-in.yaml .maestro/flows/sign-out.yaml
+appId: com.bearstudio.startuinative.staging
+---
+- launchApp
+
+- tapOn: 'Account'
+- tapOn: 'Sign out'
+
+- waitForAnimationToEnd
+
+- tapOn:
+    text: 'Sign out'
+    below: 'You are about to end your session'
+
+- waitForAnimationToEnd
+- assertVisible: 'Login to your account'

.maestro/flows/tab-navigation.yaml

@@ -0,0 +1,17 @@
+# Tests navigation between the three main tabs.
+# Relies on sign-in.yaml having run first (session state is preserved).
+# Run standalone: maestro test .maestro/flows/sign-in.yaml .maestro/flows/tab-navigation.yaml
+appId: com.bearstudio.startuinative.staging
+---
+- launchApp
+
+- assertVisible: 'Home'
+
+- tapOn: 'Books'
+- assertVisible: 'Books'
+
+- tapOn: 'Account'
+- assertVisible: 'Account'
+
+- tapOn: 'Home'
+- assertVisible: 'Home'

.maestro/utils/handle-onboarding.yaml

@@ -0,0 +1,9 @@
+appId: com.bearstudio.startuinative.staging
+---
+- extendedWaitUntil:
+    visible: 'Continue'
+    timeout: 60000
+
+- tapOn: 'Continue'
+
+- tapOn: "Let's start"

.maestro/utils/login.yaml

@@ -0,0 +1,11 @@
+appId: com.bearstudio.startuinative.staging
+env:
+  TEST_EMAIL: 'user@user.com'
+  TEST_OTP: '000000'
+---
+- tapOn:
+    text: 'Email'
+- inputText: ${TEST_EMAIL}
+- tapOn: 'Continue with email'
+- inputText: ${TEST_OTP}
+- assertVisible: 'Home'

README.md

@@ -165,13 +165,14 @@ For the **Release Production** workflow, also configure `eas.json` submit.produc
 ## Workflows
 
 
-| Workflow                  | Trigger      | Description                                                                             |
-| ------------------------- | ------------ | --------------------------------------------------------------------------------------- |
-| **EAS build**             | Manual       | Build app — select profile (development, staging, production) in the GitHub UI          |
-| **EAS Development build** | Manual       | Build development client (internal)                                                     |
-| **EAS Update**            | Manual       | Publish OTA update — select channel (development, staging, production) in the GitHub UI |
-| **EAS Preview**           | Pull request | Publish preview update on PR branch                                                     |
-| **Release Production**    | Manual       | Build production, then submit to App Store and Play Store                               |
+| Workflow                  | Trigger                  | Description                                                                             |
+| ------------------------- | ------------------------ | --------------------------------------------------------------------------------------- |
+| **EAS build**             | Manual                   | Build app — select profile (development, staging, production) in the GitHub UI          |
+| **EAS Development build** | Manual                   | Build development client (internal)                                                     |
+| **EAS Update**            | Manual                   | Publish OTA update — select channel (development, staging, production) in the GitHub UI |
+| **EAS Preview**           | Pull request             | Publish preview update on PR branch                                                     |
+| **Release Production**    | Manual                   | Build production, then submit to App Store and Play Store                               |
+| **E2E Tests**             | PR merged into main / Manual | Build staging APK and run Maestro flows on an Android emulator (API 34, x86_64)    |
 
 
 ### EAS build profiles
@@ -198,3 +199,92 @@ To be able to use previews on PR, you have to setup your project with EAS
     - `eas init --id {projectid}`
     - `eas update:configure`
 
+# E2E Tests (using Maestro)
+
+End-to-end tests are written with [Maestro](https://docs.maestro.dev) and live in the `.maestro/` folder.
+
+## Prerequisites
+
+- **Java 17+** — required by Maestro. Verify with `java -version`, and ensure `JAVA_HOME` points to your installation.
+- **Maestro CLI** — install with:
+
+```bash
+# macOS / Linux
+curl -fsSL "https://get.maestro.mobile.dev" | bash
+
+# macOS (Homebrew)
+brew tap mobile-dev-inc/tap && brew install mobile-dev-inc/tap/maestro
+```
+
+Verify the installation with `maestro --help`.
+
+> [!TIP]
+> On Windows, download `maestro.zip` from the [GitHub releases](https://github.com/mobile-dev-inc/maestro/releases), extract it to `C:\maestro`, then add `C:\maestro\bin` to your `PATH`.
+
+```text
+.maestro/
+├── flows/          # Test flows (one feature per file)
+│   ├── sign-in.yaml
+│   ├── sign-out.yaml
+│   ├── tab-navigation.yaml
+│   └── books.yaml
+└── utils/          # Reusable sub-flows (login, onboarding...)
+    ├── login.yaml
+    └── handle-onboarding.yaml
+```
+
+> [!TIP]
+> Use the script to run the test to be sure to respect the launching order. 
+
+## Setup
+
+The `appId` is set directly in each flow file. The environment variables used for authentication have default values defined in `utils/login.yaml`:
+
+| Variable | Default | Description |
+| --- | --- | --- |
+| `TEST_EMAIL` | `user@user.com` | Email address of the test user |
+| `TEST_OTP` | `000000` | OTP code for the test user |
+
+## Scripts
+
+```bash
+# Run all flows locally
+pnpm test:e2e
+```
+
+> [!TIP]
+> Make sure the staging app (`APP_ENV=staging`) is installed and running in English on an emulator or device before launching the tests.
+
+## Adding new tests
+
+### New flow
+
+Create a new file in `.maestro/flows/`. Each flow must declare the `appId` and start with `launchApp`:
+
+```yaml
+# .maestro/flows/my-feature.yaml
+appId: com.bearstudio.startuinative.staging
+---
+- launchApp
+
+- tapOn: 'My feature'
+- assertVisible: 'Expected text'
+```
+
+If the flow requires the user to be authenticated, add `sign-in.yaml` before it in the `pnpm test:e2e` script in `package.json`. Most flows depend on session state preserved from the previous flow.
+
+### New reusable sub-flow
+
+Place reusable sequences in `.maestro/utils/` and include them with `runFlow:`:
+
+```yaml
+- runFlow: ../utils/my-util.yaml
+```
+
+### Register the flow in the test suite
+
+Add the new flow to the `test:e2e` script in `package.json`, respecting the execution order (authentication must come first):
+
+```json
+"test:e2e": "maestro test .maestro/flows/sign-in.yaml ... .maestro/flows/my-feature.yaml .maestro/flows/sign-out.yaml"
+```

package.json

@@ -23,7 +23,8 @@
     "gen:api": "dotenv -- npx @hey-api/openapi-ts -f ./src/lib/hey-api/config.ts",
     "gen:icons": "svgr --config-file src/components/icons/svgr.config.cjs src/components/icons/svg-sources && prettier -w src/components/icons/generated",
     "android": "expo run:android",
-    "ios": "expo run:ios"
+    "ios": "expo run:ios",
+    "test:e2e": "maestro test .maestro/flows/sign-in.yaml .maestro/flows/tab-navigation.yaml .maestro/flows/books.yaml .maestro/flows/sign-out.yaml"
   },
   "dependencies": {
     "@bearstudio/ui-state": "1.1.0",

src/app/(logged)/(tabs)/_layout.tsx

@@ -79,7 +79,6 @@ export default function TabLayout() {
         headerTintColor: themedStyle.color,
         tabBarStyle: { backgroundColor: themedStyle.backgroundColor },
         tabBarActiveTintColor: themedStyle.color,
-        tabBarButton: (props) => <HapticTab {...props} />,
         sceneStyle: { backgroundColor: themedStyle.sceneBackgroundColor },
       }}
     >
@@ -90,6 +89,7 @@ export default function TabLayout() {
           options={{
             title: t(tab.translationKey),
             headerShown: tab.headerShown,
+            tabBarButton: (props) => <HapticTab {...props} />,
             tabBarIcon: (props) => {
               const TabIcon = props.focused ? tab.iconFocused : tab.icon;
               return (