[ { "path": ".editorconfig", "content": "# Copied from https://youtrack.jetbrains.com/issue/FL-15599/No-way-of-disabling-Java-Kotlin-wildcard-imports\n\n[*.java]\nij_java_class_count_to_use_import_on_demand = 1024\nij_java_names_count_to_use_import_on_demand = 1024\n\n[*.kt]\nij_kotlin_name_count_to_use_star_import = 1024\nij_kotlin_name_count_to_use_star_import_for_members = 1024\n" }, { "path": ".gitattributes", "content": "#\n# https://help.github.com/articles/dealing-with-line-endings/\n#\n# These are explicitly windows files and should use crlf\n*.bat text eol=crlf\n\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.yaml", "content": "name: Report a bug\ndescription: You have a problem with Maestro.\nbody:\n - type: markdown\n attributes:\n value: >\n ### Thank you for using Maestro!\n\n\n Before creating a new issue, please first search the [existing issues]\n and make sure it hasn't been reported before.\n\n\n If you are sure that you have found a bug that hasn't been reported yet,\n or if our documentation doesn't have an answer to what you're looking\n for, then please fill out this template.\n\n\n ---\n\n\n [existing issues]: https://github.com/mobile-dev-inc/maestro\n - type: checkboxes\n attributes:\n label: Is there an existing issue for this?\n description: |\n Please search to see if an issue already exists for the bug you encountered.\n options:\n - label: I have searched the existing issues and didn't find mine.\n required: true\n - type: textarea\n validations:\n required: true\n attributes:\n label: Steps to reproduce\n description: >\n Create a [minimal, reproducible example] that:\n\n 1. Demonstrates the problem\n\n 2. Explains how to reproduce the problem with detailed step-by-step\n instructions\n\n\n **In addition to the detailed step-by-step instructions**, you must include\n information about the device you're encountering the issue on\n (e.g. physical Android or iOS simulator), and the OS version\n (e.g. Android 9, Android 14 with Play Services, or iOS 18).\n\n\n **It's critical that you include your test flow file**. In general, try\n to include as much additional details as possible to make it easier for\n us to understand and fix the problem. Screenshots and videos are\n welcome.\n\n > [!TIP]\n > If you're recording a video on Android, we recommend enabling these options to show taps and gestures:\n > ```\n > adb shell settings put system show_touches 1\n > adb shell settings put system pointer_location 1\n > ```\n\n\n > [!WARNING]\n > Issues that cannot be reproduced are much more likely to be closed.\n\n\n [minimal, reproducible example]: https://stackoverflow.com/help/minimal-reproducible-example\n placeholder: |\n Example good reproduction steps:\n 1. Clone https://github.com/your_username/your_repo_with_bug and `cd` into it\n 2. Start Android emulator (Pixel 7, API 34, with Google Play)\n 3. Build app: `./gradlew :app:assembleDebug`\n 4. Run the problematic flow and see it fail: `maestro test .maestro/flow.yaml`\n - type: textarea\n validations:\n required: true\n attributes:\n label: Actual results\n description: Please explain what is happening.\n - type: textarea\n validations:\n required: true\n attributes:\n label: Expected results\n description: Please explain what you expect to happen.\n - type: textarea\n validations:\n required: true\n attributes:\n label: About app\n description: >\n Include information about the app you're testing:\n \n - Is this an open source or closed source project?\n - If open source, please share link to the repo\n - If closed source, please share app binary and/or an isolated, reproducible sample\n - Is this a native or cross-platform app?\n\n - Framework used to build the app\n - e.g. UIKit, SwiftUI, Android Views, Compose, React Native, or NativeScript\n - If applicable, version of the framework (e.g. Flutter 3.22.0, Compose 1.62.0)\n - If applicable, minimum and target Android SDK/iOS version (e.g. minSdk 21, targetSdk 34)\n placeholder: |\n The info you enter here will make it easier to resolve your issue. For example:\n - This is an open source app, available at https://github.com/wikimedia/wikipedia-ios\n - It's a native iOS app. There is also an Android version, but the issue is only on iOS.\n - It's built mainly with UIKit, minimum iOS deployment target is 13.0\n \n - type: textarea\n validations:\n required: true\n attributes:\n label: About environment\n description: |\n Include information about machine you're running Maestro on:\n \n - Java version (e.g. OpenJDK 17, Eclipse Temurin 8). To find it, run `java -version`\n - OS and its version (e.g. macOS 13.1 Ventura, Ubuntu 24.04, Arch (btw))\n - Processor architecture (x86_64, arm64)\n placeholder: |\n The info you enter here will make it easier to resolve your issue. For example:\n - I'm on M1 MacBook Air, with macOS 14.5 Sonoma and Xcode 15.4.\n - type: textarea\n attributes:\n label: Logs\n description: >\n Include the full logs of the command you're running. The zip files\n created with `maestro bugreport` can be uploaded here as well.\n\n\n Things to keep in mind:\n\n\n - If you're running more than single command, include its logs in a\n separate backticks block.\n\n\n - If the logs are too large to be uploaded to Github, you may upload\n them as a `txt` file or use online tools like https://pastebin.com and\n share the link. Just make sure the link won't break in the future.\n\n\n - **Do not upload screenshots of text**. Instead, use code blocks or the\n above mentioned ways to upload logs.\n\n\n - **Make sure the logs are well formatted**. If you post garbled logs, it\n will make it harder for us to help you.\n value: |\n
\n Logs\n\n ```\n \n ```\n\n
\n - type: input\n validations:\n required: true\n attributes:\n label: Maestro version\n description: >\n Provide version of Maestro CLI where the problem occurs. Run\n `maestro --version` to find out.\n placeholder: 1.36.0\n - type: dropdown\n validations:\n required: true\n attributes:\n label: How did you install Maestro?\n options:\n - install script (https://get.maestro.mobile.dev)\n - Homebrew\n - built from source (please include commit hash in the text area below)\n - other (please specify in the text area below)\n default: 0\n - type: textarea\n validations:\n required: false\n attributes:\n label: Anything else?\n description: >\n Links? Other issues? StackOverflow threads? Anything that will give us\n more context about the issue you are encountering will be helpful.\n\n > [!TIP]\n > You can attach images or log files by clicking this area to highlight it and then dragging files in.\n - type: markdown\n attributes:\n value: >\n Now that you've filled all the required information above, you're ready\n to submit the issue.\n\n\n **Please check what your issue looks like after creating it**. If it\n contains garbled code and logs, please take some time to adjust it so\n it's easier to parse.\n\n\n **Try reading your issue as if you were seeing it for the first time**.\n Does it read well? Is it easy to understand? Is the formatting correct?\n If not, please improve it.\n\n\n Thank you for helping us improve Maestro and keeping our issue tracker\n in a good shape!\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.yaml", "content": "name: Suggest a feature\ndescription: You want to share a new idea to improve Maestro.\nbody:\n - type: markdown\n attributes:\n value: >\n ### Thank you for using Maestro!\n\n\n We can't wait to hear your idea!\n\n\n First though, please search the [existing issues] to see if an issue\n already exists for the feature you need. Maybe someone already did the\n job for you and you don't need to fill this template.\n\n\n ---\n\n\n If you are sure that the feature you want to suggest hasn't been\n requested before, or if our documentation doesn't have an answer to what\n you're looking for, then fill out the template below. Please bear in\n mind that duplicates and insufficiently described feature requests will\n be closed.\n\n\n [existing issues]: https://github.com/mobile-dev-inc/maestro/issues\n - type: textarea\n attributes:\n label: Use case\n description: >\n Please tell us more about the use case you have that led to you wanting\n this new feature.\n\n\n Is your feature request related to a problem? Please give a clear and\n concise description of what the problem is. This will help avoid the\n [XY problem].\n\n\n Describe the alternative solutions you've considered and the tradeoffs\n they come with. The more context you can provide, the better.\n\n\n [XY problem]: https://en.wikipedia.org/wiki/XY_problem\n validations:\n required: true\n - type: textarea\n attributes:\n label: Proposal\n description: >\n Briefly but precisely describe what the new feature should look like\n from the user perspective.\n\n\n Consider attaching something showing what you are imagining:\n * code samples (maybe you already know )\n * API design ideas (e.g. of new YAML commands)\n validations:\n required: true\n - type: textarea\n validations:\n required: false\n attributes:\n label: Anything else?\n description: >\n Links? Other issues? StackOverflow threads? Anything that will give us\n more context about this feature request will be helpful.\n\n > [!TIP]\n > You can attach images or other files by clicking this area to highlight it and then dragging files in.\n" }, { "path": ".github/PULL_REQUEST_TEMPLATE.md", "content": "## Proposed changes\n\ncopilot:summary\n\n## Testing\n\n\n\n> **Does this need e2e tests?** Please consider contributing them to the [demo app](https://github.com/mobile-dev-inc/demo_app) repository.\n\n## Issues fixed\n" }, { "path": ".github/scripts/boot_simulator.sh", "content": "#!/bin/bash\n\n# Specify the device type and runtime as per your requirements\nDEVICE_TYPE=\"${DEVICE_TYPE:-iPhone 15 Pro}\"\nRUNTIME=\"${RUNTIME:-iOS18.6}\"\n\n# Create a unique identifier for the new simulator to avoid naming conflicts\nSIMULATOR_NAME=\"Simulator_$(uuidgen)\"\n\necho \"Creating a new iOS simulator: $SIMULATOR_NAME (Device: $DEVICE_TYPE, Runtime: $RUNTIME)\"\n\n# Create the simulator\nsimulator_id=$(xcrun simctl create \"$SIMULATOR_NAME\" \"$DEVICE_TYPE\" $RUNTIME)\necho \"Simulator ID: $simulator_id created.\"\n\n# Boot the simulator\necho \"Booting the simulator...\"\nxcrun simctl boot \"$simulator_id\"\n\n# Wait for the simulator to be fully booted\nwhile true; do\n # Check the current state of the simulator\n state=$(xcrun simctl list | grep \"$simulator_id\" | grep -o \"Booted\" || true)\n\n if [ \"$state\" == \"Booted\" ]; then\n echo \"Simulator $SIMULATOR_NAME is now ready.\"\n break\n else\n echo \"Waiting for the simulator to be ready...\"\n sleep 5 # sleep for 5 seconds before checking again to avoid spamming\n fi\ndone" }, { "path": ".github/workflows/close-inactive-issues.yaml", "content": "# Close issues that have had \"waiting for customer response\" label for too long.\n\n# This workflow is based on a very similar one from Flutter\n# https://github.com/flutter/flutter/blob/3.22.0/.github/workflows/no-response.yaml\n\nname: close inactive issues\n\non:\n issue_comment:\n types: [created]\n schedule:\n - cron: '0 */6 * * *'\n\npermissions:\n issues: write\n\njobs:\n main:\n runs-on: ubuntu-latest\n if: github.repository == 'mobile-dev-inc/maestro'\n steps:\n - uses: godofredoc/no-response@0ce2dc0e63e1c7d2b87752ceed091f6d32c9df09\n with:\n token: ${{ github.token }}\n closeComment: >\n Without additional information, we can't resolve this issue. We're\n therefore reluctantly going to close it.\n\n\n Feel free to open a new issue with all the required information\n provided, including a [minimal, reproducible sample]. When creating\n a new issue, please make sure to diligently fill out the issue\n template.\n\n\n Thank you for your contribution to our open-source community!\n\n\n [minimal, reproducible sample]: https://stackoverflow.com/help/minimal-reproducible-example\n # Number of days of inactivity before an issue is closed.\n daysUntilClose: 14\n # Only issues with this label will be closed (if they are inactive).\n responseRequiredLabel: waiting for customer response\n" }, { "path": ".github/workflows/lock-closed-issues.yaml", "content": "# Lock closed issues that have been inactive for a while.\n\n# This workflow is copied from Flutter\n# https://github.com/flutter/flutter/blob/3.22.0/.github/workflows/lock.yaml\n\nname: lock closed issues\n\npermissions:\n issues: write\n\non:\n schedule:\n - cron: '0 */6 * * *'\n\njobs:\n lock:\n permissions:\n issues: write\n runs-on: ubuntu-latest\n if: github.repository == 'mobile-dev-inc/maestro'\n steps:\n - uses: dessant/lock-threads@v5\n with:\n process-only: issues\n github-token: ${{ github.token }}\n # Number of days of inactivity before a closed issue is locked.\n issue-inactive-days: 7\n issue-comment: >\n This issue has been automatically locked since there has not been\n any recent activity after it was closed. If you are still\n experiencing a similar problem, please file a new issue. Make\n sure to follow the template and provide all the information\n necessary to reproduce the issue.\n\n Thank you for helping keep us our issue tracker clean!\n" }, { "path": ".github/workflows/publish-cli.yaml", "content": "name: Publish CLI\n\non:\n workflow_dispatch:\n\njobs:\n publish:\n runs-on: ubuntu-latest\n if: github.repository == 'mobile-dev-inc/maestro'\n\n steps:\n - name: Clone repository\n uses: actions/checkout@v4\n\n - name: Set up Java\n uses: actions/setup-java@v4\n with:\n distribution: zulu\n java-version: 17\n cache: gradle\n\n - name: Publish CLI\n run: ./gradlew :maestro-cli:jreleaserFullRelease --no-daemon --no-parallel\n env:\n JRELEASER_GITHUB_TOKEN: ${{ secrets.JRELEASER_GITHUB_TOKEN }}\n\n - name: Print jReleaser log\n if: always()\n run: cat maestro-cli/build/jreleaser/trace.log\n" }, { "path": ".github/workflows/publish-release.yaml", "content": "name: Publish Release\n\non:\n workflow_dispatch:\n push:\n tags:\n - 'v*'\n\nenv:\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.ORG_GRADLE_PROJECT_MAVENCENTRALUSERNAME }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.ORG_GRADLE_PROJECT_MAVENCENTRALPASSWORD }}\n\njobs:\n publish:\n runs-on: ubuntu-latest\n if: github.repository == 'mobile-dev-inc/maestro'\n\n steps:\n - name: Clone repository\n uses: actions/checkout@v4\n\n - name: Set up Java\n uses: actions/setup-java@v4\n with:\n distribution: zulu\n java-version: 17\n cache: gradle\n\n - name: Retrieve version\n run: |\n echo \"VERSION_NAME=$(cat gradle.properties | grep -w \"VERSION_NAME\" | cut -d'=' -f2)\" >> $GITHUB_ENV\n\n - name: Upload Maestro utils release\n run: ./gradlew clean :maestro-utils:publishToMavenCentral --no-daemon --no-parallel\n if: ${{ !endsWith(env.VERSION_NAME, '-SNAPSHOT') }}\n env:\n ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_PRIVATE_KEY }}\n ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ env.ORG_GRADLE_PROJECT_mavenCentralUsername }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ env.ORG_GRADLE_PROJECT_mavenCentralPassword }}\n\n - name: Upload Maestro client release\n run: ./gradlew clean :maestro-client:publishToMavenCentral --no-daemon --no-parallel\n if: ${{ !endsWith(env.VERSION_NAME, '-SNAPSHOT') }}\n env:\n ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_PRIVATE_KEY }}\n ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ env.ORG_GRADLE_PROJECT_mavenCentralUsername }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ env.ORG_GRADLE_PROJECT_mavenCentralPassword }}\n\n - name: Upload Maestro ios release\n run: ./gradlew clean :maestro-ios:publishToMavenCentral --no-daemon --no-parallel\n if: ${{ !endsWith(env.VERSION_NAME, '-SNAPSHOT') }}\n env:\n ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_PRIVATE_KEY }}\n ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ env.ORG_GRADLE_PROJECT_mavenCentralUsername }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ env.ORG_GRADLE_PROJECT_mavenCentralPassword }}\n\n - name: Upload Maestro orchestra release\n run: ./gradlew clean :maestro-orchestra:publishToMavenCentral --no-daemon --no-parallel\n if: ${{ !endsWith(env.VERSION_NAME, '-SNAPSHOT') }}\n env:\n ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_PRIVATE_KEY }}\n ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ env.ORG_GRADLE_PROJECT_mavenCentralUsername }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ env.ORG_GRADLE_PROJECT_mavenCentralPassword }}\n\n - name: Upload Maestro Orchestra Models release\n run: ./gradlew clean :maestro-orchestra-models:publishToMavenCentral --no-daemon --no-parallel\n if: ${{ !endsWith(env.VERSION_NAME, '-SNAPSHOT') }}\n env:\n ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_PRIVATE_KEY }}\n ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ env.ORG_GRADLE_PROJECT_mavenCentralUsername }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ env.ORG_GRADLE_PROJECT_mavenCentralPassword }}\n\n - name: Upload Maestro Proto release\n run: ./gradlew clean :maestro-proto:publishToMavenCentral --no-daemon --no-parallel\n if: ${{ !endsWith(env.VERSION_NAME, '-SNAPSHOT') }}\n env:\n ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_PRIVATE_KEY }}\n ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ env.ORG_GRADLE_PROJECT_mavenCentralUsername }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ env.ORG_GRADLE_PROJECT_mavenCentralPassword }}\n\n - name: Upload Maestro XCUiTest Driver\n run: ./gradlew clean :maestro-ios-driver:publishToMavenCentral --no-daemon --no-parallel\n if: ${{ !endsWith(env.VERSION_NAME, '-SNAPSHOT') }}\n env:\n ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_PRIVATE_KEY }}\n ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ env.ORG_GRADLE_PROJECT_mavenCentralUsername }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ env.ORG_GRADLE_PROJECT_mavenCentralPassword }}\n\n - name: Upload Maestro AI release\n run: ./gradlew clean :maestro-ai:publishToMavenCentral --no-daemon --no-parallel\n if: ${{ !endsWith(env.VERSION_NAME, '-SNAPSHOT') }}\n env:\n ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_PRIVATE_KEY }}\n ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ env.ORG_GRADLE_PROJECT_mavenCentralUsername }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ env.ORG_GRADLE_PROJECT_mavenCentralPassword }}\n\n - name: Upload Maestro Web release\n run: ./gradlew clean :maestro-web:publishToMavenCentral --no-daemon --no-parallel\n if: ${{ !endsWith(env.VERSION_NAME, '-SNAPSHOT') }}\n env:\n ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_PRIVATE_KEY }}\n ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ env.ORG_GRADLE_PROJECT_mavenCentralUsername }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ env.ORG_GRADLE_PROJECT_mavenCentralPassword }}\n\n - name: Upload Maestro CLI release\n run: ./gradlew clean :maestro-cli:publishToMavenCentral --no-daemon --no-parallel\n if: ${{ !endsWith(env.VERSION_NAME, '-SNAPSHOT') }}\n env:\n ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_PRIVATE_KEY }}\n ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ env.ORG_GRADLE_PROJECT_mavenCentralUsername }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ env.ORG_GRADLE_PROJECT_mavenCentralPassword }}" }, { "path": ".github/workflows/publish-snapshot.yaml", "content": "name: Publish Snapshot\n\non:\n workflow_dispatch:\n push:\n branches:\n - main\n\njobs:\n publish:\n runs-on: ubuntu-latest\n if: github.repository == 'mobile-dev-inc/maestro'\n\n steps:\n - name: Clone repository\n uses: actions/checkout@v4\n\n - name: Set up Java\n uses: actions/setup-java@v4\n with:\n distribution: zulu\n java-version: 17\n cache: gradle\n\n - name: Retrieve version\n run: |\n echo \"VERSION_NAME=$(cat gradle.properties | grep -w \"VERSION_NAME\" | cut -d'=' -f2)\" >> $GITHUB_ENV\n\n - name: Upload Maestro utils release\n run: ./gradlew clean :maestro-utils:publish --no-daemon --no-parallel\n if: endsWith(env.VERSION_NAME, '-SNAPSHOT')\n env:\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}\n\n - name: Upload Maestro client release\n run: ./gradlew clean :maestro-client:publish --no-daemon --no-parallel\n if: endsWith(env.VERSION_NAME, '-SNAPSHOT')\n env:\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}\n\n - name: Upload Maestro ios release\n run: ./gradlew clean :maestro-ios:publish --no-daemon --no-parallel\n if: endsWith(env.VERSION_NAME, '-SNAPSHOT')\n env:\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}\n\n - name: Upload Maestro orchestra release\n run: ./gradlew clean :maestro-orchestra:publish --no-daemon --no-parallel\n if: endsWith(env.VERSION_NAME, '-SNAPSHOT')\n env:\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}\n\n - name: Upload Maestro Orchestra Models release\n run: ./gradlew clean :maestro-orchestra-models:publish --no-daemon --no-parallel\n if: endsWith(env.VERSION_NAME, '-SNAPSHOT')\n env:\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}\n\n - name: Upload Maestro Proto release\n run: ./gradlew clean :maestro-proto:publish --no-daemon --no-parallel\n if: endsWith(env.VERSION_NAME, '-SNAPSHOT')\n env:\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}\n\n - name: Upload Maestro XCUiTest Driver\n run: ./gradlew clean :maestro-ios-driver:publish --no-daemon --no-parallel\n if: endsWith(env.VERSION_NAME, '-SNAPSHOT')\n env:\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}\n\n - name: Upload Maestro AI\n run: ./gradlew clean :maestro-ai:publish --no-daemon --no-parallel\n if: endsWith(env.VERSION_NAME, '-SNAPSHOT')\n env:\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}\n\n - name: Upload Maestro web\n run: ./gradlew clean :maestro-web:publish --no-daemon --no-parallel\n if: endsWith(env.VERSION_NAME, '-SNAPSHOT')\n env:\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}\n" }, { "path": ".github/workflows/test-e2e-ios-intel.yaml", "content": "name: Test E2E on iOS (Intel)\n\non:\n workflow_dispatch:\n\njobs:\n build:\n name: Build on Java ${{ matrix.java-version }}\n runs-on: macos-latest\n timeout-minutes: 20\n\n strategy:\n fail-fast: false\n matrix:\n java-version: [17]\n\n steps:\n - name: Clone repository\n uses: actions/checkout@v6\n\n - name: Set up Java\n uses: actions/setup-java@v5\n with:\n distribution: zulu\n java-version: ${{ matrix.java-version }}\n cache: gradle\n\n # Do not rebuild this - let's test the one that is in the repo\n #- name: Build xctest-runner\n # run: ./maestro-ios-xctest-runner/build-maestro-ios-runner.sh | xcbeautify\n\n - name: Build Maestro CLI\n run: ./gradlew :maestro-cli:distZip\n\n - name: Upload zipped Maestro CLI artifact\n uses: actions/upload-artifact@v6\n with:\n name: maestro-cli-jdk${{ matrix.java-version }}-run_id${{ github.run_id }}\n path: maestro-cli/build/distributions/maestro.zip\n retention-days: 1\n\n - name: Upload build/Products to artifacts\n uses: actions/upload-artifact@v6\n with:\n name: build__Products-jdk${{ matrix.java-version }}\n path: build/Products\n retention-days: 1\n\n test-ios:\n name: Test on iOS\n runs-on: macos-15-intel\n needs: build\n timeout-minutes: 120\n\n env:\n MAESTRO_DRIVER_STARTUP_TIMEOUT: 240000 # 240s\n MAESTRO_CLI_LOG_PATTERN_CONSOLE: '%d{HH:mm:ss.SSS} [%5level] %logger.%method: %msg%n'\n\n steps:\n - name: Clone repository (only needed for the e2e directory)\n uses: actions/checkout@v6\n\n - name: Set up JDK\n uses: actions/setup-java@v5\n with:\n distribution: zulu\n java-version: 17\n\n - name: Download artifacts\n uses: actions/download-artifact@v7\n with:\n name: maestro-cli-jdk17-run_id${{ github.run_id }}\n\n - name: Add Maestro CLI executable to PATH\n run: |\n unzip maestro.zip -d maestro_extracted\n echo \"$PWD/maestro_extracted/maestro/bin\" >> $GITHUB_PATH\n\n - name: Check if Maestro CLI executable starts up\n run: |\n maestro --help\n maestro --version\n\n - name: Boot Simulator\n run: |\n xcrun simctl list runtimes\n export RUNTIME=\"iOS18.5\"\n export DEVICE_TYPE=\"iPhone 16\"\n ./.github/scripts/boot_simulator.sh\n\n - name: Download apps\n working-directory: ${{ github.workspace }}/e2e\n run: ./download_apps ios\n\n - name: Install apps\n working-directory: ${{ github.workspace }}/e2e\n run: ./install_apps ios\n\n - name: Start screen recording\n run: |\n xcrun simctl io booted recordVideo --codec h264 ~/screenrecord.mp4 &\n echo $! > ~/screenrecord.pid\n\n - name: Run tests\n working-directory: ${{ github.workspace }}/e2e\n timeout-minutes: 120\n run: ./run_tests ios\n\n - name: Stop screen recording\n if: success() || failure()\n run: kill -SIGINT \"$(cat ~/screenrecord.pid)\"\n\n - name: Upload ~/.maestro artifacts\n uses: actions/upload-artifact@v6\n if: success() || failure()\n with:\n name: maestro-root-dir-ios\n path: ~/.maestro\n retention-days: 7\n include-hidden-files: true\n\n - name: Upload xctest runner logs\n uses: actions/upload-artifact@v6\n if: success() || failure()\n with:\n name: xctest_runner_logs\n path: ~/Library/Logs/maestro/xctest_runner_logs\n retention-days: 7\n include-hidden-files: true\n\n - name: Upload screen recording of Simulator\n uses: actions/upload-artifact@v6\n if: success() || failure()\n with:\n name: maestro-screenrecord-ios.mp4\n path: ~/screenrecord.mp4\n retention-days: 7\n" }, { "path": ".github/workflows/test-e2e-prod.yaml", "content": "name: Test E2E (prod)\n\non:\n workflow_dispatch:\n schedule:\n - cron: '0 * * * *'\n\njobs:\n test-cloud-production:\n # This job is copied from \"e2e-production\" in mobile-dev-inc/monorepo.\n # We want it here so open-source users can also have some visibility into it.\n\n runs-on: ubuntu-latest\n if: github.repository == 'mobile-dev-inc/maestro'\n\n steps:\n - name: Clone repository\n uses: actions/checkout@v4\n\n - name: Set up Java\n uses: actions/setup-java@v4\n with:\n distribution: zulu\n java-version: 17\n\n - name: Install Maestro\n run: |\n curl -Ls --retry 3 --retry-all-errors \"https://get.maestro.mobile.dev\" | bash\n echo \"${HOME}/.maestro/bin\" >> $GITHUB_PATH\n\n - name: Print Maestro version\n run: maestro --version\n\n - name: Download samples\n run: maestro download-samples\n\n - name: Run iOS test\n run: |\n maestro cloud \\\n --apiKey ${{ secrets.E2E_MOBILE_DEV_API_KEY }} \\\n --timeout 180 \\\n --fail-on-cancellation \\\n --include-tags=advanced \\\n samples/sample.zip samples\n\n - name: Run Android test\n run: |\n maestro cloud \\\n --apiKey ${{ secrets.E2E_MOBILE_DEV_API_KEY }} \\\n --fail-on-cancellation \\\n --include-tags advanced \\\n samples/sample.apk samples\n\n - name: Send Slack message\n if: failure()\n run: |\n curl --request POST \\\n --url \"${{ secrets.E2E_SLACK_WEBHOOK_URL }}\" \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"text\": \"๐Ÿšจ *Maestro E2E Test Failed*\\nStatus: 'Failure'\\nRun: <${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|View details>\"\n }'\n\n # - name: Trigger alert on failure\n # if: ${{ false }}\n # # if: failure()\n # run: |\n # curl --request POST \\\n # --url \"https://events.pagerduty.com/v2/enqueue\" \\\n # --header 'Content-Type: application/json' \\\n # --data '{\n # \"payload\": {\n # \"summary\": \"E2E test failed\",\n # \"source\": \"E2E test\",\n # \"severity\": \"critical\"\n # },\n # \"routing_key\": \"${{ secrets.E2E_PAGER_DUTY_INTEGRATION_KEY }}\",\n # \"event_action\": \"trigger\",\n # \"links\": [\n # {\n # \"href\": \"${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\",\n # \"text\": \"Failed E2E test - Github Action\"\n # }\n # ]\n # }'\n" }, { "path": ".github/workflows/test-e2e.yaml", "content": "name: Test E2E\n\non:\n workflow_dispatch:\n pull_request:\n\njobs:\n build:\n name: Build on Java ${{ matrix.java-version }}\n runs-on: macos-latest\n timeout-minutes: 20\n\n strategy:\n fail-fast: false\n matrix:\n java-version: [17]\n\n steps:\n - name: Clone repository\n uses: actions/checkout@v6\n\n - name: Set up Java\n uses: actions/setup-java@v5\n with:\n distribution: zulu\n java-version: ${{ matrix.java-version }}\n cache: gradle\n\n - name: Build xctest-runner\n run: ./maestro-ios-xctest-runner/build-maestro-ios-runner.sh | xcbeautify\n\n - name: Build Maestro CLI\n run: ./gradlew :maestro-cli:distZip\n\n - name: Upload zipped Maestro CLI artifact\n uses: actions/upload-artifact@v6\n with:\n name: maestro-cli-jdk${{ matrix.java-version }}-run_id${{ github.run_id }}\n path: maestro-cli/build/distributions/maestro.zip\n retention-days: 1\n\n - name: Upload build/Products to artifacts\n uses: actions/upload-artifact@v6\n with:\n name: build__Products-jdk${{ matrix.java-version }}\n path: build/Products\n retention-days: 1\n\n test-web:\n name: Test on Web\n runs-on: ubuntu-latest\n needs: build\n\n steps:\n - name: Clone repository (only needed for the e2e directory)\n uses: actions/checkout@v6\n\n - name: Set up demo_app workspace\n run: |\n git clone --depth 1 https://github.com/mobile-dev-inc/demo_app /tmp/demo_app\n mkdir -p ${{ github.workspace }}/e2e/workspaces/demo_app\n cp -r /tmp/demo_app/.maestro/. ${{ github.workspace }}/e2e/workspaces/demo_app/\n\n - name: Set up Java\n uses: actions/setup-java@v5\n with:\n distribution: zulu\n java-version: 17\n\n - name: Set up Chrome\n uses: browser-actions/setup-chrome@v2\n with:\n chrome-version: 142\n\n - name: Download artifacts\n uses: actions/download-artifact@v7\n with:\n name: maestro-cli-jdk17-run_id${{ github.run_id }}\n\n - name: Add Maestro CLI executable to PATH\n run: |\n unzip maestro.zip -d maestro_extracted\n echo \"$PWD/maestro_extracted/maestro/bin\" >> $GITHUB_PATH\n\n - name: Check if Maestro CLI executable starts up\n run: |\n maestro --help\n maestro --version\n \n - name: Run tests\n working-directory: ${{ github.workspace }}/e2e\n timeout-minutes: 20\n run: ./run_tests web\n\n - name: Upload ~/.maestro artifacts\n uses: actions/upload-artifact@v6\n if: success() || failure()\n with:\n name: maestro-root-dir-web\n path: ~/.maestro\n retention-days: 7\n include-hidden-files: true\n\n test-android:\n name: Test on Android\n runs-on: ubuntu-latest\n needs: build\n timeout-minutes: 60\n\n env:\n ANDROID_HOME: /home/runner/androidsdk\n ANDROID_SDK_ROOT: /home/runner/androidsdk\n ANDROID_AVD_HOME: /home/runner/.config/.android/avd/\n ANDROID_OS_IMAGE: system-images;android-32;google_apis;x86_64\n ANDROID_PLATFORM: platforms;android-34\n\n steps:\n - name: Enable KVM group perms\n run: |\n echo 'KERNEL==\"kvm\", GROUP=\"kvm\", MODE=\"0666\", OPTIONS+=\"static_node=kvm\"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules\n sudo udevadm control --reload-rules\n sudo udevadm trigger --name-match=kvm\n\n - name: Clone repository (only needed for the e2e directory)\n uses: actions/checkout@v6\n\n - name: Set up demo_app workspace\n run: |\n git clone --depth 1 https://github.com/mobile-dev-inc/demo_app /tmp/demo_app\n mkdir -p ${{ github.workspace }}/e2e/workspaces/demo_app\n cp -r /tmp/demo_app/.maestro/. ${{ github.workspace }}/e2e/workspaces/demo_app/\n\n - name: Set up Java\n uses: actions/setup-java@v5\n with:\n distribution: zulu\n java-version: 17\n\n - name: Download Maestro build from previous job\n uses: actions/download-artifact@v7\n with:\n name: maestro-cli-jdk17-run_id${{ github.run_id }}\n\n - name: Add Maestro CLI executable to PATH\n run: |\n unzip maestro.zip -d maestro_extracted\n echo \"$PWD/maestro_extracted/maestro/bin\" >> $GITHUB_PATH\n\n - name: Check if Maestro CLI executable starts up\n run: |\n maestro --help\n maestro --version\n\n - name: Set up mobile-dev-inc/bartek-scripts (for install_android_sdk script)\n run: |\n git clone https://github.com/mobile-dev-inc/bartek-scripts.git $HOME/scripts\n echo \"$HOME/scripts/bin\" >> $GITHUB_PATH\n\n - name: Set up Android Command-line Tools\n run: |\n # v13 - see https://stackoverflow.com/a/78890086/7009800\n install_android_sdk https://dl.google.com/android/repository/commandlinetools-linux-12266719_latest.zip\n echo \"$ANDROID_HOME/cmdline-tools/latest/bin:$PATH\" >> $GITHUB_PATH\n\n - name: Set up Android SDK components\n run: |\n yes | sdkmanager --licenses\n sdkmanager --install emulator\n echo \"$ANDROID_HOME/emulator\" >> $GITHUB_PATH\n sdkmanager --install \"platform-tools\"\n echo \"$ANDROID_HOME/platform-tools\" >> $GITHUB_PATH\n sdkmanager --install \"$ANDROID_PLATFORM\"\n sdkmanager --install \"$ANDROID_OS_IMAGE\"\n\n - name: Create AVD\n run: |\n avdmanager -s create avd \\\n --package \"$ANDROID_OS_IMAGE\" \\\n --name \"MyAVD\"\n\n echo \"DEBUG INFO\"\n \n avdmanager list avd\n\n echo \"ANDROID_PREFS_ROOT=$ANDROID_PREFS_ROOT\"\n echo \"ANDROID_SDK_ROOT=$ANDROID_SDK_ROOT\"\n echo \"ANDROID_HOME=$ANDROID_HOME\"\n echo \"ANDROID_SDK_HOME=$ANDROID_SDK_HOME\"\n echo \"ANDROID_AVD_HOME=$ANDROID_AVD_HOME\"\n echo \"ANDROID_EMULATOR_HOME=$ANDROID_EMULATOR_HOME\"\n \n echo \"HOME=$HOME\"\n \n cat << EOF >> ~/.config/.android/avd/MyAVD.avd/config.ini\n hw.cpu.ncore=2\n hw.gpu.enabled=yes\n hw.gpu.mode=swiftshader_indirect\n hw.ramSize=3072\n disk.dataPartition.size=4G\n vm.heapSize=576\n hw.lcd.density=440\n hw.lcd.height=2220\n hw.lcd.width=1080\n EOF\n\n - name: Run AVD\n run: |\n emulator @MyAVD \\\n -verbose -no-snapshot -no-window -no-audio -no-boot-anim -accel on -camera-back none -qemu -m 3072 \\\n >~/emulator_stdout.log \\\n 2>~/emulator_stderr.log &\n\n - name: Wait for AVD to start up\n run: |\n adb wait-for-device && echo 'Emulator device online'\n adb wait-for-device shell 'while [[ -z $(getprop sys.boot_completed) ]]; do sleep 1; done;' && echo 'Emulator booted'\n\n # This is also a prerequiste\n while true; do\n adb shell service list | grep 'package' && echo 'service \"package\" is active!' && break\n echo 'waiting for service \"package\" to start'\n sleep 1\n done\n\n - name: Download apps\n working-directory: ${{ github.workspace }}/e2e\n run: ./download_apps android\n\n - name: Install apps\n working-directory: ${{ github.workspace }}/e2e\n run: ./install_apps android\n\n\n\n - name: Start screen recording of AVD\n run: |\n adb shell screenrecord /sdcard/screenrecord.mp4 &\n echo $! > ~/screenrecord.pid\n\n - name: Run tests\n working-directory: ${{ github.workspace }}/e2e\n timeout-minutes: 20\n run: ./run_tests android\n\n - name: Stop screen recording of AVD\n if: success() || failure()\n run: |\n kill -SIGINT \"$(cat ~/screenrecord.pid)\" || echo \"failed to kill screenrecord: code $?\" && exit 0\n sleep 5 # prevent video file corruption\n adb pull /sdcard/screenrecord.mp4 ~/screenrecord.mp4\n\n - name: Upload ~/.maestro artifacts\n uses: actions/upload-artifact@v6\n if: success() || failure()\n with:\n name: maestro-root-dir-android\n path: ~/.maestro\n retention-days: 7\n include-hidden-files: true\n\n - name: Upload screen recording of AVD\n uses: actions/upload-artifact@v6\n if: success() || failure()\n with:\n name: maestro-screenrecord-android.mp4\n path: ~/screenrecord.mp4\n retention-days: 7\n\n test-ios:\n name: Test on iOS\n runs-on: macos-26\n needs: build\n timeout-minutes: 120\n\n env:\n MAESTRO_DRIVER_STARTUP_TIMEOUT: 240000 # 240s\n MAESTRO_CLI_LOG_PATTERN_CONSOLE: '%d{HH:mm:ss.SSS} [%5level] %logger.%method: %msg%n'\n\n steps:\n - name: Clone repository (only needed for the e2e directory)\n uses: actions/checkout@v6\n\n - name: Set up demo_app workspace\n run: |\n git clone --depth 1 https://github.com/mobile-dev-inc/demo_app /tmp/demo_app\n mkdir -p ${{ github.workspace }}/e2e/workspaces/demo_app\n cp -r /tmp/demo_app/.maestro/. ${{ github.workspace }}/e2e/workspaces/demo_app/\n\n - name: Set up JDK\n uses: actions/setup-java@v5\n with:\n distribution: zulu\n java-version: 17\n\n - name: Download artifacts\n uses: actions/download-artifact@v7\n with:\n name: maestro-cli-jdk17-run_id${{ github.run_id }}\n\n - name: Add Maestro CLI executable to PATH\n run: |\n unzip maestro.zip -d maestro_extracted\n echo \"$PWD/maestro_extracted/maestro/bin\" >> $GITHUB_PATH\n\n - name: Check if Maestro CLI executable starts up\n run: |\n maestro --help\n maestro --version\n\n - name: Boot Simulator\n run: |\n xcrun simctl list runtimes\n export RUNTIME=\"iOS26.1\"\n export DEVICE_TYPE=\"iPhone 17 Pro\"\n ./.github/scripts/boot_simulator.sh\n\n - name: Download apps\n working-directory: ${{ github.workspace }}/e2e\n run: ./download_apps ios\n\n - name: Install apps\n working-directory: ${{ github.workspace }}/e2e\n run: ./install_apps ios\n\n - name: Start screen recording\n run: |\n xcrun simctl io booted recordVideo --codec h264 ~/screenrecord.mp4 &\n echo $! > ~/screenrecord.pid\n\n - name: Run tests\n working-directory: ${{ github.workspace }}/e2e\n timeout-minutes: 120\n run: ./run_tests ios\n\n - name: Stop screen recording\n if: success() || failure()\n run: kill -SIGINT \"$(cat ~/screenrecord.pid)\"\n\n - name: Upload ~/.maestro artifacts\n uses: actions/upload-artifact@v6\n if: success() || failure()\n with:\n name: maestro-root-dir-ios\n path: ~/.maestro\n retention-days: 7\n include-hidden-files: true\n\n - name: Upload xctest runner logs\n uses: actions/upload-artifact@v6\n if: success() || failure()\n with:\n name: xctest_runner_logs\n path: ~/Library/Logs/maestro/xctest_runner_logs\n retention-days: 7\n include-hidden-files: true\n\n - name: Upload screen recording of Simulator\n uses: actions/upload-artifact@v6\n if: success() || failure()\n with:\n name: maestro-screenrecord-ios.mp4\n path: ~/screenrecord.mp4\n retention-days: 7\n\n test-ios-xctest-runner:\n name: Test on iOS (XCTest Runner only)\n if: false # Disabled: This needs be fixed, not working yet.\n runs-on: macos-latest\n needs: build\n timeout-minutes: 30\n\n steps:\n - name: Clone repository (only needed for the e2e directory)\n uses: actions/checkout@v6\n\n - name: Set up JDK\n uses: actions/setup-java@v5\n with:\n distribution: zulu\n java-version: 17\n\n - name: Download Maestro artifact\n uses: actions/download-artifact@v7\n with:\n name: maestro-cli-jdk17-run_id${{ github.run_id }}\n\n - name: Download build/Products artifact\n uses: actions/download-artifact@v7\n with:\n name: build__Products-jdk17\n path: build/Products\n\n - name: Add Maestro CLI executable to PATH\n run: |\n unzip maestro.zip -d maestro_extracted\n echo \"$PWD/maestro_extracted/maestro/bin\" >> $GITHUB_PATH\n\n - name: Check if Maestro CLI executable starts up\n run: |\n maestro --help\n maestro --version\n\n - name: Boot Simulator\n run: ./.github/scripts/boot_simulator.sh\n\n - name: Run tests\n timeout-minutes: 15\n run: ./maestro-ios-xctest-runner/test-maestro-ios-runner.sh\n\n - name: Upload xc test runner logs\n uses: actions/upload-artifact@v6\n if: success() || failure()\n with:\n name: test-ios-xctest-runner__xctest_runner_logs\n path: ~/Library/Logs/maestro/xctest_runner_logs\n retention-days: 7\n include-hidden-files: true\n" }, { "path": ".github/workflows/test.yaml", "content": "name: Test\n\non:\n workflow_dispatch:\n pull_request:\n\njobs:\n unit-test:\n name: Unit Test on Java ${{ matrix.java-version }}\n runs-on: ubuntu-latest\n\n strategy:\n fail-fast: false\n matrix:\n java-version: [17]\n\n steps:\n - name: Clone repository\n uses: actions/checkout@v4\n\n - name: Set up Java\n uses: actions/setup-java@v4\n with:\n distribution: zulu\n java-version: ${{ matrix.java-version }}\n cache: gradle\n\n - name: Test\n id: unit-test\n run: ./gradlew test\n\n - name: Upload unit test report\n uses: actions/upload-artifact@v4\n if: failure()\n with:\n name: maestro-unit-test-report\n path: ./**/build/reports/tests/test\n retention-days: 1\n include-hidden-files: true\n\n ios-driver-lib-test:\n name: MaestroDriverLib Unit Tests\n runs-on: macos-latest\n timeout-minutes: 10\n\n steps:\n - name: Clone repository\n uses: actions/checkout@v4\n\n - name: Run MaestroDriverLib Tests\n working-directory: ${{ github.workspace }}/maestro-ios-xctest-runner/MaestroDriverLib\n run: swift test\n\n ios-xctest-runner-test:\n name: iOS XCTest Runner Unit Tests\n runs-on: macos-latest\n timeout-minutes: 15\n\n steps:\n - name: Clone repository\n uses: actions/checkout@v4\n\n - name: Select Xcode\n run: sudo xcode-select -s /Applications/Xcode.app/Contents/Developer\n\n - name: Run iOS Unit Tests\n working-directory: ${{ github.workspace }}/maestro-ios-xctest-runner\n run: |\n xcodebuild test \\\n -project maestro-driver-ios.xcodeproj \\\n -scheme maestro-driver-iosTests \\\n -destination 'platform=iOS Simulator,name=iPhone 16' \\\n -only-testing:maestro-driver-iosTests \\\n | xcpretty --color || exit ${PIPESTATUS[0]}\n\n validate-gradle-wrapper:\n runs-on: ubuntu-latest\n\n steps:\n - name: Clone repository\n uses: actions/checkout@v4\n\n - name: Validate Gradle Wrapper\n uses: gradle/actions/wrapper-validation@v4\n" }, { "path": ".github/workflows/update-samples.yaml", "content": "name: Update samples\n\non:\n workflow_dispatch:\n push:\n branches: [main]\n\njobs:\n main:\n runs-on: ubuntu-latest\n if: github.repository == 'mobile-dev-inc/maestro'\n\n steps:\n - name: Clone repository\n uses: actions/checkout@v4\n\n - name: Authenticate to Google Cloud\n uses: google-github-actions/auth@v2\n with:\n # These credentials should only have write access to the bucket\n credentials_json: ${{ secrets.GCP_MOBILEDEV_BUCKET_CREDENTIALS }}\n\n - name: Set up Google Cloud CLI\n uses: google-github-actions/setup-gcloud@v2\n with:\n version: '>= 484.0.0'\n project_id: perf-dev-289002\n \n - name: Upload samples to public Google Cloud Storage bucket\n run: |\n cd e2e/\n ./update_samples\n" }, { "path": ".gitignore", "content": ".DS_Store\n\n# Ignore Gradle project-specific cache directory\n.gradle\n\n# Ignore Gradle build output directory\nbuild\n\n# Ignore Gradle local properties\nlocal.properties\n\nbin\n\n# media assets\nmaestro-orchestra/src/test/resources/media/assets/*\n\n# Local files\nlocal/" }, { "path": ".idea/.gitignore", "content": "# Default ignored files\n/shelf/\n/workspace.xml\n# Editor-based HTTP Client requests\n/httpRequests/\n# Datasource local storage ignored files\n/dataSources/\n/dataSources.local.xml\n\n# Above is default, IntelliJ-generated config. Below is our custom config.\n# Inspired by:\n# - https://github.com/Vadorequest/JetBrains-Intellij-IDEA-.gitignore-best-practices\n# - https://github.com/salarmehr/idea-gitignore\n# - https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore\n\ndataSources/\ndataSources.local.xml\nmisc.xml\nworkspace.xml\n\ngoogle-java-format.xml\ninspectionProfiles/\n\ncompiler.xml\ndeploymentTargetSelector.xml\ngradle.xml\nkotlinc.xml\nvcs.xml\n\ncopilot.data.migration.*" }, { "path": ".idea/.name", "content": "maestro" }, { "path": ".idea/dictionaries/project.xml", "content": "\n \n \n addmedia\n amanjeet\n applesimutils\n avdmanager\n bartekpacia\n bartkepacia\n berik\n caseley\n cirrusci\n clearstate\n dadb\n devicectl\n dpad\n evals\n faceid\n feeditem\n graal\n graaljs\n inputmethod\n iphoneos\n iphonesimulator\n jreleaser\n keyevent\n macosx\n mdev\n medialibrary\n mobiledev\n mobilesafari\n modelcontextprotocol\n niklasson\n nowinandroid\n openqa\n posthog\n printenv\n reinstalls\n rhinojs\n runscript\n saveliev\n screenrecord\n screenrecording\n sdkmanager\n simctl\n systemui\n takamine\n testsuites\n tokou\n udid\n visschers\n xcbeautify\n xcrun\n xctestrun\n xctestrunner\n xctrunner\n xcuitest\n yamls\n zaytsev\n \n \n" }, { "path": ".run/cli-version.run.xml", "content": "\n \n \n\n" }, { "path": ".run/cli.run.xml", "content": "\n \n \n\n" }, { "path": "CHANGELOG.md", "content": "# Changelog\n\n## Unreleased\n\n## 2.4.0\n\n- Add new device config flags for cloud and start-device\n - Deprecated `--ios-version`, `--android-api-level`, and `--os-version` flags. These will be removed in a future release.\n - `--device-os` and `--device-model` replace all platform-specific device options, providing a single consistent way to specify devices across iOS, Android, and Web\n- Add `maestro list-devices` command to see locally available devices on the machine\n- Add `maestro list-cloud-devices` command to see available cloud device models and OS versions\n- Support iframes for web tests\n- Faster feedback when using Maestro Cloud - more validation is happening locally\n- Improve feedback when startRecording fails on iOS\n- Add clearState support for web tests\n- Fix inputText crashing on iOS pincode screens\n- Fix incorrect websocket timeout (5000ms, not 5000s!)\n- Add support for variables as input to setOrientation\n- Add deprecation notice to `maestro studio`\n- Improved variable isolation and reduced memory usage in JavaScript evaluations\n- Fix step ordering in the html-detailed test report\n- Improve timeouts in all API calls (especially useful for Maestro Cloud uploads)\n\n## 2.3.0\n\n- Add web support for `clearState` command\n- Fix `assertScreenshot` not failing when screenshot dimensions are mismatched\n- Make `assertScreenshot` work more like `takeScreenshot` by not requiring file extension\n- Fix path resolution for `assertScreenshot` to allow relative paths from flows for reference images\n- Fix `inputRandomPersonName` to generate a predictable \"FirstName LastName\" format\n- Fix iPad landscape orientation support\n- Fix specifying `--device` when also specifying `--host`\n- Fix cloud uploads to always use requested device specifications on retries\n\nThanks to @SosenWiosen, @leggomuhgreggo and @jkronborg who contributed changes included in this release โค๏ธ\n\n## 2.2.0\n\n- Add `--screen-size` option to test command, to specify the headless browser window size when testing web flows\n- Add `MAESTRO_DEVICE_UDID`, `MAESTRO_SHARD_ID`, and `MAESTRO_SHARD_INDEX` as default environment variables (useful for screenshot filenames when sharding)\n- Add step information to HTML test reports via a new `html-detailed` formatter\n- Add tags and custom property information to HTML and JUnit test reports\n- Add a new `assertScreenshot` command for visual regression testing\n- Add a `cropOn` property to the `takeScreenshot` command to crop screenshots to a specific element\n- Fix scrolling in Flutter Web\n- Fix output of subflows when using `--no-ansi` flag\n- Show `maestro hierarchy` and `maestro check-syntax` commands in `maestro --help`\n- Fix iOS driver app on Simulators running on Intel-based Macs\n- Fix a potential hang between Maestro and the on-device drivers when calls take too long\n- Some logging adjustments for less noise during web tests\n- Bump web support to Chrome v144\n- Bump DataFaker to v2.5.3, GraalJS engine to v24.2.0, log4j to v2.25.3\n\nThanks to @sazquatch17, @ImL1s, @sidferreira, @SosenWiosen, @TheKohan, @Fl0p, @ff-vivek and @eldare who all contributed changes included in this release โค๏ธ\n\n## 2.1.0\n\n- Add `setPermissions` command, for setting app permissions outside of `launchApp`\n- Add `setClipboard` command, for setting Maestro's internal clipboard without copying from an element\n- Add `--platform` and `--device` to `maestro test` command\n- Add custom JUnit properties to reporting\n- Add support for --no-reinstall-driver option to `test` and `hierarchy` commands\n- Add creation of missing folders specified in the path when taking screenshots or recording videos\n- Bump web support to Chrome v142\n- Bump npm dependencies in legacy Maestro Studio\n- Hide incomplete `maestro driver-setup` command from `maestro --help`\n- Remove deprecated `deterministicOrder` feature from workspace config\n- Remove deprecated `maestro upload` command\n- Fix bug that reported that analytics was enabled when it wasn't\n- Fix building Maestro on Java >17\n- Fix link in `maestro bugreport`\n- Fix cancellation of flows whilst repeat loops are running\n- Fix enumeration of multi-select elements in Web\n- Fix use of hierarchy and screenshot strategies across Android and iOS\n- Fix web tests running into Chrome's password leak detection\n- Fix webview detection and interaction on iOS 26\n- Fix broken relative paths when uploading files via multipart form in `http.post`\n\nSpecial thanks to the Maestro community for contributing to this release! Shout out to @tokou, @kprakash2, @trongrg, @vibin, @ryuuhei0729, @Thomvis, @MarcellDr and @leovarmak โค๏ธ\n\n## 2.0.10\n\n- Fix error messaging when running with shards fails\n- Improve gathering of dependencies when running single flows with `maestro cloud`\n\n## 2.0.7\n\n### Fix\n- Fixed bug affecting CI and pull request integrations where org prompts would fail in non-interactive environments.\n\n## 2.0.6\n\n### Features\n- Added support for negative index in element selector\n- Made specifying `--project_id` for cloud upload optional. **In case it is not specified and there are multiple projects, a prompt for selecting the project will be provided.**\n- In case the user belongs to multiple organizations and hasn't specified `--api-key` during cloud upload, a prompt for **selecting the organization** will be provided.\n\n### Fixes\n- Added descriptions to missing element selector aspects (enabled, disabled, selected, not selected, focused, not focused)\n\n## 2.0.5\n\n### Fixes\n- Removed debugging logs\n\n## 2.0.4\n\n### Features\n- Added support for tapping at specific coordinates relative to an element using the `relativePoint` parameter in `tapOn` and `doubleTapOn` commands [Github Issue](https://github.com/mobile-dev-inc/Maestro/issues/2059)\n- Labels in commands can now be dynamically evaluated using JavaScript expressions (thanks @jerriais!)\n\n### Fixes\n- Fixed issue where `maestro login` would fail if user was already logged in \n- Fixed iOS permission setting when using 'all' with specific permission overrides\n- Fixed issue where platform argument would be ignored\n- Fixed issue where blank platform argument would incorrectly filter out all tests\n- Fixed off-by-one error when specifying count with `eraseText` command on Android\n- Improved performance by evaluating script conditions eagerly, ahead of visibility conditions (thanks @tokou!)\n- Fixed crash when running Maestro with empty arguments\n- Updated iOS test runner to support Xcode 26\n- Improved logging on Android driver timeouts\n- Improved copy/paste experience in legacy Maestro Studio (thanks @tylerqr!)\n\n\n## 2.0.3\nFixes:\n- Fix filter logic that was causing incorrect element selection when using multiple selectors together for some applications\n- GraalJS will now isolate environment variables correctly between different runScript executions\n- Fix incorrect reporting of failures in `HtmlTestSuiteReporter`\n\n## 2.0.2\nFixes:\n- Added Rhino deprecation warning in CLI\n- Fix conditions for checking if web flows exist in workspace\n- Added back Run details to cloud upload logs (regression in Maestro 2.0.0)\n\n## 2.0.1\nFixes:\n- Fix issues with launching CLI on Windows systems\n\n## 2.0.0\nBreaking Change:\n- Updated java version to 17 better performance, security, and modern features. **If youโ€™re still on an older version, update before using 2.0.0.**\n- Weโ€™ve switched from Rhino to **GraalJS** as the default JavaScript engine. Expect **faster execution** and **modern JS support** for your scripts. [GraalJS Behaviour Differences](https://docs.maestro.dev/advanced/javascript/graaljs-support#graaljs-behavior-differences)\n- URLs in the `appId` field are no longer supported. Flows must now use the `url` field in the YAML config for URLs.\n\nFeatures:\n- Added `setOrientation` command โ€” adjust device orientation in tests (`PORTRAIT`, `UPSIDE_DOWN`, `LANDSCAPE_LEFT`, `LANDSCAPE_RIGHT`). ([Docs](https://docs.maestro.dev/api-reference/commands/setorientation))\n- Enhanced MCP Integration:\n - More accurate flow path resolution\n - View hierarchy output size reduced by **50%** (faster & lighter)\n - `run_flow` / `run_flow_files` now support env variables & hooks\n- Added `--test-output-dir` to specify where test artifacts should be saved. ([Docs](https://docs.maestro.dev/cli/test-output-directory))\n- Added support for running entire workspace of **web flows** in a single `test` command.\n- Allowed Keep-Alive from Server to support for persistent connections.\n- Environment variables are now isolated between peer `runFlow` commands.\n- Added timestamp to JUnit and HTML test report\n- DataFaker is now available in JavaScript to generate random data for use in tests ([Docs](https://docs.maestro.dev/advanced/javascript/generating-random-with-faker.md))\n\nFixes:\n- Fix CLI Cloud upload output\n- Fix broken `maestro studio` command for web version of Studio.\n- Fix **memory leak** for ios test runs that could cause out of memory issues on testing environments.\n- Fix `maestro cloud` command when uploading files that have external dependencias (subflows, scripts and media)\n- Fix disconnect in local iOS test executions when flow contains a large element tree\n\n## 1.41.0\nFix:\n- Resolved an issue where view hierarchy was incorrectly returned on full-screen apps or larger devices (e.g., iPhone Pro models, iOS 18). This affected selector matching for taps and assertions.\n- Maestro now properly handles timeouts from the XCTest framework when the app UI is slow or too large. These are surfaced as actionable exceptions with helpful messages.\n- setLocation now mocks all major location providers (GPS, network, fused). Also ensures proper cleanup when the driver shuts down.\n- Errors when .maestro config file is misinterpreted as a test flow file.\n\nFeatures:\n- Platform configs are now supported via workspace configuration [(Docs)](https://docs.maestro.dev/api-reference/configuration/workspace-configuration#platform-configuration):\n * `disableAnimations` for both android and iOS.\n * `snapshotKeyHonorModalViews`: On iOS, includes elements behind modals that are still visible on modal to user but gets missing in hierarchy.\n- Added support for selecting `select` tags dropdown elements in web flows.\n- Debug messages are now attached to Maestro exceptions to help users understand failures faster.\n- Added support for selecting elements using CSS/DOM query\n- Added Maestro MCP server implementation to cli by [[Stevie Clifton](https://github.com/steviec)]\n\nBreaking Change:\n- `retryTapIfNoChange` is now disabled by default. It was causing side effects in some apps. If needed, it can still be manually enabled.\n\n\n## 1.40.3\nFix\n- MissingKotlinParameterException during using maestro commands.\n\n## 1.40.2\nFix\n- Sharding on iOS, throwing FileSystemAlreadyExistsException exception \n\n## 1.40.1\nFix\n- iOS apps going on background while using maestro commands\n\nFeature\n- Flag to skip interactive device selection by picking a --device-index\n\n## 1.40.0\n\nFix:\n- JavaScript fails when running maestro test in continuous mode. Affected Commands: `maestro test`, `maestro record` ([#2311](https://github.com/mobile-dev-inc/Maestro/pull/2311))\n- Ignore notifications in analyse command for CI ([#2306](https://github.com/mobile-dev-inc/Maestro/pull/2306))\n- `config.yaml` not resolving on Windows ([#2327](https://github.com/mobile-dev-inc/Maestro/pull/2327))\n- Fix swipe command failure on iOS after upgrading to Xcode 16.2 [issue #2422](https://github.com/mobile-dev-inc/maestro/issues/2422) ([#2332](https://github.com/mobile-dev-inc/maestro/pull/2332))\n- Fix `app-binary-id` option on maestro cloud upload ([#2361](https://github.com/mobile-dev-inc/Maestro/pull/2361))\n- Ensure commands with missing elements fail as expected in Studio ([#2140](https://github.com/mobile-dev-inc/Maestro/pull/2140))\n- Prevent flows from getting stuck on the cloud by properly setting driver closing state ([#2364](https://github.com/mobile-dev-inc/Maestro/pull/2364))\n- Fix `maestro cloud` & `maestro start-device` on windows ([#2371](https://github.com/mobile-dev-inc/Maestro/pull/2371))\n- Improved `maestro cloud` to only process valid flow `.yaml`/`.yml` files and skip unrelated files like `config.yaml`, preventing parsing errors when uploading folders with mixed content ([#2359](https://github.com/mobile-dev-inc/Maestro/pull/2359))\n- Improved `maestro cloud` to skip validating non-flow files (e.g., .js, README, config.yaml) in folders, preventing parsing errors and upload failures\n- Fix setting up iOS Driver when not on bash environment ([#2412](https://github.com/mobile-dev-inc/Maestro/pull/2412))\n- Speed up view hierarchy generation by reducing SpringBoard queries and avoiding redundant app list calls on iOS. ([#2419](https://github.com/mobile-dev-inc/Maestro/pull/2419))\n\nFeatures:\n- Added support for `androidWebViewHierarchy: devtools` option to build Android WebView hierarchy using Chrome DevTools ([#2350](https://github.com/mobile-dev-inc/Maestro/pull/2350))\n- Added Chrome to available devices for web automation ([#2360](https://github.com/mobile-dev-inc/Maestro/pull/2360))\n- Introduced pre-built mode for setting up iOS driver on simulators without relying on `xcodebuild` ([#2325](https://github.com/mobile-dev-inc/Maestro/pull/2325))\n- Added command-line chat mode to Maestro CLI accessible by `maestro chat --ask=` and `maestro chat` ([#2378](https://github.com/mobile-dev-inc/Maestro/pull/2378))\n- Introduced `maestro check-syntax` command for validating flow syntax ([#2387](https://github.com/mobile-dev-inc/Maestro/pull/2387))\n- Added `--reinstall-driver` flag that reinstalls xctestrunner driver before running the test. Set to false if the driver shouldn't be reinstalled ([#2413](https://github.com/mobile-dev-inc/Maestro/pull/2413))\n- Added `--compact` flag that remove empty values to make the output hierarchy json smaller ([#2413](https://github.com/mobile-dev-inc/Maestro/pull/2413))\n- Added `--device-os` and `--device-model` options to target specific iOS minor versions and devices ([Docs](https://docs.maestro.dev/cloud/reference/configuring-os-version#using-a-specific-ios-minor-version-and-device-recommended)) ([#2413](https://github.com/mobile-dev-inc/Maestro/pull/2413))\n- Added support for ios 18 on cloud and local\n- Bumped default iOS version to 16 for `maestro start-device`\n- Enabled AI command usage on `mobile.dev` ([#2425](https://github.com/mobile-dev-inc/Maestro/pull/2425))\n\nChore: \n- Update Flying Fox HTTP server on iOS driver ([#2415](https://github.com/mobile-dev-inc/Maestro/pull/2415))\n- Migrated app termination from `simctl` to `xctest` for improved stability` ([#2418](https://github.com/mobile-dev-inc/Maestro/pull/2418))\n\n## 1.39.13\n\n- Fix : Adding upload route back again\n- Feature: Removing Analyze logs from CI uploads\n\n## 1.39.12\n\n- Fix: Upload route on Robin was not working on maestro cloud command\n\n## 1.39.11\n\n- Feature: Starting trial from CLI\n- Feature: Better logs to improve visibility\n- Feature: Prebuilt iOS driver without xcodebuild\n- Feature: Analyze option to test command\n\n## 1.39.10\n\n- Update install script to tidy up old installation binaries\n\n## 1.39.9\n\n- Revert: Error in showing keyboard during input and erase commands on iOS\n- Fix: applesimutils affecting granting location permission\n- Fix: Setting host and port from the optional arguments\n- Feature: New `maestro login` command for logging in Robin.\n- Feature: Improved `maestro record` video to scroll and follow the currently executing commands\n- Fix: Enable running Maestro on Windows without WSL\n- Feature: Add console.log messages directly to the maestro log file.\n\n## 1.39.8\n\n- Fix: Debug message not showing up when we execute commands on maestro cli anymore\n\n## 1.39.7\n\n- Feature: Improved web support. \n - Fix: Maestro can test web pages again (it was broken)\n - Fix: WebDriver was reporting invalid screen size \n - Web: support cases where a new tab is opened from the page \n - Web: screen recording support (via JCodec for now, but we could add ffmpeg later)\n - Web: fake geolocation support \n - Studio: better layout for wide aspect-ratio screens (i.e. web pages or tablets)\n- Feature: Introduces extractTextWithAI command\n\n- Fix: Retry should throw exception when max retries reaches\n- Fix: Studio getting unresponsive due to exceptions in streaming device\n\n## 1.39.5\n\nReleased on 2024-12-16\n\n\nFixes:\n- Fix: Failure on how the assertConditionCommand was being handled on Robin([#2171](https://github.com/mobile-dev-inc/maestro/pull/2171))\n\n## 1.39.4\n\nFeatures:\n- Add `waitToSettleTimeoutMs` to other swipe related commands ([#2153](https://github.com/mobile-dev-inc/maestro/pull/2153))\n- Add retry command for flaky conditions ([#2168](https://github.com/mobile-dev-inc/maestro/pull/2168))\n- Add support for recording maestro flows locally instead of using remote servers ([#2173](https://github.com/mobile-dev-inc/maestro/pull/2173))\n\nFixes:\n- Fix: multiple xcodebuild process and leading to IOSDriverTimeoutException ([#2097](https://github.com/mobile-dev-inc/maestro/pull/2097))\n- Fix: NullPointerException during view hierarchy operations for android ([#2172](https://github.com/mobile-dev-inc/maestro/pull/2172))\n- Fix: Debug level logs in maestro.log file leading to large debug files ([#2170](https://github.com/mobile-dev-inc/maestro/pull/2170))\n- Fix: Environment variable not being set for test suite ([#2163](https://github.com/mobile-dev-inc/maestro/pull/2163))\n- Fix: Failures on clearKeychain operations on iOS due to missing directories ([#2178](https://github.com/mobile-dev-inc/maestro/pull/2178))\n\n## 1.39.2\n\nReleased on 2024-11-19\n\nFixes:\n- Fix: Insights object causing ConcurrentModificationException ([#2131](https://github.com/mobile-dev-inc/maestro/pull/2131))\n- Fix: Timeout unit in scrollUntilVisible command ([#2112](https://github.com/mobile-dev-inc/maestro/pull/2112))\n- Feat: Add new status for robin flows: PREPARING and INSTALLING. ([#2145](https://github.com/mobile-dev-inc/maestro/pull/2145))\n\n## 1.39.1\n\nReleased on 2024-11-04\n\nFixes:\n- Fix: clearState now automatically reinstall the App ([#2118](https://github.com/mobile-dev-inc/maestro/pull/2118))\n\n## 1.39.0\n\nReleased on 2024-10-15\n\nFeatures:\n- Feature: add `--shard-split` and `--shard-all` options to `maestro test` ([#1955](https://github.com/mobile-dev-inc/maestro/pull/1955) by [Tarek Belkahia](https://github.com/tokou))\n\n The `--shard` is now deprecated and superseded by `--shard-split`.\n\n- Feature: allow for passing multiple flow files to `maestro test` ([#1995](https://github.com/mobile-dev-inc/maestro/pull/1995) by [Tarek Belkahia](https://github.com/tokou))\n- Feature: add the `optional` argument to all commands ([#1946](https://github.com/mobile-dev-inc/maestro/pull/1946) by [Tarek Belkahia](https://github.com/tokou))\n\n This new command-level `optional` argument supersedes the (now removed) selector-level `optional` argument. No behavior changes are expected.\n\n When command with `optional: true` fails, its status is now \"warned โš ๏ธ\" instead of \"skipped โšช๏ธ\"\n\n- Feature: add changelog to the update prompt when new Maestro version is available ([#1950](https://github.com/mobile-dev-inc/maestro/pull/1950) by [Tarek Belkahia](https://github.com/tokou))\n- Feature: add back the `--platform` option ([#1954](https://github.com/mobile-dev-inc/maestro/pull/1954) by [Tarek Belkahia](https://github.com/tokou))\n- Feature: expose current flow name as `MAESTRO_FILENAME` env var ([#1945](https://github.com/mobile-dev-inc/maestro/pull/1945) by [Tarek Belkahia](https://github.com/tokou))\n\nFixes:\n- Fix: Warnings generated by AI-powered commands aren't formatted nicely ([#2043](https://github.com/mobile-dev-inc/maestro/pull/2043)) ([#2044](https://github.com/mobile-dev-inc/maestro/pull/2044))\n- Fix: not working when iOS simulator is in landscape orientation ([caveats apply](https://github.com/mobile-dev-inc/maestro/pull/1974#issuecomment-2346074593)) ([#1974](https://github.com/mobile-dev-inc/maestro/pull/1974))\n- Fix: confusing error message \"BlockingCoroutine is cancelling\" ([#2036](https://github.com/mobile-dev-inc/maestro/pull/2036))\n- Fix: AI-powered commands crashing when Anthropic is used ([#2033](https://github.com/mobile-dev-inc/maestro/pull/2033))\n- Fix: display warnings generated by AI-powered commands in CLI output when `optional: true` ([#2026](https://github.com/mobile-dev-inc/maestro/pull/2026)) \n- Fix: visual bug with emojis having slightly different length in `maestro test`'s interactive CLI output ([#2016](https://github.com/mobile-dev-inc/maestro/pull/2016)) \n- Fix: no tests being run when flowsOrder specified all tests in the workspace ([#2003](https://github.com/mobile-dev-inc/maestro/pull/2003))\n- Fix: using integers from JavaScript outputs causing a deserialization error ([#1788](https://github.com/mobile-dev-inc/maestro/pull/1788) by [Muhammed Furkan Boran](https://github.com/boranfrkn)) \n- Fix: delete temporary APKs after using them ([#1947](https://github.com/mobile-dev-inc/maestro/pull/1947) by [Tarek Belkahia](https://github.com/tokou))\n- Fix: allow env vars in `setLocation` and `travel` commands ([#1988](https://github.com/mobile-dev-inc/maestro/pull/1988) by [Prasanta Biswas](https://github.com/prasanta-biswas))\n- Fix: error message when specifying `--format` together with `--continuous` #1948 ([#1948](https://github.com/mobile-dev-inc/maestro/pull/1948) by [Tarek Belkahia](https://github.com/tokou))\n\nChores:\n- Chore: clean up logging, make log format configurable with 2 new env vars ([#2041](https://github.com/mobile-dev-inc/maestro/pull/2041))\n- Chore: make Maestro build & compile on Java 17 ([#2008](https://github.com/mobile-dev-inc/maestro/pull/2008))\n- Chore: Migrate all Gradle buildscripts to Gradle Kotlin DSL ([#1994](https://github.com/mobile-dev-inc/maestro/pull/1994))\n\n## 1.38.1\n\nReleased on 2024-08-30\n\n- New experimental AI-powered commands for screenshot testing: [assertWithAI](https://maestro.mobile.dev/api-reference/commands/assertwithai) and [assertNoDefectsWithAI](https://maestro.mobile.dev/api-reference/commands/assertnodefectswithai) ([#1906](https://github.com/mobile-dev-inc/maestro/pull/1906))\n- Enable basic support for Maestro uploads while keeping Maestro Cloud functioning ([#1970](https://github.com/mobile-dev-inc/maestro/pull/1970))\n\n## 1.37.9\n\nReleased on 2024-08-15\n\n- Revert iOS landscape mode fix ([#1916](https://github.com/mobile-dev-inc/maestro/pull/1916))\n\n## 1.37.8\n\nReleased on 2024-08-14\n\n- Fix sharding on Android failing on all but one devices (quick hotfix) ([#1867](https://github.com/mobile-dev-inc/maestro/pull/1867))\n- Fix CLI crash when flow is canceled on Maestro Cloud ([#1912](https://github.com/mobile-dev-inc/maestro/pull/1912))\n- Fix iOS landscape mode ([caveats apply](https://github.com/mobile-dev-inc/maestro/pull/1809#issuecomment-2249917209)) ([#1809](https://github.com/mobile-dev-inc/maestro/pull/1809))\n- Skip search engine selection when running on the web ([#1869](https://github.com/mobile-dev-inc/maestro/pull/1869))\n\n## 1.37.7\n\nReleased on 2024-08-03\n\n- Fix cryptic \"Socket Exception\" when `CI` env var is set, once and for all ([#1882](https://github.com/mobile-dev-inc/maestro/pull/1882))\n\n## 1.37.6\n\nReleased on 2024-08-02\n\n- Print stack trace on 3rd retry ([#1877](https://github.com/mobile-dev-inc/maestro/pull/1877))\n\n## 1.37.5\n\nReleased on 2024-08-02\n\n- Fix cryptic \"SocketException\" when API token is invalid ([#1871](https://github.com/mobile-dev-inc/maestro/pull/1871))\n\n## 1.37.4\n\nReleased on 2024-07-30\n\n- Don't ask for analytics permission on CI + add `MAESTRO_CLI_NO_ANALYTICS` env var ([#1848](https://github.com/mobile-dev-inc/maestro/pull/1848))\n\n## 1.37.3\n\nReleased on 2024-07-29\n\n### Bug fixes\n\n- Fix `FileNotFoundException: ~.maestro/sessions` ([#1843](https://github.com/mobile-dev-inc/maestro/pull/1843)) \n\n## 1.37.2 - 2024-07-29\n\n### Bug fixes\n\n- Fix `UnsupportedOperationException: Empty collection can't be reduced` ([#1840](https://github.com/mobile-dev-inc/maestro/pull/1840))\n\n## 1.37.1 - 2024-07-29\n\n### Bug fixes\n\n- Fix crash when `flutter` or `xcodebuild` is not installed ([#1839](https://github.com/mobile-dev-inc/maestro/pull/1839))\n\n## 1.37.0 - 2024-07-29\n\n### New features\n\n- **Sharding tests for parallel execution on many devices ๐ŸŽ‰**ย ([#1732](https://github.com/mobile-dev-inc/maestro/pull/1732) by [Kaan](https://github.com/sdfgsdfgd))\n\n You can now pass `--shards` argument to `maestro test` to split up your test suite into chunks that run in parallel. If you have feedback or suggestions about this huge new feature, please share them with us in [issue #1818](https://github.com/mobile-dev-inc/maestro/issues/1818).\n\n- **Reports in HTML** ([#1750](https://github.com/mobile-dev-inc/maestro/pull/1750) by [Depa Panjie Purnama](https://github.com/depapp))\n\n To see it, run `maestro test --format HTML `\n\n- **Homebrew is back!**\n\n If you prefer to switch your installation of Maestro to use Homebrew:\n 1. `rm -rf ~/.maestro`\n 2. `brew tap mobile-dev-inc/tap && brew install maestro` ๐ŸŽ‰\n\n Script install method is still supported.\n\n- **Current platform exposed in JavaScript** ([#1747](https://github.com/mobile-dev-inc/maestro/pull/1747) by [Dan Caseley](https://github.com/Fishbowler))\n\n In JavaScript, you can now access `maestro.platform` to express logic that depends on whether the test runs on iOS or Android.\n- **Control airplaneย mode** ([#1672](https://github.com/mobile-dev-inc/maestro/pull/1672) by [NyCodeGHG](https://github.com/NyCodeGHG))\n\n New commands: `setAirplaneMode` and `toggleAirplaneMode`. Android-only because of iOS simulator restrictions.\n- **New `killApp` command** ([#1727](https://github.com/mobile-dev-inc/maestro/pull/1727) by [Alexandre Favre](https://github.com/alexandrefavre4))\n\n To trigger a System-Initiated Process Death on Android. On iOS, works the same as `stopApp`.\n\n### Bug fixes\n\n- Fix cleaning up retries in iOS driver ([#1669](https://github.com/mobile-dev-inc/maestro/pull/1669))\n- Fix some commands not respecting custom labels ([#1762](https://github.com/mobile-dev-inc/maestro/pull/1762) by [Dan Caseley](https://github.com/Fishbowler))\n- Fix โ€œProtocol family unavailableโ€ when rerunning iOS tests ([#1671](https://github.com/mobile-dev-inc/maestro/pull/1671) by [Stanisล‚aw Chmiela](https://github.com/sjchmiela))\n\n## 1.36.0 - 2024-02-15\n\n- Feature: Add support for extra keys to Android TV\n- Feature: Add support for pressing tab key on Android\n- Feature: Add status and time to report.xml\n- Fix: Extend retry to handle 404 in upload status call\n- Fix: Crashes caused by toasts on Android API < 30\n\n## 1.35.0 - 2024-01-08\n\n- Change: Adds view class to Android hierarchy output\n- Change: Improves description of maestro start-device command to include device locale as well\n- Change: Adds scrollable attribute to Android view hierarchy output\n- Feature: Adds childOf attribute to selector to select from children of a container\n- Feature: Adds label attribute to customize the CLI output of maestro commands\n- Fix: Fixing โ€œUnsupported architecture UNKNOWNโ€ on linux environment when calling maestro attempts to create devices\n- Fix: Allow maestro to work below API level 25 for Android\n- Fix: IllegalArgumentException on swipe operation for iOS if the coordinates beyond device width and height are selected\n\n## 1.34.5 - 2024-01-04\n\n- Feature: Adds a parameter to exclude all the keyboard elements from hierarchy\n\n## 1.34.4 - 2023-12-27\n\n- Fix: Failures due to swipe ranges going beyond screen dimensions\n- Change: Adding escape key in `pressKey` API\n- Tweak: Avoid returning `Result` in IOSDriver install and clearAppState\n\n## 1.34.3 - 2023-11-21\n\n- Tweak: Include scrollable attribute in view hierarchy from Android Driver\n- Feature: Custom labels for readability of maestro commands\n- Feature: Adding childOf selector\n- Tweak: Message of start-device command to show locale as well\n\n## 1.34.2 - 2023-11-13\n\n- Tweak: Include view class in view hierarchy attributes from the Android driver\n\n## 1.34.1 - 2023-11-9\n\n- Feature: add support `--device-locale` parameter for `maestro cloud` command\n- Feature: add support iOS17 for `maestro start-device` command\n- Feature: add support Android API level 34 for `maestro start-device` command\n\n## 1.34.0 - 2023-10-24\n\n- Feature: support `--device-locale` parameter for `maestro start-device`\n- Feature: add `centerElement` parameter for `scrollUntilVisible`. Center element will attempt to stop scrolling when the element is near the center of the screen.\n- Feature: add `power` button support for `pressKey` on Android\n- Change: add `tapOn` parameter `waitToSettleTimeoutMs` to control how long it waits to move on to the next command. Helpful for animation heavy apps.\n- Change: improve executionOrder planning\n- Change: improve retry mechanism to ensure openness of XCUITest Server\n- Fix: improve `TimeoutException` for driver startup\n\n## 1.33.1 - 2023-10-03\n\n- Feature: support for multipart form data file upload in Javascript, thanks @maciejkrolik\n- Fix: setPermissions produces error on Xcode 15\n- Fix: Maestro studio - include enter key in command editor on initial paste\n\n## 1.33.0 - 2023-09-21\n\n- Feature: Adds MAESTRO_DRIVER_STARTUP_TIMEOUT to iOS driver to configure timeout to start iOS driver, used in CI/CD environment with performance limitations. Thanks, Jesse Farsong for contributing.\n- Feature: Introducing the \"addMedia\" command that enables adding images and videos directly to the devices.\n- Change: Improved Studio's user interface:\n - Updated fonts to align with company branding.\n - Introduced a distinct loading animation for better clarity when AI is processing commands.\n- Fix: Crash resulting in Error: No matches found for first query match sequence: `Children matching type Other` due to resolving root element for a snapshot operation on iOS\n- Fix: Android driver getting stuck when the device was disconnected\n- Fix: XCTestUnreachable exceptions due to missing IPv6 config on /etc/hosts\n- Fix: Handling app crash errors from XCUITest drivers gracefully\n- Fix: Timeouts can be separated with `_`. For example 10_000 for 10000\n\n## 1.32.0 - 2023-09-06\n\nStudio\n\n- Feature: Support writing Flows using AI (more info to come ๐Ÿš€)\n- Feature: Maestro Studio can now run in multiple tabs simultaneously\n- Feature: Added element id and copy option for it\n- Tweak: Hide action buttons till command is hovered\n- Tweak: Hide Unnecessary Scrollbars\n- Tweak: Repl view scroll improvements\n- Tweak: Improve Maestro Studio performance\n- Fix: Selected element size\n- Fix: Performance issues with maestro studio device refresh\n- Fix: Fixed dark mode for element id\n\nCLI\n\n- Feature: New command to start or create a Maestro recommended device (docs)\n- Feature: Support id selection for testID with react-native-web (community contribution)\n- Feature: Control if browser automatically opens when running Maestro Studio via --no-window (community contribution)\n- Tweak: Show cancellation reason when available (Maestro Cloud)\n- Tweak: Update selenium-java and remove webdrivermanager to support Chrome 116+\n- Tweak: Show device type when running on Maestro Cloud\n- Tweak: Added better messaging and recovery options for Maestro Cloud uploads (useful for CI)\n- Tweak: Added better error messages for missing workspace and yaml validation errors\n- Tweak: Added file name and line number in yaml parsing error messages\n- Fix: Input text and erase text stability improvements for iOS\n- Fix: Leaking response body on iOS & better error handling for iOS Driver\n- Fix: Fixed Maestro Cloud wrong exit code when flow failed\n- Fix: Debug commands parsing would crash maestro\n- Fix: Cleaning up debug logs\n\n## 1.31.0 - 2023-08-10\n\n- Fix: Warning shown from OkHttp for leaking response bodies on CLI\n - Closing response bodies for retries done on the XCUITest driver\n - Closing response bodies for permissions\n - Removing different thread execution done on hideKeyboard\n- Fix: Scroll for React native apps on screens with large view hierarchies on iOS\n- Fix: Showing more descriptive errors on flow file not found during maestro cloud command.\n- Fix: Input text characters being skipped or being appended later in the test on iOS\n- Fix: Crash in debug output generation when maestro flow contains \"/\"โ€™\n- Fix: Resolved issue where tapping on the device in maestro studio produced inaccurate click locations due to incorrect coordinates. Now fixed for accurate device interaction\n- Fix: In Maestro Studio, the issue of window resizing causing devices to overflow off the screen has been resolved.\n- Feature: Add headers to HTTP response for API calls done with Maestro. Thanks, Jesse Willoughby! for this contribution.\n- Feature: Now it is possible to configure the path with the โ€“debug-output option for debugging information that maestro dumps in the user directory by default.\n- Feature: Enhanced Maestro Studio with keyboard accessibility, streamlining navigation and facilitating the copy, run, and edit commands using the keyboard.\n- Change: Fail the test if any of the onFlowStart or onFlowComplete hooks fail\n- Change: Removed IDB on iOS. This may impact the performance of maestro commands like tapOn and assertVisible on iOS screens with large view hierarchies.\n - Studio and CLI will now provide insights and warnings in case the hierarchy of these screens becomes extensive.\n- Change: In Maestro Studio, we've integrated screenshots of selected elements alongside their corresponding commands.\n- Change: In Maestro Studio, double-clicking will now execute the command.\n\n## 1.30.4 - 2023-07-19\n\n- Fix: correctly resolve external parameters for onStart/Complete hooks\n- Fix: reuse JSEngine for all executeCommands (hooks, main commands, subflows) actions\n\n## 1.30.3 - 2023-07-17\n\n- Update: Maestro Studio revamp improvements\n - wrapped element names in sidebar\n - sidebar text always visible\n - add \"hintText\" and \"accessibilityText\" in sidebar\n - improve sidebar search\n - fixed highlight issues in search\n - various other small improvements\n\n## 1.30.2 - 2023-07-14\n\n- Revert connection improvements (from 1.30.1)\n\n## 1.30.1 - 2023-07-14\n\n- Fix: Allow running `maestro studio` and `maestro test` simultaneously\n- Fix: Connection improvements\n\n## 1.30.0 - 2023-07-13\n\n- Feature: onFlowStart / onFlowComplete hooks\n- Feature: Maestro Studio revamp\n - improved design\n - search components panel\n - improved drag-and-drop\n- Feature: Introduce `--app-binary-id` parameter for Maestro Cloud upload action to be able to re-use a previously uploaded app for different flows\n- Feature: Implement Experimental GraalJsEngine (ECMAScript 2022 compliant)\n- Fix: Save xctest xcodebuild logs output to system temp dir\n- Fix: Close existing screen recording if it was left open.\n - Thanks, @carlosmuvi, for the contribution!\n- Fix: Execute sequential Flows even if no other Flows are present\n- Fix: Various XCTestClient connection improvements\n- Deprecate: `assertOutgoingRequestsCommand`\n- Deprecate: Network Mocking feature\n- Deprecate: Maestro Mock Server feature\n\n## 1.29.0 - 2023-06-19\n\n- Feature: Add test duration measurement and display\n- Feature: New screen recording commands\n - Thanks, @tokou, for the contribution!\n- Feature: Add support for sequential execution\n- Feature: Add support for double taps + multiple taps in tapOn\n- Feature: Add support for custom Android driver startup timeout\n - Thanks, @arildojr7, for the contribution!\n- Fix: Validate workspace prior to upload to Maestro Cloud\n- Fix: Resolve Android scrollUntilVisible flakiness\n- Fix: Resolve inputText flakiness\n- Fix: iOS url arguments\n - Thanks, @tokou, for the contribution!\n\n## 1.28.0 - 2023-05-18\n\n- Feature: runScript command now support conditional execution\n- Feature: Improved debug output:\n - Shows failure reason when command fails\n - Generates screenshot when command fails\n - Unified most logs under ~/.maestro/tests//maestro.log\n- Change: Launch arguments support for long values\n- Tweak: JUnit report naming changes. Local and Cloud should now have the same naming convention.\n- Tweak: Added deprecation notice for experimental features\n- Fix: maestro record command was not working on iOS\n- Fix: WebDriver, only scroll to elements outside of the window before tapping\n- Fix: close request leaking body\n- Fix: maestro cloud now will fail on timeout if configured as such\n\n## 1.27.0 - 2023-05-02\n\n- Feature: Adds assertOutgoingRequests to assert the network requests from the app\n- Feature: Add platform condition in runFlow command to do platform-specific orchestration. Thanks, Larry Ng for your contribution!\n- Feature: Adds a new selector containsDescendants. Thanks, Larry Ng for your contribution!\n- Feature: iOS and Android launch arguments\n- Change: Include the update command instead of update instructions in the update message. Thanks @bobpozun for your contribution!\n- Fix: Fixes swipe flakiness caused due to waiting for animations to complete on XCTest\n- Fix: Correctly resolving `maestro.copiedText`\n- Fix: Using deviceId instead of booted, potentially resolving XCTestUnreachable exceptions.\n- Fix: Improving waitForAppToSettle for Android by accounting window updates. Resolves maestro command interaction in Android 13.\n- Fix: Notification permissions not getting granted\n- Fix: Use correct documentation URLs in Studio\n\n## 1.26.1 - 2023-04-13\n\n- Fix: hideKeyboard crashing on react native apps because swipe fails on some screens\n\n## 1.26.0 - 2023-04-13\n\n- Feature: Adds Travel command to mock motion for app\n- Feature: Adds a capability to match the toast messages\n- Feature: Add support for console.log in javascript\n- Feature: Allow writing inline flows with runFlow command\n- Change: Adds sms permission to permission names which can be used to allow/deny: android.permission.READ_SMS, android.permission.RECIEVE_SMS, android.permission.SEND_SMS. Thanks, @depapp for the contribution.\n- Change: Maestro can now also match hint text and values of text field.\n- Change: Maestro can now also match elements with their accessibility text.\n- Commands moved away from IDB:\n - Long press is now done with XCTest instead of idb\n - Installation of app is now done with simctl commands\n - Hide keyboard with help of XCTest. We now scroll up and down from the middle of the screen to close the keyboard.\n - Press key now is done with XCTest.\n - Note that with this change pressKey: Enter now only wraps on new line - earlier it also closed the keyboard\n - Erase text is now done with XCTest.\n - Use simctl to record screen\n- Fix: Web driver no longer crashes when using latest Chrome\n- Fix: Fixes hideKeyboard on android by appropriately dispatching proper event. Thanks, @nhaarman for contribution\n- Fix: Properly shutting down studio by listening to SIGTSP signal\n- Fix: Update granting of notifications and health permissions causing simulator restarts and XCTestUnreachableExceptions.\n\n## 1.25.0 - 2023-03-13\n\n- Fix: Shell environment variables can no longer crash the javascript runtime\n- Fix: XCTestRunner and IDB are restarted on connection error\n- Feature: Add support for setLocation\n\n## 1.24.0 - 2023-03-07\n\n- Change: LaunchApp command sets all app permissions to allow ([documentation](https://maestro.mobile.dev/reference/app-lifecycle))\n- Feature: LaunchApp supports specifying app permission state\n- Feature: On Android it is now possible to force links to be opened in the browser\n- Fix: Autocorrect is no longer applied to inputText on iOS\n- Fix: iOS apps with big view hierarchies (common with ReactNative and Flutter) caused an error in XCTest.framework\n- Fix: Studio UI fixes for Firefox and Safari\n- Fix: Element selection behavior in Maestro Studio\n\n## 1.23.0 - 2023-02-15\n\n- Feature: Maestro Studio - Action Modal\n- Feature: Maestro Studio - Dark Mode\n- Feature: assertion on `enabled`, `selected`, `checked`, `focused` properties ([documentation](https://maestro.mobile.dev/reference/assertions#assertvisible))\n- Feature: running tests in a deterministic order ([documentation](https://maestro.mobile.dev/cli/test-suites-and-reports#deterministic-ordering))\n- Feature: default global tags can now be set in `config.yaml` ([documentation](https://maestro.mobile.dev/cli/tags#global-tags))\n- Feature: allow to configure what flows should be included into a run at `config.yaml` level ([documentation](https://maestro.mobile.dev/cli/test-suites-and-reports#controlling-what-tests-to-include))\n- Tweak: considerable speed-up of iOS tests due to removal of unnecessary hierarchy polling\n- Tweak: wait for app to settle before proceeding with iOS test\n- Tweak: UX improvements in \"delete command\" confirmation dialog\n- Tweak: using `xcrun` for uninstall command on iOS\n- Tweak: using `xcrun` for clearKeychain command on iOS\n- Tweak: using `.maestro` directory by default for mockserver deploy command\n- Fix: errors were clipped in Maestro Studio\n- Fix: use element title as id in Web driver\n- Fix: Repeat-while-true did not work properly with JavaScript conditions\n- Fix: Repeat-times did not work properly with JavaScript input\n- Fix: added artificial delay after key presses (i.e. \"back\" key) on Android\n\n## 1.22.1 - 2023-02-09\n\n- Early Access Feature: Maestro Mock Server and Maestro SDK (Android preview)\n- Tweak: added visibility threshold and scroll speed to `scrollUntilVisible` command\n- Tweak: speed up `tapOn` command on iOS\n- Fix: removing view hierarchy elements that are out of screen bounds\n- Fix: `inputText` command skipping characters on iOS\n- Fix: Reworked `clearAppState` behaviour on iOS, solving issue that caused crashes after clearing the state\n- Fix: crash when running multiple Maestro sessions in parallel while using iOS device\n- Fix: a rare crash in React Native apps when trying to input a long string on iOS\n- Fix: properly handling linebreaks in Maestro Studio\n\n## 1.21.3 - 2023-01-30\n\n- Fix: `scrollUntilVisible` was not always working on iOS\n- Tweak: speed up tests by skipping an unnecessary hierarchy poll\n- Tweak: iOS screenshot no longer depends on IDB and is faster\n\n## 1.21.2 - 2023-01-26\n\n- Hotfix: Move iOS tap() implementation back to IDB to resolve problems with React Native apps\n- Fix: running multiple Maestro instances would sometimes result in Connection exception\n- Fix: support JS injection in `scrollUntilVisible` command\n\n## 1.21.1 - 2023-01-25\n\n- Fix: Increase typing speed for iOS text input\n\n## 1.21.0 - 2023-01-25\n\n- Feature: Next evolution of Maestro Studio\n- Fix: More robust implementation of inputText on iOS\n- Fix: More robust implementation of tap on iOS\n- Experimental: Added web driver\n\n## 1.20.0 - 2023-01-24\n\n- Feature: Maestro Studio - use percentage-based swiping\n- Feature: Scroll until view element is visible\n- Feature: Relatively swipe with percentage based start and end coordinates\n- Fix: Android tap was not always working\n- Fix: Bottom of Android hierarchy was cut off\n- Fix: idb_companion fails to start due to gRPC timeout exception\n- Tweak: Improve Android Screenshot Internal Logic\n- Tweak: Change the end coordinates for swipe element\n- Tweak: Update sample flows\n\n## 1.19.5 - 2023-01-19\n\n- Fix: inputText was not working on iOS React Native apps\n- Fix: Maestro fails to launch on iOS if --device parameter is present\n- Fix: Evaluate JS scripts with element selector in swipe command\n- Tweak: added tags to sample flows\n- Tweak: indicating whether build is running on CI in analytics\n\n## 1.19.2 - 2023-01-17\n\n- Hotfix: Maestro Studio was not working\n\n## 1.19.1 - 2023-01-17\n\n- Feature: generating test report from `maestro cloud` output\n- Fix: in rare cases, maestro cloud was computing progress bar as negative value\n- Fix: local test suite included non-flow files\n- Fix: some special characters were not allowed in env variables (i.e. `&`)\n- Fix: vertical scrolling was sometimes not working on iOS\n- Fix: if a text string is an invalid regex, treat it as a regular string instead\n- Fix: scroll and swipe commands on iOS were throwing an error when running in parallel with Maestro Studio\n- Tweak: print out valid inputs for `--format` parameter in `maestro test` and `maestro upload`\n- Tweak: removed Maestro Studio warning related to parallel execution\n- Refactor: making XCTestDriver configurable\n\n## 1.19.0 - 2023-01-13\n\n- Feature: iOS unicode input support + non-English keyboards\n- Feature: `swipe` command now supports `from` argument to swipe from a given view\n- Feature: `repeat` command now supports `while` condition\n- Feature: Allowing `extendedWaitUntil` command to use env values in `timeout` property\n- Tweak: assert commands now respect `optional` flag\n- Tweak: error analytics\n- Fix: scroll not working reliably on iOS\n- Fix: `openLink` was opening Google Maps on Android\n- Fix: sub-flows are now included regardless of their tags\n- Fix: Maestro Studio was not always computing `index` field correctly\n- Fix: `maestro upload` was ignoring JS files\n- Fix: `openLink` command now supports query parameters\n\n## 1.18.5 - 2023-01-10\n\n- Feature: tags\n- Tweak: allow running other maestro commands alongside Maestro Studio\n- Tweak: improved matching for strings with linebreaks\n- Fix: creating maestro logs directory was not always working properly\n- Fix: maestro studio was not working properly on Kubuntu\n\n## 1.18.3 - 2022-12-27\n\n- XCUITest driver improvements and fixes:\n - Close the response when validating server up\n - Add logs to uninstall of runner\n - Remove redundant import and library from maestro-ios\n - Kills the process before we uninstall it\n - Redirect runner logs in xctest_runner_logs directory\n\n## 1.18.2 - 2022-12-27\n\n- Fix: Wait for XCUITest server to start before proceeding\n\n## 1.18.1 - 2022-12-27\n\n- Fix: Create XCUITest driver HTTP server on loopback address\n- Fix: Create parity with idb for `text` attribute with following priority:\n - Title\n - Label\n - Value\n\n## 1.18.0 - 2022-12-26\n\n- Feature: Adds new XcUITest driver to capture view hierarchy on iOS.\n - Fixes stability issues on iOS 16\n - Fixes not identified bottom navigation tabs\n - Gets view hierarchy natively from XCUITest\n- Fix: Missing letter j and y in inputRandomText command\n- Tweak: Un-deprecate the hierarchy command, inform about Studio\n- Tweak: Match negative bounds as well in maestro studio\n- Feature: Adds replay functionality in maestro studio\n- Feature: Adding device interaction to interact page in Maestro Studio\n\n## 1.17.4 - 2022-12-15\n\n- Fix: Maestro commands were failing if Android SDK wasn't installed\n\n## 1.17.3 - 2022-12-15\n\n- Feature: no-ansi version for terminals that do not ANSI\n- Feature: Android Maven artifact for setting up network mocking\n- Fix: Android emulator was not discovered properly if it wasn't on PATH\n- Fix: missing favicon\n\n## 1.17.2 - 2022-12-13\n\n- Tweak: Deprecate hierarchy and query CLI commands\n\n## 1.17.1 - 2022-12-12\n\n- Tweak: Remove Maestro Studio icon from Mac dock\n- Tweak: Prefer port 9999 for Maestro Studio app\n- Fix: Fix Maestro Studio conditional code snippet\n\n## 1.17.0 - 2022-12-12\n\n- Feature: Maestro Studio\n- Feature: Print a message when an update is available\n- Feature: Support percentages for tapOn\n- Fix: Maestro commands execute faster now\n- Fix: Fix environment variable substitution in certain cases\n- Fix: Use actual android device screen size (including nav bar)\n\n## 1.16.4 - 2022-12-02\n\n- Fix: Add error message for when an Android screen recording fails\n\n## 1.16.3 - 2022-12-02\n\n- Fix: Fix iOS `clearState` not working in certain cases\n- Fix: Fix `maestro record` not capturing full launch screen recording\n\n## 1.16.2 - 2022-12-02\n\n- Fix: older version of Maestro Driver on Android was not always updated\n\n## 1.16.1 - 2022-11-30\n\n- Feature: `maestro record` command\n- Fix: `z` character was not inputted correctly on Android\n\n## 1.16.0 - 2022-11-29\n\n- Feature: Javascript injection support\n - `runScript` and `evalScript` commands to run scripts\n - `assertTrue` command to assert based on Javascript\n - `runFlow` can be launched based on Javascript condition\n - `copyTextFrom` now also stores result in `maestro.copiedText` variable\n - Env parameters are now treated as Javascript variables\n- Feature: HTTP(s) requests\n - `http.request()` Javascript API that allows to make HTTP requests as part of Maestro flows\n- Feature: Maestro Cloud `--android-api-level` parameter to select API version to be used\n- Feature: `waitForAnimationToEnd` command to wait until animations/videos are finished\n- Tweak: test reports can now be generated for single test runs (and not just folders)\n- Tweak: `inputText` on Android was reworked to increase speed and input stability\n- Tweak: `eraseText` is now much faster\n- Tweak: `maestro cloud` will automatically retry upload up to 3 times\n- Fix: running on Samsung devices was sometimes failing because of wrong user being used\n\n## 1.15.0 - 2022-11-17\n\n- Feature: run all tests in a folder as a suite\n- Feature: XML test report in JUnit-compatible format\n- Feature: `copyTextFrom` command for copying text from a view\n- Feature: `maestro bugreport` command for capturing Maestro logs\n- **Breaking change**: Removed `clipboardPaste` command in favour of new `pasteText` command\n- Fix: Java 8 compatibility issue for M1 users\n- Fix: `_` character was mapped incorrectly on iOS\n- Fix: first `tapOn` command was failing unless it was preceded by `launchApp` or `openLink`\n- Tweak: Maestro no longer kills running `idb_companion` processes\n- Tweak: updated gRPC version to 1.52.0\n\n## 1.14.0 - 2022-11-14\n\n- Fix: passing env parameters to subflows and other env params\n- Speeding up maestro flows\n- Checking in maestro sample flows and adds sample updating guide\n- Maestro is now compatible with java 8!\n- Launching app without stopping the app\n- Fixing launching app when resolving launcher activity throws `NullPointerException`\n\n## 1.13.2 - 2022-11-10\n\n- Fix: Fallback properly on monkey when start-activity command fails, when launching app.\n\n## 1.13.1 - 2022-11-09\n\n- Fix: Fix maestro hanging with message \"Waiting for idb service to start..\"\n- Fix: Fix clearState operation not working on iOS\n\n## 1.13.0 - 2022-11-08\n\n- Feature: Option to set direction and speed for swipe command\n- Fix: Fix duplicate and unavailable iOS simulators in list\n- Fix: Longer timeout for iOS simulator boot\n\n## 1.12.0 - 2022-11-06\n\n- Feature: `maestro cloud` command added\n\n## 1.11.4 - 2022-11-02\n\n- Fix: Use absolute path to prevent NullPointerException when .app folder is in the cwd\n- Fix: Create parent directory if not exists when generating adb key pair, updates dadb to 1.2.6\n- Fix: Opening of leak canary app\n- Tweak: send agent: ci when known CI environment variables are set\n\n## 1.11.3 - 2022-10-29\n\n- Fix: updating to dadb 1.2.4\n\n## 1.11.2 - 2022-10-29\n\n- Fix: updating to dadb 1.2.3 to fix an occasional device connection issue\n- Fix: injecting `env` parameters into conditions (i.e. in `runFlow`)\n\n## 1.11.1 - 2022-10-27\n\n- Fix: closing `idb_companion` after `maestro` completes\n\n## 1.11.0 - 2022-10-26\n\n- Feature: `maestro` will offer user to select a device if one is not running already\n- Feature: `env` variables can be inlined in flow file or in `runFlow` command\n- **Breaking change**: `--platform` option is deprecated. CLI now prompts user to pick a device.\n- Tweak: auto-starting `idb_companion`. No need to start it manually anymore.\n- Tweak: tripled Android Driver launch timeout\n- Tweak: customisable error resolution in Orchestra\n- Fix: `maestro upload` was not ignoring `-e` parameters\n\n## 1.10.1 - 2022-10-12\n\n- Fix: login command fails with java.lang.IllegalStateException: closed\n\n## 1.10.0 - 2022-10-12\n\n- Feature: `repeat` command that allows to create loops\n- Feature: conditional `runFlow` execution that allows to create if-conditions\n- Feature: `inputRandomText`, `inputRandomNumber`, `inputRandomEmail` and `inputRandomPersonName` commands (thanks @ttpho !)\n- Feature: `clipboardPaste` command (thanks @depapp !)\n- Feature: Added `enabled` property to element selector\n- Feature: Added `download-samples` command to allow quickstart without having to build your own app\n- Feature: Added `login` and `logout` commands for interacting with mobile.dev\n- **Breaking change:** `upload` now takes 1 less argument. `uploadName` parameter was replaced with `--name` optional argument\n- Tweak: `upload` command automatically zips iOS apps\n- Tweak: sending `agent: cli` value alongside `upload` and `login` commands\n- Fix: properly compare fields that contain regex special symbols\n- Fix: input text on Android was sometimes missing characters\n\n## 1.9.0 - 2022-09-30\n\n- Feature: USB support for Android devices\n\n## 1.8.3 - 2022-09-28\n\n- Fix: occasional crash when an iOS layout has a view group with a 0 width\n- Fix: properly mapping top-level syntax errors\n\n## 1.8.2 - 2022-09-27\n\n- Tweak: prioritise clickable elements over non-clickable ones\n- Fix: close TCP forwarder if it is already in use\n- Fix: hideKeyboard on Android did not always work\n\n## 1.8.1 - 2022-09-27\n\n- Fix: Timeout exception while opening port for tcp forwarding\n\n## 1.8.0 - 2022-09-22\n\n- Feature: `runFlow` command\n- Tweak: support of Tab Bar on iOS\n- Tweak: added `--mapping` option to `upload` CLI command\n- Fix: open the main launcher screen on Android instead of Leak Canary\n- Fix: input character-by-character on Android to counter adb issue where not the whole text gets transferred to the device\n\n## 1.7.2 - 2022-09-20\n\n- Fix: `tapOn` command was failing due to a failure during screenshot capture\n\n## 1.7.1 - 2022-09-19\n\n- Feature: `clearState` command\n- Feature: `clearKeychain` command\n- Feature: `stopApp` command\n- Tweak: Maestro now compares screenshots to decide whether screen has been updated\n- Tweak: `launchApp` command now supports env parameters\n\n## 1.7.0 - 2022-09-16\n\n- Feature: `maestro upload` command for uploading your builds to mobile.dev\n- Feature: `takeScreenshot` command\n- Feature: `extendedWaitUntil` command\n- Fix: waiting for Android gRPC server to properly start before interacting with it\n- Fix: brought back multi-window support on Android\n- Fix: `hideKeyboard` command did not always work\n- Fix: make project buildable on Java 14\n- Refactoring: make `MaestroCommand` serializable without custom adapters\n- Refactoring: migrated to JUnit 5\n\n## 1.6.0 - 2022-09-13\n\n- Feature: hideKeyboard command\n- Feature: add Android TV Remote navigation\n- Tweak: allowing to skip package name when searching by `id`\n- Fix: Android WebView contents were sometimes not reported as part of the view hierarchy\n- Fix: iOS inputText race condition\n- Fix: populate iOS accessibility value\n- Refactoring: simplified `MaestroCommand` serialization\n\n## 1.5.0 - 2022-09-08\n\n- Temporary fix: showing an error when unicode characters are passed to `inputText`\n- Feature: `eraseText` command\n\n## 1.4.2 - 2022-09-06\n\n- Fix: Android devices were not discoverable in some cases\n\n## 1.4.1 - 2022-09-05\n\n- Fix: relative position selectors (i.e. `below`) were sometimes picking a wrong view\n- Fix: await channel termination when closing a gRPC ManagedChannel\n- Fix: Android `inputText` did not work properly when a string had whitespaces in it\n- Fix: race condition in iOS `inputText`\n\n## 1.4.0 - 2022-08-29\n\n- Added `traits` selector.\n- Relative selectors (such as `above`, `below`, etc.) are now picking the closest element.\n- Fix: continuous mode did not work for paths without a parent directory\n- Fix: workaround for UiAutomator content descriptor crash\n- Fix: `tapOn: {int}` did not work\n\n## 1.3.6 - 2022-08-25\n\n- Added `longPressOn` command\n- Decreased wait time in apps that have a screen overlay\n- Fixed CLI issue where status updates would not propagate correctly\n\n## 1.3.3 - 2022-08-23\n\n- Fix: iOS accessibility was not propagated to Maestro\n\n## 1.3.2 - 2022-08-22\n\n- Fix: env parameters did not work with init flows when using `Maestro` programmatically\n\n## 1.3.1 - 2022-08-19\n\n- Added support for externally supplied parameters\n- Added `openLink` command\n\n## 1.2.6 - 2022-08-18\n\n- Fail launching an iOS app if the app is already running\n\n## 1.2.4 - 2022-08-17\n\n- Add support for cli to specify what platform, host and port to connect to\n\n## 1.2.3 - 2022-08-15\n\n- Added support of iOS state restoration\n- Exposing `appId` field as part of `MaestroConfig`\n\n## 1.2.2 - 2022-08-08\n\n- Update `Orchestra` to support state restoration\n\n## 1.2.1 - 2022-08-04\n\n- Update `YamlCommandReader` to accept Paths instead of Files to support zip Filesystems\n\n## 1.2.0 - 2022-08-04\n\n- Config is now defined via a document separator\n- launchApp no longer requires and appId\n- initFlow config implemented\n\n## 1.1.0 - 2022-07-28\n\n- `launchApp` command now can optionally clear app state\n- `config` command to allow Orchestra consumers a higher degree of customization\n- Fixed a bug where `ElementNotFound` hierarchy field was not declared as public\n\n## 1.0.0 - 2022-07-20\n\n- Initial Maestro release (formerly known as Conductor)\n" }, { "path": "CONTRIBUTING.md", "content": "# Contributing to Maestro\n\nThank you for considering contributing to the project!\n\nWe welcome contributions from everyone and generally try to be as accommodating as possible. However, to make sure that your time is well spent, we separate the types of \ncontributions in the following types:\n\n- Type A: Simple fixes (bugs, typos) and cleanups\n - You can open a pull request directly, chances are high (though never guaranteed) that it will be merged.\n- Type B: Features and major changes (i.e. refactoring)\n - Unless you feel adventurous and wouldn't mind discarding your work in the worst-case scenario, we advise to open an issue or a PR with a suggestion first where you will \n describe the problem you are trying to solve and the solution you have in mind. This will allow us to discuss the problem and the solution you have in mind.\n\n### Side-note on refactoring\n\nOur opinion on refactorings is generally that of - don't fix it if it isn't broken. Though we acknowledge that there are multiple areas where code could've been structured in a \ncleaner way, we believe there are no massive tech debt issues in the codebase. As each change has a probability of introducing a problem (despite all the test coverage), be \nmindful of that when working on a refactoring and have a strong justification prepared. \n\n## Lead times\n\nWe strive towards having all public PRs reviewed within a week, typically even faster than that. If you believe that your PR requires more urgency, please contact us on a \npublic Maestro Slack channel.\n\nOnce your PR is merged, it usually takes about a week until it becomes publicly available and included into the next release.\n\n## Developing\n\n### Requirements\n\nMaestro's minimal deployment target is Java 17, and for development, you need to use Java 17 or newer.\n\nIf you made changes to the CLI, rebuilt it with `./gradlew :maestro-cli:installDist`. This will generate a startup shell\nscript in `./maestro-cli/build/install/maestro/bin/maestro`. Use it instead of globally installed `maestro`.\n\nIf you made changes to the iOS XCTest runner app, make sure they are compatible with the version of Xcode used by the GitHub Actions build step. It is currently built using the default version of Xcode listed in the macos runner image [readme][macos_builder_readme].\nIf you introduce changes that work locally but fail to build when you make a PR, check if you used a feature used in a newer version of Swift or some other new Xcode setting.\n\n### Debugging\n\nMaestro stores logs for every test run in the following locations:\n\n- CLI Logs: `~/.maestro/tests/*/maestro.log`\n- iOS test runner logs: `~/Library/Logs/maestro/xctest_runner_logs`\n\n### Android artifacts\n\nMaestro requires 2 artifacts to run on Android:\n\n- `maestro-app.apk` - the host app. Does nothing.\n- `maestro-server.apk` - the test runner app. Starts an HTTP server inside an infinite JUnit/UIAutomator test.\n\nThese artifacts are built by `./gradlew :maestro-android:assemble` and `./gradlew :maestro-android:assembleAndroidTest`, respectively.\nThey are placed in `maestro-android/build/outputs/apk`, and are copied over to `maestro-client/src/main/resources`.\n\n### iOS artifacts\n\nMaestro requires 3 artifacts to run on iOS:\n\n- `maestro-driver-ios` - the host app for the test runner. Does nothing and is not installed.\n- `maestro-driver-iosUITests-Runner.app` - the test runner app. Starts an HTTP server inside an infinite XCTest. \n- `maestro-driver-ios-config.xctestrun` - the configuration file required to run the test runner app.\n\nThese artifacts are built by the `build-maestro-ios-runner.sh` script. It places them in `maestro-ios-driver/src/main/resources`.\n\n### Running standalone iOS XCTest runner app\n\nThe iOS XCTest runner can be run without Maestro CLI. To do so, make sure you built the artifacts, and then run:\n\n```console\n./maestro-ios-xctest-runner/run-maestro-ios-runner.sh\n```\n\nThis will use `xcodebuild test-without-building` to run the test runner on the connected iOS device. Now, you can reach\nthe HTTP server that runs inside the XCTest runner app (by default on port 22087):\n\n```console\ncurl -fsSL -X GET localhost:22087/deviceInfo | jq\n```\n\n
\nSee example output\n\n```json\n{\n \"heightPoints\": 852,\n \"heightPixels\": 2556,\n \"widthPixels\": 1179,\n \"widthPoints\": 393\n}\n```\n\n
\n\n```console\ncurl -fsSL -X POST localhost:22087/touch -d '\n{\n \"x\": 150,\n \"y\": 150,\n \"duration\": 0.2\n}'\n```\n\n```console\ncurl -sSL -X GET localhost:22087/swipe -d '\n{\n \"startX\": 150,\n \"startY\": 426,\n \"endX\": 426,\n \"endY\": 350,\n \"duration\": 1\n}'\n```\n\n\n### Artifacts and the CLI\n\n`maestro-cli` depends on both `maestro-ios-driver` and `maestro-client`. This is how the CLI gets these artifacts.\n\n## Linting\n\n```bash\n./gradlew detekt # Run detekt code quality checks\n./gradlew detektMain # Run detekt with type resolution\n./gradlew detektBaseline # Generate baseline\n```\n\n## Testing\n\nThere are 3 ways to test your changes:\n\n- Integration tests\n - Run them via `./gradlew :maestro-test:test` (or from IDE)\n - Tests are using real implementation of most components except for `Driver`. We use `FakeDriver` which pretends to be a real device.\n- Manual testing\n - Run `./maestro` instead of `maestro` to use your local code.\n- Unit tests\n - All the other tests in the projects. Run them via `./gradlew test` (or from IDE)\n\nIf you made changes to the iOS XCUITest driver, rebuild it by running `./maestro-ios-xctest-runner/build-maestro-ios-runner.sh`.\n\n## Module structure\n\n| Module | Purpose |\n|--------|---------|\n| `maestro-cli` | CLI entry point and user-facing commands |\n| `maestro-client` | `Maestro` class, `Driver` interface, core API |\n| `maestro-orchestra` | Flow execution, YAML parsing, scripting |\n| `maestro-orchestra-models` | Command data classes (serializable) |\n| `maestro-android` | Android driver implementation |\n| `maestro-ios` | iOS driver implementation |\n| `maestro-ios-xctest-runner` | Swift/Xcode XCTest runner app |\n| `maestro-web` | Web/CDP driver implementation |\n| `maestro-studio` | Studio IDE server |\n| `maestro-ai` | AI-powered test capabilities |\n| `maestro-test` | `FakeDriver` and testing utilities |\n| `maestro-utils` | Shared utilities |\n| `maestro-proto` | Protocol buffer definitions |\n| `e2e` | End-to-end test suites |\n\n### Processing flow\n\n```\nYAML Flow File โ†’ YamlCommandReader โ†’ List โ†’ Orchestra.executeFlow() โ†’ Maestro API โ†’ Driver โ†’ Device\n```\n\n## Architectural considerations\n\nKeep the following things in mind when working on a PR:\n\n- `Maestro` class is serving as a target-agnostic API between you and the device.\n - `Maestro` itself should not know or care about the concept of commands.\n- `Orchestra` class is a layer that translates Maestro commands (represented by `MaestroCommand`) to actual calls to `Maestro` API.\n- `Maestro` and `Orchestra` classes should remain completely target (Android/iOS/Web) agnostic.\n - Use `Driver` interface to provide target-specific functionality.\n - Maestro commands should be as platform-agnostic as possible, though we do allow for exceptions where they are justified.\n- Maestro CLI is supposed to be cross-platform (Mac OS, Linux, Windows).\n- Maestro is designed to run locally as well as on Maestro Cloud. That means that code should assume that it is running in a sandbox environment and shouldn't call out or spawn \n arbitrary processes based on user's input\n - For that reason we are not allowing execution of bash scripts from Maestro commands.\n - For that reason, `MaestroCommand` class should be JSON-serializable (and is a reason we haven't moved to `sealed class`)\n- Prefer fakes over mocks (e.g. `FakeDriver`). Mocks (MockK) are used in some modules but fakes are the preferred approach for driver-level testing.\n\nThis graph (generated with [`./gradlew :generateDependencyGraph`][graph_plugin] in [PR #1834][pr_1834]) may be helpful\nto visualize relations between subprojects:\n\n![Project dependency graph](assets/project-dependency-graph.svg)\n\n## How to\n\n### Add new command\n\nFollow these steps:\n\n- Define a new command in `Commands.kt` file, implementing `Command` interface.\n- Add a new field to `MaestroCommand` class, following the example set by other commands.\n- Add a new field to `YamlFluentCommand` to map between yaml representation and `MaestroCommand` representation.\n- Handle command in `Orchestra` class.\n - If this is a new functionality, you might need to add new methods to `Maestro` and `Driver` APIs.\n- Add a new test to `IntegrationTest`.\n\n[macos_builder_readme]: https://github.com/actions/runner-images/blob/main/images/macos/macos-14-Readme.md\n[graph_plugin]: https://github.com/vanniktech/gradle-dependency-graph-generator-plugin\n[pr_1834]: https://github.com/mobile-dev-inc/maestro/pull/1834\n" }, { "path": "LICENSE", "content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n" }, { "path": "README.md", "content": "> [!TIP]\n> Great things happen when testers connect โ€” [Join the Maestro Community](https://maestrodev.typeform.com/to/FelIEe8A)\n\n\n

\n \n \"Maestro\n \n

\n\n\n

\n Maestro is an open-source framework that makes UI and end-to-end testing for Android, iOS, and web apps simple and fast.
\n Write your first test in under five minutes using YAML flows and run them on any emulator, simulator, or browser.\n

\n\n\n\n---\n\n## Table of Contents\n\n- [Why Maestro?](#why-maestro)\n- [Getting Started](#getting-started)\n- [Resources & Community](#resources--community)\n- [Contributing](#contributing)\n- [Maestro Studio โ€“ Test IDE](#maestro-studio--test-ide)\n- [Maestro Cloud โ€“ Parallel Execution & Scalability](#maestro-cloud--parallel-execution--scalability)\n\n\n---\n\n## Why Maestro?\n\nMaestro is built on learnings from its predecessors (Appium, Espresso, UIAutomator, XCTest, Selenium, Playwright) and allows you to easily define and test your Flows.\n\nBy combining a human-readable YAML syntax with an interpreted execution engine, it lets you write, run, and scale cross-platform end-to-end tests for mobile and web with ease.\n\n- **Cross-platform coverage** โ€“ test Android, iOS, and web apps (React Native, Flutter, hybrid) on emulators, simulators, or real devices. \n- **Human-readable YAML flows** โ€“ express interactions as commands like `launchApp`, `tapOn`, and `assertVisible`. \n- **Resilience & smart waiting** โ€“ built-in flakiness tolerance and automatic waiting handle dynamic UIs without manual `sleep()` calls. \n- **Fast iteration & simple install** โ€“ flows are interpreted (no compilation) and installation is a single script.\n\n**Simple Example:**\n```\n# flow_contacts_android.yaml\n\nappId: com.android.contacts\n---\n- launchApp\n- tapOn: \"Create new contact\"\n- tapOn: \"First Name\"\n- inputText: \"John\"\n- tapOn: \"Last Name\"\n- inputText: \"Snow\"\n- tapOn: \"Save\"\n```\n\n---\n## Getting Started\n\nMaestro requires Java 17 or higher to be installed on your system. You can verify your Java version by running:\n\n```\njava -version\n```\n\nInstalling the CLI:\n\nRun the following command to install Maestro on macOS, Linux or Windows (WSL):\n\n```\ncurl -fsSL \"https://get.maestro.mobile.dev\" | bash\n```\n\nThe links below will guide you through the next steps.\n\n- [Installing Maestro](https://docs.maestro.dev/getting-started/installing-maestro) (includes regular Windows installation)\n- [Build and install your app](https://docs.maestro.dev/getting-started/build-and-install-your-app)\n- [Run a sample flow](https://docs.maestro.dev/getting-started/run-a-sample-flow)\n- [Writing your first flow](https://docs.maestro.dev/getting-started/writing-your-first-flow)\n\n\n---\n\n## Resources & Community\n\n- ๐Ÿ’ฌ [Join the Slack Community](https://maestrodev.typeform.com/to/FelIEe8A)\n- ๐Ÿ“˜ [Documentation](https://docs.maestro.dev) \n- ๐Ÿ“ฐ [Blog](https://maestro.dev/blog?utm_source=github-readme) \n- ๐Ÿฆ [Follow us on X](https://twitter.com/maestro__dev)\n\n---\n\n## Contributing\n\nMaestro is open-source under the Apache 2.0 license โ€” contributions are welcome!\n\n- Check [good first issues](https://github.com/mobile-dev-inc/maestro/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)\n- Read the [Contribution Guide](https://github.com/mobile-dev-inc/Maestro/blob/main/CONTRIBUTING.md) \n- Fork, create a branch, and open a Pull Request.\n\nIf you find Maestro useful, โญ star the repository to support the project.\n\n---\n\n## Maestro Studio โ€“ Test IDE\n\n**Maestro Studio Desktop** is a lightweight IDE that lets you design and execute tests visually โ€” no terminal needed. \nIt is also free, even though Studio is not an open-source project. So you won't find the Maestro Studio code here.\n\n- **Simple setup** โ€“ just download the native app for macOS, Windows, or Linux. \n- **Visual flow builder & inspector** โ€“ record interactions, inspect elements, and build flows visually. \n- **AI assistance** โ€“ use MaestroGPT to generate commands and answer questions while authoring tests.\n\n[Download Maestro Studio](https://maestro.dev/?utm_source=github-readme#maestro-studio)\n\n---\n\n## Maestro Cloud โ€“ Parallel Execution & Scalability\n\nWhen your test suite grows, run hundreds of tests in parallel on dedicated infrastructure, cutting execution times by up to 90%. Includes built-in notifications, deterministic environments, and complete debugging tools.\n\nPricing for Maestro Cloud is completely transparent and can be found on the [pricing page](https://maestro.dev/pricing?utm_source=github-readme).\n\n๐Ÿ‘‰ [Start your free 7-day trial](https://maestro.dev/cloud?utm_source=github-readme)\n\n\n\n```\n Built with โค๏ธ by Maestro.dev\n```\n\n\n" }, { "path": "RELEASING.md", "content": "# Production Releases\n\n## Prepare\n\n1. Define the next semantic version\n\n Semantic versioning: a.b.c\n\n - a: major breaking changes\n - b: new functionality, new features\n - c: any other small changes\n\n2. Checkout the main branch and make sure it is up-to-date: `git checkout main && git pull`\n3. Create a new branch\n4. Update the CHANGELOG.md file with changes of this release, you should add a new section with your version number and the relevant updates, like the ones that exist on the previous versions\n5. Change the version in `gradle.properties`\n6. Change the version in `maestro-cli/gradle.properties`\n7. `git commit -am \"Prepare for release X.Y.Z.\"` (where X.Y.Z is the new version)\n8. Submit a PR with the changes against the main branch\n9. Merge the PR\n\n## Tag\n\n1. `git tag -a vX.Y.Z -m \"Version X.Y.Z\"` (where X.Y.Z is the new version)\n2. `git push --tags`\n3. Wait until all Publish actions have completed https://github.com/mobile-dev-inc/maestro/actions\n\n## Publish Maven Central\n\n1. Trigger the [Publish Release action](https://github.com/mobile-dev-inc/maestro/actions/workflows/publish-release.yml)\n - ATTENTION: Wait for it to finish\n3. Go to [OSS Sonatype](https://s01.oss.sonatype.org/) and login with user/password\n4. Go to Staging Repositories, select the repository uploaded from the trigger above.\n5. Click \"Close\" and then \"Release\". Each of these operations take a couple minutes to complete\n\n____________________________________________________________________________________________________________________________________________________\n**CAUTION:** You should go back to the [notion document](https://www.notion.so/Maestro-Release-Run-Book-78159c6f80de4492a6e9e05bb490cf60?pvs=4) to see how to update the **Robin** and **Maestro Cloud** versions before updating the **CLI**\n____________________________________________________________________________________________________________________________________________________\n\n## Publish CLI\n\n1. Trigger the [Publish CLI Github action](https://github.com/mobile-dev-inc/Maestro/actions/workflows/publish-cli.yaml)\n2. Test installing the cli by running `curl -Ls \"https://get.maestro.mobile.dev\" | bash`\n3. Check the version number `maestro --version`\n\n" }, { "path": "build.gradle.kts", "content": "import org.jetbrains.kotlin.gradle.tasks.KotlinCompilationTask\n\n@Suppress(\"DSL_SCOPE_VIOLATION\")\nplugins {\n alias(libs.plugins.kotlin.jvm)\n alias(libs.plugins.kotlin.android) apply false\n alias(libs.plugins.android.application) apply false\n alias(libs.plugins.protobuf) apply false\n alias(libs.plugins.mavenPublish)\n alias(libs.plugins.detekt)\n}\n\njava {\n sourceCompatibility = JavaVersion.VERSION_17\n targetCompatibility = JavaVersion.VERSION_17\n}\n\ntasks.named(\"compileKotlin\", KotlinCompilationTask::class.java) {\n compilerOptions {\n freeCompilerArgs.addAll(\"-Xjdk-release=17\")\n }\n}\n\nkotlin {\n jvmToolchain {\n languageVersion.set(JavaLanguageVersion.of(17))\n }\n}\n\ndetekt {\n buildUponDefaultConfig = true\n allRules = false\n autoCorrect = true\n config = files(\"${rootDir}/detekt.yml\")\n}\n" }, { "path": "detekt.yml", "content": "build:\n maxIssues: 0\n excludeCorrectable: false\n weights:\n # complexity: 2\n # LongParameterList: 1\n # style: 1\n # comments: 1\n\nconfig:\n validation: true\n warningsAsErrors: false\n # when writing own rules with new properties, exclude the property path e.g.: 'my_rule_set,.*>.*>[my_property]'\n excludes: ''\n\nprocessors:\n active: true\n exclude:\n - 'DetektProgressListener'\n # - 'KtFileCountProcessor'\n # - 'PackageCountProcessor'\n # - 'ClassCountProcessor'\n # - 'FunctionCountProcessor'\n # - 'PropertyCountProcessor'\n # - 'ProjectComplexityProcessor'\n # - 'ProjectCognitiveComplexityProcessor'\n # - 'ProjectLLOCProcessor'\n # - 'ProjectCLOCProcessor'\n # - 'ProjectLOCProcessor'\n # - 'ProjectSLOCProcessor'\n # - 'LicenseHeaderLoaderExtension'\n\nconsole-reports:\n active: true\n exclude:\n - 'ProjectStatisticsReport'\n - 'ComplexityReport'\n - 'NotificationReport'\n # - 'FindingsReport'\n - 'FileBasedFindingsReport'\n - 'LiteFindingsReport'\n\noutput-reports:\n active: true\n exclude:\n # - 'TxtOutputReport'\n # - 'XmlOutputReport'\n # - 'HtmlOutputReport'\n\ncomments:\n active: true\n AbsentOrWrongFileLicense:\n active: false\n licenseTemplateFile: 'license.template'\n licenseTemplateIsRegex: false\n CommentOverPrivateFunction:\n active: false\n CommentOverPrivateProperty:\n active: false\n DeprecatedBlockTag:\n active: false\n EndOfSentenceFormat:\n active: false\n endOfSentenceFormat: '([.?!][ \\t\\n\\r\\f<])|([.?!:]$)'\n OutdatedDocumentation:\n active: false\n matchTypeParameters: true\n matchDeclarationsOrder: true\n UndocumentedPublicClass:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n searchInNestedClass: true\n searchInInnerClass: true\n searchInInnerObject: true\n searchInInnerInterface: true\n UndocumentedPublicFunction:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n UndocumentedPublicProperty:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n\ncomplexity:\n active: true\n ComplexCondition:\n active: true\n threshold: 4\n ComplexInterface:\n active: false\n threshold: 10\n includeStaticDeclarations: false\n includePrivateDeclarations: false\n ComplexMethod:\n active: true\n threshold: 15\n ignoreSingleWhenExpression: false\n ignoreSimpleWhenEntries: false\n ignoreNestingFunctions: false\n nestingFunctions:\n - 'also'\n - 'apply'\n - 'forEach'\n - 'isNotNull'\n - 'ifNull'\n - 'let'\n - 'run'\n - 'use'\n - 'with'\n LabeledExpression:\n active: false\n ignoredLabels: [ ]\n LargeClass:\n active: true\n threshold: 600\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n LongMethod:\n active: true\n threshold: 120\n LongParameterList:\n active: false\n functionThreshold: 6\n constructorThreshold: 7\n ignoreDefaultParameters: false\n ignoreDataClasses: true\n ignoreAnnotatedParameter: [ ]\n MethodOverloading:\n active: false\n threshold: 6\n NamedArguments:\n active: false\n threshold: 3\n NestedBlockDepth:\n active: true\n threshold: 4\n ReplaceSafeCallChainWithRun:\n active: false\n StringLiteralDuplication:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n threshold: 3\n ignoreAnnotation: true\n excludeStringsWithLessThan5Characters: true\n ignoreStringsRegex: '$^'\n TooManyFunctions:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n thresholdInFiles: 11\n thresholdInClasses: 11\n thresholdInInterfaces: 11\n thresholdInObjects: 11\n thresholdInEnums: 11\n ignoreDeprecated: false\n ignorePrivate: false\n ignoreOverridden: false\n\ncoroutines:\n active: true\n GlobalCoroutineUsage:\n active: false\n InjectDispatcher:\n active: false\n dispatcherNames:\n - 'IO'\n - 'Default'\n - 'Unconfined'\n RedundantSuspendModifier:\n active: false\n SleepInsteadOfDelay:\n active: false\n SuspendFunWithFlowReturnType:\n active: false\n\nempty-blocks:\n active: true\n EmptyCatchBlock:\n active: true\n allowedExceptionNameRegex: '_|(ignore|expected).*'\n EmptyClassBlock:\n active: true\n EmptyDefaultConstructor:\n active: true\n EmptyDoWhileBlock:\n active: true\n EmptyElseBlock:\n active: true\n EmptyFinallyBlock:\n active: true\n EmptyForBlock:\n active: true\n EmptyFunctionBlock:\n active: true\n ignoreOverridden: true\n EmptyIfBlock:\n active: true\n EmptyInitBlock:\n active: true\n EmptyKtFile:\n active: true\n EmptySecondaryConstructor:\n active: true\n EmptyTryBlock:\n active: true\n EmptyWhenBlock:\n active: true\n EmptyWhileBlock:\n active: true\n\nexceptions:\n active: true\n ExceptionRaisedInUnexpectedLocation:\n active: true\n methodNames:\n - 'equals'\n - 'finalize'\n - 'hashCode'\n - 'toString'\n InstanceOfCheckForException:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n NotImplementedDeclaration:\n active: false\n ObjectExtendsThrowable:\n active: false\n PrintStackTrace:\n active: true\n RethrowCaughtException:\n active: true\n ReturnFromFinally:\n active: true\n ignoreLabeled: false\n SwallowedException:\n active: true\n ignoredExceptionTypes:\n - 'InterruptedException'\n - 'MalformedURLException'\n - 'NumberFormatException'\n - 'ParseException'\n allowedExceptionNameRegex: '_|(ignore|expected).*'\n ThrowingExceptionFromFinally:\n active: true\n ThrowingExceptionInMain:\n active: false\n ThrowingExceptionsWithoutMessageOrCause:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n exceptions:\n - 'ArrayIndexOutOfBoundsException'\n - 'Exception'\n - 'IllegalArgumentException'\n - 'IllegalMonitorStateException'\n - 'IllegalStateException'\n - 'IndexOutOfBoundsException'\n - 'NullPointerException'\n - 'RuntimeException'\n - 'Throwable'\n ThrowingNewInstanceOfSameException:\n active: true\n TooGenericExceptionCaught:\n active: true\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n exceptionNames:\n - 'ArrayIndexOutOfBoundsException'\n - 'Error'\n - 'Exception'\n - 'IllegalMonitorStateException'\n - 'IndexOutOfBoundsException'\n - 'NullPointerException'\n - 'RuntimeException'\n - 'Throwable'\n allowedExceptionNameRegex: '_|(ignore|expected).*'\n TooGenericExceptionThrown:\n active: true\n exceptionNames:\n - 'Error'\n - 'Exception'\n - 'RuntimeException'\n - 'Throwable'\n\nformatting:\n active: true\n android: false\n autoCorrect: true\n AnnotationOnSeparateLine:\n active: false\n autoCorrect: true\n AnnotationSpacing:\n active: false\n autoCorrect: true\n ArgumentListWrapping:\n active: false\n autoCorrect: true\n indentSize: 4\n maxLineLength: 160\n ChainWrapping:\n active: true\n autoCorrect: true\n CommentSpacing:\n active: true\n autoCorrect: true\n EnumEntryNameCase:\n active: false\n autoCorrect: true\n Filename:\n active: true\n FinalNewline:\n active: true\n autoCorrect: true\n insertFinalNewLine: true\n ImportOrdering:\n active: true\n autoCorrect: true\n layout: '*,java.**,javax.**,kotlin.**,^'\n Indentation:\n active: true\n autoCorrect: true\n indentSize: 4\n continuationIndentSize: 4\n MaximumLineLength:\n active: true\n maxLineLength: 160\n ignoreBackTickedIdentifier: false\n ModifierOrdering:\n active: true\n autoCorrect: true\n MultiLineIfElse:\n active: false\n autoCorrect: true\n NoBlankLineBeforeRbrace:\n active: true\n autoCorrect: true\n NoConsecutiveBlankLines:\n active: true\n autoCorrect: true\n NoEmptyClassBody:\n active: true\n autoCorrect: true\n NoEmptyFirstLineInMethodBlock:\n active: false\n autoCorrect: true\n NoLineBreakAfterElse:\n active: true\n autoCorrect: true\n NoLineBreakBeforeAssignment:\n active: true\n autoCorrect: true\n NoMultipleSpaces:\n active: true\n autoCorrect: true\n NoSemicolons:\n active: true\n autoCorrect: true\n NoTrailingSpaces:\n active: true\n autoCorrect: true\n NoUnitReturn:\n active: true\n autoCorrect: true\n NoUnusedImports:\n active: true\n autoCorrect: true\n NoWildcardImports:\n active: true\n PackageName:\n active: false\n autoCorrect: true\n ParameterListWrapping:\n active: true\n autoCorrect: true\n indentSize: 4\n maxLineLength: 160\n SpacingAroundAngleBrackets:\n active: false\n autoCorrect: true\n SpacingAroundColon:\n active: true\n autoCorrect: true\n SpacingAroundComma:\n active: true\n autoCorrect: true\n SpacingAroundCurly:\n active: true\n autoCorrect: true\n SpacingAroundDot:\n active: true\n autoCorrect: true\n SpacingAroundDoubleColon:\n active: false\n autoCorrect: true\n SpacingAroundKeyword:\n active: true\n autoCorrect: true\n SpacingAroundOperators:\n active: true\n autoCorrect: true\n SpacingAroundParens:\n active: true\n autoCorrect: true\n SpacingAroundRangeOperator:\n active: true\n autoCorrect: true\n SpacingAroundUnaryOperator:\n active: false\n autoCorrect: true\n SpacingBetweenDeclarationsWithAnnotations:\n active: false\n autoCorrect: true\n SpacingBetweenDeclarationsWithComments:\n active: false\n autoCorrect: true\n StringTemplate:\n active: true\n autoCorrect: true\n\nnaming:\n active: true\n BooleanPropertyNaming:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n allowedPattern: '^(is|has|are)'\n ClassNaming:\n active: true\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n classPattern: '[A-Z][a-zA-Z0-9]*'\n ConstructorParameterNaming:\n active: true\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n parameterPattern: '[a-z][A-Za-z0-9]*'\n privateParameterPattern: '[a-z][A-Za-z0-9]*'\n excludeClassPattern: '$^'\n ignoreOverridden: true\n EnumNaming:\n active: true\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n enumEntryPattern: '[A-Z][_a-zA-Z0-9]*'\n ForbiddenClassName:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n forbiddenName: [ ]\n FunctionMaxLength:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n maximumFunctionNameLength: 30\n FunctionMinLength:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n minimumFunctionNameLength: 3\n FunctionNaming:\n active: true\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n functionPattern: '([a-z][a-zA-Z0-9]*)|(`.*`)'\n excludeClassPattern: '$^'\n ignoreOverridden: true\n FunctionParameterNaming:\n active: true\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n parameterPattern: '[a-z][A-Za-z0-9]*'\n excludeClassPattern: '$^'\n ignoreOverridden: true\n InvalidPackageDeclaration:\n active: false\n rootPackage: ''\n LambdaParameterNaming:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n parameterPattern: '[a-z][A-Za-z0-9]*|_'\n MatchingDeclarationName:\n active: true\n mustBeFirst: true\n MemberNameEqualsClassName:\n active: true\n ignoreOverridden: true\n NoNameShadowing:\n active: false\n NonBooleanPropertyPrefixedWithIs:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n ObjectPropertyNaming:\n active: true\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n constantPattern: '[A-Za-z][_A-Za-z0-9]*'\n propertyPattern: '[A-Za-z][_A-Za-z0-9]*'\n privatePropertyPattern: '(_)?[A-Za-z][_A-Za-z0-9]*'\n PackageNaming:\n active: true\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n packagePattern: '[a-z]+(\\.[a-z][A-Za-z0-9]*)*'\n TopLevelPropertyNaming:\n active: true\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n constantPattern: '[A-Z][_A-Z0-9]*'\n propertyPattern: '[A-Za-z][_A-Za-z0-9]*'\n privatePropertyPattern: '_?[A-Za-z][_A-Za-z0-9]*'\n VariableMaxLength:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n maximumVariableNameLength: 64\n VariableMinLength:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n minimumVariableNameLength: 1\n VariableNaming:\n active: true\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n variablePattern: '[a-z][A-Za-z0-9]*'\n privateVariablePattern: '(_)?[a-z][A-Za-z0-9]*'\n excludeClassPattern: '$^'\n ignoreOverridden: true\n\nperformance:\n active: true\n ArrayPrimitive:\n active: true\n ForEachOnRange:\n active: true\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n SpreadOperator:\n active: true\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n UnnecessaryTemporaryInstantiation:\n active: true\n\npotential-bugs:\n active: true\n AvoidReferentialEquality:\n active: false\n forbiddenTypePatterns:\n - 'kotlin.String'\n CastToNullableType:\n active: false\n Deprecation:\n active: false\n DontDowncastCollectionTypes:\n active: false\n DoubleMutabilityForCollection:\n active: false\n DuplicateCaseInWhenExpression:\n active: true\n EqualsAlwaysReturnsTrueOrFalse:\n active: true\n EqualsWithHashCodeExist:\n active: true\n ExitOutsideMain:\n active: false\n ExplicitGarbageCollectionCall:\n active: true\n HasPlatformType:\n active: false\n IgnoredReturnValue:\n active: false\n restrictToAnnotatedMethods: true\n returnValueAnnotations:\n - '*.CheckResult'\n - '*.CheckReturnValue'\n ignoreReturnValueAnnotations:\n - '*.CanIgnoreReturnValue'\n ImplicitDefaultLocale:\n active: true\n ImplicitUnitReturnType:\n active: false\n allowExplicitReturnType: true\n InvalidRange:\n active: true\n IteratorHasNextCallsNextMethod:\n active: true\n IteratorNotThrowingNoSuchElementException:\n active: true\n LateinitUsage:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n ignoreOnClassesPattern: ''\n MapGetWithNotNullAssertionOperator:\n active: false\n MissingPackageDeclaration:\n active: false\n excludes: [ '**/*.kts' ]\n MissingWhenCase:\n active: true\n allowElseExpression: true\n NullableToStringCall:\n active: false\n RedundantElseInWhen:\n active: true\n UnconditionalJumpStatementInLoop:\n active: false\n UnnecessaryNotNullOperator:\n active: true\n UnnecessarySafeCall:\n active: true\n UnreachableCatchBlock:\n active: false\n UnreachableCode:\n active: true\n UnsafeCallOnNullableType:\n active: true\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n UnsafeCast:\n active: true\n UnusedUnaryOperator:\n active: false\n UselessPostfixExpression:\n active: false\n WrongEqualsTypeParameter:\n active: true\n\nstyle:\n active: true\n ClassOrdering:\n active: false\n CollapsibleIfStatements:\n active: false\n DataClassContainsFunctions:\n active: false\n conversionFunctionPrefix: 'to'\n DataClassShouldBeImmutable:\n active: false\n DestructuringDeclarationWithTooManyEntries:\n active: false\n maxDestructuringEntries: 3\n EqualsNullCall:\n active: true\n EqualsOnSignatureLine:\n active: false\n ExplicitCollectionElementAccessMethod:\n active: false\n ExplicitItLambdaParameter:\n active: false\n ExpressionBodySyntax:\n active: false\n includeLineWrapping: false\n ForbiddenComment:\n active: true\n values:\n - 'FIXME:'\n - 'STOPSHIP:'\n - 'TODO:'\n allowedPatterns: ''\n customMessage: ''\n ForbiddenImport:\n active: false\n imports: [ ]\n forbiddenPatterns: ''\n ForbiddenMethodCall:\n active: false\n methods:\n - 'kotlin.io.print'\n - 'kotlin.io.println'\n ForbiddenPublicDataClass:\n active: true\n excludes: [ '**' ]\n ignorePackages:\n - '*.internal'\n - '*.internal.*'\n ForbiddenVoid:\n active: false\n ignoreOverridden: false\n ignoreUsageInGenerics: false\n FunctionOnlyReturningConstant:\n active: true\n ignoreOverridableFunction: true\n ignoreActualFunction: true\n excludedFunctions: ''\n LibraryCodeMustSpecifyReturnType:\n active: true\n excludes: [ '**' ]\n LibraryEntitiesShouldNotBePublic:\n active: true\n excludes: [ '**' ]\n LoopWithTooManyJumpStatements:\n active: true\n maxJumpCount: 1\n MagicNumber:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n ignoreNumbers:\n - '-1'\n - '0'\n - '1'\n - '2'\n ignoreHashCodeFunction: true\n ignorePropertyDeclaration: false\n ignoreLocalVariableDeclaration: false\n ignoreConstantDeclaration: true\n ignoreCompanionObjectPropertyDeclaration: true\n ignoreAnnotation: false\n ignoreNamedArgument: true\n ignoreEnums: false\n ignoreRanges: false\n ignoreExtensionFunctions: true\n MandatoryBracesIfStatements:\n active: false\n MandatoryBracesLoops:\n active: false\n MaxLineLength:\n active: true\n maxLineLength: 160\n excludePackageStatements: true\n excludeImportStatements: true\n excludeCommentStatements: false\n MayBeConst:\n active: true\n ModifierOrder:\n active: true\n MultilineLambdaItParameter:\n active: false\n NestedClassesVisibility:\n active: true\n NewLineAtEndOfFile:\n active: true\n NoTabs:\n active: false\n ObjectLiteralToLambda:\n active: false\n OptionalAbstractKeyword:\n active: true\n OptionalUnit:\n active: false\n OptionalWhenBraces:\n active: false\n PreferToOverPairSyntax:\n active: false\n ProtectedMemberInFinalClass:\n active: true\n RedundantExplicitType:\n active: false\n RedundantHigherOrderMapUsage:\n active: false\n RedundantVisibilityModifierRule:\n active: false\n ReturnCount:\n active: false\n max: 2\n excludedFunctions: 'equals'\n excludeLabeled: false\n excludeReturnFromLambda: true\n excludeGuardClauses: false\n SafeCast:\n active: true\n SerialVersionUIDInSerializableClass:\n active: true\n SpacingBetweenPackageAndImports:\n active: false\n ThrowsCount:\n active: false\n max: 2\n excludeGuardClauses: false\n TrailingWhitespace:\n active: false\n UnderscoresInNumericLiterals:\n active: false\n acceptableLength: 4\n UnnecessaryAbstractClass:\n active: false\n UnnecessaryAnnotationUseSiteTarget:\n active: false\n UnnecessaryApply:\n active: true\n UnnecessaryFilter:\n active: false\n UnnecessaryInheritance:\n active: true\n UnnecessaryLet:\n active: false\n UnnecessaryParentheses:\n active: false\n UntilInsteadOfRangeTo:\n active: false\n UnusedImports:\n active: false\n UnusedPrivateClass:\n active: true\n UnusedPrivateMember:\n active: true\n allowedNames: '(_|ignored|expected|serialVersionUID)'\n UseAnyOrNoneInsteadOfFind:\n active: false\n UseArrayLiteralsInAnnotations:\n active: false\n UseCheckNotNull:\n active: false\n UseCheckOrError:\n active: false\n UseDataClass:\n active: false\n allowVars: false\n UseEmptyCounterpart:\n active: false\n UseIfEmptyOrIfBlank:\n active: false\n UseIfInsteadOfWhen:\n active: false\n UseIsNullOrEmpty:\n active: false\n UseOrEmpty:\n active: false\n UseRequire:\n active: false\n UseRequireNotNull:\n active: false\n UselessCallOnNotNull:\n active: true\n UtilityClassWithPublicConstructor:\n active: true\n VarCouldBeVal:\n active: true\n WildcardImport:\n active: false\n excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]\n excludeImports:\n - 'java.util.*'\n" }, { "path": "e2e/.gitignore", "content": "apps/\n\nsamples/\nsamples.zip\n" }, { "path": "e2e/README.md", "content": "# e2e\n\nThis directory contains glue code for testing Maestro itself.\n\n## Testing\n\nTypical workflow is:\n\n1. Start Android emulator and iOS simulator\n2. `download_apps`\n3. `install_apps`\n4. `run_tests`\n\nWe try to keep shell code in separate files, so we don't get too tightly coupled\nto GitHub Actions.\n\n### Expected failures\n\nLet's say a critical bug is introduced that causes Maestro to always mark all\ntests as passed. If our e2e test suite only was only checking if all tests pass\n(i.e. `maestro test` exit code is 0), then wouldn't catch such a bug.\n\nTo prevent this, all flows in this directory MUST have a `passing` or `failing`\nlabel, so the correct outcome can be asserted.\n\n## Samples\n\nThis directory also contains samples that are downloaded by the `maestro download-samples` command,\nand some glue code to facilitate updating those samples.\n\n`maestro download-samples` provides a set of flows and apps so that users can\nquickly try out Maestro, without having to write any flows for their own app.\n\n`download-samples` downloads these files and apps from our publicly-available\nGoogle Cloud Storage bucket (hosted on `storage.googleapis.com`).\n\n### Intro\n\nThe samples are automatically updated by the GitHub Action on every new commit\nto the `main` branch.\n\nThere zip archive that is downloaded by `download-samples` consists of 2 things:\n- the Maestro workspace with flows (located in the `workspaces/wikipedia` directory)\n- the app binary files that are used in the flows (located in the `apps` directory)\n\nApp binary files are heavy, so we don't store them in the repository. Instead, they are hosted\non publicly available directory in Google Cloud Storage:\n\n### Update the samples\n\nRun the script:\n\n```console\n./update_samples\n```\n" }, { "path": "e2e/download_apps", "content": "#!/usr/bin/env sh\nset -eu\n\n# Download apps from URLs listed in manifest.txt.\n#\n# We assume that if the downloaded file is a zip file, it's an iOS app and must\n# be unzipped.\n\n[ \"$(basename \"$PWD\")\" = \"e2e\" ] || { echo \"must be run from e2e directory\" && exit 1; }\n\ncommand -v curl >/dev/null 2>&1 || { echo \"curl is required\" && exit 1; }\n\nplatform=\"${1:-}\" # android or ios or an empty string (no filter)\nplatform=\"$(echo \"$platform\" | tr '[:upper:]' '[:lower:]')\" # Normalize to lowercase\n\nmkdir -p ./apps\nwhile read -r url; do\n case \"$platform\" in\n android)\n echo \"$url\" | grep -qi '\\.apk$' || continue # Skip if not an APK\n ;;\n ios)\n echo \"$url\" | grep -qi '\\.zip$' || continue # Skip if not a ZIP file\n ;;\n *)\n # No filter\n ;;\n esac\n echo \"download $url\"\n app_file=\"$(curl -fsSL --output-dir ./apps --write-out \"%{filename_effective}\" -OJ \"$url\")\"\n extension=\"${app_file##*.}\"\n if [ \"$extension\" = \"zip\" ]; then\n unzip -qq -o -d ./apps \"$app_file\" -x \"__MACOSX/*\"\n fi\ndone \"\n\texit 1\nfi\n\ncommand -v adb >/dev/null 2>&1 || { echo \"adb is required\" && exit 1; }\n\nfor file in ./apps/*; do\n\tfilename=\"$(basename \"$file\")\"\n\n\textension=\"${file##*.}\"\n\tif [ \"$platform\" = android ] && [ \"$extension\" = \"apk\" ]; then\n\t\techo \"install $filename\"\n\t\tadb install -r \"$file\" >/dev/null || echo \"adb: could not install $filename\"\n\telif [ \"$platform\" = ios ] && [ \"$extension\" = \"app\" ] && [ \"$(uname)\" = \"Darwin\" ]; then\n\t\techo \"install $filename\"\n\t\txcrun simctl install booted \"$file\" || echo \"xcrun: could not install $filename\"\n\tfi\ndone\n" }, { "path": "e2e/manifest.txt", "content": "https://storage.googleapis.com/mobile.dev/cli_e2e/wikipedia.apk\nhttps://storage.googleapis.com/mobile.dev/cli_e2e/wikipedia.zip\nhttps://storage.googleapis.com/mobile.dev/cli_e2e/demo_app.apk\nhttps://storage.googleapis.com/mobile.dev/cli_e2e/demo_app.zip\nhttps://storage.googleapis.com/mobile.dev/cli_e2e/setOrientation.apk\nhttps://storage.googleapis.com/mobile.dev/cli_e2e/SimpleWebViewApp.zip\n" }, { "path": "e2e/run_tests", "content": "#!/usr/bin/env sh\nset -eu\n\n# Runs all tests in the workspaces directory.\n\ncommand -v maestro >/dev/null 2>&1 || { echo \"maestro is required\" && exit 1; }\n\n[ \"$(basename \"$PWD\")\" = \"e2e\" ] || { echo \"must be run from e2e directory\" && exit 1; }\n\nALL_PASS=true\n\n_h1() { printf \"=>\\n=> %s\\n=>\\n\" \"$1\"; }\n_h2() { printf \"==> [%s] %s\\n\" \"$1\" \"$2\"; }\n_h3() { printf \"==> [%s] [%s] => %s\\n\" \"$1\" \"$2\" \"$3\"; }\n\ncloud=\"android_device_configuration,ios_device_configuration\" # Maestro Cloud specific tests\nplatform=\"${1:-}\"\ncase \"$platform\" in\n\tandroid) exclude_tags=\"ios,web,$cloud\" ;;\n\tios) exclude_tags=\"android,$cloud,web\" ;;\n\tweb) exclude_tags=\"android,ios,$cloud\" ;;\n\t*) echo \"usage: $0 \"; exit 1 ;;\nesac\n\nmkfifo pipe\ntrap 'rm -f pipe' EXIT\n\nexport MAESTRO_EXAMPLE=\"test-value\" # Relied upon in a test\n\nif [ \"$platform\" = \"web\" ]; then\n\t###\n\t### Web: run web-tagged tests for demo_app only\n\t###\n\tworkspace_dir=\"./workspaces/demo_app\"\n\tapp_name=\"demo_app\"\n\n\t_h1 \"run tests for app \\\"$app_name\\\" on platform \\\"$platform\\\"\"\n\t_h2 \"$app_name\" \"run web tests\"\n\n\twhile IFS= read -r line; do\n\t\t_h3 \"$app_name\" \"web\" \"$line\"\n\tdone < pipe &\n\n\tmaestro --verbose --platform \"$platform\" test --headless --include-tags web --exclude-tags \"$exclude_tags\" \"$workspace_dir\" 1>pipe 2>&1 \\\n\t\t|| { _h2 \"$app_name\" \"FAIL! Expected all pass, but at least some failed instead\"; ALL_PASS=false; }\nelse\n\tfor workspace_dir in ./workspaces/*; do\n\t\tapp_name=\"$(basename \"$workspace_dir\")\"\n\n\t\tcase $app_name in\n\t\t\t# demo_app has OOM issues on GHA\n\t\t\tdemo_app|setOrientation) [ \"$platform\" = \"ios\" ] && continue ;;\n\t\t\tsimple_web_view) [ \"$platform\" = \"android\" ] && continue ;;\n\t\tesac\n\n\t\t_h1 \"run tests for app \\\"$app_name\\\" on platform \\\"$platform\\\"\"\n\n\t\t###\n\t\t### Run passing tests\n\t\t###\n\t\t_h2 \"$app_name\" \"run passing tests\"\n\n\t\twhile IFS= read -r line; do\n\t\t\t_h3 \"$app_name\" \"passing\" \"$line\"\n\t\tdone < pipe &\n\n\t\tmaestro --verbose --platform \"$platform\" test --include-tags passing --exclude-tags \"$exclude_tags\" \"$workspace_dir\" 1>pipe 2>&1 \\\n\t\t\t|| { _h2 \"$app_name\" \"FAIL! Expected all pass, but at least some failed instead\"; ALL_PASS=false; }\n\n\t\t###\n\t\t### Run failing tests (skip workspaces with no failing flows)\n\t\t###\n\t\tcase $app_name in\n\t\t\twikipedia|setOrientation|simple_web_view) continue ;;\n\t\tesac\n\n\t\t_h2 \"$app_name\" \"run failing tests\"\n\n\t\twhile IFS= read -r line; do\n\t\t\t_h3 \"$app_name\" \"failing\" \"$line\"\n\t\tdone < pipe &\n\n\t\tmaestro --verbose --platform \"$platform\" test --include-tags failing --exclude-tags \"$exclude_tags\" \"$workspace_dir\" 1>pipe 2>&1 \\\n\t\t\t&& { _h2 \"$app_name\" \"FAIL! Expected all to fail, but at least some passed instead\"; ALL_PASS=false; }\n\tdone\nfi\n\nif [ \"$ALL_PASS\" = \"false\" ]; then\n\t_h1 \"FAILURE: some tests failed!\"\n\texit 1\nelse\n\t_h1 \"SUCCESS: all tests passed!\"\nfi" }, { "path": "e2e/update_samples", "content": "#!/usr/bin/env sh\nset -eu\n\n# Updates the samples that are hosted in mobile.dev's GCS bucket ($SAMPLES_URL).\n# The samples are for use with `maestro download-samples` command.\n\n[ \"$(basename \"$PWD\")\" = \"e2e\" ] || { echo \"must be run from e2e directory\" && exit 1; }\n\ncommand -v curl >/dev/null 2>&1 || { echo \"curl is required\" && exit 1; }\ncommand -v gsutil >/dev/null 2>&1 || { echo \"gsutil is required\" && exit 1; }\n\nSAMPLES_URL=\"gs://mobile.dev/samples/samples.zip\"\n\nif [ ! -d apps/ ]; then\n\t./download_apps\nfi\n\nrm -rf samples/ samples.zip\nmkdir -p samples/\ncp -r apps/wikipedia.apk apps/wikipedia.zip samples/\ncp -r workspaces/wikipedia/* samples/\ncp samples/wikipedia.apk samples/sample.apk # The name is being depended upon.\ncp samples/wikipedia.zip samples/sample.zip # The name is being depended upon.\ncd samples/\n\nzip -r -q ../samples.zip . -x \"/**/.*\" -x \"__MACOSX\"\n\ncd ..\n\ngsutil cp samples.zip \"$SAMPLES_URL\"\ngsutil acl ch -r -u AllUsers:R \"$SAMPLES_URL\"\n" }, { "path": "e2e/workspaces/setOrientation/test-set-orientation-flow.yaml", "content": "appId: com.example.maestro.orientation\nenv:\n orientationLandscapeLeft: LANDSCAPE_LEFT\n orientationLandscapeRight: LANDSCAPE_RIGHT\n orientationUpsideDown: UPSIDE_DOWN\n orientationPortrait: PORTRAIT\ntags:\n - android\n - passing\n---\n- launchApp\n- setOrientation: LANDSCAPE_LEFT\n- assertVisible: \"LANDSCAPE_LEFT\"\n- setOrientation: LANDSCAPE_RIGHT\n- assertVisible: \"LANDSCAPE_RIGHT\"\n- setOrientation: UPSIDE_DOWN\n- assertVisible: \"UPSIDE_DOWN\"\n- setOrientation: PORTRAIT\n- assertVisible: \"PORTRAIT\"\n- setOrientation: ${orientationLandscapeLeft}\n- assertVisible: \"LANDSCAPE_LEFT\"\n- setOrientation: ${orientationLandscapeRight}\n- assertVisible: \"LANDSCAPE_RIGHT\"\n- setOrientation: ${orientationUpsideDown}\n- assertVisible: \"UPSIDE_DOWN\"\n- setOrientation: ${orientationPortrait}\n- assertVisible: \"PORTRAIT\"" }, { "path": "e2e/workspaces/simple_web_view/webview.yaml", "content": "appId: com.example.SimpleWebViewApp\ntags:\n - passing\n - ios\n---\n- launchApp:\n clearState: true\n\n- tapOn: Open Login Page\n\n- extendedWaitUntil:\n visible: Login\n timeout: 30000\n label: Wait for Login page to load\n- assertVisible: Sign In\n- assertVisible: Forgot your password?\n" }, { "path": "e2e/workspaces/wikipedia/android-advanced-flow.yaml", "content": "appId: org.wikipedia\ntags:\n - android\n - passing\n - advanced\n---\n- runFlow: subflows/onboarding-android.yaml\n- tapOn:\n id: \"org.wikipedia:id/search_container\"\n- tapOn:\n text: \"Non existent view\"\n optional: true\n- runScript: scripts/getSearchQuery.js\n- inputText: ${output.result}\n- assertVisible: ${output.result}\n- runFlow: subflows/launch-clearstate-android.yaml\n" }, { "path": "e2e/workspaces/wikipedia/android-flow.yaml", "content": "appId: org.wikipedia\ntags:\n - android\n - passing\n---\n- launchApp\n" }, { "path": "e2e/workspaces/wikipedia/ios-advanced-flow.yaml", "content": "appId: org.wikimedia.wikipedia\ntags:\n - ios\n - passing\n - advanced\n---\n- runFlow: subflows/onboarding-ios.yaml\n\n- runFlow:\n when:\n visible:\n text: Explore your Wikipedia Year in Review\n commands:\n - tapOn: Done\n label: Dismiss Year In Review popup, if visible\n\n- runFlow:\n when:\n visible: \"You have been logged out\"\n commands:\n - tapOn:\n text: \"Continue without logging in\"\n label: Dismiss the auth modal if visible\n\n- tapOn:\n text: \"Non existent view\"\n optional: true\n- tapOn: Search Wikipedia\n- runScript: scripts/getSearchQuery.js\n- inputText: ${output.result}\n- eraseText\n- inputText: qwerty\n- assertVisible: ${output.result}\n- runFlow: subflows/launch-clearstate-ios.yaml\n" }, { "path": "e2e/workspaces/wikipedia/ios-flow.yaml", "content": "appId: org.wikimedia.wikipedia\ntags:\n - ios\n - passing\n---\n- launchApp\n" }, { "path": "e2e/workspaces/wikipedia/scripts/getSearchQuery.js", "content": "output.result = 'qwerty';\n" }, { "path": "e2e/workspaces/wikipedia/subflows/launch-clearstate-android.yaml", "content": "appId: org.wikipedia\n---\n- launchApp:\n clearState: true\n- assertVisible: \"Continue\"\n- assertVisible: \"Skip\"" }, { "path": "e2e/workspaces/wikipedia/subflows/launch-clearstate-ios.yaml", "content": "appId: org.wikimedia.wikipedia\n---\n- launchApp:\n clearState: true\n- assertVisible: \"Next\"\n- assertVisible: \"Skip\"" }, { "path": "e2e/workspaces/wikipedia/subflows/onboarding-android.yaml", "content": "appId: org.wikipedia\n---\n- launchApp:\n clearState: true\n- tapOn:\n text: \"Non existent view\"\n optional: true\n- tapOn:\n id: \"org.wikipedia:id/fragment_onboarding_forward_button\"\n- tapOn:\n id: \"org.wikipedia:id/fragment_onboarding_forward_button\"\n- tapOn:\n id: \"org.wikipedia:id/fragment_onboarding_forward_button\"\n- tapOn:\n id: \"org.wikipedia:id/fragment_onboarding_done_button\"\n" }, { "path": "e2e/workspaces/wikipedia/subflows/onboarding-ios.yaml", "content": "appId: org.wikimedia.wikipedia\n---\n- launchApp:\n clearState: true\n- repeat:\n times: 3\n commands:\n - swipe:\n direction: LEFT\n duration: 400\n - waitForAnimationToEnd\n- tapOn: Get started\n- tapOn:\n text: \"Non existent view\"\n optional: true\n" }, { "path": "e2e/workspaces/wikipedia/wikipedia-android-advanced/auth/login.yml", "content": "appId: org.wikipedia\n---\n- tapOn: \"More\"\n- tapOn: \"LOG IN.*\"\n- tapOn:\n id: \".*create_account_login_button\"\n- runScript: \"../scripts/fetchTestUser.js\"\n- tapOn: \"Username\"\n- inputText: \"${output.test_user.username}\"\n- tapOn: \"Password\"\n- inputText: \"No provided\"\n- tapOn: \"LOG IN\"\n- back\n- back\n" }, { "path": "e2e/workspaces/wikipedia/wikipedia-android-advanced/auth/signup.yml", "content": "appId: org.wikipedia\n---\n- tapOn: \"More\"\n- tapOn: \"LOG IN.*\"\n- runScript: \"../scripts/generateCredentials.js\"\n- tapOn: \"Username\"\n- inputText: \"${output.credentials.username}\"\n- tapOn: \"Password\"\n- inputText: \"${output.credentials.password}\"\n- tapOn: \"Repeat password\"\n- inputText: \"${output.credentials.password}\"\n- tapOn: \"Email.*\"\n- inputText: \"${output.credentials.email}\"\n\n# We won't actually create the account\n- back\n- back\n" }, { "path": "e2e/workspaces/wikipedia/wikipedia-android-advanced/dashboard/copy-paste.yml", "content": "appId: org.wikipedia\n---\n- tapOn: \"Explore\"\n- scrollUntilVisible:\n element: \"Top read\"\n- copyTextFrom:\n id: \".*view_list_card_item_title\"\n index: 0\n- tapOn: \"Explore\"\n- tapOn: \"Search Wikipedia\"\n- inputText: \"${maestro.copiedText}\"\n- back\n- back\n" }, { "path": "e2e/workspaces/wikipedia/wikipedia-android-advanced/dashboard/feed.yml", "content": "appId: org.wikipedia\n---\n- tapOn: \"Explore\"\n- scrollUntilVisible:\n element: \"Today on Wikipedia.*\"\n- tapOn: \"Today on Wikipedia.*\"\n- back\n" }, { "path": "e2e/workspaces/wikipedia/wikipedia-android-advanced/dashboard/main.yml", "content": "appId: org.wikipedia\n---\n- runFlow: \"search.yml\"\n- runFlow: \"saved.yml\"\n- runFlow: \"feed.yml\"\n- runFlow: \"copy-paste.yml\"\n" }, { "path": "e2e/workspaces/wikipedia/wikipedia-android-advanced/dashboard/saved.yml", "content": "appId: org.wikipedia\n---\n- tapOn: \"Saved\"\n- tapOn: \"Default list for your saved articles\"\n- assertVisible: \"Sun\"\n- assertVisible: \"Star at the center of the Solar System\"\n- back\n" }, { "path": "e2e/workspaces/wikipedia/wikipedia-android-advanced/dashboard/search.yml", "content": "appId: org.wikipedia\n---\n- tapOn: \"Search Wikipedia\"\n- inputText: \"Sun\"\n- assertVisible: \"Star at the center of the Solar System\"\n- tapOn:\n id: \".*page_list_item_title\"\n- tapOn:\n id: \".*page_save\"\n- back\n- back\n- back\n" }, { "path": "e2e/workspaces/wikipedia/wikipedia-android-advanced/onboarding/add-language.yml", "content": "appId: org.wikipedia\n---\n- tapOn: \"ADD OR EDIT.*\"\n- tapOn: \"ADD LANGUAGE\"\n- tapOn:\n id: \".*menu_search_language\"\n- inputText: \"Greek\"\n- assertVisible: \"ฮ•ฮปฮปฮทฮฝฮนฮบฮฌ\"\n- tapOn: \"ฮ•ฮปฮปฮทฮฝฮนฮบฮฌ\"\n- tapOn: \"Navigate up\"\n" }, { "path": "e2e/workspaces/wikipedia/wikipedia-android-advanced/onboarding/main.yml", "content": "appId: org.wikipedia\n---\n- runFlow: \"add-language.yml\"\n- runFlow: \"remove-language.yml\"\n- tapOn: \"Continue\"\n- assertVisible: \"New ways to explore\"\n- tapOn: \"Continue\"\n- assertVisible: \"Reading lists with sync\"\n- tapOn: \"Continue\"\n- assertVisible: \"Send anonymous data\"\n- tapOn: \"Get started\"\n" }, { "path": "e2e/workspaces/wikipedia/wikipedia-android-advanced/onboarding/remove-language.yml", "content": "appId: org.wikipedia\n---\n- tapOn: \"ADD OR EDIT.*\"\n- tapOn: \"More options\"\n- tapOn: \"Remove language\"\n- tapOn:\n id: \".*wiki_language_checkbox\"\n index: 1\n- tapOn:\n id: \".*menu_delete_selected\"\n- tapOn: \"OK\"\n- assertNotVisible: \"ฮ•ฮปฮปฮทฮฝฮนฮบฮฌ\"\n- tapOn: \"Navigate up\"\n" }, { "path": "e2e/workspaces/wikipedia/wikipedia-android-advanced/run-test.yml", "content": "appId: org.wikipedia\ntags:\n - android\n - passing\n---\n- launchApp:\n clearState: true\n- runFlow: \"onboarding/main.yml\"\n- runFlow: \"dashboard/main.yml\"\n- runFlow: \"auth/signup.yml\"\n- runFlow: \"auth/login.yml\"\n" }, { "path": "e2e/workspaces/wikipedia/wikipedia-android-advanced/scripts/fetchTestUser.js", "content": "// Fetches test user from API\nfunction getTestUserFromApi() {\n const url = `https://jsonplaceholder.typicode.com/users/1`;\n var response = http.get(url);\n var data = json(response.body);\n\n return {\n username: data.username,\n email: data.email,\n };\n}\n\noutput.test_user = getTestUserFromApi();\n" }, { "path": "e2e/workspaces/wikipedia/wikipedia-android-advanced/scripts/generateCredentials.js", "content": "function username() {\n var date = new Date().getTime().toString();\n var username = `test_user_placeholder`.replace(\"placeholder\", date);\n return username;\n}\n\nfunction email() {\n var date = new Date().getTime().toString();\n var email = `test-user-placeholder@test.com`.replace(\"placeholder\", date);\n return email;\n}\n\nfunction password() {\n var date = new Date().getTime().toString();\n var password = `test-user-password-placeholder`.replace(\"placeholder\", date);\n return password;\n}\n\noutput.credentials = {\n email: email(),\n password: password(),\n username: username(),\n};\n" }, { "path": "gradle/libs.versions.toml", "content": "# File should be sorted by alphabet for each section\n\n# How to sort with AS:\n# \"Select all in block\" -> \"Edit\" -> \"Sort lines\"\n\n# File should follow the naming convention:\n# https://blog.gradle.org/best-practices-naming-version-catalog-entries\n\n[versions]\nandroidPlugin = \"8.13.2\"\nandroidxEspresso = \"3.6.1\"\nandroidxTestJunit = \"1.2.1\"\nandroidxUiautomator = \"2.3.0\"\napkParser = \"2.6.10\"\nappdirs = \"1.2.1\"\naxml = \"2.1.2\"\ncommons-codec = \"1.17.0\"\ncommons-lang3 = \"3.13.0\" # 3.14.0 causes weird crashes during dexing\ncommons-io = \"2.16.1\"\ndadb = \"1.2.10\"\ndatafaker = \"2.5.3\"\nddPlist = \"1.23\"\ndetekt = \"1.23.8\"\ngoogleFindbugs = \"3.0.2\"\ngoogleGson = \"2.11.0\"\ngoogleProtobuf = \"3.21.9\"\ngoogleProtobufPlugin = \"0.9.4\"\ngoogleTruth = \"1.4.2\"\ngraaljs = \"24.2.0\"\ngrpc = \"1.50.2\"\ngrpcKotlinStub = \"1.4.1\"\nimageComparison = \"4.4.0\"\nhiddenapibypass = \"4.3\"\njackson = \"2.17.1\"\njansi = \"2.4.1\"\njarchivelib = \"1.2.0\"\njcodec = \"0.2.5\"\njunit = \"5.10.2\"\nkotlin = \"2.2.0\"\nkotlinRetry = \"2.0.1\"\nkotlinResult = \"2.0.1\"\nkotlinx-serialization-json = \"1.5.0\"\nktor = \"2.3.6\"\nmicrometerObservation = \"1.13.4\"\nmicrometerCore = \"1.13.4\"\nmockk = \"1.12.0\"\nmordant = \"3.0.2\"\nmozillaRhino = \"1.7.14\"\npicocli = \"4.6.3\"\nposthog = \"1.0.3\"\nselenium = \"4.40.0\"\nselenium-devtools = \"4.40.0\"\nskiko = \"0.8.18\"\nsquareOkhttp = \"4.12.0\"\nsquareOkio = \"3.16.2\"\nsquareMockWebServer = \"4.11.0\"\nwiremock = \"2.35.0\"\nlog4j = \"2.25.3\"\n\ncoroutines = \"1.8.0\"\nkotlinx-html = \"0.8.0\"\nclikt = \"4.2.2\"\ngmsLocation = \"21.3.0\"\nmcpKotlinSdk = \"steviec/kotlin-1.8\"\n\n[libraries]\nkotlinx-coroutines-core = { module = \"org.jetbrains.kotlinx:kotlinx-coroutines-core\", version.ref = \"coroutines\" }\nkotlinx-html = { module = \"org.jetbrains.kotlinx:kotlinx-html\", version.ref = \"kotlinx-html\" }\nkotlinx-serialization-json = { module = \"org.jetbrains.kotlinx:kotlinx-serialization-json\", version.ref = \"kotlinx-serialization-json\" }\nandroidx-espresso-core = { module = \"androidx.test.espresso:espresso-core\", version.ref = \"androidxEspresso\" }\nandroidx-test-junit = { module = \"androidx.test.ext:junit\", version.ref = \"androidxTestJunit\" }\nandroidx-uiautomator = { module = \"androidx.test.uiautomator:uiautomator\", version.ref = \"androidxUiautomator\" }\napk-parser = { module = \"net.dongliu:apk-parser\", version.ref = \"apkParser\" }\nappdirs = { module = \"net.harawata:appdirs\", version.ref = \"appdirs\" }\naxml = { module = \"de.upb.cs.swt:axml\", version.ref = \"axml\" }\ncommons-codec = { module = \"commons-codec:commons-codec\", version.ref = \"commons-codec\" }\ncommons-lang3 = { module = \"org.apache.commons:commons-lang3\", version.ref = \"commons-lang3\" }\ncommons-io = { module = \"commons-io:commons-io\", version.ref = \"commons-io\" }\ndadb = { module = \"dev.mobile:dadb\", version.ref = \"dadb\" }\ndatafaker = { module = \"net.datafaker:datafaker\", version.ref = \"datafaker\" }\ndd-plist = { module = \"com.googlecode.plist:dd-plist\", version.ref = \"ddPlist\" }\ngoogle-findbugs = { module = \"com.google.code.findbugs:jsr305\", version.ref = \"googleFindbugs\" }\ngoogle-gson = { module = \"com.google.code.gson:gson\", version.ref = \"googleGson\" }\ngoogle-protobuf-kotlin = { module = \"com.google.protobuf:protobuf-kotlin\", version.ref = \"googleProtobuf\" }\ngoogle-protobuf-kotlin-lite = { module = \"com.google.protobuf:protobuf-kotlin-lite\", version.ref = \"googleProtobuf\" }\ngoogle-truth = { module = \"com.google.truth:truth\", version.ref = \"googleTruth\" }\ngraaljs = { module = \"org.graalvm.js:js\", version.ref = \"graaljs\" }\ngraaljsEngine = { module = \"org.graalvm.js:js-scriptengine\", version.ref = \"graaljs\" }\ngraaljsLanguage = { module = \"org.graalvm.js:js-language\", version.ref = \"graaljs\" }\ngrpc-kotlin-stub = { module = \"io.grpc:grpc-kotlin-stub\", version.ref = \"grpcKotlinStub\" }\ngrpc-netty = { module = \"io.grpc:grpc-netty\", version.ref = \"grpc\" }\ngrpc-netty-shaded = { module = \"io.grpc:grpc-netty-shaded\", version.ref = \"grpc\" }\ngrpc-okhttp = { module = \"io.grpc:grpc-okhttp\", version.ref = \"grpc\" }\ngrpc-protobuf = { module = \"io.grpc:grpc-protobuf\", version.ref = \"grpc\" }\ngrpc-protobuf-lite = { module = \"io.grpc:grpc-protobuf-lite\", version.ref = \"grpc\" }\ngrpc-stub = { module = \"io.grpc:grpc-stub\", version.ref = \"grpc\" }\nhiddenapibypass = { module = \"org.lsposed.hiddenapibypass:hiddenapibypass\", version.ref = \"hiddenapibypass\" }\nimage-comparison = { module = \"com.github.romankh3:image-comparison\", version.ref = \"imageComparison\" }\njackson-core-databind = { module = \"com.fasterxml.jackson.core:jackson-databind\", version.ref = \"jackson\" }\njackson-dataformat-xml = { module = \"com.fasterxml.jackson.dataformat:jackson-dataformat-xml\", version.ref = \"jackson\" }\njackson-dataformat-yaml = { module = \"com.fasterxml.jackson.dataformat:jackson-dataformat-yaml\", version.ref = \"jackson\" }\njackson-module-kotlin = { module = \"com.fasterxml.jackson.module:jackson-module-kotlin\", version.ref = \"jackson\" }\njackson-datatype-jsr310 = { module = \"com.fasterxml.jackson.datatype:jackson-datatype-jsr310\", version.ref = \"jackson\" }\njansi = { module = \"org.fusesource.jansi:jansi\", version.ref = \"jansi\" }\njarchivelib = { module = \"org.rauschig:jarchivelib\", version.ref = \"jarchivelib\" }\njcodec = { module = \"org.jcodec:jcodec\", version.ref = \"jcodec\" }\njcodec-awt = { module = \"org.jcodec:jcodec-javase\", version.ref = \"jcodec\" }\njunit-jupiter-api = { module = \"org.junit.jupiter:junit-jupiter-api\", version.ref = \"junit\" }\njunit-jupiter-engine = { module = \"org.junit.jupiter:junit-jupiter-engine\", version.ref = \"junit\" }\njunit-jupiter-params = { module = \"org.junit.jupiter:junit-jupiter-params\", version.ref = \"junit\" }\nkotlin-result = { module = \"com.michael-bull.kotlin-result:kotlin-result\", version.ref = \"kotlinResult\" }\nkotlin-retry = { module = \"com.michael-bull.kotlin-retry:kotlin-retry\", version.ref = \"kotlinRetry\" }\nclikt = { module = \"com.github.ajalt.clikt:clikt\", version.ref = \"clikt\" }\nktor-client-cio = { module = \"io.ktor:ktor-client-cio\", version.ref = \"ktor\" }\nktor-client-core = { module = \"io.ktor:ktor-client-core\", version.ref = \"ktor\" }\nktor-serial-gson = { module = \"io.ktor:ktor-serialization-gson\", version.ref = \"ktor\" }\nktor-serial-json = { module = \"io.ktor:ktor-serialization-kotlinx-json\", version.ref = \"ktor\" }\nktor-server-cio = { module = \"io.ktor:ktor-server-cio\", version.ref = \"ktor\" }\nktor-server-content-negotiation = { module = \"io.ktor:ktor-server-content-negotiation\", version.ref = \"ktor\" }\nktor-client-content-negotiation = { module = \"io.ktor:ktor-client-content-negotiation\", version.ref = \"ktor\" }\nktor-server-core = { module = \"io.ktor:ktor-server-core\", version.ref = \"ktor\" }\nktor-server-cors = { module = \"io.ktor:ktor-server-cors\", version.ref = \"ktor\" }\nktor-server-netty = { module = \"io.ktor:ktor-server-netty\", version.ref = \"ktor\" }\nktor-server-status-pages = { module = \"io.ktor:ktor-server-status-pages\", version.ref = \"ktor\" }\nmicrometer-core = { module = \"io.micrometer:micrometer-core\", version.ref = \"micrometerCore\" }\nmicrometer-observation = { module = \"io.micrometer:micrometer-observation\", version.ref = \"micrometerObservation\" }\nmockk = { module = \"io.mockk:mockk\", version.ref = \"mockk\" }\nmordant = { module = \"com.github.ajalt.mordant:mordant\", version.ref = \"mordant\" }\nmozilla-rhino = { module = \"org.mozilla:rhino\", version.ref = \"mozillaRhino\" }\npicocli = { module = \"info.picocli:picocli\", version.ref = \"picocli\" }\npicocli-codegen = { module = \"info.picocli:picocli-codegen\", version.ref = \"picocli\" }\nposthog = { module = \"com.posthog:posthog-server\", version.ref = \"posthog\" }\nselenium = { module = \"org.seleniumhq.selenium:selenium-java\", version.ref = \"selenium\" }\nselenium-devtools = { module = \"org.seleniumhq.selenium:selenium-devtools-v142\", version.ref = \"selenium-devtools\" }\nskiko-macos-arm64 = { module = \"org.jetbrains.skiko:skiko-awt-runtime-macos-arm64\", version.ref = \"skiko\" }\nskiko-macos-x64 = { module = \"org.jetbrains.skiko:skiko-awt-runtime-macos-x64\", version.ref = \"skiko\" }\nskiko-linux-arm64 = { module = \"org.jetbrains.skiko:skiko-awt-runtime-linux-arm64\", version.ref = \"skiko\" }\nskiko-linux-x64 = { module = \"org.jetbrains.skiko:skiko-awt-runtime-linux-x64\", version.ref = \"skiko\" }\nskiko-windows-arm64 = { module = \"org.jetbrains.skiko:skiko-awt-runtime-windows-arm64\", version.ref = \"skiko\" }\nskiko-windows-x64 = { module = \"org.jetbrains.skiko:skiko-awt-runtime-windows-x64\", version.ref = \"skiko\" }\nsquare-okhttp = { module = \"com.squareup.okhttp3:okhttp\", version.ref = \"squareOkhttp\" }\nsquare-okhttp-logs = { module = \"com.squareup.okhttp3:logging-interceptor\", version.ref = \"squareOkhttp\" }\nsquare-okio = { module = \"com.squareup.okio:okio\", version.ref = \"squareOkio\" }\nsquare-okio-jvm = { module = \"com.squareup.okio:okio-jvm\", version.ref = \"squareOkio\" }\nsquare-mock-server = { module = \"com.squareup.okhttp3:mockwebserver\", version.ref = \"squareMockWebServer\" }\nwiremock-jre8 = { module = \"com.github.tomakehurst:wiremock-jre8\", version.ref = \"wiremock\" }\nlogging-sl4j = { module = \"org.apache.logging.log4j:log4j-slf4j2-impl\", version.ref = \"log4j\" }\nlogging-api = { module = \"org.apache.logging.log4j:log4j-api\", version.ref = \"log4j\" }\nlogging-layout-template = { module = \"org.apache.logging.log4j:log4j-layout-template-json\", version.ref = \"log4j\" }\nlog4j-core = { module = \"org.apache.logging.log4j:log4j-core\", version.ref = \"log4j\" }\ngmsLocation = { module = \"com.google.android.gms:play-services-location\", version.ref = \"gmsLocation\" }\nmcp-kotlin-sdk = { module = \"io.modelcontextprotocol:kotlin-sdk\" }\n\n[bundles]\n\n[plugins]\nandroid-application = { id = \"com.android.application\", version.ref = \"androidPlugin\" }\ndetekt = { id = \"io.gitlab.arturbosch.detekt\", version.ref = \"detekt\" }\nprotobuf = { id = \"com.google.protobuf\", version.ref = \"googleProtobufPlugin\" }\nkotlin-jvm = { id = \"org.jetbrains.kotlin.jvm\", version.ref = \"kotlin\" }\nkotlin-android = { id = \"org.jetbrains.kotlin.android\", version.ref = \"kotlin\" }\nkotlin-serialization = { id = \"org.jetbrains.kotlin.plugin.serialization\", version.ref = \"kotlin\" }\nmavenPublish = { id = \"com.vanniktech.maven.publish\", version = \"0.33.0\" }\njreleaser = { id = \"org.jreleaser\", version = \"1.13.1\" }\nshadow = { id = \"com.github.johnrengelman.shadow\", version = \"7.1.2\" }\n" }, { "path": "gradle/wrapper/gradle-wrapper.properties", "content": "distributionBase=GRADLE_USER_HOME\ndistributionPath=wrapper/dists\ndistributionUrl=https\\://services.gradle.org/distributions/gradle-8.13-bin.zip\nnetworkTimeout=10000\nvalidateDistributionUrl=true\nzipStoreBase=GRADLE_USER_HOME\nzipStorePath=wrapper/dists\n" }, { "path": "gradle.properties", "content": "android.useAndroidX=true\nandroid.enableJetifier=true\nkotlin.code.style=official\nGROUP=dev.mobile\nVERSION_NAME=2.4.0\nPOM_DESCRIPTION=Maestro is a server-driven platform-agnostic library that allows to drive tests for both iOS and Android using the same implementation through an intuitive API.\nPOM_URL=https://github.com/mobile-dev-inc/maestro\nPOM_SCM_URL=https://github.com/mobile-dev-inc/maestro\nPOM_SCM_CONNECTION=scm:git:git://github.com/mobile-dev-inc/maestro.git\nPOM_SCM_DEV_CONNECTION=scm:git:ssh://git@github.com/mobile-dev-inc/maestro.git\nPOM_LICENCE_NAME=The Apache Software License, Version 2.0\nPOM_LICENCE_URL=https://www.apache.org/licenses/LICENSE-2.0.txt\nPOM_LICENCE_DIST=repo\nPOM_DEVELOPER_ID=mobile-dev-inc\nPOM_DEVELOPER_NAME=mobile.dev inc.\nSONATYPE_STAGING_PROFILE=dev.mobile\norg.gradle.jvmargs=-Xmx2000m\n" }, { "path": "gradlew", "content": "#!/bin/sh\n\n#\n# Copyright ยฉ 2015-2021 the original authors.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# https://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n#\n# SPDX-License-Identifier: Apache-2.0\n#\n\n##############################################################################\n#\n# Gradle start up script for POSIX generated by Gradle.\n#\n# Important for running:\n#\n# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is\n# noncompliant, but you have some other compliant shell such as ksh or\n# bash, then to run this script, type that shell name before the whole\n# command line, like:\n#\n# ksh Gradle\n#\n# Busybox and similar reduced shells will NOT work, because this script\n# requires all of these POSIX shell features:\n# * functions;\n# * expansions ยซ$varยป, ยซ${var}ยป, ยซ${var:-default}ยป, ยซ${var+SET}ยป,\n# ยซ${var#prefix}ยป, ยซ${var%suffix}ยป, and ยซ$( cmd )ยป;\n# * compound commands having a testable exit status, especially ยซcaseยป;\n# * various built-in commands including ยซcommandยป, ยซsetยป, and ยซulimitยป.\n#\n# Important for patching:\n#\n# (2) This script targets any POSIX shell, so it avoids extensions provided\n# by Bash, Ksh, etc; in particular arrays are avoided.\n#\n# The \"traditional\" practice of packing multiple parameters into a\n# space-separated string is a well documented source of bugs and security\n# problems, so this is (mostly) avoided, by progressively accumulating\n# options in \"$@\", and eventually passing that to Java.\n#\n# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,\n# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;\n# see the in-line comments for details.\n#\n# There are tweaks for specific operating systems such as AIX, CygWin,\n# Darwin, MinGW, and NonStop.\n#\n# (3) This script is generated from the Groovy template\n# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt\n# within the Gradle project.\n#\n# You can find Gradle at https://github.com/gradle/gradle/.\n#\n##############################################################################\n\n# Attempt to set APP_HOME\n\n# Resolve links: $0 may be a link\napp_path=$0\n\n# Need this for daisy-chained symlinks.\nwhile\n APP_HOME=${app_path%\"${app_path##*/}\"} # leaves a trailing /; empty if no leading path\n [ -h \"$app_path\" ]\ndo\n ls=$( ls -ld \"$app_path\" )\n link=${ls#*' -> '}\n case $link in #(\n /*) app_path=$link ;; #(\n *) app_path=$APP_HOME$link ;;\n esac\ndone\n\n# This is normally unused\n# shellcheck disable=SC2034\nAPP_BASE_NAME=${0##*/}\n# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)\nAPP_HOME=$( cd -P \"${APP_HOME:-./}\" > /dev/null && printf '%s\\n' \"$PWD\" ) || exit\n\n# Use the maximum available, or set MAX_FD != -1 to use that value.\nMAX_FD=maximum\n\nwarn () {\n echo \"$*\"\n} >&2\n\ndie () {\n echo\n echo \"$*\"\n echo\n exit 1\n} >&2\n\n# OS specific support (must be 'true' or 'false').\ncygwin=false\nmsys=false\ndarwin=false\nnonstop=false\ncase \"$( uname )\" in #(\n CYGWIN* ) cygwin=true ;; #(\n Darwin* ) darwin=true ;; #(\n MSYS* | MINGW* ) msys=true ;; #(\n NONSTOP* ) nonstop=true ;;\nesac\n\nCLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar\n\n\n# Determine the Java command to use to start the JVM.\nif [ -n \"$JAVA_HOME\" ] ; then\n if [ -x \"$JAVA_HOME/jre/sh/java\" ] ; then\n # IBM's JDK on AIX uses strange locations for the executables\n JAVACMD=$JAVA_HOME/jre/sh/java\n else\n JAVACMD=$JAVA_HOME/bin/java\n fi\n if [ ! -x \"$JAVACMD\" ] ; then\n die \"ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME\n\nPlease set the JAVA_HOME variable in your environment to match the\nlocation of your Java installation.\"\n fi\nelse\n JAVACMD=java\n if ! command -v java >/dev/null 2>&1\n then\n die \"ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.\n\nPlease set the JAVA_HOME variable in your environment to match the\nlocation of your Java installation.\"\n fi\nfi\n\n# Increase the maximum file descriptors if we can.\nif ! \"$cygwin\" && ! \"$darwin\" && ! \"$nonstop\" ; then\n case $MAX_FD in #(\n max*)\n # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.\n # shellcheck disable=SC2039,SC3045\n MAX_FD=$( ulimit -H -n ) ||\n warn \"Could not query maximum file descriptor limit\"\n esac\n case $MAX_FD in #(\n '' | soft) :;; #(\n *)\n # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.\n # shellcheck disable=SC2039,SC3045\n ulimit -n \"$MAX_FD\" ||\n warn \"Could not set maximum file descriptor limit to $MAX_FD\"\n esac\nfi\n\n# Collect all arguments for the java command, stacking in reverse order:\n# * args from the command line\n# * the main class name\n# * -classpath\n# * -D...appname settings\n# * --module-path (only if needed)\n# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.\n\n# For Cygwin or MSYS, switch paths to Windows format before running java\nif \"$cygwin\" || \"$msys\" ; then\n APP_HOME=$( cygpath --path --mixed \"$APP_HOME\" )\n CLASSPATH=$( cygpath --path --mixed \"$CLASSPATH\" )\n\n JAVACMD=$( cygpath --unix \"$JAVACMD\" )\n\n # Now convert the arguments - kludge to limit ourselves to /bin/sh\n for arg do\n if\n case $arg in #(\n -*) false ;; # don't mess with options #(\n /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath\n [ -e \"$t\" ] ;; #(\n *) false ;;\n esac\n then\n arg=$( cygpath --path --ignore --mixed \"$arg\" )\n fi\n # Roll the args list around exactly as many times as the number of\n # args, so each arg winds up back in the position where it started, but\n # possibly modified.\n #\n # NB: a `for` loop captures its iteration list before it begins, so\n # changing the positional parameters here affects neither the number of\n # iterations, nor the values presented in `arg`.\n shift # remove old arg\n set -- \"$@\" \"$arg\" # push replacement arg\n done\nfi\n\n\n# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.\nDEFAULT_JVM_OPTS='\"-Xmx64m\" \"-Xms64m\"'\n\n# Collect all arguments for the java command:\n# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,\n# and any embedded shellness will be escaped.\n# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be\n# treated as '${Hostname}' itself on the command line.\n\nset -- \\\n \"-Dorg.gradle.appname=$APP_BASE_NAME\" \\\n -classpath \"$CLASSPATH\" \\\n org.gradle.wrapper.GradleWrapperMain \\\n \"$@\"\n\n# Stop when \"xargs\" is not available.\nif ! command -v xargs >/dev/null 2>&1\nthen\n die \"xargs is not available\"\nfi\n\n# Use \"xargs\" to parse quoted args.\n#\n# With -n1 it outputs one arg per line, with the quotes and backslashes removed.\n#\n# In Bash we could simply go:\n#\n# readarray ARGS < <( xargs -n1 <<<\"$var\" ) &&\n# set -- \"${ARGS[@]}\" \"$@\"\n#\n# but POSIX shell has neither arrays nor command substitution, so instead we\n# post-process each arg (as a line of input to sed) to backslash-escape any\n# character that might be a shell metacharacter, then use eval to reverse\n# that process (while maintaining the separation between arguments), and wrap\n# the whole thing up as a single \"set\" statement.\n#\n# This will of course break if any of these variables contains a newline or\n# an unmatched quote.\n#\n\neval \"set -- $(\n printf '%s\\n' \"$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS\" |\n xargs -n1 |\n sed ' s~[^-[:alnum:]+,./:=@_]~\\\\&~g; ' |\n tr '\\n' ' '\n )\" '\"$@\"'\n\nexec \"$JAVACMD\" \"$@\"\n" }, { "path": "gradlew.bat", "content": "@rem\r\n@rem Copyright 2015 the original author or authors.\r\n@rem\r\n@rem Licensed under the Apache License, Version 2.0 (the \"License\");\r\n@rem you may not use this file except in compliance with the License.\r\n@rem You may obtain a copy of the License at\r\n@rem\r\n@rem https://www.apache.org/licenses/LICENSE-2.0\r\n@rem\r\n@rem Unless required by applicable law or agreed to in writing, software\r\n@rem distributed under the License is distributed on an \"AS IS\" BASIS,\r\n@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\n@rem See the License for the specific language governing permissions and\r\n@rem limitations under the License.\r\n@rem\r\n@rem SPDX-License-Identifier: Apache-2.0\r\n@rem\r\n\r\n@if \"%DEBUG%\"==\"\" @echo off\r\n@rem ##########################################################################\r\n@rem\r\n@rem Gradle startup script for Windows\r\n@rem\r\n@rem ##########################################################################\r\n\r\n@rem Set local scope for the variables with windows NT shell\r\nif \"%OS%\"==\"Windows_NT\" setlocal\r\n\r\nset DIRNAME=%~dp0\r\nif \"%DIRNAME%\"==\"\" set DIRNAME=.\r\n@rem This is normally unused\r\nset APP_BASE_NAME=%~n0\r\nset APP_HOME=%DIRNAME%\r\n\r\n@rem Resolve any \".\" and \"..\" in APP_HOME to make it shorter.\r\nfor %%i in (\"%APP_HOME%\") do set APP_HOME=%%~fi\r\n\r\n@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.\r\nset DEFAULT_JVM_OPTS=\"-Xmx64m\" \"-Xms64m\"\r\n\r\n@rem Find java.exe\r\nif defined JAVA_HOME goto findJavaFromJavaHome\r\n\r\nset JAVA_EXE=java.exe\r\n%JAVA_EXE% -version >NUL 2>&1\r\nif %ERRORLEVEL% equ 0 goto execute\r\n\r\necho. 1>&2\r\necho ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2\r\necho. 1>&2\r\necho Please set the JAVA_HOME variable in your environment to match the 1>&2\r\necho location of your Java installation. 1>&2\r\n\r\ngoto fail\r\n\r\n:findJavaFromJavaHome\r\nset JAVA_HOME=%JAVA_HOME:\"=%\r\nset JAVA_EXE=%JAVA_HOME%/bin/java.exe\r\n\r\nif exist \"%JAVA_EXE%\" goto execute\r\n\r\necho. 1>&2\r\necho ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2\r\necho. 1>&2\r\necho Please set the JAVA_HOME variable in your environment to match the 1>&2\r\necho location of your Java installation. 1>&2\r\n\r\ngoto fail\r\n\r\n:execute\r\n@rem Setup the command line\r\n\r\nset CLASSPATH=%APP_HOME%\\gradle\\wrapper\\gradle-wrapper.jar\r\n\r\n\r\n@rem Execute Gradle\r\n\"%JAVA_EXE%\" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% \"-Dorg.gradle.appname=%APP_BASE_NAME%\" -classpath \"%CLASSPATH%\" org.gradle.wrapper.GradleWrapperMain %*\r\n\r\n:end\r\n@rem End local scope for the variables with windows NT shell\r\nif %ERRORLEVEL% equ 0 goto mainEnd\r\n\r\n:fail\r\nrem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of\r\nrem the _cmd.exe /c_ return code!\r\nset EXIT_CODE=%ERRORLEVEL%\r\nif %EXIT_CODE% equ 0 set EXIT_CODE=1\r\nif not \"\"==\"%GRADLE_EXIT_CONSOLE%\" exit %EXIT_CODE%\r\nexit /b %EXIT_CODE%\r\n\r\n:mainEnd\r\nif \"%OS%\"==\"Windows_NT\" endlocal\r\n\r\n:omega\r\n" }, { "path": "installLocally.sh", "content": "#!/bin/sh\n\n./gradlew :maestro-cli:installDist\n\nrm -rf ~/.maestro/bin\nrm -rf ~/.maestro/lib\n\ncp -r ./maestro-cli/build/install/maestro/bin ~/.maestro/bin\ncp -r ./maestro-cli/build/install/maestro/lib ~/.maestro/lib" }, { "path": "maestro", "content": "#!/usr/bin/env bash\n\nset -e\n\nif [ -t 0 ]; then\n input=\"\"\nelse\n input=$(cat -)\nfi\n\n./gradlew :maestro-cli:installDist -q && ./maestro-cli/build/install/maestro/bin/maestro \"$@\"\n" }, { "path": "maestro-ai/README.md", "content": "# maestro-ai\n\nThis project implements AI support for use in Maestro.\n\nIt's both a library and an executable demo app.\n\n## Demo app\n\nAn API key is required. Set it with `MAESTRO_CLI_AI_KEY` env var. Examples:\n\n- OpenAI: `export MAESTRO_CLI_AI_KEY=sk-...`\n- Anthropic: `export MAESTRO_CLI_AI_KEY=sk-ant-api-...`\n\n### Build\n\n```console\n./gradlew :maestro-ai:installDist\n```\n\nThe startup script will be generated in `./maestro-ai/build/install/maestro-ai-demo/bin/maestro-ai-demo`.\n\n### How to use\n\nFirst of all, try out the `--help` flag.\n\nRun test for a single screenshot that contains defects (i.e. is bad):\n\n```console\nmaestro-ai-demo foo_1_bad.png\n```\n\nRun tests for all screenshots from the Uber that contain defects (i.e. are bad). Additionally, show prompts and raw\nLLM response:\n\n```console\nmaestro-ai-demo \\\n --model gpt-4o-2024-08-06 \\\n --show-prompts \\\n --show-raw-response \\\n test-ai-fixtures/uber_*_bad.png\n```\n" }, { "path": "maestro-ai/build.gradle.kts", "content": "import org.jetbrains.kotlin.gradle.tasks.KotlinCompilationTask\n\nplugins {\n application\n id(\"maven-publish\")\n alias(libs.plugins.kotlin.jvm)\n alias(libs.plugins.kotlin.serialization)\n alias(libs.plugins.mavenPublish)\n}\n\napplication {\n applicationName = \"maestro-ai-demo\"\n mainClass.set(\"maestro.ai.DemoAppKt\")\n}\n\nmavenPublishing {\n publishToMavenCentral(true)\n signAllPublications()\n}\n\ntasks.named(\"jar\") {\n manifest {\n attributes[\"Main-Class\"] = \"maestro.ai.DemoAppKt\"\n }\n}\n\ndependencies {\n api(libs.kotlin.result)\n api(libs.square.okio)\n api(libs.square.okio.jvm)\n api(libs.square.okhttp)\n\n api(libs.logging.sl4j)\n api(libs.logging.api)\n api(libs.logging.layout.template)\n api(libs.log4j.core)\n\n\n api(libs.ktor.client.core)\n implementation(libs.ktor.client.cio)\n implementation(libs.ktor.serial.json)\n implementation(libs.ktor.client.content.negotiation)\n implementation(libs.kotlinx.coroutines.core)\n implementation(libs.clikt)\n\n testImplementation(libs.junit.jupiter.api)\n testRuntimeOnly(libs.junit.jupiter.engine)\n testImplementation(libs.google.truth)\n testImplementation(libs.square.mock.server)\n testImplementation(libs.junit.jupiter.params)\n}\n\njava {\n sourceCompatibility = JavaVersion.VERSION_17\n targetCompatibility = JavaVersion.VERSION_17\n}\n\nkotlin {\n jvmToolchain {\n languageVersion.set(JavaLanguageVersion.of(17))\n }\n}\n\ntasks.named(\"compileKotlin\", KotlinCompilationTask::class.java) {\n compilerOptions {\n freeCompilerArgs.addAll(\"-Xjdk-release=17\")\n }\n}\n" }, { "path": "maestro-ai/gradle.properties", "content": "POM_NAME=Maestro AI\nPOM_ARTIFACT_ID=maestro-ai\nPOM_PACKAGING=jar\n" }, { "path": "maestro-ai/src/main/java/maestro/ai/AI.kt", "content": "package maestro.ai\n\nimport io.ktor.client.HttpClient\nimport io.ktor.client.plugins.HttpTimeout\nimport io.ktor.client.plugins.contentnegotiation.ContentNegotiation\nimport kotlinx.serialization.json.Json\nimport kotlinx.serialization.json.JsonObject\nimport java.io.Closeable\n\ndata class CompletionData(\n val prompt: String,\n val model: String,\n val temperature: Float,\n val maxTokens: Int,\n val images: List,\n val response: String,\n)\n\nabstract class AI(\n val defaultModel: String,\n protected val httpClient: HttpClient,\n) : Closeable {\n\n /**\n * Chat completion with the AI model.\n *\n * Caveats:\n * - `jsonSchema` is only supported by OpenAI (\"Structured Outputs\" feature)\n */\n abstract suspend fun chatCompletion(\n prompt: String,\n images: List = listOf(),\n temperature: Float? = null,\n model: String? = null,\n maxTokens: Int? = null,\n imageDetail: String? = null,\n identifier: String? = null,\n jsonSchema: JsonObject? = null,\n ): CompletionData\n\n companion object {\n const val AI_KEY_ENV_VAR = \"MAESTRO_CLI_AI_KEY\"\n const val AI_MODEL_ENV_VAR = \"MAESTRO_CLI_AI_MODEL\"\n\n val defaultHttpClient = HttpClient {\n install(ContentNegotiation) {\n Json {\n ignoreUnknownKeys = true\n }\n }\n\n install(HttpTimeout) {\n connectTimeoutMillis = 10000\n socketTimeoutMillis = 60000\n requestTimeoutMillis = 60000\n }\n }\n }\n}\n" }, { "path": "maestro-ai/src/main/java/maestro/ai/CloudPredictionAIEngine.kt", "content": "package maestro.ai\n\nimport maestro.ai.cloud.Defect\nimport maestro.ai.Prediction\n\nclass CloudAIPredictionEngine(private val apiKey: String) : AIPredictionEngine {\n override suspend fun findDefects(screen: ByteArray): List {\n return Prediction.findDefects(apiKey, screen)\n }\n\n override suspend fun performAssertion(screen: ByteArray, assertion: String): Defect? {\n return Prediction.performAssertion(apiKey, screen, assertion)\n }\n\n override suspend fun extractText(screen: ByteArray, query: String): String {\n return Prediction.extractText(apiKey, query, screen)\n }\n}\n" }, { "path": "maestro-ai/src/main/java/maestro/ai/DemoApp.kt", "content": "package maestro.ai\n\nimport com.github.ajalt.clikt.core.CliktCommand\nimport com.github.ajalt.clikt.parameters.arguments.argument\nimport com.github.ajalt.clikt.parameters.arguments.multiple\nimport com.github.ajalt.clikt.parameters.options.default\nimport com.github.ajalt.clikt.parameters.options.flag\nimport com.github.ajalt.clikt.parameters.options.option\nimport com.github.ajalt.clikt.parameters.types.float\nimport com.github.ajalt.clikt.parameters.types.path\nimport kotlinx.coroutines.async\nimport kotlinx.coroutines.runBlocking\nimport maestro.ai.anthropic.Claude\nimport maestro.ai.cloud.Defect\nimport maestro.ai.openai.OpenAI\nimport java.io.File\nimport java.nio.file.Path\n\n\nfun main(args: Array) = DemoApp().main(args)\n\n/**\n * This is a small helper program to help evaluate LLM results against a directory of screenshots and prompts.\n *\n * ### Input format\n *\n * Screenshot name format:\n * - {app_name}_{screenshot_number}_{good|bad}.png\n *\n * A screenshot can optionally have a prompt. In this case, the model will treat the prompt as the assertion command.\n * To associate a prompt with a screenshot, prompt text file name must have\n * the following format:\n * - {app_name_{screenshot_number}_{good|bad}.txt\n *\n * For example:\n * - foo_1_bad.png\n * - bar_2_good.png\n *\n * ### Output format\n *\n * The output for a single screenshot should indicate either PASS or FAIL, screenshot name, the result, and the defects\n * founds (if any).\n *\n * For example:\n *\n * ```text\n * PASS uber_2_bad.png: 1 defects found (as expected)\n * \t* layout: The prompt for entering a verification code is visible, indicating that the 2-factor authentication process is present. The screen instructs the user to enter a verification code generated for Uber, which is a typical 2-factor authentication step.\n * ```\n *\n * Some of the flags change output format.\n */\nclass DemoApp : CliktCommand() {\n private val inputFiles: List by argument(help = \"screenshots to use\").path(mustExist = true).multiple()\n\n private val model: String by option(help = \"LLM to use\").default(\"gpt-4o\")\n\n private val showOnlyFails: Boolean by option(help = \"Show only failed tests\").flag()\n\n private val showPrompts: Boolean by option(help = \"Show prompts\").flag()\n\n private val showRawResponse: Boolean by option(help = \"Show raw LLM response\").flag()\n\n private val temperature: Float by option(help = \"Temperature for LLM\").float().default(0.2f)\n\n private val parallel: Boolean by option(help = \"Run in parallel. May get rate limited\").flag()\n\n // IDEA: \"--json\" flag to allow for easy filtering with jq\n\n override fun run() = runBlocking {\n val apiKey = System.getenv(\"MAESTRO_CLI_AI_KEY\")\n require(apiKey != null) { \"OpenAI API key is not provided\" }\n\n val testCases = inputFiles.map { it.toFile() }.map { file ->\n require(!file.isDirectory) { \"Provided file is a directory, not a file\" }\n require(file.exists()) { \"Provided file does not exist\" }\n require(file.extension == \"png\") { \"Provided file is not a PNG file\" }\n file\n }.map { file ->\n val filename = file.nameWithoutExtension\n val parts = filename.split(\"_\")\n require(parts.size == 3) { \"Screenshot name is invalid: ${file.name}\" }\n\n val appName = parts[0]\n val index =\n parts[1].toIntOrNull() ?: throw IllegalArgumentException(\"Invalid screenshot name: ${file.name}\")\n val status = parts[2]\n\n val promptFile = \"${file.parent}/${appName}_${index}_${status}.txt\"\n val prompt = File(promptFile).run {\n if (exists()) {\n println(\"Found prompt file: $promptFile\")\n readText()\n } else null\n }\n\n TestCase(\n screenshot = file,\n appName = appName,\n shouldPass = status == \"good\",\n index = index,\n prompt = prompt,\n )\n }.toList()\n\n val aiClient: AI = when {\n model.startsWith(\"gpt\") -> OpenAI(\n apiKey = apiKey,\n defaultModel = model,\n defaultTemperature = temperature,\n )\n\n model.startsWith(\"claude\") -> Claude(\n apiKey = apiKey,\n defaultModel = model,\n defaultTemperature = temperature,\n )\n\n else -> throw IllegalArgumentException(\"Unknown model: $model\")\n }\n\n val cloudApiKey = System.getenv(\"MAESTRO_CLOUD_API_KEY\")\n if (cloudApiKey.isNullOrEmpty()) {\n throw IllegalArgumentException(\"`MAESTRO_CLOUD_API_KEY` is not available. Did you export MAESTRO_CLOUD_API_KEY?\")\n }\n\n testCases.forEach { testCase ->\n val bytes = testCase.screenshot.readBytes()\n\n val job = async {\n val defects = if (testCase.prompt == null) Prediction.findDefects(\n apiKey = cloudApiKey,\n screen = bytes,\n ) else {\n val result = Prediction.performAssertion(\n apiKey = cloudApiKey,\n screen = bytes,\n assertion = testCase.prompt,\n )\n\n if (result == null) emptyList()\n else listOf(result)\n }\n\n verify(testCase, defects)\n }\n\n if (!parallel) job.await()\n }\n }\n\n private fun verify(testCase: TestCase, defects: List) {\n if (!testCase.shouldPass) {\n // Check if LLM found defects (i.e. didn't commit false negative)\n if (defects.isNotEmpty()) {\n if (showOnlyFails) return\n\n println(\n \"\"\"\n PASS ${testCase.screenshot.name}: ${defects.size} defects found (as expected)\n ${defects.joinToString(\"\\n\") { \"\\t* ${it.category}: ${it.reasoning}\" }}\n \"\"\".trimIndent()\n )\n } else {\n println(\"FAIL ${testCase.screenshot.name} false-negative: No defects found but some were expected\")\n }\n\n } else {\n // Check that LLM didn't raise false positives\n if (defects.isEmpty()) {\n if (showOnlyFails) return\n\n println(\n \"\"\"\n PASS ${testCase.screenshot.name}: No defects found (as expected)\n \"\"\".trimIndent()\n )\n } else {\n println(\n \"\"\"\n FAIL ${testCase.screenshot.name} false-positive: ${defects.size} defects found but none were expected\n ${defects.joinToString(\"\\n\") { \"\\t* ${it.category}: ${it.reasoning}\" }}\n \"\"\".trimIndent()\n )\n }\n }\n }\n}\n\ndata class TestCase(\n val screenshot: File,\n val appName: String,\n val prompt: String?,\n val shouldPass: Boolean,\n val index: Int,\n)\n" }, { "path": "maestro-ai/src/main/java/maestro/ai/IAPredictionEngine.kt", "content": "package maestro.ai\n\nimport maestro.ai.cloud.Defect\n\ninterface AIPredictionEngine {\n suspend fun findDefects(screen: ByteArray): List\n suspend fun performAssertion(screen: ByteArray, assertion: String): Defect?\n suspend fun extractText(screen: ByteArray, query: String): String\n}\n" }, { "path": "maestro-ai/src/main/java/maestro/ai/Prediction.kt", "content": "package maestro.ai\n\nimport maestro.ai.cloud.ApiClient\nimport maestro.ai.cloud.Defect\n\nobject Prediction {\n private val apiClient = ApiClient()\n\n suspend fun findDefects(\n apiKey: String,\n screen: ByteArray,\n ): List {\n val response = apiClient.findDefects(apiKey, screen)\n\n return response.defects\n }\n\n suspend fun performAssertion(\n apiKey: String,\n screen: ByteArray,\n assertion: String,\n ): Defect? {\n val response = apiClient.findDefects(apiKey, screen, assertion)\n\n return response.defects.firstOrNull()\n }\n\n suspend fun extractText(\n apiKey: String,\n query: String,\n screen: ByteArray,\n ): String {\n val response = apiClient.extractTextWithAi(apiKey, query, screen)\n\n return response.text\n }\n}" }, { "path": "maestro-ai/src/main/java/maestro/ai/anthropic/Client.kt", "content": "package maestro.ai.anthropic\n\nimport Response\nimport io.ktor.client.HttpClient\nimport io.ktor.client.plugins.HttpTimeout\nimport io.ktor.client.plugins.contentnegotiation.ContentNegotiation\nimport io.ktor.client.request.post\nimport io.ktor.client.request.setBody\nimport io.ktor.client.statement.bodyAsText\nimport io.ktor.http.ContentType\nimport io.ktor.http.HttpStatusCode\nimport io.ktor.http.contentType\nimport io.ktor.http.isSuccess\nimport io.ktor.util.encodeBase64\nimport kotlinx.serialization.SerializationException\nimport kotlinx.serialization.encodeToString\nimport kotlinx.serialization.json.Json\nimport kotlinx.serialization.json.JsonObject\nimport maestro.ai.AI\nimport maestro.ai.CompletionData\nimport org.slf4j.LoggerFactory\n\nprivate const val API_URL = \"https://api.anthropic.com/v1/messages\"\n\nprivate val logger = LoggerFactory.getLogger(Claude::class.java)\n\nclass Claude(\n defaultModel: String = \"claude-3-5-sonnet-20240620\",\n httpClient: HttpClient = defaultHttpClient,\n private val apiKey: String,\n private val defaultTemperature: Float = 0.2f,\n private val defaultMaxTokens: Int = 1024,\n private val defaultImageDetail: String = \"high\",\n) : AI(defaultModel = defaultModel, httpClient = httpClient) {\n\n private val json = Json { ignoreUnknownKeys = true }\n\n override suspend fun chatCompletion(\n prompt: String,\n images: List,\n temperature: Float?,\n model: String?,\n maxTokens: Int?,\n imageDetail: String?,\n identifier: String?,\n jsonSchema: JsonObject?,\n ): CompletionData {\n val imagesBase64 = images.map { it.encodeBase64() }\n\n // Fallback to Anthropic defaults\n val actualTemperature = temperature ?: defaultTemperature\n val actualModel = model ?: defaultModel\n val actualMaxTokens = maxTokens ?: defaultMaxTokens\n val actualImageDetail = imageDetail ?: defaultImageDetail\n\n val imageContents = imagesBase64\n .map { imageBase64 ->\n Content(\n type = \"image\",\n source = ContentSource(\n type = \"base64\",\n mediaType = \"image/png\",\n data = imageBase64,\n ),\n )\n }\n\n val textContent = Content(type = \"text\", text = prompt)\n\n val chatCompletionRequest = Request(\n model = actualModel,\n maxTokens = actualMaxTokens,\n messages = listOf(Message(\"user\", imageContents + textContent)),\n )\n\n val response = try {\n val httpResponse = httpClient.post(API_URL) {\n contentType(ContentType.Application.Json)\n headers[\"x-api-key\"] = apiKey\n headers[\"anthropic-version\"] = \"2023-06-01\"\n setBody(json.encodeToString(chatCompletionRequest))\n }\n\n val body = httpResponse.bodyAsText()\n if (!httpResponse.status.isSuccess()) {\n logger.error(\"Failed to complete request to Anthropic: ${httpResponse.status}, $body\")\n throw Exception(\"Failed to complete request to Anthropic: ${httpResponse.status}, $body\")\n }\n\n if (httpResponse.status != HttpStatusCode.OK) {\n throw IllegalStateException(\"Call to Anthropic AI failed: $body\")\n }\n\n json.decodeFromString(httpResponse.bodyAsText())\n } catch (e: SerializationException) {\n logger.error(\"Failed to parse response from Anthropic\", e)\n throw e\n } catch (e: Exception) {\n logger.error(\"Failed to complete request to Anthropic\", e)\n throw e\n }\n\n return CompletionData(\n prompt = prompt,\n temperature = actualTemperature,\n maxTokens = actualMaxTokens,\n images = imagesBase64,\n model = actualModel,\n response = response.content.first().text!!,\n )\n }\n\n override fun close() = httpClient.close()\n}\n" }, { "path": "maestro-ai/src/main/java/maestro/ai/anthropic/Common.kt", "content": "package maestro.ai.anthropic\n\nimport kotlinx.serialization.SerialName\nimport kotlinx.serialization.Serializable\n\n@Serializable\ndata class Message(\n val role: String,\n val content: List,\n)\n\n@Serializable\ndata class Content(\n val type: String,\n val text: String? = null,\n val source: ContentSource? = null,\n)\n\n@Serializable\ndata class ContentSource(\n val type: String,\n @SerialName(\"media_type\") val mediaType: String,\n val data: String,\n)\n" }, { "path": "maestro-ai/src/main/java/maestro/ai/anthropic/Request.kt", "content": "package maestro.ai.anthropic\n\nimport kotlinx.serialization.SerialName\nimport kotlinx.serialization.Serializable\n\n@Serializable\ndata class Request(\n val model: String,\n @SerialName(\"max_tokens\") val maxTokens: Int,\n val messages: List,\n)\n" }, { "path": "maestro-ai/src/main/java/maestro/ai/anthropic/Response.kt", "content": "import kotlinx.serialization.Serializable\nimport maestro.ai.anthropic.Content\n\n@Serializable\ndata class Response(\n val content: List,\n)\n" }, { "path": "maestro-ai/src/main/java/maestro/ai/cloud/ApiClient.kt", "content": "package maestro.ai.cloud\n\nimport io.ktor.client.*\nimport io.ktor.client.plugins.*\nimport io.ktor.client.plugins.contentnegotiation.*\nimport io.ktor.client.request.*\nimport io.ktor.client.statement.*\nimport io.ktor.http.*\nimport kotlinx.serialization.Serializable\nimport kotlinx.serialization.SerializationException\nimport kotlinx.serialization.encodeToString\nimport kotlinx.serialization.json.Json\nimport maestro.ai.openai.OpenAI\nimport org.slf4j.LoggerFactory\n\nprivate val logger = LoggerFactory.getLogger(OpenAI::class.java)\n\n@Serializable\ndata class Defect(\n val category: String,\n val reasoning: String,\n)\n\n@Serializable\ndata class FindDefectsRequest(\n val assertion: String? = null,\n val screen: ByteArray,\n)\n\n@Serializable\ndata class FindDefectsResponse(\n val defects: List,\n)\n\n@Serializable\ndata class ExtractTextWithAiRequest(\n val query: String,\n val screen: ByteArray,\n)\n\n@Serializable\ndata class ExtractTextWithAiResponse(\n val text: String,\n)\n\nclass ApiClient {\n private val baseUrl by lazy {\n System.getenv(\"MAESTRO_CLOUD_API_URL\") ?: \"https://api.copilot.mobile.dev\"\n }\n\n private val json = Json { ignoreUnknownKeys = true }\n\n val httpClient = HttpClient {\n install(ContentNegotiation) {\n Json {\n ignoreUnknownKeys = true\n }\n }\n\n install(HttpTimeout) {\n connectTimeoutMillis = 10000\n socketTimeoutMillis = 60000\n requestTimeoutMillis = 60000\n }\n }\n\n suspend fun extractTextWithAi(\n apiKey: String,\n query: String,\n screen: ByteArray,\n ): ExtractTextWithAiResponse {\n val url = \"$baseUrl/v2/extract-text\"\n\n val response = try {\n val httpResponse = httpClient.post(url) {\n headers {\n append(HttpHeaders.Authorization, \"Bearer $apiKey\")\n append(HttpHeaders.ContentType, ContentType.Application.Json.toString()) // Explicitly set JSON content type\n }\n setBody(json.encodeToString(ExtractTextWithAiRequest(query, screen)))\n }\n\n val body = httpResponse.bodyAsText()\n if (!httpResponse.status.isSuccess()) {\n logger.error(\"Failed to complete request to Maestro Cloud: ${httpResponse.status}, $body\")\n throw Exception(\"Failed to complete request to Maestro Cloud: ${httpResponse.status}, $body\")\n }\n\n json.decodeFromString(body)\n } catch (e: SerializationException) {\n logger.error(\"Failed to parse response from Maestro Cloud\", e)\n throw e\n } catch (e: Exception) {\n logger.error(\"Failed to complete request to Maestro Cloud\", e)\n throw e\n }\n\n return response\n }\n\n suspend fun findDefects(\n apiKey: String,\n screen: ByteArray,\n assertion: String? = null,\n ): FindDefectsResponse {\n val url = \"$baseUrl/v2/find-defects\"\n\n val response = try {\n val httpResponse = httpClient.post(url) {\n headers {\n append(HttpHeaders.Authorization, \"Bearer $apiKey\")\n append(HttpHeaders.ContentType, ContentType.Application.Json.toString()) // Explicitly set JSON content type\n }\n setBody(json.encodeToString(FindDefectsRequest(assertion = assertion, screen = screen)))\n }\n\n val body = httpResponse.bodyAsText()\n if (!httpResponse.status.isSuccess()) {\n logger.error(\"Failed to complete request to Maestro Cloud: ${httpResponse.status}, $body\")\n throw Exception(\"Failed to complete request to Maestro Cloud: ${httpResponse.status}, $body\")\n }\n\n json.decodeFromString(body)\n } catch (e: SerializationException) {\n logger.error(\"Failed to parse response from Maestro Cloud\", e)\n throw e\n } catch (e: Exception) {\n logger.error(\"Failed to complete request to Maestro Cloud\", e)\n throw e\n }\n\n return response\n }\n\n}" }, { "path": "maestro-ai/src/main/java/maestro/ai/common/Image.kt", "content": "package maestro.ai.common\n\nimport kotlinx.serialization.Serializable\n\n@Serializable\ndata class Base64Image(\n val url: String,\n val detail: String,\n)\n" }, { "path": "maestro-ai/src/main/java/maestro/ai/openai/Client.kt", "content": "package maestro.ai.openai\n\nimport io.ktor.client.HttpClient\nimport io.ktor.client.request.post\nimport io.ktor.client.request.setBody\nimport io.ktor.client.statement.bodyAsText\nimport io.ktor.http.ContentType\nimport io.ktor.http.contentType\nimport io.ktor.http.isSuccess\nimport io.ktor.util.encodeBase64\nimport kotlinx.serialization.SerializationException\nimport kotlinx.serialization.encodeToString\nimport kotlinx.serialization.json.Json\nimport kotlinx.serialization.json.JsonObject\nimport maestro.ai.AI\nimport maestro.ai.CompletionData\nimport maestro.ai.common.Base64Image\nimport org.slf4j.LoggerFactory\n\nprivate const val API_URL = \"https://api.openai.com/v1/chat/completions\"\n\nprivate val logger = LoggerFactory.getLogger(OpenAI::class.java)\n\nclass OpenAI(\n defaultModel: String = \"gpt-4o\",\n httpClient: HttpClient = defaultHttpClient,\n private val apiKey: String,\n private val defaultTemperature: Float = 0.2f,\n private val defaultMaxTokens: Int = 1024,\n private val defaultImageDetail: String = \"high\",\n) : AI(defaultModel = defaultModel, httpClient = httpClient) {\n\n private val json = Json { ignoreUnknownKeys = true }\n\n override suspend fun chatCompletion(\n prompt: String,\n images: List,\n temperature: Float?,\n model: String?,\n maxTokens: Int?,\n imageDetail: String?,\n identifier: String?,\n jsonSchema: JsonObject?,\n ): CompletionData {\n val imagesBase64 = images.map { it.encodeBase64() }\n\n // Fallback to OpenAI defaults\n val actualTemperature = temperature ?: defaultTemperature\n val actualModel = model ?: defaultModel\n val actualMaxTokens = maxTokens ?: defaultMaxTokens\n val actualImageDetail = imageDetail ?: defaultImageDetail\n\n val imagesContent = imagesBase64.map { image ->\n ContentDetail(\n type = \"image_url\",\n imageUrl = Base64Image(url = \"data:image/png;base64,$image\", detail = actualImageDetail),\n )\n }\n val textContent = ContentDetail(type = \"text\", text = prompt)\n\n val messages = listOf(\n MessageContent(\n role = \"user\",\n content = imagesContent + textContent,\n )\n )\n\n val chatCompletionRequest = ChatCompletionRequest(\n model = actualModel,\n temperature = actualTemperature,\n messages = messages,\n maxTokens = actualMaxTokens,\n seed = 1566,\n responseFormat = if (jsonSchema == null) null else ResponseFormat(\n type = \"json_schema\",\n jsonSchema = jsonSchema,\n ),\n )\n\n val chatCompletionResponse = try {\n val httpResponse = httpClient.post(API_URL) {\n contentType(ContentType.Application.Json)\n headers[\"Authorization\"] = \"Bearer $apiKey\"\n setBody(json.encodeToString(chatCompletionRequest))\n }\n\n val body = httpResponse.bodyAsText()\n if (!httpResponse.status.isSuccess()) {\n logger.error(\"Failed to complete request to OpenAI: ${httpResponse.status}, $body\")\n throw Exception(\"Failed to complete request to OpenAI: ${httpResponse.status}, $body\")\n }\n\n json.decodeFromString(body)\n } catch (e: SerializationException) {\n logger.error(\"Failed to parse response from OpenAI\", e)\n throw e\n } catch (e: Exception) {\n logger.error(\"Failed to complete request to OpenAI\", e)\n throw e\n }\n\n return CompletionData(\n prompt = prompt,\n temperature = actualTemperature,\n maxTokens = actualMaxTokens,\n images = imagesBase64,\n model = actualModel,\n response = chatCompletionResponse.choices.first().message.content,\n )\n }\n\n override fun close() = httpClient.close()\n}\n" }, { "path": "maestro-ai/src/main/java/maestro/ai/openai/Request.kt", "content": "package maestro.ai.openai\n\nimport kotlinx.serialization.SerialName\nimport kotlinx.serialization.Serializable\nimport kotlinx.serialization.json.JsonObject\nimport maestro.ai.common.Base64Image\n\n@Serializable\ndata class ChatCompletionRequest(\n val model: String,\n val messages: List,\n val temperature: Float,\n @SerialName(\"max_tokens\") val maxTokens: Int,\n @SerialName(\"response_format\") val responseFormat: ResponseFormat?,\n val seed: Int,\n)\n\n@Serializable\nclass ResponseFormat(\n val type: String,\n @SerialName(\"json_schema\") val jsonSchema: JsonObject,\n)\n\n@Serializable\ndata class MessageContent(\n val role: String,\n val content: List,\n)\n\n@Serializable\ndata class ContentDetail(\n val type: String,\n val text: String? = null,\n @SerialName(\"image_url\") val imageUrl: Base64Image? = null,\n)\n" }, { "path": "maestro-ai/src/main/java/maestro/ai/openai/Response.kt", "content": "package maestro.ai.openai\n\nimport kotlinx.serialization.SerialName\nimport kotlinx.serialization.Serializable\n\n@Serializable\ndata class ChatCompletionResponse(\n val id: String,\n val `object`: String,\n val created: Long,\n val model: String,\n @SerialName(\"system_fingerprint\") val systemFingerprint: String? = null,\n val usage: Usage? = null,\n val choices: List,\n)\n\n@Serializable\ndata class Usage(\n @SerialName(\"prompt_tokens\") val promptTokens: Int,\n @SerialName(\"completion_tokens\") val completionTokens: Int? = null,\n @SerialName(\"total_tokens\") val totalTokens: Int,\n)\n\n@Serializable\ndata class Choice(\n val message: Message,\n @SerialName(\"finish_details\") val finishDetails: FinishDetails? = null,\n val index: Int,\n @SerialName(\"finish_reason\") val finishReason: String? = null,\n)\n\n@Serializable\ndata class Message(\n val role: String,\n val content: String,\n)\n\n@Serializable\ndata class FinishDetails(\n val type: String,\n val stop: String? = null,\n)\n" }, { "path": "maestro-ai/src/main/resources/askForDefects_schema.json", "content": "{\n \"name\": \"askForDefects\",\n \"description\": \"Returns a list of possible defects found in the mobile app's UI\",\n \"strict\": true,\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\"defects\"],\n \"additionalProperties\": false,\n \"properties\": {\n \"defects\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"required\": [\"category\", \"reasoning\"],\n \"additionalProperties\": false,\n \"properties\": {\n \"category\": {\n \"type\": \"string\",\n \"enum\": [\n \"layout\",\n \"localization\"\n ]\n },\n \"reasoning\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n }\n}\n" }, { "path": "maestro-ai/src/main/resources/extractText_schema.json", "content": "{\n \"name\": \"extractText\",\n \"description\": \"Extracts text from an image based on a given query\",\n \"strict\": true,\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"text\"\n ],\n \"additionalProperties\": false,\n \"properties\": {\n \"text\": {\n \"type\": \"string\"\n }\n }\n }\n}" }, { "path": "maestro-android/build.gradle.kts", "content": "import org.jetbrains.kotlin.config.JvmTarget\n\nplugins {\n alias(libs.plugins.android.application)\n alias(libs.plugins.kotlin.android)\n alias(libs.plugins.protobuf)\n}\n\nprotobuf {\n protoc {\n artifact = \"com.google.protobuf:protoc:${libs.versions.googleProtobuf.get()}\"\n }\n\n plugins {\n create(\"grpc\") {\n artifact = \"io.grpc:protoc-gen-grpc-java:${libs.versions.grpc.get()}\"\n }\n }\n\n generateProtoTasks {\n all().forEach { task ->\n task.plugins {\n create(\"grpc\") { option(\"lite\") }\n }\n\n task.builtins {\n create(\"java\") { option(\"lite\") }\n create(\"kotlin\") { option(\"lite\") }\n }\n }\n }\n}\n\nkotlin.sourceSets.configureEach {\n // Prevent build warnings for grpc's generated opt-in code\n languageSettings.optIn(\"kotlin.RequiresOptIn\")\n}\n\nandroid {\n namespace = \"dev.mobile.maestro\"\n compileSdk = 34\n\n defaultConfig {\n applicationId = \"dev.mobile.maestro\"\n minSdk = 24\n targetSdk = 34\n versionCode = 1\n versionName = \"1.0\"\n testInstrumentationRunner = \"androidx.test.runner.AndroidJUnitRunner\"\n }\n\n buildTypes {\n named(\"release\") {\n isMinifyEnabled = false\n\n proguardFiles(\n getDefaultProguardFile(\"proguard-android-optimize.txt\"),\n \"proguard-rules.pro\",\n )\n }\n\n named(\"debug\") {\n signingConfig = signingConfigs.getByName(\"debug\")\n }\n }\n\n signingConfigs {\n named(\"debug\") {\n storeFile = file(\"../debug.keystore\")\n }\n }\n\n compileOptions {\n sourceCompatibility = JavaVersion.VERSION_17\n targetCompatibility = JavaVersion.VERSION_17\n }\n\n kotlinOptions {\n jvmTarget = \"17\"\n }\n\n packaging {\n resources {\n excludes += listOf(\"META-INF/INDEX.LIST\", \"META-INF/io.netty.versions.properties\")\n }\n }\n}\n\ntasks.register(\"copyMaestroAndroid\") {\n val maestroAndroidApkPath = \"outputs/apk/debug/maestro-android-debug.apk\"\n val maestroAndroidApkDest = \"../../maestro-client/src/main/resources\"\n val maestroAndroidApkDestPath = \"../../maestro-client/src/main/resources/maestro-android-debug.apk\"\n\n from(layout.buildDirectory.dir(maestroAndroidApkPath))\n into(layout.buildDirectory.file(maestroAndroidApkDest))\n\n doLast {\n if (!layout.buildDirectory.file(maestroAndroidApkDestPath).get().asFile.exists()) {\n throw GradleException(\"Error: Input source for copyMaestroAndroid doesn't exist\")\n }\n\n File(\"./maestro-client/src/main/resources/maestro-android-debug.apk\").renameTo(File(\"./maestro-client/src/main/resources/maestro-app.apk\"))\n }\n}\n\ntasks.register(\"copyMaestroServer\") {\n val maestroServerApkPath = \"outputs/apk/androidTest/debug/maestro-android-debug-androidTest.apk\"\n val maestroServerApkDest = \"../../maestro-client/src/main/resources\"\n val maestroServerApkDestPath = \"../../maestro-client/src/main/resources/maestro-android-debug-androidTest.apk\"\n\n from(layout.buildDirectory.dir(maestroServerApkPath))\n into(layout.buildDirectory.file(maestroServerApkDest))\n\n doLast {\n if (!layout.buildDirectory.file(maestroServerApkDestPath).get().asFile.exists()) {\n throw GradleException(\"Error: Input source for copyMaestroServer doesn't exist\")\n }\n\n File(\"./maestro-client/src/main/resources/maestro-android-debug-androidTest.apk\").renameTo(File(\"./maestro-client/src/main/resources/maestro-server.apk\"))\n }\n}\n\ntasks.named(\"assemble\") {\n // lint.enabled = false\n // lintVitalRelease.enabled = false\n finalizedBy(\"copyMaestroAndroid\")\n}\n\ntasks.named(\"assembleAndroidTest\") {\n // lint.enabled = false\n // lintVitalRelease.enabled = false\n finalizedBy(\"copyMaestroServer\")\n}\n\nsourceSets {\n create(\"generated\") {\n java {\n srcDirs(\n \"build/generated/source/proto/main/grpc\",\n \"build/generated/source/proto/main/java\",\n \"build/generated/source/proto/main/kotlin\",\n )\n }\n }\n}\n\ndependencies {\n protobuf(project(\":maestro-proto\"))\n\n implementation(libs.grpc.kotlin.stub)\n implementation(libs.grpc.netty.shaded)\n implementation(libs.grpc.stub)\n implementation(libs.grpc.protobuf.lite)\n implementation(libs.grpc.okhttp)\n implementation(libs.google.protobuf.kotlin.lite)\n\n implementation(libs.ktor.server.core)\n implementation(libs.ktor.server.cio)\n implementation(libs.ktor.server.content.negotiation)\n implementation(libs.ktor.serial.gson)\n\n implementation(libs.commons.lang3)\n implementation(libs.hiddenapibypass)\n\n androidTestImplementation(libs.gmsLocation)\n implementation(libs.gmsLocation)\n\n androidTestImplementation(libs.androidx.test.junit)\n androidTestImplementation(libs.androidx.espresso.core)\n androidTestImplementation(libs.androidx.uiautomator)\n androidTestImplementation(libs.kotlin.retry)\n}\n" }, { "path": "maestro-android/src/androidTest/AndroidManifest.xml", "content": "\n\n\n \n \n \n \n\n\n \n \n \n" }, { "path": "maestro-android/src/androidTest/java/androidx/test/uiautomator/UiDeviceExt.kt", "content": "package androidx.test.uiautomator\n\nobject UiDeviceExt {\n\n /**\n * Fix for a UiDevice.click() method that discards taps that happen outside of the screen bounds.\n * The issue with the original method is that it was computing screen bounds incorrectly.\n */\n fun UiDevice.clickExt(x: Int, y: Int) {\n interactionController.clickNoSync(\n x, y\n )\n }\n\n}" }, { "path": "maestro-android/src/androidTest/java/dev/mobile/maestro/AccessibilityNodeInfoExt.kt", "content": "package dev.mobile.maestro\n\nimport android.os.Build\nimport android.view.accessibility.AccessibilityNodeInfo\n\nobject AccessibilityNodeInfoExt {\n\n /**\n * Retrieves the hint text associated with this [android.view.accessibility.AccessibilityNodeInfo].\n *\n * If the device API level is below 26 (Oreo) or the hint text is null, this function provides a fallback\n * by returning an empty CharSequence instead.\n *\n * @return [CharSequence] representing the hint text or its fallback.\n */\n fun AccessibilityNodeInfo.getHintOrFallback(): CharSequence {\n return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O && this.hintText != null) {\n this.hintText\n } else {\n \"\"\n }\n }\n\n}\n" }, { "path": "maestro-android/src/androidTest/java/dev/mobile/maestro/MaestroDriverService.kt", "content": "package dev.mobile.maestro\n\nimport android.app.UiAutomation\nimport android.content.Context\nimport android.content.Context.LOCATION_SERVICE\nimport android.location.Criteria\nimport android.location.Location\nimport android.location.LocationManager\nimport android.os.Build\nimport android.os.SystemClock\nimport android.util.DisplayMetrics\nimport android.util.Log\nimport android.view.KeyEvent.KEYCODE_1\nimport android.view.KeyEvent.KEYCODE_4\nimport android.view.KeyEvent.KEYCODE_5\nimport android.view.KeyEvent.KEYCODE_6\nimport android.view.KeyEvent.KEYCODE_7\nimport android.view.KeyEvent.KEYCODE_APOSTROPHE\nimport android.view.KeyEvent.KEYCODE_AT\nimport java.util.concurrent.TimeUnit\nimport android.view.KeyEvent.KEYCODE_BACKSLASH\nimport android.view.KeyEvent.KEYCODE_COMMA\nimport android.view.KeyEvent.KEYCODE_EQUALS\nimport android.view.KeyEvent.KEYCODE_GRAVE\nimport android.view.KeyEvent.KEYCODE_LEFT_BRACKET\nimport android.view.KeyEvent.KEYCODE_MINUS\nimport android.view.KeyEvent.KEYCODE_NUMPAD_ADD\nimport android.view.KeyEvent.KEYCODE_NUMPAD_LEFT_PAREN\nimport android.view.KeyEvent.KEYCODE_NUMPAD_RIGHT_PAREN\nimport android.view.KeyEvent.KEYCODE_PERIOD\nimport android.view.KeyEvent.KEYCODE_POUND\nimport android.view.KeyEvent.KEYCODE_RIGHT_BRACKET\nimport android.view.KeyEvent.KEYCODE_SEMICOLON\nimport android.view.KeyEvent.KEYCODE_SLASH\nimport android.view.KeyEvent.KEYCODE_SPACE\nimport android.view.KeyEvent.KEYCODE_STAR\nimport android.view.KeyEvent.META_SHIFT_LEFT_ON\nimport android.view.WindowManager\nimport androidx.test.ext.junit.runners.AndroidJUnit4\nimport androidx.test.platform.app.InstrumentationRegistry\nimport androidx.test.uiautomator.Configurator\nimport androidx.test.uiautomator.UiDevice\nimport androidx.test.uiautomator.UiDeviceExt.clickExt\nimport com.google.android.gms.location.LocationServices\nimport dev.mobile.maestro.location.FusedLocationProvider\nimport dev.mobile.maestro.location.LocationManagerProvider\nimport dev.mobile.maestro.location.MockLocationProvider\nimport dev.mobile.maestro.location.PlayServices\nimport dev.mobile.maestro.screenshot.ScreenshotException\nimport dev.mobile.maestro.screenshot.ScreenshotService\nimport io.grpc.Metadata\nimport io.grpc.Status\nimport io.grpc.StatusRuntimeException\nimport io.grpc.netty.shaded.io.grpc.netty.NettyServerBuilder\nimport io.grpc.stub.StreamObserver\nimport maestro_android.MaestroAndroid\nimport maestro_android.MaestroDriverGrpc\nimport maestro_android.addMediaResponse\nimport maestro_android.checkWindowUpdatingResponse\nimport maestro_android.deviceInfo\nimport maestro_android.emptyResponse\nimport maestro_android.eraseAllTextResponse\nimport maestro_android.inputTextResponse\nimport maestro_android.launchAppResponse\nimport maestro_android.screenshotResponse\nimport maestro_android.setLocationResponse\nimport maestro_android.tapResponse\nimport maestro_android.viewHierarchyResponse\nimport org.junit.Test\nimport org.junit.runner.RunWith\nimport java.io.ByteArrayOutputStream\nimport java.io.OutputStream\nimport java.util.Timer\nimport java.util.TimerTask\nimport kotlin.system.measureTimeMillis\n\n/**\n * Instrumented test, which will execute on an Android device.\n *\n * See [testing documentation](http://d.android.com/tools/testing).\n */\n@RunWith(AndroidJUnit4::class)\nclass MaestroDriverService {\n\n @Test\n fun grpcServer() {\n Configurator.getInstance()\n .setActionAcknowledgmentTimeout(0L)\n .setWaitForIdleTimeout(0L)\n .setWaitForSelectorTimeout(0L)\n\n val instrumentation = InstrumentationRegistry.getInstrumentation()\n val uiDevice = UiDevice.getInstance(instrumentation)\n val uiAutomation = instrumentation.uiAutomation\n\n val port = InstrumentationRegistry.getArguments().getString(\"port\", \"7001\").toInt()\n\n println(\"Server running on port [ $port ]\")\n\n NettyServerBuilder.forPort(port)\n .addService(Service(uiDevice, uiAutomation))\n .permitKeepAliveTime(30, TimeUnit.SECONDS) // If a client pings more than once every 30 seconds, terminate the connection\n .permitKeepAliveWithoutCalls(true) // Allow pings even when there are no active streams.\n .keepAliveTimeout(20, TimeUnit.SECONDS) // wait 20 seconds for client to ack the keep alive\n .maxConnectionIdle(30, TimeUnit.MINUTES) // If a client is idle for 30 minutes, send a GOAWAY frame.\n .build()\n .start()\n\n while (!Thread.interrupted()) {\n Thread.sleep(100)\n }\n }\n}\n\nclass Service(\n private val uiDevice: UiDevice,\n private val uiAutomation: UiAutomation,\n) : MaestroDriverGrpc.MaestroDriverImplBase() {\n\n private var locationTimerTask : TimerTask? = null\n private val locationTimer = Timer()\n\n private val screenshotService = ScreenshotService()\n private val mockLocationProviderList = mutableListOf()\n private val toastAccessibilityListener = ToastAccessibilityListener.start(uiAutomation)\n\n companion object {\n private const val TAG = \"Maestro\"\n private const val UPDATE_INTERVAL_IN_MILLIS = 2000L\n\n private val ERROR_TYPE_KEY: Metadata.Key =\n Metadata.Key.of(\"error-type\", Metadata.ASCII_STRING_MARSHALLER)\n private val ERROR_MSG_KEY: Metadata.Key =\n Metadata.Key.of(\"error-message\", Metadata.ASCII_STRING_MARSHALLER)\n private val ERROR_CAUSE_KEY: Metadata.Key =\n Metadata.Key.of(\"error-cause\", Metadata.ASCII_STRING_MARSHALLER)\n }\n\n override fun launchApp(\n request: MaestroAndroid.LaunchAppRequest,\n responseObserver: StreamObserver\n ) {\n try {\n val context = InstrumentationRegistry.getInstrumentation().targetContext\n\n val intent = context.packageManager.getLaunchIntentForPackage(request.packageName)\n\n if (intent == null) {\n Log.e(\"Maestro\", \"No launcher intent found for package ${request.packageName}\")\n responseObserver.onError(RuntimeException(\"No launcher intent found for package ${request.packageName}\"))\n return\n }\n\n request.argumentsList\n .forEach {\n when (it.type) {\n String::class.java.name -> intent.putExtra(it.key, it.value)\n Boolean::class.java.name -> intent.putExtra(it.key, it.value.toBoolean())\n Int::class.java.name -> intent.putExtra(it.key, it.value.toInt())\n Double::class.java.name -> intent.putExtra(it.key, it.value.toDouble())\n Long::class.java.name -> intent.putExtra(it.key, it.value.toLong())\n else -> intent.putExtra(it.key, it.value)\n }\n }\n context.startActivity(intent)\n\n responseObserver.onNext(launchAppResponse { })\n responseObserver.onCompleted()\n } catch (t: Throwable) {\n responseObserver.onError(t.internalError())\n }\n }\n\n override fun deviceInfo(\n request: MaestroAndroid.DeviceInfoRequest,\n responseObserver: StreamObserver\n ) {\n try {\n val windowManager = InstrumentationRegistry.getInstrumentation()\n .context\n .getSystemService(Context.WINDOW_SERVICE) as WindowManager\n\n val displayMetrics = DisplayMetrics()\n windowManager.defaultDisplay.getRealMetrics(displayMetrics)\n\n responseObserver.onNext(\n deviceInfo {\n widthPixels = displayMetrics.widthPixels\n heightPixels = displayMetrics.heightPixels\n }\n )\n responseObserver.onCompleted()\n } catch (t: Throwable) {\n responseObserver.onError(t.internalError())\n }\n }\n\n override fun viewHierarchy(\n request: MaestroAndroid.ViewHierarchyRequest,\n responseObserver: StreamObserver\n ) {\n try {\n refreshAccessibilityCache()\n val stream = ByteArrayOutputStream()\n\n val ms = measureTimeMillis {\n if (toastAccessibilityListener.getToastAccessibilityNode() != null && !toastAccessibilityListener.isTimedOut()) {\n Log.d(\"Maestro\", \"Requesting view hierarchy with toast\")\n ViewHierarchy.dump(\n uiDevice,\n uiAutomation,\n stream,\n toastAccessibilityListener.getToastAccessibilityNode()\n )\n } else {\n Log.d(\"Maestro\", \"Requesting view hierarchy\")\n ViewHierarchy.dump(\n uiDevice,\n uiAutomation,\n stream\n )\n }\n }\n Log.d(\"Maestro\", \"View hierarchy received in $ms ms\")\n\n responseObserver.onNext(\n viewHierarchyResponse {\n hierarchy = stream.toString(Charsets.UTF_8.name())\n }\n )\n responseObserver.onCompleted()\n } catch (t: Throwable) {\n responseObserver.onError(t.internalError())\n }\n }\n\n /**\n * Clears the in-process Accessibility cache, removing any stale references. Because the\n * AccessibilityInteractionClient singleton stores copies of AccessibilityNodeInfo instances,\n * calls to public APIs such as `recycle` do not guarantee cached references get updated.\n */\n private fun refreshAccessibilityCache() {\n try {\n uiDevice.waitForIdle(500)\n uiAutomation.serviceInfo = null\n } catch (nullExp: NullPointerException) {\n /* no-op */\n }\n }\n\n override fun tap(\n request: MaestroAndroid.TapRequest,\n responseObserver: StreamObserver\n ) {\n try {\n uiDevice.clickExt(\n request.x,\n request.y\n )\n\n responseObserver.onNext(tapResponse {})\n responseObserver.onCompleted()\n } catch (t: Throwable) {\n responseObserver.onError(t.internalError())\n }\n }\n\n override fun addMedia(responseObserver: StreamObserver): StreamObserver {\n return object : StreamObserver {\n\n var outputStream: OutputStream? = null\n\n override fun onNext(value: MaestroAndroid.AddMediaRequest) {\n if (outputStream == null) {\n outputStream = MediaStorage.getOutputStream(\n value.mediaName,\n value.mediaExt\n )\n }\n value.payload.data.writeTo(outputStream)\n }\n\n override fun onError(t: Throwable) {\n responseObserver.onError(t.internalError())\n }\n\n override fun onCompleted() {\n responseObserver.onNext(addMediaResponse { })\n responseObserver.onCompleted()\n }\n\n }\n }\n\n override fun eraseAllText(\n request: MaestroAndroid.EraseAllTextRequest,\n responseObserver: StreamObserver\n ) {\n try {\n val charactersToErase = request.charactersToErase\n Log.d(\"Maestro\", \"Erasing text $charactersToErase\")\n\n for (i in 1..charactersToErase) {\n uiDevice.pressDelete()\n }\n\n responseObserver.onNext(eraseAllTextResponse { })\n responseObserver.onCompleted()\n } catch (t: Throwable) {\n responseObserver.onError(t.internalError())\n }\n }\n\n override fun inputText(\n request: MaestroAndroid.InputTextRequest,\n responseObserver: StreamObserver\n ) {\n try {\n Log.d(\"Maestro\", \"Inputting text\")\n request.text.forEach {\n setText(it.toString())\n Thread.sleep(75)\n }\n\n responseObserver.onNext(inputTextResponse { })\n responseObserver.onCompleted()\n } catch (e: Throwable) {\n responseObserver.onError(e.internalError())\n }\n }\n\n override fun screenshot(\n request: MaestroAndroid.ScreenshotRequest,\n responseObserver: StreamObserver\n ) {\n try {\n val bitmap = screenshotService.takeScreenshotWithRetry { uiAutomation.takeScreenshot() }\n val bytes = screenshotService.encodePng(bitmap)\n responseObserver.onNext(screenshotResponse { this.bytes = bytes })\n responseObserver.onCompleted()\n } catch (e: NullPointerException) {\n Log.e(TAG, \"Screenshot failed with NullPointerException: ${e.message}\", e)\n responseObserver.onError(e.internalError())\n } catch (e: ScreenshotException) {\n Log.e(TAG, \"Screenshot failed with ScreenshotException: ${e.message}\", e)\n responseObserver.onError(e.internalError())\n } catch (e: Exception) {\n Log.e(TAG, \"Screenshot failed with: ${e.message}\", e)\n responseObserver.onError(e.internalError())\n }\n }\n\n override fun isWindowUpdating(\n request: MaestroAndroid.CheckWindowUpdatingRequest,\n responseObserver: StreamObserver\n ) {\n try {\n responseObserver.onNext(checkWindowUpdatingResponse {\n isWindowUpdating = uiDevice.waitForWindowUpdate(request.appId, 500)\n })\n responseObserver.onCompleted()\n } catch (e: Throwable) {\n responseObserver.onError(e.internalError())\n }\n }\n\n override fun disableLocationUpdates(\n request: MaestroAndroid.EmptyRequest,\n responseObserver: StreamObserver\n ) {\n try {\n Log.d(TAG, \"[Start] Disabling location updates\")\n locationTimerTask?.cancel()\n locationTimer.cancel()\n mockLocationProviderList.forEach {\n it.disable()\n }\n Log.d(TAG, \"[Done] Disabling location updates\")\n responseObserver.onNext(emptyResponse { })\n responseObserver.onCompleted()\n } catch (exception: Exception) {\n responseObserver.onError(exception.internalError())\n }\n }\n\n override fun enableMockLocationProviders(\n request: MaestroAndroid.EmptyRequest,\n responseObserver: StreamObserver\n ) {\n try {\n Log.d(TAG, \"[Start] Enabling mock location providers\")\n val context = InstrumentationRegistry.getInstrumentation().targetContext\n val locationManager = context.getSystemService(LOCATION_SERVICE) as LocationManager\n\n mockLocationProviderList.addAll(\n createMockProviders(context, locationManager)\n )\n\n mockLocationProviderList.forEach {\n it.enable()\n }\n Log.d(TAG, \"[Done] Enabling mock location providers\")\n\n responseObserver.onNext(emptyResponse { })\n responseObserver.onCompleted()\n } catch (exception: Exception) {\n Log.e(TAG, \"Error while enabling mock location provider\", exception)\n responseObserver.onError(exception.internalError())\n }\n }\n\n private fun createMockProviders(\n context: Context,\n locationManager: LocationManager\n ): List {\n val playServices = PlayServices()\n val fusedLocationProvider: MockLocationProvider? = if (playServices.isAvailable(context)) {\n val fusedLocationProviderClient =\n LocationServices.getFusedLocationProviderClient(context)\n FusedLocationProvider(fusedLocationProviderClient)\n } else {\n null\n }\n return (locationManager.allProviders.mapNotNull {\n if (it.equals(LocationManager.PASSIVE_PROVIDER)) {\n null\n } else {\n val mockProvider = createLocationManagerMockProvider(locationManager, it)\n mockProvider\n }\n } + fusedLocationProvider).mapNotNull { it }\n }\n\n private fun createLocationManagerMockProvider(\n locationManager: LocationManager,\n providerName: String?\n ): MockLocationProvider? {\n if (providerName == null) {\n return null\n }\n // API level check for existence of provider properties\n if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {\n // API level 31 and above\n val providerProperties =\n locationManager.getProviderProperties(providerName) ?: return null\n return LocationManagerProvider(\n locationManager,\n providerName,\n providerProperties.hasNetworkRequirement(),\n providerProperties.hasSatelliteRequirement(),\n providerProperties.hasCellRequirement(),\n providerProperties.hasMonetaryCost(),\n providerProperties.hasAltitudeSupport(),\n providerProperties.hasSpeedSupport(),\n providerProperties.hasBearingSupport(),\n providerProperties.powerUsage,\n providerProperties.accuracy\n )\n }\n val provider = locationManager.getProvider(providerName) ?: return null\n return LocationManagerProvider(\n locationManager,\n provider.name,\n provider.requiresNetwork(),\n provider.requiresSatellite(),\n provider.requiresCell(),\n provider.hasMonetaryCost(),\n provider.supportsAltitude(),\n provider.supportsSpeed(),\n provider.supportsBearing(),\n provider.powerRequirement,\n provider.accuracy\n )\n }\n\n\n override fun setLocation(\n request: MaestroAndroid.SetLocationRequest,\n responseObserver: StreamObserver\n ) {\n try {\n if (locationTimerTask != null) {\n locationTimerTask?.cancel()\n }\n\n locationTimerTask = object : TimerTask() {\n override fun run() {\n mockLocationProviderList.forEach {\n val latitude = request.latitude\n val longitude = request.longitude\n Log.d(TAG, \"Setting location latitude: $latitude and longitude: $longitude for ${it.getProviderName()}\")\n val location = Location(it.getProviderName()).apply {\n setLatitude(latitude)\n setLongitude(longitude)\n accuracy = Criteria.ACCURACY_FINE.toFloat()\n altitude = 0.0\n time = System.currentTimeMillis()\n elapsedRealtimeNanos = SystemClock.elapsedRealtimeNanos()\n }\n it.setLocation(location)\n }\n }\n }\n locationTimer.schedule(\n locationTimerTask,\n 0,\n UPDATE_INTERVAL_IN_MILLIS\n )\n responseObserver.onNext(setLocationResponse { })\n responseObserver.onCompleted()\n } catch (t: Throwable) {\n responseObserver.onError(t.internalError())\n }\n }\n\n private fun setText(text: String) {\n for (element in text) {\n Log.d(\"Maestro\", element.code.toString())\n when (element.code) {\n in 48..57 -> {\n /** 0~9 **/\n uiDevice.pressKeyCode(element.code - 41)\n }\n\n in 65..90 -> {\n /** A~Z **/\n uiDevice.pressKeyCode(element.code - 36, 1)\n }\n\n in 97..122 -> {\n /** a~z **/\n uiDevice.pressKeyCode(element.code - 68)\n }\n\n ';'.code -> uiDevice.pressKeyCode(KEYCODE_SEMICOLON)\n '='.code -> uiDevice.pressKeyCode(KEYCODE_EQUALS)\n ','.code -> uiDevice.pressKeyCode(KEYCODE_COMMA)\n '-'.code -> uiDevice.pressKeyCode(KEYCODE_MINUS)\n '.'.code -> uiDevice.pressKeyCode(KEYCODE_PERIOD)\n '/'.code -> uiDevice.pressKeyCode(KEYCODE_SLASH)\n '`'.code -> uiDevice.pressKeyCode(KEYCODE_GRAVE)\n '\\''.code -> uiDevice.pressKeyCode(KEYCODE_APOSTROPHE)\n '['.code -> uiDevice.pressKeyCode(KEYCODE_LEFT_BRACKET)\n ']'.code -> uiDevice.pressKeyCode(KEYCODE_RIGHT_BRACKET)\n '\\\\'.code -> uiDevice.pressKeyCode(KEYCODE_BACKSLASH)\n ' '.code -> uiDevice.pressKeyCode(KEYCODE_SPACE)\n '@'.code -> uiDevice.pressKeyCode(KEYCODE_AT)\n '#'.code -> uiDevice.pressKeyCode(KEYCODE_POUND)\n '*'.code -> uiDevice.pressKeyCode(KEYCODE_STAR)\n '('.code -> uiDevice.pressKeyCode(KEYCODE_NUMPAD_LEFT_PAREN)\n ')'.code -> uiDevice.pressKeyCode(KEYCODE_NUMPAD_RIGHT_PAREN)\n '+'.code -> uiDevice.pressKeyCode(KEYCODE_NUMPAD_ADD)\n '!'.code -> keyPressShiftedToEvents(uiDevice, KEYCODE_1)\n '$'.code -> keyPressShiftedToEvents(uiDevice, KEYCODE_4)\n '%'.code -> keyPressShiftedToEvents(uiDevice, KEYCODE_5)\n '^'.code -> keyPressShiftedToEvents(uiDevice, KEYCODE_6)\n '&'.code -> keyPressShiftedToEvents(uiDevice, KEYCODE_7)\n '\"'.code -> keyPressShiftedToEvents(uiDevice, KEYCODE_APOSTROPHE)\n '{'.code -> keyPressShiftedToEvents(uiDevice, KEYCODE_LEFT_BRACKET)\n '}'.code -> keyPressShiftedToEvents(uiDevice, KEYCODE_RIGHT_BRACKET)\n ':'.code -> keyPressShiftedToEvents(uiDevice, KEYCODE_SEMICOLON)\n '|'.code -> keyPressShiftedToEvents(uiDevice, KEYCODE_BACKSLASH)\n '<'.code -> keyPressShiftedToEvents(uiDevice, KEYCODE_COMMA)\n '>'.code -> keyPressShiftedToEvents(uiDevice, KEYCODE_PERIOD)\n '?'.code -> keyPressShiftedToEvents(uiDevice, KEYCODE_SLASH)\n '~'.code -> keyPressShiftedToEvents(uiDevice, KEYCODE_GRAVE)\n '_'.code -> keyPressShiftedToEvents(uiDevice, KEYCODE_MINUS)\n }\n }\n }\n\n private fun keyPressShiftedToEvents(uiDevice: UiDevice, keyCode: Int) {\n uiDevice.pressKeyCode(keyCode, META_SHIFT_LEFT_ON)\n }\n\n internal fun Throwable.internalError(): StatusRuntimeException {\n val trailers = Metadata().apply {\n put(ERROR_TYPE_KEY, this@internalError::class.java.name)\n this@internalError.message?.let { put(ERROR_MSG_KEY, it) }\n this@internalError.cause?.let { put(ERROR_CAUSE_KEY, it.toString()) }\n }\n return Status.INTERNAL.withDescription(message).asRuntimeException(trailers)\n }\n\n enum class FileType(val ext: String, val mimeType: String) {\n JPG(\"jpg\", \"image/jpg\"),\n JPEG(\"jpeg\", \"image/jpeg\"),\n PNG(\"png\", \"image/png\"),\n GIF(\"gif\", \"image/gif\"),\n MP4(\"mp4\", \"video/mp4\"),\n }\n}\n" }, { "path": "maestro-android/src/androidTest/java/dev/mobile/maestro/Media.kt", "content": "package dev.mobile.maestro\n\nimport android.content.ContentValues\nimport android.provider.MediaStore\nimport androidx.test.platform.app.InstrumentationRegistry\nimport java.io.OutputStream\n\nobject MediaStorage {\n\n fun getOutputStream(mediaName: String, mediaExt: String): OutputStream? {\n val uri = when (mediaExt) {\n Service.FileType.JPG.ext,\n Service.FileType.PNG.ext,\n Service.FileType.GIF.ext,\n Service.FileType.JPEG.ext -> MediaStore.Images.Media.EXTERNAL_CONTENT_URI\n Service.FileType.MP4.ext -> MediaStore.Video.Media.EXTERNAL_CONTENT_URI\n else -> throw IllegalStateException(\"mime .$mediaExt not yet supported\")\n }\n val ext = Service.FileType.values().first { it.ext == mediaExt }\n val contentValues = ContentValues()\n contentValues.apply {\n put(MediaStore.MediaColumns.DISPLAY_NAME, mediaName)\n put(MediaStore.MediaColumns.MIME_TYPE, ext.mimeType)\n }\n val contentResolver = InstrumentationRegistry.getInstrumentation().targetContext.contentResolver\n val outputStream = contentResolver.insert(uri, contentValues)?.let {\n contentResolver.openOutputStream(it)\n }\n return outputStream\n }\n}" }, { "path": "maestro-android/src/androidTest/java/dev/mobile/maestro/ToastAccessibilityListener.kt", "content": "package dev.mobile.maestro\n\nimport android.app.UiAutomation\nimport android.os.Build\nimport android.util.Log\nimport android.view.accessibility.AccessibilityEvent\nimport android.view.accessibility.AccessibilityNodeInfo\nimport android.widget.Toast\nimport kotlin.reflect.jvm.jvmName\n\nobject ToastAccessibilityListener : UiAutomation.OnAccessibilityEventListener {\n\n private var toastNode: AccessibilityNodeInfo? = null\n private var isListening = false\n private var recentToastTimeMillis: Long = 0\n\n private const val TOAST_LENGTH_LONG_DURATION = 3500\n\n override fun onAccessibilityEvent(accessibilityEvent: AccessibilityEvent) {\n if (\n accessibilityEvent.eventType == AccessibilityEvent.TYPE_NOTIFICATION_STATE_CHANGED &&\n accessibilityEvent.className.toString().contains(Toast::class.jvmName)\n ) {\n recentToastTimeMillis = System.currentTimeMillis()\n // Constructor for AccessibilityNodeInfo is only available on Android API 30+\n val nodeInfo = if (Build.VERSION.SDK_INT < 30) {\n AccessibilityNodeInfo.obtain()\n } else {\n AccessibilityNodeInfo()\n }\n toastNode = nodeInfo.apply {\n text = accessibilityEvent.text.first().toString()\n className = Toast::class.jvmName\n isVisibleToUser = true\n viewIdResourceName = \"\"\n packageName = \"\"\n isCheckable = false\n isChecked = accessibilityEvent.isChecked\n isClickable = false\n isEnabled = accessibilityEvent.isEnabled\n Log.d(\"Maestro\", \"Toast received with $text\")\n }\n }\n }\n\n fun getToastAccessibilityNode() = toastNode\n\n fun isTimedOut(): Boolean {\n return System.currentTimeMillis() - recentToastTimeMillis > TOAST_LENGTH_LONG_DURATION\n }\n\n fun start(uiAutomation: UiAutomation): ToastAccessibilityListener {\n if (isListening) return this\n uiAutomation.setOnAccessibilityEventListener(this)\n isListening = true\n Log.d(\"Maestro\", \"Started listening to accessibility events\")\n return this\n }\n\n fun stop() {\n isListening = false\n Log.d(\"Maestro\", \"Stopped listening to accessibility events\")\n }\n}" }, { "path": "maestro-android/src/androidTest/java/dev/mobile/maestro/ViewHierarchy.kt", "content": "package dev.mobile.maestro\n\nimport android.app.UiAutomation\nimport android.content.Context\nimport android.graphics.Rect\nimport android.os.Build\nimport android.util.DisplayMetrics\nimport android.util.Log\nimport android.util.Xml\nimport android.view.WindowManager\nimport android.view.accessibility.AccessibilityNodeInfo\nimport android.widget.GridLayout\nimport android.widget.GridView\nimport android.widget.ListView\nimport android.widget.TableLayout\nimport androidx.test.platform.app.InstrumentationRegistry\nimport androidx.test.uiautomator.UiDevice\nimport dev.mobile.maestro.AccessibilityNodeInfoExt.getHintOrFallback\nimport org.xmlpull.v1.XmlSerializer\nimport java.io.IOException\nimport java.io.OutputStream\n\n// Logic largely copied from AccessibilityNodeInfoDumper with some modifications\nobject ViewHierarchy {\n\n private const val LOGTAG = \"Maestro\"\n\n fun dump(\n device: UiDevice,\n uiAutomation: UiAutomation,\n out: OutputStream,\n toastNode: AccessibilityNodeInfo? = null\n ) {\n val windowManager = InstrumentationRegistry.getInstrumentation()\n .context\n .getSystemService(Context.WINDOW_SERVICE) as WindowManager\n\n val displayRect = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {\n windowManager.currentWindowMetrics.bounds\n } else {\n val displayMetrics = DisplayMetrics()\n windowManager.defaultDisplay.getRealMetrics(displayMetrics)\n Rect(0, 0, displayMetrics.widthPixels, displayMetrics.heightPixels)\n }\n\n\n val serializer = Xml.newSerializer()\n serializer.setFeature(\"http://xmlpull.org/v1/doc/features.html#indent-output\", true)\n serializer.setOutput(out, \"UTF-8\")\n serializer.startDocument(\"UTF-8\", true)\n serializer.startTag(\"\", \"hierarchy\")\n serializer.attribute(\"\", \"rotation\", Integer.toString(device.displayRotation))\n\n val roots = try {\n device.javaClass\n .getDeclaredMethod(\"getWindowRoots\")\n .apply {\n isAccessible = true\n }\n .let {\n @Suppress(\"UNCHECKED_CAST\")\n it.invoke(device) as Array\n }\n .toList()\n } catch (e: Exception) {\n // Falling back to a public method if reflection fails\n Log.e(LOGTAG, \"Unable to call getWindowRoots\", e)\n listOf(uiAutomation.rootInActiveWindow)\n }\n\n roots.forEach {\n dumpNodeRec(\n it,\n serializer,\n 0,\n displayRect\n )\n }\n addToastNode(toastNode, serializer, displayRect)\n\n serializer.endTag(\"\", \"hierarchy\")\n serializer.endDocument()\n }\n\n private fun addToastNode(\n toastNode: AccessibilityNodeInfo?,\n serializer: XmlSerializer,\n displayRect: Rect\n ) {\n if (toastNode != null) {\n serializer.apply {\n startTag(\"\", \"node\")\n attribute(\"\", \"index\", \"0\")\n attribute(\"\", \"class\", toastNode.className.toString())\n attribute(\"\", \"text\", toastNode.text.toString())\n attribute(\"\", \"visible-to-user\", toastNode.isVisibleToUser.toString())\n attribute(\"\", \"checkable\", toastNode.isCheckable.toString())\n attribute(\"\", \"clickable\", toastNode.isClickable.toString())\n attribute(\"\", \"bounds\", getVisibleBoundsInScreen(toastNode, displayRect)?.toShortString())\n endTag(\"\", \"node\")\n }\n }\n }\n\n private val NAF_EXCLUDED_CLASSES = arrayOf(\n GridView::class.java.name, GridLayout::class.java.name,\n ListView::class.java.name, TableLayout::class.java.name\n )\n\n @Suppress(\"LongParameterList\")\n @Throws(IOException::class)\n private fun dumpNodeRec(\n node: AccessibilityNodeInfo,\n serializer: XmlSerializer,\n index: Int,\n displayRect: Rect,\n insideWebView: Boolean = false,\n ) {\n serializer.startTag(\"\", \"node\")\n if (!nafExcludedClass(node) && !nafCheck(node)) {\n serializer.attribute(\"\", \"NAF\", java.lang.Boolean.toString(true))\n }\n\n serializer.attribute(\"\", \"index\", Integer.toString(index))\n serializer.attribute(\"\", \"hintText\", safeCharSeqToString(node.getHintOrFallback()))\n serializer.attribute(\"\", \"text\", safeCharSeqToString(node.text))\n serializer.attribute(\"\", \"resource-id\", safeCharSeqToString(node.viewIdResourceName))\n serializer.attribute(\"\", \"class\", safeCharSeqToString(node.className))\n serializer.attribute(\"\", \"package\", safeCharSeqToString(node.packageName))\n serializer.attribute(\"\", \"content-desc\", safeCharSeqToString(node.contentDescription))\n serializer.attribute(\"\", \"checkable\", java.lang.Boolean.toString(node.isCheckable))\n serializer.attribute(\"\", \"checked\", java.lang.Boolean.toString(node.isChecked))\n serializer.attribute(\"\", \"clickable\", java.lang.Boolean.toString(node.isClickable))\n serializer.attribute(\"\", \"enabled\", java.lang.Boolean.toString(node.isEnabled))\n serializer.attribute(\"\", \"focusable\", java.lang.Boolean.toString(node.isFocusable))\n serializer.attribute(\"\", \"focused\", java.lang.Boolean.toString(node.isFocused))\n serializer.attribute(\"\", \"scrollable\", java.lang.Boolean.toString(node.isScrollable))\n serializer.attribute(\"\", \"long-clickable\", java.lang.Boolean.toString(node.isLongClickable))\n serializer.attribute(\"\", \"password\", java.lang.Boolean.toString(node.isPassword))\n serializer.attribute(\"\", \"selected\", java.lang.Boolean.toString(node.isSelected))\n serializer.attribute(\"\", \"visible-to-user\", java.lang.Boolean.toString(node.isVisibleToUser))\n serializer.attribute(\"\", \"important-for-accessibility\", java.lang.Boolean.toString(node.isImportantForAccessibility))\n serializer.attribute(\"\", \"error\", safeCharSeqToString(node.error))\n serializer.attribute(\n \"\", \"bounds\", getVisibleBoundsInScreen(node, displayRect)?.toShortString()\n )\n val count = node.childCount\n for (i in 0 until count) {\n val child = node.getChild(i)\n if (child != null) {\n // This condition is different from the original.\n // Original implementation has a bug where contents of a WebView sometimes reported as invisible.\n // This is a workaround for that bug.\n if (child.isVisibleToUser || insideWebView) {\n dumpNodeRec(\n child,\n serializer, i,\n displayRect,\n insideWebView || child.className == \"android.webkit.WebView\"\n )\n child.recycle()\n } else {\n Log.i(LOGTAG, \"Skipping invisible child: $child\")\n }\n } else {\n Log.i(LOGTAG, \"Null child $i/$count, parent: $node\")\n }\n }\n serializer.endTag(\"\", \"node\")\n }\n\n /**\n * The list of classes to exclude my not be complete. We're attempting to\n * only reduce noise from standard layout classes that may be falsely\n * configured to accept clicks and are also enabled.\n *\n * @param node\n * @return true if node is excluded.\n */\n private fun nafExcludedClass(node: AccessibilityNodeInfo): Boolean {\n val className = safeCharSeqToString(node.className)\n for (excludedClassName in NAF_EXCLUDED_CLASSES) {\n if (className.endsWith(excludedClassName)) return true\n }\n return false\n }\n\n /**\n * We're looking for UI controls that are enabled, clickable but have no\n * text nor content-description. Such controls configuration indicate an\n * interactive control is present in the UI and is most likely not\n * accessibility friendly. We refer to such controls here as NAF controls\n * (Not Accessibility Friendly)\n *\n * @param node\n * @return false if a node fails the check, true if all is OK\n */\n private fun nafCheck(node: AccessibilityNodeInfo): Boolean {\n val isNaf = (node.isClickable && node.isEnabled\n && safeCharSeqToString(node.contentDescription).isEmpty()\n && safeCharSeqToString(node.text).isEmpty())\n return if (!isNaf) true else childNafCheck(node)\n\n // check children since sometimes the containing element is clickable\n // and NAF but a child's text or description is available. Will assume\n // such layout as fine.\n }\n\n /**\n * This should be used when it's already determined that the node is NAF and\n * a further check of its children is in order. A node maybe a container\n * such as LinearLayout and may be set to be clickable but have no text or\n * content description but it is counting on one of its children to fulfill\n * the requirement for being accessibility friendly by having one or more of\n * its children fill the text or content-description. Such a combination is\n * considered by this dumper as acceptable for accessibility.\n *\n * @param node\n * @return false if node fails the check.\n */\n @Suppress(\"ReturnCount\")\n private fun childNafCheck(node: AccessibilityNodeInfo): Boolean {\n val childCount = node.childCount\n for (x in 0 until childCount) {\n val childNode = node.getChild(x)\n if (childNode == null) continue;\n if (!safeCharSeqToString(childNode.contentDescription).isEmpty()\n || !safeCharSeqToString(childNode.text).isEmpty()\n ) return true\n if (childNafCheck(childNode)) return true\n }\n return false\n }\n\n private fun safeCharSeqToString(cs: CharSequence?): String {\n return cs?.let { stripInvalidXMLChars(it) } ?: \"\"\n }\n\n @Suppress(\"ComplexCondition\")\n private fun stripInvalidXMLChars(cs: CharSequence): String {\n val ret = StringBuffer()\n var ch: Char\n /* http://www.w3.org/TR/xml11/#charsets\n [#x1-#x8], [#xB-#xC], [#xE-#x1F], [#x7F-#x84], [#x86-#x9F], [#xFDD0-#xFDDF],\n [#x1FFFE-#x1FFFF], [#x2FFFE-#x2FFFF], [#x3FFFE-#x3FFFF],\n [#x4FFFE-#x4FFFF], [#x5FFFE-#x5FFFF], [#x6FFFE-#x6FFFF],\n [#x7FFFE-#x7FFFF], [#x8FFFE-#x8FFFF], [#x9FFFE-#x9FFFF],\n [#xAFFFE-#xAFFFF], [#xBFFFE-#xBFFFF], [#xCFFFE-#xCFFFF],\n [#xDFFFE-#xDFFFF], [#xEFFFE-#xEFFFF], [#xFFFFE-#xFFFFF],\n [#x10FFFE-#x10FFFF].\n */for (i in 0 until cs.length) {\n ch = cs[i]\n if (ch.code >= 0x1 && ch.code <= 0x8 || ch.code >= 0xB && ch.code <= 0xC || ch.code >= 0xE && ch.code <= 0x1F ||\n ch.code >= 0x7F && ch.code <= 0x84 || ch.code >= 0x86 && ch.code <= 0x9f ||\n ch.code >= 0xFDD0 && ch.code <= 0xFDDF || ch.code >= 0x1FFFE && ch.code <= 0x1FFFF ||\n ch.code >= 0x2FFFE && ch.code <= 0x2FFFF || ch.code >= 0x3FFFE && ch.code <= 0x3FFFF ||\n ch.code >= 0x4FFFE && ch.code <= 0x4FFFF || ch.code >= 0x5FFFE && ch.code <= 0x5FFFF ||\n ch.code >= 0x6FFFE && ch.code <= 0x6FFFF || ch.code >= 0x7FFFE && ch.code <= 0x7FFFF ||\n ch.code >= 0x8FFFE && ch.code <= 0x8FFFF || ch.code >= 0x9FFFE && ch.code <= 0x9FFFF ||\n ch.code >= 0xAFFFE && ch.code <= 0xAFFFF || ch.code >= 0xBFFFE && ch.code <= 0xBFFFF ||\n ch.code >= 0xCFFFE && ch.code <= 0xCFFFF || ch.code >= 0xDFFFE && ch.code <= 0xDFFFF ||\n ch.code >= 0xEFFFE && ch.code <= 0xEFFFF || ch.code >= 0xFFFFE && ch.code <= 0xFFFFF ||\n ch.code >= 0x10FFFE && ch.code <= 0x10FFFF\n ) ret.append(\".\") else ret.append(ch)\n }\n return ret.toString()\n }\n\n // This method is copied from AccessibilityNodeInfoHelper as-is\n private fun getVisibleBoundsInScreen(node: AccessibilityNodeInfo?, displayRect: Rect): Rect? {\n if (node == null) {\n return null\n }\n // targeted node's bounds\n val nodeRect = Rect()\n node.getBoundsInScreen(nodeRect)\n return if (nodeRect.intersect(displayRect)) {\n nodeRect\n } else {\n Rect()\n }\n }\n\n}\n" }, { "path": "maestro-android/src/androidTest/java/dev/mobile/maestro/location/FusedLocationProvider.kt", "content": "package dev.mobile.maestro.location\n\nimport android.location.Location\nimport com.google.android.gms.location.FusedLocationProviderClient\n\nclass FusedLocationProvider(\n private val fusedLocationProviderClient: FusedLocationProviderClient\n): MockLocationProvider {\n\n companion object {\n private const val PROVIDER_NAME = \"fused\"\n private val TAG = FusedLocationProvider::class.java.name\n }\n\n override fun setLocation(location: Location) {\n fusedLocationProviderClient.setMockLocation(location)\n }\n\n override fun enable() {\n fusedLocationProviderClient.setMockMode(true)\n }\n\n override fun disable() {\n fusedLocationProviderClient.setMockMode(false)\n }\n\n override fun getProviderName(): String {\n return PROVIDER_NAME\n }\n}" }, { "path": "maestro-android/src/androidTest/java/dev/mobile/maestro/location/LocationManagerProvider.kt", "content": "package dev.mobile.maestro.location\n\nimport android.location.Location\nimport android.location.LocationManager\n\nclass LocationManagerProvider(\n private val locationManager: LocationManager,\n private val name: String,\n private val requiresNetwork: Boolean,\n private val requiresCell: Boolean,\n private val requiresSatellite: Boolean,\n private val hasMonetaryCost: Boolean,\n private val supportsAltitude: Boolean,\n private val supportsSpeed: Boolean,\n private val supportsBearing: Boolean,\n private val powerRequirement: Int,\n private val accuracy: Int\n) : MockLocationProvider {\n\n override fun setLocation(location: Location) {\n locationManager.setTestProviderLocation(name, location)\n }\n\n override fun enable() {\n locationManager.addTestProvider(\n name,\n requiresNetwork,\n requiresSatellite,\n requiresCell,\n hasMonetaryCost,\n supportsAltitude,\n supportsSpeed,\n supportsBearing,\n powerRequirement,\n accuracy\n )\n locationManager.setTestProviderEnabled(name, true)\n }\n\n override fun disable() {\n locationManager.setTestProviderEnabled(name, false)\n locationManager.removeTestProvider(name)\n }\n\n override fun getProviderName(): String {\n return name\n }\n}" }, { "path": "maestro-android/src/androidTest/java/dev/mobile/maestro/location/MockLocationProvider.kt", "content": "package dev.mobile.maestro.location\n\nimport android.location.Location\n\ninterface MockLocationProvider {\n\n fun setLocation(location: Location)\n\n fun enable()\n\n fun disable()\n\n fun getProviderName(): String\n}" }, { "path": "maestro-android/src/androidTest/java/dev/mobile/maestro/location/PlayServices.kt", "content": "package dev.mobile.maestro.location\n\nimport android.content.Context\nimport com.google.android.gms.common.ConnectionResult\nimport com.google.android.gms.common.GoogleApiAvailability\n\nclass PlayServices {\n\n fun isAvailable(context: Context): Boolean {\n val apiAvailability = GoogleApiAvailability.getInstance()\n val resultCode = apiAvailability.isGooglePlayServicesAvailable(context)\n return resultCode == ConnectionResult.SUCCESS\n }\n}" }, { "path": "maestro-android/src/androidTest/java/dev/mobile/maestro/screenshot/ScreenshotService.kt", "content": "package dev.mobile.maestro.screenshot\n\nimport android.graphics.Bitmap\nimport com.github.michaelbull.retry.policy.binaryExponentialBackoff\nimport com.github.michaelbull.retry.policy.continueIf\nimport com.github.michaelbull.retry.policy.plus\nimport com.github.michaelbull.retry.policy.stopAtAttempts\nimport com.github.michaelbull.retry.retry\nimport com.google.protobuf.ByteString\nimport java.io.ByteArrayOutputStream\nimport kotlinx.coroutines.runBlocking\n\n/**\n * Thrown when screenshot encoding fails (e.g. [Bitmap.compress] throws or returns false).\n */\nclass ScreenshotException(\n message: String,\n cause: Throwable? = null\n) : Exception(message, cause)\n\n/**\n * Encodes screenshots to PNG (or other formats) with validation and size limits.\n */\nclass ScreenshotService() {\n\n /**\n * Takes a screenshot with retry logic. Retries up to 3 times with exponential backoff\n * when the screenshot returns null (window not ready / SurfaceControl invalid).\n */\n fun takeScreenshotWithRetry(screenshotProvider: () -> Bitmap?): Bitmap {\n return runBlocking {\n retry(\n stopAtAttempts(3)\n + continueIf { it.failure is NullPointerException }\n + binaryExponentialBackoff(min = 500L, max = 5000L)\n ) {\n screenshotProvider()\n ?: throw NullPointerException(\"Screenshot returned null โ€” window may not be ready\")\n }\n }\n }\n\n /**\n * Encodes a screenshot bitmap to PNG bytes.\n *\n * @throws ScreenshotException if compression fails or output is invalid/too large.\n */\n fun encodePng(bitmap: Bitmap, quality: Int = 100): ByteString =\n encode(bitmap, Bitmap.CompressFormat.PNG, quality)\n\n /**\n * Generic encoder for any [Bitmap.CompressFormat].\n *\n * @throws ScreenshotException if compression fails or output is invalid/too large.\n */\n fun encode(\n bitmap: Bitmap,\n format: Bitmap.CompressFormat,\n quality: Int = 100,\n ): ByteString {\n validateQuality(format, quality)\n\n val outputStream = ByteArrayOutputStream()\n val ok = try {\n bitmap.compress(format, quality, outputStream)\n } catch (t: Throwable) {\n throw ScreenshotException(\n message = \"Bitmap compression failed: format=${format.name}, width=${bitmap.width}, height=${bitmap.height}, config=${bitmap.config}\",\n cause = t\n )\n }\n\n if (!ok) {\n throw ScreenshotException(\n message = \"Bitmap.compress returned false: format=${format.name}, quality=$quality, width=${bitmap.width}, height=${bitmap.height}, config=${bitmap.config}\"\n )\n }\n\n val bytes = outputStream.toByteArray()\n if (bytes.isEmpty()) {\n throw ScreenshotException(\n message = \"Bitmap compressed but produced empty output: format=${format.name}, quality=$quality, width=${bitmap.width}, height=${bitmap.height}, config=${bitmap.config}\"\n )\n }\n return ByteString.copyFrom(bytes)\n }\n\n private fun validateQuality(format: Bitmap.CompressFormat, quality: Int) {\n if (quality !in 0..100) {\n throw IllegalArgumentException(\"quality must be in 0..100, got $quality\")\n }\n }\n}\n" }, { "path": "maestro-android/src/androidTest/java/dev/mobile/maestro/screenshot/ScreenshotServiceTest.kt", "content": "package dev.mobile.maestro.screenshot\n\nimport android.graphics.Bitmap\nimport androidx.test.ext.junit.runners.AndroidJUnit4\nimport org.junit.Assert.assertEquals\nimport org.junit.Assert.assertNotNull\nimport org.junit.Assert.assertSame\nimport org.junit.Assert.assertTrue\nimport org.junit.Assert.fail\nimport org.junit.Ignore\nimport org.junit.Test\nimport org.junit.runner.RunWith\n\n@Ignore(\"Disabled since this structure of unit test is weird - We should have libs which should be having their own tests\")\n@RunWith(AndroidJUnit4::class)\nclass ScreenshotServiceTest {\n private val screenshotService = ScreenshotService()\n\n @Test\n fun encodePng_withValidBitmap_returnsBytes() {\n val bitmap = Bitmap.createBitmap(100, 100, Bitmap.Config.ARGB_8888)\n try {\n val result = screenshotService.encodePng(bitmap)\n assertNotNull(result)\n assertTrue(\"Encoded bytes should not be empty\", result.size() > 0)\n } finally {\n bitmap.recycle()\n }\n }\n\n @Test\n fun encode_withInvalidQualityTooHigh_throwsIllegalArgumentException() {\n val bitmap = Bitmap.createBitmap(100, 100, Bitmap.Config.ARGB_8888)\n try {\n screenshotService.encode(bitmap, Bitmap.CompressFormat.PNG, quality = 101)\n fail(\"Expected IllegalArgumentException to be thrown\")\n } catch (e: IllegalArgumentException) {\n assertTrue(\n \"Message should mention quality\",\n e.message?.contains(\"quality\") == true\n )\n } finally {\n bitmap.recycle()\n }\n }\n\n @Test\n fun encode_withInvalidQualityNegative_throwsIllegalArgumentException() {\n val bitmap = Bitmap.createBitmap(100, 100, Bitmap.Config.ARGB_8888)\n try {\n screenshotService.encode(bitmap, Bitmap.CompressFormat.PNG, quality = -1)\n fail(\"Expected IllegalArgumentException to be thrown\")\n } catch (e: IllegalArgumentException) {\n assertTrue(\n \"Message should mention quality\",\n e.message?.contains(\"quality\") == true\n )\n } finally {\n bitmap.recycle()\n }\n }\n\n @Test\n fun encode_withJpegFormat_returnsBytes() {\n val bitmap = Bitmap.createBitmap(100, 100, Bitmap.Config.ARGB_8888)\n try {\n val result = screenshotService.encode(bitmap, Bitmap.CompressFormat.JPEG, quality = 80)\n assertNotNull(result)\n assertTrue(\"Encoded bytes should not be empty\", result.size() > 0)\n } finally {\n bitmap.recycle()\n }\n }\n\n @Test\n fun encode_withWebpFormat_returnsBytes() {\n val bitmap = Bitmap.createBitmap(100, 100, Bitmap.Config.ARGB_8888)\n try {\n @Suppress(\"DEPRECATION\")\n val result = screenshotService.encode(bitmap, Bitmap.CompressFormat.WEBP, quality = 80)\n assertNotNull(result)\n assertTrue(\"Encoded bytes should not be empty\", result.size() > 0)\n } finally {\n bitmap.recycle()\n }\n }\n\n @Test\n fun takeScreenshotWithRetry_returnsOnFirstSuccess() {\n val bitmap = Bitmap.createBitmap(100, 100, Bitmap.Config.ARGB_8888)\n var callCount = 0\n try {\n val result = screenshotService.takeScreenshotWithRetry {\n callCount++\n bitmap\n }\n assertSame(bitmap, result)\n assertEquals(1, callCount)\n } finally {\n bitmap.recycle()\n }\n }\n\n @Test\n fun takeScreenshotWithRetry_retriesOnNull() {\n val bitmap = Bitmap.createBitmap(100, 100, Bitmap.Config.ARGB_8888)\n var callCount = 0\n try {\n val result = screenshotService.takeScreenshotWithRetry {\n callCount++\n if (callCount < 3) null else bitmap\n }\n assertSame(bitmap, result)\n assertEquals(3, callCount)\n } finally {\n bitmap.recycle()\n }\n }\n\n @Test\n fun takeScreenshotWithRetry_throwsAfterAllRetriesExhausted() {\n var callCount = 0\n try {\n screenshotService.takeScreenshotWithRetry {\n callCount++\n null\n }\n fail(\"Expected NullPointerException to be thrown\")\n } catch (e: NullPointerException) {\n assertEquals(3, callCount)\n }\n }\n}\n" }, { "path": "maestro-android/src/main/AndroidManifest.xml", "content": "\n\n\n \n \n \n \n \n \n \n\n \n \n \n \n" }, { "path": "maestro-android/src/main/java/dev/mobile/maestro/handlers/AbstractSettingHandler.kt", "content": "package dev.mobile.maestro.handlers\n\nimport android.content.Context\nimport android.content.pm.PackageManager\nimport android.util.Log\n\nabstract class AbstractSettingHandler(private val context: Context, private val permissions: List) {\n protected fun hasPermissions(): Boolean {\n for (p in permissions) {\n if (context.checkCallingOrSelfPermission(p) != PackageManager.PERMISSION_GRANTED) {\n val logMessage = String.format(\n \"The permission %s is not set. Cannot change state of %s.\",\n p, settingDescription\n )\n Log.e(TAG, logMessage)\n return false\n }\n }\n return true\n }\n\n abstract fun setState(state: Boolean): Boolean\n abstract val settingDescription: String\n\n companion object {\n private const val TAG = \"Maestro\"\n }\n}" }, { "path": "maestro-android/src/main/java/dev/mobile/maestro/handlers/LocaleSettingHandler.kt", "content": "package dev.mobile.maestro.handlers\n\nimport android.annotation.SuppressLint\nimport android.content.Context\nimport android.content.res.Configuration\nimport android.os.Build\nimport org.lsposed.hiddenapibypass.HiddenApiBypass\nimport java.lang.reflect.InvocationTargetException\nimport java.util.*\n\nclass LocaleSettingHandler(context: Context) : AbstractSettingHandler(context, listOf(CHANGE_CONFIGURATION)) {\n fun setLocale(locale: Locale) {\n if (hasPermissions()) {\n setLocaleWith(locale)\n }\n }\n\n @SuppressLint(\"PrivateApi\")\n @Throws(\n ClassNotFoundException::class,\n NoSuchMethodException::class,\n InvocationTargetException::class,\n IllegalAccessException::class,\n NoSuchFieldException::class\n )\n private fun setLocaleWith(locale: Locale) {\n var activityManagerNativeClass = Class.forName(\"android.app.ActivityManagerNative\")\n val methodGetDefault = activityManagerNativeClass.getMethod(\"getDefault\")\n methodGetDefault.isAccessible = true\n val amn = methodGetDefault.invoke(activityManagerNativeClass)\n\n if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {\n // getConfiguration moved from ActivityManagerNative to ActivityManagerProxy\n activityManagerNativeClass = Class.forName(amn.javaClass.name)\n }\n\n val methodGetConfiguration = activityManagerNativeClass.getMethod(\"getConfiguration\")\n methodGetConfiguration.isAccessible = true\n val config = methodGetConfiguration.invoke(amn) as Configuration\n val configClass: Class<*> = config.javaClass\n val f = configClass.getField(\"userSetLocale\")\n f.setBoolean(config, true)\n config.locale = locale\n config.setLayoutDirection(locale)\n\n if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {\n HiddenApiBypass.invoke(\n activityManagerNativeClass,\n amn,\n \"updateConfiguration\",\n config\n )\n } else {\n val methodUpdateConfiguration = activityManagerNativeClass.getMethod(\n \"updateConfiguration\",\n Configuration::class.java\n )\n methodUpdateConfiguration.isAccessible = true\n methodUpdateConfiguration.invoke(amn, config)\n }\n }\n\n override fun setState(state: Boolean): Boolean {\n return false\n }\n\n override val settingDescription: String = \"locale\"\n\n companion object {\n private const val CHANGE_CONFIGURATION = \"android.permission.CHANGE_CONFIGURATION\"\n }\n}\n\n" }, { "path": "maestro-android/src/main/java/dev/mobile/maestro/receivers/HasAction.kt", "content": "package dev.mobile.maestro.receivers\n\ninterface HasAction {\n fun action(): String\n}" }, { "path": "maestro-android/src/main/java/dev/mobile/maestro/receivers/LocaleSettingReceiver.kt", "content": "package dev.mobile.maestro.receivers\n\nimport android.content.BroadcastReceiver\nimport android.content.Context\nimport android.content.Intent\nimport android.util.Log\nimport dev.mobile.maestro.handlers.LocaleSettingHandler\nimport org.apache.commons.lang3.LocaleUtils\nimport java.util.*\nimport java.lang.Exception\n\nclass LocaleSettingReceiver : BroadcastReceiver(), HasAction {\n\n override fun onReceive(context: Context, intent: Intent) {\n var language = intent.getStringExtra(LANG)\n var country = intent.getStringExtra(COUNTRY)\n\n if (language == null || country == null) {\n Log.w(\n TAG, \"It is required to provide both language and country, for example: \" +\n \"am broadcast -a dev.mobile.maestro --es lang ja --es country JP\"\n )\n Log.i(TAG, \"Set en-US by default.\")\n language = \"en\"\n country = \"US\"\n }\n\n var locale = Locale(language, country)\n\n Log.i(TAG, \"Obtained locale: $locale\")\n\n try {\n Log.i(TAG, \"getting string extra for device locale\")\n val script = intent.getStringExtra(SCRIPT)\n if (script != null) {\n Log.i(TAG, \"setting script with device locale\")\n Locale.Builder().setLocale(locale).setScript(script).build().also { locale = it }\n Log.i(TAG, \"script set for device locale\")\n }\n\n if (!LocaleUtils.isAvailableLocale(locale)) {\n val approximateMatchesLc = matchLocales(language, country)\n\n if (approximateMatchesLc.isNotEmpty() && script.isNullOrBlank()) {\n Log.i(\n TAG,\n \"The locale $locale is not known. Selecting the closest known one ${approximateMatchesLc[0]} instead\"\n )\n locale = approximateMatchesLc[0]\n } else {\n val approximateMatchesL = matchLocales(language)\n if (approximateMatchesL.isEmpty()) {\n Log.e(\n TAG,\n \"The locale $locale is not known. Only the following locales are available: ${LocaleUtils.availableLocaleList()}\"\n )\n } else {\n Log.e(\n TAG,\n \"The locale $locale is not known. \" +\n \"The following locales are available for the $language language: $approximateMatchesL\" +\n \"The following locales are available altogether: ${LocaleUtils.availableLocaleList()}\"\n )\n }\n resultCode = RESULT_LOCALE_NOT_VALID\n resultData = \"Failed to set locale $locale, the locale is not valid\"\n return\n }\n }\n } catch (e: Exception) {\n Log.e(TAG, \"Failed to validate device locale\", e)\n resultCode = RESULT_LOCALE_VALIDATION_FAILED\n resultData = \"Failed to set locale $locale: ${e.message}\"\n }\n\n try {\n LocaleSettingHandler(context).setLocale(locale)\n Log.i(TAG, \"Set locale: $locale\")\n resultCode = RESULT_SUCCESS\n resultData = locale.toString()\n } catch (e: Exception) {\n Log.e(TAG, \"Failed to set locale\", e)\n resultCode = RESULT_UPDATE_CONFIGURATION_FAILED\n resultData = \"Failed to set locale $locale, exception during updating configuration occurred: $e\"\n }\n }\n\n private fun matchLocales(language: String): List {\n val matches = ArrayList()\n for (locale in LocaleUtils.availableLocaleList()) {\n if (locale.language == language) {\n matches.add(locale)\n }\n }\n return matches\n }\n\n private fun matchLocales(language: String, country: String): List {\n val matches = ArrayList()\n for (locale in LocaleUtils.availableLocaleList()) {\n if (locale.language == language &&\n locale.country == country\n ) {\n matches.add(locale)\n }\n }\n return matches\n }\n\n override fun action(): String {\n return ACTION\n }\n\n companion object {\n private const val LANG = \"lang\"\n private const val COUNTRY = \"country\"\n private const val SCRIPT = \"script\"\n private const val ACTION = \"dev.mobile.maestro.locale\"\n private const val TAG = \"Maestro\"\n\n private const val RESULT_SUCCESS = 0\n private const val RESULT_LOCALE_NOT_VALID = 1\n private const val RESULT_UPDATE_CONFIGURATION_FAILED = 2\n private const val RESULT_LOCALE_VALIDATION_FAILED = 3\n }\n}" }, { "path": "maestro-android/src/main/res/values/stub.xml", "content": "\n Maestro Driver\n\n" }, { "path": "maestro-cli/build.gradle.kts", "content": "import org.jreleaser.model.Active.ALWAYS\nimport org.jetbrains.kotlin.gradle.tasks.KotlinCompilationTask\nimport org.jreleaser.model.Stereotype\nimport java.util.Properties\n\n@Suppress(\"DSL_SCOPE_VIOLATION\")\nplugins {\n application\n alias(libs.plugins.kotlin.jvm)\n alias(libs.plugins.jreleaser)\n alias(libs.plugins.shadow)\n alias(libs.plugins.mavenPublish)\n alias(libs.plugins.kotlin.serialization)\n}\n\ngroup = \"dev.mobile\"\n\nval CLI_VERSION: String by project\n\napplication {\n applicationName = \"maestro\"\n mainClass.set(\"maestro.cli.AppKt\")\n}\n\ntasks.named(\"jar\") {\n manifest {\n attributes[\"Main-Class\"] = \"maestro.cli.AppKt\"\n }\n // Include the driver source directly\n from(\"../maestro-ios-xctest-runner\") {\n into(\"driver/ios\")\n include(\n \"maestro-driver-ios/**\",\n \"maestro-driver-iosUITests/**\",\n \"maestro-driver-ios.xcodeproj/**\",\n )\n }\n}\n\ntasks.named(\"run\") {\n standardInput = System.`in`\n workingDir = rootDir\n}\n\n/** The source that was used to create JvmVersion is here. It was compiled with JDK 1.1\n * on a Windows 32 bit machine using https://www.oracle.com/java/technologies/java-archive-downloads-javase11-downloads.html\n * with a META-INF/MANIFEST.MF of Main-Class: JvmVersion for the jvm-version.jar\n *\n * import java.util.StringTokenizer;\n *\n * class JvmVersion {\n * public static void main(String[] args) {\n * try {\n * String javaVersion = System.getProperty(\"java.version\");\n * \t\t\tStringTokenizer tokenizer = new StringTokenizer(javaVersion, \".\");\n * \t\t\tString[] split = new String[tokenizer.countTokens()];\n * \t\t\tint count = 0;\n * \t\t\twhile (tokenizer.hasMoreTokens()) {\n * \t\t\t\tsplit[count] = tokenizer.nextToken();\n * \t\t\t\tcount++;\n * \t\t\t}\n * if (javaVersion.startsWith(\"1.\")) {\n * String version = split[1];\n * if (Integer.parseInt(version) >= 1 && Integer.parseInt(version) <= 8) {\n * System.out.println(version);\n * System.exit(0);\n * } else {\n * \t\t\t\t\tString base = \"Expected a JVM version of 1.0 through to 1.8 for legacy JVM versioning. Instead got \";\n * String output = base.concat(version);\n * System.out.println(output);\n * System.exit(1);\n * }\n * } else {\n * String version = split[0];\n * if (Integer.parseInt(version) >= 9) {\n * System.out.println(version);\n * System.exit(0);\n * } else {\n * \t\t\t\t\tString base = \"Expected a JVM version of 9 or greater for new JVM versioning. Instead got \";\n * \t\t\t\t\tString output = base.concat(version);\n * \t\t\t\t\tSystem.out.println(output);\n * System.exit(1);\n * }\n * }\n * } catch (Exception e) {\n * System.err.println(e.getMessage());\n * System.exit(1);\n * }\n * }\n * }\n *\n */\n\nfun windowsMinimumJavaText(minimumJavaVersion: String): String = \"\"\"\nset JAVA_VERSION=0\nfor /f \"tokens=*\" %%g in ('cmd /c \"\"%JAVA_EXE%\" -classpath \"%APP_HOME%\\bin\\*\" JvmVersion\"') do (\n set JAVA_VERSION=%%g\n)\n\nif %JAVA_VERSION% LSS $minimumJavaVersion (\n echo.\n echo ERROR: Java $minimumJavaVersion or higher is required.\n echo.\n echo Please update Java, then try again.\n echo To check your Java version, run: java -version\n echo.\n echo See https://maestro.dev/blog/introducing-maestro-2-0-0 for more details.\n goto fail\n)\n\"\"\".trimIndent().replace(\"\\n\", \"\\r\\n\")\n\nfun unixMinimumJavaText(minimumJavaVersion: String): String = \"\"\"\nJAVA_VERSION=$( \"${'$'}JAVACMD\" -classpath \"${'$'}APP_HOME\"/bin/*.jar JvmVersion )\nif [ \"${'$'}JAVA_VERSION\" -lt $minimumJavaVersion ]; then\n die \"ERROR: Java $minimumJavaVersion or higher is required.\n\nPlease update Java, then try again.\nTo check your Java version, run: java -version\n\nSee https://maestro.dev/blog/introducing-maestro-2-0-0 for more details.\"\nfi\n\"\"\".trimIndent()\n\ntasks.named(\"startScripts\") {\n classpath = files(\"${layout.buildDirectory}/libs/*\")\n doLast {\n val minimumJavaVersion = \"17\"\n val unixExec = \"exec \\\"\\$JAVACMD\\\" \\\"$@\\\"\"\n\n val currentUnix = unixScript.readText()\n val replacedUnix = currentUnix.replaceFirst(unixExec,\n unixMinimumJavaText(minimumJavaVersion) + \"\\n\\n\" + unixExec)\n unixScript.writeText(replacedUnix)\n\n val currentWindows = windowsScript.readText()\n val windowsExec = \"@rem Execute maestro\"\n val replacedWindows = currentWindows.replaceFirst(windowsExec,\n windowsMinimumJavaText(minimumJavaVersion) + \"\\r\\n\\r\\n\" + windowsExec)\n windowsScript.writeText(replacedWindows)\n\n val path = project.projectDir.toPath().resolve(\"jvm-version.jar\")\n\n copy {\n from(path)\n into(outputDir)\n }\n }\n}\n\ndependencies {\n implementation(project(path = \":maestro-utils\"))\n annotationProcessor(libs.picocli.codegen)\n\n implementation(project(\":maestro-orchestra\"))\n implementation(project(\":maestro-client\"))\n implementation(project(\":maestro-ios\"))\n implementation(project(\":maestro-ios-driver\"))\n implementation(project(\":maestro-studio:server\"))\n implementation(libs.apk.parser)\n implementation(libs.dd.plist)\n implementation(libs.posthog)\n implementation(libs.dadb)\n implementation(libs.picocli)\n implementation(libs.jackson.core.databind)\n implementation(libs.jackson.module.kotlin)\n implementation(libs.jackson.dataformat.yaml)\n implementation(libs.jackson.dataformat.xml)\n implementation(libs.jackson.datatype.jsr310)\n implementation(libs.jansi)\n implementation(libs.jcodec)\n implementation(libs.jcodec.awt)\n implementation(libs.square.okhttp)\n implementation(libs.ktor.client.core)\n implementation(libs.ktor.client.cio)\n implementation(libs.ktor.server.core)\n implementation(libs.ktor.server.netty)\n implementation(libs.ktor.server.cors)\n implementation(libs.ktor.server.status.pages)\n implementation(libs.jarchivelib)\n implementation(libs.commons.codec)\n implementation(libs.kotlinx.coroutines.core)\n implementation(libs.kotlinx.html)\n implementation(libs.skiko.macos.arm64)\n implementation(libs.skiko.macos.x64)\n implementation(libs.skiko.linux.arm64)\n implementation(libs.skiko.linux.x64)\n implementation(libs.skiko.windows.arm64)\n implementation(libs.skiko.windows.x64)\n implementation(libs.kotlinx.serialization.json)\n implementation(\"org.jetbrains.kotlinx:kotlinx-io-core:0.2.0\")\n implementation(libs.mcp.kotlin.sdk) {\n version {\n branch = \"steviec/kotlin-1.8\"\n }\n exclude(group = \"org.slf4j\", module = \"slf4j-simple\")\n }\n implementation(libs.logging.sl4j)\n implementation(libs.logging.api)\n implementation(libs.logging.layout.template)\n implementation(libs.log4j.core)\n implementation(libs.mordant)\n\n testImplementation(libs.junit.jupiter.api)\n testRuntimeOnly(libs.junit.jupiter.engine)\n testImplementation(libs.mockk)\n testImplementation(libs.google.truth)\n}\n\ntasks.named(\"test\") {\n useJUnitPlatform()\n}\n\njava {\n sourceCompatibility = JavaVersion.VERSION_17\n targetCompatibility = JavaVersion.VERSION_17\n}\n\nkotlin {\n jvmToolchain(17)\n}\n\ntasks.named(\"compileKotlin\", KotlinCompilationTask::class.java) {\n compilerOptions {\n freeCompilerArgs.addAll(\"-Xjdk-release=17\")\n }\n}\n\ntasks.create(\"createProperties\") {\n dependsOn(\"processResources\")\n\n doLast {\n File(\"$buildDir/resources/main/version.properties\").writer().use { w ->\n val p = Properties()\n p[\"version\"] = CLI_VERSION\n p.store(w, null)\n }\n }\n}\n\ntasks.register(\"createTestResources\") {\n from(\"../maestro-ios-xctest-runner\") {\n into(\"driver/ios\")\n include(\n \"maestro-driver-ios/**\",\n \"maestro-driver-iosUITests/**\",\n \"maestro-driver-ios.xcodeproj/**\"\n )\n }\n into(layout.buildDirectory.dir(\"resources/test\"))\n}\n\ntasks.named(\"classes\") {\n dependsOn(\"createTestResources\")\n dependsOn(\"createProperties\")\n}\n\ntasks.named(\"distZip\") {\n archiveFileName.set(\"maestro.zip\")\n}\n\ntasks.named(\"distTar\") {\n archiveFileName.set(\"maestro.tar\")\n}\n\ntasks.shadowJar {\n setProperty(\"zip64\", true)\n}\n\nmavenPublishing {\n publishToMavenCentral(true)\n signAllPublications()\n}\n\njreleaser {\n version = CLI_VERSION\n gitRootSearch.set(true)\n\n project {\n name.set(\"Maestro CLI\")\n description.set(\"The easiest way to automate UI testing for your mobile app\")\n links {\n homepage.set(\"https://maestro.mobile.dev\")\n bugTracker.set(\"https://github.com/mobile-dev-inc/maestro/issues\")\n }\n authors.set(listOf(\"Dmitry Zaytsev\", \"Amanjeet Singh\", \"Leland Takamine\", \"Arthur Saveliev\", \"Axel Niklasson\", \"Berik Visschers\"))\n license.set(\"Apache-2.0\")\n copyright.set(\"mobile.dev 2024\")\n }\n\n distributions {\n create(\"maestro\") {\n stereotype.set(Stereotype.CLI)\n\n executable {\n name.set(\"maestro\")\n }\n\n artifact {\n setPath(\"build/distributions/maestro.zip\")\n }\n\n release {\n github {\n repoOwner.set(\"mobile-dev-inc\")\n name.set(\"maestro\")\n tagName.set(\"cli-$CLI_VERSION\")\n releaseName.set(\"CLI $CLI_VERSION\")\n overwrite.set(true)\n\n changelog {\n // GitHub removes dots Markdown headers (1.37.5 becomes 1375)\n extraProperties.put(\"versionHeader\", CLI_VERSION.replace(\".\", \"\"))\n\n formatted.set(ALWAYS)\n content.set(\"\"\"\n [See changelog in the CHANGELOG.md file][link]\n\n [link]: https://github.com/mobile-dev-inc/maestro/blob/main/CHANGELOG.md#{{changelogVersionHeader}}\n \"\"\".trimIndent()\n )\n }\n }\n }\n }\n }\n\n packagers {\n brew {\n setActive(\"RELEASE\")\n extraProperties.put(\"skipJava\", \"true\")\n formulaName.set(\"Maestro\")\n\n // The default template path\n templateDirectory.set(file(\"src/jreleaser/distributions/maestro/brew\"))\n\n repoTap {\n repoOwner.set(\"mobile-dev-inc\")\n name.set(\"homebrew-tap\")\n }\n\n dependencies {\n dependency(\"openjdk\", \"17+\")\n }\n }\n }\n}\n" }, { "path": "maestro-cli/gradle.properties", "content": "CLI_VERSION=2.4.0\n" }, { "path": "maestro-cli/src/jreleaser/distributions/maestro/brew/formula.rb.tpl", "content": "# {{jreleaserCreationStamp}}\n{{#brewRequireRelative}}\nrequire_relative \"{{.}}\"\n{{/brewRequireRelative}}\n\nclass {{brewFormulaName}} < Formula\n desc \"{{projectDescription}}\"\n homepage \"{{projectLinkHomepage}}\"\n url \"{{distributionUrl}}\"{{#brewDownloadStrategy}}, :using => {{.}}{{/brewDownloadStrategy}}\n version \"{{projectVersion}}\"\n sha256 \"{{distributionChecksumSha256}}\"\n license \"{{projectLicense}}\"\n\n {{#brewHasLivecheck}}\n livecheck do\n {{#brewLivecheck}}\n {{.}}\n {{/brewLivecheck}}\n end\n {{/brewHasLivecheck}}\n {{#brewDependencies}}\n depends_on {{.}}\n {{/brewDependencies}}\n\n def install\n libexec.install Dir[\"*\"]\n bin.install_symlink \"#{libexec}/bin/{{distributionExecutableUnix}}\" => \"{{distributionExecutableName}}\"\n end\n\n test do\n output = shell_output(\"#{bin}/{{distributionExecutableName}} --version\")\n assert_match \"{{projectVersion}}\", output\n end\nend\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/App.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro.cli\n\nimport maestro.MaestroException\nimport maestro.cli.analytics.Analytics\nimport maestro.cli.analytics.CliCommandRunEvent\nimport maestro.cli.command.BugReportCommand\nimport maestro.cli.command.ChatCommand\nimport maestro.cli.command.CheckSyntaxCommand\nimport maestro.cli.command.CloudCommand\nimport maestro.cli.command.DownloadSamplesCommand\nimport maestro.cli.command.DriverCommand\nimport maestro.cli.command.ListCloudDevicesCommand\nimport maestro.cli.command.ListDevicesCommand\nimport maestro.cli.command.LoginCommand\nimport maestro.cli.command.LogoutCommand\nimport maestro.cli.command.McpCommand\nimport maestro.cli.command.PrintHierarchyCommand\nimport maestro.cli.command.QueryCommand\nimport maestro.cli.command.RecordCommand\nimport maestro.cli.command.StartDeviceCommand\nimport maestro.cli.command.StudioCommand\nimport maestro.cli.command.TestCommand\nimport maestro.cli.insights.TestAnalysisManager\nimport maestro.cli.update.Updates\nimport maestro.cli.util.ChangeLogUtils\nimport maestro.cli.util.ErrorReporter\nimport maestro.cli.view.box\nimport maestro.debuglog.DebugLogStore\nimport picocli.AutoComplete.GenerateCompletion\nimport picocli.CommandLine\nimport picocli.CommandLine.Command\nimport picocli.CommandLine.Option\nimport java.util.*\nimport kotlin.system.exitProcess\n\n@Command(\n name = \"maestro\",\n subcommands = [\n TestCommand::class,\n CloudCommand::class,\n RecordCommand::class,\n PrintHierarchyCommand::class,\n QueryCommand::class,\n DownloadSamplesCommand::class,\n LoginCommand::class,\n LogoutCommand::class,\n BugReportCommand::class,\n StudioCommand::class,\n StartDeviceCommand::class,\n ListDevicesCommand::class,\n ListCloudDevicesCommand::class,\n GenerateCompletion::class,\n ChatCommand::class,\n CheckSyntaxCommand::class,\n DriverCommand::class,\n McpCommand::class,\n ]\n)\nclass App {\n @CommandLine.Mixin\n var disableANSIMixin: DisableAnsiMixin? = null\n\n @CommandLine.Mixin\n var showHelpMixin: ShowHelpMixin? = null\n\n @Option(names = [\"-v\", \"--version\"], versionHelp = true, description = [\"Display CLI version\"])\n var requestedVersion: Boolean? = false\n\n @Option(names = [\"-p\", \"--platform\"], description = [\"(Optional) Select a platform to run on\"])\n var platform: String? = null\n\n @Option(names = [\"--host\"], hidden = true)\n var host: String? = null\n\n @Option(names = [\"--port\"], hidden = true)\n var port: Int? = null\n\n @Option(\n names = [\"--device\", \"--udid\"],\n description = [\"(Optional) Device ID to run on explicitly, can be a comma separated list of IDs: --device \\\"Emulator_1,Emulator_2\\\" \"],\n )\n var deviceId: String? = null\n\n @Option(names = [\"--verbose\"], description = [\"Enable verbose logging\"])\n var verbose: Boolean = false\n}\n\nprivate fun printVersion() {\n val props = App::class.java.classLoader.getResourceAsStream(\"version.properties\").use {\n Properties().apply { load(it) }\n }\n\n println(props[\"version\"])\n}\n\nfun main(args: Array) {\n // Disable icon in Mac dock\n // https://stackoverflow.com/a/17544259\n try {\n System.setProperty(\"apple.awt.UIElement\", \"true\")\n Analytics.warnAndEnableAnalyticsIfNotDisable()\n\n Dependencies.install()\n Updates.fetchUpdatesAsync()\n\n val commandLine = CommandLine(App())\n .setUsageHelpWidth(160)\n .setCaseInsensitiveEnumValuesAllowed(true)\n .setExecutionStrategy(DisableAnsiMixin::executionStrategy)\n .setExecutionExceptionHandler { ex, cmd, cmdParseResult ->\n\n runCatching { ErrorReporter.report(ex, cmdParseResult) }\n\n // make errors red\n println()\n cmd.colorScheme = CommandLine.Help.ColorScheme.Builder()\n .errors(CommandLine.Help.Ansi.Style.fg_red)\n .build()\n\n cmd.err.println(\n cmd.colorScheme.errorText(ex.message.orEmpty())\n )\n\n if (\n ex !is CliError && ex !is MaestroException.UnsupportedJavaVersion\n && ex !is MaestroException.MissingAppleTeamId && ex !is MaestroException.IOSDeviceDriverSetupException\n ) {\n cmd.err.println(\"\\nThe stack trace was:\")\n cmd.err.println(ex.stackTraceToString())\n }\n\n 1\n }\n\n // Track CLI run\n if (args.isNotEmpty())\n Analytics.trackEvent(CliCommandRunEvent(command = args[0]))\n\n val generateCompletionCommand = commandLine.subcommands[\"generate-completion\"]\n generateCompletionCommand?.commandSpec?.usageMessage()?.hidden(true)\n\n val exitCode = commandLine\n .execute(*args)\n\n DebugLogStore.finalizeRun()\n TestAnalysisManager.maybeNotify()\n\n val newVersion = Updates.checkForUpdates()\n if (newVersion != null) {\n Updates.fetchChangelogAsync()\n System.err.println()\n val changelog = Updates.getChangelog()\n val anchor = newVersion.toString().replace(\".\", \"\")\n System.err.println(\n listOf(\n \"A new version of the Maestro CLI is available ($newVersion).\\n\",\n \"See what's new:\",\n \"https://github.com/mobile-dev-inc/maestro/blob/main/CHANGELOG.md#$anchor\",\n ChangeLogUtils.print(changelog),\n \"Upgrade command:\",\n \"curl -Ls \\\"https://get.maestro.mobile.dev\\\" | bash\",\n ).joinToString(\"\\n\").box()\n )\n }\n\n if (commandLine.isVersionHelpRequested) {\n printVersion()\n Analytics.close()\n exitProcess(0)\n }\n\n Analytics.close()\n exitProcess(exitCode)\n } catch (e: Throwable) {\n Analytics.close()\n throw e\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/CliError.kt", "content": "package maestro.cli\n\nclass CliError(override val message: String) : RuntimeException(message)\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/Dependencies.kt", "content": "package maestro.cli\n\nimport maestro.cli.util.Unpacker.binaryDependency\nimport maestro.cli.util.Unpacker.unpack\n\nobject Dependencies {\n private val appleSimUtils = binaryDependency(\"applesimutils\")\n\n fun install() {\n unpack(\n jarPath = \"deps/applesimutils\",\n target = appleSimUtils,\n )\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/DisableAnsiMixin.kt", "content": "package maestro.cli\n\nimport org.fusesource.jansi.Ansi\nimport org.fusesource.jansi.AnsiConsole\nimport org.fusesource.jansi.internal.CLibrary\nimport picocli.CommandLine\n\nclass DisableAnsiMixin {\n @CommandLine.Option(\n names = [\"--no-color\", \"--no-ansi\"],\n negatable = true,\n description = [\"Enable / disable colors and ansi output\"]\n )\n var enableANSIOutput = true\n\n companion object {\n var ansiEnabled = true\n private set\n\n fun executionStrategy(parseResult: CommandLine.ParseResult): Int {\n applyCLIMixin(parseResult)\n return CommandLine.RunLast().execute(parseResult)\n }\n\n private fun findFirstParserWithMatchedParamLabel(parseResult: CommandLine.ParseResult, paramLabel: String): CommandLine.ParseResult? {\n val found = parseResult.matchedOptions().find { it.paramLabel() == paramLabel }\n if (found != null) {\n return parseResult\n }\n\n parseResult.subcommands().forEach {\n return findFirstParserWithMatchedParamLabel(it, paramLabel) ?: return@forEach\n }\n\n return null\n }\n\n private fun applyCLIMixin(parseResult: CommandLine.ParseResult) {\n // Find the first mixin for which of the enable-ansi parameter was specified\n val parserWithANSIOption = findFirstParserWithMatchedParamLabel(parseResult, \"\")\n val mixin = parserWithANSIOption?.commandSpec()?.mixins()?.values?.firstNotNullOfOrNull { it.userObject() as? DisableAnsiMixin }\n\n val stdoutIsTTY = CLibrary.isatty(CLibrary.STDOUT_FILENO) != 0\n ansiEnabled = mixin?.enableANSIOutput // Use the param value if it was specified\n ?: stdoutIsTTY // Otherwise fall back to checking if output is a tty\n\n Ansi.setEnabled(ansiEnabled)\n\n if (ansiEnabled) {\n AnsiConsole.systemInstall()\n }\n }\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/ShowHelpMixin.kt", "content": "package maestro.cli\n\nimport picocli.CommandLine\n\nclass ShowHelpMixin {\n @CommandLine.Option(\n names = [\"-h\", \"--help\"],\n usageHelp = true,\n description = [\"Display help message\"],\n )\n var help = false\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/analytics/Analytics.kt", "content": "package maestro.cli.analytics\n\nimport com.fasterxml.jackson.databind.DeserializationFeature\nimport com.fasterxml.jackson.module.kotlin.jacksonObjectMapper\nimport com.posthog.server.PostHog\nimport com.posthog.server.PostHogConfig\nimport com.posthog.server.PostHogInterface\nimport maestro.auth.ApiKey\nimport maestro.cli.api.ApiClient\nimport maestro.cli.util.EnvUtils\nimport org.slf4j.LoggerFactory\nimport java.nio.file.Path\nimport java.util.concurrent.Executors\nimport java.util.concurrent.TimeUnit\nimport kotlin.String\n\nobject Analytics : AutoCloseable {\n private const val POSTHOG_API_KEY: String = \"phc_XKhdIS7opUZiS58vpOqbjzgRLFpi0I6HU2g00hR7CVg\"\n private const val POSTHOG_HOST: String = \"https://us.i.posthog.com\"\n private const val DISABLE_ANALYTICS_ENV_VAR = \"MAESTRO_CLI_NO_ANALYTICS\"\n private val JSON = jacksonObjectMapper().configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)\n private val apiClient = ApiClient(EnvUtils.BASE_API_URL)\n private val posthog: PostHogInterface = PostHog.with(\n PostHogConfig.builder(POSTHOG_API_KEY)\n .host(POSTHOG_HOST)\n .build()\n )\n\n private val logger = LoggerFactory.getLogger(Analytics::class.java)\n private val analyticsStatePath: Path = EnvUtils.xdgStateHome().resolve(\"analytics.json\")\n private val analyticsStateManager = AnalyticsStateManager(analyticsStatePath)\n\n // Simple executor for analytics events - following ErrorReporter pattern\n private val executor = Executors.newCachedThreadPool {\n Executors.defaultThreadFactory().newThread(it).apply { isDaemon = true }\n }\n\n private val analyticsDisabledWithEnvVar: Boolean\n get() = System.getenv(DISABLE_ANALYTICS_ENV_VAR) != null\n\n val hasRunBefore: Boolean\n get() = analyticsStateManager.hasRunBefore()\n\n val uuid: String\n get() = analyticsStateManager.getState().uuid\n\n\n /**\n * Super properties to be sent with the event\n */\n private val superProperties = SuperProperties.create()\n\n /**\n * Call initially just to inform user and set a default state\n */\n fun warnAndEnableAnalyticsIfNotDisable() {\n if (hasRunBefore) return\n val analyticsShouldBeEnabled = !analyticsDisabledWithEnvVar\n if (analyticsShouldBeEnabled)\n println(\"Anonymous analytics enabled. To opt out, set $DISABLE_ANALYTICS_ENV_VAR environment variable to any value before running Maestro.\\n\")\n analyticsStateManager.saveInitialState(granted = analyticsShouldBeEnabled, uuid = uuid)\n }\n\n /**\n * Identify user in PostHog and update local state.\n *\n * This function:\n * 1. Sends user identification to PostHog analytics\n * 2. Updates local analytics state with user info\n * 3. Tracks login event for analytics\n *\n * Should only be called when user identity changes (login/logout).\n */\n fun identifyAndUpdateState(token: String) {\n try {\n val user = apiClient.getUser(token)\n val org = apiClient.getOrg(token)\n\n // Update local state with user info\n val updatedAnalyticsState = analyticsStateManager.updateState(token, user, org)\n val identifyProperties = UserProperties.fromAnalyticsState(updatedAnalyticsState).toMap()\n\n // Send identification to PostHog\n posthog.identify(analyticsStateManager.getState().uuid, identifyProperties)\n // Track user authentication event\n val isFirstAuth = analyticsStateManager.getState().cachedToken == null\n trackEvent(UserAuthenticatedEvent(\n isFirstAuth = isFirstAuth,\n authMethod = \"oauth\"\n ))\n } catch (e: Exception) {\n // Analytics failures should never break CLI functionality or show errors to users\n logger.trace(\"Failed to identify user: ${e.message}\", e)\n }\n }\n\n /**\n * Conditionally identify user based on current and cashed token\n */\n fun identifyUserIfNeeded() {\n // No identification needed if token is null\n val token = ApiKey.getToken() ?: return\n val cachedToken = analyticsStateManager.getState().cachedToken\n // No identification needed if token is same as cachedToken\n if (!cachedToken.isNullOrEmpty() && (token == cachedToken)) return\n // Else Update identification\n identifyAndUpdateState(token)\n }\n\n /**\n * Track events asynchronously to prevent blocking CLI operations\n * Use this for important events like authentication, errors, test results, etc.\n * This method is \"fire and forget\" - it will never block the calling thread\n */\n fun trackEvent(event: PostHogEvent) {\n executor.submit {\n try {\n if (!analyticsStateManager.getState().enabled || analyticsDisabledWithEnvVar) return@submit\n\n identifyUserIfNeeded()\n\n // Include super properties in each event since PostHog Java client doesn't have register\n val eventData = convertEventToEventData(event)\n val userState = analyticsStateManager.getState()\n val groupProperties = userState.orgId?.let { orgId ->\n mapOf(\n \"\\$groups\" to mapOf(\n \"company\" to orgId\n )\n )\n } ?: emptyMap()\n val properties =\n eventData.properties +\n superProperties.toMap() +\n UserProperties.fromAnalyticsState(userState).toMap() +\n groupProperties\n\n // Send Event\n posthog.capture(\n uuid,\n eventData.eventName,\n properties\n )\n } catch (e: Exception) {\n // Analytics failures should never break CLI functionality\n logger.trace(\"Failed to track event ${event.name}: ${e.message}\", e)\n }\n }\n }\n\n /**\n * Flush pending PostHog events immediately\n * Use this when you need to ensure events are sent before continuing\n */\n fun flush() {\n try {\n posthog.flush()\n } catch (e: Exception) {\n // Analytics failures should never break CLI functionality or show errors to users\n logger.trace(\"Failed to flush PostHog: ${e.message}\", e)\n }\n }\n\n /**\n * Convert a PostHogEvent to EventData with eventName and properties separated\n * This allows for clean destructuring in the calling code\n */\n private fun convertEventToEventData(event: PostHogEvent): EventData {\n return try {\n // Use Jackson to convert the data class to a Map\n val jsonString = JSON.writeValueAsString(event)\n val eventMap = JSON.readValue(jsonString, Map::class.java) as Map\n\n // Extract the name and create properties without it\n val eventName = event.name\n val properties = eventMap.filterKeys { it != \"name\" }\n\n EventData(eventName, properties)\n } catch (e: Exception) {\n // Analytics failures should never break CLI functionality or show errors to users\n logger.trace(\"Failed to serialize event ${event.name}: ${e.message}\", e)\n EventData(event.name, mapOf())\n }\n }\n\n /**\n * Close and cleanup resources\n * Ensures pending analytics events are sent before shutdown\n */\n override fun close() {\n // First, flush any pending PostHog events before shutting down threads\n flush()\n\n // Now shutdown PostHog to cleanup resources\n try {\n posthog.close()\n } catch (e: Exception) {\n // Analytics failures should never break CLI functionality or show errors to users\n logger.trace(\"Failed to close PostHog: ${e.message}\", e)\n }\n\n // Now shutdown the executor\n try {\n executor.shutdown()\n if (!executor.awaitTermination(2, TimeUnit.SECONDS)) {\n // Analytics failures should never break CLI functionality or show errors to users\n logger.trace(\"Analytics executor did not shutdown gracefully, forcing shutdown\")\n executor.shutdownNow()\n }\n } catch (e: InterruptedException) {\n executor.shutdownNow()\n Thread.currentThread().interrupt()\n }\n }\n}\n\n/**\n * Data class to hold event name and properties for destructuring\n */\ndata class EventData(\n val eventName: String,\n val properties: Map\n)\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/analytics/AnalyticsStateManager.kt", "content": "package maestro.cli.analytics\n\nimport com.fasterxml.jackson.annotation.JsonFormat\nimport com.fasterxml.jackson.annotation.JsonIgnoreProperties\nimport com.fasterxml.jackson.databind.SerializationFeature\nimport com.fasterxml.jackson.datatype.jsr310.JavaTimeModule\nimport com.fasterxml.jackson.module.kotlin.jacksonObjectMapper\nimport com.fasterxml.jackson.module.kotlin.readValue\nimport maestro.cli.api.OrgResponse\nimport maestro.cli.api.UserResponse\nimport maestro.cli.util.CiUtils\nimport maestro.cli.util.EnvUtils\nimport org.slf4j.LoggerFactory\nimport java.nio.file.Path\nimport java.time.Instant\nimport java.time.LocalDate\nimport java.time.format.DateTimeFormatter\nimport java.time.format.DateTimeParseException\nimport java.util.*\nimport kotlin.String\nimport kotlin.io.path.exists\nimport kotlin.io.path.readText\nimport kotlin.io.path.writeText\n\n\n@JsonIgnoreProperties(ignoreUnknown = true)\ndata class AnalyticsState(\n val uuid: String,\n val enabled: Boolean,\n val cachedToken: String? = null,\n val lastUploadedForCLI: String? = null,\n @JsonFormat(shape = JsonFormat.Shape.STRING, timezone = \"UTC\") val lastUploadedTime: Instant?,\n val email: String? = null,\n val user_id: String? = null,\n val name: String? = null,\n val workOSOrgId: String? = null,\n val orgId: String? = null,\n val orgName: String? = null,\n val orgPlan: String? = null,\n val orgTrialExpiresOn: String? = null,\n // Org status properties\n val orgStatus: OrgStatus? = null,\n val currentPlan: OrgPlans? = null,\n val isInTrial: Boolean? = null,\n val daysUntilTrialExpiry: Int? = null,\n val daysUntilGracePeriodExpiry: Int? = null\n)\n\n/**\n * Manages analytics state persistence and caching.\n * Separated from Analytics object to improve separation of concerns.\n */\nclass AnalyticsStateManager(\n private val analyticsStatePath: Path\n) {\n private val logger = LoggerFactory.getLogger(AnalyticsStateManager::class.java)\n \n private val JSON = jacksonObjectMapper().apply {\n registerModule(JavaTimeModule())\n enable(SerializationFeature.INDENT_OUTPUT)\n }\n\n private var _analyticsState: AnalyticsState? = null\n\n fun getState(): AnalyticsState {\n if (_analyticsState == null) {\n _analyticsState = loadState()\n }\n return _analyticsState!!\n }\n\n fun hasRunBefore(): Boolean {\n return analyticsStatePath.exists()\n }\n\n fun updateState(\n token: String,\n user: UserResponse,\n org: OrgResponse,\n ): AnalyticsState {\n val currentState = getState()\n val updatedState = currentState.copy(\n cachedToken = token,\n lastUploadedForCLI = EnvUtils.CLI_VERSION?.toString(),\n lastUploadedTime = Instant.now(),\n user_id = user.id,\n email = user.email,\n name = user.name,\n workOSOrgId = user.workOSOrgId,\n orgId = org.id,\n orgName = org.name,\n orgPlan = org.metadata?.get(\"pricing_plan\"),\n ).addOrgStatusProperties(org)\n saveState(updatedState)\n return updatedState\n }\n\n fun saveInitialState(\n granted: Boolean,\n uuid: String? = null,\n ): AnalyticsState {\n val state = AnalyticsState(\n uuid = uuid ?: generateUUID(),\n enabled = granted,\n lastUploadedTime = null\n )\n saveState(state)\n return state\n }\n\n private fun saveState(state: AnalyticsState) {\n val stateJson = JSON.writeValueAsString(state)\n analyticsStatePath.parent.toFile().mkdirs()\n analyticsStatePath.writeText(stateJson + \"\\n\")\n logger.trace(\"Saved analytics to {}, value: {}\", analyticsStatePath, stateJson)\n \n // Refresh the cached state\n _analyticsState = state\n }\n\n private fun loadState(): AnalyticsState {\n return try {\n if (analyticsStatePath.exists()) {\n JSON.readValue(analyticsStatePath.readText())\n } else {\n createDefaultState()\n }\n } catch (e: Exception) {\n logger.warn(\"Failed to read analytics state: ${e.message}. Using default.\")\n createDefaultState()\n }\n }\n\n private fun createDefaultState(): AnalyticsState {\n return AnalyticsState(\n uuid = generateUUID(),\n enabled = false,\n lastUploadedTime = null,\n )\n }\n\n private fun generateUUID(): String {\n return CiUtils.getCiProvider() ?: UUID.randomUUID().toString()\n }\n}\n\n/**\n * Extension function to add organization status to AnalyticsState\n */\nfun AnalyticsState.addOrgStatusProperties(org: OrgResponse?): AnalyticsState {\n if (org == null) return this\n\n val orgStatus = getOrgStatus(org)\n val pricingPlan = org.metadata?.get(\"pricing_plan\")\n\n // Trial status requires checking both plan type and org status\n val isInTrial = pricingPlan == \"BASIC\" && orgStatus == OrgStatus.ACTIVE && org.metadata[\"trial_expires_on\"] != null\n\n return this.copy(\n orgStatus = orgStatus,\n currentPlan = pricingPlan?.let { OrgPlans.valueOf(it) },\n isInTrial = isInTrial,\n daysUntilTrialExpiry = if (isInTrial) calculateDaysUntil(org.metadata[\"trial_expires_on\"]) else null,\n daysUntilGracePeriodExpiry = if (orgStatus == OrgStatus.IN_GRACE_PERIOD) calculateDaysUntil(org.metadata?.get(\"subscription_grace_period\")) else null\n )\n}\n\n/**\n * Helper function to get organization status\n */\nprivate fun getOrgStatus(org: OrgResponse?): OrgStatus? {\n if (org == null) return null\n if (org.metadata == null) return null\n\n val trialExpirationDate = org.metadata.get(\"trial_expires_on\")\n val pricingPlan = org.metadata.get(\"pricing_plan\")\n val gracePeriod = org.metadata.get(\"subscription_grace_period\")\n\n if (gracePeriod != null) {\n val graceDate = parseDate(gracePeriod)\n if (graceDate != null) {\n val now = LocalDate.now()\n // If grace period is in the past, expired\n return if (graceDate.isBefore(now)) {\n OrgStatus.GRACE_PERIOD_EXPIRED\n } else {\n OrgStatus.IN_GRACE_PERIOD\n }\n } else {\n // If we can't parse the date, assume it's active\n return OrgStatus.IN_GRACE_PERIOD\n }\n }\n\n if (pricingPlan == \"BASIC\" && trialExpirationDate != null) {\n val trialDate = parseDate(trialExpirationDate)\n if (trialDate != null) {\n val now = LocalDate.now()\n if (trialDate.isBefore(now)) {\n return OrgStatus.TRIAL_EXPIRED\n } else {\n return OrgStatus.ACTIVE\n }\n } else {\n // If we can't parse the date, assume trial is active\n return OrgStatus.ACTIVE\n }\n }\n\n if (pricingPlan == \"BASIC\") {\n return OrgStatus.TRIAL_NOT_ACTIVE\n }\n\n if (listOf(\"CLOUD_MANUAL\", \"ENTERPRISE\", \"CLOUD\").contains(pricingPlan)) {\n return OrgStatus.ACTIVE\n }\n\n return OrgStatus.TRIAL_NOT_ACTIVE\n}\n\n/**\n * Helper function to parse dates in multiple formats\n */\nprivate fun parseDate(dateString: String?): LocalDate? {\n if (dateString == null) return null\n \n val formatters = listOf(\n DateTimeFormatter.ISO_LOCAL_DATE, // \"2030-02-19\"\n DateTimeFormatter.ofPattern(\"MMM d yyyy\", Locale.ENGLISH), // \"Sep 1 2025\"\n DateTimeFormatter.ofPattern(\"MMM dd yyyy\", Locale.ENGLISH), // \"Sep 01 2025\" (with zero-padded day)\n DateTimeFormatter.ofPattern(\"MMMM d yyyy\", Locale.ENGLISH), // \"September 1 2025\"\n DateTimeFormatter.ofPattern(\"MMMM dd yyyy\", Locale.ENGLISH), // \"September 01 2025\" (with zero-padded day)\n DateTimeFormatter.ofPattern(\"MM/dd/yyyy\"), // \"02/19/2030\"\n DateTimeFormatter.ofPattern(\"dd/MM/yyyy\"), // \"19/02/2030\"\n DateTimeFormatter.ofPattern(\"yyyy-MM-dd\"), // \"2030-02-19\"\n )\n \n for (formatter in formatters) {\n try {\n return LocalDate.parse(dateString, formatter)\n } catch (e: DateTimeParseException) {\n // Try next formatter\n }\n }\n return null\n}\n\n/**\n * Helper function to calculate days until a date\n */\nprivate fun calculateDaysUntil(dateString: String?): Int? {\n if (dateString == null) return null\n val targetDate = parseDate(dateString) ?: return null\n val now = LocalDate.now()\n return java.time.temporal.ChronoUnit.DAYS.between(now, targetDate).toInt()\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/analytics/PostHogEvents.kt", "content": "package maestro.cli.analytics\n\nimport maestro.cli.model.FlowStatus\nimport maestro.cli.util.EnvUtils\nimport maestro.cli.util.IOSEnvUtils\nimport maestro.device.util.AndroidEnvUtils\n\n/**\n * Organization status enum\n */\nenum class OrgStatus(val value: String) {\n TRIAL_EXPIRED(\"TRIAL_EXPIRED\"),\n GRACE_PERIOD_EXPIRED(\"GRACE_PERIOD_EXPIRED\"),\n ACTIVE(\"ACTIVE\"),\n TRIAL_NOT_ACTIVE(\"TRIAL_NOT_ACTIVE\"),\n IN_GRACE_PERIOD(\"IN_GRACE_PERIOD\");\n}\n\nenum class OrgPlans(val value: String) {\n BASIC(\"BASIC\"),\n CLOUD(\"CLOUD\"),\n CLOUD_MANUAL(\"CLOUD_MANUAL\"),\n ENTERPRISE(\"ENTERPRISE\"),\n}\n\n/**\n * Strongly-typed PostHog events for Maestro CLI using discriminated unions\n * This ensures compile-time type safety for all analytics events\n */\n\n/**\n * Super properties that are automatically included with every event\n */\ndata class SuperProperties(\n val app_version: String,\n val platform: String,\n val env: String,\n val app: String = \"cli\",\n val cli_version: String,\n val java_version: String,\n val os_arch: String,\n val os_version: String,\n val xcode_version: String? = null,\n val flutter_version: String? = null,\n val flutter_channel: String? = null,\n val android_versions: List? = null,\n val ios_versions: List? = null,\n) {\n /**\n * Convert to Map for analytics tracking\n */\n fun toMap(): Map {\n return mapOf(\n \"app_version\" to app_version,\n \"platform\" to platform,\n \"env\" to env,\n \"app\" to app,\n \"cli_version\" to cli_version,\n \"java_version\" to java_version,\n \"os_arch\" to os_arch,\n \"os_version\" to os_version,\n \"xcode_version\" to xcode_version,\n \"flutter_version\" to flutter_version,\n \"flutter_channel\" to flutter_channel,\n \"android_versions\" to android_versions,\n \"ios_versions\" to ios_versions\n ) as Map\n }\n \n /**\n * Create SuperProperties with current system information\n */\n companion object {\n fun create(): SuperProperties {\n return SuperProperties(\n app_version = EnvUtils.getVersion().toString(),\n platform = EnvUtils.OS_NAME,\n env = if (System.getenv(\"MAESTRO_API_URL\") != null) \"dev\" else \"prod\",\n app = \"cli\",\n cli_version = EnvUtils.CLI_VERSION.toString(),\n java_version = EnvUtils.getJavaVersion().toString(),\n os_arch = EnvUtils.OS_ARCH,\n os_version = EnvUtils.OS_VERSION,\n xcode_version = IOSEnvUtils.xcodeVersion,\n flutter_version = EnvUtils.getFlutterVersionAndChannel().first,\n flutter_channel = EnvUtils.getFlutterVersionAndChannel().second,\n android_versions = AndroidEnvUtils.androidEmulatorSdkVersions,\n ios_versions = IOSEnvUtils.simulatorRuntimes\n )\n }\n }\n}\n\n/**\n * User properties for user identification\n */\ndata class UserProperties(\n val user_id: String?,\n val email: String?,\n val name: String?,\n val organizationId: String? = null,\n val org_id: String?,\n val org_name: String?,\n val plan: String?,\n val orgPlan: String?,\n val orgTrialExpiresOn: String?,\n) {\n /**\n * Convert to Map for analytics tracking\n */\n fun toMap(): Map {\n return mapOf(\n \"user_id\" to user_id,\n \"email\" to email,\n \"name\" to name,\n \"organizationId\" to organizationId,\n \"org_id\" to org_id,\n \"org_name\" to org_name,\n \"plan\" to plan,\n \"orgPlan\" to orgPlan,\n \"orgTrialExpiresOn\" to orgTrialExpiresOn\n ) as Map\n }\n /**\n * Create UserProperties from AnalyticsState\n */\n companion object {\n fun fromAnalyticsState(state: AnalyticsState): UserProperties {\n return UserProperties(\n user_id = state.user_id,\n email = state.email,\n name = state.name,\n organizationId = state.orgId,\n org_id = state.orgId,\n org_name = state.orgName,\n plan = state.orgPlan,\n orgPlan = state.orgPlan,\n orgTrialExpiresOn = state.orgTrialExpiresOn,\n )\n }\n }\n}\n\n/**\n * Base interface for all PostHog events\n */\nsealed interface PostHogEvent {\n val name: String\n}\n\n/**\n * CLI Usage Events\n */\nsealed interface CliUsageEvent : PostHogEvent\n\ndata class CliCommandRunEvent(\n override val name: String = \"maestro_cli_command_run\",\n val command: String\n) : CliUsageEvent\n\n/**\n * Test execution events\n */\nsealed interface TestRunEvent : PostHogEvent\n\ndata class TestRunStartedEvent(\n override val name: String = \"test_run_started\",\n val platform: String,\n) : TestRunEvent\n\ndata class TestRunFailedEvent(\n override val name: String = \"test_run_failed\",\n val error: String,\n val platform: String,\n) : TestRunEvent\n\ndata class TestRunFinishedEvent(\n override val name: String = \"test_run_finished\",\n val status: FlowStatus,\n val platform: String,\n val durationMs: Long\n) : TestRunEvent\n\n\n/**\n * Workspace execution events\n */\nsealed interface WorkspaceRunEvent : PostHogEvent\n\ndata class WorkspaceRunStartedEvent(\n override val name: String = \"workspace_run_started\",\n val flowCount: Int,\n val platform: String,\n val deviceCount: Int\n) : WorkspaceRunEvent\n\ndata class WorkspaceRunFailedEvent(\n override val name: String = \"workspace_run_failed\",\n val error: String,\n val flowCount: Int,\n val platform: String,\n val deviceCount: Int,\n) : WorkspaceRunEvent\n\ndata class WorkspaceRunFinishedEvent(\n override val name: String = \"workspace_run_finished\",\n val flowCount: Int,\n val platform: String,\n val deviceCount: Int,\n val durationMs: Long\n) : WorkspaceRunEvent\n\n/**\n * Record Screen Event\n */\nsealed interface RecordEvent : PostHogEvent\n\ndata class RecordStartedEvent(\n override val name: String = \"maestro_cli_record_start\",\n val platform: String,\n) : RecordEvent\n\ndata class RecordFinishedEvent(\n override val name: String = \"maestro_cli_record_finished\",\n val platform: String,\n val durationMs: Long\n) : RecordEvent\n\n/**\n * Cloud Upload Events\n */\nsealed interface CloudUploadEvent : PostHogEvent\n\ndata class CloudUploadTriggeredEvent(\n override val name: String = \"cloud_upload_triggered\",\n val projectId: String,\n val isBinaryUpload: Boolean = false,\n val usesEnvironment: Boolean = false,\n val deviceModel: String? = null,\n val deviceOs: String? = null\n) : CloudUploadEvent\n\ndata class CloudUploadStartedEvent(\n override val name: String = \"cloud_upload_started\",\n val projectId: String,\n val isBinaryUpload: Boolean = false,\n val usesEnvironment: Boolean = false,\n val platform: String,\n val deviceModel: String? = null,\n val deviceOs: String? = null\n) : CloudUploadEvent\n\ndata class CloudUploadSucceededEvent(\n override val name: String = \"cloud_upload_succeeded\",\n val projectId: String,\n val platform: String,\n val isBinaryUpload: Boolean,\n val usesEnvironment: Boolean,\n val deviceModel: String? = null,\n val deviceOs: String? = null,\n) : CloudUploadEvent\n\n/**\n * Cloud Run Event\n */\nsealed interface CloudRunEvent : PostHogEvent\n\ndata class CloudRunFinishedEvent(\n override val name: String = \"cloud_run_finished\",\n val projectId: String,\n val appPackageId: String,\n val totalFlows: Number,\n val totalPassedFlows: Number,\n val totalFailedFlows: Number,\n val wasAppLaunched: Boolean\n) : CloudRunEvent\n\n/**\n * User Auth Event\n */\n\nsealed interface AuthEvent : PostHogEvent\n\ndata class UserAuthenticatedEvent(\n override val name: String = \"user_authenticated\",\n val isFirstAuth: Boolean,\n val authMethod: String,\n) : AuthEvent\n\ndata class UserLoggedOutEvent(\n override val name: String = \"user_logged_out\",\n) : AuthEvent\n\n/**\n * Print Hierarchy Events\n */\nsealed interface PrintHierarchyEvent : PostHogEvent\n\ndata class PrintHierarchyStartedEvent(\n override val name: String = \"print_hierarchy_started\",\n val platform: String\n) : PrintHierarchyEvent\n\ndata class PrintHierarchyFinishedEvent(\n override val name: String = \"print_hierarchy_finished\",\n val platform: String,\n val success: Boolean,\n val durationMs: Long,\n val errorMessage: String? = null\n) : PrintHierarchyEvent\n\n/**\n * Trial Events\n */\nsealed interface TrialEvent : PostHogEvent\n\ndata class TrialStartPromptedEvent(\n override val name: String = \"trial_start_prompted\",\n) : TrialEvent\n\ndata class TrialStartedEvent(\n override val name: String = \"trial_started\",\n val companyName: String,\n) : TrialEvent\n\ndata class TrialStartFailedEvent(\n override val name: String = \"trial_start_failed\",\n val companyName: String,\n val failureReason: String,\n) : TrialEvent\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/api/ApiClient.kt", "content": "package maestro.cli.api\n\nimport com.fasterxml.jackson.annotation.JsonIgnoreProperties\nimport com.fasterxml.jackson.core.type.TypeReference\nimport com.fasterxml.jackson.databind.DeserializationFeature\nimport com.fasterxml.jackson.module.kotlin.jacksonObjectMapper\nimport com.github.michaelbull.result.Err\nimport com.github.michaelbull.result.Ok\nimport com.github.michaelbull.result.Result\nimport maestro.cli.CliError\nimport maestro.cli.analytics.Analytics\nimport maestro.cli.analytics.TrialStartedEvent\nimport maestro.cli.analytics.TrialStartFailedEvent\nimport maestro.cli.analytics.TrialStartPromptedEvent\nimport maestro.cli.insights.AnalysisDebugFiles\nimport maestro.cli.model.FlowStatus\nimport maestro.cli.runner.resultview.AnsiResultView\nimport maestro.cli.util.CiUtils\nimport maestro.cli.util.EnvUtils\nimport maestro.cli.util.PrintUtils\nimport maestro.cli.view.brightRed\nimport maestro.cli.view.cyan\nimport maestro.cli.view.green\nimport maestro.utils.HttpClient\nimport okhttp3.Interceptor\nimport okhttp3.MediaType.Companion.toMediaType\nimport okhttp3.MultipartBody\nimport okhttp3.Protocol\nimport okhttp3.Request\nimport okhttp3.RequestBody\nimport okhttp3.RequestBody.Companion.asRequestBody\nimport okhttp3.RequestBody.Companion.toRequestBody\nimport okhttp3.Response\nimport okio.Buffer\nimport okio.BufferedSink\nimport okio.ForwardingSink\nimport okio.IOException\nimport okio.buffer\nimport java.io.File\nimport java.nio.file.Path\nimport java.util.Scanner\nimport kotlin.io.path.absolutePathString\nimport kotlin.io.path.exists\nimport kotlin.time.Duration.Companion.minutes\n\nclass ApiClient(\n private val baseUrl: String,\n) {\n\n private val client = HttpClient.build(\n name = \"ApiClient\",\n readTimeout = 5.minutes,\n writeTimeout = 5.minutes,\n protocols = listOf(Protocol.HTTP_1_1),\n interceptors = listOf(SystemInformationInterceptor()),\n )\n\n val domain: String\n get() {\n val regex = \"https?://[^.]+.([a-zA-Z0-9.-]*).*\".toRegex()\n val matchResult = regex.matchEntire(baseUrl)\n val domain = if (!matchResult?.groups?.get(1)?.value.isNullOrEmpty()) {\n matchResult?.groups?.get(1)?.value\n } else {\n matchResult?.groups?.get(0)?.value\n }\n return domain ?: \"mobile.dev\"\n }\n\n fun sendErrorReport(exception: Exception, commandLine: String) {\n post(\n path = \"/maestro/error\",\n body = mapOf(\n \"exception\" to exception,\n \"commandLine\" to commandLine\n )\n )\n }\n\n fun sendScreenReport(maxDepth: Int) {\n post(\n path = \"/maestro/screen\",\n body = mapOf(\n \"maxDepth\" to maxDepth\n )\n )\n }\n\n fun getLatestCliVersion(): CliVersion {\n val request = Request.Builder()\n .header(\"X-FRESH-INSTALL\", if (!Analytics.hasRunBefore) \"true\" else \"false\")\n .url(\"$baseUrl/v2/maestro/version\")\n .get()\n .build()\n\n val response = try {\n client.newCall(request).execute()\n } catch (e: IOException) {\n throw ApiException(statusCode = null)\n }\n\n response.use {\n if (!response.isSuccessful) {\n throw ApiException(\n statusCode = response.code\n )\n }\n\n return JSON.readValue(response.body?.bytes(), CliVersion::class.java)\n }\n }\n\n fun getAuthUrl(port: String): String {\n return \"$baseUrl/v2/maestroLogin/authUrl?port=$port\"\n }\n\n fun exchangeToken(code: String): String {\n val requestBody = code.toRequestBody(\"text/plain\".toMediaType())\n\n val request = Request.Builder()\n .url(\"$baseUrl/v2/maestroLogin/exchange\")\n .post(requestBody)\n .build()\n\n try {\n client.newCall(request).execute().use { response ->\n val responseBody = response.body?.string()\n println(responseBody ?: \"No response body received\")\n if (!response.isSuccessful) {\n throw IOException(\"HTTP ${response.code}: ${response.message}\\nBody: $responseBody\")\n }\n return responseBody ?: throw IOException(\"Empty response body\")\n }\n } catch (e: Exception) {\n throw IOException(\"${e.message}\", e)\n }\n }\n\n fun isAuthTokenValid(authToken: String): Boolean {\n val request = Request.Builder()\n .url(\"$baseUrl/v2/maestroLogin/valid\")\n .header(\"Authorization\", \"Bearer $authToken\")\n .get()\n .build()\n\n client.newCall(request).execute().use { response ->\n return !(!response.isSuccessful && (response.code == 401 || response.code == 403))\n }\n }\n\n private fun getAgent(): String {\n return CiUtils.getCiProvider() ?: \"cli\"\n }\n\n fun uploadStatus(\n authToken: String,\n uploadId: String,\n projectId: String?,\n ): UploadStatus {\n val baseUrl = \"$baseUrl/v2/project/$projectId/upload/$uploadId\"\n\n val request = Request.Builder()\n .header(\"Authorization\", \"Bearer $authToken\")\n .url(baseUrl)\n .get()\n .build()\n\n val response = try {\n client.newCall(request).execute()\n } catch (e: IOException) {\n throw ApiException(statusCode = null)\n }\n\n response.use {\n if (!response.isSuccessful) {\n throw ApiException(\n statusCode = response.code\n )\n }\n\n return JSON.readValue(response.body?.bytes(), UploadStatus::class.java)\n }\n }\n\n fun render(\n screenRecording: File,\n frames: List,\n progressListener: (totalBytes: Long, bytesWritten: Long) -> Unit = { _, _ -> },\n ): String {\n val baseUrl = \"https://maestro-record.ngrok.io\"\n val body = MultipartBody.Builder()\n .setType(MultipartBody.FORM)\n .addFormDataPart(\n \"screenRecording\",\n screenRecording.name,\n screenRecording.asRequestBody(\"application/mp4\".toMediaType()).observable(progressListener)\n )\n .addFormDataPart(\"frames\", JSON.writeValueAsString(frames))\n .build()\n val request = Request.Builder()\n .url(\"$baseUrl/render\")\n .post(body)\n .build()\n val response = client.newCall(request).execute().use { response ->\n if (!response.isSuccessful) {\n throw CliError(\"Render request failed (${response.code}): ${response.body?.string()}\")\n }\n JSON.readValue(response.body?.bytes(), RenderResponse::class.java)\n }\n return response.id\n }\n\n fun getRenderState(id: String): RenderState {\n val baseUrl = \"https://maestro-record.ngrok.io\"\n val request = Request.Builder()\n .url(\"$baseUrl/v2/render/$id\")\n .get()\n .build()\n val response = client.newCall(request).execute().use { response ->\n if (!response.isSuccessful) {\n throw CliError(\"Get render state request failed (${response.code}): ${response.body?.string()}\")\n }\n JSON.readValue(response.body?.bytes(), RenderState::class.java)\n }\n val downloadUrl = if (response.downloadUrl == null) null else \"$baseUrl${response.downloadUrl}\"\n return response.copy(downloadUrl = downloadUrl)\n }\n\n fun upload(\n authToken: String,\n appFile: Path?,\n workspaceZip: Path,\n uploadName: String?,\n mappingFile: Path?,\n repoOwner: String?,\n repoName: String?,\n branch: String?,\n commitSha: String?,\n pullRequestId: String?,\n env: Map? = null,\n appBinaryId: String? = null,\n includeTags: List = emptyList(),\n excludeTags: List = emptyList(),\n maxRetryCount: Int = 3,\n completedRetries: Int = 0,\n disableNotifications: Boolean,\n deviceLocale: String? = null,\n progressListener: (totalBytes: Long, bytesWritten: Long) -> Unit = { _, _ -> },\n projectId: String,\n deviceModel: String? = null,\n deviceOs: String? = null,\n androidApiLevel: Int?,\n iOSVersion: String? = null,\n ): UploadResponse {\n if (appBinaryId == null && appFile == null) throw CliError(\"Missing required parameter for option '--app-file' or '--app-binary-id'\")\n if (appFile != null && !appFile.exists()) throw CliError(\"App file does not exist: ${appFile.absolutePathString()}\")\n if (!workspaceZip.exists()) throw CliError(\"Workspace zip does not exist: ${workspaceZip.absolutePathString()}\")\n\n val requestPart = mutableMapOf()\n if (uploadName != null) {\n requestPart[\"benchmarkName\"] = uploadName\n }\n repoOwner?.let { requestPart[\"repoOwner\"] = it }\n repoName?.let { requestPart[\"repoName\"] = it }\n branch?.let { requestPart[\"branch\"] = it }\n commitSha?.let { requestPart[\"commitSha\"] = it }\n pullRequestId?.let { requestPart[\"pullRequestId\"] = it }\n env?.let { requestPart[\"env\"] = it }\n requestPart[\"agent\"] = getAgent()\n appBinaryId?.let { requestPart[\"appBinaryId\"] = it }\n deviceLocale?.let { requestPart[\"deviceLocale\"] = it }\n requestPart[\"projectId\"] = projectId\n deviceModel?.let { requestPart[\"deviceModel\"] = it }\n deviceOs?.let { requestPart[\"deviceOs\"] = it }\n if (includeTags.isNotEmpty()) requestPart[\"includeTags\"] = includeTags\n if (excludeTags.isNotEmpty()) requestPart[\"excludeTags\"] = excludeTags\n if (disableNotifications) requestPart[\"disableNotifications\"] = true\n\n val bodyBuilder = MultipartBody.Builder()\n .setType(MultipartBody.FORM)\n .addFormDataPart(\n \"workspace\",\n \"workspace.zip\",\n workspaceZip.toFile().asRequestBody(\"application/zip\".toMediaType())\n )\n .addFormDataPart(\"request\", JSON.writeValueAsString(requestPart))\n\n if (appFile != null) {\n bodyBuilder.addFormDataPart(\n \"app_binary\",\n \"app.zip\",\n appFile.toFile().asRequestBody(\"application/zip\".toMediaType()).observable(progressListener)\n )\n }\n\n if (mappingFile != null) {\n bodyBuilder.addFormDataPart(\n \"mapping\",\n \"mapping.txt\",\n mappingFile.toFile().asRequestBody(\"text/plain\".toMediaType())\n )\n }\n\n val body = bodyBuilder.build()\n\n fun retry(message: String, e: Throwable? = null): UploadResponse {\n if (completedRetries >= maxRetryCount) {\n e?.printStackTrace()\n throw CliError(message)\n }\n\n PrintUtils.message(\"$message, retrying (${completedRetries + 1}/$maxRetryCount)...\")\n Thread.sleep(BASE_RETRY_DELAY_MS + (2000 * completedRetries))\n\n return upload(\n authToken = authToken,\n appFile = appFile,\n workspaceZip = workspaceZip,\n uploadName = uploadName,\n mappingFile = mappingFile,\n repoOwner = repoOwner,\n repoName = repoName,\n branch = branch,\n commitSha = commitSha,\n pullRequestId = pullRequestId,\n env = env,\n includeTags = includeTags,\n excludeTags = excludeTags,\n maxRetryCount = maxRetryCount,\n completedRetries = completedRetries + 1,\n progressListener = progressListener,\n appBinaryId = appBinaryId,\n disableNotifications = disableNotifications,\n deviceLocale = deviceLocale,\n projectId = projectId,\n deviceModel = deviceModel,\n deviceOs = deviceOs,\n androidApiLevel = androidApiLevel,\n iOSVersion = iOSVersion,\n )\n }\n\n val url = \"$baseUrl/v2/project/$projectId/runMaestroTest\"\n\n val response = try {\n val request = Request.Builder()\n .header(\"Authorization\", \"Bearer $authToken\")\n .url(url)\n .post(body)\n .build()\n\n client.newCall(request).execute()\n } catch (e: IOException) {\n return retry(\"Upload failed due to socket exception\", e)\n }\n\n response.use {\n if (!response.isSuccessful) {\n val errorMessage = response.body?.string().takeIf { it?.isNotEmpty() == true } ?: \"Unknown\"\n\n if (response.code == 403 && errorMessage.contains(\n \"Your trial has not started yet\",\n ignoreCase = true\n )\n ) {\n Analytics.trackEvent(TrialStartPromptedEvent())\n PrintUtils.info(\"\\n[ERROR] Your trial has not started yet\".brightRed())\n PrintUtils.info(\"[INFO] Start your 7-day free trial with no credit card required!\".green())\n PrintUtils.info(\"${\"[INPUT]\".cyan()} Please enter your company name to start the free trial: \")\n \n val scanner = Scanner(System.`in`)\n val companyName = scanner.nextLine().trim()\n\n if (companyName.isNotEmpty()) {\n println(\"\\u001B[33;1m[INFO]\\u001B[0m Starting your trial for company: \\u001B[36;1m$companyName\\u001B[0m...\")\n\n val isTrialStarted = startTrial(authToken, companyName);\n if (isTrialStarted) {\n println(\"\\u001B[32;1m[SUCCESS]\\u001B[0m Free trial successfully started! Enjoy your 7-day free trial!\\n\")\n return upload(\n authToken = authToken,\n appFile = appFile,\n workspaceZip = workspaceZip,\n uploadName = uploadName,\n mappingFile = mappingFile,\n repoOwner = repoOwner,\n repoName = repoName,\n branch = branch,\n commitSha = commitSha,\n pullRequestId = pullRequestId,\n env = env,\n includeTags = includeTags,\n excludeTags = excludeTags,\n maxRetryCount = maxRetryCount,\n completedRetries = completedRetries + 1,\n progressListener = progressListener,\n appBinaryId = appBinaryId,\n disableNotifications = disableNotifications,\n deviceLocale = deviceLocale,\n projectId = projectId,\n deviceModel = deviceModel,\n deviceOs = deviceOs,\n androidApiLevel = androidApiLevel,\n iOSVersion = iOSVersion,\n )\n } else {\n println(\"\\u001B[31;1m[ERROR]\\u001B[0m Failed to start trial. Please check your details and try again.\")\n }\n } else {\n println(\"\\u001B[31;1m[ERROR]\\u001B[0m Company name is required to start your free trial.\")\n // Track trial start failed event for empty company name\n Analytics.trackEvent(TrialStartFailedEvent(\n companyName = \"\",\n failureReason = \"EMPTY_COMPANY_NAME\"\n ))\n }\n }\n\n if (response.code >= 500) {\n return retry(\"Upload failed with status code ${response.code}: $errorMessage\")\n } else {\n throw CliError(\"Upload request failed (${response.code}): $errorMessage\")\n }\n }\n\n val responseBody = JSON.readValue(response.body?.bytes(), Map::class.java)\n\n return parseUploadResponse(responseBody)\n }\n }\n\n private fun startTrial(authToken: String, companyName: String): Boolean {\n println(\"Starting your trial...\")\n val url = \"$baseUrl/v2/start-trial\"\n\n val request = StartTrialRequest(companyName, referralSource = \"cli\")\n val jsonBody = JSON.writeValueAsString(request).toRequestBody(\"application/json\".toMediaType())\n val trialRequest = Request.Builder()\n .header(\"Authorization\", \"Bearer $authToken\")\n .url(url)\n .post(jsonBody)\n .build()\n\n try {\n val response = client.newCall(trialRequest).execute()\n if (response.isSuccessful) {\n Analytics.trackEvent(TrialStartedEvent(companyName = companyName))\n return true\n }\n val errorMessage = response.body?.string() ?: \"Unknown error\"\n println(\"\\u001B[31m$errorMessage\\u001B[0m\");\n // Track trial start failed event\n Analytics.trackEvent(TrialStartFailedEvent(\n companyName = companyName,\n failureReason = \"API_ERROR: $errorMessage\"\n ))\n return false\n } catch (e: IOException) {\n println(\"\\u001B[31;1m[ERROR]\\u001B[0m We're experiencing connectivity issues, please try again in sometime, reach out to the slack channel in case if this doesn't work.\")\n // Track trial start failed event\n Analytics.trackEvent(TrialStartFailedEvent(\n companyName = companyName,\n failureReason = \"CONNECTIVITY_ERROR: ${e.message}\"\n ))\n return false\n }\n }\n\n private fun parseUploadResponse(responseBody: Map<*, *>): UploadResponse {\n @Suppress(\"UNCHECKED_CAST\")\n val orgId = responseBody[\"orgId\"] as String\n val uploadId = responseBody[\"uploadId\"] as String\n val appId = responseBody[\"appId\"] as String\n val appBinaryId = responseBody[\"appBinaryId\"] as String\n\n val deviceConfigMap = responseBody[\"deviceConfiguration\"] as Map\n val platform = deviceConfigMap[\"platform\"].toString().uppercase()\n val deviceConfiguration = DeviceConfiguration(\n platform = platform,\n deviceName = deviceConfigMap[\"deviceName\"] as String,\n orientation = deviceConfigMap[\"orientation\"] as String,\n osVersion = deviceConfigMap[\"osVersion\"] as String,\n displayInfo = deviceConfigMap[\"displayInfo\"] as String,\n deviceLocale = deviceConfigMap[\"deviceLocale\"] as? String\n )\n\n return UploadResponse(\n orgId = orgId,\n uploadId = uploadId,\n deviceConfiguration = deviceConfiguration,\n appId = appId,\n appBinaryId = appBinaryId\n )\n }\n\n\n private inline fun post(path: String, body: Any): Result {\n val bodyBytes = JSON.writeValueAsBytes(body)\n val request = Request.Builder()\n .post(bodyBytes.toRequestBody(\"application/json\".toMediaType()))\n .url(\"$baseUrl$path\")\n .build()\n val response = client.newCall(request).execute()\n\n if (!response.isSuccessful) return Err(response)\n if (Unit is T) return Ok(Unit)\n val parsed = JSON.readValue(response.body?.bytes(), T::class.java)\n return Ok(parsed)\n }\n\n private fun RequestBody.observable(\n progressListener: (totalBytes: Long, bytesWritten: Long) -> Unit,\n ) = object : RequestBody() {\n\n override fun contentLength() = this@observable.contentLength()\n\n override fun contentType() = this@observable.contentType()\n\n override fun writeTo(sink: BufferedSink) {\n val forwardingSink = object : ForwardingSink(sink) {\n\n private var bytesWritten = 0L\n\n override fun write(source: Buffer, byteCount: Long) {\n super.write(source, byteCount)\n bytesWritten += byteCount\n progressListener(contentLength(), bytesWritten)\n }\n }.buffer()\n progressListener(contentLength(), 0)\n this@observable.writeTo(forwardingSink)\n forwardingSink.flush()\n }\n }\n\n fun analyze(\n authToken: String,\n debugFiles: AnalysisDebugFiles,\n ): AnalyzeResponse {\n val mediaType = \"application/json; charset=utf-8\".toMediaType()\n val body = JSON.writeValueAsString(debugFiles).toRequestBody(mediaType)\n\n val url = \"$baseUrl/v2/analyze\"\n\n val request = Request.Builder()\n .header(\"Authorization\", \"Bearer $authToken\")\n .url(url)\n .post(body)\n .build()\n\n val response = client.newCall(request).execute()\n\n response.use {\n if (!response.isSuccessful) {\n val errorMessage = response.body?.string().takeIf { it?.isNotEmpty() == true } ?: \"Unknown\"\n throw CliError(\"Analyze request failed (${response.code}): $errorMessage\")\n }\n\n val parsed = JSON.readValue(response.body?.bytes(), AnalyzeResponse::class.java)\n\n return parsed;\n }\n }\n\n fun listCloudDevices(): Map>> {\n val request = Request.Builder()\n .url(\"$baseUrl/v2/device/list\")\n .get()\n .build()\n\n val response = try {\n client.newCall(request).execute()\n } catch (e: IOException) {\n throw ApiException(statusCode = null)\n }\n\n response.use {\n if (!response.isSuccessful) throw ApiException(statusCode = response.code)\n return JSON.readValue(response.body?.bytes(), object : TypeReference>>>() {})\n }\n }\n\n fun botMessage(question: String, sessionId: String, authToken: String): List {\n val body = JSON.writeValueAsString(\n MessageRequest(\n sessionId = sessionId,\n context = emptyList(),\n messages = listOf(\n ContentDetail(\n type = \"text\",\n text = question\n )\n )\n )\n )\n\n val url = \"$baseUrl/v2/bot/message\"\n\n val request = Request.Builder()\n .url(url)\n .header(\"Authorization\", \"Bearer $authToken\")\n .post(body.toRequestBody(\"application/json\".toMediaType()))\n .build()\n\n val response = client.newCall(request).execute()\n\n response.use {\n if (!response.isSuccessful) {\n val errorMessage = response.body?.string().takeIf { it?.isNotEmpty() == true } ?: \"Unknown\"\n throw CliError(\"bot message request failed (${response.code}): $errorMessage\")\n }\n\n val data = response.body?.bytes()\n val parsed = JSON.readValue(data, object : TypeReference>() {})\n\n return parsed;\n }\n }\n\n\n fun getUser(authToken: String): UserResponse {\n val baseUrl = \"$baseUrl/v2/maestro-studio/user\"\n\n val request = Request.Builder()\n .header(\"Authorization\", \"Bearer $authToken\")\n .url(baseUrl)\n .get()\n .build()\n\n val response = try {\n client.newCall(request).execute()\n } catch (e: IOException) {\n throw ApiException(statusCode = null)\n }\n\n response.use {\n if (!response.isSuccessful) {\n throw ApiException(\n statusCode = response.code\n )\n }\n val responseBody = response.body?.string()\n try {\n val user = JSON.readValue(responseBody, UserResponse::class.java)\n return user\n } catch (e: Exception) {\n throw e\n }\n }\n }\n\n fun getOrg(authToken: String): OrgResponse {\n val baseUrl = \"$baseUrl/v2/maestro-studio/org\"\n\n val request = Request.Builder()\n .header(\"Authorization\", \"Bearer $authToken\")\n .url(baseUrl)\n .get()\n .build()\n\n val response = try {\n client.newCall(request).execute()\n } catch (e: IOException) {\n throw ApiException(statusCode = null)\n }\n\n response.use {\n if (!response.isSuccessful) {\n throw ApiException(\n statusCode = response.code\n )\n }\n val responseBody = response.body?.string()\n try {\n val user = JSON.readValue(responseBody, OrgResponse::class.java)\n return user\n } catch (e: Exception) {\n throw e\n }\n }\n }\n\n fun getOrgs(authToken: String): List {\n val url = \"$baseUrl/v2/maestro-studio/orgs\"\n \n val request = Request.Builder()\n .header(\"Authorization\", \"Bearer $authToken\")\n .url(url)\n .get()\n .build()\n\n val response = try {\n client.newCall(request).execute()\n } catch (e: IOException) {\n throw ApiException(statusCode = null)\n }\n\n response.use {\n if (!response.isSuccessful) {\n throw ApiException(\n statusCode = response.code\n )\n }\n val responseBody = response.body?.string()\n try {\n val orgs = JSON.readValue(responseBody, object : TypeReference>() {})\n return orgs\n } catch (e: Exception) {\n throw e\n }\n }\n }\n\n fun switchOrg(authToken: String, orgId: String): String {\n val url = \"$baseUrl/v2/maestro-studio/org/switch\"\n\n val request = Request.Builder()\n .header(\"Authorization\", \"Bearer $authToken\")\n .url(url)\n .post(orgId.toRequestBody(\"text/plain\".toMediaType()))\n .build()\n\n val response = try {\n client.newCall(request).execute()\n } catch (e: IOException) {\n throw ApiException(statusCode = null)\n }\n\n response.use {\n if (!response.isSuccessful) {\n throw ApiException(\n statusCode = response.code\n )\n }\n val responseBody = response.body?.string()\n try {\n // The endpoint returns the API key directly as plain text\n return responseBody ?: throw Exception(\"No API key in switch org response\")\n } catch (e: Exception) {\n throw e\n }\n }\n }\n\n fun getProjects(authToken: String): List {\n val url = \"$baseUrl/v2/maestro-studio/projects\"\n\n val request = Request.Builder()\n .header(\"Authorization\", \"Bearer $authToken\")\n .url(url)\n .get()\n .build()\n\n val response = try {\n client.newCall(request).execute()\n } catch (e: IOException) {\n throw ApiException(statusCode = null)\n }\n\n response.use {\n if (!response.isSuccessful) {\n throw ApiException(\n statusCode = response.code\n )\n }\n val responseBody = response.body?.string()\n try {\n val projects = JSON.readValue(responseBody, object : TypeReference>() {})\n return projects\n } catch (e: Exception) {\n throw e\n }\n }\n }\n\n fun getAppBinaryInfo(authToken: String, appBinaryId: String): AppBinaryInfo {\n val request = Request.Builder()\n .header(\"Authorization\", \"Bearer $authToken\")\n .url(\"$baseUrl/v2/maestro-studio/app-binary/$appBinaryId\")\n .get()\n .build()\n\n val response = try {\n client.newCall(request).execute()\n } catch (e: IOException) {\n throw ApiException(statusCode = null)\n }\n\n response.use {\n if (!response.isSuccessful) {\n throw ApiException(statusCode = response.code)\n }\n return JSON.readValue(response.body?.bytes(), AppBinaryInfo::class.java)\n }\n }\n\n data class ApiException(\n val statusCode: Int?,\n ) : Exception(\"Request failed. Status code: $statusCode\")\n\n companion object {\n private const val BASE_RETRY_DELAY_MS = 3000L\n private val JSON = jacksonObjectMapper().configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)\n }\n}\n\n\ndata class UploadResponse(\n val orgId: String,\n val uploadId: String,\n val appId: String,\n val deviceConfiguration: DeviceConfiguration?,\n val appBinaryId: String?,\n)\n\ndata class AppBinaryInfo(\n val appBinaryId: String,\n val platform: String,\n val appId: String,\n)\n\ndata class DeviceConfiguration(\n val platform: String,\n val deviceName: String,\n val orientation: String,\n val osVersion: String,\n val displayInfo: String,\n val deviceLocale: String?\n)\n\n@JsonIgnoreProperties(ignoreUnknown = true)\ndata class DeviceInfo(\n val platform: String,\n val displayInfo: String,\n val isDefaultOsVersion: Boolean,\n val deviceLocale: String,\n)\n\n@JsonIgnoreProperties(ignoreUnknown = true)\ndata class UploadStatus(\n val uploadId: String,\n val status: Status,\n val completed: Boolean,\n val totalTime: Long?,\n val startTime: Long?,\n val flows: List,\n val appPackageId: String?,\n val wasAppLaunched: Boolean\n) {\n\n data class FlowResult(\n val name: String,\n val status: FlowStatus,\n val errors: List,\n val startTime: Long,\n val totalTime: Long? = null,\n val cancellationReason: CancellationReason? = null\n )\n\n enum class Status {\n PENDING,\n PREPARING,\n INSTALLING,\n RUNNING,\n SUCCESS,\n ERROR,\n CANCELED,\n WARNING,\n STOPPED\n }\n\n // These values must match backend monorepo models\n // in package models.benchmark.BenchmarkCancellationReason\n enum class CancellationReason {\n BENCHMARK_DEPENDENCY_FAILED,\n INFRA_ERROR,\n OVERLAPPING_BENCHMARK,\n TIMEOUT,\n CANCELED_BY_USER,\n RUN_EXPIRED,\n }\n}\n\ndata class RenderResponse(\n val id: String,\n)\n\ndata class RenderState(\n val status: String,\n val positionInQueue: Int?,\n val currentTaskProgress: Float?,\n val error: String?,\n val downloadUrl: String?,\n)\n\n\ndata class UserResponse(\n val id: String,\n val email: String,\n val firstName: String?,\n val lastName: String?,\n val status: String,\n val role: String,\n val workOSOrgId: String,\n) {\n val name: String\n get() = when {\n !firstName.isNullOrBlank() && !lastName.isNullOrBlank() -> \"$firstName $lastName\"\n !firstName.isNullOrBlank() -> firstName!!\n !lastName.isNullOrBlank() -> lastName!!\n else -> email\n }\n}\n\ndata class OrgResponse(\n val id: String,\n val name: String,\n val quota: Map>?,\n val metadata: Map?,\n val workOSOrgId: String?,\n)\n\ndata class ProjectResponse(\n val id: String,\n val name: String,\n)\n\ndata class CliVersion(\n val major: Int,\n val minor: Int,\n val patch: Int,\n) : Comparable {\n\n override fun compareTo(other: CliVersion): Int {\n return COMPARATOR.compare(this, other)\n }\n\n override fun toString(): String {\n return \"$major.$minor.$patch\"\n }\n\n companion object {\n\n private val COMPARATOR = compareBy({ it.major }, { it.minor }, { it.patch })\n\n fun parse(versionString: String): CliVersion? {\n val parts = versionString.split('.')\n if (parts.size != 3) return null\n val major = parts[0].toIntOrNull() ?: return null\n val minor = parts[1].toIntOrNull() ?: return null\n val patch = parts[2].toIntOrNull() ?: return null\n return CliVersion(major, minor, patch)\n }\n }\n}\n\nclass SystemInformationInterceptor : Interceptor {\n override fun intercept(chain: Interceptor.Chain): Response {\n val newRequest = chain.request().newBuilder()\n .header(\"X-UUID\", Analytics.uuid)\n .header(\"X-VERSION\", EnvUtils.getVersion().toString())\n .header(\"X-OS\", EnvUtils.OS_NAME)\n .header(\"X-OSARCH\", EnvUtils.OS_ARCH)\n .build()\n\n return chain.proceed(newRequest)\n }\n}\n\ndata class Insight(\n val category: String,\n val reasoning: String,\n)\n\ndata class StartTrialRequest(\n val companyName: String,\n val referralSource: String,\n)\n\nclass AnalyzeResponse(\n val htmlReport: String?,\n val output: String,\n val insights: List\n)\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/api/Chatbot.kt", "content": "package maestro.cli.api\n\nimport com.fasterxml.jackson.annotation.JsonProperty\n\ndata class MessageRequest(\n @JsonProperty(\"sessionId\") val sessionId: String,\n val context: List,\n val messages: List\n)\n\ndata class ContentDetail(\n val type: String, // \"text\" or \"image_url\" for now\n val text: String? = null,\n val image_url: Base64Image? = null\n)\n\ndata class Base64Image(\n val url: String,\n val detail: String,\n)\n\ndata class MessageContent(\n val role: String,\n val content: List = emptyList(),\n val tool_calls: List? = null,\n val tool_call_id: String? = null\n)\n\ndata class ToolCall(\n val id: String,\n val function: ToolFunction\n)\n\ndata class ToolFunction(\n val name: String,\n val arguments: String?,\n)\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/auth/Auth.kt", "content": "package maestro.cli.auth\n\nimport io.ktor.http.*\nimport io.ktor.server.application.*\nimport io.ktor.server.engine.*\nimport io.ktor.server.netty.*\nimport io.ktor.server.response.*\nimport io.ktor.server.routing.*\nimport kotlinx.coroutines.CompletableDeferred\nimport kotlinx.coroutines.runBlocking\nimport maestro.auth.ApiKey\nimport maestro.cli.api.ApiClient\nimport maestro.cli.util.PrintUtils.err\nimport maestro.cli.util.PrintUtils.info\nimport maestro.cli.util.PrintUtils.success\nimport maestro.cli.util.getFreePort\nimport java.awt.Desktop\nimport java.net.URI\n\nprivate const val SUCCESS_HTML = \"\"\"\n \n\n\n Authentication Successful\n \n\n\n
\n
\n \n \n \n

Authentication Successful!

\n

You can close this window and return to the CLI.

\n
\n
\n\n\n \"\"\"\n\nprivate const val FAILURE_DEFAULT_DESCRIPTION = \"Something went wrong. Please try again.\"\n\nprivate const val FAILURE_HTML = \"\"\"\n \n\n\n Authentication Failed\n \n\n\n
\n
\n \n \n \n

Authentication Failed

\n

${FAILURE_DEFAULT_DESCRIPTION}

\n
\n
\n\n\n\"\"\"\n\nclass Auth(\n private val apiClient: ApiClient\n) {\n\n fun getAuthToken(apiKey: String?, triggerSignIn: Boolean = true): String? {\n if (triggerSignIn) {\n return apiKey // Check for API key\n ?: ApiKey.getToken()\n ?: triggerSignInFlow() // Otherwise, trigger the sign-in flow\n }\n return apiKey // Check for API key\n ?: ApiKey.getToken()\n }\n\n\n fun triggerSignInFlow(): String {\n val deferredToken = CompletableDeferred()\n\n val port = getFreePort()\n val server = embeddedServer(Netty, configure = { shutdownTimeout = 0; shutdownGracePeriod = 0 }, port = port) {\n routing {\n get(\"/callback\") {\n handleCallback(call, deferredToken)\n }\n }\n }.start(wait = false)\n\n val authUrl = apiClient.getAuthUrl(port.toString())\n info(\"Your browser has been opened to visit:\\n\\n\\t$authUrl\")\n\n if (Desktop.isDesktopSupported()) {\n Desktop.getDesktop().browse(URI(authUrl))\n } else {\n err(\"Failed to open browser on this platform. Please open the above URL in your preferred browser.\")\n throw UnsupportedOperationException(\"Failed to open browser automatically on this platform. Please open the above URL in your preferred browser.\")\n }\n\n val token = runBlocking {\n deferredToken.await()\n }\n server.stop(0, 0)\n ApiKey.setToken(token)\n success(\"Authentication completed.\")\n return token\n }\n\n private suspend fun handleCallback(call: ApplicationCall, deferredToken: CompletableDeferred) {\n val code = call.request.queryParameters[\"code\"]\n if (code.isNullOrEmpty()) {\n err(\"No authorization code received. Please try again.\")\n call.respondText(FAILURE_HTML, ContentType.Text.Html)\n return\n }\n\n try {\n val newApiKey = apiClient.exchangeToken(code)\n call.respondText(SUCCESS_HTML, ContentType.Text.Html)\n deferredToken.complete(newApiKey)\n } catch (e: Exception) {\n val errorMessage = \"Failed to exchange token: ${e.message}\"\n call.respondText(\n if (errorMessage.isNotBlank()) FAILURE_HTML.replace(FAILURE_DEFAULT_DESCRIPTION, errorMessage) else FAILURE_HTML,\n ContentType.Text.Html,\n status = HttpStatusCode.InternalServerError\n )\n deferredToken.completeExceptionally(e)\n }\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/cloud/CloudInteractor.kt", "content": "package maestro.cli.cloud\n\nimport maestro.cli.CliError\nimport maestro.cli.analytics.Analytics\nimport maestro.cli.analytics.CloudUploadTriggeredEvent\nimport maestro.cli.api.ApiClient\nimport maestro.cli.api.DeviceConfiguration\nimport maestro.cli.api.OrgResponse\nimport maestro.cli.api.ProjectResponse\nimport maestro.cli.api.UploadStatus\nimport maestro.cli.auth.Auth\nimport maestro.device.Platform\nimport maestro.cli.insights.AnalysisDebugFiles\nimport maestro.cli.model.FlowStatus\nimport maestro.cli.model.RunningFlow\nimport maestro.cli.model.RunningFlows\nimport maestro.cli.model.TestExecutionSummary\nimport maestro.cli.report.HtmlInsightsAnalysisReporter\nimport maestro.cli.report.ReportFormat\nimport maestro.cli.report.ReporterFactory\nimport maestro.cli.util.FileUtils.isWebFlow\nimport maestro.cli.util.FileUtils.isZip\nimport maestro.cli.util.PrintUtils\nimport maestro.cli.util.WorkspaceUtils\nimport maestro.cli.view.ProgressBar\nimport com.github.ajalt.mordant.terminal.Terminal\nimport com.github.ajalt.mordant.input.interactiveSelectList\nimport maestro.cli.analytics.CloudRunFinishedEvent\nimport maestro.cli.analytics.CloudUploadSucceededEvent\nimport maestro.cli.view.TestSuiteStatusView\nimport maestro.cli.view.TestSuiteStatusView.TestSuiteViewModel.Companion.toViewModel\nimport maestro.cli.view.TestSuiteStatusView.uploadUrl\nimport maestro.cli.view.box\nimport maestro.cli.view.cyan\nimport maestro.cli.view.render\nimport maestro.cli.promotion.PromotionStateManager\nimport maestro.orchestra.validation.AppMetadataAnalyzer\nimport maestro.orchestra.validation.AppMetadata\nimport maestro.cli.web.WebInteractor\nimport maestro.orchestra.validation.AppValidationException\nimport maestro.orchestra.validation.AppValidator\nimport maestro.orchestra.validation.WorkspaceValidationException\nimport maestro.orchestra.validation.WorkspaceValidator\nimport maestro.device.DeviceSpec\nimport maestro.device.DeviceSpecRequest\nimport maestro.utils.TemporaryDirectory\nimport okio.BufferedSink\nimport okio.buffer\nimport okio.sink\nimport org.rauschig.jarchivelib.ArchiveFormat\nimport org.rauschig.jarchivelib.ArchiverFactory\nimport java.io.File\nimport java.nio.file.Path\nimport java.util.*\nimport java.util.concurrent.TimeUnit\nimport kotlin.String\nimport kotlin.io.path.absolute\nimport kotlin.time.Duration.Companion.milliseconds\n\nval terminalStatuses = listOf(FlowStatus.CANCELED, FlowStatus.STOPPED, FlowStatus.SUCCESS, FlowStatus.ERROR)\n\nclass CloudInteractor(\n private val client: ApiClient,\n private val appFileValidator: (File) -> AppMetadata?,\n private val workspaceValidator: WorkspaceValidator,\n private val webManifestProvider: (() -> File?)? = null,\n private val auth: Auth = Auth(client),\n private val waitTimeoutMs: Long = TimeUnit.MINUTES.toMillis(30),\n private val minPollIntervalMs: Long = TimeUnit.SECONDS.toMillis(10),\n private val maxPollingRetries: Int = 5,\n private val failOnTimeout: Boolean = true,\n) {\n\n fun upload(\n flowFile: File,\n appFile: File?,\n async: Boolean,\n mapping: File? = null,\n apiKey: String? = null,\n uploadName: String? = null,\n repoOwner: String? = null,\n repoName: String? = null,\n branch: String? = null,\n commitSha: String? = null,\n pullRequestId: String? = null,\n env: Map = emptyMap(),\n appBinaryId: String? = null,\n failOnCancellation: Boolean = false,\n includeTags: List = emptyList(),\n excludeTags: List = emptyList(),\n reportFormat: ReportFormat = ReportFormat.NOOP,\n reportOutput: File? = null,\n testSuiteName: String? = null,\n disableNotifications: Boolean = false,\n deviceLocale: String? = null,\n projectId: String? = null,\n deviceModel: String? = null,\n deviceOs: String? = null,\n androidApiLevel: Int? = null,\n iOSVersion: String? = null,\n ): Int {\n if (!flowFile.exists()) throw CliError(\"File does not exist: ${flowFile.absolutePath}\")\n if (mapping?.exists() == false) throw CliError(\"File does not exist: ${mapping.absolutePath}\")\n if (async && reportFormat != ReportFormat.NOOP) throw CliError(\"Cannot use --format with --async\")\n\n // In case apiKey is provided use that, else fallback to signIn and org Selection\n val authToken: String = auth.getAuthToken(apiKey, triggerSignIn = false) ?:\n selectOrganization(auth.getAuthToken(apiKey, triggerSignIn = true) ?:\n throw CliError(\"Failed to get authentication token\"))\n\n // Fetch and select project if not provided\n val selectedProjectId = projectId ?: selectProject(authToken)\n\n // Record cloud command usage for promotion message suppression\n PromotionStateManager().recordCloudCommandUsage()\n\n // Track cloud upload triggered before any file I/O; platform unknown until binary is analyzed\n Analytics.trackEvent(CloudUploadTriggeredEvent(\n projectId = selectedProjectId,\n isBinaryUpload = appBinaryId != null,\n usesEnvironment = env.isNotEmpty(),\n deviceModel = deviceModel,\n deviceOs = deviceOs\n ))\n \n PrintUtils.message(\"Uploading Flow(s)...\")\n\n TemporaryDirectory.use { tmpDir ->\n val workspaceZip = tmpDir.resolve(\"workspace.zip\")\n WorkspaceUtils.createWorkspaceZip(flowFile.toPath().absolute(), workspaceZip)\n val progressBar = ProgressBar(20)\n\n // Binary id or Binary file\n val appFileToSend = getAppFile(appFile, appBinaryId, tmpDir, flowFile)\n\n // Validate app and resolve platform\n val appValidator = AppValidator(\n appFileValidator = appFileValidator,\n appBinaryInfoProvider = { binaryId ->\n try {\n val info = client.getAppBinaryInfo(authToken, binaryId)\n AppValidator.AppBinaryInfoResult(info.appBinaryId, info.platform, info.appId)\n } catch (e: ApiClient.ApiException) {\n if (e.statusCode == 404) throw AppValidationException.AppBinaryNotFound(binaryId)\n throw AppValidationException.AppBinaryFetchError(e.statusCode)\n }\n },\n webManifestProvider = webManifestProvider,\n iosMinOSVersionProvider = { file ->\n val metadata = AppMetadataAnalyzer.getIosAppMetadata(file) ?: return@AppValidator null\n val major = metadata.minimumOSVersion.substringBefore(\".\").toIntOrNull() ?: return@AppValidator null\n AppValidator.IosMinOSVersion(major = major, full = metadata.minimumOSVersion)\n },\n )\n val resolvedAppValidation = try {\n appValidator.validate(appFile = appFileToSend, appBinaryId = appBinaryId)\n } catch (e: AppValidationException) {\n throw CliError(e.message ?: \"App validation failed\")\n }\n\n // Fetch supported devices and validate device spec\n val supportedDevices = try {\n client.listCloudDevices()\n } catch (e: ApiClient.ApiException) {\n throw CliError(\"Failed to fetch supported devices. Status code: ${e.statusCode}\")\n }\n\n // Validate workspace against appId before uploading to catch errors early\n try {\n workspaceValidator.validate(\n workspace = workspaceZip.toFile(),\n appId = resolvedAppValidation.appIdentifier,\n env = env,\n includeTags = includeTags,\n excludeTags = excludeTags,\n )\n } catch (e: WorkspaceValidationException) {\n throw CliError(e.message ?: \"Workspace validation failed\")\n }\n\n val response = client.upload(\n authToken = authToken,\n appFile = appFileToSend?.toPath(),\n workspaceZip = workspaceZip,\n uploadName = uploadName,\n mappingFile = mapping?.toPath(),\n repoOwner = repoOwner,\n repoName = repoName,\n branch = branch,\n commitSha = commitSha,\n pullRequestId = pullRequestId,\n env = env,\n appBinaryId = appBinaryId,\n includeTags = includeTags,\n excludeTags = excludeTags,\n disableNotifications = disableNotifications,\n projectId = selectedProjectId,\n progressListener = { totalBytes, bytesWritten ->\n progressBar.set(bytesWritten.toFloat() / totalBytes.toFloat())\n },\n deviceLocale = deviceLocale,\n deviceModel = deviceModel,\n deviceOs = deviceOs,\n androidApiLevel = androidApiLevel,\n iOSVersion = iOSVersion,\n )\n\n // Track finish after upload completion\n val platform = response.deviceConfiguration?.platform?.lowercase() ?: \"unknown\"\n Analytics.trackEvent(CloudUploadSucceededEvent(\n projectId = selectedProjectId,\n platform = platform,\n isBinaryUpload = appBinaryId != null,\n usesEnvironment = env.isNotEmpty(),\n deviceModel = deviceModel,\n deviceOs = deviceOs\n ))\n\n val project = requireNotNull(selectedProjectId)\n val appId = response.appId\n val uploadUrl = uploadUrl(project, appId, response.uploadId, client.domain)\n val deviceMessage =\n if (response.deviceConfiguration != null) printDeviceInfo(response.deviceConfiguration) else \"\"\n\n val uploadResponse = printMaestroCloudResponse(\n async,\n authToken,\n failOnCancellation,\n reportFormat,\n reportOutput,\n testSuiteName,\n uploadUrl,\n deviceMessage,\n appId,\n response.appBinaryId,\n response.uploadId,\n selectedProjectId,\n )\n\n Analytics.trackEvent(CloudRunFinishedEvent(\n projectId = selectedProjectId,\n totalFlows = uploadResponse.flows.size,\n totalPassedFlows = uploadResponse.flows.count { it.status == FlowStatus.SUCCESS },\n totalFailedFlows = uploadResponse.flows.count { it.status == FlowStatus.ERROR },\n appPackageId = uploadResponse.appPackageId ?: \"\",\n wasAppLaunched = uploadResponse.wasAppLaunched\n ))\n\n Analytics.flush()\n \n return when (uploadResponse.status) {\n UploadStatus.Status.SUCCESS -> 0\n UploadStatus.Status.ERROR -> 1\n UploadStatus.Status.CANCELED -> if (failOnCancellation) 1 else 0\n UploadStatus.Status.STOPPED -> 1\n else -> 1\n }\n }\n }\n\n private fun selectProject(authToken: String): String {\n val projects = try {\n client.getProjects(authToken)\n } catch (e: ApiClient.ApiException) {\n throw CliError(\"Failed to fetch projects. Status code: ${e.statusCode}\")\n } catch (e: Exception) {\n throw CliError(\"Failed to fetch projects: ${e.message}\")\n }\n\n if (projects.isEmpty()) {\n throw CliError(\"No projects found. Please create a project first at https://console.mobile.dev\")\n }\n\n return when (projects.size) {\n 1 -> {\n val project = projects.first()\n PrintUtils.info(\"Using project: ${project.name} (${project.id})\")\n project.id\n }\n else -> {\n val selectedProject = pickProject(projects)\n PrintUtils.info(\"Selected project: ${selectedProject.name} (${selectedProject.id})\")\n selectedProject.id\n }\n }\n }\n\n fun pickProject(projects: List): ProjectResponse {\n val terminal = Terminal()\n val choices = projects.map { \"${it.name} (${it.id})\" }\n \n val selection = terminal.interactiveSelectList(\n choices,\n title = \"Multiple projects found. Please select one (Bypass this prompt by using --project-id=<>):\"\n )\n \n if (selection == null) {\n terminal.println(\"No project selected\")\n throw CliError(\"Project selection was cancelled\")\n }\n \n val selectedIndex = choices.indexOf(selection)\n return projects[selectedIndex]\n }\n\n private fun selectOrganization(authToken: String): String {\n val orgs = try {\n client.getOrgs(authToken)\n } catch (e: ApiClient.ApiException) {\n throw CliError(\"Failed to fetch organizations. Status code: ${e.statusCode}\")\n } catch (e: Exception) {\n throw CliError(\"Failed to fetch organizations: ${e.message}\")\n }\n\n return when (orgs.size) {\n 1 -> {\n val org = orgs.first()\n PrintUtils.message(\"Using organization: ${org.name} (${org.id})\")\n authToken\n }\n else -> {\n val selectedOrg = pickOrganization(orgs)\n PrintUtils.info(\"Selected organization: ${selectedOrg.name} (${selectedOrg.id})\")\n // Switch to the selected organization to get org-scoped token\n try {\n client.switchOrg(authToken, selectedOrg.id)\n } catch (e: ApiClient.ApiException) {\n throw CliError(\"Failed to switch to organization. Status code: ${e.statusCode}\")\n } catch (e: Exception) {\n throw CliError(\"Failed to switch to organization: ${e.message}\")\n }\n }\n }\n }\n\n fun pickOrganization(orgs: List): OrgResponse {\n val terminal = Terminal()\n val choices = orgs.map { \"${it.name} (${it.id})\" }\n \n val selection = terminal.interactiveSelectList(\n choices,\n title = \"Multiple organizations found. Please select one (Bypass this prompt by using --api-key=<>):\",\n )\n \n if (selection == null) {\n terminal.println(\"No organization selected\")\n throw CliError(\"Organization selection was cancelled\")\n }\n \n val selectedIndex = choices.indexOf(selection)\n return orgs[selectedIndex]\n }\n\n private fun getAppFile(\n appFile: File?,\n appBinaryId: String?,\n tmpDir: Path,\n flowFile: File\n ): File? {\n when {\n appBinaryId != null -> return null\n\n appFile != null -> if (appFile.isZip()) {\n return appFile\n } else {\n val archiver = ArchiverFactory.createArchiver(ArchiveFormat.ZIP)\n\n // An awkward API of Archiver that has a different behaviour depending on\n // whether we call a vararg method or a normal method. The *arrayOf() construct\n // forces compiler to choose vararg method.\n @Suppress(\"RemoveRedundantSpreadOperator\")\n return archiver.create(appFile.name + \".zip\", tmpDir.toFile(), *arrayOf(appFile.absoluteFile))\n }\n\n flowFile.isWebFlow() -> return WebInteractor.createManifestFromWorkspace(flowFile)\n\n else -> return null\n }\n }\n\n private fun printMaestroCloudResponse(\n async: Boolean,\n authToken: String,\n failOnCancellation: Boolean,\n reportFormat: ReportFormat,\n reportOutput: File?,\n testSuiteName: String?,\n uploadUrl: String,\n deviceInfoMessage: String,\n appId: String,\n appBinaryIdResponse: String?,\n uploadId: String,\n projectId: String\n ): UploadStatus {\n if (async) {\n PrintUtils.message(\"โœ… Upload successful!\")\n\n println(deviceInfoMessage)\n PrintUtils.info(\"View the results of your upload below:\")\n PrintUtils.info(uploadUrl.cyan())\n\n if (appBinaryIdResponse != null) PrintUtils.info(\"App binary id: ${appBinaryIdResponse.cyan()}\\n\")\n\n // Return a simple UploadStatus for async case\n return UploadStatus(\n uploadId = uploadId,\n status = UploadStatus.Status.SUCCESS,\n completed = true,\n totalTime = null,\n startTime = null,\n flows = emptyList(),\n appPackageId = null,\n wasAppLaunched = false,\n )\n } else {\n println(deviceInfoMessage)\n \n // Print the upload URL\n PrintUtils.info(\"Visit Maestro Cloud for more details about this upload:\")\n PrintUtils.info(uploadUrl.cyan())\n println()\n\n if (appBinaryIdResponse != null) PrintUtils.info(\"App binary id: ${appBinaryIdResponse.cyan()}\\n\")\n\n PrintUtils.info(\"Waiting for runs to be completed...\")\n\n return waitForCompletion(\n authToken = authToken,\n uploadId = uploadId,\n appId = appId,\n failOnCancellation = failOnCancellation,\n reportFormat = reportFormat,\n reportOutput = reportOutput,\n testSuiteName = testSuiteName,\n uploadUrl = uploadUrl,\n projectId = projectId,\n )\n }\n }\n\n private fun printDeviceInfo(deviceConfiguration: DeviceConfiguration): String {\n val platform = Platform.fromString(deviceConfiguration.platform)\n PrintUtils.info(\"\\n\")\n\n val version = deviceConfiguration.osVersion\n val lines = listOf(\n \"Maestro cloud device specs:\\n* @|magenta ${deviceConfiguration.displayInfo} - ${deviceConfiguration.deviceLocale}|@\\n\",\n \"To change OS version use this option: @|magenta ${if (platform == Platform.IOS) \"--device-os=\" else \"--android-api-level=\"}|@\",\n \"To change devices use this option: @|magenta --device-model=|@\",\n \"To change device locale use this option: @|magenta --device-locale=|@\",\n \"To create a similar device locally, run: @|magenta `maestro start-device --platform=${\n platform.toString().lowercase()\n } --os-version=$version --device-locale=${deviceConfiguration.deviceLocale}`|@\"\n )\n\n return lines.joinToString(\"\\n\").render().box()\n }\n\n\n internal fun waitForCompletion(\n authToken: String,\n uploadId: String,\n appId: String,\n failOnCancellation: Boolean,\n reportFormat: ReportFormat,\n reportOutput: File?,\n testSuiteName: String?,\n uploadUrl: String,\n projectId: String?\n ): UploadStatus {\n val startTime = System.currentTimeMillis()\n\n var pollingInterval = minPollIntervalMs\n var retryCounter = 0\n val printedFlows = mutableSetOf()\n\n do {\n val upload: UploadStatus = try {\n client.uploadStatus(authToken, uploadId, projectId)\n } catch (e: ApiClient.ApiException) {\n if (e.statusCode == 429) {\n // back off through extending sleep duration with 25%\n pollingInterval = (pollingInterval * 1.25).toLong()\n Thread.sleep(pollingInterval)\n continue\n }\n\n if (e.statusCode == 500 || e.statusCode == 502 || e.statusCode == 404) {\n if (++retryCounter <= maxPollingRetries) {\n // retry on 500\n Thread.sleep(pollingInterval)\n continue\n }\n }\n\n throw CliError(\"Failed to fetch the status of an upload $uploadId. Status code = ${e.statusCode}\")\n }\n\n for (uploadFlowResult in upload.flows) {\n if(printedFlows.contains(uploadFlowResult)) { continue }\n if(!terminalStatuses.contains(uploadFlowResult.status)) { continue }\n\n printedFlows.add(uploadFlowResult);\n TestSuiteStatusView.showFlowCompletion(\n uploadFlowResult.toViewModel()\n )\n }\n\n if (upload.completed) {\n val runningFlows = RunningFlows(\n flows = upload.flows.map { flowResult ->\n RunningFlow(\n flowResult.name,\n flowResult.status,\n duration = flowResult.totalTime?.milliseconds,\n startTime = flowResult.startTime\n )\n },\n duration = upload.totalTime?.milliseconds,\n startTime = upload.startTime\n )\n return handleSyncUploadCompletion(\n upload = upload,\n runningFlows = runningFlows,\n appId = appId,\n failOnCancellation = failOnCancellation,\n reportFormat = reportFormat,\n reportOutput = reportOutput,\n testSuiteName = testSuiteName,\n uploadUrl = uploadUrl\n )\n }\n\n Thread.sleep(pollingInterval)\n } while (System.currentTimeMillis() - startTime < waitTimeoutMs)\n\n val displayedMin = TimeUnit.MILLISECONDS.toMinutes(waitTimeoutMs)\n\n PrintUtils.warn(\"Waiting for flows to complete has timed out ($displayedMin minutes)\")\n PrintUtils.warn(\"* To extend the timeout, run maestro with this option `maestro cloud --timeout=`\")\n\n PrintUtils.warn(\"* Follow the results of your upload here:\\n$uploadUrl\")\n\n if (failOnTimeout) {\n PrintUtils.message(\"Process will exit with code 1 (FAIL)\")\n PrintUtils.message(\"* To change exit code on Timeout, run maestro with this option: `maestro cloud --fail-on-timeout=`\")\n } else {\n PrintUtils.message(\"Process will exit with code 0 (SUCCESS)\")\n PrintUtils.message(\"* To change exit code on Timeout, run maestro with this option: `maestro cloud --fail-on-timeout=`\")\n }\n\n // Fetch the latest upload status before returning\n return try {\n client.uploadStatus(authToken, uploadId, projectId)\n } catch (e: Exception) {\n // If we can't fetch the latest status, return a timeout status\n UploadStatus(\n uploadId = uploadId,\n status = UploadStatus.Status.ERROR,\n completed = false,\n totalTime = null,\n startTime = null,\n flows = emptyList(),\n appPackageId = null,\n wasAppLaunched = false,\n )\n }\n }\n\n private fun handleSyncUploadCompletion(\n upload: UploadStatus,\n runningFlows: RunningFlows,\n appId: String,\n failOnCancellation: Boolean,\n reportFormat: ReportFormat,\n reportOutput: File?,\n testSuiteName: String?,\n uploadUrl: String,\n ): UploadStatus {\n TestSuiteStatusView.showSuiteResult(\n upload.toViewModel(\n TestSuiteStatusView.TestSuiteViewModel.UploadDetails(\n uploadId = upload.uploadId,\n appId = appId,\n domain = client.domain,\n )\n ),\n uploadUrl\n )\n\n val isCancelled = upload.status == UploadStatus.Status.CANCELED\n val isFailure = upload.status == UploadStatus.Status.ERROR\n val containsFailure =\n upload.flows.find { it.status == FlowStatus.ERROR } != null // status can be cancelled but also contain flow with failure\n\n val failed = isFailure || containsFailure || isCancelled && failOnCancellation\n\n val reportOutputSink = reportFormat.fileExtension\n ?.let { extension ->\n (reportOutput ?: File(\"report$extension\"))\n .sink()\n .buffer()\n }\n\n if (reportOutputSink != null) {\n saveReport(\n reportFormat,\n !failed,\n createSuiteResult(!failed, upload, runningFlows),\n reportOutputSink,\n testSuiteName\n )\n }\n\n\n if (!failed) {\n PrintUtils.message(\"Process will exit with code 0 (SUCCESS)\")\n if (isCancelled) {\n PrintUtils.message(\"* To change exit code on Cancellation, run maestro with this option: `maestro cloud --fail-on-cancellation=`\")\n }\n } else {\n PrintUtils.message(\"Process will exit with code 1 (FAIL)\")\n if (isCancelled && !containsFailure) {\n PrintUtils.message(\"* To change exit code on cancellation, run maestro with this option: `maestro cloud --fail-on-cancellation=`\")\n }\n }\n\n return upload\n }\n\n private fun saveReport(\n reportFormat: ReportFormat,\n passed: Boolean,\n suiteResult: TestExecutionSummary.SuiteResult,\n reportOutputSink: BufferedSink,\n testSuiteName: String?\n ) {\n ReporterFactory.buildReporter(reportFormat, testSuiteName)\n .report(\n TestExecutionSummary(\n passed = passed,\n suites = listOf(suiteResult)\n ),\n reportOutputSink,\n )\n }\n\n private fun createSuiteResult(\n passed: Boolean,\n upload: UploadStatus,\n runningFlows: RunningFlows\n ): TestExecutionSummary.SuiteResult {\n return TestExecutionSummary.SuiteResult(\n passed = passed,\n flows = upload.flows.map { uploadFlowResult ->\n val failure = uploadFlowResult.errors.firstOrNull()\n val currentRunningFlow = runningFlows.flows.find { it.name == uploadFlowResult.name }\n TestExecutionSummary.FlowResult(\n name = uploadFlowResult.name,\n fileName = null,\n status = uploadFlowResult.status,\n failure = if (failure != null) TestExecutionSummary.Failure(failure) else null,\n duration = currentRunningFlow?.duration,\n startTime = currentRunningFlow?.startTime\n )\n },\n duration = runningFlows.duration,\n startTime = runningFlows.startTime\n )\n }\n\n fun analyze(\n apiKey: String?,\n debugFiles: AnalysisDebugFiles,\n debugOutputPath: Path,\n ): Int {\n val authToken = auth.getAuthToken(apiKey)\n if (authToken == null) throw CliError(\"Failed to get authentication token\")\n\n PrintUtils.info(\"\\n\\uD83D\\uDD0E Analyzing Flow(s)...\")\n\n try {\n val response = client.analyze(authToken, debugFiles)\n\n if (response.htmlReport.isNullOrEmpty()) {\n PrintUtils.info(response.output)\n return 0\n }\n\n val outputFilePath = HtmlInsightsAnalysisReporter().report(response.htmlReport, debugOutputPath)\n val os = System.getProperty(\"os.name\").lowercase(Locale.getDefault())\n\n val formattedOutput = response.output.replace(\n \"{{outputFilePath}}\",\n \"file:${if (os.contains(\"win\")) \"///\" else \"//\"}${outputFilePath}\\n\"\n )\n\n PrintUtils.info(formattedOutput);\n return 0;\n } catch (error: CliError) {\n PrintUtils.err(\"Unexpected error while analyzing Flow(s): ${error.message}\")\n return 1\n }\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/BugReportCommand.kt", "content": "package maestro.cli.command\n\nimport maestro.cli.DisableAnsiMixin\nimport maestro.cli.ShowHelpMixin\nimport maestro.debuglog.DebugLogStore\nimport picocli.CommandLine\nimport java.util.concurrent.Callable\n\n@CommandLine.Command(\n name = \"bugreport\",\n description = [\n \"Report a bug - Help us improve your experience!\"\n ]\n)\nclass BugReportCommand : Callable {\n\n @CommandLine.Mixin\n var disableANSIMixin: DisableAnsiMixin? = null\n\n @CommandLine.Mixin\n var showHelpMixin: ShowHelpMixin? = null\n\n override fun call(): Int {\n val message = \"\"\"\n Please open an issue on GitHub: https://github.com/mobile-dev-inc/Maestro/issues/new?template=bug_report.yaml\n Attach the files found in this folder ${DebugLogStore.logDirectory}\n \"\"\".trimIndent()\n println(message)\n return 0\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/ChatCommand.kt", "content": "package maestro.cli.command\n\nimport maestro.auth.ApiKey\nimport maestro.cli.api.ApiClient\nimport maestro.cli.auth.Auth\nimport maestro.cli.util.EnvUtils.BASE_API_URL\nimport org.fusesource.jansi.Ansi.ansi\nimport picocli.CommandLine\nimport java.util.*\nimport java.util.concurrent.Callable\n\n@CommandLine.Command(\n name = \"chat\",\n description = [\n \"Use Maestro GPT to help you with Maestro documentation and code questions\"\n ]\n)\nclass ChatCommand : Callable {\n\n @CommandLine.Option(order = 0, names = [\"--api-key\", \"--apiKey\"], description = [\"API key\"])\n private var apiKey: String? = null\n\n @CommandLine.Option(order = 1, names = [\"--api-url\", \"--apiUrl\"], description = [\"API base URL\"])\n private var apiUrl: String = BASE_API_URL\n\n @CommandLine.Option(\n order = 2,\n names = [\"--ask\"],\n description = [\"Gets a response and immediately exits the chat session\"]\n )\n private var ask: String? = null\n\n private val auth by lazy {\n Auth(ApiClient(apiUrl))\n }\n\n override fun call(): Int {\n if (apiKey == null) {\n apiKey = ApiKey.getToken()\n }\n\n if (apiKey == null) {\n println(\"You must log in first in to use this command (maestro login).\")\n return 1\n }\n\n val client = ApiClient(apiUrl)\n if (ask == null) {\n println(\n \"\"\"\n Welcome to MaestroGPT!\n\n You can ask questions about Maestro documentation and code.\n To exit, type \"quit\" or \"exit\".\n \n \"\"\".trimIndent()\n )\n }\n val sessionId = \"maestro_cli:\" + UUID.randomUUID().toString()\n\n while (true) {\n if(ask == null) {\n print(ansi().fgBrightMagenta().a(\"> \").reset().toString())\n }\n val question = ask ?: readLine()\n\n if (question == null || question == \"quit\" || question == \"exit\") {\n println(\"Goodbye!\")\n return 0\n }\n\n val messages = client.botMessage(question, sessionId, apiKey!!)\n println()\n messages.filter { it.role == \"assistant\" }.mapNotNull { message ->\n message.content.map { it.text }.joinToString(\"\\n\").takeIf { it.isNotBlank() }\n }.forEach { message ->\n if(ask != null) {\n println(message)\n } else {\n println(\n ansi().fgBrightMagenta().a(\"MaestroGPT> \").reset().fgBrightCyan().a(message).reset().toString()\n )\n }\n println()\n }\n\n if (ask != null) {\n return 0\n }\n }\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/CheckSyntaxCommand.kt", "content": "package maestro.cli.command\n\nimport maestro.cli.CliError\nimport maestro.orchestra.error.SyntaxError\nimport maestro.orchestra.yaml.YamlCommandReader\nimport picocli.CommandLine\nimport java.io.File\nimport java.util.concurrent.Callable\n\n@CommandLine.Command(\n name = \"check-syntax\",\n description = [\n \"Check syntax of Maestro code\"\n ]\n)\nclass CheckSyntaxCommand : Callable {\n\n @CommandLine.Parameters(\n index = \"0\",\n description = [\"Check syntax of Maestro flow file or \\\"-\\\" for stdin\"],\n )\n private lateinit var file: File\n\n override fun call(): Int {\n val maestroCode = if (file.path == \"-\") {\n System.`in`.readBytes().toString(Charsets.UTF_8)\n } else {\n if (!file.exists()) throw CliError(\"File does not exist: ${file.absolutePath}\")\n file.readText()\n }\n if (maestroCode.isBlank()) throw CliError(\"Maestro code is empty.\")\n try {\n YamlCommandReader.checkSyntax(maestroCode)\n println(\"OK\")\n } catch (e: SyntaxError) {\n throw CliError(e.message)\n }\n return 0\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/CloudCommand.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro.cli.command\n\nimport maestro.cli.App\nimport maestro.cli.CliError\nimport maestro.cli.DisableAnsiMixin\nimport maestro.cli.ShowHelpMixin\nimport maestro.cli.api.ApiClient\nimport maestro.cli.cloud.CloudInteractor\nimport maestro.cli.report.ReportFormat\nimport maestro.orchestra.validation.AppMetadataAnalyzer\nimport maestro.cli.web.WebInteractor\nimport maestro.cli.report.TestDebugReporter\nimport maestro.cli.util.FileUtils.isWebFlow\nimport maestro.cli.util.PrintUtils\nimport maestro.orchestra.util.Env.withInjectedShellEnvVars\nimport maestro.orchestra.workspace.WorkspaceExecutionPlanner\nimport picocli.CommandLine\nimport picocli.CommandLine.Option\nimport java.io.File\nimport java.util.concurrent.Callable\nimport java.util.concurrent.TimeUnit\nimport maestro.orchestra.util.Env.withDefaultEnvVars\n\n@CommandLine.Command(\n name = \"cloud\",\n description = [\n \"Upload your flows on Cloud by using @|yellow `maestro cloud sample/app.apk flows_folder/`|@ (@|cyan https://app.maestro.dev|@)\",\n \"Provide your application file and a folder with Maestro flows to run them in parallel on multiple devices in the cloud\",\n \"By default, the command will block until all analyses have completed. You can use the --async flag to run the command asynchronously and exit immediately.\",\n ]\n)\nclass CloudCommand : Callable {\n\n @CommandLine.Spec\n var spec: CommandLine.Model.CommandSpec? = null\n\n @CommandLine.Mixin\n var disableANSIMixin: DisableAnsiMixin? = null\n\n @CommandLine.Mixin\n var showHelpMixin: ShowHelpMixin? = null\n\n @CommandLine.Parameters(hidden = true, arity = \"0..2\", description = [\"App file and/or Flow file i.e \"])\n private lateinit var files: List\n\n @Option(names = [\"--config\"], description = [\"Optional .yaml configuration file for Flows. If not provided, Maestro will look for a config.yaml file in the root directory.\"])\n private var configFile: File? = null\n\n @Option(names = [\"--app-file\"], description = [\"App binary to run your Flows against\"])\n private var appFile: File? = null\n\n @Option(order = 1, names = [\"--flows\"], description = [\"A Flow filepath or a folder path that contains Flows\"])\n private lateinit var flowsFile: File\n\n @Option(order = 0, names = [\"--api-key\", \"--apiKey\"], description = [\"API key\"])\n private var apiKey: String? = null\n\n @Option(order = 1, names = [\"--project-id\", \"--projectId\"], description = [\"Project Id\"])\n private var projectId: String? = null\n\n @Option(order = 2, names = [\"--api-url\", \"--apiUrl\"], description = [\"API base URL\"])\n private var apiUrl: String? = null\n\n @Option(order = 3, names = [\"--mapping\"], description = [\"dSYM file (iOS) or Proguard mapping file (Android)\"])\n private var mapping: File? = null\n\n @Option(order = 4, names = [\"--repo-owner\", \"--repoOwner\"], description = [\"Repository owner (ie: GitHub organization or user slug)\"])\n private var repoOwner: String? = null\n\n @Option(order = 5, names = [\"--repo-name\", \"--repoName\"], description = [\"Repository name (ie: GitHub repo slug)\"])\n private var repoName: String? = null\n\n @Option(order = 6, names = [\"--branch\"], description = [\"The branch this upload originated from\"])\n private var branch: String? = null\n\n @Option(order = 7, names = [\"--commit-sha\", \"--commitSha\"], description = [\"The commit SHA of this upload\"])\n private var commitSha: String? = null\n\n @Option(order = 8, names = [\"--pull-request-id\", \"--pullRequestId\"], description = [\"The ID of the pull request this upload originated from\"])\n private var pullRequestId: String? = null\n\n @Option(order = 9, names = [\"-e\", \"--env\"], description = [\"Environment variables to inject into your Flows\"])\n private var env: Map = emptyMap()\n\n @Option(order = 10, names = [\"--name\"], description = [\"Name of the upload\"])\n private var uploadName: String? = null\n\n @Option(order = 11, names = [\"--async\"], description = [\"Run the upload asynchronously\"])\n private var async: Boolean = false\n\n @Deprecated(\"Use --device-os instead\")\n @Option(order = 12, hidden = true, names = [\"--android-api-level\"], description = [\"Android API level to run your flow against\"])\n private var androidApiLevel: Int? = null\n\n @Option(\n order = 13,\n names = [\"--include-tags\"],\n description = [\"List of tags that will remove the Flows that does not have the provided tags\"],\n split = \",\",\n )\n private var includeTags: List = emptyList()\n\n @Option(\n order = 14,\n names = [\"--exclude-tags\"],\n description = [\"List of tags that will remove the Flows containing the provided tags\"],\n split = \",\",\n )\n private var excludeTags: List = emptyList()\n\n @Option(\n order = 15,\n names = [\"--format\"],\n description = [\"Test report format (default=\\${DEFAULT-VALUE}): \\${COMPLETION-CANDIDATES}\"],\n )\n private var format: ReportFormat = ReportFormat.NOOP\n\n @Option(\n names = [\"--test-suite-name\"],\n description = [\"Test suite name\"],\n )\n private var testSuiteName: String? = null\n\n @Option(\n order = 16,\n names = [\"--output\"],\n description = [\"File to write report into (default=report.xml)\"],\n )\n private var output: File? = null\n\n @Deprecated(\"Use --device-os instead\")\n @Option(order = 17, hidden = true, names = [\"--ios-version\"], description = [\"iOS version to run your flow against. Please use --device-os instead\"])\n private var iOSVersion: String? = null\n\n @Option(order = 18, names = [\"--app-binary-id\", \"--appBinaryId\"], description = [\"The ID of the app binary previously uploaded to Maestro Cloud\"])\n private var appBinaryId: String? = null\n\n @Option(order = 19, names = [\"--device-locale\"], description = [\"Locale that will be set to a device, ISO-639-1 code and uppercase ISO-3166-1 code i.e. \\\"de_DE\\\" for Germany\"])\n private var deviceLocale: String? = null\n\n @Option(order = 20, names = [\"--device-model\"], description = [\n \"Device model to run your flow against. \" +\n \"iOS: iPhone-11, iPhone-11-Pro, etc. Run command: maestro list-cloud-devices\" +\n \"Android: pixel_6, etc. Run command: maestro list-cloud-devices\"\n ])\n private var deviceModel: String? = null\n\n @Option(order = 21, names = [\"--device-os\"], description = [\n \"OS version to run your flow against. \" +\n \"iOS: iOS-16-2, iOS-17-5, iOS-18-2, etc. maestro list-devices\" +\n \"Android: android-33, android-34, etc. maestro list-cloud-devices\"\n ])\n private var deviceOs: String? = null\n\n @Option(hidden = true, names = [\"--fail-on-cancellation\"], description = [\"Fail the command if the upload is marked as cancelled\"])\n private var failOnCancellation: Boolean = false\n\n @Option(hidden = true, names = [\"--fail-on-timeout\"], description = [\"Fail the command if the upload times outs\"])\n private var failOnTimeout: Boolean = true\n\n @Option(hidden = true, names = [\"--disable-notifications\"], description = [\"Do not send the notifications configured in config.yaml\"])\n private var disableNotifications = false\n\n @Option(hidden = true, names = [\"--timeout\"], description = [\"Minutes to wait until all flows complete\"])\n private var resultWaitTimeout = 60\n\n @CommandLine.ParentCommand\n private val parent: App? = null\n\n override fun call(): Int {\n TestDebugReporter.install(\n debugOutputPathAsString = null,\n flattenDebugOutput = false,\n printToConsole = parent?.verbose == true,\n )\n\n validateFiles()\n validateWorkSpace()\n\n // Upload\n val apiUrl = apiUrl ?: \"https://api.copilot.mobile.dev\"\n\n env = env\n .withInjectedShellEnvVars()\n .withDefaultEnvVars(flowsFile)\n\n val apiClient = ApiClient(apiUrl)\n val webManifestProvider = if (flowsFile.isWebFlow()) {\n { WebInteractor.createManifestFromWorkspace(flowsFile) }\n } else null\n\n return CloudInteractor(\n client = apiClient,\n appFileValidator = { AppMetadataAnalyzer.validateAppFile(it) },\n workspaceValidator = maestro.orchestra.validation.WorkspaceValidator(),\n webManifestProvider = webManifestProvider,\n failOnTimeout = failOnTimeout,\n waitTimeoutMs = TimeUnit.MINUTES.toMillis(resultWaitTimeout.toLong())\n ).upload(\n async = async,\n flowFile = flowsFile,\n appFile = appFile,\n mapping = mapping,\n env = env,\n uploadName = uploadName,\n repoOwner = repoOwner,\n repoName = repoName,\n branch = branch,\n commitSha = commitSha,\n pullRequestId = pullRequestId,\n apiKey = apiKey,\n appBinaryId = appBinaryId,\n includeTags = includeTags,\n excludeTags = excludeTags,\n reportFormat = format,\n reportOutput = output,\n failOnCancellation = failOnCancellation,\n testSuiteName = testSuiteName,\n disableNotifications = disableNotifications,\n deviceLocale = deviceLocale,\n projectId = projectId,\n deviceModel = deviceModel,\n deviceOs = deviceOs,\n androidApiLevel = androidApiLevel,\n iOSVersion = iOSVersion\n )\n }\n\n private fun validateWorkSpace() {\n try {\n PrintUtils.message(\"Evaluating flow(s)...\")\n WorkspaceExecutionPlanner\n .plan(\n input = setOf(flowsFile.toPath().toAbsolutePath()),\n includeTags = includeTags,\n excludeTags = excludeTags,\n config = configFile?.toPath()?.toAbsolutePath(),\n )\n } catch (e: Exception) {\n throw CliError(\"Upload aborted. Received error when evaluating flow(s):\\n\\n${e.message}\")\n }\n }\n\n private fun validateFiles() {\n\n if (configFile != null && configFile?.exists()?.not() == true) {\n throw CliError(\"The config file ${configFile?.absolutePath} does not exist.\")\n }\n\n // Maintains backwards compatibility for this syntax: maestro cloud \n // App file can be optional now\n if (this::files.isInitialized) {\n when (files.size) {\n 2 -> {\n appFile = files[0]\n flowsFile = files[1]\n }\n 1 -> {\n flowsFile = files[0]\n }\n }\n }\n\n val hasWorkspace = this::flowsFile.isInitialized\n val hasApp = appFile != null\n || appBinaryId != null\n || (this::flowsFile.isInitialized && this::flowsFile.get().isWebFlow())\n\n if (!hasApp && !hasWorkspace) {\n throw CommandLine.MissingParameterException(spec!!.commandLine(), spec!!.findOption(\"--flows\"), \"Missing required parameters: '--app-file', \" +\n \"'--flows'. \" +\n \"Example:\" +\n \" maestro cloud --app-file --flows \")\n }\n\n if (!hasApp) throw CommandLine.MissingParameterException(spec!!.commandLine(), spec!!.findOption(\"--app-file\"), \"Missing required parameter for option '--app-file' or \" +\n \"'--app-binary-id'\")\n if (!hasWorkspace) throw CommandLine.MissingParameterException(spec!!.commandLine(), spec!!.findOption(\"--flows\"), \"Missing required parameter for option '--flows'\")\n\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/DownloadSamplesCommand.kt", "content": "package maestro.cli.command\n\nimport kotlinx.coroutines.runBlocking\nimport maestro.cli.DisableAnsiMixin\nimport maestro.cli.ShowHelpMixin\nimport maestro.cli.util.FileDownloader\nimport maestro.cli.util.PrintUtils.err\nimport maestro.cli.util.PrintUtils.message\nimport maestro.cli.view.ProgressBar\nimport org.rauschig.jarchivelib.ArchiverFactory\nimport picocli.CommandLine\nimport picocli.CommandLine.Option\nimport java.io.File\nimport java.util.concurrent.Callable\n\n@CommandLine.Command(\n name = \"download-samples\",\n description = [\n \"Download sample apps and flows for trying out maestro without setting up your own app\"\n ]\n)\nclass DownloadSamplesCommand : Callable {\n\n @CommandLine.Mixin\n var disableANSIMixin: DisableAnsiMixin? = null\n\n @CommandLine.Mixin\n var showHelpMixin: ShowHelpMixin? = null\n\n @Option(names = [\"-o\", \"--output\"], description = [\"Output directory\"])\n private var outputDirectory: File? = null\n\n override fun call(): Int {\n val folder = ensureSamplesFolder()\n val samplesFile = File(\"maestro-samples.zip\")\n\n return runBlocking {\n try {\n downloadSamplesZip(samplesFile)\n\n val archiver = ArchiverFactory.createArchiver(samplesFile)\n archiver.extract(samplesFile, folder)\n\n message(\"โœ… Samples downloaded to $folder/\")\n return@runBlocking 0\n } catch (e: Exception) {\n err(e.message ?: \"Error downloading samples: $e\")\n return@runBlocking 1\n } finally {\n samplesFile.delete()\n }\n }\n }\n\n private suspend fun downloadSamplesZip(file: File) {\n val progressView = ProgressBar(20)\n\n FileDownloader\n .downloadFile(\n SAMPLES_URL,\n file\n ).collect {\n when (it) {\n is FileDownloader.DownloadResult.Success -> {\n // Do nothing\n }\n is FileDownloader.DownloadResult.Error -> {\n throw it.cause ?: error(it.message)\n }\n is FileDownloader.DownloadResult.Progress -> {\n progressView.set(it.progress)\n }\n }\n }\n }\n\n private fun ensureSamplesFolder(): File {\n val outputDir = outputDirectory\n ?: File(\"samples\")\n\n if (!outputDir.exists()) {\n outputDir.mkdirs()\n }\n\n return outputDir\n }\n\n companion object {\n\n private const val SAMPLES_URL = \"https://storage.googleapis.com/mobile.dev/samples/samples.zip\"\n\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/DriverCommand.kt", "content": "package maestro.cli.command\n\nimport maestro.cli.driver.DriverBuilder\nimport maestro.cli.driver.RealIOSDeviceDriver\nimport picocli.CommandLine\nimport java.util.concurrent.Callable\n\n@CommandLine.Command(\n name = \"driver-setup\",\n description = [\n \"Setup maestro drivers on your devices. Right now works for real iOS devices\"\n ],\n hidden = true\n)\nclass DriverCommand : Callable {\n\n @CommandLine.Option(\n names = [\"--apple-team-id\"],\n description = [\"The Team ID is a unique 10-character string generated by Apple that is assigned to your team's apple account.\"],\n hidden = true\n )\n private var appleTeamId: String? = null\n\n @CommandLine.Option(\n names = [\"--destination\"],\n description = [\"Destination device to build the driver for. Defaults to generic/platform=iphoneos if not specified.\"],\n hidden = true\n )\n private var destination: String? = null\n\n\n override fun call(): Int {\n val teamId = requireNotNull(appleTeamId) { \"Apple account team ID must be specified.\" }\n val destination = destination ?: \"generic/platform=iphoneos\"\n\n val driverBuilder = DriverBuilder()\n\n RealIOSDeviceDriver(\n teamId = teamId,\n destination = destination,\n driverBuilder = driverBuilder,\n ).validateAndUpdateDriver(force = true)\n\n return 0\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/ListCloudDevicesCommand.kt", "content": "package maestro.cli.command\n\nimport maestro.cli.App\nimport maestro.cli.CliError\nimport maestro.cli.ShowHelpMixin\nimport maestro.cli.api.ApiClient\nimport maestro.cli.report.TestDebugReporter\nimport maestro.cli.util.EnvUtils\nimport maestro.cli.util.PrintUtils\nimport maestro.cli.view.bold\nimport maestro.cli.view.cyan\nimport maestro.device.Platform\nimport picocli.CommandLine\nimport java.util.concurrent.Callable\n\n@CommandLine.Command(\n name = \"list-cloud-devices\",\n description = [\"List devices available on Maestro Cloud, grouped by platform\"],\n)\nclass ListCloudDevicesCommand : Callable {\n\n @CommandLine.Mixin\n var showHelpMixin: ShowHelpMixin? = null\n\n @CommandLine.ParentCommand\n private val parent: App? = null\n\n @CommandLine.Option(\n names = [\"--platform\"],\n description = [\"Filter by platform: android, ios, web\"],\n )\n private var platform: String? = null\n\n override fun call(): Int {\n TestDebugReporter.install(null, printToConsole = parent?.verbose == true)\n\n val platformFilter = platform?.let { input ->\n Platform.fromString(input)\n }\n\n val apiClient = ApiClient(EnvUtils.BASE_API_URL)\n\n println()\n PrintUtils.info(\"Cloud Devices\", bold = true)\n println(\"โ”€\".repeat(SEPARATOR_WIDTH))\n\n val cloudDevices = try {\n apiClient.listCloudDevices()\n } catch (e: ApiClient.ApiException) {\n if (e.statusCode == null) PrintUtils.err(\"Unable to reach Maestro Cloud. Please check your network connection and try again.\")\n throw e\n }\n\n val platformOrder = listOf(Platform.IOS, Platform.ANDROID, Platform.WEB)\n val platforms = if (platformFilter != null) listOf(platformFilter) else platformOrder\n\n val sections = platforms.mapNotNull { p ->\n val key = p.name.lowercase()\n val raw = cloudDevices[key] ?: return@mapNotNull null\n val groups = raw.map { (model, osList) -> DeviceGroup(model, osList) }\n p to groups\n }.filter { it.second.isNotEmpty() }\n\n if (sections.isEmpty()) {\n println(\"No cloud devices found\")\n return 0\n }\n\n sections.forEachIndexed { idx, (p, groups) ->\n if (idx > 0) println()\n printSection(p, groups)\n }\n\n return 0\n }\n\n private data class DeviceGroup(\n val model: String,\n val osList: List,\n )\n\n private fun printSection(platform: Platform, groups: List) {\n println(platform.description.bold())\n\n val modelW = groups.maxOf { it.model.length }\n\n for (g in groups) {\n val osLine = g.osList.joinToString(\", \")\n println(row(g.model.cyan().padEnd(modelW + ansiExtra(g.model.cyan())), osLine))\n }\n }\n\n private fun row(vararg cols: String) = \" \" + cols.joinToString(\" \")\n\n private fun ansiExtra(s: String) = s.length - s.replace(ANSI_RE, \"\").length\n\n companion object {\n private val ANSI_RE = Regex(\"\\u001B\\\\[[\\\\d;]*[^\\\\d;]\")\n private const val SEPARATOR_WIDTH = 53\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/ListDevicesCommand.kt", "content": "package maestro.cli.command\n\nimport maestro.cli.App\nimport maestro.cli.CliError\nimport maestro.cli.ShowHelpMixin\nimport maestro.cli.report.TestDebugReporter\nimport maestro.cli.util.PrintUtils\nimport maestro.cli.view.bold\nimport maestro.cli.view.cyan\nimport maestro.cli.view.faint\nimport maestro.device.Device\nimport maestro.device.DeviceService\nimport maestro.device.Platform\nimport picocli.CommandLine\nimport java.util.concurrent.Callable\n\n@CommandLine.Command(\n name = \"list-devices\",\n description = [\"List local devices available, grouped by platform\"],\n)\nclass ListDevicesCommand : Callable {\n\n @CommandLine.Mixin\n var showHelpMixin: ShowHelpMixin? = null\n\n @CommandLine.ParentCommand\n private val parent: App? = null\n\n @CommandLine.Option(\n names = [\"--platform\"],\n description = [\"Filter by platform: android, ios, web\"],\n )\n private var platform: String? = null\n\n override fun call(): Int {\n TestDebugReporter.install(null, printToConsole = parent?.verbose == true)\n\n val platformFilter = platform?.let { input ->\n Platform.fromString(input)\n }\n\n println(\"Showing local devices. Use 'maestro list-cloud-device' to list devices available on Maestro Cloud.\".faint())\n println()\n\n PrintUtils.info(\"Local Devices\", bold = true)\n println(\"โ”€\".repeat(SEPARATOR_WIDTH))\n\n val devices = DeviceService.listDevices(includeWeb = true)\n val platforms = if (platformFilter != null) listOf(platformFilter) else Platform.entries\n val sections = platforms.map { p -> p to devices.filter { it.platform == p }.groupedByModel() }\n .filter { it.second.isNotEmpty() }\n\n if (sections.isEmpty()) {\n println(\"No devices found\")\n return 0\n }\n\n sections.forEachIndexed { idx, (p, groups) ->\n if (idx > 0) println()\n printSection(p, groups)\n }\n\n return 0\n }\n\n private data class DeviceGroup(\n val model: String,\n val osList: List,\n )\n\n private fun List.groupedByModel(): List {\n val groups = LinkedHashMap>()\n for (device in this) {\n if (device.deviceSpec.model.isEmpty()) continue\n val osList = groups.getOrPut(device.deviceSpec.model) { mutableListOf() }\n if (device.deviceSpec.os.isNotEmpty() && device.deviceSpec.os !in osList) {\n osList.add(device.deviceSpec.os)\n }\n }\n return groups.map { (model, osList) -> DeviceGroup(model, osList) }\n }\n\n private fun printSection(platform: Platform, groups: List) {\n println(platform.description.bold())\n\n val modelW = groups.maxOf { it.model.length }\n\n for (g in groups) {\n val osLine = g.osList.joinToString(\", \")\n println(row(g.model.cyan().padEnd(modelW + ansiExtra(g.model.cyan())), osLine))\n }\n }\n\n private fun row(vararg cols: String) = \" \" + cols.joinToString(\" \")\n\n private fun ansiExtra(s: String) = s.length - s.replace(ANSI_RE, \"\").length\n\n companion object {\n private val ANSI_RE = Regex(\"\\u001B\\\\[[\\\\d;]*[^\\\\d;]\")\n private const val SEPARATOR_WIDTH = 53\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/LoginCommand.kt", "content": "package maestro.cli.command\n\nimport maestro.auth.ApiKey\nimport maestro.cli.DisableAnsiMixin\nimport maestro.cli.ShowHelpMixin\nimport maestro.cli.analytics.Analytics\nimport maestro.cli.analytics.UserLoggedOutEvent\nimport maestro.cli.api.ApiClient\nimport maestro.cli.auth.Auth\nimport maestro.cli.util.PrintUtils.message\nimport picocli.CommandLine\nimport java.util.concurrent.Callable\nimport kotlin.io.path.absolutePathString\nimport maestro.cli.report.TestDebugReporter\nimport maestro.debuglog.LogConfig\nimport picocli.CommandLine.Option\n\n@CommandLine.Command(\n name = \"login\",\n description = [\n \"Log into Maestro Cloud\"\n ]\n)\nclass LoginCommand : Callable {\n\n @CommandLine.Mixin\n var disableANSIMixin: DisableAnsiMixin? = null\n\n @CommandLine.Mixin\n var showHelpMixin: ShowHelpMixin? = null\n\n @Option(names = [\"--api-url\", \"--apiUrl\"], description = [\"API base URL\"])\n private var apiUrl: String = \"https://api.copilot.mobile.dev\"\n\n private val auth by lazy {\n Auth(ApiClient(apiUrl))\n }\n\n override fun call(): Int {\n Analytics.trackEvent(UserLoggedOutEvent())\n\n LogConfig.configure(logFileName = null, printToConsole = false) // Disable all logs from Login\n val token = auth.triggerSignInFlow()\n println(token)\n\n return 0\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/LogoutCommand.kt", "content": "package maestro.cli.command\n\nimport maestro.cli.DisableAnsiMixin\nimport maestro.cli.ShowHelpMixin\nimport maestro.cli.analytics.Analytics\nimport maestro.cli.analytics.UserLoggedOutEvent\nimport org.fusesource.jansi.Ansi\nimport picocli.CommandLine\nimport java.nio.file.Path\nimport java.nio.file.Paths\nimport java.util.concurrent.Callable\nimport kotlin.io.path.deleteIfExists\nimport maestro.cli.util.PrintUtils\nimport maestro.cli.util.PrintUtils.message\n\n@CommandLine.Command(\n name = \"logout\",\n description = [\n \"Log out of Maestro Cloud\"\n ]\n)\nclass LogoutCommand : Callable {\n\n @CommandLine.Mixin\n var disableANSIMixin: DisableAnsiMixin? = null\n\n @CommandLine.Mixin\n var showHelpMixin: ShowHelpMixin? = null\n\n private val cachedAuthTokenFile: Path = Paths.get(System.getProperty(\"user.home\"), \".mobiledev\", \"authtoken\")\n\n override fun call(): Int {\n // Track logout event before deleting the token\n Analytics.trackEvent(UserLoggedOutEvent())\n \n cachedAuthTokenFile.deleteIfExists()\n\n message(\"Logged out.\")\n\n return 0\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/McpCommand.kt", "content": "package maestro.cli.command\n\nimport picocli.CommandLine\nimport java.util.concurrent.Callable\nimport maestro.cli.mcp.runMaestroMcpServer\nimport java.io.File\nimport maestro.cli.util.WorkingDirectory\n\n@CommandLine.Command(\n name = \"mcp\",\n description = [\n \"Starts the Maestro MCP server, exposing Maestro device and automation commands as Model Context Protocol (MCP) tools over STDIO for LLM agents and automation clients.\"\n ],\n)\nclass McpCommand : Callable {\n @CommandLine.Option(\n names = [\"--working-dir\"],\n description = [\"Base working directory for resolving files\"]\n )\n private var workingDir: File? = null\n\n override fun call(): Int {\n if (workingDir != null) {\n WorkingDirectory.baseDir = workingDir!!.absoluteFile\n }\n runMaestroMcpServer()\n return 0\n }\n} " }, { "path": "maestro-cli/src/main/java/maestro/cli/command/PrintHierarchyCommand.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro.cli.command\n\nimport com.fasterxml.jackson.annotation.JsonInclude\nimport com.fasterxml.jackson.module.kotlin.jacksonObjectMapper\nimport maestro.TreeNode\nimport maestro.cli.App\nimport maestro.cli.DisableAnsiMixin\nimport maestro.cli.ShowHelpMixin\nimport maestro.cli.analytics.Analytics\nimport maestro.cli.analytics.PrintHierarchyFinishedEvent\nimport maestro.cli.analytics.PrintHierarchyStartedEvent\nimport maestro.cli.report.TestDebugReporter\nimport maestro.cli.session.MaestroSessionManager\nimport maestro.cli.view.yellow\nimport maestro.utils.CliInsights\nimport maestro.utils.Insight\nimport maestro.utils.chunkStringByWordCount\nimport picocli.CommandLine\nimport picocli.CommandLine.Option\nimport java.lang.StringBuilder\n\n@CommandLine.Command(\n name = \"hierarchy\",\n description = [\n \"Print out the view hierarchy of the connected device\"\n ]\n)\nclass PrintHierarchyCommand : Runnable {\n\n @CommandLine.Mixin\n var disableANSIMixin: DisableAnsiMixin? = null\n\n @CommandLine.Mixin\n var showHelpMixin: ShowHelpMixin? = null\n\n @CommandLine.ParentCommand\n private val parent: App? = null\n\n @CommandLine.Option(\n names = [\"--android-webview-hierarchy\"],\n description = [\"Set to \\\"devtools\\\" to use Chrome dev tools for Android WebView hierarchy\"],\n hidden = true,\n )\n private var androidWebViewHierarchy: String? = null\n\n @CommandLine.Option(\n names = [\"--reinstall-driver\"],\n description = [\"Reinstalls driver before running the test. On iOS, reinstalls xctestrunner driver. On Android, reinstalls both driver and server apps. Set to false to skip reinstallation.\"],\n negatable = true,\n defaultValue = \"true\",\n fallbackValue = \"true\" \n )\n private var reinstallDriver: Boolean = true\n\n @Option(\n names = [\"--apple-team-id\"],\n description = [\"The Team ID is a unique 10-character string generated by Apple that is assigned to your team's apple account.\"],\n hidden = true\n )\n private var appleTeamId: String? = null\n\n @CommandLine.Option(\n names = [\"--compact\"],\n description = [\"Output in CSV format with element_num,depth,attributes,parent_num columns\"],\n hidden = false\n )\n private var compact: Boolean = false\n\n @CommandLine.Option(\n names = [\"--device-index\"],\n description = [\"The index of the device to run the test on\"],\n hidden = true\n )\n private var deviceIndex: Int? = null\n\n override fun run() {\n TestDebugReporter.install(\n debugOutputPathAsString = null,\n flattenDebugOutput = false,\n printToConsole = parent?.verbose == true,\n )\n \n // Track print hierarchy start\n val platform = parent?.platform ?: \"unknown\"\n val startTime = System.currentTimeMillis()\n Analytics.trackEvent(PrintHierarchyStartedEvent(platform = platform))\n \n\n MaestroSessionManager.newSession(\n host = parent?.host,\n port = parent?.port,\n driverHostPort = null,\n teamId = appleTeamId,\n deviceId = parent?.deviceId,\n platform = parent?.platform,\n reinstallDriver = reinstallDriver,\n deviceIndex = deviceIndex\n ) { session ->\n session.maestro.setAndroidChromeDevToolsEnabled(androidWebViewHierarchy == \"devtools\")\n val callback: (Insight) -> Unit = {\n val message = StringBuilder()\n val level = it.level.toString().lowercase().replaceFirstChar(Char::uppercase)\n message.append(level.yellow() + \": \")\n it.message.chunkStringByWordCount(12).forEach { chunkedMessage ->\n message.append(\"$chunkedMessage \")\n }\n println(message.toString())\n }\n val insights = CliInsights\n\n insights.onInsightsUpdated(callback)\n\n val tree = session.maestro.viewHierarchy().root\n\n insights.unregisterListener(callback)\n\n if (compact) {\n // Output in CSV format\n println(\"element_num,depth,attributes,parent_num\")\n val nodeToId = mutableMapOf()\n val csv = StringBuilder()\n \n // Assign IDs to each node\n var counter = 0\n tree?.aggregate()?.forEach { node ->\n nodeToId[node] = counter++\n }\n \n // Process tree recursively to generate CSV\n processTreeToCSV(tree, 0, null, nodeToId, csv)\n \n println(csv.toString())\n } else {\n // Original JSON output format\n val hierarchy = jacksonObjectMapper()\n .setSerializationInclusion(JsonInclude.Include.NON_NULL)\n .writerWithDefaultPrettyPrinter()\n .writeValueAsString(tree)\n \n println(hierarchy)\n }\n }\n \n // Track successful completion\n val duration = System.currentTimeMillis() - startTime\n Analytics.trackEvent(PrintHierarchyFinishedEvent(\n platform = platform,\n success = true,\n durationMs = duration\n ))\n Analytics.flush()\n }\n \n private fun processTreeToCSV(\n node: TreeNode?, \n depth: Int, \n parentId: Int?, \n nodeToId: Map,\n csv: StringBuilder\n ) {\n if (node == null) return\n \n val nodeId = nodeToId[node] ?: return\n \n // Build attributes string\n val attributesList = mutableListOf()\n \n // Add normal attributes\n node.attributes.forEach { (key, value) ->\n if (value.isNotEmpty() && value != \"false\") {\n attributesList.add(\"$key=$value\")\n }\n }\n \n // Add boolean properties if true\n if (node.clickable == true) attributesList.add(\"clickable=true\")\n if (node.enabled == true) attributesList.add(\"enabled=true\")\n if (node.focused == true) attributesList.add(\"focused=true\")\n if (node.checked == true) attributesList.add(\"checked=true\")\n if (node.selected == true) attributesList.add(\"selected=true\")\n \n // Join all attributes with \"; \"\n val attributesString = attributesList.joinToString(\"; \")\n \n // Escape quotes in the attributes string if needed\n val escapedAttributes = attributesString.replace(\"\\\"\", \"\\\"\\\"\")\n \n // Add this node to CSV\n csv.append(\"$nodeId,$depth,\\\"$escapedAttributes\\\",${parentId ?: \"\"}\\n\")\n \n // Process children\n node.children.forEach { child ->\n processTreeToCSV(child, depth + 1, nodeId, nodeToId, csv)\n }\n }\n\n private fun removeEmptyValues(tree: TreeNode?): TreeNode? {\n if (tree == null) {\n return null\n }\n\n return TreeNode(\n attributes = tree.attributes.filter {\n it.value != \"\" && it.value.toString() != \"false\"\n }.toMutableMap(),\n children = tree.children.map { removeEmptyValues(it) }.filterNotNull(),\n checked = if(tree.checked == true) true else null,\n clickable = if(tree.clickable == true) true else null,\n enabled = if(tree.enabled == true) true else null,\n focused = if(tree.focused == true) true else null,\n selected = if(tree.selected == true) true else null,\n )\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/QueryCommand.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro.cli.command\n\nimport com.fasterxml.jackson.module.kotlin.jacksonObjectMapper\nimport maestro.ElementFilter\nimport maestro.Filters\nimport maestro.cli.App\nimport maestro.cli.DisableAnsiMixin\nimport maestro.cli.ShowHelpMixin\nimport maestro.cli.session.MaestroSessionManager\nimport maestro.cli.view.red\nimport maestro.orchestra.Orchestra\nimport maestro.utils.StringUtils.toRegexSafe\nimport picocli.CommandLine\nimport picocli.CommandLine.Command\nimport picocli.CommandLine.Model\nimport picocli.CommandLine.Option\nimport picocli.CommandLine.Spec\n\n@Command(\n name = \"query\",\n description = [\n \"Find elements in the view hierarchy of the connected device\"\n ],\n hidden = true\n)\nclass QueryCommand : Runnable {\n\n @CommandLine.Mixin\n var disableANSIMixin: DisableAnsiMixin? = null\n\n @CommandLine.Mixin\n var showHelpMixin: ShowHelpMixin? = null\n\n @CommandLine.ParentCommand\n private val parent: App? = null\n\n @Option(names = [\"text\"])\n private var text: String? = null\n\n @Option(names = [\"id\"])\n private var id: String? = null\n\n @Spec\n lateinit var commandSpec: Model.CommandSpec\n\n @Option(\n names = [\"--apple-team-id\"],\n description = [\"The Team ID is a unique 10-character string generated by Apple that is assigned to your team's apple account.\"],\n hidden = true\n )\n private var appleTeamId: String? = null\n\n override fun run() {\n MaestroSessionManager.newSession(\n host = parent?.host,\n port = parent?.port,\n driverHostPort = null,\n deviceId = parent?.deviceId,\n platform = parent?.platform,\n teamId = appleTeamId,\n ) { session ->\n val filters = mutableListOf()\n\n text?.let {\n filters += Filters.textMatches(it.toRegexSafe(Orchestra.REGEX_OPTIONS))\n }\n\n id?.let {\n filters += Filters.idMatches(it.toRegexSafe(Orchestra.REGEX_OPTIONS))\n }\n\n if (filters.isEmpty()) {\n throw CommandLine.ParameterException(\n commandSpec.commandLine(),\n \"Must specify at least one search criteria\"\n )\n }\n\n val elements = session.maestro.allElementsMatching(\n Filters.intersect(filters)\n )\n\n val mapper = jacksonObjectMapper()\n .writerWithDefaultPrettyPrinter()\n\n println(\"Matches: ${elements.size}\")\n elements.forEach {\n println(\n mapper.writeValueAsString(it)\n )\n }\n }\n System.err.println(\"This command is deprecated. Use \\\"maestro studio\\\" instead.\".red())\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/RecordCommand.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro.cli.command\n\nimport maestro.cli.App\nimport maestro.cli.CliError\nimport maestro.cli.DisableAnsiMixin\nimport maestro.cli.ShowHelpMixin\nimport maestro.cli.analytics.Analytics\nimport maestro.cli.analytics.RecordFinishedEvent\nimport maestro.cli.analytics.RecordStartedEvent\nimport maestro.cli.graphics.LocalVideoRenderer\nimport maestro.cli.graphics.RemoteVideoRenderer\nimport maestro.cli.graphics.SkiaFrameRenderer\nimport maestro.cli.report.TestDebugReporter\nimport maestro.cli.runner.TestRunner\nimport maestro.cli.runner.resultview.AnsiResultView\nimport maestro.cli.session.MaestroSessionManager\nimport maestro.cli.util.FileUtils.isWebFlow\nimport maestro.orchestra.workspace.WorkspaceExecutionPlanner\nimport okio.sink\nimport picocli.CommandLine\nimport picocli.CommandLine.Option\nimport java.io.File\nimport java.util.concurrent.Callable\n\n@CommandLine.Command(\n name = \"record\",\n description = [\n \"Render a beautiful video of your Flow - Great for demos and bug reports\"\n ]\n)\nclass RecordCommand : Callable {\n\n @CommandLine.Mixin\n var disableANSIMixin: DisableAnsiMixin? = null\n\n @CommandLine.Mixin\n var showHelpMixin: ShowHelpMixin? = null\n\n @CommandLine.ParentCommand\n private val parent: App? = null\n\n @CommandLine.Parameters(index = \"0\", description = [\"The Flow file to record.\"])\n private lateinit var flowFile: File\n\n @CommandLine.Parameters(description = [\"Output file for the rendered video. Only valid for local rendering (--local).\"], arity = \"0..1\", index = \"1\")\n private var outputFile: File? = null\n\n @Option(names = [\"--config\"], description = [\"Optional .yaml configuration file for Flows. If not provided, Maestro will look for a config.yaml file in the root directory.\"])\n private var configFile: File? = null\n\n @Option(names = [\"--local\"], description = [\"(Beta) Record using local rendering. This will become the default in a future Maestro release.\"])\n private var local: Boolean = false\n\n @Option(names = [\"-e\", \"--env\"])\n private var env: Map = emptyMap()\n\n @Option(\n names = [\"--apple-team-id\"],\n description = [\"The Team ID is a unique 10-character string generated by Apple that is assigned to your team's apple account.\"]\n )\n private var appleTeamId: String? = null\n\n @CommandLine.Spec\n lateinit var commandSpec: CommandLine.Model.CommandSpec\n\n @Option(\n names = [\"--debug-output\"],\n description = [\"Configures the debug output in this path, instead of default\"]\n )\n private var debugOutput: String? = null\n\n override fun call(): Int {\n // Track record start\n val startTime = System.currentTimeMillis()\n val platform = parent?.platform ?: \"unknown\"\n Analytics.trackEvent(RecordStartedEvent(platform = platform))\n\n if (!flowFile.exists()) {\n throw CommandLine.ParameterException(\n commandSpec.commandLine(),\n \"File not found: $flowFile\"\n )\n }\n\n if (!local && outputFile != null) {\n throw CommandLine.ParameterException(\n commandSpec.commandLine(),\n \"The outputFile parameter is only valid for local rendering (--local).\",\n )\n }\n\n if (configFile != null && configFile?.exists()?.not() == true) {\n throw CliError(\"The config file ${configFile?.absolutePath} does not exist.\")\n }\n TestDebugReporter.install(debugOutputPathAsString = debugOutput, printToConsole = parent?.verbose == true)\n val path = TestDebugReporter.getDebugOutputPath()\n\n val deviceId = if (flowFile.isWebFlow()) {\n throw CliError(\"'record' command does not support web flows yet.\")\n } else {\n parent?.deviceId\n }\n\n val plan = WorkspaceExecutionPlanner.plan(\n input = setOf(flowFile.toPath()),\n includeTags = emptyList(),\n excludeTags = emptyList(),\n config = configFile?.toPath()\n )\n\n return MaestroSessionManager.newSession(\n host = parent?.host,\n port = parent?.port,\n driverHostPort = null,\n deviceId = deviceId,\n teamId = appleTeamId,\n platform = parent?.platform,\n executionPlan = plan,\n block = { session ->\n val maestro = session.maestro\n val device = session.device\n\n if (flowFile.isDirectory) {\n throw CommandLine.ParameterException(\n commandSpec.commandLine(),\n \"Only single Flows are supported by \\\"maestro record\\\". $flowFile is a directory.\",\n )\n }\n\n val resultView = AnsiResultView()\n val screenRecording = kotlin.io.path.createTempFile(suffix = \".mp4\").toFile()\n val exitCode = screenRecording.sink().use { out ->\n maestro.startScreenRecording(out).use {\n TestRunner.runSingle(\n maestro,\n device,\n flowFile,\n env,\n resultView,\n path,\n testOutputDir = null,\n deviceId = parent?.deviceId,\n )\n }\n }\n\n val frames = resultView.getFrames()\n\n val localOutputFile = outputFile ?: path.resolve(\"maestro-recording.mp4\").toFile()\n val videoRenderer = if (local) LocalVideoRenderer(\n frameRenderer = SkiaFrameRenderer(),\n outputFile = localOutputFile,\n outputFPS = 25,\n outputWidthPx = 1920,\n outputHeightPx = 1080,\n ) else RemoteVideoRenderer()\n videoRenderer.render(screenRecording, frames)\n\n TestDebugReporter.deleteOldFiles()\n\n // Track record completion\n val duration = System.currentTimeMillis() - startTime\n Analytics.trackEvent(RecordFinishedEvent(platform = platform, durationMs = duration))\n Analytics.flush()\n\n exitCode\n },\n )\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/StartDeviceCommand.kt", "content": "package maestro.cli.command\n\nimport maestro.cli.App\nimport maestro.cli.CliError\nimport maestro.cli.ShowHelpMixin\nimport maestro.cli.device.DeviceCreateUtil\nimport maestro.device.DeviceService\nimport maestro.cli.report.TestDebugReporter\nimport maestro.cli.util.EnvUtils\nimport maestro.device.DeviceSpec\nimport maestro.device.DeviceSpecRequest\nimport maestro.device.Platform\nimport picocli.CommandLine\nimport java.util.concurrent.Callable\n\n@CommandLine.Command(\n name = \"start-device\",\n description = [\n \"Starts or creates an iOS Simulator or Android Emulator similar to the ones on the cloud\",\n \"Supported device types: iPhone11 (iOS), Pixel 6 (Android)\",\n ]\n)\nclass StartDeviceCommand : Callable {\n\n @CommandLine.Mixin\n var showHelpMixin: ShowHelpMixin? = null\n\n @CommandLine.ParentCommand\n private val parent: App? = null\n\n @CommandLine.Option(\n order = 0,\n names = [\"--platform\"],\n required = true,\n description = [\"Platforms: android, ios, web\"],\n )\n private lateinit var platform: String\n\n @Deprecated(\"Use --device-os instead\")\n @CommandLine.Option(\n order = 1,\n hidden = true,\n names = [\"--os-version\"],\n description = [\"OS version to use:\", \"iOS: 16, 17, 18\", \"Android: 28, 29, 30, 31, 33\"],\n )\n private var osVersion: String? = null\n\n @CommandLine.Option(\n order = 2,\n names = [\"--device-locale\"],\n description = [\"a combination of lowercase ISO-639-1 code and uppercase ISO-3166-1 code i.e. \\\"de_DE\\\" for Germany\"],\n )\n private var deviceLocale: String? = null\n\n @CommandLine.Option(\n order = 3,\n names = [\"--device-model\"],\n description = [\n \"Device model to run against\",\n \"iOS: iPhone-11, iPhone-11-Pro, etc. Run command: maestro list-devices\",\n \"Android: pixel_6, pixel_7, etc. Run command: maestro list-devices\"\n ],\n )\n private var deviceModel: String? = null\n\n @CommandLine.Option(\n order = 4,\n names = [\"--device-os\"],\n description = [\n \"OS version to use:\",\n \"iOS: iOS-16-2, iOS-17-5, iOS-18-2, etc. maestro list-devices\",\n \"Android: android-33, android-34, etc. maestro list-devices\"\n ],\n )\n private var deviceOs: String? = null\n\n @CommandLine.Option(\n order = 5,\n names = [\"--force-create\"],\n description = [\"Will override existing device if it already exists\"],\n )\n private var forceCreate: Boolean = false\n\n override fun call(): Int {\n TestDebugReporter.install(null, printToConsole = parent?.verbose == true)\n\n if (EnvUtils.isWSL()) {\n throw CliError(\"This command is not supported in Windows WSL. You can launch your emulator manually.\")\n }\n\n // Get the device configuration\n val parsedPlatform = Platform.fromString(platform)\n val maestroDeviceConfiguration = DeviceSpec.fromRequest(\n when (parsedPlatform) {\n Platform.ANDROID -> DeviceSpecRequest.Android(\n model = deviceModel,\n os = deviceOs ?: osVersion.let { \"android-$it\" },\n locale = deviceLocale,\n cpuArchitecture = EnvUtils.getMacOSArchitecture(),\n )\n Platform.IOS -> DeviceSpecRequest.Ios(\n model = deviceModel,\n os = deviceOs ?: osVersion.let { \"iOS-$it\" },\n locale = deviceLocale,\n )\n Platform.WEB -> DeviceSpecRequest.Web(\n model = deviceModel,\n os = deviceOs ?: osVersion,\n locale = deviceLocale,\n )\n }\n )\n\n // Get/Create the device\n val device = DeviceCreateUtil.getOrCreateDevice(\n maestroDeviceConfiguration,\n forceCreate\n )\n\n // Start Device\n DeviceService.startDevice(\n device = device,\n driverHostPort = parent?.port\n )\n\n return 0\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/StudioCommand.kt", "content": "package maestro.cli.command\n\nimport maestro.cli.App\nimport maestro.cli.DisableAnsiMixin\nimport maestro.cli.ShowHelpMixin\nimport maestro.cli.report.TestDebugReporter\nimport maestro.cli.session.MaestroSessionManager\nimport maestro.cli.view.blue\nimport maestro.cli.view.bold\nimport maestro.cli.view.box\nimport maestro.cli.view.faint\nimport maestro.studio.MaestroStudio\nimport picocli.CommandLine\nimport java.awt.Desktop\nimport java.net.URI\nimport java.util.concurrent.Callable\nimport maestro.cli.util.getFreePort\nimport picocli.CommandLine.Option\n\n@CommandLine.Command(\n name = \"studio\",\n hidden = true,\n description = [\"Launch Maestro Studio\"],\n)\nclass StudioCommand : Callable {\n\n @CommandLine.Mixin\n var disableANSIMixin: DisableAnsiMixin? = null\n\n @CommandLine.Mixin\n var showHelpMixin: ShowHelpMixin? = null\n\n @CommandLine.ParentCommand\n private val parent: App? = null\n\n @Option(\n names = [\"--debug-output\"],\n description = [\"Configures the debug output in this path, instead of default\"]\n )\n private var debugOutput: String? = null\n\n @Option(\n names = [\"--no-window\"],\n description = [\"When set, a browser window will not be automatically opened\"]\n )\n private var noWindow: Boolean? = null\n\n @Option(\n names = [\"--android-webview-hierarchy\"],\n description = [\"Set to \\\"devtools\\\" to use Chrome dev tools for Android WebView hierarchy\"],\n hidden = true,\n )\n private var androidWebViewHierarchy: String? = null\n\n @Option(\n names = [\"--apple-team-id\"],\n description = [\"The Team ID is a unique 10-character string generated by Apple that is assigned to your team's apple account.\"]\n )\n private var appleTeamId: String? = null\n\n override fun call(): Int {\n println()\n println(\"\"\"\n โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ\n โ”‚ โ”‚\n โ”‚ Download the new and improved Maestro Studio app today! โ”‚\n โ”‚ โ”‚\n โ”‚ https://maestro.dev?utm_source=cli&utm_campaign=download_studio#maestro-studio โ”‚\n โ”‚ โ”‚\n โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ\"\"\".trimIndent().bold())\n println()\n\n TestDebugReporter.install(debugOutputPathAsString = debugOutput, printToConsole = parent?.verbose == true)\n\n MaestroSessionManager.newSession(\n host = parent?.host,\n port = parent?.port,\n driverHostPort = null,\n teamId = appleTeamId,\n deviceId = parent?.deviceId,\n platform = parent?.platform,\n isStudio = true,\n ) { session ->\n session.maestro.setAndroidChromeDevToolsEnabled(androidWebViewHierarchy == \"devtools\")\n\n val port = getFreePort()\n MaestroStudio.start(port, session.maestro)\n\n val studioUrl = \"http://localhost:${port}\"\n val message = (\"Maestro Studio\".bold() + \" is running at \" + studioUrl.blue()).box()\n println()\n println(message)\n tryOpenUrl(studioUrl)\n\n\n println()\n println(\"Tip: Maestro Studio can now run simultaneously alongside other Maestro CLI commands!\")\n\n println()\n println(\"Navigate to $studioUrl in your browser to open Maestro Studio. Ctrl-C to exit.\".faint())\n\n Thread.currentThread().join()\n }\n\n TestDebugReporter.deleteOldFiles()\n return 0\n }\n\n private fun tryOpenUrl(studioUrl: String) {\n try {\n if (Desktop.isDesktopSupported() && noWindow != true) {\n Desktop.getDesktop().browse(URI(studioUrl))\n }\n } catch (ignore: Exception) {\n // Do nothing\n }\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/command/TestCommand.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro.cli.command\n\nimport kotlinx.coroutines.CoroutineName\nimport kotlinx.coroutines.Dispatchers\nimport kotlinx.coroutines.async\nimport kotlinx.coroutines.awaitAll\nimport kotlinx.coroutines.runBlocking\nimport maestro.Maestro\nimport maestro.cli.App\nimport maestro.cli.CliError\nimport maestro.cli.DisableAnsiMixin\nimport maestro.cli.ShowHelpMixin\nimport maestro.cli.analytics.Analytics\nimport maestro.cli.analytics.TestRunFailedEvent\nimport maestro.cli.analytics.TestRunFinishedEvent\nimport maestro.cli.analytics.TestRunStartedEvent\nimport maestro.cli.analytics.WorkspaceRunFailedEvent\nimport maestro.cli.analytics.WorkspaceRunFinishedEvent\nimport maestro.cli.analytics.WorkspaceRunStartedEvent\nimport maestro.device.Device\nimport maestro.device.DeviceService\nimport maestro.cli.model.TestExecutionSummary\nimport maestro.cli.report.ReportFormat\nimport maestro.cli.report.ReporterFactory\nimport maestro.cli.report.TestDebugReporter\nimport maestro.cli.runner.TestRunner\nimport maestro.cli.runner.TestSuiteInteractor\nimport maestro.cli.runner.resultview.AnsiResultView\nimport maestro.cli.runner.resultview.PlainTextResultView\nimport maestro.cli.session.MaestroSessionManager\nimport maestro.cli.util.CiUtils\nimport maestro.cli.util.EnvUtils\nimport maestro.cli.util.FileUtils.isWebFlow\nimport maestro.cli.util.PrintUtils\nimport maestro.cli.insights.TestAnalysisManager\nimport maestro.cli.view.greenBox\nimport maestro.cli.view.box\nimport maestro.cli.view.green\nimport maestro.cli.api.ApiClient\nimport maestro.cli.auth.Auth\nimport maestro.cli.model.FlowStatus\nimport maestro.cli.view.cyan\nimport maestro.cli.promotion.PromotionStateManager\nimport maestro.orchestra.error.ValidationError\nimport maestro.orchestra.workspace.WorkspaceExecutionPlanner\nimport maestro.orchestra.workspace.WorkspaceExecutionPlanner.ExecutionPlan\nimport maestro.utils.isSingleFile\nimport okio.sink\nimport org.slf4j.LoggerFactory\nimport picocli.CommandLine\nimport picocli.CommandLine.Option\nimport java.io.File\nimport java.nio.file.Path\nimport java.time.LocalDate\nimport java.util.concurrent.Callable\nimport java.util.concurrent.ConcurrentHashMap\nimport kotlin.io.path.absolutePathString\nimport kotlin.math.roundToInt\nimport maestro.device.Platform\n\n@CommandLine.Command(\n name = \"test\",\n description = [\"Test a Flow or set of Flows on a local iOS Simulator or Android Emulator\"],\n)\nclass TestCommand : Callable {\n\n @CommandLine.Mixin\n var disableANSIMixin: DisableAnsiMixin? = null\n\n @CommandLine.Mixin\n var showHelpMixin: ShowHelpMixin? = null\n\n @CommandLine.ParentCommand\n private val parent: App? = null\n\n @CommandLine.Parameters(description = [\"One or more flow files or folders containing flow files\"], arity = \"1..*\")\n private var flowFiles: Set = emptySet()\n\n @Option(\n names = [\"--config\"],\n description = [\"Optional YAML configuration file for the workspace. If not provided, Maestro will look for a config.yaml file in the workspace's root directory.\"]\n )\n private var configFile: File? = null\n\n @Option(\n names = [\"-s\", \"--shards\"],\n description = [\"Number of parallel shards to distribute tests across\"],\n )\n @Deprecated(\"Use --shard-split or --shard-all instead\")\n private var legacyShardCount: Int? = null\n\n @Option(\n names = [\"--shard-split\"],\n description = [\"Run the tests across N connected devices, splitting the tests evenly across them\"],\n )\n private var shardSplit: Int? = null\n\n @Option(\n names = [\"--shard-all\"],\n description = [\"Run all the tests across N connected devices\"],\n )\n private var shardAll: Int? = null\n\n @Option(names = [\"-c\", \"--continuous\"])\n private var continuous: Boolean = false\n\n @Option(names = [\"-e\", \"--env\"])\n private var env: Map = emptyMap()\n\n @Option(\n names = [\"--format\"],\n description = [\"Test report format (default=\\${DEFAULT-VALUE}): \\${COMPLETION-CANDIDATES}\"],\n converter = [ReportFormat.Converter::class]\n )\n private var format: ReportFormat = ReportFormat.NOOP\n\n @Option(\n names = [\"--test-suite-name\"],\n description = [\"Test suite name\"],\n )\n private var testSuiteName: String? = null\n\n @Option(names = [\"--output\"])\n private var output: File? = null\n\n @Option(\n names = [\"--debug-output\"],\n description = [\"Configures the debug output in this path, instead of default\"],\n )\n private var debugOutput: String? = null\n\n @Option(\n names = [\"--test-output-dir\"],\n description = [\"Configures the test output directory for screenshots and other test artifacts (note: this does NOT include debug output)\"],\n )\n private var testOutputDir: String? = null\n\n @Option(\n names = [\"--flatten-debug-output\"],\n description = [\"All file outputs from the test case are created in the folder without subfolders or timestamps for each run. It can be used with --debug-output. Useful for CI.\"]\n )\n private var flattenDebugOutput: Boolean = false\n\n @Option(\n names = [\"--include-tags\"],\n description = [\"List of tags that will remove the Flows that does not have the provided tags\"],\n split = \",\",\n )\n private var includeTags: List = emptyList()\n\n @Option(\n names = [\"--exclude-tags\"],\n description = [\"List of tags that will remove the Flows containing the provided tags\"],\n split = \",\",\n )\n private var excludeTags: List = emptyList()\n\n @Option(\n names = [\"--headless\"],\n description = [\"(Web only) Run the tests in headless mode\"],\n )\n private var headless: Boolean = false\n\n @Option(\n names = [\"--screen-size\"],\n description = [\"(Web only) Set the size of the headless browser. Use the format {Width}x{Height}. Usage is --screen-size 1920x1080\"],\n )\n private var screenSize: String? = null\n\n @Option(\n names = [\"--analyze\"],\n description = [\"[Beta] Enhance the test output analysis with AI Insights\"],\n )\n private var analyze: Boolean = false\n\n @Option(names = [\"--api-url\"], description = [\"[Beta] API base URL\"])\n private var apiUrl: String = \"https://api.copilot.mobile.dev\"\n\n @Option(names = [\"--api-key\"], description = [\"[Beta] API key\"])\n private var apiKey: String? = null\n\n private val client: ApiClient = ApiClient(baseUrl = apiUrl)\n private val auth: Auth = Auth(client)\n private val authToken: String? = auth.getAuthToken(apiKey, triggerSignIn = false)\n\n @Option(\n names = [\"--reinstall-driver\"],\n description = [\"Reinstalls driver before running the test. On iOS, reinstalls xctestrunner driver. On Android, reinstalls both driver and server apps. Set to false to skip reinstallation.\"],\n negatable = true,\n defaultValue = \"true\",\n fallbackValue = \"true\"\n )\n private var reinstallDriver: Boolean = true\n\n @Option(\n names = [\"--apple-team-id\"],\n description = [\"The Team ID is a unique 10-character string generated by Apple that is assigned to your team's apple account.\"],\n hidden = true\n )\n private var appleTeamId: String? = null\n\n @Option(names = [\"-p\", \"--platform\"], description = [\"Select a platform to run on\"])\n var platform: String? = null\n\n @Option(\n names = [\"--device\", \"--udid\"],\n description = [\"Device ID to run on explicitly, can be a comma separated list of IDs: --device \\\"Emulator_1,Emulator_2\\\" \"],\n )\n var deviceId: String? = null\n \n @CommandLine.Spec\n lateinit var commandSpec: CommandLine.Model.CommandSpec\n\n private val usedPorts = ConcurrentHashMap()\n private val logger = LoggerFactory.getLogger(TestCommand::class.java)\n\n internal fun executionPlanIncludesWebFlow(plan: ExecutionPlan): Boolean {\n return plan.flowsToRun.any { it.toFile().isWebFlow() } ||\n plan.sequence.flows.any { it.toFile().isWebFlow() }\n }\n\n internal fun allFlowsAreWebFlow(plan: ExecutionPlan): Boolean {\n if(plan.flowsToRun.isEmpty() && plan.sequence.flows.isEmpty()) return false\n return (plan.flowsToRun.all { it.toFile().isWebFlow() } && plan.sequence.flows.all { it.toFile().isWebFlow() })\n }\n \n override fun call(): Int {\n TestDebugReporter.install(\n debugOutputPathAsString = debugOutput,\n flattenDebugOutput = flattenDebugOutput,\n printToConsole = parent?.verbose == true,\n )\n\n if (shardSplit != null && shardAll != null) {\n throw CliError(\"Options --shard-split and --shard-all are mutually exclusive.\")\n }\n\n @Suppress(\"DEPRECATION\")\n if (legacyShardCount != null) {\n PrintUtils.warn(\"--shards option is deprecated and will be removed in the next Maestro version. Use --shard-split or --shard-all instead.\")\n shardSplit = legacyShardCount\n }\n\n if (configFile != null && configFile?.exists()?.not() == true) {\n throw CliError(\"The config file ${configFile?.absolutePath} does not exist.\")\n }\n\n if (screenSize != null && !screenSize!!.matches(Regex(\"\\\\d+x\\\\d+\"))) {\n throw CliError(\"Invalid screen size format. Please use the format {Width}x{Height}, e.g. 1920x1080.\")\n }\n\n val executionPlan = try {\n WorkspaceExecutionPlanner.plan(\n input = flowFiles.map { it.toPath().toAbsolutePath() }.toSet(),\n includeTags = includeTags,\n excludeTags = excludeTags,\n config = configFile?.toPath()?.toAbsolutePath(),\n )\n } catch (e: ValidationError) {\n throw CliError(e.message)\n }\n\n val resolvedTestOutputDir = resolveTestOutputDir(executionPlan)\n\n // Update TestDebugReporter with the resolved test output directory\n TestDebugReporter.updateTestOutputDir(resolvedTestOutputDir)\n val debugOutputPath = TestDebugReporter.getDebugOutputPath()\n\n // Track test execution start\n val flowCount = executionPlan.flowsToRun.size\n val platform = parent?.platform ?: \"unknown\"\n val deviceCount = getDeviceCount(executionPlan)\n\n val result = try {\n handleSessions(debugOutputPath, executionPlan, resolvedTestOutputDir)\n } catch (e: Exception) {\n // Track workspace failure for runtime errors\n if (flowCount > 1) {\n Analytics.trackEvent(WorkspaceRunFailedEvent(\n error = e.message ?: \"Unknown error occurred during workspace execution\",\n flowCount = flowCount,\n platform = platform,\n deviceCount = deviceCount,\n ))\n } else {\n Analytics.trackEvent(TestRunFailedEvent(\n error = e.message ?: \"Unknown error occurred during workspace execution\",\n platform = platform,\n ))\n }\n throw e\n }\n\n // Flush analytics events immediately after tracking the upload finished event\n Analytics.flush()\n\n return result\n }\n\n /**\n * Get the actual number of devices that will be used for test execution\n */\n private fun getDeviceCount(plan: ExecutionPlan): Int {\n val deviceIds = getDeviceIds(plan)\n return deviceIds.size\n }\n\n /**\n * Get the list of device IDs that will be used for test execution\n */\n private fun getDeviceIds(plan: ExecutionPlan): List {\n val includeWeb = executionPlanIncludesWebFlow(plan)\n val connectedDevices = DeviceService.listConnectedDevices(\n includeWeb = includeWeb,\n host = parent?.host,\n port = parent?.port,\n )\n val availableDevices = connectedDevices.map { it.instanceId }.toSet()\n return getPassedOptionsDeviceIds(plan)\n .filter { device -> device in availableDevices }\n .ifEmpty { availableDevices }\n .toList()\n }\n\n private fun resolveTestOutputDir(plan: ExecutionPlan): Path? {\n // Command line flag takes precedence\n testOutputDir?.let { return File(it).toPath() }\n \n // Then check workspace config\n plan.workspaceConfig.testOutputDir?.let { return File(it).toPath() }\n \n // No test output directory configured\n return null\n }\n\n private fun handleSessions(debugOutputPath: Path, plan: ExecutionPlan, testOutputDir: Path?): Int = runBlocking(Dispatchers.IO) {\n val requestedShards = shardSplit ?: shardAll ?: 1\n if (requestedShards > 1 && plan.sequence.flows.isNotEmpty()) {\n error(\"Cannot run sharded tests with sequential execution\")\n }\n\n val onlySequenceFlows = plan.sequence.flows.isNotEmpty() && plan.flowsToRun.isEmpty() // An edge case\n val includeWeb = executionPlanIncludesWebFlow(plan);\n\n if (includeWeb) {\n PrintUtils.warn(\"Web support is in Beta. We would appreciate your feedback!\\n\")\n }\n\n val connectedDevices = DeviceService.listConnectedDevices(\n includeWeb = includeWeb,\n host = parent?.host,\n port = parent?.port,\n )\n val availableDevicesIds = connectedDevices.map { it.instanceId }.toSet()\n val deviceIds = getPassedOptionsDeviceIds(plan)\n .filter { device ->\n if (device !in availableDevicesIds) {\n throw CliError(\"Device $device was requested, but it is not connected.\")\n } else {\n true\n }\n }\n .ifEmpty {\n val platform = platform ?: parent?.platform\n connectedDevices\n .filter { platform == null || it.platform == Platform.fromString(platform) }\n .map { it.instanceId }.toSet()\n }\n .toList()\n\n val missingDevices = requestedShards - deviceIds.size\n if (missingDevices > 0) {\n PrintUtils.warn(\"You have ${deviceIds.size} devices connected, which is not enough to run $requestedShards shards. Missing $missingDevices device(s).\")\n throw CliError(\"Not enough devices connected (${deviceIds.size}) to run the requested number of shards ($requestedShards).\")\n }\n\n val effectiveShards = when {\n\n onlySequenceFlows -> 1\n\n shardAll == null -> requestedShards.coerceAtMost(plan.flowsToRun.size)\n\n shardSplit == null -> requestedShards.coerceAtMost(deviceIds.size)\n\n else -> 1\n }\n\n val warning = \"Requested $requestedShards shards, \" +\n \"but it cannot be higher than the number of flows (${plan.flowsToRun.size}). \" +\n \"Will use $effectiveShards shards instead.\"\n if (shardAll == null && requestedShards > plan.flowsToRun.size) PrintUtils.warn(warning)\n\n val chunkPlans = makeChunkPlans(plan, effectiveShards, onlySequenceFlows)\n\n val flowCount = if (onlySequenceFlows) plan.sequence.flows.size else plan.flowsToRun.size\n val message = when {\n shardAll != null -> \"Will run $effectiveShards shards, with all $flowCount flows in each shard\"\n shardSplit != null -> {\n val flowsPerShard = (flowCount.toFloat() / effectiveShards).roundToInt()\n val isApprox = flowCount % effectiveShards != 0\n val prefix = if (isApprox) \"approx. \" else \"\"\n \"Will split $flowCount flows across $effectiveShards shards (${prefix}$flowsPerShard flows per shard)\"\n }\n\n else -> null\n }\n message?.let { PrintUtils.info(it) }\n\n // Show cloud promotion message if there are more than 5 tests (at most once per day)\n if (flowCount > 5) {\n showCloudFasterResultsPromotionMessageIfNeeded()\n }\n\n val results = (0 until effectiveShards).map { shardIndex ->\n async(Dispatchers.IO + CoroutineName(\"shard-$shardIndex\")) {\n runShardSuite(\n effectiveShards = effectiveShards,\n deviceIds = deviceIds,\n shardIndex = shardIndex,\n chunkPlans = chunkPlans,\n debugOutputPath = debugOutputPath,\n testOutputDir = testOutputDir,\n )\n }\n }.awaitAll()\n\n val passed = results.sumOf { it.first ?: 0 }\n val total = results.sumOf { it.second ?: 0 }\n val suites = results.mapNotNull { it.third }\n\n // Show cloud debug promotion message if there are failures\n if (passed != total) {\n showCloudDebugPromotionMessageIfNeeded()\n }\n\n suites.mergeSummaries()?.saveReport()\n\n if (effectiveShards > 1) printShardsMessage(passed, total, suites)\n if (analyze) TestAnalysisManager(apiUrl = apiUrl, apiKey = apiKey).runAnalysis(debugOutputPath)\n if (passed == total) 0 else 1\n }\n\n private fun runShardSuite(\n effectiveShards: Int,\n deviceIds: List,\n shardIndex: Int,\n chunkPlans: List,\n debugOutputPath: Path,\n testOutputDir: Path?,\n ): Triple {\n val driverHostPort = selectPort(effectiveShards)\n val deviceId = deviceIds[shardIndex]\n val executionPlan = chunkPlans[shardIndex]\n\n logger.info(\"[shard ${shardIndex + 1}] Selected device $deviceId using port $driverHostPort with execution plan $executionPlan\")\n\n return MaestroSessionManager.newSession(\n host = parent?.host,\n port = parent?.port,\n teamId = appleTeamId,\n driverHostPort = driverHostPort,\n deviceId = deviceId,\n platform = platform ?: parent?.platform,\n isHeadless = headless,\n screenSize = screenSize,\n reinstallDriver = reinstallDriver,\n executionPlan = executionPlan\n ) { session ->\n val maestro = session.maestro\n val device = session.device\n\n val isReplicatingSingleFile = shardAll != null && effectiveShards > 1 && flowFiles.isSingleFile\n val isMultipleFiles = flowFiles.isSingleFile.not()\n val isAskingForReport = format != ReportFormat.NOOP\n if (isMultipleFiles || isAskingForReport || isReplicatingSingleFile) {\n if (continuous) {\n throw CommandLine.ParameterException(\n commandSpec.commandLine(),\n \"Continuous mode is not supported when running multiple flows. (${flowFiles.joinToString(\", \")})\",\n )\n }\n runBlocking {\n runMultipleFlows(\n maestro,\n device,\n chunkPlans,\n shardIndex,\n debugOutputPath,\n testOutputDir,\n deviceId,\n )\n }\n } else {\n val flowFile = flowFiles.first()\n if (continuous) {\n if (!flattenDebugOutput) {\n TestDebugReporter.deleteOldFiles()\n }\n TestRunner.runContinuous(\n maestro,\n device,\n flowFile,\n env,\n analyze,\n authToken,\n testOutputDir,\n deviceId,\n )\n } else {\n runSingleFlow(maestro, device, flowFile, debugOutputPath, testOutputDir, deviceId)\n }\n }\n }\n }\n\n private fun selectPort(effectiveShards: Int): Int =\n if (effectiveShards == 1) 7001\n else (7001..7128).shuffled().find { port ->\n usedPorts.putIfAbsent(port, true) == null\n } ?: error(\"No available ports found\")\n\n private fun runSingleFlow(\n maestro: Maestro,\n device: Device?,\n flowFile: File,\n debugOutputPath: Path,\n testOutputDir: Path?,\n deviceId: String?,\n ): Triple {\n val resultView =\n if (DisableAnsiMixin.ansiEnabled) {\n AnsiResultView(useEmojis = !EnvUtils.isWindows())\n } else {\n PlainTextResultView()\n }\n\n val startTime = System.currentTimeMillis()\n Analytics.trackEvent(TestRunStartedEvent(\n platform = device?.platform.toString()\n ))\n\n val resultSingle = TestRunner.runSingle(\n maestro = maestro,\n device = device,\n flowFile = flowFile,\n env = env,\n resultView = resultView,\n debugOutputPath = debugOutputPath,\n analyze = analyze,\n apiKey = authToken,\n testOutputDir = testOutputDir,\n deviceId = deviceId,\n )\n val duration = System.currentTimeMillis() - startTime\n\n if (resultSingle == 1) {\n printExitDebugMessage()\n }\n\n\n Analytics.trackEvent(\n TestRunFinishedEvent(\n status = if (resultSingle == 0) FlowStatus.SUCCESS else FlowStatus.ERROR,\n platform = device?.platform.toString(),\n durationMs = duration\n )\n )\n\n if (!flattenDebugOutput) {\n TestDebugReporter.deleteOldFiles()\n }\n\n val result = if (resultSingle == 0) 1 else 0\n return Triple(result, 1, null)\n }\n\n private suspend fun runMultipleFlows(\n maestro: Maestro,\n device: Device?,\n chunkPlans: List,\n shardIndex: Int,\n debugOutputPath: Path,\n testOutputDir: Path?,\n deviceId: String?,\n ): Triple {\n val startTime = System.currentTimeMillis()\n val totalFlowCount = chunkPlans.sumOf { it.flowsToRun.size }\n Analytics.trackEvent(WorkspaceRunStartedEvent(\n flowCount = totalFlowCount,\n platform = parent?.platform.toString(),\n deviceCount = chunkPlans.size\n ))\n\n val suiteResult = TestSuiteInteractor(\n maestro = maestro,\n device = device,\n shardIndex = if (chunkPlans.size == 1) null else shardIndex,\n reporter = ReporterFactory.buildReporter(format, testSuiteName),\n captureSteps = format == ReportFormat.HTML_DETAILED,\n ).runTestSuite(\n executionPlan = chunkPlans[shardIndex],\n env = env,\n reportOut = null,\n debugOutputPath = debugOutputPath,\n testOutputDir = testOutputDir,\n deviceId = deviceId,\n )\n\n val duration = System.currentTimeMillis() - startTime\n\n\n if (!flattenDebugOutput) {\n TestDebugReporter.deleteOldFiles()\n }\n\n Analytics.trackEvent(\n WorkspaceRunFinishedEvent(\n flowCount = totalFlowCount,\n deviceCount = chunkPlans.size,\n platform = parent?.platform.toString(),\n durationMs = duration\n )\n )\n return Triple(suiteResult.passedCount, suiteResult.totalTests, suiteResult)\n }\n\n private fun makeChunkPlans(\n plan: ExecutionPlan,\n effectiveShards: Int,\n onlySequenceFlows: Boolean,\n ) = when {\n onlySequenceFlows -> listOf(plan) // We only want to run sequential flows in this case.\n shardAll != null -> (0 until effectiveShards).reversed().map { plan.copy() }\n else -> plan.flowsToRun\n .withIndex()\n .groupBy { it.index % effectiveShards }\n .map { (_, files) ->\n val flowsToRun = files.map { it.value }\n ExecutionPlan(flowsToRun, plan.sequence, plan.workspaceConfig)\n }\n }\n\n private fun getPassedOptionsDeviceIds(plan: ExecutionPlan): List {\n val arguments = if (allFlowsAreWebFlow(plan)) {\n \"chromium\"\n } else deviceId ?: parent?.deviceId\n val deviceIds = arguments\n .orEmpty()\n .split(\",\")\n .map { it.trim() }\n .filter { it.isNotBlank() }\n return deviceIds\n }\n\n private fun printExitDebugMessage() {\n println()\n println(\"==== Debug output (logs & screenshots) ====\")\n PrintUtils.message(TestDebugReporter.getDebugOutputPath().absolutePathString())\n }\n\n private fun printShardsMessage(passedTests: Int, totalTests: Int, shardResults: List) {\n val lines = listOf(\"Passed: $passedTests/$totalTests\") +\n shardResults.mapIndexed { _, result ->\n \"[ ${result.suites.first().deviceName} ] - ${result.passedCount ?: 0}/${result.totalTests ?: 0}\"\n }\n PrintUtils.message(lines.joinToString(\"\\n\").box())\n }\n\n private fun TestExecutionSummary.saveReport() {\n val reporter = ReporterFactory.buildReporter(format, testSuiteName)\n\n format.fileExtension?.let { extension ->\n (output ?: File(\"report$extension\")).sink()\n }?.also { sink ->\n reporter.report(this, sink)\n }\n }\n\n private fun List.mergeSummaries(): TestExecutionSummary? = reduceOrNull { acc, summary ->\n TestExecutionSummary(\n passed = acc.passed && summary.passed,\n suites = acc.suites + summary.suites,\n passedCount = sumOf { it.passedCount ?: 0 },\n totalTests = sumOf { it.totalTests ?: 0 }\n )\n }\n\n private fun showCloudFasterResultsPromotionMessageIfNeeded() {\n // Don't show in CI environments\n if (CiUtils.getCiProvider() != null) {\n return\n }\n \n val promotionStateManager = PromotionStateManager()\n val today = LocalDate.now().toString()\n \n // Don't show if already shown today\n if (promotionStateManager.getLastShownDate(\"fasterResults\") == today) {\n return\n }\n \n // Don't show if user has used cloud command within last 3 days\n if (promotionStateManager.wasCloudCommandUsedWithinDays(3)) {\n return\n }\n \n val command = \"maestro cloud app_file flows_folder/\"\n val message = \"Get results faster by ${\"executing flows in parallel\".cyan()} on Maestro Cloud virtual devices. Run: \\n${command.green()}\"\n PrintUtils.info(message.greenBox())\n promotionStateManager.setLastShownDate(\"fasterResults\", today)\n }\n\n private fun showCloudDebugPromotionMessageIfNeeded() {\n // Don't show in CI environments\n if (CiUtils.getCiProvider() != null) {\n return\n }\n \n val promotionStateManager = PromotionStateManager()\n val today = LocalDate.now().toString()\n\n // Don't show if already shown today\n if (promotionStateManager.getLastShownDate(\"debug\") == today) {\n return\n }\n\n // Don't show if user has used cloud command within last 3 days\n if (promotionStateManager.wasCloudCommandUsedWithinDays(3)) {\n return\n }\n \n val command = \"maestro cloud app_file flows_folder/\"\n val message = \"Debug tests faster by easy access to ${\"test recordings, maestro logs, screenshots, and more\".cyan()}.\\n\\nRun your flows on Maestro Cloud:\\n${command.green()}\"\n PrintUtils.info(message.greenBox())\n promotionStateManager.setLastShownDate(\"debug\", today)\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/db/KeyValueStore.kt", "content": "package maestro.cli.db\n\nimport java.io.File\nimport java.util.concurrent.locks.ReentrantReadWriteLock\nimport kotlin.concurrent.read\nimport kotlin.concurrent.write\n\nclass KeyValueStore(private val dbFile: File) {\n private val lock = ReentrantReadWriteLock()\n\n init {\n dbFile.createNewFile()\n }\n\n fun get(key: String): String? = lock.read { getCurrentDB()[key] }\n\n fun set(key: String, value: String) = lock.write {\n val db = getCurrentDB()\n db[key] = value\n commit(db)\n }\n\n fun delete(key: String) = lock.write {\n val db = getCurrentDB()\n db.remove(key)\n commit(db)\n }\n\n fun keys(): List = lock.read { getCurrentDB().keys.toList() }\n\n private fun getCurrentDB(): MutableMap {\n return dbFile\n .readLines()\n .associate { line ->\n val (key, value) = line.split(\"=\", limit = 2)\n key to value\n }\n .toMutableMap()\n }\n\n private fun commit(db: MutableMap) {\n dbFile.writeText(\n db.map { (key, value) -> \"$key=$value\" }\n .joinToString(\"\\n\")\n )\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/device/DeviceCreateUtil.kt", "content": "package maestro.cli.device\n\nimport maestro.device.DeviceService\nimport maestro.device.Device\nimport maestro.device.Platform\nimport maestro.cli.CliError\nimport maestro.cli.util.*\nimport maestro.device.DeviceSpec\n\nobject DeviceCreateUtil {\n\n fun getOrCreateDevice(\n deviceSpec: DeviceSpec,\n forceCreate: Boolean = false,\n shardIndex: Int? = null,\n ): Device.AvailableForLaunch = when (deviceSpec) {\n is DeviceSpec.Android -> getOrCreateAndroidDevice(deviceSpec, forceCreate, shardIndex)\n is DeviceSpec.Ios -> getOrCreateIosDevice(deviceSpec, forceCreate, shardIndex)\n is DeviceSpec.Web -> Device.AvailableForLaunch(\n platform = Platform.WEB,\n description = \"Chromium Desktop Browser (Experimental)\",\n modelId = deviceSpec.model,\n deviceType = Device.DeviceType.BROWSER,\n deviceSpec = deviceSpec,\n )\n }\n\n fun getOrCreateIosDevice(\n deviceSpec: DeviceSpec.Ios, forceCreate: Boolean, shardIndex: Int? = null\n ): Device.AvailableForLaunch {\n // check connected device\n if (DeviceService.isDeviceConnected(deviceSpec.deviceName, Platform.IOS) != null && shardIndex == null && !forceCreate) {\n throw CliError(\"A device with name ${deviceSpec.deviceName} is already connected\")\n }\n\n // check existing device\n val existingDeviceId = DeviceService.isDeviceAvailableToLaunch(deviceSpec.deviceName, Platform.IOS)?.let {\n if (forceCreate) {\n DeviceService.deleteIosDevice(it.modelId)\n null\n } else it.modelId\n }\n\n if (existingDeviceId != null) PrintUtils.message(\"Using existing device ${deviceSpec.deviceName} (${existingDeviceId}).\")\n else PrintUtils.message(\"Attempting to create iOS simulator: ${deviceSpec.deviceName} \")\n\n val deviceUUID = existingDeviceId ?: try {\n // To find the closest matching os: \"iOS-18\" -> \"iOS-18-2\", \"iOS-17\" -> \"iOS-17-5\"\n val closestInstalledRuntime = DeviceService.listIOSDevices().firstOrNull {\n it.deviceSpec.os.startsWith(deviceSpec.os)\n }?.deviceSpec?.os ?: deviceSpec.os\n\n // Start the device\n DeviceService.createIosDevice(deviceSpec.deviceName, deviceSpec.model, closestInstalledRuntime).toString()\n } catch (e: IllegalStateException) {\n val error = e.message ?: \"\"\n if (error.contains(\"Invalid runtime\")) {\n val msg = \"\"\"\n Required runtime to create the simulator is not installed: ${deviceSpec.os}\n\n To install additional iOS runtimes checkout this guide:\n * https://developer.apple.com/documentation/xcode/installing-additional-simulator-runtimes\n \"\"\".trimIndent()\n throw CliError(msg)\n } else if (error.contains(\"xcrun: error: unable to find utility \\\"simctl\\\"\")) {\n val msg = \"\"\"\n The xcode-select CLI tools are not installed, install with xcode-select --install\n\n If the xcode-select CLI tools are already installed, the path may be broken. Try\n running sudo xcode-select -r to repair the path and re-run this command\n \"\"\".trimIndent()\n throw CliError(msg)\n } else if (error.contains(\"Invalid device type\")) {\n throw CliError(\"Device type ${deviceSpec.model} is either not supported or not found.\")\n } else {\n throw CliError(error)\n }\n }\n\n if (existingDeviceId == null) PrintUtils.message(\"Created simulator with name ${deviceSpec.deviceName} and UUID $deviceUUID\")\n\n return Device.AvailableForLaunch(\n modelId = deviceUUID,\n description = deviceSpec.deviceName,\n platform = Platform.IOS,\n deviceType = Device.DeviceType.SIMULATOR,\n deviceSpec = deviceSpec,\n )\n }\n\n fun getOrCreateAndroidDevice(\n deviceSpec: DeviceSpec.Android, forceCreate: Boolean, shardIndex: Int? = null\n ): Device.AvailableForLaunch {\n val systemImage = deviceSpec.emulatorImage\n // check connected device\n if (DeviceService.isDeviceConnected(deviceSpec.deviceName, Platform.ANDROID) != null && shardIndex == null && !forceCreate)\n throw CliError(\"A device with name ${deviceSpec.deviceName} is already connected\")\n\n // existing device\n val existingDevice =\n if (forceCreate) null\n else DeviceService.isDeviceAvailableToLaunch(deviceSpec.deviceName, Platform.ANDROID)?.modelId\n\n // dependencies\n if (existingDevice == null && !DeviceService.isAndroidSystemImageInstalled(systemImage)) {\n PrintUtils.err(\"The required system image $systemImage is not installed.\")\n\n PrintUtils.message(\"Would you like to install it? y/n\")\n val r = readlnOrNull()?.lowercase()\n if (r == \"y\" || r == \"yes\") {\n PrintUtils.message(\"Attempting to install $systemImage via Android SDK Manager...\\n\")\n if (!DeviceService.installAndroidSystemImage(systemImage)) {\n val message = \"\"\"\n Unable to install required dependencies. You can install the system image manually by running this command:\n ${DeviceService.getAndroidSystemImageInstallCommand(systemImage)}\n \"\"\".trimIndent()\n throw CliError(message)\n }\n } else {\n val message = \"\"\"\n To install the system image manually, you can run this command:\n ${DeviceService.getAndroidSystemImageInstallCommand(systemImage)}\n \"\"\".trimIndent()\n throw CliError(message)\n }\n }\n\n if (existingDevice != null) PrintUtils.message(\"Using existing device ${deviceSpec.deviceName}.\")\n else PrintUtils.message(\"Attempting to create Android emulator: ${deviceSpec.deviceName} \")\n\n val deviceLaunchId = try {\n existingDevice ?: DeviceService.createAndroidDevice(\n deviceName = deviceSpec.deviceName,\n device = deviceSpec.model,\n systemImage = systemImage,\n tag = deviceSpec.tag,\n abi = deviceSpec.cpuArchitecture.value,\n force = forceCreate,\n )\n } catch (e: IllegalStateException) {\n throw CliError(\"${e.message}\")\n }\n\n if (existingDevice == null) PrintUtils.message(\"Created Android emulator: ${deviceSpec.deviceName} ($systemImage)\")\n\n return Device.AvailableForLaunch(\n modelId = deviceLaunchId,\n description = deviceLaunchId,\n platform = Platform.ANDROID,\n deviceType = Device.DeviceType.EMULATOR,\n deviceSpec = deviceSpec,\n )\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/device/PickDeviceInteractor.kt", "content": "package maestro.cli.device\n\nimport maestro.cli.CliError\nimport maestro.device.DeviceService\nimport maestro.device.DeviceService.withPlatform\nimport maestro.device.Device\nimport maestro.device.Platform\nimport maestro.cli.util.EnvUtils\nimport maestro.cli.util.PrintUtils\n\nobject PickDeviceInteractor {\n\n fun pickDevice(\n deviceId: String? = null,\n driverHostPort: Int? = null,\n platform: Platform? = null,\n deviceIndex: Int? = null,\n ): Device.Connected {\n if (deviceId != null) {\n return DeviceService.listConnectedDevices()\n .find {\n it.instanceId.equals(deviceId, ignoreCase = true)\n } ?: throw CliError(\"Device with id $deviceId is not connected\")\n }\n\n return pickDeviceInternal(platform, deviceIndex)\n .let { pickedDevice ->\n var result: Device = pickedDevice\n\n if (result is Device.AvailableForLaunch) {\n when (result.deviceSpec.platform) {\n Platform.ANDROID -> PrintUtils.message(\"Launching Android emulator...\")\n Platform.IOS -> PrintUtils.message(\"Launching iOS simulator...\")\n Platform.WEB -> PrintUtils.message(\"Launching ${result.description}\")\n }\n\n result = DeviceService.startDevice(result, driverHostPort)\n }\n\n if (result !is Device.Connected) {\n error(\"Device $result is not connected\")\n }\n\n result\n }\n }\n\n private fun pickDeviceInternal(platform: Platform?, selectedIndex: Int? = null): Device {\n val connectedDevices = DeviceService.listConnectedDevices().withPlatform(platform)\n\n val selected = if(selectedIndex != null) {\n selectedIndex\n } else if (connectedDevices.size == 1) {\n 0\n } else {\n null\n }\n\n if (selected != null) {\n val device = connectedDevices[selected]\n\n PickDeviceView.showRunOnDevice(device)\n\n return device\n }\n\n if (connectedDevices.isEmpty()) {\n return startDevice(platform)\n }\n\n return pickRunningDevice(connectedDevices)\n }\n\n private fun startDevice(platform: Platform?): Device {\n if (EnvUtils.isWSL()) {\n throw CliError(\"No running emulator found. Start an emulator manually and try again.\\nFor setup info checkout: https://maestro.mobile.dev/getting-started/installing-maestro/windows\")\n }\n\n PrintUtils.message(\"No running devices found. Launch a device manually or select a number from the options below:\\n\")\n PrintUtils.message(\"[1] Start or create a Maestro recommended device\\n[2] List existing devices\\n[3] Quit\")\n val input = readlnOrNull()?.lowercase()?.trim()\n\n when(input) {\n \"1\" -> {\n PrintUtils.clearConsole()\n val maestroDeviceConfiguration = PickDeviceView.requestDeviceOptions(platform)\n return DeviceCreateUtil.getOrCreateDevice(maestroDeviceConfiguration, false)\n }\n \"2\" -> {\n PrintUtils.clearConsole()\n val availableDevices = DeviceService.listAvailableForLaunchDevices().withPlatform(platform)\n if (availableDevices.isEmpty()) {\n throw CliError(\"No devices available. To proceed, either install Android SDK or Xcode.\")\n }\n\n return PickDeviceView.pickDeviceToStart(availableDevices)\n }\n else -> {\n throw CliError(\"Please either start a device manually or via running maestro start-device to proceed running your flows\")\n }\n }\n }\n\n private fun pickRunningDevice(devices: List): Device {\n return PickDeviceView.pickRunningDevice(devices)\n }\n\n}\n\nfun main() {\n println(PickDeviceInteractor.pickDevice())\n\n println(\"Ready\")\n while (!Thread.interrupted()) {\n Thread.sleep(1000)\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/device/PickDeviceView.kt", "content": "package maestro.cli.device\n\nimport maestro.cli.CliError\nimport maestro.cli.util.PrintUtils\nimport maestro.device.Device\nimport maestro.device.DeviceSpecRequest\nimport maestro.device.DeviceSpec\nimport maestro.device.Platform\nimport org.fusesource.jansi.Ansi.ansi\n\nobject PickDeviceView {\n\n fun showRunOnDevice(device: Device) {\n println(\"Running on ${device.description}\")\n }\n\n fun pickDeviceToStart(devices: List): Device {\n printIndexedDevices(devices)\n\n println(\"Choose a device to boot and run on.\")\n printEnterNumberPrompt()\n\n return pickIndex(devices)\n }\n\n fun requestDeviceOptions(platform: Platform? = null): DeviceSpec {\n PrintUtils.message(\"Please specify a device platform [android, ios, web]:\")\n val selectedPlatform = platform\n ?: (readlnOrNull()?.lowercase()?.let {\n Platform.fromString(it)\n } ?: throw CliError(\"Please specify a platform\"))\n\n val spec = DeviceSpec.fromRequest(\n when (selectedPlatform) {\n Platform.ANDROID -> DeviceSpecRequest.Android()\n Platform.IOS -> DeviceSpecRequest.Ios()\n Platform.WEB -> DeviceSpecRequest.Web()\n }\n )\n\n return spec\n }\n\n fun pickRunningDevice(devices: List): Device {\n printIndexedDevices(devices)\n\n println(\"Multiple running devices detected. Choose a device to run on.\")\n printEnterNumberPrompt()\n\n return pickIndex(devices)\n }\n\n private fun pickIndex(data: List): T {\n println()\n while (!Thread.interrupted()) {\n val index = readlnOrNull()?.toIntOrNull() ?: 0\n\n if (index < 1 || index > data.size) {\n printEnterNumberPrompt()\n continue\n }\n\n return data[index - 1]\n }\n\n error(\"Interrupted\")\n }\n\n private fun printEnterNumberPrompt() {\n println()\n println(\"Enter a number from the list above:\")\n }\n\n private fun printIndexedDevices(devices: List) {\n val devicesByPlatform = devices.groupBy {\n it.platform\n }\n\n var index = 0\n\n devicesByPlatform.forEach { (platform, devices) ->\n println(platform.description)\n println()\n devices.forEach { device ->\n println(\n ansi()\n .render(\"[\")\n .fgCyan()\n .render(\"${++index}\")\n .fgDefault()\n .render(\"] ${device.description}\")\n )\n }\n println()\n }\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/driver/DriverBuildConfig.kt", "content": "package maestro.cli.driver\n\nimport maestro.cli.api.CliVersion\n\ndata class DriverBuildConfig(\n val teamId: String,\n val derivedDataPath: String,\n val sourceCodePath: String = \"driver/ios\",\n val sourceCodeRoot: String = System.getProperty(\"user.home\"),\n val destination: String = \"generic/platform=iphoneos\",\n val architectures: String = \"arm64\",\n val configuration: String = \"Debug\",\n val cliVersion: CliVersion?\n)" }, { "path": "maestro-cli/src/main/java/maestro/cli/driver/DriverBuilder.kt", "content": "package maestro.cli.driver\n\nimport maestro.MaestroException\nimport java.io.File\nimport java.nio.file.*\nimport java.util.*\nimport java.util.concurrent.TimeUnit\nimport kotlin.io.path.pathString\n\nclass DriverBuilder(private val processBuilderFactory: XcodeBuildProcessBuilderFactory = XcodeBuildProcessBuilderFactory()) {\n private val waitTime: Long by lazy {\n System.getenv(\"MAESTRO_XCODEBUILD_WAIT_TIME\")?.toLongOrNull() ?: DEFAULT_XCODEBUILD_WAIT_TIME\n }\n\n /**\n * Builds the iOS driver for real iOS devices by extracting the driver source, copying it to a temporary build\n * directory, and executing the Xcode build process. The resulting build products are placed in the specified\n * derived data path.\n *\n * @param config A configuration object containing details like team ID, derived data path, destination platform,\n * architectures, and other parameters required for building the driver.\n * @return The path to the directory containing build products.\n * @throws RuntimeException if the build process fails.\n *\n * Directory Structure:\n * 1. workingDirectory (Path): Root working directory for Maestro stored in the user's home directory.\n * .maestro\n * |_ maestro-iphoneos-driver-build\n * |_ driver-iphoneos: Consists the build products to setup iOS driver: maestro-driver-*.xctestrun,\n * Debug-iphoneos/maestro-driver-iosUITests-Runner.app, and Debug-iphoneos/maestro-driver-ios.app\n * |_ output.log: In case of errors output.log would be there to help debug\n *\n * 2. xcodebuildOutput (Path): A temporary directory created to store the output logs of the xcodebuild process and source code.\n * It exists only for the duration of the build operation.\n * e.g., $TMPDIR/maestro-xcodebuild-outputXXXXXX\n */\n fun buildDriver(config: DriverBuildConfig): Path {\n // Get driver source from resources\n val driverSourcePath = getDriverSourceFromResources(config)\n\n // Create temporary build directory\n val workingDirectory = Paths.get(config.sourceCodeRoot, \".maestro\")\n val buildDir = Files.createDirectories(workingDirectory.resolve(\"maestro-iphoneos-driver-build\")).apply {\n // Cleanup directory before we execute the build\n toFile().deleteRecursively()\n }\n val xcodebuildOutput = Files.createTempDirectory(\"maestro-xcodebuild-output\")\n val outputFile = File(xcodebuildOutput.pathString + \"/output.log\")\n\n try {\n // Copy driver source to build directory\n Files.walk(driverSourcePath).use { paths ->\n paths.filter { Files.isRegularFile(it) }.forEach { path ->\n val targetPath = xcodebuildOutput.resolve(driverSourcePath.relativize(path).toString())\n Files.createDirectories(targetPath.parent)\n Files.copy(path, targetPath, StandardCopyOption.REPLACE_EXISTING)\n }\n }\n\n // Create derived data path\n val derivedDataPath = buildDir.resolve(config.derivedDataPath)\n Files.createDirectories(derivedDataPath)\n\n // Build command\n val process = processBuilderFactory.createProcess(\n commands = listOf(\n \"xcodebuild\",\n \"clean\",\n \"build-for-testing\",\n \"-project\", \"${xcodebuildOutput.pathString}/maestro-driver-ios.xcodeproj\",\n \"-scheme\", \"maestro-driver-ios\",\n \"-destination\", config.destination,\n \"-allowProvisioningUpdates\",\n \"-derivedDataPath\", derivedDataPath.toString(),\n \"DEVELOPMENT_TEAM=${config.teamId}\",\n \"ARCHS=${config.architectures}\",\n \"CODE_SIGN_IDENTITY=Apple Development\",\n ), workingDirectory = workingDirectory.toFile(), outputFile = outputFile\n )\n\n process.waitFor(waitTime, TimeUnit.SECONDS)\n\n if (process.exitValue() != 0) {\n // copy the error log inside driver output\n val targetErrorFile = File(buildDir.toFile(), outputFile.name)\n outputFile.copyTo(targetErrorFile, overwrite = true)\n throw MaestroException.IOSDeviceDriverSetupException(\n \"\"\"\n \n Failed to build iOS driver for connected iOS device.\n \n Error details:\n - Build log: ${targetErrorFile.path}\n \"\"\".trimIndent()\n )\n }\n\n // Return path to build products\n return derivedDataPath.resolve(\"Build/Products\")\n } finally {\n File(buildDir.toFile(), \"version.properties\").writer().use {\n val p = Properties()\n p[\"version\"] = config.cliVersion.toString()\n p.store(it, null)\n }\n xcodebuildOutput.toFile().deleteRecursively()\n }\n }\n\n fun getDriverSourceFromResources(config: DriverBuildConfig): Path {\n val resourcePath = config.sourceCodePath\n val resourceUrl = DriverBuilder::class.java.classLoader.getResource(resourcePath)\n ?: throw IllegalArgumentException(\"Resource not found: $resourcePath\")\n val uri = resourceUrl.toURI()\n\n val path = if (uri.scheme == \"jar\") {\n val fs = try {\n FileSystems.getFileSystem(uri)\n } catch (e: FileSystemNotFoundException) {\n FileSystems.newFileSystem(uri, emptyMap())\n }\n fs.getPath(\"/$resourcePath\")\n } else {\n Paths.get(uri)\n }\n return path\n }\n\n companion object {\n private const val DEFAULT_XCODEBUILD_WAIT_TIME: Long = 120\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/driver/RealIOSDeviceDriver.kt", "content": "package maestro.cli.driver\n\nimport maestro.MaestroException\nimport maestro.cli.api.CliVersion\nimport maestro.cli.util.EnvUtils\nimport maestro.cli.util.PrintUtils.message\nimport java.nio.file.Files\nimport java.nio.file.Path\nimport java.nio.file.Paths\nimport java.util.Properties\n\nclass RealIOSDeviceDriver(private val teamId: String?, private val destination: String, private val driverBuilder: DriverBuilder) {\n\n fun validateAndUpdateDriver(driverRootDirectory: Path = getDefaultVersionPropertiesFile(), force: Boolean = false) {\n val driverDirectory = driverRootDirectory.resolve(\"maestro-iphoneos-driver-build\")\n val versionPropertiesFile = driverDirectory.resolve(\"version.properties\")\n\n val currentCliVersion = EnvUtils.CLI_VERSION ?: throw IllegalStateException(\"CLI version is unavailable.\")\n\n if (force) {\n buildDriver(driverDirectory, message = \"Building iOS driver for $destination...\")\n return\n }\n\n if (Files.exists(versionPropertiesFile)) {\n val properties = Properties().apply {\n Files.newBufferedReader(versionPropertiesFile).use(this::load)\n }\n val localVersion = properties.getProperty(\"version\")?.let { CliVersion.parse(it) }\n ?: throw IllegalStateException(\"Invalid or missing version in version.properties.\")\n\n val products = driverDirectory.resolve(\"driver-iphoneos\").resolve(\"Build\").resolve(\"Products\")\n val xctestRun = products.toFile().walk().find { it.extension == \"xctestrun\" }\n if (currentCliVersion > localVersion) {\n message(\"Local version $localVersion of iOS driver is outdated. Updating to latest.\")\n buildDriver(driverDirectory, message = \"Validating and updating iOS driver for real iOS device: $destination...\")\n } else if (xctestRun?.exists() == false || xctestRun == null) {\n message(\"Drivers for $destination not found, building the drivers.\")\n buildDriver(driverDirectory, message = \"Building the drivers for $destination\")\n }\n } else {\n buildDriver(driverDirectory, \"Building iOS driver for $destination...\")\n }\n }\n\n private fun buildDriver(driverDirectory: Path, message: String) {\n val spinner = Spinner(message).apply {\n start()\n }\n // Build the new driver\n val teamId = try {\n requireNotNull(teamId) { \"Apple account team ID must be specified.\" }\n } catch (e: IllegalArgumentException) {\n throw MaestroException.MissingAppleTeamId(\n \"Apple account team ID must be specified to build drivers for connected iPhone.\"\n )\n }\n\n // Cleanup old driver files if necessary\n if (Files.exists(driverDirectory)) {\n message(\"Cleaning up old driver files...\")\n driverDirectory.toFile().deleteRecursively()\n }\n\n driverBuilder.buildDriver(\n DriverBuildConfig(\n teamId = teamId,\n derivedDataPath = \"driver-iphoneos\",\n destination = destination,\n sourceCodePath = \"driver/ios\",\n cliVersion = EnvUtils.CLI_VERSION\n )\n )\n\n spinner.stop()\n message(\"โœ… Drivers successfully set up for destination $destination\")\n }\n\n private fun getDefaultVersionPropertiesFile(): Path {\n val maestroDirectory = Paths.get(System.getProperty(\"user.home\"), \".maestro\")\n return maestroDirectory\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/driver/Spinner.kt", "content": "package maestro.cli.driver\n\nclass Spinner(private val message: String = \"Processing\") {\n private val frames = listOf(\"โ ‹\", \"โ ™\", \"โ น\", \"โ ธ\", \"โ ผ\", \"โ ด\", \"โ ฆ\", \"โ ง\", \"โ ‡\", \"โ \")\n private var active = true\n private lateinit var thread: Thread\n\n fun start() {\n thread = Thread {\n var i = 0\n while (active) {\n print(\"\\r${frames[i % frames.size]} $message\")\n Thread.sleep(100)\n i++\n }\n }\n thread.start()\n }\n\n fun stop() {\n active = false\n thread.join()\n print(\"\\rโœ… $message\\n\")\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/driver/XcodeBuildProcessBuilderFactory.kt", "content": "package maestro.cli.driver\n\nimport java.io.File\n\nclass XcodeBuildProcessBuilderFactory {\n\n fun createProcess(commands: List, workingDirectory: File, outputFile: File): Process {\n return ProcessBuilder(commands).directory(workingDirectory).redirectOutput(outputFile)\n .redirectError(outputFile)\n .start()\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/graphics/AWTUtils.kt", "content": "package maestro.cli.graphics\n\nimport org.jcodec.api.FrameGrab\nimport org.jcodec.api.awt.AWTSequenceEncoder\nimport org.jcodec.common.io.NIOUtils\nimport java.awt.Graphics2D\nimport java.io.File\n\nfun Graphics2D.use(block: (g: Graphics2D) -> Unit) {\n try {\n block(this)\n } finally {\n dispose()\n }\n}\n\nfun AWTSequenceEncoder.use(block: (encoder: AWTSequenceEncoder) -> Unit) {\n try {\n block(this)\n } finally {\n finish()\n }\n}\n\nfun useFrameGrab(file: File, block: (grab: FrameGrab) -> Unit) {\n NIOUtils.readableChannel(file).use { channelIn ->\n val grab = FrameGrab.createFrameGrab(channelIn)\n block(grab)\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/graphics/LocalVideoRenderer.kt", "content": "package maestro.cli.graphics\n\nimport maestro.cli.runner.resultview.AnsiResultView\nimport maestro.cli.view.ProgressBar\nimport maestro.cli.view.render\nimport okio.ByteString.Companion.decodeBase64\nimport org.jcodec.api.PictureWithMetadata\nimport org.jcodec.api.awt.AWTSequenceEncoder\nimport org.jcodec.common.io.NIOUtils\nimport org.jcodec.common.model.Rational\nimport org.jcodec.scale.AWTUtil\nimport java.awt.image.BufferedImage\nimport java.io.File\n\ninterface FrameRenderer {\n fun render(\n outputWidthPx: Int,\n outputHeightPx: Int,\n screen: BufferedImage,\n text: String,\n ): BufferedImage\n}\n\nclass LocalVideoRenderer(\n private val frameRenderer: FrameRenderer,\n private val outputFile: File,\n private val outputFPS: Int,\n private val outputWidthPx: Int,\n private val outputHeightPx: Int,\n) : VideoRenderer {\n\n override fun render(\n screenRecording: File,\n textFrames: List,\n ) {\n System.err.println()\n System.err.println(\"@|bold Rendering video - This may take some time...|@\".render())\n System.err.println()\n System.err.println(outputFile.absolutePath)\n\n val uploadProgress = ProgressBar(50)\n NIOUtils.writableFileChannel(outputFile.absolutePath).use { out ->\n AWTSequenceEncoder(out, Rational.R(outputFPS, 1)).use { encoder ->\n useFrameGrab(screenRecording) { grab ->\n val outputDurationSeconds = grab.videoTrack.meta.totalDuration\n val outputFrameCount = (outputDurationSeconds * outputFPS).toInt()\n var curFrame: PictureWithMetadata = grab.nativeFrameWithMetadata!!\n var nextFrame: PictureWithMetadata? = grab.nativeFrameWithMetadata\n (0..outputFrameCount).forEach { frameIndex ->\n val currentTimestampSeconds = frameIndex.toDouble() / outputFPS\n\n // !! Due to smart cast limitation: https://youtrack.jetbrains.com/issue/KT-7186\n @Suppress(\"UNNECESSARY_NOT_NULL_ASSERTION\")\n while (nextFrame != null && nextFrame!!.timestamp <= currentTimestampSeconds) {\n curFrame = nextFrame!!\n nextFrame = grab.nativeFrameWithMetadata\n }\n\n val curImage = AWTUtil.toBufferedImage(curFrame.picture)\n val curTextFrame = textFrames.lastOrNull { frame -> frame.timestamp.div(1000.0) <= currentTimestampSeconds } ?: textFrames.first()\n val curText = curTextFrame.content.decodeBase64()!!.string(Charsets.UTF_8).stripAnsiCodes()\n val outputImage = frameRenderer.render(outputWidthPx, outputHeightPx, curImage, curText)\n encoder.encodeImage(outputImage)\n\n uploadProgress.set(frameIndex / outputFrameCount.toFloat())\n }\n }\n }\n }\n System.err.println()\n System.err.println()\n System.err.println(\"Rendering complete! If you're sharing on Twitter be sure to tag us \\uD83D\\uDE04 @|bold @mobile__dev|@\".render())\n }\n\n private fun String.stripAnsiCodes(): String {\n return replace(\"\\\\u001B\\\\[[;\\\\d]*[mH]\".toRegex(), \"\")\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/graphics/RemoteVideoRenderer.kt", "content": "package maestro.cli.graphics\n\nimport maestro.cli.api.ApiClient\nimport maestro.cli.runner.resultview.AnsiResultView\nimport maestro.cli.view.ProgressBar\nimport maestro.cli.view.render\nimport java.io.File\n\nclass RemoteVideoRenderer : VideoRenderer {\n\n override fun render(\n screenRecording: File,\n textFrames: List\n ) {\n val client = ApiClient(\"\")\n\n System.err.println()\n System.err.println(\"@|bold โš \\uFE0F DEPRECATION NOTICE โš \\uFE0F\\nThis method of recording will soon be deprecated and replaced with a local rendering implementation.\\nTo switch to (Beta) local rendering, use \\\"maestro record --local ...\\\". This will become the default behavior in a future Maestro release.|@\".render())\n System.err.println()\n\n val uploadProgress = ProgressBar(50)\n System.err.println(\"Uploading raw files for render...\")\n val id = client.render(screenRecording, textFrames) { totalBytes, bytesWritten ->\n uploadProgress.set(bytesWritten.toFloat() / totalBytes)\n }\n System.err.println()\n\n var renderProgress: ProgressBar? = null\n var status: String? = null\n var positionInQueue: Int? = null\n while (true) {\n val state = client.getRenderState(id)\n\n // If new position or status, print header\n if (state.status != status || state.positionInQueue != positionInQueue) {\n status = state.status\n positionInQueue = state.positionInQueue\n\n if (renderProgress != null) {\n renderProgress.set(1f)\n System.err.println()\n }\n\n System.err.println()\n\n System.err.println(\"Status : ${styledStatus(state.status)}\")\n if (state.positionInQueue != null) {\n System.err.println(\"Position In Queue : ${state.positionInQueue}\")\n }\n }\n\n // Add ticks to progress bar\n if (state.currentTaskProgress != null) {\n if (renderProgress == null) renderProgress = ProgressBar(50)\n renderProgress.set(state.currentTaskProgress)\n }\n\n // Print download url or error and return\n if (state.downloadUrl != null || state.error != null) {\n System.err.println()\n if (state.downloadUrl != null) {\n System.err.println(\"@|bold Signed Download URL:|@\".render())\n System.err.println()\n print(\"@|cyan,bold ${state.downloadUrl}|@\".render())\n System.err.println()\n System.err.println()\n System.err.println(\"Open the link above to download your video. If you're sharing on Twitter be sure to tag us @|bold @mobile__dev|@!\".render())\n } else {\n System.err.println(\"@|bold Render encountered during rendering:|@\".render())\n System.err.println(state.error)\n }\n break\n }\n\n Thread.sleep(2000)\n }\n }\n\n private fun styledStatus(status: String): String {\n val style = when (status) {\n \"PENDING\" -> \"yellow,bold\"\n \"RENDERING\" -> \"blue,bold\"\n \"SUCCESS\" -> \"green,bold\"\n else -> \"bold\"\n }\n return \"@|$style $status|@\".render()\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/graphics/SkiaFrameRenderer.kt", "content": "package maestro.cli.graphics\n\nimport org.jetbrains.skia.Canvas\nimport org.jetbrains.skia.Color\nimport org.jetbrains.skia.Font\nimport org.jetbrains.skia.Paint\nimport org.jetbrains.skia.Rect\nimport org.jetbrains.skia.Surface\nimport org.jetbrains.skiko.toImage\nimport java.awt.image.BufferedImage\nimport javax.imageio.ImageIO\n\nclass SkiaFrameRenderer : FrameRenderer {\n\n private val backgroundImage = ImageIO.read(SkiaFrameRenderer::class.java.getResource(\"/record-background.jpg\")!!).toImage()\n\n private val shadowColor = Color.makeARGB(100, 0, 0, 0)\n\n private val scenePadding = 40f\n private val sceneGap = 40f\n\n private val headerBgColor = Color.makeARGB(50, 255, 255, 255)\n private val headerHeight = 60f\n private val headerFont = Font(SkiaFonts.SANS_SERIF_TYPEFACE, 22f)\n private val headerTextColor = Color.makeARGB(200, 0, 0, 0)\n private val headerText = \"Record your own using ${'$'} maestro record YourFlow.yaml\"\n\n private val headerButtonColor = Color.makeARGB(50, 255, 255, 255)\n private val headerButtonSize = 20f\n private val headerButtonGap = 10f\n private val headerButtonMx = 20f\n\n private val footerBgColor = Color.makeARGB(50, 255, 255, 255)\n private val footerHeight = 60f\n private val footerFont = Font(SkiaFonts.SANS_SERIF_TYPEFACE, 22f)\n private val footerTextColor = Color.makeARGB(200, 0, 0, 0)\n private val footerText = \"maestro.mobile.dev\"\n\n private val terminalBgColor = Color.makeARGB(220, 0, 0, 0)\n private val terminalContentPadding = 40f\n\n private val textClipper = SkiaTextClipper()\n\n override fun render(\n outputWidthPx: Int,\n outputHeightPx: Int,\n screen: BufferedImage,\n text: String\n ): BufferedImage {\n return Surface.makeRasterN32Premul(outputWidthPx, outputHeightPx).use { surface ->\n drawScene(surface.canvas, outputWidthPx.toFloat(), outputHeightPx.toFloat(), screen, text)\n surface.makeImageSnapshot().toBufferedImage()\n }\n }\n\n private fun drawScene(canvas: Canvas, outputWidthPx: Float, outputHeightPx: Float, screen: BufferedImage, text: String) {\n val fullScreenRect = Rect(0f, 0f, outputWidthPx, outputHeightPx)\n canvas.drawImageRect(backgroundImage, fullScreenRect)\n\n val paddedScreenRect = fullScreenRect.inflate(-scenePadding)\n\n drawContent(canvas, paddedScreenRect, screen, text)\n }\n\n private fun drawContent(canvas: Canvas, containerRect: Rect, screen: BufferedImage, text: String) {\n val imageRect = drawDevice(canvas, containerRect, screen)\n drawTerminal(canvas, containerRect, imageRect, text)\n }\n\n private fun drawDevice(canvas: Canvas, containerRect: Rect, screen: BufferedImage): Rect {\n val cornerRadius = 20f\n val deviceImageScale = containerRect.height / screen.height.toFloat()\n var deviceImageRect = Rect(0f, 0f, screen.width.toFloat(), screen.height.toFloat()).scale(deviceImageScale)\n deviceImageRect = deviceImageRect.offset(containerRect.right - deviceImageRect.right, containerRect.top)\n val deviceImageRectRounded = deviceImageRect.toRRect(cornerRadius)\n canvas.save()\n canvas.clipRRect(deviceImageRectRounded, true)\n canvas.drawImageRect(screen.toImage(), deviceImageRect)\n canvas.restore()\n canvas.drawRectShadow(deviceImageRectRounded, 0f, 0f, 20f, 0.5f, shadowColor)\n return deviceImageRect\n }\n\n private fun drawTerminal(canvas: Canvas, containerRect: Rect, imageRect: Rect, text: String) {\n val terminalRect = Rect(containerRect.left, containerRect.top, imageRect.left - sceneGap, containerRect.bottom)\n val terminalRectRounded = terminalRect.toRRect(20f)\n canvas.drawRectShadow(terminalRectRounded, 0f, 0f, 20f, 0.5f, shadowColor)\n\n val headerRect = drawHeader(canvas, terminalRect)\n val footerRect = drawFooter(canvas, terminalRect)\n drawTerminalContent(canvas, terminalRect, headerRect, footerRect, text)\n }\n\n private fun drawFooter(canvas: Canvas, terminalRect: Rect): Rect {\n val footerRect = Rect.makeXYWH(terminalRect.left, terminalRect.bottom - footerHeight, terminalRect.width, footerHeight)\n val headerRectRounded = footerRect.toRRect(0f, 0f, 20f, 20f)\n canvas.drawRRect(headerRectRounded, Paint().apply { color = footerBgColor })\n\n drawFooterText(canvas, footerRect)\n\n return footerRect\n }\n\n private fun drawFooterText(canvas: Canvas, footerRect: Rect) {\n val paint = Paint().apply {\n color = footerTextColor\n }\n val textRect = footerFont.measureText(footerText, paint)\n val x = footerRect.left + (footerRect.width - textRect.width) / 2\n val y = footerRect.top + footerRect.height / 2 + textRect.height / 3\n canvas.drawString(footerText, x, y, footerFont, paint)\n }\n\n private fun drawHeader(canvas: Canvas, terminalRect: Rect): Rect {\n val headerRect = Rect.makeXYWH(terminalRect.left, terminalRect.top, terminalRect.width, headerHeight)\n val headerRectRounded = headerRect.toRRect(20f, 20f, 0f, 0f)\n canvas.drawRRect(headerRectRounded, Paint().apply { color = headerBgColor })\n\n drawHeaderButtons(canvas, headerRect)\n drawHeaderText(canvas, headerRect)\n\n return headerRect\n }\n\n private fun drawHeaderButtons(canvas: Canvas, headerRect: Rect) {\n var centerX = headerRect.left + headerButtonMx + headerButtonSize / 2\n val centerY = headerRect.top + headerRect.height / 2\n\n repeat(3) {\n canvas.drawCircle(centerX, centerY, headerButtonSize / 2, Paint().apply { color = headerButtonColor })\n centerX += headerButtonSize + headerButtonGap\n }\n }\n\n private fun drawHeaderText(canvas: Canvas, headerRect: Rect) {\n val paint = Paint().apply {\n color = headerTextColor\n }\n val textRect = headerFont.measureText(headerText, paint)\n val x = headerRect.left + (headerRect.width - textRect.width) / 2\n val y = headerRect.top + headerRect.height / 2 + textRect.height / 3\n canvas.drawString(headerText, x, y, headerFont, paint)\n }\n\n private fun drawTerminalContent(canvas: Canvas, terminalRect: Rect, headerRect: Rect, footerRect: Rect, string: String) {\n val contentRect = Rect.makeLTRB(terminalRect.left, headerRect.bottom, terminalRect.right, footerRect.top)\n canvas.drawRect(contentRect, Paint().apply { color = terminalBgColor })\n\n val paddedContentRect = Rect.makeLTRB(\n l = contentRect.left + terminalContentPadding,\n t = contentRect.top + terminalContentPadding,\n r = contentRect.right - terminalContentPadding,\n b = contentRect.bottom - terminalContentPadding / 4f,\n )\n\n val focusedLineIndex = getFocusedLineIndex(string)\n val focusedLinePadding = 5\n textClipper.renderClippedText(canvas, paddedContentRect, string, focusedLineIndex + focusedLinePadding)\n }\n\n private fun getFocusedLineIndex(text: String): Int {\n val lines = text.lines()\n val indexOfFirstPendingLine = lines.indexOfFirst { it.contains(\"\\uD83D\\uDD32\") }\n if (indexOfFirstPendingLine != -1) return indexOfFirstPendingLine\n val indexOfLastCheck = lines.indexOfLast { it.contains(\"โœ…\") }\n if (indexOfLastCheck != -1) return indexOfLastCheck\n return 0\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/graphics/SkiaTextClipper.kt", "content": "package maestro.cli.graphics\n\nimport org.jetbrains.skia.Canvas\nimport org.jetbrains.skia.Color\nimport org.jetbrains.skia.FontMgr\nimport org.jetbrains.skia.Rect\nimport org.jetbrains.skia.paragraph.FontCollection\nimport org.jetbrains.skia.paragraph.Paragraph\nimport org.jetbrains.skia.paragraph.ParagraphBuilder\nimport org.jetbrains.skia.paragraph.ParagraphStyle\nimport org.jetbrains.skia.paragraph.RectHeightMode\nimport org.jetbrains.skia.paragraph.RectWidthMode\nimport org.jetbrains.skia.paragraph.TextStyle\nimport kotlin.math.min\n\nclass SkiaTextClipper {\n\n private val terminalTextStyle = TextStyle().apply {\n fontFamilies = SkiaFonts.MONOSPACE_FONT_FAMILIES.toTypedArray()\n fontSize = 24f\n color = Color.WHITE\n }\n\n fun renderClippedText(canvas: Canvas, rect: Rect, text: String, focusedLine: Int) {\n val p = createParagraph(text, rect.width)\n val focusedLineRange = getRangeForLine(text, focusedLine)\n val focusedLineBottom = p.getRectsForRange(\n start = focusedLineRange.first,\n end = focusedLineRange.second,\n rectHeightMode = RectHeightMode.MAX,\n rectWidthMode = RectWidthMode.MAX\n ).maxOf { it.rect.bottom }\n val offsetY = min(0f, rect.height - focusedLineBottom)\n canvas.save()\n canvas.clipRect(rect)\n p.paint(canvas, rect.left, rect.top + offsetY)\n canvas.restore()\n }\n\n private fun getRangeForLine(text: String, lineIndex: Int): Pair {\n var start = 0\n var end = 0\n var currentLine = 0\n while (currentLine <= lineIndex) {\n start = end\n end = text.indexOf('\\n', start + 1)\n if (end == -1) {\n end = text.length\n break\n }\n currentLine++\n }\n return Pair(start, end)\n }\n\n private fun createParagraph(text: String, width: Float): Paragraph {\n val fontCollection = FontCollection().setDefaultFontManager(FontMgr.default)\n return ParagraphBuilder(ParagraphStyle(), fontCollection)\n .pushStyle(terminalTextStyle)\n .addText(text)\n .build()\n .apply { layout(width) }\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/graphics/SkiaUtils.kt", "content": "package maestro.cli.graphics\n\nimport org.jetbrains.skia.Bitmap\nimport org.jetbrains.skia.Canvas\nimport org.jetbrains.skia.ColorAlphaType\nimport org.jetbrains.skia.FontMgr\nimport org.jetbrains.skia.FontStyle\nimport org.jetbrains.skia.Image\nimport org.jetbrains.skia.ImageInfo\nimport org.jetbrains.skia.RRect\nimport org.jetbrains.skia.Rect\nimport org.jetbrains.skia.Typeface\nimport java.awt.Transparency\nimport java.awt.color.ColorSpace\nimport java.awt.image.BufferedImage\nimport java.awt.image.ComponentColorModel\nimport java.awt.image.DataBuffer\nimport java.awt.image.DataBufferByte\nimport java.awt.image.Raster\n\nobject SkiaFonts {\n\n val SANS_SERIF_FONT_FAMILIES = listOf(\"Inter\", \"Roboto\", \"Arial\", \"Avenir Next\", \"Avenir\", \"Helvetica Neue\", \"Helvetica\", \"Arial Nova\", \"Arimo\", \"Noto Sans\", \"Liberation Sans\", \"DejaVu Sans\", \"Nimbus Sans\", \"Clear Sans\", \"Lato\", \"Cantarell\", \"Arimo\", \"Ubuntu\")\n val MONOSPACE_FONT_FAMILIES = listOf(\"Cascadia Code\", \"Source Code Pro\", \"Menlo\", \"Consolas\", \"Monaco\", \"Liberation Mono\", \"Ubuntu Mono\", \"Roboto Mono\", \"Lucida Console\", \"Monaco\", \"Courier New\", \"Courier\")\n\n val SANS_SERIF_TYPEFACE: Typeface\n val MONOSPACE_TYPEFACE: Typeface\n\n init {\n val sansSerifTypeface = FontMgr.default.matchFamiliesStyle(SANS_SERIF_FONT_FAMILIES.toTypedArray(), FontStyle.NORMAL)\n if (sansSerifTypeface == null) {\n System.err.println(\"Failed to find a sans-serif typeface.\")\n }\n SANS_SERIF_TYPEFACE = sansSerifTypeface ?: Typeface.makeEmpty()\n\n val monospaceTypeface = FontMgr.default.matchFamiliesStyle(MONOSPACE_FONT_FAMILIES.toTypedArray(), FontStyle.NORMAL)\n if (monospaceTypeface == null) {\n System.err.println(\"Failed to find a monospace typeface.\")\n }\n MONOSPACE_TYPEFACE = monospaceTypeface ?: Typeface.makeEmpty()\n }\n}\n\n// https://stackoverflow.com/a/70852824\nfun Image.toBufferedImage(): BufferedImage {\n val storage = Bitmap()\n storage.allocPixelsFlags(ImageInfo.makeS32(this.width, this.height, ColorAlphaType.PREMUL), false)\n Canvas(storage).drawImage(this, 0f, 0f)\n\n val bytes = storage.readPixels(storage.imageInfo, (this.width * 4), 0, 0)!!\n val buffer = DataBufferByte(bytes, bytes.size)\n val raster = Raster.createInterleavedRaster(\n buffer,\n this.width,\n this.height,\n this.width * 4, 4,\n intArrayOf(2, 1, 0, 3), // BGRA order\n null\n )\n val colorModel = ComponentColorModel(\n ColorSpace.getInstance(ColorSpace.CS_sRGB),\n true,\n false,\n Transparency.TRANSLUCENT,\n DataBuffer.TYPE_BYTE\n )\n\n return BufferedImage(colorModel, raster!!, false, null)\n}\n\nfun Rect.toRRect(radii: Float): RRect {\n return RRect.makeLTRB(this.left, this.top, this.right, this.bottom, radii)\n}\n\nfun Rect.toRRect(tlRad: Float, trRad: Float, brRad: Float, blRad: Float): RRect {\n return RRect.makeLTRB(this.left, this.top, this.right, this.bottom, tlRad, trRad, brRad, blRad)\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/graphics/VideoRenderer.kt", "content": "package maestro.cli.graphics\n\nimport maestro.cli.runner.resultview.AnsiResultView\nimport java.io.File\n\ninterface VideoRenderer {\n fun render(\n screenRecording: File,\n textFrames: List,\n )\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/insights/TestAnalysisManager.kt", "content": "package maestro.cli.insights\n\nimport com.fasterxml.jackson.annotation.JsonIgnoreProperties\nimport com.fasterxml.jackson.databind.SerializationFeature\nimport com.fasterxml.jackson.datatype.jsr310.JavaTimeModule\nimport com.fasterxml.jackson.module.kotlin.jacksonObjectMapper\nimport com.fasterxml.jackson.module.kotlin.readValue\nimport com.github.romankh3.image.comparison.ImageComparisonUtil\nimport maestro.cli.api.ApiClient\nimport maestro.cli.cloud.CloudInteractor\nimport maestro.cli.util.CiUtils\nimport maestro.cli.util.EnvUtils\nimport maestro.cli.util.PrintUtils\nimport maestro.cli.view.box\nimport java.nio.file.Files\nimport java.nio.file.Path\nimport java.util.stream.Collectors\nimport kotlin.io.path.createDirectories\nimport kotlin.io.path.exists\nimport kotlin.io.path.readText\nimport kotlin.io.path.writeText\n\ndata class AnalysisScreenshot (\n val data: ByteArray,\n val path: Path,\n)\n\ndata class AnalysisLog (\n val data: ByteArray,\n val path: Path,\n)\n\ndata class AnalysisDebugFiles(\n val screenshots: List,\n val logs: List,\n val commands: List,\n)\n\nclass TestAnalysisManager(private val apiUrl: String, private val apiKey: String?) {\n private val apiClient by lazy {\n ApiClient(apiUrl)\n }\n\n fun runAnalysis(debugOutputPath: Path): Int {\n val debugFiles = processDebugFiles(debugOutputPath)\n if (debugFiles == null) {\n PrintUtils.warn(\"No screenshots or debug artifacts found for analysis.\")\n return 0;\n }\n\n return CloudInteractor(\n client = apiClient,\n appFileValidator = { null },\n workspaceValidator = maestro.orchestra.validation.WorkspaceValidator(),\n ).analyze(\n apiKey = apiKey,\n debugFiles = debugFiles,\n debugOutputPath = debugOutputPath\n )\n }\n\n private fun processDebugFiles(outputPath: Path): AnalysisDebugFiles? {\n val files = Files.walk(outputPath)\n .filter(Files::isRegularFile)\n .collect(Collectors.toList())\n\n if (files.isEmpty()) {\n return null\n }\n\n return getDebugFiles(files)\n }\n\n private fun getDebugFiles(files: List): AnalysisDebugFiles {\n val logs = mutableListOf()\n val commands = mutableListOf()\n val screenshots = mutableListOf()\n\n files.forEach { path ->\n val data = Files.readAllBytes(path)\n val fileName = path.fileName.toString().lowercase()\n\n when {\n fileName.endsWith(\".png\") || fileName.endsWith(\".jpg\") || fileName.endsWith(\".jpeg\") -> {\n screenshots.add(AnalysisScreenshot(data = data, path = path))\n }\n\n fileName.startsWith(\"commands\") -> {\n commands.add(AnalysisLog(data = data, path = path))\n }\n\n fileName == \"maestro.log\" -> {\n logs.add(AnalysisLog(data = data, path = path))\n }\n }\n }\n\n val filteredScreenshots = filterSimilarScreenshots(screenshots)\n\n return AnalysisDebugFiles(\n logs = logs,\n commands = commands,\n screenshots = filteredScreenshots,\n )\n }\n\n private val screenshotsDifferenceThreshold = 5.0\n\n private fun filterSimilarScreenshots(\n screenshots: List\n ): List {\n val uniqueScreenshots = mutableListOf()\n\n for (screenshot in screenshots) {\n val isSimilar = uniqueScreenshots.any { existingScreenshot ->\n val diffPercent = ImageComparisonUtil.getDifferencePercent(\n ImageComparisonUtil.readImageFromResources(existingScreenshot.path.toString()),\n ImageComparisonUtil.readImageFromResources(screenshot.path.toString())\n )\n diffPercent <= screenshotsDifferenceThreshold\n }\n\n if (!isSimilar) {\n uniqueScreenshots.add(screenshot)\n }\n }\n\n return uniqueScreenshots\n }\n\n /**\n * The Notification system for Test Analysis.\n * - Uses configuration from $XDG_CONFIG_HOME/maestro/analyze-notification.json.\n */\n companion object AnalysisNotification {\n private const val MAESTRO_CLI_ANALYSIS_NOTIFICATION_DISABLED = \"MAESTRO_CLI_ANALYSIS_NOTIFICATION_DISABLED\"\n private val disabled: Boolean\n get() = System.getenv(MAESTRO_CLI_ANALYSIS_NOTIFICATION_DISABLED) == \"true\"\n\n private val notificationStatePath: Path = EnvUtils.xdgStateHome().resolve(\"analyze-notification.json\")\n\n private val JSON = jacksonObjectMapper().apply {\n registerModule(JavaTimeModule())\n enable(SerializationFeature.INDENT_OUTPUT)\n }\n private val shouldNotNotify: Boolean\n get() {\n if (CiUtils.getCiProvider() != null) {\n return true\n }\n\n return disabled || (notificationStatePath.exists() && notificationState.acknowledged)\n }\n\n private val notificationState: AnalysisNotificationState\n get() = JSON.readValue(notificationStatePath.readText())\n\n fun maybeNotify() {\n if (shouldNotNotify) return\n\n println(\n listOf(\n \"Try out our new Analyze with Ai feature.\\n\",\n \"See what's new:\",\n \"> https://maestro.mobile.dev/cli/test-suites-and-reports#analyze\",\n \"Analyze command:\",\n \"$ maestro test flow-file.yaml --analyze | bash\\n\",\n \"To disable this notification, set $MAESTRO_CLI_ANALYSIS_NOTIFICATION_DISABLED environment variable to \\\"true\\\" before running Maestro.\"\n ).joinToString(\"\\n\").box()\n )\n ack();\n }\n\n private fun ack() {\n val state = AnalysisNotificationState(\n acknowledged = true\n )\n\n val stateJson = JSON.writeValueAsString(state)\n notificationStatePath.parent.createDirectories()\n notificationStatePath.writeText(stateJson + \"\\n\")\n }\n }\n}\n\n@JsonIgnoreProperties(ignoreUnknown = true)\ndata class AnalysisNotificationState(\n val acknowledged: Boolean = false\n)\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/McpServer.kt", "content": "package maestro.cli.mcp\n\nimport io.ktor.utils.io.streams.*\nimport io.modelcontextprotocol.kotlin.sdk.*\nimport io.modelcontextprotocol.kotlin.sdk.server.Server\nimport io.modelcontextprotocol.kotlin.sdk.server.ServerOptions\nimport io.modelcontextprotocol.kotlin.sdk.server.StdioServerTransport\nimport kotlinx.coroutines.Job\nimport kotlinx.coroutines.runBlocking\nimport kotlinx.serialization.json.*\nimport kotlinx.io.*\nimport maestro.cli.session.MaestroSessionManager\nimport maestro.debuglog.LogConfig\nimport maestro.cli.mcp.tools.ListDevicesTool\nimport maestro.cli.mcp.tools.StartDeviceTool\nimport maestro.cli.mcp.tools.LaunchAppTool\nimport maestro.cli.mcp.tools.TakeScreenshotTool\nimport maestro.cli.mcp.tools.TapOnTool\nimport maestro.cli.mcp.tools.InputTextTool\nimport maestro.cli.mcp.tools.BackTool\nimport maestro.cli.mcp.tools.StopAppTool\nimport maestro.cli.mcp.tools.RunFlowTool\nimport maestro.cli.mcp.tools.RunFlowFilesTool\nimport maestro.cli.mcp.tools.CheckFlowSyntaxTool\nimport maestro.cli.mcp.tools.InspectViewHierarchyTool\nimport maestro.cli.mcp.tools.CheatSheetTool\nimport maestro.cli.mcp.tools.QueryDocsTool\nimport maestro.cli.util.WorkingDirectory\n\n// Main function to run the Maestro MCP server\nfun runMaestroMcpServer() {\n // Disable all console logging to prevent interference with JSON-RPC communication\n LogConfig.configure(logFileName = null, printToConsole = false)\n \n val sessionManager = MaestroSessionManager\n\n // Create the MCP Server instance with Maestro implementation\n val server = Server(\n Implementation(\n name = \"maestro\",\n version = \"1.0.0\"\n ),\n ServerOptions(\n capabilities = ServerCapabilities(\n tools = ServerCapabilities.Tools(listChanged = true)\n )\n )\n )\n\n // Register tools\n server.addTools(listOf(\n ListDevicesTool.create(),\n StartDeviceTool.create(),\n LaunchAppTool.create(sessionManager),\n TakeScreenshotTool.create(sessionManager),\n TapOnTool.create(sessionManager),\n InputTextTool.create(sessionManager),\n BackTool.create(sessionManager),\n StopAppTool.create(sessionManager),\n RunFlowTool.create(sessionManager),\n RunFlowFilesTool.create(sessionManager),\n CheckFlowSyntaxTool.create(),\n InspectViewHierarchyTool.create(sessionManager),\n CheatSheetTool.create(),\n QueryDocsTool.create()\n ))\n\n\n // Create a transport using standard IO for server communication\n val transport = StdioServerTransport(\n System.`in`.asSource().buffered(),\n System.out.asSink().buffered()\n )\n\n System.err.println(\"MCP Server: Started. Waiting for messages. Working directory: ${WorkingDirectory.baseDir}\")\n\n runBlocking {\n server.connect(transport)\n val done = Job()\n server.onClose {\n done.complete()\n }\n done.join()\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/README.md", "content": "# Maestro MCP Server\n\n## Overview\n\nThe Maestro MCP (Model Context Protocol) server enables LLM-driven automation and orchestration of Maestro commands and device management. It serves two primary functions for calling LLMs:\n- enables LLMs to directly control and interact with devices using Maestro device capabilities\n- enables LLMs to write, validate, and run Maestro code (flows)\n\nThe MCP server is designed to be extensible, maintainable, and easy to run as part of the Maestro CLI. It supports real-time device management, app automation, and more, all via a standardized protocol.\n\n## Features\n\n- Exposes Maestro device and automation commands as MCP tools\n- Supports listing, launching, and interacting with devices\n- Supports running flow yaml or files and checking the flow file syntax\n- Easily extensible: add new tools with minimal boilerplate\n- Includes a test script and config for automated validation\n\n## Running the MCP Server\n\nTo use the MCP server as an end user, after following the maestro install instructions run:\n\n```\nmaestro mcp\n```\n\nThis launches the MCP server via the Maestro CLI, exposing Maestro tools over STDIO for LLM agents and other clients.\n\n## Developing\n\n## Extending the MCP Server\n\nTo add a new tool:\n1. Create a new file in `maestro-cli/src/main/java/maestro/cli/mcp/tools/` following the same patterns as the other tools.\n2. Add your tool to the `addTools` call in `McpServer.kt`\n3. Build the CLI with `./gradlew :maestro-cli:installDist`\n4. Test your tool by running `./maestro-cli/src/test/mcp/test-single-mcp-tool.sh` with appropriate args for your tool\n\n## Evals testing\n\nWhen testing a Maestro MCP tool, it's important to test not only that it works correctly but that LLMs can call it correctly and use the output appropriately. This happens less frequently than is expected. Make sure to add relevant test cases to our evals framework in `./maestro-cli/src/test/mcp/maestro-evals.yaml`, and then run the eval test suite with:\n\n```\nANTHROPIC_API_KEY= ./maestro-cli/src/test/mcp/run-mcp-server-evals.sh\n```\n\n## Implementation Notes & Rationale\n\n### Using forked version of official kotlin MCP SDK\n\nThe [official MCP Kotlin SDK](https://github.com/modelcontextprotocol/kotlin-sdk) can't be used directly because it requires Java 21 and Kotlin 2.x, while Maestro is built on Java 8 and Kotlin 1.8.x for broad compatibility. However, we want to be able to benefit from features added to the SDK since the MCP spec is changing rapidly. So we created a fork that \"downgrades\" the reference SDK to Java 8 and Kotlin 1.8.22.\n\n\n### Why Integrate MCP Server Directly Into `maestro-cli`?\n\n- **Dependency Management:** The MCP server needs access to abstractions like `MaestroSessionManager` and other CLI internals. Placing it in a separate module (e.g., `maestro-mcp`) would create a circular dependency between `maestro-cli` and the new module.\n- **Simplicity:** Keeping all MCP logic within `maestro-cli` avoids complex build configurations and makes the integration easier to maintain and review.\n- **Extensibility:** This approach allows new tools to be added with minimal boilerplate and direct access to CLI features.\n\n### Potential Future Improvements\n\n- **Shared Abstractions:** If more MCP-related code or other integrations are needed, consider extracting shared abstractions (e.g., session management, tool interfaces) into a `common` or `core` module. This would allow for a clean separation and potentially enable a standalone `maestro-mcp` module.\n- **Streamable HTTP:** This MCP server currently only uses STDIO for communication.\n\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/tools/BackTool.kt", "content": "package maestro.cli.mcp.tools\n\nimport io.modelcontextprotocol.kotlin.sdk.*\nimport io.modelcontextprotocol.kotlin.sdk.server.RegisteredTool\nimport kotlinx.serialization.json.*\nimport maestro.cli.session.MaestroSessionManager\nimport maestro.orchestra.BackPressCommand\nimport maestro.orchestra.Orchestra\nimport maestro.orchestra.MaestroCommand\nimport kotlinx.coroutines.runBlocking\n\nobject BackTool {\n fun create(sessionManager: MaestroSessionManager): RegisteredTool {\n return RegisteredTool(\n Tool(\n name = \"back\",\n description = \"Press the back button on the device\",\n inputSchema = Tool.Input(\n properties = buildJsonObject {\n putJsonObject(\"device_id\") {\n put(\"type\", \"string\")\n put(\"description\", \"The ID of the device to press back on\")\n }\n },\n required = listOf(\"device_id\")\n )\n )\n ) { request ->\n try {\n val deviceId = request.arguments[\"device_id\"]?.jsonPrimitive?.content\n \n if (deviceId == null) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"device_id is required\")),\n isError = true\n )\n }\n \n val result = sessionManager.newSession(\n host = null,\n port = null,\n driverHostPort = null,\n deviceId = deviceId,\n platform = null\n ) { session ->\n val command = BackPressCommand(\n label = null,\n optional = false\n )\n \n val orchestra = Orchestra(session.maestro)\n runBlocking {\n orchestra.runFlow(listOf(MaestroCommand(command = command)))\n }\n \n buildJsonObject {\n put(\"success\", true)\n put(\"device_id\", deviceId)\n put(\"message\", \"Back button pressed successfully\")\n }.toString()\n }\n \n CallToolResult(content = listOf(TextContent(result)))\n } catch (e: Exception) {\n CallToolResult(\n content = listOf(TextContent(\"Failed to press back: ${e.message}\")),\n isError = true\n )\n }\n }\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/tools/CheatSheetTool.kt", "content": "package maestro.cli.mcp.tools\n\nimport io.modelcontextprotocol.kotlin.sdk.*\nimport io.modelcontextprotocol.kotlin.sdk.server.RegisteredTool\nimport kotlinx.serialization.json.*\nimport maestro.auth.ApiKey\nimport maestro.utils.HttpClient\nimport okhttp3.Request\nimport kotlin.time.Duration.Companion.minutes\n\nobject CheatSheetTool {\n fun create(): RegisteredTool {\n return RegisteredTool(\n Tool(\n name = \"cheat_sheet\",\n description = \"Get the Maestro cheat sheet with common commands and syntax examples. \" +\n \"Returns comprehensive documentation on Maestro flow syntax, commands, and best practices.\",\n inputSchema = Tool.Input(\n properties = buildJsonObject {},\n required = emptyList()\n )\n )\n ) { _ ->\n try {\n val apiKey = ApiKey.getToken()\n if (apiKey.isNullOrBlank()) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"MAESTRO_CLOUD_API_KEY environment variable is required\")),\n isError = true\n )\n }\n \n val client = HttpClient.build(\n name = \"CheatSheetTool\",\n readTimeout = 2.minutes\n )\n \n // Make GET request to cheat sheet endpoint\n val httpRequest = Request.Builder()\n .url(\"https://api.copilot.mobile.dev/v2/bot/maestro-cheat-sheet\")\n .header(\"Authorization\", \"Bearer $apiKey\")\n .get()\n .build()\n \n val response = client.newCall(httpRequest).execute()\n \n response.use {\n if (!response.isSuccessful) {\n val errorMessage = response.body?.string().takeIf { it?.isNotEmpty() == true } ?: \"Unknown error\"\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"Failed to get cheat sheet (${response.code}): $errorMessage\")),\n isError = true\n )\n }\n \n val cheatSheetContent = response.body?.string() ?: \"\"\n \n CallToolResult(content = listOf(TextContent(cheatSheetContent)))\n }\n } catch (e: Exception) {\n CallToolResult(\n content = listOf(TextContent(\"Failed to get cheat sheet: ${e.message}\")),\n isError = true\n )\n }\n }\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/tools/CheckFlowSyntaxTool.kt", "content": "package maestro.cli.mcp.tools\n\nimport io.modelcontextprotocol.kotlin.sdk.*\nimport io.modelcontextprotocol.kotlin.sdk.server.RegisteredTool\nimport kotlinx.serialization.json.*\nimport maestro.orchestra.yaml.YamlCommandReader\n\nobject CheckFlowSyntaxTool {\n fun create(): RegisteredTool {\n return RegisteredTool(\n Tool(\n name = \"check_flow_syntax\",\n description = \"Validates the syntax of a block of Maestro code. Valid maestro code must be well-formatted YAML.\",\n inputSchema = Tool.Input(\n properties = buildJsonObject {\n putJsonObject(\"flow_yaml\") {\n put(\"type\", \"string\")\n put(\"description\", \"YAML-formatted Maestro flow content to validate\")\n }\n },\n required = listOf(\"flow_yaml\")\n )\n )\n ) { request ->\n try {\n val flowYaml = request.arguments[\"flow_yaml\"]?.jsonPrimitive?.content\n \n if (flowYaml == null) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"flow_yaml is required\")),\n isError = true\n )\n }\n \n val result = try {\n YamlCommandReader.checkSyntax(flowYaml)\n buildJsonObject {\n put(\"valid\", true)\n put(\"message\", \"Flow syntax is valid\")\n }.toString()\n } catch (e: Exception) {\n buildJsonObject {\n put(\"valid\", false)\n put(\"error\", e.message ?: \"Unknown parsing error\")\n put(\"message\", \"Syntax check failed\")\n }.toString()\n }\n \n CallToolResult(content = listOf(TextContent(result)))\n } catch (e: Exception) {\n CallToolResult(\n content = listOf(TextContent(\"Failed to check flow syntax: ${e.message}\")),\n isError = true\n )\n }\n }\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/tools/InputTextTool.kt", "content": "package maestro.cli.mcp.tools\n\nimport io.modelcontextprotocol.kotlin.sdk.*\nimport io.modelcontextprotocol.kotlin.sdk.server.RegisteredTool\nimport kotlinx.serialization.json.*\nimport maestro.cli.session.MaestroSessionManager\nimport maestro.orchestra.InputTextCommand\nimport maestro.orchestra.Orchestra\nimport maestro.orchestra.MaestroCommand\nimport kotlinx.coroutines.runBlocking\n\nobject InputTextTool {\n fun create(sessionManager: MaestroSessionManager): RegisteredTool {\n return RegisteredTool(\n Tool(\n name = \"input_text\",\n description = \"Input text into the currently focused text field\",\n inputSchema = Tool.Input(\n properties = buildJsonObject {\n putJsonObject(\"device_id\") {\n put(\"type\", \"string\")\n put(\"description\", \"The ID of the device to input text on\")\n }\n putJsonObject(\"text\") {\n put(\"type\", \"string\")\n put(\"description\", \"The text to input\")\n }\n },\n required = listOf(\"device_id\", \"text\")\n )\n )\n ) { request ->\n try {\n val deviceId = request.arguments[\"device_id\"]?.jsonPrimitive?.content\n val text = request.arguments[\"text\"]?.jsonPrimitive?.content\n \n if (deviceId == null || text == null) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"Both device_id and text are required\")),\n isError = true\n )\n }\n \n val result = sessionManager.newSession(\n host = null,\n port = null,\n driverHostPort = null,\n deviceId = deviceId,\n platform = null\n ) { session ->\n val command = InputTextCommand(\n text = text,\n label = null,\n optional = false\n )\n \n val orchestra = Orchestra(session.maestro)\n runBlocking {\n orchestra.runFlow(listOf(MaestroCommand(command = command)))\n }\n \n buildJsonObject {\n put(\"success\", true)\n put(\"device_id\", deviceId)\n put(\"text\", text)\n put(\"message\", \"Text input successful\")\n }.toString()\n }\n \n CallToolResult(content = listOf(TextContent(result)))\n } catch (e: Exception) {\n CallToolResult(\n content = listOf(TextContent(\"Failed to input text: ${e.message}\")),\n isError = true\n )\n }\n }\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/tools/InspectViewHierarchyTool.kt", "content": "package maestro.cli.mcp.tools\n\nimport io.modelcontextprotocol.kotlin.sdk.*\nimport io.modelcontextprotocol.kotlin.sdk.server.RegisteredTool\nimport kotlinx.serialization.json.*\nimport maestro.cli.session.MaestroSessionManager\nimport maestro.TreeNode\nimport kotlinx.coroutines.runBlocking\n\nobject InspectViewHierarchyTool {\n fun create(sessionManager: MaestroSessionManager): RegisteredTool {\n return RegisteredTool(\n Tool(\n name = \"inspect_view_hierarchy\",\n description = \"Get the nested view hierarchy of the current screen in CSV format. Returns UI elements \" +\n \"with bounds coordinates for interaction. Use this to understand screen layout, find specific elements \" +\n \"by text/id, or locate interactive components. Elements include bounds (x,y,width,height), text content, \" +\n \"resource IDs, and interaction states (clickable, enabled, checked).\",\n inputSchema = Tool.Input(\n properties = buildJsonObject {\n putJsonObject(\"device_id\") {\n put(\"type\", \"string\")\n put(\"description\", \"The ID of the device to get hierarchy from\")\n }\n },\n required = listOf(\"device_id\")\n )\n )\n ) { request ->\n try {\n val deviceId = request.arguments[\"device_id\"]?.jsonPrimitive?.content\n \n if (deviceId == null) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"device_id is required\")),\n isError = true\n )\n }\n \n val result = sessionManager.newSession(\n host = null,\n port = null,\n driverHostPort = null,\n deviceId = deviceId,\n platform = null\n ) { session ->\n val maestro = session.maestro\n val viewHierarchy = maestro.viewHierarchy()\n val tree = viewHierarchy.root\n \n // Return CSV format (original format for compatibility)\n ViewHierarchyFormatters.extractCsvOutput(tree)\n }\n \n CallToolResult(content = listOf(TextContent(result)))\n } catch (e: Exception) {\n CallToolResult(\n content = listOf(TextContent(\"Failed to inspect UI: ${e.message}\")),\n isError = true\n )\n }\n }\n }\n \n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/tools/LaunchAppTool.kt", "content": "package maestro.cli.mcp.tools\n\nimport io.modelcontextprotocol.kotlin.sdk.*\nimport io.modelcontextprotocol.kotlin.sdk.server.RegisteredTool\nimport kotlinx.serialization.json.*\nimport maestro.cli.session.MaestroSessionManager\nimport maestro.orchestra.LaunchAppCommand\nimport maestro.orchestra.Orchestra\nimport maestro.orchestra.MaestroCommand\nimport kotlinx.coroutines.runBlocking\n\nobject LaunchAppTool {\n fun create(sessionManager: MaestroSessionManager): RegisteredTool {\n return RegisteredTool(\n Tool(\n name = \"launch_app\",\n description = \"Launch an application on the connected device\",\n inputSchema = Tool.Input(\n properties = buildJsonObject {\n putJsonObject(\"device_id\") {\n put(\"type\", \"string\")\n put(\"description\", \"The ID of the device to launch the app on\")\n }\n putJsonObject(\"appId\") {\n put(\"type\", \"string\")\n put(\"description\", \"Bundle ID or app ID to launch\")\n }\n },\n required = listOf(\"device_id\", \"appId\")\n )\n )\n ) { request ->\n try {\n val deviceId = request.arguments[\"device_id\"]?.jsonPrimitive?.content\n val appId = request.arguments[\"appId\"]?.jsonPrimitive?.content\n \n if (deviceId == null || appId == null) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"Both device_id and appId are required\")),\n isError = true\n )\n }\n \n val result = sessionManager.newSession(\n host = null,\n port = null,\n driverHostPort = null,\n deviceId = deviceId,\n platform = null\n ) { session ->\n val command = LaunchAppCommand(\n appId = appId,\n clearState = null,\n clearKeychain = null,\n stopApp = null,\n permissions = null,\n launchArguments = null,\n label = null,\n optional = false\n )\n \n val orchestra = Orchestra(session.maestro)\n runBlocking {\n orchestra.runFlow(listOf(MaestroCommand(command = command)))\n }\n \n buildJsonObject {\n put(\"success\", true)\n put(\"device_id\", deviceId)\n put(\"app_id\", appId)\n put(\"message\", \"App launched successfully\")\n }.toString()\n }\n \n CallToolResult(content = listOf(TextContent(result)))\n } catch (e: Exception) {\n CallToolResult(\n content = listOf(TextContent(\"Failed to launch app: ${e.message}\")),\n isError = true\n )\n }\n }\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/tools/ListDevicesTool.kt", "content": "package maestro.cli.mcp.tools\n\nimport io.modelcontextprotocol.kotlin.sdk.*\nimport io.modelcontextprotocol.kotlin.sdk.server.RegisteredTool\nimport kotlinx.serialization.json.*\nimport maestro.device.DeviceService\n\nobject ListDevicesTool {\n fun create(): RegisteredTool {\n return RegisteredTool(\n Tool(\n name = \"list_devices\",\n description = \"List all available devices that can be launched for automation.\",\n inputSchema = Tool.Input(\n properties = buildJsonObject { },\n required = emptyList()\n )\n )\n ) { _ ->\n try {\n val availableDevices = DeviceService.listAvailableForLaunchDevices(includeWeb = true)\n val connectedDevices = DeviceService.listConnectedDevices()\n \n val allDevices = buildJsonArray {\n // Add connected devices\n connectedDevices.forEach { device ->\n addJsonObject {\n put(\"device_id\", device.instanceId)\n put(\"name\", device.description)\n put(\"platform\", device.platform.name.lowercase())\n put(\"type\", device.deviceType.name.lowercase())\n put(\"connected\", true)\n }\n }\n \n // Add available devices that aren't already connected\n availableDevices.forEach { device ->\n val alreadyConnected = connectedDevices.any { it.instanceId == device.modelId }\n if (!alreadyConnected) {\n addJsonObject {\n put(\"device_id\", device.modelId)\n put(\"name\", device.description)\n put(\"platform\", device.platform.name.lowercase())\n put(\"type\", device.deviceType.name.lowercase()) \n put(\"connected\", false)\n }\n }\n }\n }\n \n val result = buildJsonObject {\n put(\"devices\", allDevices)\n }\n \n CallToolResult(content = listOf(TextContent(result.toString())))\n } catch (e: Exception) {\n CallToolResult(\n content = listOf(TextContent(\"Failed to list devices: ${e.message}\")),\n isError = true\n )\n }\n }\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/tools/QueryDocsTool.kt", "content": "package maestro.cli.mcp.tools\n\nimport io.modelcontextprotocol.kotlin.sdk.*\nimport io.modelcontextprotocol.kotlin.sdk.server.RegisteredTool\nimport kotlinx.serialization.json.*\nimport maestro.auth.ApiKey\nimport maestro.utils.HttpClient\nimport okhttp3.MediaType.Companion.toMediaType\nimport okhttp3.Request\nimport okhttp3.RequestBody.Companion.toRequestBody\nimport kotlin.time.Duration.Companion.minutes\n\nobject QueryDocsTool {\n fun create(): RegisteredTool {\n return RegisteredTool(\n Tool(\n name = \"query_docs\",\n description = \"Query the Maestro documentation for specific information. \" +\n \"Ask questions about Maestro features, commands, best practices, and troubleshooting. \" +\n \"Returns relevant documentation content and examples.\",\n inputSchema = Tool.Input(\n properties = buildJsonObject {\n putJsonObject(\"question\") {\n put(\"type\", \"string\")\n put(\"description\", \"The question to ask about Maestro documentation\")\n }\n },\n required = listOf(\"question\")\n )\n )\n ) { request ->\n try {\n val question = request.arguments[\"question\"]?.jsonPrimitive?.content\n if (question.isNullOrBlank()) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"question parameter is required\")),\n isError = true\n )\n }\n \n val apiKey = ApiKey.getToken()\n if (apiKey.isNullOrBlank()) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"MAESTRO_CLOUD_API_KEY environment variable is required\")),\n isError = true\n )\n }\n \n val client = HttpClient.build(\n name = \"QueryDocsTool\",\n readTimeout = 2.minutes\n )\n \n // Create JSON request body\n val requestBody = buildJsonObject {\n put(\"question\", question)\n }.toString()\n \n // Make POST request to query docs endpoint\n val httpRequest = Request.Builder()\n .url(\"https://api.copilot.mobile.dev/v2/bot/query-docs\")\n .header(\"Authorization\", \"Bearer $apiKey\")\n .header(\"Content-Type\", \"application/json\")\n .post(requestBody.toRequestBody(\"application/json\".toMediaType()))\n .build()\n \n val response = client.newCall(httpRequest).execute()\n \n response.use {\n if (!response.isSuccessful) {\n val errorMessage = response.body?.string().takeIf { it?.isNotEmpty() == true } ?: \"Unknown error\"\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"Failed to query docs (${response.code}): $errorMessage\")),\n isError = true\n )\n }\n \n val responseBody = response.body?.string() ?: \"\"\n \n try {\n val jsonResponse = Json.parseToJsonElement(responseBody).jsonObject\n val answer = jsonResponse[\"answer\"]?.jsonPrimitive?.content ?: responseBody\n CallToolResult(content = listOf(TextContent(answer)))\n } catch (e: Exception) {\n // If JSON parsing fails, return the raw response\n CallToolResult(content = listOf(TextContent(responseBody)))\n }\n }\n } catch (e: Exception) {\n CallToolResult(\n content = listOf(TextContent(\"Failed to query docs: ${e.message}\")),\n isError = true\n )\n }\n }\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/tools/RunFlowFilesTool.kt", "content": "package maestro.cli.mcp.tools\n\nimport io.modelcontextprotocol.kotlin.sdk.*\nimport io.modelcontextprotocol.kotlin.sdk.server.RegisteredTool\nimport kotlinx.serialization.json.*\nimport maestro.cli.session.MaestroSessionManager\nimport maestro.orchestra.Orchestra\nimport maestro.orchestra.yaml.YamlCommandReader\nimport maestro.orchestra.util.Env.withEnv\nimport maestro.orchestra.util.Env.withInjectedShellEnvVars\nimport maestro.orchestra.util.Env.withDefaultEnvVars\nimport kotlinx.coroutines.runBlocking\nimport java.io.File\nimport java.nio.file.Paths\nimport maestro.cli.util.WorkingDirectory\n\nobject RunFlowFilesTool {\n fun create(sessionManager: MaestroSessionManager): RegisteredTool {\n return RegisteredTool(\n Tool(\n name = \"run_flow_files\",\n description = \"Run one or more full Maestro test files. If no device is running, you'll need to start a device first. If the command fails using a relative path, try using an absolute path.\",\n inputSchema = Tool.Input(\n properties = buildJsonObject {\n putJsonObject(\"device_id\") {\n put(\"type\", \"string\")\n put(\"description\", \"The ID of the device to run the flows on\")\n }\n putJsonObject(\"flow_files\") {\n put(\"type\", \"string\")\n put(\"description\", \"Comma-separated file paths to YAML flow files to execute (e.g., 'flow1.yaml,flow2.yaml')\")\n }\n putJsonObject(\"env\") {\n put(\"type\", \"object\")\n put(\"description\", \"Optional environment variables to inject into the flows (e.g., {\\\"APP_ID\\\": \\\"com.example.app\\\", \\\"LANGUAGE\\\": \\\"tr\\\", \\\"COUNTRY\\\": \\\"TR\\\"})\")\n putJsonObject(\"additionalProperties\") {\n put(\"type\", \"string\")\n }\n }\n },\n required = listOf(\"device_id\", \"flow_files\")\n )\n )\n ) { request ->\n try {\n val deviceId = request.arguments[\"device_id\"]?.jsonPrimitive?.content\n val flowFilesString = request.arguments[\"flow_files\"]?.jsonPrimitive?.content\n val envParam = request.arguments[\"env\"]?.jsonObject\n \n if (deviceId == null || flowFilesString == null) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"Both device_id and flow_files are required\")),\n isError = true\n )\n }\n \n val flowFiles = flowFilesString.split(\",\").map { it.trim() }\n \n if (flowFiles.isEmpty()) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"At least one flow file must be provided\")),\n isError = true\n )\n }\n \n // Parse environment variables from JSON object\n val env = envParam?.mapValues { it.value.jsonPrimitive.content } ?: emptyMap()\n \n // Resolve all flow files to File objects once\n val resolvedFiles = flowFiles.map { WorkingDirectory.resolve(it) }\n // Validate all files exist before executing\n val missingFiles = resolvedFiles.filter { !it.exists() }\n if (missingFiles.isNotEmpty()) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"Files not found: ${missingFiles.joinToString(\", \") { it.absolutePath }}\")),\n isError = true\n )\n }\n \n val result = sessionManager.newSession(\n host = null,\n port = null,\n driverHostPort = null,\n deviceId = deviceId,\n platform = null\n ) { session ->\n val orchestra = Orchestra(session.maestro)\n val results = mutableListOf>()\n var totalCommands = 0\n \n for (fileObj in resolvedFiles) {\n try {\n val commands = YamlCommandReader.readCommands(fileObj.toPath())\n val finalEnv = env\n .withInjectedShellEnvVars()\n .withDefaultEnvVars(fileObj, deviceId)\n val commandsWithEnv = commands.withEnv(finalEnv)\n \n runBlocking {\n orchestra.runFlow(commandsWithEnv)\n }\n results.add(mapOf(\n \"file\" to fileObj.absolutePath,\n \"success\" to true,\n \"commands_executed\" to commands.size,\n \"message\" to \"Flow executed successfully\"\n ))\n totalCommands += commands.size\n } catch (e: Exception) {\n results.add(mapOf(\n \"file\" to fileObj.absolutePath,\n \"success\" to false,\n \"error\" to (e.message ?: \"Unknown error\"),\n \"message\" to \"Flow execution failed\"\n ))\n }\n }\n \n val finalEnv = env\n .withInjectedShellEnvVars()\n .withDefaultEnvVars(deviceId = deviceId)\n \n buildJsonObject {\n put(\"success\", results.all { (it[\"success\"] as Boolean) })\n put(\"device_id\", deviceId)\n put(\"total_files\", flowFiles.size)\n put(\"total_commands_executed\", totalCommands)\n putJsonArray(\"results\") {\n results.forEach { result ->\n addJsonObject {\n result.forEach { (key, value) ->\n when (value) {\n is String -> put(key, value)\n is Boolean -> put(key, value)\n is Int -> put(key, value)\n else -> put(key, value.toString())\n }\n }\n }\n }\n }\n if (finalEnv.isNotEmpty()) {\n putJsonObject(\"env_vars\") {\n finalEnv.forEach { (key, value) ->\n put(key, value)\n }\n }\n }\n put(\"message\", if (results.all { (it[\"success\"] as Boolean) }) \n \"All flows executed successfully\" \n else \n \"Some flows failed to execute\")\n }.toString()\n }\n \n // Check if any flows failed and return isError accordingly\n val anyFlowsFailed = result.contains(\"\\\"success\\\":false\") \n CallToolResult(\n content = listOf(TextContent(result)),\n isError = anyFlowsFailed\n )\n } catch (e: Exception) {\n CallToolResult(\n content = listOf(TextContent(\"Failed to run flow files: ${e.message}\")),\n isError = true\n )\n }\n }\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/tools/RunFlowTool.kt", "content": "package maestro.cli.mcp.tools\n\nimport io.modelcontextprotocol.kotlin.sdk.*\nimport io.modelcontextprotocol.kotlin.sdk.server.RegisteredTool\nimport kotlinx.serialization.json.*\nimport maestro.cli.session.MaestroSessionManager\nimport maestro.orchestra.Orchestra\nimport maestro.orchestra.yaml.YamlCommandReader\nimport maestro.orchestra.util.Env.withEnv\nimport maestro.orchestra.util.Env.withInjectedShellEnvVars\nimport maestro.orchestra.util.Env.withDefaultEnvVars\nimport kotlinx.coroutines.runBlocking\nimport java.io.File\nimport java.nio.file.Files\n\nobject RunFlowTool {\n fun create(sessionManager: MaestroSessionManager): RegisteredTool {\n return RegisteredTool(\n Tool(\n name = \"run_flow\",\n description = \"\"\"\n Use this when interacting with a device and running adhoc commands, preferably one at a time.\n\n Whenever you're exploring an app, testing out commands or debugging, prefer using this tool over creating temp files and using run_flow_files.\n\n Run a set of Maestro commands (one or more). This can be a full maestro script (including headers), a set of commands (one per line) or simply a single command (eg '- tapOn: 123').\n\n If this fails due to no device running, please ask the user to start a device!\n\n If you don't have an up-to-date view hierarchy or screenshot on which to execute the commands, please call inspect_view_hierarchy first, instead of blindly guessing.\n\n *** You don't need to call check_syntax before executing this, as syntax will be checked as part of the execution flow. ***\n\n Use the `inspect_view_hierarchy` tool to retrieve the current view hierarchy and use it to execute commands on the device.\n Use the `cheat_sheet` tool to retrieve a summary of Maestro's flow syntax before using any of the other tools.\n\n Examples of valid inputs:\n ```\n - tapOn: 123\n ```\n\n ```\n appId: any\n ---\n - tapOn: 123\n ```\n\n ```\n appId: any\n # other headers here\n ---\n - tapOn: 456\n - scroll\n # other commands here\n ```\n \"\"\".trimIndent(),\n inputSchema = Tool.Input(\n properties = buildJsonObject {\n putJsonObject(\"device_id\") {\n put(\"type\", \"string\")\n put(\"description\", \"The ID of the device to run the flow on\")\n }\n putJsonObject(\"flow_yaml\") {\n put(\"type\", \"string\")\n put(\"description\", \"YAML-formatted Maestro flow content to execute\")\n }\n putJsonObject(\"env\") {\n put(\"type\", \"object\")\n put(\"description\", \"Optional environment variables to inject into the flow (e.g., {\\\"APP_ID\\\": \\\"com.example.app\\\", \\\"LANGUAGE\\\": \\\"en\\\"})\")\n putJsonObject(\"additionalProperties\") {\n put(\"type\", \"string\")\n }\n }\n },\n required = listOf(\"device_id\", \"flow_yaml\")\n )\n )\n ) { request ->\n try {\n val deviceId = request.arguments[\"device_id\"]?.jsonPrimitive?.content\n val flowYaml = request.arguments[\"flow_yaml\"]?.jsonPrimitive?.content\n val envParam = request.arguments[\"env\"]?.jsonObject\n \n if (deviceId == null || flowYaml == null) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"Both device_id and flow_yaml are required\")),\n isError = true\n )\n }\n \n // Parse environment variables from JSON object\n val env = envParam?.mapValues { it.value.jsonPrimitive.content } ?: emptyMap()\n \n val result = sessionManager.newSession(\n host = null,\n port = null,\n driverHostPort = null,\n deviceId = deviceId,\n platform = null\n ) { session ->\n // Create a temporary file with the YAML content\n val tempFile = Files.createTempFile(\"maestro-flow\", \".yaml\").toFile()\n try {\n tempFile.writeText(flowYaml)\n \n // Parse and execute the flow with environment variables\n val commands = YamlCommandReader.readCommands(tempFile.toPath())\n val finalEnv = env\n .withInjectedShellEnvVars()\n .withDefaultEnvVars(tempFile, deviceId)\n val commandsWithEnv = commands.withEnv(finalEnv)\n \n val orchestra = Orchestra(session.maestro)\n \n runBlocking {\n orchestra.runFlow(commandsWithEnv)\n }\n \n buildJsonObject {\n put(\"success\", true)\n put(\"device_id\", deviceId)\n put(\"commands_executed\", commands.size)\n put(\"message\", \"Flow executed successfully\")\n if (finalEnv.isNotEmpty()) {\n putJsonObject(\"env_vars\") {\n finalEnv.forEach { (key, value) ->\n put(key, value)\n }\n }\n }\n }.toString()\n } finally {\n // Clean up the temporary file\n tempFile.delete()\n }\n }\n \n CallToolResult(content = listOf(TextContent(result)))\n } catch (e: Exception) {\n CallToolResult(\n content = listOf(TextContent(\"Failed to run flow: ${e.message}\")),\n isError = true\n )\n }\n }\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/tools/StartDeviceTool.kt", "content": "package maestro.cli.mcp.tools\n\nimport io.modelcontextprotocol.kotlin.sdk.*\nimport io.modelcontextprotocol.kotlin.sdk.server.RegisteredTool\nimport kotlinx.serialization.json.*\nimport maestro.device.DeviceService\nimport maestro.device.Platform\n\nobject StartDeviceTool {\n fun create(): RegisteredTool {\n return RegisteredTool(\n Tool(\n name = \"start_device\",\n description = \"Start a device (simulator/emulator) and return its device ID. \" +\n \"You must provide either a device_id (from list_devices) or a platform (ios or android). \" +\n \"If device_id is provided, starts that device. If platform is provided, starts any available device for that platform. \" +\n \"If neither is provided, defaults to platform = ios.\",\n inputSchema = Tool.Input(\n properties = buildJsonObject {\n putJsonObject(\"device_id\") {\n put(\"type\", \"string\")\n put(\"description\", \"ID of the device to start (from list_devices). Optional.\")\n }\n putJsonObject(\"platform\") {\n put(\"type\", \"string\") \n put(\"description\", \"Platform to start (ios or android). Optional. Default: ios.\")\n }\n },\n required = emptyList()\n )\n )\n ) { request ->\n try {\n val deviceId = request.arguments[\"device_id\"]?.jsonPrimitive?.content\n val platformStr = request.arguments[\"platform\"]?.jsonPrimitive?.content ?: \"ios\"\n \n // Get all connected and available devices\n val availableDevices = DeviceService.listAvailableForLaunchDevices(includeWeb = true)\n val connectedDevices = DeviceService.listConnectedDevices()\n\n // Helper to build result\n fun buildResult(device: maestro.device.Device.Connected, alreadyRunning: Boolean): String {\n return buildJsonObject {\n put(\"device_id\", device.instanceId)\n put(\"name\", device.description)\n put(\"platform\", device.platform.name.lowercase())\n put(\"type\", device.deviceType.name.lowercase())\n put(\"already_running\", alreadyRunning)\n }.toString()\n }\n\n if (deviceId != null) {\n // Check for a connected device with this instanceId\n val connected = connectedDevices.find { it.instanceId == deviceId }\n if (connected != null) {\n return@RegisteredTool CallToolResult(content = listOf(TextContent(buildResult(connected, true))))\n }\n // Check for an available device with this modelId\n val available = availableDevices.find { it.modelId == deviceId }\n if (available != null) {\n val connectedDevice = DeviceService.startDevice(\n device = available,\n driverHostPort = null\n )\n return@RegisteredTool CallToolResult(content = listOf(TextContent(buildResult(connectedDevice, false))))\n }\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"No device found with device_id: $deviceId\")),\n isError = true\n )\n }\n\n // No device_id provided: use platform\n val platform = Platform.fromString(platformStr)\n // Check for a connected device matching the platform\n val connected = connectedDevices.find { it.platform == platform }\n if (connected != null) {\n return@RegisteredTool CallToolResult(content = listOf(TextContent(buildResult(connected, true))))\n }\n // Check for an available device matching the platform\n val available = availableDevices.find { it.platform == platform }\n if (available != null) {\n val connectedDevice = DeviceService.startDevice(\n device = available,\n driverHostPort = null\n )\n return@RegisteredTool CallToolResult(content = listOf(TextContent(buildResult(connectedDevice, false))))\n }\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"No available or connected device found for platform: $platformStr\")),\n isError = true\n )\n } catch (e: Exception) {\n CallToolResult(\n content = listOf(TextContent(\"Failed to start device: ${e.message}\")),\n isError = true\n )\n }\n }\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/tools/StopAppTool.kt", "content": "package maestro.cli.mcp.tools\n\nimport io.modelcontextprotocol.kotlin.sdk.*\nimport io.modelcontextprotocol.kotlin.sdk.server.RegisteredTool\nimport kotlinx.serialization.json.*\nimport maestro.cli.session.MaestroSessionManager\nimport maestro.orchestra.StopAppCommand\nimport maestro.orchestra.Orchestra\nimport maestro.orchestra.MaestroCommand\nimport kotlinx.coroutines.runBlocking\n\nobject StopAppTool {\n fun create(sessionManager: MaestroSessionManager): RegisteredTool {\n return RegisteredTool(\n Tool(\n name = \"stop_app\",\n description = \"Stop an application on the connected device\",\n inputSchema = Tool.Input(\n properties = buildJsonObject {\n putJsonObject(\"device_id\") {\n put(\"type\", \"string\")\n put(\"description\", \"The ID of the device to stop the app on\")\n }\n putJsonObject(\"appId\") {\n put(\"type\", \"string\")\n put(\"description\", \"Bundle ID or app ID to stop\")\n }\n },\n required = listOf(\"device_id\", \"appId\")\n )\n )\n ) { request ->\n try {\n val deviceId = request.arguments[\"device_id\"]?.jsonPrimitive?.content\n val appId = request.arguments[\"appId\"]?.jsonPrimitive?.content\n \n if (deviceId == null || appId == null) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"Both device_id and appId are required\")),\n isError = true\n )\n }\n \n val result = sessionManager.newSession(\n host = null,\n port = null,\n driverHostPort = null,\n deviceId = deviceId,\n platform = null\n ) { session ->\n val command = StopAppCommand(\n appId = appId,\n label = null,\n optional = false\n )\n \n val orchestra = Orchestra(session.maestro)\n runBlocking {\n orchestra.runFlow(listOf(MaestroCommand(command = command)))\n }\n \n buildJsonObject {\n put(\"success\", true)\n put(\"device_id\", deviceId)\n put(\"app_id\", appId)\n put(\"message\", \"App stopped successfully\")\n }.toString()\n }\n \n CallToolResult(content = listOf(TextContent(result)))\n } catch (e: Exception) {\n CallToolResult(\n content = listOf(TextContent(\"Failed to stop app: ${e.message}\")),\n isError = true\n )\n }\n }\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/tools/TakeScreenshotTool.kt", "content": "package maestro.cli.mcp.tools\n\nimport io.modelcontextprotocol.kotlin.sdk.*\nimport io.modelcontextprotocol.kotlin.sdk.server.RegisteredTool\nimport kotlinx.serialization.json.*\nimport maestro.cli.session.MaestroSessionManager\nimport okio.Buffer\nimport java.util.Base64\nimport java.io.ByteArrayInputStream\nimport java.io.ByteArrayOutputStream\nimport javax.imageio.ImageIO\n\nobject TakeScreenshotTool {\n fun create(sessionManager: MaestroSessionManager): RegisteredTool {\n return RegisteredTool(\n Tool(\n name = \"take_screenshot\",\n description = \"Take a screenshot of the current device screen\",\n inputSchema = Tool.Input(\n properties = buildJsonObject {\n putJsonObject(\"device_id\") {\n put(\"type\", \"string\")\n put(\"description\", \"The ID of the device to take a screenshot from\")\n }\n },\n required = listOf(\"device_id\")\n )\n )\n ) { request ->\n try {\n val deviceId = request.arguments[\"device_id\"]?.jsonPrimitive?.content\n \n if (deviceId == null) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"device_id is required\")),\n isError = true\n )\n }\n \n val result = sessionManager.newSession(\n host = null,\n port = null,\n driverHostPort = null,\n deviceId = deviceId,\n platform = null\n ) { session ->\n val buffer = Buffer()\n session.maestro.takeScreenshot(buffer, true)\n val pngBytes = buffer.readByteArray()\n \n // Convert PNG to JPEG\n val pngImage = ImageIO.read(ByteArrayInputStream(pngBytes))\n val jpegOutput = ByteArrayOutputStream()\n ImageIO.write(pngImage, \"JPEG\", jpegOutput)\n val jpegBytes = jpegOutput.toByteArray()\n \n val base64 = Base64.getEncoder().encodeToString(jpegBytes)\n base64\n }\n \n val imageContent = ImageContent(\n data = result,\n mimeType = \"image/jpeg\"\n )\n \n CallToolResult(content = listOf(imageContent))\n } catch (e: Exception) {\n CallToolResult(\n content = listOf(TextContent(\"Failed to take screenshot: ${e.message}\")),\n isError = true\n )\n }\n }\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/tools/TapOnTool.kt", "content": "package maestro.cli.mcp.tools\n\nimport io.modelcontextprotocol.kotlin.sdk.*\nimport io.modelcontextprotocol.kotlin.sdk.server.RegisteredTool\nimport kotlinx.serialization.json.*\nimport maestro.cli.session.MaestroSessionManager\nimport maestro.orchestra.ElementSelector\nimport maestro.orchestra.TapOnElementCommand\nimport maestro.orchestra.Orchestra\nimport maestro.orchestra.MaestroCommand\nimport kotlinx.coroutines.runBlocking\n\nobject TapOnTool {\n fun create(sessionManager: MaestroSessionManager): RegisteredTool {\n return RegisteredTool(\n Tool(\n name = \"tap_on\",\n description = \"Tap on a UI element by selector or description\",\n inputSchema = Tool.Input(\n properties = buildJsonObject {\n putJsonObject(\"device_id\") {\n put(\"type\", \"string\")\n put(\"description\", \"The ID of the device to tap on\")\n }\n putJsonObject(\"text\") {\n put(\"type\", \"string\")\n put(\"description\", \"Text content to match (from 'text' field in inspect_ui output)\")\n }\n putJsonObject(\"id\") {\n put(\"type\", \"string\")\n put(\"description\", \"Element ID to match (from 'id' field in inspect_ui output)\")\n }\n putJsonObject(\"index\") {\n put(\"type\", \"integer\")\n put(\"description\", \"0-based index if multiple elements match the same criteria\")\n }\n putJsonObject(\"use_fuzzy_matching\") {\n put(\"type\", \"boolean\")\n put(\"description\", \"Whether to use fuzzy/partial text matching (true, default) or exact regex matching (false)\")\n }\n putJsonObject(\"enabled\") {\n put(\"type\", \"boolean\")\n put(\"description\", \"If true, only match enabled elements. If false, only match disabled elements. Omit this field to match regardless of enabled state.\")\n }\n putJsonObject(\"checked\") {\n put(\"type\", \"boolean\")\n put(\"description\", \"If true, only match checked elements. If false, only match unchecked elements. Omit this field to match regardless of checked state.\")\n }\n putJsonObject(\"focused\") {\n put(\"type\", \"boolean\")\n put(\"description\", \"If true, only match focused elements. If false, only match unfocused elements. Omit this field to match regardless of focus state.\")\n }\n putJsonObject(\"selected\") {\n put(\"type\", \"boolean\")\n put(\"description\", \"If true, only match selected elements. If false, only match unselected elements. Omit this field to match regardless of selection state.\")\n }\n },\n required = listOf(\"device_id\")\n )\n )\n ) { request ->\n try {\n val deviceId = request.arguments[\"device_id\"]?.jsonPrimitive?.content\n val text = request.arguments[\"text\"]?.jsonPrimitive?.content\n val id = request.arguments[\"id\"]?.jsonPrimitive?.content\n val index = request.arguments[\"index\"]?.jsonPrimitive?.intOrNull\n val useFuzzyMatching = request.arguments[\"use_fuzzy_matching\"]?.jsonPrimitive?.booleanOrNull ?: true\n val enabled = request.arguments[\"enabled\"]?.jsonPrimitive?.booleanOrNull\n val checked = request.arguments[\"checked\"]?.jsonPrimitive?.booleanOrNull\n val focused = request.arguments[\"focused\"]?.jsonPrimitive?.booleanOrNull\n val selected = request.arguments[\"selected\"]?.jsonPrimitive?.booleanOrNull\n \n if (deviceId == null) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"device_id is required\")),\n isError = true\n )\n }\n \n // Validate that at least one selector is provided\n if (text == null && id == null) {\n return@RegisteredTool CallToolResult(\n content = listOf(TextContent(\"Either 'text' or 'id' parameter must be provided\")),\n isError = true\n )\n }\n \n val result = sessionManager.newSession(\n host = null,\n port = null,\n driverHostPort = null,\n deviceId = deviceId,\n platform = null\n ) { session ->\n // Escape special regex characters to prevent regex injection issues\n fun escapeRegex(input: String): String {\n return input.replace(Regex(\"[()\\\\[\\\\]{}+*?^$|.\\\\\\\\]\")) { \"\\\\${it.value}\" }\n }\n \n val elementSelector = ElementSelector(\n textRegex = if (useFuzzyMatching && text != null) \".*${escapeRegex(text)}.*\" else text,\n idRegex = if (useFuzzyMatching && id != null) \".*${escapeRegex(id)}.*\" else id,\n index = index?.toString(),\n enabled = enabled,\n checked = checked,\n focused = focused,\n selected = selected\n )\n \n val command = TapOnElementCommand(\n selector = elementSelector,\n retryIfNoChange = true,\n waitUntilVisible = true\n )\n \n val orchestra = Orchestra(session.maestro)\n runBlocking {\n orchestra.runFlow(listOf(MaestroCommand(command = command)))\n }\n \n buildJsonObject {\n put(\"success\", true)\n put(\"device_id\", deviceId)\n put(\"message\", \"Tap executed successfully\")\n }.toString()\n }\n \n CallToolResult(content = listOf(TextContent(result)))\n } catch (e: Exception) {\n CallToolResult(\n content = listOf(TextContent(\"Failed to tap element: ${e.message}\")),\n isError = true\n )\n }\n }\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/mcp/tools/ViewHierarchyFormatters.kt", "content": "package maestro.cli.mcp.tools\n\nimport com.fasterxml.jackson.annotation.JsonInclude\nimport com.fasterxml.jackson.module.kotlin.jacksonObjectMapper\nimport com.fasterxml.jackson.dataformat.yaml.YAMLMapper\nimport maestro.TreeNode\n\n/**\n * Various formatters for view hierarchy output.\n * Preserves different approaches for potential future use.\n */\nobject ViewHierarchyFormatters {\n \n /**\n * Original CSV format - matches PrintHierarchyCommand.kt exactly\n */\n fun extractCsvOutput(node: TreeNode?): String {\n if (node == null) return \"element_num,depth,bounds,attributes,parent_num\\n\"\n \n val csv = StringBuilder()\n csv.appendLine(\"element_num,depth,bounds,attributes,parent_num\")\n \n val nodeToId = mutableMapOf()\n \n // Assign IDs to each node\n var counter = 0\n node.aggregate().forEach { treeNode ->\n nodeToId[treeNode] = counter++\n }\n \n // Process tree recursively to generate CSV\n processTreeToCSV(node, 0, null, nodeToId, csv)\n \n return csv.toString()\n }\n \n private fun processTreeToCSV(\n node: TreeNode?, \n depth: Int, \n parentId: Int?, \n nodeToId: Map,\n csv: StringBuilder\n ) {\n if (node == null) return\n \n val nodeId = nodeToId[node] ?: return\n \n // Extract bounds as separate column\n val bounds = node.attributes[\"bounds\"] ?: \"\"\n val quotedBounds = if (bounds.isNotEmpty()) \"\\\"$bounds\\\"\" else \"\"\n \n // Build attributes string (exclude bounds since it's now a separate column)\n val attributesList = mutableListOf()\n \n // Add normal attributes (skip boolean properties and bounds that are handled separately)\n val excludedProperties = setOf(\"clickable\", \"enabled\", \"focused\", \"checked\", \"selected\", \"bounds\")\n node.attributes.forEach { (key, value) ->\n if (value.isNotEmpty() && value != \"false\" && !excludedProperties.contains(key)) {\n attributesList.add(\"$key=$value\")\n }\n }\n \n // Add boolean properties if true\n if (node.clickable == true) attributesList.add(\"clickable=true\")\n if (node.enabled == true) attributesList.add(\"enabled=true\")\n if (node.focused == true) attributesList.add(\"focused=true\")\n if (node.checked == true) attributesList.add(\"checked=true\")\n if (node.selected == true) attributesList.add(\"selected=true\")\n \n // Join all attributes with \"; \"\n val attributesString = attributesList.joinToString(\"; \")\n \n // Escape quotes in the attributes string if needed\n val escapedAttributes = attributesString.replace(\"\\\"\", \"\\\"\\\"\")\n \n // Add this node to CSV\n csv.append(\"$nodeId,$depth,$quotedBounds,\\\"$escapedAttributes\\\",${parentId ?: \"\"}\\n\")\n \n // Process children\n node.children.forEach { child ->\n processTreeToCSV(child, depth + 1, nodeId, nodeToId, csv)\n }\n }\n \n /**\n * Compact CSV format with filtering and abbreviated columns\n * \n * Example output:\n * id,depth,bounds,text,resource_id,accessibility,hint,class,value,scrollable,clickable,enabled,focused,selected,checked,parent_id\n * 0,0,\"[9,22][402,874]\",,,\"Demo App\",,,,,1,,,,,\n * 1,1,\"[63,93][347,128]\",,,\"Flutter Demo Home Page\",,,,,1,,,,,0\n * 2,1,\"[131,139][279,187]\",,,\"Defects Test\",,,,,1,,,,,0\n * 3,1,\"[330,768][386,824]\",,\"fabAddIcon\",\"Increment\",,,,,1,,,,,0\n */\n fun extractCompactCsvOutput(node: TreeNode, platform: String): String {\n val csv = StringBuilder()\n csv.appendLine(\"id,depth,bounds,text,resource_id,accessibility,hint,class,value,scrollable,clickable,enabled,focused,selected,checked,parent_id\")\n \n val compactElements = compactTreeData(node, platform)\n val flatElements = mutableListOf, Int>>() // element, depth\n \n // Flatten the nested structure while preserving depth\n fun flattenElements(elements: List>, depth: Int) {\n elements.forEach { element ->\n flatElements.add(element to depth)\n @Suppress(\"UNCHECKED_CAST\")\n val children = element[\"c\"] as? List>\n if (children != null) {\n flattenElements(children, depth + 1)\n }\n }\n }\n \n flattenElements(compactElements, 0)\n \n // Build CSV rows\n flatElements.forEachIndexed { index, (element, depth) ->\n val bounds = element[\"b\"] as? String ?: \"\"\n val text = element[\"txt\"] as? String ?: \"\"\n val resourceId = element[\"rid\"] as? String ?: \"\"\n val accessibility = element[\"a11y\"] as? String ?: \"\"\n val hint = element[\"hint\"] as? String ?: \"\"\n val className = element[\"cls\"] as? String ?: \"\"\n val value = element[\"val\"] as? String ?: \"\"\n val scrollable = if (element[\"scroll\"] == true) \"1\" else \"\"\n val clickable = if (element[\"clickable\"] == true) \"1\" else \"\"\n val enabled = if (element[\"enabled\"] == false) \"0\" else \"1\"\n val focused = if (element[\"focused\"] == true) \"1\" else \"\"\n val selected = if (element[\"selected\"] == true) \"1\" else \"\"\n val checked = if (element[\"checked\"] == true) \"1\" else \"\"\n \n // Find parent ID (previous element with lower depth)\n var parentId = \"\"\n for (i in index - 1 downTo 0) {\n if (flatElements[i].second < depth) {\n parentId = i.toString()\n break\n }\n }\n \n // Quote strings only if they have content\n val quotedBounds = quoteIfNotEmpty(bounds)\n val quotedText = quoteIfNotEmpty(text)\n val quotedA11y = quoteIfNotEmpty(accessibility)\n val quotedHint = quoteIfNotEmpty(hint)\n val quotedClass = quoteIfNotEmpty(className)\n val quotedValue = quoteIfNotEmpty(value)\n val quotedRid = quoteIfNotEmpty(resourceId)\n \n csv.append(\"$index,$depth,$quotedBounds,$quotedText,$quotedRid,$quotedA11y,$quotedHint,$quotedClass,$quotedValue,$scrollable,$clickable,$enabled,$focused,$selected,$checked,$parentId\\n\")\n }\n \n return csv.toString()\n }\n \n private fun quoteIfNotEmpty(value: String): String {\n return if (value.isNotEmpty()) {\n \"\\\"${value.replace(\"\\\"\", \"\\\"\\\"\")}\\\"\"\n } else {\n \"\"\n }\n }\n \n /**\n * Compact JSON format with filtering and abbreviated keys\n */\n fun extractCompactJsonOutput(node: TreeNode, platform: String): String {\n val compactData = createCompactWithSchema(node, platform)\n return jacksonObjectMapper()\n .setSerializationInclusion(JsonInclude.Include.NON_NULL)\n .writeValueAsString(compactData)\n }\n \n /**\n * Compact YAML format with filtering and abbreviated keys\n */\n fun extractCompactYamlOutput(node: TreeNode, platform: String): String {\n val yamlMapper = YAMLMapper().setSerializationInclusion(JsonInclude.Include.NON_NULL)\n val result = StringBuilder()\n \n // Get the full data structure\n val compactData = createCompactWithSchema(node, platform)\n \n // Add document separator\n result.appendLine(\"---\")\n \n // Serialize and add ui_schema section with comment\n result.appendLine(\"# Schema definitions - explains abbreviations and default values used in elements\")\n val schemaYaml = yamlMapper.writeValueAsString(mapOf(\"ui_schema\" to compactData[\"ui_schema\"]))\n .removePrefix(\"---\\n\") // Remove extra document separator\n result.append(schemaYaml)\n \n // Serialize and add elements section with comment \n result.appendLine(\"# UI Elements - the actual view hierarchy with abbreviated attribute names\")\n val elementsYaml = yamlMapper.writeValueAsString(mapOf(\"elements\" to compactData[\"elements\"]))\n .removePrefix(\"---\\n\") // Remove extra document separator\n result.append(elementsYaml)\n \n return result.toString()\n }\n \n private fun createCompactWithSchema(node: TreeNode, platform: String): Map {\n val result = mutableMapOf()\n \n // Add platform-specific schema\n result[\"ui_schema\"] = createPlatformSchema(platform)\n \n // Convert the tree to compact structure using existing logic\n result[\"elements\"] = compactTreeData(node, platform)\n \n return result\n }\n \n private fun createPlatformSchema(platform: String): Map {\n return when (platform) {\n \"android\" -> createAndroidSchema()\n \"ios\" -> createIOSSchema()\n else -> createIOSSchema() // Default to iOS if unknown\n }\n }\n \n private fun createAndroidSchema(): Map {\n return mapOf(\n \"platform\" to \"android\",\n \"abbreviations\" to mapOf(\n \"b\" to \"bounds\",\n \"txt\" to \"text\",\n \"rid\" to \"resource-id\",\n \"a11y\" to \"content-desc\",\n \"hint\" to \"hintText\",\n \"cls\" to \"class\",\n \"scroll\" to \"scrollable\",\n \"c\" to \"children\"\n ),\n \"defaults\" to mapOf(\n \"enabled\" to true,\n \"clickable\" to false,\n \"focused\" to false,\n \"selected\" to false,\n \"checked\" to false,\n \"scrollable\" to false,\n \"txt\" to \"\",\n \"hint\" to \"\",\n \"rid\" to \"\",\n \"a11y\" to \"\",\n \"cls\" to \"\"\n )\n )\n }\n \n private fun createIOSSchema(): Map {\n return mapOf(\n \"platform\" to \"ios\",\n \"abbreviations\" to mapOf(\n \"b\" to \"bounds\",\n \"txt\" to \"text\",\n \"rid\" to \"resource-id\",\n \"a11y\" to \"accessibilityText\",\n \"hint\" to \"hintText\",\n \"val\" to \"value\",\n \"c\" to \"children\"\n ),\n \"defaults\" to mapOf(\n \"enabled\" to true,\n \"focused\" to false,\n \"selected\" to false,\n \"checked\" to false,\n \"txt\" to \"\",\n \"hint\" to \"\",\n \"rid\" to \"\",\n \"val\" to \"\",\n \"a11y\" to \"\"\n )\n )\n }\n \n /**\n * Recursively processes the UI tree to create a compact representation by:\n * 1. Filtering out meaningless nodes (zero-size, empty containers)\n * 2. Converting remaining nodes to abbreviated attribute maps\n * 3. Flattening the hierarchy by removing wrapper containers\n */\n private fun compactTreeData(node: TreeNode, platform: String): List> {\n // Skip zero-size elements (invisible/collapsed elements serve no automation purpose)\n if (hasZeroSize(node)) {\n return node.children.flatMap { compactTreeData(it, platform) }\n }\n \n // Skip nodes with no meaningful content (empty containers that only provide structure)\n if (!hasNonDefaultValues(node, platform)) {\n return node.children.flatMap { compactTreeData(it, platform) }\n }\n \n // Process this node - convert to compact representation with abbreviated attributes\n val element = convertToCompactNode(node).toMutableMap()\n \n // Recursively process children with same filtering rules\n val children = node.children.flatMap { compactTreeData(it, platform) }\n \n // Add children array only if there are meaningful child elements\n if (children.isNotEmpty()) {\n element[\"c\"] = children\n }\n \n return listOf(element)\n }\n \n private fun hasZeroSize(node: TreeNode): Boolean {\n val bounds = node.attributes[\"bounds\"] ?: return false\n val boundsPattern = Regex(\"\\\\[(\\\\d+),(\\\\d+)\\\\]\\\\[(\\\\d+),(\\\\d+)\\\\]\")\n val matchResult = boundsPattern.find(bounds) ?: return false\n val (x1, y1, x2, y2) = matchResult.destructured\n val width = x2.toInt() - x1.toInt()\n val height = y2.toInt() - y1.toInt()\n return width == 0 || height == 0\n }\n \n private fun hasNonDefaultValues(node: TreeNode, platform: String): Boolean {\n // Check for non-default boolean states (TreeNode properties)\n if (node.clickable == true) return true\n if (node.checked == true) return true\n if (node.enabled == false) return true // False is non-default\n if (node.focused == true) return true\n if (node.selected == true) return true\n \n // Get platform-specific defaults from schema\n val schema = createPlatformSchema(platform)\n @Suppress(\"UNCHECKED_CAST\")\n val defaults = schema[\"defaults\"] as Map\n \n // Check all attributes against their defaults\n for ((attr, value) in node.attributes) {\n if (value.isNullOrBlank()) continue\n \n val defaultValue = defaults[attr]\n val isNonDefault = when (defaultValue) {\n is String -> value != defaultValue\n is Boolean -> value.toBooleanStrictOrNull() != defaultValue\n is Int -> value.toIntOrNull() != defaultValue\n else -> !value.isNullOrBlank() // For attributes not in defaults, non-blank means meaningful\n }\n if (isNonDefault) return true\n }\n \n return false\n }\n \n /**\n * Converts a TreeNode to a compact map representation by:\n * 1. Inlining attributes directly into the output (no nested \"attributes\" object)\n * 2. Using abbreviated keys (e.g., \"b\" for \"bounds\", \"txt\" for \"text\") \n * 3. Including only non-default values to minimize output size\n * 4. Flattening the structure for easier LLM consumption\n */\n private fun convertToCompactNode(node: TreeNode): Map {\n val result = mutableMapOf()\n \n // Inline attributes with abbreviated keys (only if non-empty)\n val bounds = node.attributes[\"bounds\"]\n if (!bounds.isNullOrBlank()) result[\"b\"] = bounds\n \n val accessibilityText = node.attributes[\"accessibilityText\"]\n if (!accessibilityText.isNullOrBlank()) result[\"a11y\"] = accessibilityText\n \n val text = node.attributes[\"text\"]\n if (!text.isNullOrBlank()) result[\"txt\"] = text\n \n val value = node.attributes[\"value\"]\n if (!value.isNullOrBlank()) result[\"val\"] = value\n \n val resourceId = node.attributes[\"resource-id\"]\n if (!resourceId.isNullOrBlank()) result[\"rid\"] = resourceId\n \n val className = node.attributes[\"class\"]\n if (!className.isNullOrBlank()) result[\"cls\"] = className\n \n // For Android, also check content-desc (maps to a11y in schema)\n val contentDesc = node.attributes[\"content-desc\"]\n if (!contentDesc.isNullOrBlank()) result[\"a11y\"] = contentDesc\n \n val hintText = node.attributes[\"hintText\"]\n if (!hintText.isNullOrBlank()) result[\"hint\"] = hintText\n \n val scrollable = node.attributes[\"scrollable\"]\n if (scrollable == \"true\") result[\"scroll\"] = true\n \n // Inline TreeNode boolean properties (only if non-default)\n if (node.clickable == true) result[\"clickable\"] = true\n if (node.checked == true) result[\"checked\"] = true\n if (node.enabled == false) result[\"enabled\"] = false // false is non-default\n if (node.focused == true) result[\"focused\"] = true\n if (node.selected == true) result[\"selected\"] = true\n \n return result\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/model/FlowStatus.kt", "content": "package maestro.cli.model\n\nimport maestro.cli.api.UploadStatus\n\nenum class FlowStatus {\n PENDING,\n PREPARING,\n INSTALLING,\n RUNNING,\n SUCCESS,\n ERROR,\n CANCELED,\n STOPPED,\n WARNING;\n\n companion object {\n\n fun from(status: UploadStatus.Status) = when (status) {\n UploadStatus.Status.PENDING -> PENDING\n UploadStatus.Status.PREPARING -> PREPARING\n UploadStatus.Status.INSTALLING -> INSTALLING\n UploadStatus.Status.RUNNING -> RUNNING\n UploadStatus.Status.SUCCESS -> SUCCESS\n UploadStatus.Status.ERROR -> ERROR\n UploadStatus.Status.CANCELED -> CANCELED\n UploadStatus.Status.WARNING -> WARNING\n UploadStatus.Status.STOPPED -> STOPPED\n }\n\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/model/RunningFlow.kt", "content": "package maestro.cli.model\n\nimport kotlin.time.Duration\n\ndata class RunningFlows(\n val flows: List,\n val duration: Duration?,\n val startTime: Long?\n)\n\ndata class RunningFlow(\n val name: String,\n val status: FlowStatus,\n val duration: Duration? = null,\n val startTime: Long? = null,\n val reported: Boolean = false\n)\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/model/TestExecutionSummary.kt", "content": "package maestro.cli.model\n\nimport kotlin.time.Duration\n\n// TODO: Some properties should be implemented as getters, but it's not possible.\n// See https://github.com/Kotlin/kotlinx.serialization/issues/805\ndata class TestExecutionSummary(\n val passed: Boolean,\n val suites: List,\n val passedCount: Int? = null,\n val totalTests: Int? = null,\n) {\n\n data class SuiteResult(\n val passed: Boolean,\n val flows: List,\n val duration: Duration? = null,\n val startTime: Long? = null,\n val deviceName: String? = null,\n ) {\n fun failures(): List = flows.filter { it.status == FlowStatus.ERROR }\n }\n\n data class FlowResult(\n val name: String,\n val fileName: String?,\n val status: FlowStatus,\n val failure: Failure? = null,\n val duration: Duration? = null,\n val startTime: Long? = null,\n val properties: Map? = null,\n val tags: List? = null,\n val steps: List = emptyList(),\n )\n\n data class StepResult(\n val description: String,\n val status: String,\n val duration: String,\n )\n\n data class Failure(\n val message: String,\n )\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/promotion/PromotionStateManager.kt", "content": "package maestro.cli.promotion\n\nimport com.fasterxml.jackson.annotation.JsonIgnoreProperties\nimport com.fasterxml.jackson.databind.SerializationFeature\nimport com.fasterxml.jackson.datatype.jsr310.JavaTimeModule\nimport com.fasterxml.jackson.module.kotlin.jacksonObjectMapper\nimport com.fasterxml.jackson.module.kotlin.readValue\nimport maestro.cli.util.EnvUtils\nimport java.nio.file.Path\nimport java.time.LocalDate\nimport java.time.temporal.ChronoUnit\nimport kotlin.io.path.exists\nimport kotlin.io.path.readText\nimport kotlin.io.path.writeText\n\n@JsonIgnoreProperties(ignoreUnknown = true)\ndata class PromotionState(\n val fasterResultsLastShown: String? = null,\n val debugLastShown: String? = null,\n val cloudCommandLastUsed: String? = null\n)\n\n/**\n * Manages promotion message state persistence.\n * Similar to AnalyticsStateManager, stores all promotion states in a single JSON file.\n */\nclass PromotionStateManager {\n private val promotionStatePath: Path = EnvUtils.xdgStateHome().resolve(\"promotion-state.json\")\n \n private val JSON = jacksonObjectMapper().apply {\n registerModule(JavaTimeModule())\n enable(SerializationFeature.INDENT_OUTPUT)\n }\n\n private var _promotionState: PromotionState? = null\n\n private fun getState(): PromotionState {\n if (_promotionState == null) {\n _promotionState = loadState()\n }\n return _promotionState!!\n }\n\n fun getLastShownDate(key: String): String? {\n return when (key) {\n \"fasterResults\" -> getState().fasterResultsLastShown\n \"debug\" -> getState().debugLastShown\n else -> null\n }\n }\n\n fun setLastShownDate(key: String, date: String) {\n val currentState = getState()\n val updatedState = when (key) {\n \"fasterResults\" -> currentState.copy(fasterResultsLastShown = date)\n \"debug\" -> currentState.copy(debugLastShown = date)\n else -> currentState\n }\n saveState(updatedState)\n }\n\n fun recordCloudCommandUsage() {\n val today = LocalDate.now().toString()\n val currentState = getState()\n saveState(currentState.copy(cloudCommandLastUsed = today))\n }\n\n fun wasCloudCommandUsedWithinDays(days: Int): Boolean {\n val lastUsed = getState().cloudCommandLastUsed ?: return false\n val lastUsedDate = try {\n LocalDate.parse(lastUsed)\n } catch (e: Exception) {\n return false\n }\n val today = LocalDate.now()\n val daysSince = ChronoUnit.DAYS.between(lastUsedDate, today)\n return daysSince < days\n }\n\n private fun saveState(state: PromotionState) {\n val stateJson = JSON.writeValueAsString(state)\n promotionStatePath.parent.toFile().mkdirs()\n promotionStatePath.writeText(stateJson + \"\\n\")\n _promotionState = state\n }\n\n private fun loadState(): PromotionState {\n return try {\n if (promotionStatePath.exists()) {\n JSON.readValue(promotionStatePath.readText())\n } else {\n PromotionState()\n }\n } catch (e: Exception) {\n PromotionState()\n }\n }\n}\n\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/report/HtmlAITestSuiteReporter.kt", "content": "package maestro.cli.report\n\nimport kotlinx.html.a\nimport kotlinx.html.body\nimport kotlinx.html.button\nimport kotlinx.html.div\nimport kotlinx.html.h1\nimport kotlinx.html.head\nimport kotlinx.html.html\nimport kotlinx.html.img\nimport kotlinx.html.lang\nimport kotlinx.html.main\nimport kotlinx.html.meta\nimport kotlinx.html.p\nimport kotlinx.html.script\nimport kotlinx.html.span\nimport kotlinx.html.stream.appendHTML\nimport kotlinx.html.style\nimport kotlinx.html.title\nimport kotlinx.html.unsafe\nimport readResourceAsText\nimport java.io.File\n\n// TODO(bartekpacia): Ideally, AI output would be in the same HTML file as \"normal test output\". There is no inherent reason\n// to split those 2 streams of output (\"normal\" and \"AI\") into 2 separate HTML files.\n// See issue #1973\nclass HtmlAITestSuiteReporter {\n\n private val FlowAIOutput.htmlReportFilename\n get() = \"ai-report-${flowName}.html\"\n\n private val reportCss: String\n get() = readResourceAsText(this::class, \"/ai_report.css\")\n\n private val reportJs: String\n get() = readResourceAsText(this::class, \"/tailwind.config.js\")\n\n /**\n * Creates HTML files in [outputDestination] for each flow in [outputs].\n */\n fun report(outputs: List, outputDestination: File) {\n if (!outputDestination.isDirectory) throw IllegalArgumentException(\"Output destination must be a directory\")\n\n outputs.forEachIndexed { index, output ->\n val htmlContent = buildHtmlReport(outputs, index)\n val file = File(outputDestination, output.htmlReportFilename)\n file.writeText(htmlContent)\n }\n }\n\n /**\n * Build HTML report for a single flow.\n *\n * Information about other flows is needed to generate links to them.\n */\n private fun buildHtmlReport(outputs: List, index: Int): String {\n val summary = outputs[index]\n\n return buildString {\n appendLine(\"\")\n appendHTML().html {\n lang = \"en\"\n\n head {\n meta { charset = \"UTF-8\" }\n meta { name = \"viewport\"; content = \"width=device-width, initial-scale=1.0\" }\n title { +\"Maestro Test Report\" }\n script { src = \"https://cdn.tailwindcss.com/3.4.5\" }\n\n script {\n unsafe { +reportJs }\n }\n\n style(type = \"text/tailwindcss\") { +reportCss }\n }\n\n body {\n div(classes = \"flex min-h-screen flex-col\") {\n\n // Header area\n div(classes = \"container mx-auto py-6 space-y-2\") {\n h1(classes = \"text-3xl\") {\n +\"AI suggestions for flow \"\n span(classes = \"text-gray-medium\") {\n +summary.flowName\n }\n }\n\n // File chooser for different reports\n div(classes = \"group relative inline-block self-start\") {\n button(classes = \"btn\") { +\"โ†’ Open other report\" }\n div(classes = \"absolute z-10 hidden min-w-32 group-hover:block\") {\n outputs.forEachIndexed { outputIndex, outputFlow ->\n val selected = outputIndex == index\n\n a(classes = buildString {\n append(\"toggle-link\")\n\n if (selected) append(\" toggle-link-selected\")\n } ) {\n href = \"./\" + outputs[outputIndex].htmlReportFilename\n val name = outputFlow.flowFile.nameWithoutExtension\n +\"(${outputIndex + 1}) $name\"\n }\n }\n }\n }\n\n // Link to the flow file\n // FIXME(bartekpacia): This path will be broken when moved across machines\n p {\n a(\n classes = \"btn\", href = summary.flowFile.absolutePath\n ) {\n +\"โ†’ Open flow file ( ${summary.flowFile.name} )\"\n }\n }\n }\n\n // Container for list of screenshots\n main(classes = \"container mx-auto flex flex-col gap-4\") {\n // Overall defect count for the flow\n p(classes = \"text-lg\") {\n val word = if (summary.defectCount == 1) \"defect\" else \"defects\"\n +\"${summary.defectCount} possible $word found\"\n }\n\n // List of screenshots within flow with defects founds\n summary.screenOutputs.forEachIndexed { screenIndex, screenSummary ->\n div(classes = \"screen-card\") {\n img(classes = \"screenshot-image\") {\n alt = \"Screenshot of the defect\"\n // Use relative path, so when file is moved across machines, it still works\n src = screenSummary.screenshotPath.name.toString()\n }\n\n // defect-card-container\n div(classes = \"flex flex-col gap-4 flex-grow\") {\n // Defect count for the screen\n p(classes = \"text-lg\") {\n val word = if (screenSummary.defects.size == 1) \"defect\" else \"defects\"\n +\"${screenSummary.defects.size} possible $word\"\n }\n\n screenSummary.defects.forEachIndexed { i, defect ->\n div(classes = \"defect-card\") {\n p { +defect.reasoning }\n div(classes = \"badge\") { +defect.category }\n }\n }\n }\n }\n\n if (screenIndex != summary.screenOutputs.size - 1) {\n div(classes = \"divider\")\n }\n }\n }\n }\n }\n }\n }\n }\n\n private val FlowAIOutput.defectCount: Int\n get() = screenOutputs.flatMap { it.defects }.size\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/report/HtmlInsightsAnalysisReporter.kt", "content": "package maestro.cli.report\n\nimport java.nio.file.Files\nimport java.nio.file.Path\n\nclass HtmlInsightsAnalysisReporter {\n\n fun report(\n html: String,\n outputDestination: Path\n ): Path {\n if (!Files.isDirectory(outputDestination)) {\n throw IllegalArgumentException(\"Output destination must be a directory\")\n }\n\n val fileName = \"insights-report.html\"\n val filePath = outputDestination.resolve(fileName)\n\n Files.write(filePath, html.toByteArray())\n\n return filePath\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/report/HtmlTestSuiteReporter.kt", "content": "package maestro.cli.report\n\nimport kotlinx.html.*\nimport kotlinx.html.stream.appendHTML\nimport maestro.cli.model.TestExecutionSummary\nimport okio.Sink\nimport okio.buffer\n\nclass HtmlTestSuiteReporter(private val detailed: Boolean = false) : TestSuiteReporter {\n\n companion object {\n private fun loadPrettyCss(): String {\n return HtmlTestSuiteReporter::class.java\n .getResourceAsStream(\"/html-detailed.css\")\n ?.bufferedReader()\n ?.use { it.readText() }\n ?: \"\"\n }\n }\n\n override fun report(summary: TestExecutionSummary, out: Sink) {\n val bufferedOut = out.buffer()\n val htmlContent = buildHtmlReport(summary)\n bufferedOut.writeUtf8(htmlContent)\n bufferedOut.close()\n }\n\n private fun buildHtmlReport(summary: TestExecutionSummary): String {\n\n return buildString {\n appendHTML().html {\n head {\n title { +\"Maestro Test Report\" }\n link(\n rel = \"stylesheet\",\n href = \"https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css\"\n ) {}\n }\n body {\n summary.suites.forEach { suite ->\n val failedTests = suite.failures()\n div(classes = \"card mb-4\") {\n div(classes = \"card-body\") {\n h1(classes = \"mt-5 text-center\") { +\"Flow Execution Summary\" }\n br {}\n +\"Test Result: ${if (suite.passed) \"PASSED\" else \"FAILED\"}\"\n br {}\n +\"Duration: ${suite.duration}\"\n br {}\n +\"Start Time: ${suite.startTime?.let { millisToCurrentLocalDateTime(it) }}\"\n br {}\n br {}\n div(classes = \"card-group mb-4\") {\n div(classes = \"card\") {\n div(classes = \"card-body\") {\n h5(classes = \"card-title text-center\") { +\"Total number of Flows\" }\n h3(classes = \"card-text text-center\") { +\"${suite.flows.size}\" }\n }\n }\n div(classes = \"card text-white bg-danger\") {\n div(classes = \"card-body\") {\n h5(classes = \"card-title text-center\") { +\"Failed Flows\" }\n h3(classes = \"card-text text-center\") { +\"${failedTests.size}\" }\n }\n }\n div(classes = \"card text-white bg-success\") {\n div(classes = \"card-body\") {\n h5(classes = \"card-title text-center\") { +\"Successful Flows\" }\n h3(classes = \"card-text text-center\") { +\"${suite.flows.size - failedTests.size}\" }\n }\n }\n }\n if (failedTests.isNotEmpty()) {\n div(classes = \"card border-danger mb-3\") {\n div(classes = \"card-body text-danger\") {\n b { +\"Failed Flow\" }\n br {}\n p(classes = \"card-text\") {\n failedTests.forEach { test ->\n +test.name\n br {}\n }\n }\n }\n }\n }\n suite.flows.forEachIndexed { index, flow ->\n val buttonClass =\n if (flow.status.toString() == \"ERROR\") \"btn btn-danger\" else \"btn btn-success\"\n // Create a valid HTML ID by sanitizing the flow name\n val flowId = \"flow-$index-${flow.name.replace(Regex(\"[^a-zA-Z0-9_-]\"), \"-\")}\"\n div(classes = \"card mb-4\") {\n div(classes = \"card-header\") {\n h5(classes = \"mb-0\") {\n button(classes = buttonClass) {\n attributes[\"type\"] = \"button\"\n attributes[\"data-bs-toggle\"] = \"collapse\"\n attributes[\"data-bs-target\"] = \"#$flowId\"\n attributes[\"aria-expanded\"] = \"false\"\n attributes[\"aria-controls\"] = flowId\n +\"${flow.name} : ${flow.status}\"\n }\n }\n }\n div(classes = \"collapse\") {\n id = flowId\n div(classes = \"card-body\") {\n p(classes = \"card-text\") {\n +\"Status: ${flow.status}\"\n br {}\n +\"Duration: ${flow.duration}\"\n br {}\n +\"Start Time: ${\n flow.startTime?.let {\n millisToCurrentLocalDateTime(\n it\n )\n }\n }\"\n br {}\n if (flow.fileName != null) {\n +\"File Name: ${flow.fileName}\"\n br {}\n }\n \n // Display tags if present\n if (!flow.tags.isNullOrEmpty()) {\n +\"Tags: \"\n flow.tags.forEach { tag ->\n span(classes = \"badge bg-primary me-1\") {\n +tag\n }\n }\n br {}\n }\n }\n \n // Display properties if present\n if (!flow.properties.isNullOrEmpty()) {\n h6(classes = \"mt-3 mb-2\") { +\"Properties\" }\n div(classes = \"table-responsive\") {\n table(classes = \"table table-sm table-bordered\") {\n thead {\n tr {\n th { +\"Property\" }\n th { +\"Value\" }\n }\n }\n tbody {\n flow.properties.forEach { (key, value) ->\n tr {\n td { +key }\n td { +value }\n }\n }\n }\n }\n }\n }\n \n if (flow.failure != null) {\n p(classes = \"card-text text-danger\") {\n +flow.failure.message\n }\n }\n\n // Show detailed steps when detailed mode is enabled\n if (detailed && flow.steps.isNotEmpty()) {\n h6(classes = \"mt-3 mb-3\") { +\"Test Steps (${flow.steps.size})\" }\n\n flow.steps.forEach { step ->\n val statusIcon = when (step.status) {\n \"COMPLETED\" -> \"โœ…\"\n \"WARNED\" -> \"โš ๏ธ\"\n \"FAILED\" -> \"โŒ\"\n \"SKIPPED\" -> \"โญ๏ธ\"\n else -> \"โšช\"\n }\n\n div(classes = \"step-item mb-2\") {\n div(classes = \"step-header d-flex justify-content-between align-items-center\") {\n span {\n +\"$statusIcon \"\n span(classes = \"step-name\") { +step.description }\n }\n span(classes = \"badge bg-light text-dark\") {\n +step.duration\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n // Add styling for step items when detailed mode is enabled\n if (detailed) {\n style {\n unsafe {\n +loadPrettyCss()\n }\n }\n }\n script(\n src = \"https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.min.js\",\n content = \"\"\n )\n }\n }\n }\n }\n }\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/report/JUnitTestSuiteReporter.kt", "content": "package maestro.cli.report\n\nimport com.fasterxml.jackson.annotation.JsonInclude\nimport com.fasterxml.jackson.annotation.JsonProperty\nimport com.fasterxml.jackson.databind.ObjectMapper\nimport com.fasterxml.jackson.dataformat.xml.XmlMapper\nimport com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper\nimport com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty\nimport com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement\nimport com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlText\nimport com.fasterxml.jackson.dataformat.xml.ser.ToXmlGenerator\nimport com.fasterxml.jackson.module.kotlin.KotlinModule\nimport maestro.cli.model.FlowStatus\nimport maestro.cli.model.TestExecutionSummary\nimport okio.Sink\nimport okio.buffer\nimport kotlin.time.DurationUnit\n\nclass JUnitTestSuiteReporter(\n private val mapper: ObjectMapper,\n private val testSuiteName: String?\n) : TestSuiteReporter {\n\n private fun suiteResultToTestSuite(suite: TestExecutionSummary.SuiteResult) = TestSuite(\n name = testSuiteName ?: \"Test Suite\",\n device = suite.deviceName,\n failures = suite.failures().size,\n time = suite.duration?.toDouble(DurationUnit.SECONDS)?.toString(),\n timestamp = suite.startTime?.let { millisToCurrentLocalDateTime(it) },\n tests = suite.flows.size,\n testCases = suite.flows\n .map { flow ->\n // Combine flow properties and tags into a single properties list\n val allProperties = mutableListOf()\n \n // Add custom properties\n flow.properties?.forEach { (key, value) ->\n allProperties.add(TestCaseProperty(key, value))\n }\n \n // Add tags as a comma-separated property\n flow.tags?.takeIf { it.isNotEmpty() }?.let { tags ->\n allProperties.add(TestCaseProperty(\"tags\", tags.joinToString(\", \")))\n }\n \n TestCase(\n id = flow.name,\n name = flow.name,\n classname = flow.name,\n failure = flow.failure?.let { failure ->\n Failure(\n message = failure.message,\n )\n },\n time = flow.duration?.toDouble(DurationUnit.SECONDS)?.toString(),\n timestamp = flow.startTime?.let { millisToCurrentLocalDateTime(it) },\n status = flow.status,\n properties = allProperties.takeIf { it.isNotEmpty() }\n )\n }\n )\n\n\n override fun report(\n summary: TestExecutionSummary,\n out: Sink\n ) {\n mapper\n .writerWithDefaultPrettyPrinter()\n .writeValue(\n out.buffer().outputStream(),\n TestSuites(\n suites = summary\n .suites\n .map { suiteResultToTestSuite(it) }\n )\n )\n }\n\n @JacksonXmlRootElement(localName = \"testsuites\")\n private data class TestSuites(\n @JacksonXmlElementWrapper(useWrapping = false)\n @JsonProperty(\"testsuite\")\n val suites: List,\n )\n\n @JacksonXmlRootElement(localName = \"testsuite\")\n private data class TestSuite(\n @JacksonXmlProperty(isAttribute = true) val name: String,\n @JacksonXmlProperty(isAttribute = true) val device: String?,\n @JacksonXmlProperty(isAttribute = true) val tests: Int,\n @JacksonXmlProperty(isAttribute = true) val failures: Int,\n @JacksonXmlProperty(isAttribute = true) val time: String? = null,\n @JacksonXmlProperty(isAttribute = true) val timestamp: String? = null,\n @JacksonXmlElementWrapper(useWrapping = false)\n @JsonProperty(\"testcase\")\n val testCases: List,\n )\n\n private data class TestCase(\n @JacksonXmlProperty(isAttribute = true) val id: String,\n @JacksonXmlProperty(isAttribute = true) val name: String,\n @JacksonXmlProperty(isAttribute = true) val classname: String,\n @JacksonXmlProperty(isAttribute = true) val time: String? = null,\n @JacksonXmlProperty(isAttribute = true) val timestamp: String? = null,\n @JacksonXmlProperty(isAttribute = true) val status: FlowStatus,\n @JacksonXmlElementWrapper(localName = \"properties\")\n @JacksonXmlProperty(localName = \"property\")\n val properties: List? = null,\n val failure: Failure? = null,\n )\n\n private data class Failure(\n @JacksonXmlText val message: String,\n )\n\n private data class TestCaseProperty(\n @JacksonXmlProperty(isAttribute = true) val name: String,\n @JacksonXmlProperty(isAttribute = true) val value: String,\n )\n\n companion object {\n\n fun xml(testSuiteName: String? = null) = JUnitTestSuiteReporter(\n mapper = XmlMapper().apply {\n registerModule(KotlinModule.Builder().build())\n setSerializationInclusion(JsonInclude.Include.NON_NULL)\n configure(ToXmlGenerator.Feature.WRITE_XML_DECLARATION, true)\n },\n testSuiteName = testSuiteName\n )\n\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/report/ReportFormat.kt", "content": "package maestro.cli.report\n\nimport picocli.CommandLine\n\nenum class ReportFormat(\n val fileExtension: String?,\n private val displayName: String? = null\n) {\n\n JUNIT(\".xml\"),\n HTML(\".html\"),\n HTML_DETAILED(\".html\", \"HTML-DETAILED\"),\n NOOP(null);\n\n override fun toString(): String {\n return displayName ?: name\n }\n\n class Converter : CommandLine.ITypeConverter {\n override fun convert(value: String): ReportFormat {\n // Try to match by display name first, then by enum name\n return values().find {\n it.toString().equals(value, ignoreCase = true) ||\n it.name.equals(value, ignoreCase = true)\n } ?: throw IllegalArgumentException(\"Invalid format: $value. Valid options are: ${values().joinToString()}\")\n }\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/report/ReporterFactory.kt", "content": "package maestro.cli.report\n\nimport maestro.cli.model.TestExecutionSummary\nimport okio.BufferedSink\n\nobject ReporterFactory {\n\n fun buildReporter(format: ReportFormat, testSuiteName: String?): TestSuiteReporter {\n return when (format) {\n ReportFormat.JUNIT -> JUnitTestSuiteReporter.xml(testSuiteName)\n ReportFormat.NOOP -> TestSuiteReporter.NOOP\n ReportFormat.HTML -> HtmlTestSuiteReporter(detailed = false)\n ReportFormat.HTML_DETAILED -> HtmlTestSuiteReporter(detailed = true)\n }\n }\n\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/report/TestDebugReporter.kt", "content": "package maestro.cli.report\n\nimport com.fasterxml.jackson.annotation.JsonInclude\nimport com.fasterxml.jackson.annotation.JsonProperty\nimport com.fasterxml.jackson.databind.JsonMappingException\nimport com.fasterxml.jackson.module.kotlin.jacksonObjectMapper\nimport maestro.MaestroException\nimport maestro.TreeNode\nimport maestro.ai.cloud.Defect\nimport maestro.cli.runner.CommandStatus\nimport maestro.cli.util.CiUtils\nimport maestro.cli.util.EnvUtils\nimport maestro.cli.util.IOSEnvUtils\nimport maestro.debuglog.DebugLogStore\nimport maestro.debuglog.LogConfig\nimport maestro.orchestra.MaestroCommand\nimport org.apache.logging.log4j.Level\nimport org.apache.logging.log4j.LogManager\nimport org.apache.logging.log4j.core.LoggerContext\nimport org.apache.logging.log4j.core.config.Configurator\nimport org.slf4j.Logger\nimport org.slf4j.LoggerFactory\nimport java.io.File\nimport java.nio.file.Files\nimport java.nio.file.Path\nimport java.nio.file.Paths\nimport java.nio.file.attribute.FileTime\nimport java.time.Duration\nimport java.time.Instant\nimport java.time.LocalDateTime\nimport java.time.format.DateTimeFormatter\nimport java.time.temporal.ChronoUnit\nimport java.util.*\nimport kotlin.io.path.absolutePathString\nimport kotlin.io.path.exists\nimport kotlin.math.log\n\n\n// TODO(bartekpacia): Rename to TestOutputReporter, because it's not only for \"debug\" stuff\nobject TestDebugReporter {\n\n private val logger = LogManager.getLogger(TestDebugReporter::class.java)\n private val mapper = jacksonObjectMapper().setSerializationInclusion(JsonInclude.Include.NON_NULL)\n .setSerializationInclusion(JsonInclude.Include.NON_EMPTY).writerWithDefaultPrettyPrinter()\n\n private var debugOutputPath: Path? = null\n private var debugOutputPathAsString: String? = null\n private var flattenDebugOutput: Boolean = false\n private var testOutputDir: Path? = null\n\n // AI outputs must be saved separately at the end of the flow.\n fun saveSuggestions(outputs: List, path: Path) {\n // This mutates the output.\n outputs.forEach { output ->\n // Write AI screenshots. Paths need to be changed to the final ones.\n val updatedOutputs = output.screenOutputs.map { newOutput ->\n val screenshotFilename = newOutput.screenshotPath.name\n val screenshotFile = File(path.absolutePathString(), screenshotFilename)\n newOutput.screenshotPath.copyTo(screenshotFile)\n newOutput.copy(screenshotPath = screenshotFile)\n }\n\n output.screenOutputs.clear()\n output.screenOutputs.addAll(updatedOutputs)\n\n // Write AI JSON output\n val jsonFilename = \"ai-(${output.flowName.replace(\"/\", \"_\")}).json\"\n val jsonFile = File(path.absolutePathString(), jsonFilename)\n mapper.writeValue(jsonFile, output)\n }\n\n HtmlAITestSuiteReporter().report(outputs, path.toFile())\n }\n\n /**\n * Save debug information about a single flow, after it has finished.\n */\n fun saveFlow(flowName: String, debugOutput: FlowDebugOutput, path: Path, shardIndex: Int? = null) {\n // TODO(bartekpacia): Potentially accept a single \"FlowPersistentOutput\" object\n // TODO(bartekpacia: Build output incrementally, instead of single-shot on flow completion\n // Be aware that this goal somewhat conflicts with including links to other flows in the HTML report.\n\n val shardPrefix = shardIndex?.let { \"shard-${it + 1}-\" }.orEmpty()\n val shardLogPrefix = shardIndex?.let { \"[shard ${it + 1}] \" }.orEmpty()\n\n // commands\n try {\n val commandMetadata = debugOutput.commands\n if (commandMetadata.isNotEmpty()) {\n val commandsFilename = \"commands-$shardPrefix(${flowName.replace(\"/\", \"_\")}).json\"\n val file = File(path.absolutePathString(), commandsFilename)\n commandMetadata.map {\n CommandDebugWrapper(it.key, it.value)\n }.let {\n mapper.writeValue(file, it)\n }\n }\n } catch (e: JsonMappingException) {\n logger.error(\"${shardLogPrefix}Unable to parse commands\", e)\n }\n\n // screenshots\n debugOutput.screenshots.forEach {\n val status = when (it.status) {\n CommandStatus.COMPLETED -> \"โœ…\"\n CommandStatus.FAILED -> \"โŒ\"\n CommandStatus.WARNED -> \"โš ๏ธ\"\n else -> \"๏น–\"\n }\n val filename = \"screenshot-$shardPrefix$status-${it.timestamp}-(${flowName}).png\"\n val file = File(path.absolutePathString(), filename)\n\n it.screenshot.copyTo(file)\n }\n }\n\n fun deleteOldFiles(days: Long = 14) {\n try {\n val currentTime = Instant.now()\n val daysLimit = currentTime.minus(Duration.of(days, ChronoUnit.DAYS))\n\n val logParentDirectory = getDebugOutputPath().parent\n logger.info(\"Performing purge of logs older than $days days from ${logParentDirectory.absolutePathString()}\")\n\n Files.walk(logParentDirectory).filter {\n val fileTime = Files.getAttribute(it, \"basic:lastModifiedTime\") as FileTime\n val isOlderThanLimit = fileTime.toInstant().isBefore(daysLimit)\n val shouldBeDeleted = Files.isDirectory(it) && isOlderThanLimit\n if (shouldBeDeleted) {\n logger.info(\"Deleting old directory: ${it.absolutePathString()}\")\n }\n shouldBeDeleted\n }.sorted(Comparator.reverseOrder()).forEach { dir ->\n Files.walk(dir).sorted(Comparator.reverseOrder()).forEach { file -> Files.delete(file) }\n }\n } catch (e: Exception) {\n logger.warn(\"Failed to delete older files\", e)\n }\n }\n\n private fun logSystemInfo() {\n logger.info(\"Debug output path: {}\", getDebugOutputPath().absolutePathString())\n\n // Disable specific gRPC and Netty loggers\n Configurator.setLevel(\"io.grpc.netty.NettyClientHandler\", Level.OFF)\n Configurator.setLevel(\"io.grpc.netty\", Level.OFF)\n Configurator.setLevel(\"io.netty\", Level.OFF)\n\n val logger = LogManager.getLogger(\"MAESTRO\")\n logger.info(\"---- System Info ----\")\n logger.info(\"Maestro Version: ${EnvUtils.CLI_VERSION ?: \"Undefined\"}\")\n logger.info(\"CI: ${CiUtils.getCiProvider() ?: \"Undefined\"}\")\n logger.info(\"OS Name: ${EnvUtils.OS_NAME}\")\n logger.info(\"OS Version: ${EnvUtils.OS_VERSION}\")\n logger.info(\"Architecture: ${EnvUtils.OS_ARCH}\")\n logger.info(\"Java Version: ${EnvUtils.getJavaVersion()}\")\n logger.info(\"Xcode Version: ${IOSEnvUtils.xcodeVersion}\")\n logger.info(\"Flutter Version: ${EnvUtils.getFlutterVersionAndChannel().first ?: \"Undefined\"}\")\n logger.info(\"Flutter Channel: ${EnvUtils.getFlutterVersionAndChannel().second ?: \"Undefined\"}\")\n logger.info(\"---------------------\")\n }\n\n /**\n * Calls to this method should be done as soon as possible, to make all\n * loggers use our custom configuration rather than the defaults.\n */\n fun install(debugOutputPathAsString: String? = null, flattenDebugOutput: Boolean = false, printToConsole: Boolean) {\n this.debugOutputPathAsString = debugOutputPathAsString\n this.flattenDebugOutput = flattenDebugOutput\n val path = getDebugOutputPath()\n LogConfig.configure(logFileName = path.absolutePathString() + \"/maestro.log\", printToConsole = printToConsole)\n logSystemInfo()\n DebugLogStore.logSystemInfo()\n }\n\n fun updateTestOutputDir(testOutputDir: Path?) {\n this.testOutputDir = testOutputDir\n // Reset debugOutputPath so getDebugOutputPath() will properly handle directory creation\n debugOutputPath = null\n }\n\n fun getDebugOutputPath(): Path {\n if (debugOutputPath != null) return debugOutputPath as Path\n\n val debugRootPath =\n if (debugOutputPathAsString != null) debugOutputPathAsString!! else System.getProperty(\"user.home\")\n val debugOutput =\n if (flattenDebugOutput) Paths.get(debugRootPath) else buildDefaultDebugOutputPath(debugRootPath)\n\n if (!debugOutput.exists()) {\n Files.createDirectories(debugOutput)\n }\n debugOutputPath = debugOutput\n return debugOutput\n }\n\n private fun buildDefaultDebugOutputPath(debugRootPath: String): Path {\n // If testOutputDir is configured, use it as the base path instead of ~/.maestro/tests\n return if (testOutputDir != null) {\n val foldername = DateTimeFormatter.ofPattern(\"yyyy-MM-dd_HHmmss\").format(LocalDateTime.now())\n testOutputDir!!.resolve(foldername)\n } else {\n val preamble = arrayOf(\".maestro\", \"tests\")\n val foldername = DateTimeFormatter.ofPattern(\"yyyy-MM-dd_HHmmss\").format(LocalDateTime.now())\n Paths.get(debugRootPath, *preamble, foldername)\n }\n }\n}\n\nprivate data class CommandDebugWrapper(\n val command: MaestroCommand, val metadata: CommandDebugMetadata\n)\n\ndata class CommandDebugMetadata(\n var status: CommandStatus? = null,\n var timestamp: Long? = null,\n var duration: Long? = null,\n var error: Throwable? = null,\n var hierarchy: TreeNode? = null,\n var sequenceNumber: Int = 0,\n var evaluatedCommand: MaestroCommand? = null\n) {\n fun calculateDuration() {\n if (timestamp != null) {\n duration = System.currentTimeMillis() - timestamp!!\n }\n }\n}\n\ndata class FlowDebugOutput(\n val commands: IdentityHashMap = IdentityHashMap(),\n val screenshots: MutableList = mutableListOf(),\n var exception: MaestroException? = null,\n) {\n data class Screenshot(\n val screenshot: File,\n val timestamp: Long,\n val status: CommandStatus,\n )\n}\n\ndata class FlowAIOutput(\n @JsonProperty(\"flow_name\") val flowName: String,\n @JsonProperty(\"flow_file_path\") val flowFile: File,\n @JsonProperty(\"outputs\") val screenOutputs: MutableList = mutableListOf(),\n)\n\ndata class SingleScreenFlowAIOutput(\n @JsonProperty(\"screenshot_path\") val screenshotPath: File,\n val defects: List,\n)\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/report/TestSuiteReporter.kt", "content": "package maestro.cli.report\n\nimport maestro.cli.model.TestExecutionSummary\nimport okio.Sink\nimport java.time.Instant\nimport java.time.ZoneId\nimport java.time.format.DateTimeFormatter\n\ninterface TestSuiteReporter {\n\n /**\n * Writes the report for [summary] to [out] in the format specified by the implementation.\n */\n fun report(\n summary: TestExecutionSummary,\n out: Sink,\n )\n\n companion object {\n val NOOP: TestSuiteReporter = object : TestSuiteReporter {\n override fun report(summary: TestExecutionSummary, out: Sink) {\n // no-op\n }\n }\n }\n\n\n /**\n * Judging from https://github.com/testmoapp/junitxml?tab=readme-ov-file#complete-junit-xml-example,\n * the output of timestamp needs to be an ISO 8601 local date time instead of an ISO 8601 offset date\n * time (it would be ideal to use ISO 8601 offset date time it needs to be confirmed if it's valid)\n *\n * Due to having to use LocalDateTime, we need to get the offset from the client (i.e. the machine running\n * maestro-cli) using ZoneId.systemDefault() so we can display the time relative to the client machine\n */\n fun millisToCurrentLocalDateTime(milliseconds: Long): String {\n val localDateTime = Instant.ofEpochMilli(milliseconds).atZone(ZoneId.systemDefault()).toLocalDateTime()\n return localDateTime.format(DateTimeFormatter.ISO_LOCAL_DATE_TIME)\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/runner/CliWatcher.kt", "content": "package maestro.cli.runner\n\nimport java.io.InputStream\nimport java.nio.file.Path\nimport java.util.concurrent.CompletableFuture\nimport java.util.concurrent.Executors\nimport java.util.concurrent.TimeUnit\n\ninternal object CliWatcher {\n\n fun waitForFileChangeOrEnter(fileWatcher: FileWatcher, files: List): SignalType {\n val executor = Executors.newCachedThreadPool()\n\n val fileChangeFuture = CompletableFuture.supplyAsync({\n fileWatcher.waitForChange(files)\n SignalType.FILE_CHANGE\n }, executor)\n\n val enterFuture = CompletableFuture.supplyAsync({\n interruptibleWaitForChar(System.`in`, '\\n')\n SignalType.ENTER\n }, executor)\n\n val signalType = CompletableFuture.anyOf(fileChangeFuture, enterFuture).get() as SignalType\n\n executor.shutdownNow()\n if (!executor.awaitTermination(5, TimeUnit.SECONDS)) {\n throw InterruptedException(\"Timed out waiting for threads to shutdown\")\n }\n\n return signalType\n }\n\n private fun interruptibleWaitForChar(inputStream: InputStream, c: Char) {\n while (true) {\n if (inputStream.available() > 0){\n if (inputStream.read().toChar() == c) {\n return\n }\n } else {\n Thread.sleep(100)\n }\n }\n }\n\n enum class SignalType {\n ENTER, FILE_CHANGE\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/runner/CommandState.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro.cli.runner\n\nimport maestro.orchestra.MaestroCommand\nimport maestro.utils.Insight\n\ndata class CommandState(\n val status: CommandStatus,\n val command: MaestroCommand,\n val subOnStartCommands: List?,\n val subOnCompleteCommands: List?,\n val numberOfRuns: Int? = null,\n val subCommands: List? = null,\n val logMessages: List = emptyList(),\n val insight: Insight = Insight(\"\", Insight.Level.NONE)\n)" }, { "path": "maestro-cli/src/main/java/maestro/cli/runner/CommandStatus.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro.cli.runner\n\nenum class CommandStatus {\n PENDING,\n RUNNING,\n COMPLETED,\n FAILED,\n WARNED,\n SKIPPED,\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/runner/FileWatcher.kt", "content": "package maestro.cli.runner\n\nimport java.nio.file.FileSystems\nimport java.nio.file.Path\nimport java.nio.file.StandardWatchEventKinds\nimport java.nio.file.WatchKey\nimport kotlin.io.path.absolute\n\nclass FileWatcher {\n\n private val watchService = FileSystems.getDefault().newWatchService()\n private val watchKeys = mutableSetOf()\n\n fun waitForChange(files: Iterable) {\n watchKeys.forEach(WatchKey::cancel)\n watchKeys.clear()\n\n val paths = files.map { it.absolute() }\n\n paths.forEach { path ->\n val watchKey = path.parent.register(\n watchService,\n arrayOf(\n StandardWatchEventKinds.ENTRY_CREATE,\n StandardWatchEventKinds.ENTRY_DELETE,\n StandardWatchEventKinds.ENTRY_MODIFY,\n ),\n )\n watchKeys.add(watchKey)\n }\n\n fun isRelevantWatchKey(watchKey: WatchKey): Boolean {\n watchKey.pollEvents().forEach { event ->\n val relativePath = event.context() as Path\n val fullPath = (watchKey.watchable() as Path).resolve(relativePath).toAbsolutePath()\n if (fullPath in paths) return true\n }\n return false\n }\n\n while (true) {\n val watchKey = watchService.take()\n try {\n if (watchKey.isValid) {\n if (isRelevantWatchKey(watchKey)) {\n break\n }\n } else {\n watchKeys.remove(watchKey)\n }\n } finally {\n watchKey.reset()\n }\n }\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/runner/MaestroCommandRunner.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro.cli.runner\n\nimport maestro.Maestro\nimport maestro.MaestroException\nimport maestro.device.Device\nimport maestro.cli.report.SingleScreenFlowAIOutput\nimport maestro.cli.report.CommandDebugMetadata\nimport maestro.cli.report.FlowAIOutput\nimport maestro.cli.report.FlowDebugOutput\nimport maestro.cli.runner.resultview.ResultView\nimport maestro.cli.runner.resultview.UiState\nimport maestro.cli.util.PrintUtils\nimport maestro.orchestra.ApplyConfigurationCommand\nimport maestro.orchestra.CompositeCommand\nimport maestro.orchestra.MaestroCommand\nimport maestro.orchestra.Orchestra\n\nimport maestro.orchestra.yaml.YamlCommandReader\nimport maestro.utils.CliInsights\nimport org.slf4j.LoggerFactory\nimport java.io.File\nimport java.util.IdentityHashMap\nimport maestro.cli.util.ScreenshotUtils\nimport maestro.utils.Insight\nimport java.nio.file.Path\n\n/**\n * Knows how to run a list of Maestro commands and update the UI.\n *\n * Should not know what a \"flow\" is (apart from knowing a name, for display purposes).\n */\nobject MaestroCommandRunner {\n\n private val logger = LoggerFactory.getLogger(MaestroCommandRunner::class.java)\n\n suspend fun runCommands(\n flowName: String,\n maestro: Maestro,\n device: Device?,\n view: ResultView,\n commands: List,\n debugOutput: FlowDebugOutput,\n aiOutput: FlowAIOutput,\n apiKey: String? = null,\n analyze: Boolean = false,\n testOutputDir: Path?\n ): Boolean {\n val config = YamlCommandReader.getConfig(commands)\n val onFlowComplete = config?.onFlowComplete\n val onFlowStart = config?.onFlowStart\n\n val commandStatuses = IdentityHashMap()\n val commandMetadata = IdentityHashMap()\n\n fun refreshUi() {\n view.setState(\n UiState.Running(\n flowName = flowName,\n device = device,\n onFlowStartCommands = toCommandStates(\n onFlowStart?.commands ?: emptyList(),\n commandStatuses,\n commandMetadata\n ),\n onFlowCompleteCommands = toCommandStates(\n onFlowComplete?.commands ?: emptyList(),\n commandStatuses,\n commandMetadata\n ),\n commands = toCommandStates(\n commands,\n commandStatuses,\n commandMetadata\n )\n )\n )\n }\n\n refreshUi()\n\n if (analyze) {\n ScreenshotUtils.takeDebugScreenshotByCommand(maestro, debugOutput, CommandStatus.PENDING)\n }\n\n var commandSequenceNumber = 0\n\n val orchestra = Orchestra(\n maestro = maestro,\n screenshotsDir = testOutputDir?.resolve(\"screenshots\"),\n insights = CliInsights,\n onCommandStart = { _, command ->\n logger.info(\"${command.description()} RUNNING\")\n commandStatuses[command] = CommandStatus.RUNNING\n debugOutput.commands[command] = CommandDebugMetadata(\n timestamp = System.currentTimeMillis(),\n status = CommandStatus.RUNNING,\n sequenceNumber = commandSequenceNumber++\n )\n\n refreshUi()\n },\n onCommandComplete = { _, command ->\n logger.info(\"${command.description()} COMPLETED\")\n commandStatuses[command] = CommandStatus.COMPLETED\n if (analyze) {\n ScreenshotUtils.takeDebugScreenshotByCommand(maestro, debugOutput, CommandStatus.COMPLETED)\n }\n\n debugOutput.commands[command]?.apply {\n status = CommandStatus.COMPLETED\n calculateDuration()\n }\n refreshUi()\n },\n onCommandFailed = { _, command, e ->\n debugOutput.commands[command]?.apply {\n status = CommandStatus.FAILED\n calculateDuration()\n error = e\n }\n\n ScreenshotUtils.takeDebugScreenshot(maestro, debugOutput, CommandStatus.FAILED)\n\n if (e !is MaestroException) {\n throw e\n } else {\n debugOutput.exception = e\n }\n\n logger.info(\"${command.description()} FAILED\")\n commandStatuses[command] = CommandStatus.FAILED\n refreshUi()\n Orchestra.ErrorResolution.FAIL\n },\n onCommandSkipped = { _, command ->\n logger.info(\"${command.description()} SKIPPED\")\n commandStatuses[command] = CommandStatus.SKIPPED\n debugOutput.commands[command]?.apply {\n status = CommandStatus.SKIPPED\n }\n refreshUi()\n },\n onCommandWarned = { _, command ->\n logger.info(\"${command.description()} WARNED\")\n commandStatuses[command] = CommandStatus.WARNED\n debugOutput.commands[command]?.apply {\n status = CommandStatus.WARNED\n }\n\n ScreenshotUtils.takeDebugScreenshot(maestro, debugOutput, CommandStatus.WARNED)\n\n refreshUi()\n },\n onCommandReset = { command ->\n logger.info(\"${command.description()} PENDING\")\n commandStatuses[command] = CommandStatus.PENDING\n debugOutput.commands[command]?.apply {\n status = CommandStatus.PENDING\n }\n refreshUi()\n },\n onCommandMetadataUpdate = { command, metadata ->\n logger.info(\"${command.description()} metadata $metadata\")\n commandMetadata[command] = metadata\n // Update debug output with evaluated command for interpolated labels\n debugOutput.commands[command]?.evaluatedCommand = metadata.evaluatedCommand\n refreshUi()\n },\n onCommandGeneratedOutput = { command, defects, screenshot ->\n logger.info(\"${command.description()} generated output\")\n val screenshotPath = ScreenshotUtils.writeAIscreenshot(screenshot)\n aiOutput.screenOutputs.add(\n SingleScreenFlowAIOutput(\n screenshotPath = screenshotPath,\n defects = defects,\n )\n )\n },\n apiKey = apiKey, \n )\n\n val flowSuccess = orchestra.runFlow(commands)\n\n // Warn users about deprecated Rhino JS engine\n val isRhinoExplicitlyRequested = config?.ext?.get(\"jsEngine\") == \"rhino\"\n if (isRhinoExplicitlyRequested) {\n PrintUtils.warn(\"โš ๏ธ The Rhino JS engine (jsEngine: rhino) is deprecated and will be removed in a future version. Please migrate to GraalJS (the default) for better performance and compatibility. This warning will be removed in a future version.\")\n } \n\n return flowSuccess\n }\n\n private fun toCommandStates(\n commands: List,\n commandStatuses: MutableMap,\n commandMetadata: IdentityHashMap,\n ): List {\n return commands\n // Don't render configuration commands\n .filter { it.asCommand() !is ApplyConfigurationCommand }\n .mapIndexed { _, command ->\n CommandState(\n command = commandMetadata[command]?.evaluatedCommand ?: command,\n subOnStartCommands = (command.asCommand() as? CompositeCommand)\n ?.config()\n ?.onFlowStart\n ?.let { toCommandStates(it.commands, commandStatuses, commandMetadata) },\n subOnCompleteCommands = (command.asCommand() as? CompositeCommand)\n ?.config()\n ?.onFlowComplete\n ?.let { toCommandStates(it.commands, commandStatuses, commandMetadata) },\n status = commandStatuses[command] ?: CommandStatus.PENDING,\n numberOfRuns = commandMetadata[command]?.numberOfRuns,\n subCommands = (command.asCommand() as? CompositeCommand)\n ?.subCommands()\n ?.let { toCommandStates(it, commandStatuses, commandMetadata) },\n logMessages = commandMetadata[command]?.logMessages ?: emptyList(),\n insight = commandMetadata[command]?.insight ?: Insight(\"\", Insight.Level.NONE)\n )\n }\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/runner/TestRunner.kt", "content": "package maestro.cli.runner\n\nimport com.github.michaelbull.result.Err\nimport com.github.michaelbull.result.Ok\nimport com.github.michaelbull.result.Result\nimport com.github.michaelbull.result.get\nimport com.github.michaelbull.result.getOr\nimport com.github.michaelbull.result.onFailure\nimport kotlinx.coroutines.runBlocking\nimport maestro.Maestro\nimport maestro.MaestroException\nimport maestro.device.Device\nimport maestro.cli.report.FlowAIOutput\nimport maestro.cli.report.FlowDebugOutput\nimport maestro.cli.report.TestDebugReporter\nimport maestro.cli.runner.resultview.AnsiResultView\nimport maestro.cli.runner.resultview.ResultView\nimport maestro.cli.runner.resultview.UiState\nimport maestro.cli.util.EnvUtils\nimport maestro.cli.util.PrintUtils\nimport maestro.cli.view.ErrorViewUtils\nimport maestro.orchestra.MaestroCommand\nimport maestro.orchestra.util.Env.withEnv\nimport maestro.orchestra.util.Env.withDefaultEnvVars\nimport maestro.orchestra.util.Env.withInjectedShellEnvVars\nimport maestro.orchestra.yaml.YamlCommandReader\nimport org.slf4j.LoggerFactory\nimport java.io.File\nimport java.nio.file.Path\nimport kotlin.concurrent.thread\n\n/**\n * Knows how to run a single Maestro flow (either one-shot or continuously).\n */\nobject TestRunner {\n\n private val logger = LoggerFactory.getLogger(TestRunner::class.java)\n\n /**\n * Runs a single flow, one-shot style.\n *\n * If the flow generates artifacts, they should be placed in [debugOutputPath].\n */\n fun runSingle(\n maestro: Maestro,\n device: Device?,\n flowFile: File,\n env: Map,\n resultView: ResultView,\n debugOutputPath: Path,\n analyze: Boolean = false,\n apiKey: String? = null,\n testOutputDir: Path?,\n deviceId: String?,\n ): Int {\n val debugOutput = FlowDebugOutput()\n var aiOutput = FlowAIOutput(\n flowName = flowFile.nameWithoutExtension,\n flowFile = flowFile,\n )\n\n val updatedEnv = env\n .withInjectedShellEnvVars()\n .withDefaultEnvVars(flowFile, deviceId)\n\n val result = runCatching(resultView, maestro) {\n val commands = YamlCommandReader.readCommands(flowFile.toPath())\n .withEnv(updatedEnv)\n\n val flowName = YamlCommandReader.getConfig(commands)?.name ?: flowFile.nameWithoutExtension\n aiOutput = aiOutput.copy(flowName = flowName)\n\n logger.info(\"Running flow ${flowFile.name}...\")\n\n runBlocking {\n MaestroCommandRunner.runCommands(\n flowName = flowName,\n maestro = maestro,\n device = device,\n view = resultView,\n commands = commands,\n debugOutput = debugOutput,\n aiOutput = aiOutput,\n analyze = analyze,\n apiKey = apiKey,\n testOutputDir = testOutputDir,\n )\n }\n }\n\n TestDebugReporter.saveFlow(\n flowName = flowFile.name,\n debugOutput = debugOutput,\n path = debugOutputPath,\n )\n TestDebugReporter.saveSuggestions(\n outputs = listOf(aiOutput),\n path = debugOutputPath,\n )\n\n val exception = debugOutput.exception\n if (exception != null) {\n PrintUtils.err(exception.message)\n if (exception is MaestroException.AssertionFailure) {\n PrintUtils.err(exception.debugMessage)\n } else if (exception is MaestroException.HideKeyboardFailure) {\n PrintUtils.err(exception.debugMessage)\n } else {\n val debugMessage = (exception as? MaestroException.DriverTimeout)?.debugMessage\n if (exception is MaestroException.DriverTimeout && debugMessage != null) {\n PrintUtils.err(debugMessage)\n }\n }\n }\n\n return if (result.get() == true) 0 else 1\n }\n\n /**\n * Runs a single flow continuously.\n */\n fun runContinuous(\n maestro: Maestro,\n device: Device?,\n flowFile: File,\n env: Map,\n analyze: Boolean = false,\n apiKey: String? = null,\n testOutputDir: Path?,\n deviceId: String?,\n ): Nothing {\n val resultView = AnsiResultView(\"> Press [ENTER] to restart the Flow\\n\\n\", useEmojis = !EnvUtils.isWindows())\n\n val fileWatcher = FileWatcher()\n\n var previousCommands: List? = null\n\n var ongoingTest: Thread? = null\n do {\n val watchFiles = runCatching(resultView, maestro) {\n ongoingTest?.apply {\n interrupt()\n join()\n }\n\n val updatedEnv = env\n .withInjectedShellEnvVars()\n .withDefaultEnvVars(flowFile, deviceId)\n\n val commands = YamlCommandReader\n .readCommands(flowFile.toPath())\n .withEnv(updatedEnv)\n\n val flowName = YamlCommandReader.getConfig(commands)?.name\n\n // Restart the flow if anything has changed\n if (commands != previousCommands) {\n ongoingTest = thread {\n previousCommands = commands\n\n runCatching(resultView, maestro) {\n runBlocking {\n MaestroCommandRunner.runCommands(\n flowName = flowName ?: flowFile.nameWithoutExtension,\n maestro = maestro,\n device = device,\n view = resultView,\n commands = commands,\n debugOutput = FlowDebugOutput(),\n // TODO(bartekpacia): make AI outputs work in continuous mode (see #1972)\n aiOutput = FlowAIOutput(\n flowName = \"TODO\",\n flowFile = flowFile,\n ),\n analyze = analyze,\n apiKey = apiKey,\n testOutputDir = testOutputDir\n )\n }\n }.get()\n }\n }\n\n YamlCommandReader.getWatchFiles(flowFile.toPath())\n }\n .onFailure {\n previousCommands = null\n }\n .getOr(listOf(flowFile.toPath()))\n\n if (CliWatcher.waitForFileChangeOrEnter(fileWatcher, watchFiles) == CliWatcher.SignalType.ENTER) {\n // On ENTER force re-run of flow even if commands have not changed\n previousCommands = null\n }\n } while (true)\n }\n\n private fun runCatching(\n view: ResultView,\n maestro: Maestro,\n block: () -> T,\n ): Result {\n return try {\n Ok(block())\n } catch (e: Exception) {\n logger.error(\"Failed to run flow\", e)\n val message = ErrorViewUtils.exceptionToMessage(e)\n\n if (!maestro.isShutDown()) {\n view.setState(\n UiState.Error(\n message = message\n )\n )\n }\n return Err(e)\n }\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/runner/TestSuiteInteractor.kt", "content": "package maestro.cli.runner\n\nimport maestro.Maestro\nimport maestro.MaestroException\nimport maestro.cli.CliError\nimport maestro.device.Device\nimport maestro.cli.model.FlowStatus\nimport maestro.cli.model.TestExecutionSummary\nimport maestro.cli.report.SingleScreenFlowAIOutput\nimport maestro.cli.report.CommandDebugMetadata\nimport maestro.cli.report.FlowAIOutput\nimport maestro.cli.report.FlowDebugOutput\nimport maestro.cli.report.TestDebugReporter\nimport maestro.cli.report.TestSuiteReporter\nimport maestro.cli.util.PrintUtils\nimport maestro.cli.util.TimeUtils\nimport maestro.cli.view.ErrorViewUtils\nimport maestro.cli.view.TestSuiteStatusView\nimport maestro.cli.view.TestSuiteStatusView.TestSuiteViewModel\nimport maestro.orchestra.Orchestra\nimport maestro.orchestra.util.Env.withEnv\nimport maestro.orchestra.workspace.WorkspaceExecutionPlanner\nimport maestro.orchestra.yaml.YamlCommandReader\nimport okio.Sink\nimport org.slf4j.LoggerFactory\nimport java.io.File\nimport java.nio.file.Path\nimport kotlin.system.measureTimeMillis\nimport kotlin.time.Duration.Companion.seconds\nimport maestro.cli.util.ScreenshotUtils\nimport maestro.orchestra.util.Env.withDefaultEnvVars\nimport maestro.orchestra.util.Env.withInjectedShellEnvVars\n\n/**\n * Similar to [TestRunner], but:\n * * can run many flows at once\n * * does not support continuous mode\n *\n * Does not care about sharding. It only has to know the index of the shard it's running it, for logging purposes.\n */\nclass TestSuiteInteractor(\n private val maestro: Maestro,\n private val device: Device? = null,\n private val reporter: TestSuiteReporter,\n private val shardIndex: Int? = null,\n private val captureSteps: Boolean = false,\n) {\n\n private val logger = LoggerFactory.getLogger(TestSuiteInteractor::class.java)\n private val shardPrefix = shardIndex?.let { \"[shard ${it + 1}] \" }.orEmpty()\n\n suspend fun runTestSuite(\n executionPlan: WorkspaceExecutionPlanner.ExecutionPlan,\n reportOut: Sink?,\n env: Map,\n debugOutputPath: Path,\n testOutputDir: Path? = null,\n deviceId: String? = null,\n ): TestExecutionSummary {\n if (executionPlan.flowsToRun.isEmpty() && executionPlan.sequence.flows.isEmpty()) {\n throw CliError(\"${shardPrefix}No flows returned from the tag filter used\")\n }\n\n val flowResults = mutableListOf()\n\n PrintUtils.message(\"${shardPrefix}Waiting for flows to complete...\")\n\n var passed = true\n val aiOutputs = mutableListOf()\n\n // first run sequence of flows if present\n val flowSequence = executionPlan.sequence\n for (flow in flowSequence.flows) {\n val flowFile = flow.toFile()\n val updatedEnv = env\n .withInjectedShellEnvVars()\n .withDefaultEnvVars(flowFile, deviceId, shardIndex)\n val (result, aiOutput) = runFlow(flowFile, updatedEnv, maestro, debugOutputPath, testOutputDir)\n flowResults.add(result)\n aiOutputs.add(aiOutput)\n\n if (result.status == FlowStatus.ERROR) {\n passed = false\n if (executionPlan.sequence.continueOnFailure != true) {\n PrintUtils.message(\"${shardPrefix}Flow ${result.name} failed and continueOnFailure is set to false, aborting running sequential Flows\")\n println()\n break\n }\n }\n }\n\n // proceed to run all other Flows\n executionPlan.flowsToRun.forEach { flow ->\n val flowFile = flow.toFile()\n val updatedEnv = env\n .withInjectedShellEnvVars()\n .withDefaultEnvVars(flowFile, deviceId, shardIndex)\n val (result, aiOutput) = runFlow(flowFile, updatedEnv, maestro, debugOutputPath, testOutputDir)\n aiOutputs.add(aiOutput)\n\n if (result.status == FlowStatus.ERROR) {\n passed = false\n }\n flowResults.add(result)\n }\n\n\n val suiteDuration = flowResults.sumOf { it.duration?.inWholeSeconds ?: 0 }.seconds\n\n TestSuiteStatusView.showSuiteResult(\n TestSuiteViewModel(\n status = if (passed) FlowStatus.SUCCESS else FlowStatus.ERROR,\n duration = suiteDuration,\n shardIndex = shardIndex,\n flows = flowResults\n .map {\n TestSuiteViewModel.FlowResult(\n name = it.name,\n status = it.status,\n duration = it.duration,\n )\n },\n ),\n uploadUrl = \"\"\n )\n\n val summary = TestExecutionSummary(\n passed = passed,\n suites = listOf(\n TestExecutionSummary.SuiteResult(\n passed = passed,\n flows = flowResults,\n duration = suiteDuration,\n deviceName = device?.description,\n )\n ),\n passedCount = flowResults.count { it.status == FlowStatus.SUCCESS },\n totalTests = flowResults.size\n )\n\n if (reportOut != null) {\n reporter.report(\n summary,\n reportOut,\n )\n }\n\n // TODO(bartekpacia): Should it also be saving to debugOutputPath?\n TestDebugReporter.saveSuggestions(aiOutputs, debugOutputPath)\n\n return summary\n }\n\n private suspend fun runFlow(\n flowFile: File,\n env: Map,\n maestro: Maestro,\n debugOutputPath: Path,\n testOutputDir: Path? = null\n ): Pair {\n // TODO(bartekpacia): merge TestExecutionSummary with AI suggestions\n // (i.e. consider them also part of the test output)\n // See #1973\n\n var flowStatus: FlowStatus\n var errorMessage: String? = null\n\n val debugOutput = FlowDebugOutput()\n val aiOutput = FlowAIOutput(\n flowName = flowFile.nameWithoutExtension,\n flowFile = flowFile,\n )\n val commands = YamlCommandReader\n .readCommands(flowFile.toPath())\n .withEnv(env)\n\n val maestroConfig = YamlCommandReader.getConfig(commands)\n val flowName: String = maestroConfig?.name ?: flowFile.nameWithoutExtension\n\n logger.info(\"$shardPrefix Running flow $flowName\")\n\n val flowTimeMillis = measureTimeMillis {\n try {\n var commandSequenceNumber = 0\n val orchestra = Orchestra(\n maestro = maestro,\n screenshotsDir = testOutputDir?.resolve(\"screenshots\"),\n onCommandStart = { _, command ->\n logger.info(\"${shardPrefix}${command.description()} RUNNING\")\n debugOutput.commands[command] = CommandDebugMetadata(\n timestamp = System.currentTimeMillis(),\n status = CommandStatus.RUNNING,\n sequenceNumber = commandSequenceNumber++\n )\n },\n onCommandComplete = { _, command ->\n logger.info(\"${shardPrefix}${command.description()} COMPLETED\")\n debugOutput.commands[command]?.let {\n it.status = CommandStatus.COMPLETED\n it.calculateDuration()\n }\n },\n onCommandFailed = { _, command, e ->\n logger.info(\"${shardPrefix}${command.description()} FAILED\")\n if (e is MaestroException) debugOutput.exception = e\n debugOutput.commands[command]?.let {\n it.status = CommandStatus.FAILED\n it.calculateDuration()\n it.error = e\n }\n\n ScreenshotUtils.takeDebugScreenshot(maestro, debugOutput, CommandStatus.FAILED)\n Orchestra.ErrorResolution.FAIL\n },\n onCommandSkipped = { _, command ->\n logger.info(\"${shardPrefix}${command.description()} SKIPPED\")\n debugOutput.commands[command]?.let {\n it.status = CommandStatus.SKIPPED\n }\n },\n onCommandWarned = { _, command ->\n logger.info(\"${shardPrefix}${command.description()} WARNED\")\n debugOutput.commands[command]?.apply {\n status = CommandStatus.WARNED\n }\n },\n onCommandReset = { command ->\n logger.info(\"${shardPrefix}${command.description()} PENDING\")\n debugOutput.commands[command]?.let {\n it.status = CommandStatus.PENDING\n }\n },\n onCommandGeneratedOutput = { command, defects, screenshot ->\n logger.info(\"${shardPrefix}${command.description()} generated output\")\n val screenshotPath = ScreenshotUtils.writeAIscreenshot(screenshot)\n aiOutput.screenOutputs.add(\n SingleScreenFlowAIOutput(\n screenshotPath = screenshotPath,\n defects = defects,\n )\n )\n }\n )\n\n val flowSuccess = orchestra.runFlow(commands)\n flowStatus = if (flowSuccess) FlowStatus.SUCCESS else FlowStatus.ERROR\n } catch (e: Exception) {\n logger.error(\"${shardPrefix}Failed to complete flow\", e)\n flowStatus = FlowStatus.ERROR\n errorMessage = ErrorViewUtils.exceptionToMessage(e)\n }\n }\n val flowDuration = TimeUtils.durationInSeconds(flowTimeMillis)\n\n TestDebugReporter.saveFlow(\n flowName = flowName,\n debugOutput = debugOutput,\n shardIndex = shardIndex,\n path = debugOutputPath,\n )\n // FIXME(bartekpacia): Save AI output as well\n\n TestSuiteStatusView.showFlowCompletion(\n TestSuiteViewModel.FlowResult(\n name = flowName,\n status = flowStatus,\n duration = flowDuration,\n shardIndex = shardIndex,\n error = debugOutput.exception?.message,\n )\n )\n\n // Extract step information if captureSteps is enabled\n val steps = if (captureSteps) {\n debugOutput.commands.entries\n .sortedBy { it.value.sequenceNumber }\n .mapIndexed { index, (command, metadata) ->\n val durationStr = when (val duration = metadata.duration) {\n null -> \"<1ms\"\n else -> if (duration >= 1000) {\n \"%.1fs\".format(duration / 1000.0)\n } else {\n \"${duration}ms\"\n }\n }\n val status = metadata.status?.toString() ?: \"UNKNOWN\"\n // Use evaluated command for interpolated labels, fallback to original\n val displayCommand = metadata.evaluatedCommand ?: command\n TestExecutionSummary.StepResult(\n description = \"${index + 1}. ${displayCommand.description()}\",\n status = status,\n duration = durationStr,\n )\n }\n } else {\n emptyList()\n }\n\n return Pair(\n first = TestExecutionSummary.FlowResult(\n name = flowName,\n fileName = flowFile.nameWithoutExtension,\n status = flowStatus,\n failure = if (flowStatus == FlowStatus.ERROR) {\n TestExecutionSummary.Failure(\n message = shardPrefix + (errorMessage ?: debugOutput.exception?.message ?: \"Unknown error\"),\n )\n } else null,\n duration = flowDuration,\n properties = maestroConfig?.properties,\n tags = maestroConfig?.tags,\n steps = steps,\n ),\n second = aiOutput,\n )\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/runner/resultview/AnsiResultView.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro.cli.runner.resultview\n\nimport io.ktor.util.encodeBase64\nimport maestro.device.Device\nimport maestro.device.Platform\nimport maestro.cli.runner.CommandState\nimport maestro.cli.runner.CommandStatus\nimport maestro.device.DeviceSpecRequest\nimport maestro.device.DeviceSpec\nimport maestro.orchestra.AssertWithAICommand\nimport maestro.orchestra.ElementSelector\nimport maestro.orchestra.LaunchAppCommand\nimport maestro.orchestra.MaestroCommand\nimport maestro.orchestra.TapOnElementCommand\nimport maestro.orchestra.TapOnPointV2Command\nimport maestro.utils.Insight\nimport maestro.utils.chunkStringByWordCount\nimport org.fusesource.jansi.Ansi\n\nclass AnsiResultView(\n private val prompt: String? = null,\n private val printCommandLogs: Boolean = true,\n private val useEmojis: Boolean = true,\n) : ResultView {\n\n private val startTimestamp = System.currentTimeMillis()\n\n private val frames = mutableListOf()\n\n private var previousFrame: String? = null\n\n init {\n println(Ansi.ansi().eraseScreen())\n }\n\n override fun setState(state: UiState) {\n when (state) {\n is UiState.Running -> renderRunningState(state)\n is UiState.Error -> renderErrorState(state)\n }\n }\n\n fun getFrames(): List {\n return frames.toList()\n }\n\n private fun renderErrorState(state: UiState.Error) {\n renderFrame {\n fgRed()\n render(state.message)\n render(\"\\n\")\n }\n }\n\n private fun renderRunningState(state: UiState.Running) = renderFrame {\n state.device?.let {\n render(\"Running on ${state.device.description}\\n\")\n }\n render(\"\\n\")\n if (state.onFlowStartCommands.isNotEmpty()) {\n render(\" โ•‘\\n\")\n render(\" โ•‘ > On Flow Start\\n\")\n render(\" โ•‘\\n\")\n renderCommands(state.onFlowStartCommands)\n }\n render(\" โ•‘\\n\")\n render(\" โ•‘ > Flow: ${state.flowName}\\n\")\n render(\" โ•‘\\n\")\n renderCommands(state.commands)\n render(\" โ•‘\\n\")\n if (state.onFlowCompleteCommands.isNotEmpty()) {\n render(\" โ•‘\\n\")\n render(\" โ•‘ > On Flow Complete\\n\")\n render(\" โ•‘\\n\")\n renderCommands(state.onFlowCompleteCommands)\n }\n renderPrompt()\n }\n\n private fun Ansi.renderPrompt() {\n prompt?.let {\n render(\" โ•‘\\n\")\n render(\" โ•‘ $prompt\\n\")\n }\n }\n\n private fun Ansi.renderCommands(\n commands: List,\n indent: Int = 0,\n ) {\n commands\n .filter { it.command.asCommand()?.visible() ?: true }\n .forEach { renderCommand(it, indent) }\n }\n\n private fun Ansi.renderCommand(commandState: CommandState, indent: Int) {\n val statusSymbol = status(commandState.status)\n\n fgDefault()\n renderLineStart(indent)\n render(statusSymbol)\n render(\" \".repeat(2))\n render(\n commandState.command.description()\n .replace(\"(?\n \"@|cyan ${match.value}|@\"\n }\n )\n\n if (commandState.status == CommandStatus.SKIPPED) {\n render(\" (skipped)\")\n } else if (commandState.status == CommandStatus.WARNED) {\n render(\" (warned)\")\n } else if (commandState.numberOfRuns != null) {\n val timesWord = if (commandState.numberOfRuns == 1) \"time\" else \"times\"\n render(\" (completed ${commandState.numberOfRuns} $timesWord)\")\n }\n\n render(\"\\n\")\n\n if (printCommandLogs && commandState.logMessages.isNotEmpty()) {\n printLogMessages(indent, commandState)\n }\n\n if (commandState.insight.level != Insight.Level.NONE) {\n printInsight(indent, commandState.insight)\n }\n\n\n val subCommandsHasNotPending = (commandState.subCommands\n ?.any { subCommand -> subCommand.status != CommandStatus.PENDING } ?: false)\n val onStartHasNotPending = (commandState.subOnStartCommands\n ?.any { subCommand -> subCommand.status != CommandStatus.PENDING } ?: false)\n val onCompleteHasNotPending = (commandState.subOnCompleteCommands\n ?.any { subCommand -> subCommand.status != CommandStatus.PENDING } ?: false)\n val expandSubCommands = commandState.status in setOf(CommandStatus.RUNNING, CommandStatus.FAILED) &&\n (subCommandsHasNotPending || onStartHasNotPending || onCompleteHasNotPending)\n\n if (expandSubCommands) {\n commandState.subOnStartCommands?.let {\n render(\" โ•‘\\n\")\n render(\" โ•‘ > On Flow Start\\n\")\n render(\" โ•‘\\n\")\n renderCommands(it)\n }\n\n commandState.subCommands?.let { subCommands ->\n renderCommands(subCommands, indent + 1)\n }\n\n commandState.subOnCompleteCommands?.let {\n render(\" โ•‘\\n\")\n render(\" โ•‘ > On Flow Complete\\n\")\n render(\" โ•‘\\n\")\n renderCommands(it)\n }\n }\n }\n\n private fun Ansi.printLogMessages(indent: Int, commandState: CommandState) {\n renderLineStart(indent + 1)\n render(\" \") // Space that a status symbol would normally occupy\n render(\"@|yellow Log messages:|@\\n\")\n\n commandState.logMessages.forEach {\n renderLineStart(indent + 2)\n render(\" \") // Space that a status symbol would normally occupy\n render(it)\n render(\"\\n\")\n }\n }\n\n private fun Ansi.printInsight(indent: Int, insight: Insight) {\n val color = when (insight.level) {\n Insight.Level.WARNING -> \"yellow\"\n Insight.Level.INFO -> \"cyan\"\n else -> \"default\"\n }\n val level = insight.level.toString().lowercase().replaceFirstChar(Char::uppercase)\n renderLineStart(indent + 1)\n render(\" \") // Space that a status symbol would normally occupy\n render(\"@|$color $level:|@\\n\")\n\n insight.message.split(\"\\n\").forEach { paragraph ->\n paragraph.chunkStringByWordCount(12).forEach { chunkedMessage ->\n renderLineStart(indent + 2)\n render(\" \") // Space that a status symbol would normally occupy\n render(chunkedMessage)\n render(\"\\n\")\n }\n }\n }\n\n private fun Ansi.renderLineStart(indent: Int) {\n render(\" โ•‘ \")\n repeat(indent) {\n render(\" \")\n }\n }\n\n private fun renderFrame(block: Ansi.() -> Any) {\n renderFrame(StringBuilder().apply {\n val ansi = Ansi().cursor(0, 0)\n ansi.block()\n append(ansi)\n }.toString())\n }\n\n private fun renderFrame(frame: String) {\n // Clear previous frame\n previousFrame?.let { previousFrame ->\n val lines = previousFrame.lines()\n val height = lines.size\n val width = lines.maxOf { it.length }\n Ansi.ansi().let { ansi ->\n ansi.cursor(0, 0)\n repeat(height) {\n ansi.render(\" \".repeat(width))\n ansi.render(\"\\n\")\n }\n ansi.cursor(0, 0)\n println(ansi)\n }\n }\n print(frame)\n frames.add(createFrame(frame))\n previousFrame = frame\n }\n\n private fun createFrame(frame: String): Frame {\n val content = frame.encodeBase64()\n return Frame(System.currentTimeMillis() - startTimestamp, content)\n }\n\n private fun status(status: CommandStatus): String {\n if (useEmojis) {\n return when (status) {\n CommandStatus.COMPLETED -> \"โœ… \"\n CommandStatus.FAILED -> \"โŒ \"\n CommandStatus.RUNNING -> \"โณ \"\n CommandStatus.PENDING -> \"\\uD83D\\uDD32 \" // ๐Ÿ”ฒ\n CommandStatus.WARNED -> \"โš ๏ธ \"\n CommandStatus.SKIPPED -> \"โšช๏ธ \"\n }\n } else {\n return when (status) {\n CommandStatus.COMPLETED -> \"+ \"\n CommandStatus.FAILED -> \"X \"\n CommandStatus.RUNNING -> \"> \"\n CommandStatus.PENDING -> \" \"\n CommandStatus.WARNED -> \"! \"\n CommandStatus.SKIPPED -> \"- \"\n }\n }\n }\n\n data class Frame(val timestamp: Long, val content: String)\n}\n\n// Helper launcher to play around with presentation\nfun main() {\n val view = AnsiResultView(\"> Press [ENTER] to restart the Flow\\n\")\n\n view.setState(\n UiState.Running(\n flowName = \"Flow for playing around\",\n device = Device.Connected(\n instanceId = \"device\",\n deviceSpec = DeviceSpec.fromRequest(\n DeviceSpecRequest.Android()\n ),\n description = \"description\",\n platform = Platform.ANDROID,\n deviceType = Device.DeviceType.EMULATOR\n ),\n onFlowStartCommands = listOf(),\n onFlowCompleteCommands = listOf(),\n commands = listOf(\n CommandState(\n command = MaestroCommand(launchAppCommand = LaunchAppCommand(\"com.example.example\")),\n status = CommandStatus.COMPLETED,\n subOnStartCommands = listOf(),\n subOnCompleteCommands = listOf(),\n ),\n CommandState(\n command = MaestroCommand(\n assertWithAICommand = AssertWithAICommand(\n assertion = \"There are no bananas visible\",\n optional = true\n ),\n ),\n status = CommandStatus.WARNED,\n subOnStartCommands = listOf(),\n subOnCompleteCommands = listOf(),\n insight = Insight(\n message = \"\"\"\n |Assertion is false: There are no bananas visible\n |Reasoning: The screen shows a login screen and no images of bananas are present.\n \"\"\".trimMargin(),\n level = Insight.Level.WARNING,\n ),\n ),\n CommandState(\n command = MaestroCommand(\n tapOnElement = TapOnElementCommand(\n selector = ElementSelector(\"id\", \"login\")\n ),\n ),\n status = CommandStatus.SKIPPED,\n subOnStartCommands = listOf(),\n subOnCompleteCommands = listOf(),\n ),\n CommandState(\n command = MaestroCommand(\n tapOnElement = TapOnElementCommand(\n selector = ElementSelector(\"id\", \"login\"),\n label = \"Use JS value: \\${output.some_var}\",\n ),\n ),\n status = CommandStatus.RUNNING,\n subOnStartCommands = listOf(),\n subOnCompleteCommands = listOf(),\n ),\n CommandState(\n command = MaestroCommand(tapOnPointV2Command = TapOnPointV2Command(point = \"50%, 25%\")),\n status = CommandStatus.PENDING,\n subOnStartCommands = listOf(),\n subOnCompleteCommands = listOf(),\n ),\n CommandState(\n command = MaestroCommand(tapOnPointV2Command = TapOnPointV2Command(point = \"50%, 25%\")),\n status = CommandStatus.FAILED,\n subOnStartCommands = listOf(),\n subOnCompleteCommands = listOf(),\n insight = Insight(\"This is insight message\", Insight.Level.NONE),\n ),\n CommandState(\n command = MaestroCommand(tapOnPointV2Command = TapOnPointV2Command(point = \"50%, 25%\")),\n status = CommandStatus.FAILED,\n subOnStartCommands = listOf(),\n subOnCompleteCommands = listOf(),\n insight = Insight(\"This is an error message\", Insight.Level.INFO),\n ),\n )\n )\n )\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/runner/resultview/PlainTextResultView.kt", "content": "package maestro.cli.runner.resultview\n\nimport maestro.cli.runner.CommandState\nimport maestro.cli.runner.CommandStatus\nimport maestro.orchestra.CompositeCommand\nimport maestro.utils.Insight\nimport maestro.utils.chunkStringByWordCount\n\nclass PlainTextResultView: ResultView {\n\n private val printed = mutableSetOf()\n\n private val terminalStatuses = setOf(\n CommandStatus.COMPLETED,\n CommandStatus.FAILED,\n CommandStatus.SKIPPED,\n CommandStatus.WARNED\n )\n\n private inline fun printOnce(key: String, block: () -> Unit) {\n if (printed.add(key)) block()\n }\n\n override fun setState(state: UiState) {\n when (state) {\n is UiState.Running -> renderRunningState(state)\n is UiState.Error -> renderErrorState(state)\n }\n }\n\n private fun renderErrorState(state: UiState.Error) {\n println(state.message)\n }\n\n private fun renderRunningState(state: UiState.Running) {\n renderRunningStatePlainText(state)\n }\n\n private fun renderRunningStatePlainText(state: UiState.Running) {\n state.device?.let {\n printOnce(\"device\") { println(\"Running on ${state.device.description}\") }\n }\n\n if (state.onFlowStartCommands.isNotEmpty()) {\n printOnce(\"onFlowStart\") { println(\" > On Flow Start\") }\n renderCommandsPlainText(state.onFlowStartCommands, prefix = \"onFlowStart\")\n }\n\n printOnce(\"flowName:${state.flowName}\") { println(\" > Flow ${state.flowName}\") }\n\n renderCommandsPlainText(state.commands, prefix = \"main\")\n\n if (state.onFlowCompleteCommands.isNotEmpty()) {\n printOnce(\"onFlowComplete\") { println(\" > On Flow Complete\") }\n renderCommandsPlainText(state.onFlowCompleteCommands, prefix = \"onFlowComplete\")\n }\n }\n\n private fun renderCommandsPlainText(commands: List, indent: Int = 0, prefix: String = \"\") {\n for ((index, command) in commands.withIndex()) {\n renderCommandPlainText(command, indent, \"$prefix:$index\")\n }\n }\n\n private fun renderCommandPlainText(command: CommandState, indent: Int, key: String) {\n val c = command.command.asCommand()\n if (c?.visible() == false) return\n\n val desc = c?.description() ?: \"Unknown command\"\n val pad = \" \".repeat(indent)\n\n when (c) {\n is CompositeCommand -> {\n // Print start line once when command begins\n if (command.status != CommandStatus.PENDING) {\n printOnce(\"$key:start\") { println(\"$pad$desc...\") }\n }\n\n // onFlowStart hooks\n command.subOnStartCommands?.let { cmds ->\n printOnce(\"$key:onStart\") { println(\"$pad > On Flow Start\") }\n renderCommandsPlainText(cmds, indent + 1, \"$key:subOnStart\")\n }\n\n // The actual sub-commands of the composite\n command.subCommands?.let { cmds ->\n renderCommandsPlainText(cmds, indent + 1, \"$key:sub\")\n }\n\n // onFlowComplete hooks\n command.subOnCompleteCommands?.let { cmds ->\n printOnce(\"$key:onComplete\") { println(\"$pad > On Flow Complete\") }\n renderCommandsPlainText(cmds, indent + 1, \"$key:subOnComplete\")\n }\n\n // Print completion line once when it reaches a terminal status\n if (command.status in terminalStatuses) {\n printOnce(\"$key:complete\") { println(\"$pad$desc... ${status(command.status)}\") }\n }\n }\n\n else -> {\n // Simple command (tapOn, assertVisible, etc.)\n when (command.status) {\n CommandStatus.RUNNING -> {\n printOnce(\"$key:start\") { print(\"$pad$desc...\") }\n }\n\n in terminalStatuses -> {\n printOnce(\"$key:start\") { print(\"$pad$desc...\") }\n printOnce(\"$key:complete\") {\n println(\" ${status(command.status)}\")\n renderInsight(command.insight, indent + 1)\n }\n }\n\n else -> {}\n }\n }\n }\n }\n\n private fun renderInsight(insight: Insight, indent: Int) {\n if (insight.level != Insight.Level.NONE) {\n println(\"\\n\")\n val level = insight.level.toString().lowercase().replaceFirstChar(Char::uppercase)\n print(\" \".repeat(indent) + level + \":\")\n insight.message.chunkStringByWordCount(12).forEach { chunkedMessage ->\n print(\" \".repeat(indent))\n print(chunkedMessage)\n print(\"\\n\")\n }\n }\n }\n\n private fun status(status: CommandStatus): String {\n return when (status) {\n CommandStatus.COMPLETED -> \"COMPLETED\"\n CommandStatus.FAILED -> \"FAILED\"\n CommandStatus.RUNNING -> \"RUNNING\"\n CommandStatus.PENDING -> \"PENDING\"\n CommandStatus.SKIPPED -> \"SKIPPED\"\n CommandStatus.WARNED -> \"WARNED\"\n }\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/runner/resultview/ResultView.kt", "content": "package maestro.cli.runner.resultview\n\ninterface ResultView {\n fun setState(state: UiState)\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/runner/resultview/UiState.kt", "content": "package maestro.cli.runner.resultview\n\nimport maestro.device.Device\nimport maestro.cli.runner.CommandState\n\nsealed class UiState {\n\n data class Error(val message: String) : UiState()\n\n data class Running(\n val flowName: String,\n val device: Device? = null,\n val onFlowStartCommands: List = emptyList(),\n val onFlowCompleteCommands: List = emptyList(),\n val commands: List,\n ) : UiState()\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/session/MaestroSessionManager.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro.cli.session\n\nimport dadb.Dadb\nimport dadb.adbserver.AdbServer\nimport ios.LocalIOSDevice\nimport ios.devicectl.DeviceControlIOSDevice\nimport device.SimctlIOSDevice\nimport ios.xctest.XCTestIOSDevice\nimport maestro.Maestro\nimport maestro.device.Device\nimport maestro.cli.device.PickDeviceInteractor\nimport maestro.cli.driver.DriverBuilder\nimport maestro.cli.driver.RealIOSDeviceDriver\nimport maestro.cli.util.PrintUtils\nimport maestro.device.Platform\nimport maestro.utils.CliInsights\nimport maestro.cli.util.ScreenReporter\nimport maestro.drivers.AndroidDriver\nimport maestro.drivers.IOSDriver\nimport maestro.orchestra.WorkspaceConfig.PlatformConfiguration\nimport maestro.orchestra.workspace.WorkspaceExecutionPlanner\nimport maestro.utils.TempFileHandler\nimport org.slf4j.LoggerFactory\nimport util.IOSDeviceType\nimport util.XCRunnerCLIUtils\nimport xcuitest.XCTestClient\nimport xcuitest.XCTestDriverClient\nimport xcuitest.installer.Context\nimport xcuitest.installer.LocalXCTestInstaller\nimport xcuitest.installer.LocalXCTestInstaller.*\nimport java.nio.file.Paths\nimport java.util.UUID\nimport java.util.concurrent.Executors\nimport java.util.concurrent.TimeUnit\nimport kotlin.concurrent.thread\nimport kotlin.io.path.pathString\n\nobject MaestroSessionManager {\n private const val defaultHost = \"localhost\"\n private const val defaultXctestHost = \"127.0.0.1\"\n private const val defaultXcTestPort = 22087\n\n private val executor = Executors.newScheduledThreadPool(1)\n private val logger = LoggerFactory.getLogger(MaestroSessionManager::class.java)\n\n\n fun newSession(\n host: String?,\n port: Int?,\n driverHostPort: Int?,\n deviceId: String?,\n teamId: String? = null,\n platform: String? = null,\n isStudio: Boolean = false,\n isHeadless: Boolean = false,\n screenSize: String? = null,\n reinstallDriver: Boolean = true,\n deviceIndex: Int? = null,\n executionPlan: WorkspaceExecutionPlanner.ExecutionPlan? = null,\n block: (MaestroSession) -> T,\n ): T {\n val selectedDevice = selectDevice(\n host = host,\n port = port,\n driverHostPort = driverHostPort,\n deviceId = deviceId,\n teamId = teamId,\n platform = if(!platform.isNullOrEmpty()) Platform.fromString(platform) else null,\n deviceIndex = deviceIndex,\n )\n val sessionId = UUID.randomUUID().toString()\n\n val heartbeatFuture = executor.scheduleAtFixedRate(\n {\n try {\n Thread.sleep(1000) // Add a 1-second delay here for fixing race condition\n SessionStore.heartbeat(sessionId, selectedDevice.platform)\n } catch (e: Exception) {\n logger.error(\"Failed to record heartbeat\", e)\n }\n },\n 0L,\n 5L,\n TimeUnit.SECONDS\n )\n\n val session = createMaestro(\n selectedDevice = selectedDevice,\n connectToExistingSession = if (isStudio) {\n false\n } else {\n SessionStore.hasActiveSessions(\n sessionId,\n selectedDevice.platform\n )\n },\n isStudio = isStudio,\n isHeadless = isHeadless,\n screenSize = screenSize,\n driverHostPort = driverHostPort,\n reinstallDriver = reinstallDriver,\n platformConfiguration = executionPlan?.workspaceConfig?.platform\n )\n Runtime.getRuntime().addShutdownHook(thread(start = false) {\n heartbeatFuture.cancel(true)\n SessionStore.delete(sessionId, selectedDevice.platform)\n runCatching { ScreenReporter.reportMaxDepth() }\n if (SessionStore.activeSessions().isEmpty()) {\n session.close()\n }\n })\n\n return block(session)\n }\n\n private fun selectDevice(\n host: String?,\n port: Int?,\n driverHostPort: Int?,\n deviceId: String?,\n platform: Platform? = null,\n teamId: String? = null,\n deviceIndex: Int? = null,\n ): SelectedDevice {\n\n if (deviceId == \"chromium\" || platform == Platform.WEB) {\n return SelectedDevice(\n platform = Platform.WEB,\n deviceType = Device.DeviceType.BROWSER\n )\n }\n\n if (host == null) {\n val device = PickDeviceInteractor.pickDevice(deviceId, driverHostPort, platform, deviceIndex)\n\n if (device.deviceType == Device.DeviceType.REAL && device.platform == Platform.IOS) {\n PrintUtils.message(\"Detected connected iPhone with ${device.instanceId}!\")\n val driverBuilder = DriverBuilder()\n RealIOSDeviceDriver(\n destination = \"platform=iOS,id=${device.instanceId}\",\n teamId = teamId,\n driverBuilder = driverBuilder\n ).validateAndUpdateDriver()\n }\n return SelectedDevice(\n platform = device.platform,\n device = device,\n deviceType = device.deviceType\n )\n }\n\n if (isAndroid(host, port)) {\n val deviceType = when {\n deviceId?.startsWith(\"emulator\") == true -> Device.DeviceType.EMULATOR\n else -> Device.DeviceType.REAL\n }\n return SelectedDevice(\n platform = Platform.ANDROID,\n host = host,\n port = port,\n deviceId = deviceId,\n deviceType = deviceType\n )\n }\n\n return SelectedDevice(\n platform = Platform.IOS,\n host = null,\n port = null,\n deviceId = deviceId,\n deviceType = Device.DeviceType.SIMULATOR\n )\n }\n\n private fun createMaestro(\n selectedDevice: SelectedDevice,\n connectToExistingSession: Boolean,\n isStudio: Boolean,\n isHeadless: Boolean,\n screenSize: String?,\n reinstallDriver: Boolean,\n driverHostPort: Int?,\n platformConfiguration: PlatformConfiguration? = null,\n ): MaestroSession {\n return when {\n selectedDevice.device != null -> MaestroSession(\n maestro = when (selectedDevice.device.platform) {\n Platform.ANDROID -> createAndroid(\n selectedDevice.device.instanceId,\n !connectToExistingSession,\n driverHostPort,\n reinstallDriver,\n )\n\n Platform.IOS -> createIOS(\n selectedDevice.device.instanceId,\n !connectToExistingSession,\n driverHostPort,\n reinstallDriver,\n deviceType = selectedDevice.device.deviceType,\n platformConfiguration = platformConfiguration\n )\n\n Platform.WEB -> pickWebDevice(isStudio, isHeadless, screenSize)\n },\n device = selectedDevice.device,\n )\n\n selectedDevice.platform == Platform.ANDROID -> MaestroSession(\n maestro = pickAndroidDevice(\n selectedDevice.host,\n selectedDevice.port,\n driverHostPort,\n !connectToExistingSession,\n reinstallDriver,\n selectedDevice.deviceId,\n ),\n device = null,\n )\n\n selectedDevice.platform == Platform.IOS -> MaestroSession(\n maestro = pickIOSDevice(\n deviceId = selectedDevice.deviceId,\n openDriver = !connectToExistingSession,\n driverHostPort = driverHostPort ?: defaultXcTestPort,\n reinstallDriver = reinstallDriver,\n platformConfiguration = platformConfiguration,\n ),\n device = null,\n )\n\n selectedDevice.platform == Platform.WEB -> MaestroSession(\n maestro = pickWebDevice(isStudio, isHeadless, screenSize),\n device = null\n )\n\n else -> error(\"Unable to create Maestro session\")\n }\n }\n\n private fun isAndroid(host: String?, port: Int?): Boolean {\n return try {\n val dadb = if (port != null) {\n Dadb.create(host ?: defaultHost, port)\n } else {\n Dadb.discover(host ?: defaultHost)\n ?: createAdbServerDadb()\n ?: error(\"No android devices found.\")\n }\n\n dadb.close()\n\n true\n } catch (_: Exception) {\n false\n }\n }\n\n private fun pickAndroidDevice(\n host: String?,\n port: Int?,\n driverHostPort: Int?,\n openDriver: Boolean,\n reinstallDriver: Boolean,\n deviceId: String? = null,\n ): Maestro {\n val dadb = if (port != null) {\n Dadb.create(host ?: defaultHost, port)\n } else if (deviceId != null) {\n Dadb.list(host = host ?: defaultHost).find { it.toString() == deviceId }\n ?: error(\"No Android device found with id '$deviceId' on host '${host ?: defaultHost}'\")\n } else {\n Dadb.discover(host ?: defaultHost)\n ?: createAdbServerDadb()\n ?: error(\"No android devices found.\")\n }\n\n return Maestro.android(\n driver = AndroidDriver(dadb, driverHostPort, \"\", reinstallDriver),\n openDriver = openDriver,\n )\n }\n\n private fun createAdbServerDadb(): Dadb? {\n return try {\n AdbServer.createDadb(adbServerPort = 5038)\n } catch (ignored: Exception) {\n null\n }\n }\n\n private fun pickIOSDevice(\n deviceId: String?,\n openDriver: Boolean,\n driverHostPort: Int,\n reinstallDriver: Boolean,\n platformConfiguration: PlatformConfiguration?,\n ): Maestro {\n val device = PickDeviceInteractor.pickDevice(deviceId, driverHostPort)\n return createIOS(\n device.instanceId,\n openDriver,\n driverHostPort,\n reinstallDriver,\n deviceType = device.deviceType,\n platformConfiguration = platformConfiguration\n )\n }\n\n private fun createAndroid(\n instanceId: String,\n openDriver: Boolean,\n driverHostPort: Int?,\n reinstallDriver: Boolean,\n ): Maestro {\n val driver = AndroidDriver(\n dadb = Dadb\n .list()\n .find { it.toString() == instanceId }\n ?: Dadb.discover()\n ?: error(\"Unable to find device with id $instanceId\"),\n hostPort = driverHostPort,\n emulatorName = instanceId,\n reinstallDriver = reinstallDriver,\n )\n\n return Maestro.android(\n driver = driver,\n openDriver = openDriver,\n )\n }\n\n private fun createIOS(\n deviceId: String,\n openDriver: Boolean,\n driverHostPort: Int?,\n reinstallDriver: Boolean,\n platformConfiguration: PlatformConfiguration?,\n deviceType: Device.DeviceType,\n ): Maestro {\n\n val iOSDeviceType = when (deviceType) {\n Device.DeviceType.REAL -> IOSDeviceType.REAL\n Device.DeviceType.SIMULATOR -> IOSDeviceType.SIMULATOR\n else -> {\n throw UnsupportedOperationException(\"Unsupported device type $deviceType for iOS platform\")\n }\n }\n val iOSDriverConfig = when (deviceType) {\n Device.DeviceType.REAL -> {\n val maestroDirectory = Paths.get(System.getProperty(\"user.home\"), \".maestro\")\n val driverPath = maestroDirectory.resolve(\"maestro-iphoneos-driver-build\").resolve(\"driver-iphoneos\")\n .resolve(\"Build\").resolve(\"Products\")\n IOSDriverConfig(\n prebuiltRunner = false,\n sourceDirectory = driverPath.pathString,\n context = Context.CLI,\n snapshotKeyHonorModalViews = platformConfiguration?.ios?.snapshotKeyHonorModalViews\n )\n }\n Device.DeviceType.SIMULATOR -> {\n IOSDriverConfig(\n prebuiltRunner = false,\n sourceDirectory = \"driver-iPhoneSimulator\",\n context = Context.CLI,\n snapshotKeyHonorModalViews = platformConfiguration?.ios?.snapshotKeyHonorModalViews\n )\n }\n else -> throw UnsupportedOperationException(\"Unsupported device type $deviceType for iOS platform\")\n }\n\n val tempFileHandler = TempFileHandler()\n val deviceController = when (deviceType) {\n Device.DeviceType.REAL -> {\n val device = util.LocalIOSDevice().listDeviceViaDeviceCtl(deviceId)\n val deviceCtlDevice = DeviceControlIOSDevice(deviceId = device.identifier)\n deviceCtlDevice\n }\n Device.DeviceType.SIMULATOR -> {\n val simctlIOSDevice = SimctlIOSDevice(\n deviceId = deviceId,\n tempFileHandler = tempFileHandler\n )\n simctlIOSDevice\n }\n else -> throw UnsupportedOperationException(\"Unsupported device type $deviceType for iOS platform\")\n }\n\n val xcTestInstaller = LocalXCTestInstaller(\n deviceId = deviceId,\n host = defaultXctestHost,\n defaultPort = driverHostPort ?: defaultXcTestPort,\n reinstallDriver = reinstallDriver,\n deviceType = iOSDeviceType,\n iOSDriverConfig = iOSDriverConfig,\n deviceController = deviceController,\n tempFileHandler = tempFileHandler\n )\n\n val xcTestDriverClient = XCTestDriverClient(\n installer = xcTestInstaller,\n client = XCTestClient(defaultXctestHost, driverHostPort ?: defaultXcTestPort),\n reinstallDriver = reinstallDriver,\n )\n\n val xcRunnerCLIUtils = XCRunnerCLIUtils(tempFileHandler = tempFileHandler)\n val xcTestDevice = XCTestIOSDevice(\n deviceId = deviceId,\n client = xcTestDriverClient,\n getInstalledApps = { xcRunnerCLIUtils.listApps(deviceId) },\n )\n\n val iosDriver = IOSDriver(\n LocalIOSDevice(\n deviceId = deviceId,\n xcTestDevice = xcTestDevice,\n deviceController = deviceController,\n insights = CliInsights\n ),\n insights = CliInsights\n )\n\n return Maestro.ios(\n driver = iosDriver,\n openDriver = openDriver || xcTestDevice.isShutdown(),\n )\n }\n\n private fun pickWebDevice(isStudio: Boolean, isHeadless: Boolean, screenSize: String?): Maestro {\n return Maestro.web(isStudio, isHeadless, screenSize)\n }\n\n private data class SelectedDevice(\n val platform: Platform,\n val device: Device.Connected? = null,\n val host: String? = null,\n val port: Int? = null,\n val deviceId: String? = null,\n val deviceType: Device.DeviceType,\n )\n\n data class MaestroSession(\n val maestro: Maestro,\n val device: Device? = null,\n ) {\n\n fun close() {\n maestro.close()\n }\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/session/SessionStore.kt", "content": "package maestro.cli.session\n\nimport maestro.cli.db.KeyValueStore\nimport maestro.device.Platform\nimport java.nio.file.Paths\nimport java.util.concurrent.TimeUnit\n\nobject SessionStore {\n\n private val keyValueStore by lazy {\n KeyValueStore(\n dbFile = Paths\n .get(System.getProperty(\"user.home\"), \".maestro\", \"sessions\")\n .toFile()\n .also { it.parentFile.mkdirs() }\n )\n }\n\n fun heartbeat(sessionId: String, platform: Platform) {\n synchronized(keyValueStore) {\n keyValueStore.set(\n key = key(sessionId, platform),\n value = System.currentTimeMillis().toString(),\n )\n\n pruneInactiveSessions()\n }\n }\n\n private fun pruneInactiveSessions() {\n keyValueStore.keys()\n .forEach { key ->\n val lastHeartbeat = keyValueStore.get(key)?.toLongOrNull()\n if (lastHeartbeat != null && System.currentTimeMillis() - lastHeartbeat >= TimeUnit.SECONDS.toMillis(21)) {\n keyValueStore.delete(key)\n }\n }\n }\n\n fun delete(sessionId: String, platform: Platform) {\n synchronized(keyValueStore) {\n keyValueStore.delete(\n key(sessionId, platform)\n )\n }\n }\n\n fun activeSessions(): List {\n synchronized(keyValueStore) {\n return keyValueStore\n .keys()\n .filter { key ->\n val lastHeartbeat = keyValueStore.get(key)?.toLongOrNull()\n lastHeartbeat != null && System.currentTimeMillis() - lastHeartbeat < TimeUnit.SECONDS.toMillis(21)\n }\n }\n }\n\n fun hasActiveSessions(\n sessionId: String,\n platform: Platform\n ): Boolean {\n synchronized(keyValueStore) {\n return activeSessions()\n .any { it != key(sessionId, platform) }\n }\n }\n\n private fun key(sessionId: String, platform: Platform): String {\n return \"${platform}_$sessionId\"\n }\n\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/update/Updates.kt", "content": "package maestro.cli.update\n\nimport maestro.cli.api.ApiClient\nimport maestro.cli.api.CliVersion\nimport maestro.cli.util.EnvUtils\nimport maestro.cli.util.EnvUtils.CLI_VERSION\nimport java.util.concurrent.CompletableFuture\nimport java.util.concurrent.Executors\nimport java.util.concurrent.TimeUnit\nimport maestro.cli.util.ChangeLogUtils\nimport maestro.cli.util.ChangeLog\n\nobject Updates {\n private val DEFAULT_THREAD_FACTORY = Executors.defaultThreadFactory()\n private val EXECUTOR = Executors.newCachedThreadPool {\n DEFAULT_THREAD_FACTORY.newThread(it).apply { isDaemon = true }\n }\n\n private var future: CompletableFuture? = null\n private var changelogFuture: CompletableFuture>? = null\n\n fun fetchUpdatesAsync() {\n getFuture()\n }\n\n fun fetchChangelogAsync() {\n getChangelogFuture()\n }\n\n fun checkForUpdates(): CliVersion? {\n // Disable update check, when MAESTRO_DISABLE_UPDATE_CHECK is set to \"true\" e.g. when installed by a package manager. e.g. nix\n if (System.getenv(\"MAESTRO_DISABLE_UPDATE_CHECK\")?.toBoolean() == true) {\n return null\n }\n return try {\n getFuture().get(3, TimeUnit.SECONDS)\n } catch (e: Exception) {\n return null\n }\n }\n\n fun getChangelog(): List? {\n // Disable update check, when MAESTRO_DISABLE_UPDATE_CHECK is set to \"true\" e.g. when installed by a package manager. e.g. nix\n if (System.getenv(\"MAESTRO_DISABLE_UPDATE_CHECK\")?.toBoolean() == true) {\n return null\n }\n return try {\n getChangelogFuture().get(3, TimeUnit.SECONDS)\n } catch (e: Exception) {\n return null\n }\n }\n\n private fun fetchUpdates(): CliVersion? {\n if (CLI_VERSION == null) {\n return null\n }\n\n val latestCliVersion = ApiClient(EnvUtils.BASE_API_URL).getLatestCliVersion()\n\n return if (latestCliVersion > CLI_VERSION) {\n latestCliVersion\n } else {\n null\n }\n }\n\n private fun fetchChangelog(): ChangeLog {\n if (CLI_VERSION == null) {\n return null\n }\n val version = fetchUpdates()?.toString() ?: return null\n val content = ChangeLogUtils.fetchContent()\n return ChangeLogUtils.formatBody(content, version)\n }\n\n @Synchronized\n private fun getFuture(): CompletableFuture {\n var future = this.future\n if (future == null) {\n future = CompletableFuture.supplyAsync(this::fetchUpdates, EXECUTOR)!!\n this.future = future\n }\n return future\n }\n\n @Synchronized\n private fun getChangelogFuture(): CompletableFuture> {\n var changelogFuture = this.changelogFuture\n if (changelogFuture == null) {\n changelogFuture = CompletableFuture.supplyAsync(this::fetchChangelog, EXECUTOR)!!\n this.changelogFuture = changelogFuture\n }\n return changelogFuture\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/ChangeLogUtils.kt", "content": "package maestro.cli.util\n\nimport maestro.cli.util.EnvUtils.CLI_VERSION\nimport maestro.utils.HttpClient\nimport okhttp3.Request\nimport java.io.File\n\ntypealias ChangeLog = List?\n\nobject ChangeLogUtils {\n\n fun formatBody(content: String?, version: String): ChangeLog = content\n ?.split(\"\\n## \")?.map { it.lines() }\n ?.firstOrNull { it.firstOrNull()?.startsWith(version) == true }\n ?.drop(1)\n ?.map { it.trim().replace(\"**\", \"\") }\n ?.map { it.replace(\"\\\\[(.*?)]\\\\(.*?\\\\)\".toRegex(), \"$1\") }\n ?.filter { it.isNotEmpty() && it.startsWith(\"- \") }\n\n fun fetchContent(): String? {\n val request = Request.Builder()\n .url(\"https://raw.githubusercontent.com/mobile-dev-inc/maestro/main/CHANGELOG.md\")\n .build()\n return HttpClient.build(\"ChangeLogUtils\").newCall(request).execute().body?.string()\n }\n\n fun print(changelog: ChangeLog): String =\n changelog?.let { \"\\n${it.joinToString(\"\\n\")}\\n\" }.orEmpty()\n}\n\n// Helper launcher to play around with presentation\nfun main() {\n val changelogFile = File(System.getProperty(\"user.dir\"), \"CHANGELOG.md\")\n val content = changelogFile.readText()\n val unreleased = ChangeLogUtils.formatBody(content, \"Unreleased\")\n val current = ChangeLogUtils.formatBody(content, CLI_VERSION.toString())\n val changelog = unreleased ?: current\n println(\"## ${unreleased?.let { \"Unreleased\" } ?: CLI_VERSION.toString()}\")\n println(\"-\".repeat(100))\n println(ChangeLogUtils.print(changelog))\n println(\"-\".repeat(100))\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/CiUtils.kt", "content": "package maestro.cli.util\n\nobject CiUtils {\n\n // When adding a new CI, also add the first version of Maestro that supports it.\n private val ciEnvVarMap = mapOf(\n \"APPVEYOR\" to \"appveyor\", // since v1.37.4\n \"BITBUCKET_BUILD_NUMBER\" to \"bitbucket\",\n \"BITRISE_IO\" to \"bitrise\",\n \"BUILDKITE\" to \"buildkite\", // since v1.37.4\n \"CIRCLECI\" to \"circleci\",\n \"CIRRUS_CI\" to \"cirrusci\", // since v1.37.4\n \"DRONE\" to \"drone\", // since v1.37.4\n \"GITHUB_ACTIONS\" to \"github\",\n \"GITLAB_CI\" to \"gitlab\",\n \"JENKINS_HOME\" to \"jenkins\",\n \"TEAMCITY_VERSION\" to \"teamcity\", // since v1.37.4\n \"CI\" to \"ci\"\n )\n\n private fun isTruthy(envVar: String?): Boolean {\n if (envVar == null) return false\n return envVar != \"0\" && envVar != \"false\"\n }\n\n fun getCiProvider(): String? {\n val mdevCiEnvVar = System.getenv(\"MDEV_CI\")\n if (isTruthy(mdevCiEnvVar)) {\n return mdevCiEnvVar\n }\n\n for (ciEnvVar in ciEnvVarMap.entries) {\n try {\n if (isTruthy(System.getenv(ciEnvVar.key).lowercase())) return ciEnvVar.value\n } catch (e: Exception) {\n // We don't care\n }\n }\n\n return null\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/DependencyResolver.kt", "content": "package maestro.cli.util\n\nimport maestro.orchestra.ApplyConfigurationCommand\nimport maestro.orchestra.CompositeCommand\nimport maestro.orchestra.MaestroCommand\nimport maestro.orchestra.yaml.MaestroFlowParser\nimport java.nio.file.Files\nimport java.nio.file.Path\nimport java.nio.file.LinkOption\nimport kotlin.io.path.exists\n\nobject DependencyResolver {\n\n fun discoverAllDependencies(flowFile: Path): List {\n val discoveredFiles = mutableSetOf()\n val filesToProcess = mutableListOf(normalizePath(flowFile))\n \n while (filesToProcess.isNotEmpty()) {\n val currentFile = normalizePath(filesToProcess.removeFirst())\n \n // Skip if we've already processed this file (prevents circular references)\n if (discoveredFiles.contains(currentFile)) continue\n \n // Add current file to discovered set\n discoveredFiles.add(currentFile)\n \n try {\n // Only process YAML files for dependency discovery\n if (!isYamlFile(currentFile)) {\n continue\n }\n \n val flowContent = Files.readString(currentFile)\n val commands = MaestroFlowParser.parseFlow(currentFile, flowContent)\n \n // Discover dependencies from each command\n val dependencies = commands.flatMap { maestroCommand ->\n extractDependenciesFromCommand(maestroCommand, currentFile)\n }\n \n val newDependencies = dependencies\n .map { normalizePath(it) }\n .filter { it.exists() && !discoveredFiles.contains(it) }\n filesToProcess.addAll(newDependencies)\n \n } catch (e: Exception) {\n // Ignore\n }\n }\n \n return discoveredFiles.toList()\n }\n \n private fun extractDependenciesFromCommand(maestroCommand: MaestroCommand, currentFile: Path): List {\n val commandDependencies = mutableListOf()\n\n // Check for runFlow commands and add the dependency if it exists (sourceDescription is not null)\n maestroCommand.runFlowCommand?.let { runFlow ->\n resolveDependencyFile(currentFile, runFlow.sourceDescription)?.let { commandDependencies.add(it) }\n }\n \n // Check for runScript commands and add the dependency if it exists (sourceDescription is not null)\n maestroCommand.runScriptCommand?.let { runScript ->\n resolveDependencyFile(currentFile, runScript.sourceDescription)?.let { commandDependencies.add(it) }\n }\n \n // Check for retry commands and add the dependency if it exists (sourceDescription is not null)\n maestroCommand.retryCommand?.let { retry ->\n resolveDependencyFile(currentFile, retry.sourceDescription)?.let { commandDependencies.add(it) }\n }\n \n // Check for assertScreenshot commands and add the reference image as a dependency\n maestroCommand.assertScreenshotCommand?.let { assertScreenshot ->\n resolveDependencyFile(currentFile, assertScreenshot.path)?.let { commandDependencies.add(it) }\n }\n\n // Check for addMedia commands and add the dependency if it exists (mediaPaths is not null)\n maestroCommand.addMediaCommand?.let { addMedia ->\n addMedia.mediaPaths.forEach { mediaPath ->\n resolveDependencyFile(currentFile, mediaPath)?.let { commandDependencies.add(it) }\n }\n }\n \n // Handle configuration commands (onFlowStart, onFlowComplete)\n maestroCommand.applyConfigurationCommand?.let { config ->\n config.config.onFlowStart?.commands?.forEach { startCommand ->\n commandDependencies.addAll(extractDependenciesFromCommand(startCommand, currentFile))\n }\n config.config.onFlowComplete?.commands?.forEach { completeCommand ->\n commandDependencies.addAll(extractDependenciesFromCommand(completeCommand, currentFile))\n }\n }\n \n // Handle ALL composite commands to extract dependencies from nested commands (RunFlow, Repeat, Retry)\n val command = maestroCommand.asCommand()\n if (command is CompositeCommand) {\n command.subCommands().forEach { nestedCommand ->\n commandDependencies.addAll(extractDependenciesFromCommand(nestedCommand, currentFile))\n }\n }\n \n return commandDependencies\n }\n \n private fun resolvePath(flowPath: Path, requestedPath: String): Path {\n val path = flowPath.fileSystem.getPath(requestedPath)\n \n return if (path.isAbsolute) {\n path\n } else {\n flowPath.resolveSibling(path).toAbsolutePath()\n }\n }\n \n private fun resolveDependencyFile(currentFile: Path, requestedPath: String?): Path? {\n val trimmed = requestedPath?.trim()\n if (trimmed.isNullOrEmpty()) return null\n val resolved = resolvePath(currentFile, trimmed)\n return if (resolved.exists() && !Files.isDirectory(resolved)) resolved else null\n }\n\n private fun isYamlFile(path: Path): Boolean {\n val filename = path.fileName.toString().lowercase()\n return filename.endsWith(\".yaml\") || filename.endsWith(\".yml\")\n }\n\n private fun isJsFile(path: Path): Boolean {\n val filename = path.fileName.toString().lowercase()\n return filename.endsWith(\".js\")\n }\n\n fun getDependencySummary(flowFile: Path): String {\n val dependencies = discoverAllDependencies(flowFile)\n val mainFile = dependencies.firstOrNull { it == flowFile }\n val subflows = dependencies.filter { it != flowFile && isYamlFile(it) }\n val scripts = dependencies.filter { it != flowFile && isJsFile(it) }\n val otherFiles = dependencies.filter { it != flowFile && !isYamlFile(it) && !isJsFile(it) }\n \n return buildString {\n appendLine(\"Dependency discovery for: ${flowFile.fileName}\")\n appendLine(\"Total files: ${dependencies.size}\")\n if (subflows.isNotEmpty()) appendLine(\"Subflows: ${subflows.size}\")\n if (scripts.isNotEmpty()) appendLine(\"Scripts: ${scripts.size}\")\n if (otherFiles.isNotEmpty()) appendLine(\"Other files: ${otherFiles.size}\")\n \n if (subflows.isNotEmpty()) {\n appendLine(\"Subflow files:\")\n subflows.forEach { appendLine(\" - ${it.fileName}\") }\n }\n if (scripts.isNotEmpty()) {\n appendLine(\"Script files:\")\n scripts.forEach { appendLine(\" - ${it.fileName}\") }\n }\n if (otherFiles.isNotEmpty()) {\n appendLine(\"Other files:\")\n otherFiles.forEach { appendLine(\" - ${it.fileName}\") }\n }\n }\n }\n\n private fun normalizePath(path: Path): Path {\n return try {\n // Prefer canonical path without following symlinks\n path.toRealPath(LinkOption.NOFOLLOW_LINKS)\n } catch (e: Exception) {\n // Fall back to absolute normalized path if real path resolution fails\n path.toAbsolutePath().normalize()\n }\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/EnvUtils.kt", "content": "package maestro.cli.util\n\nimport com.fasterxml.jackson.module.kotlin.jacksonObjectMapper\nimport com.fasterxml.jackson.module.kotlin.readValue\nimport maestro.cli.api.CliVersion\nimport maestro.cli.update.Updates\nimport maestro.cli.view.red\nimport maestro.device.CPU_ARCHITECTURE\nimport java.io.File\nimport java.io.IOException\nimport java.nio.file.Path\nimport java.nio.file.Paths\nimport java.util.Properties\nimport java.util.concurrent.TimeUnit\nimport java.util.concurrent.TimeoutException\n\nobject EnvUtils {\n private const val PROD_API_URL = \"https://api.copilot.mobile.dev\"\n\n val OS_NAME: String = System.getProperty(\"os.name\")\n val OS_ARCH: String = System.getProperty(\"os.arch\")\n val OS_VERSION: String = System.getProperty(\"os.version\")\n\n val CLI_VERSION: CliVersion? = getCLIVersion()\n\n fun getVersion(): CliVersion? {\n return getCLIVersion().apply {\n if (this == null) {\n System.err.println(\"\\nWarning: Failed to parse current version\".red())\n }\n }\n }\n\n val BASE_API_URL: String\n get() = System.getenv(\"MAESTRO_API_URL\") ?: PROD_API_URL\n\n /**\n * Where Maestro config and state files were located before v1.37.0.\n */\n fun legacyMaestroHome(): Path {\n return Paths.get(System.getProperty(\"user.home\"), \".maestro\")\n }\n\n fun xdgStateHome(): Path {\n if (System.getenv(\"XDG_STATE_HOME\") != null) {\n return Paths.get(System.getenv(\"XDG_STATE_HOME\"), \"maestro\")\n }\n\n return Paths.get(System.getProperty(\"user.home\"), \".maestro\")\n }\n\n /**\n * @return true, if we're executing from Windows Linux shell (WSL)\n */\n fun isWSL(): Boolean {\n try {\n val p1 = ProcessBuilder(\"printenv\", \"WSL_DISTRO_NAME\").start()\n if (!p1.waitFor(20, TimeUnit.SECONDS)) throw TimeoutException()\n if (p1.exitValue() == 0 && String(p1.inputStream.readBytes()).trim().isNotEmpty()) {\n return true\n }\n\n val p2 = ProcessBuilder(\"printenv\", \"IS_WSL\").start()\n if (!p2.waitFor(20, TimeUnit.SECONDS)) throw TimeoutException()\n if (p2.exitValue() == 0 && String(p2.inputStream.readBytes()).trim().isNotEmpty()) {\n return true\n }\n } catch (ignore: Exception) {\n // ignore\n }\n\n return false\n }\n\n fun isWindows(): Boolean {\n return OS_NAME.lowercase().startsWith(\"windows\")\n }\n\n /**\n * Returns major version of Java, e.g. 8, 11, 17, 21.\n */\n fun getJavaVersion(): Int {\n // Adapted from https://stackoverflow.com/a/2591122/7009800\n val version = System.getProperty(\"java.version\")\n return if (version.startsWith(\"1.\")) {\n version.substring(2, 3).toInt()\n } else {\n val dot = version.indexOf(\".\")\n if (dot != -1) version.substring(0, dot).toInt() else 0\n }\n }\n\n fun getFlutterVersionAndChannel(): Pair {\n val stdout = try {\n runProcess(\n \"flutter\",\n \"--no-version-check\", \"--version\", \"--machine\",\n ).joinToString(separator = \"\")\n } catch (e: IOException) {\n // Flutter is probably not installed\n return Pair(first = null, second = null)\n }\n\n val mapper = jacksonObjectMapper()\n val version = runCatching {\n val obj: Map = mapper.readValue(stdout)\n obj[\"flutterVersion\"].toString()\n }\n val channel = runCatching {\n val obj: Map = mapper.readValue(stdout)\n obj[\"channel\"].toString()\n }\n\n return Pair(first = version.getOrNull(), second = channel.getOrNull())\n }\n\n fun getMacOSArchitecture(): CPU_ARCHITECTURE {\n return determineArchitectureDetectionStrategy().detectArchitecture()\n }\n\n private fun determineArchitectureDetectionStrategy(): ArchitectureDetectionStrategy {\n return if (isWindows()) {\n ArchitectureDetectionStrategy.WindowsArchitectureDetection\n } else if (runProcess(\"uname\").contains(\"Linux\")) {\n ArchitectureDetectionStrategy.LinuxArchitectureDetection\n } else {\n ArchitectureDetectionStrategy.MacOsArchitectureDetection\n }\n }\n\n fun getCLIVersion(): CliVersion? {\n val props = try {\n Updates::class.java.classLoader.getResourceAsStream(\"version.properties\").use {\n Properties().apply { load(it) }\n }\n } catch (e: Exception) {\n return null\n }\n\n val versionString = props[\"version\"] as? String ?: return null\n\n return CliVersion.parse(versionString)\n }\n}\n\nsealed interface ArchitectureDetectionStrategy {\n\n fun detectArchitecture(): CPU_ARCHITECTURE\n\n object MacOsArchitectureDetection : ArchitectureDetectionStrategy {\n override fun detectArchitecture(): CPU_ARCHITECTURE {\n fun runSysctl(property: String) = runProcess(\"sysctl\", property).any { it.endsWith(\": 1\") }\n\n // Prefer sysctl over 'uname -m' due to Rosetta making it unreliable\n val isArm64 = runSysctl(\"hw.optional.arm64\")\n val isX86_64 = runSysctl(\"hw.optional.x86_64\")\n return when {\n isArm64 -> CPU_ARCHITECTURE.ARM64\n isX86_64 -> CPU_ARCHITECTURE.X86_64\n else -> CPU_ARCHITECTURE.UNKNOWN\n }\n }\n }\n\n object LinuxArchitectureDetection : ArchitectureDetectionStrategy {\n override fun detectArchitecture(): CPU_ARCHITECTURE {\n return when (runProcess(\"uname\", \"-m\").first()) {\n \"x86_64\" -> CPU_ARCHITECTURE.X86_64\n \"arm64\" -> CPU_ARCHITECTURE.ARM64\n else -> CPU_ARCHITECTURE.UNKNOWN\n }\n }\n }\n\n object WindowsArchitectureDetection: ArchitectureDetectionStrategy {\n override fun detectArchitecture(): CPU_ARCHITECTURE {\n return CPU_ARCHITECTURE.X86_64\n }\n }\n}\n\ninternal fun runProcess(program: String, vararg arguments: String): List {\n val process = ProcessBuilder(program, *arguments).start()\n return try {\n process.inputStream.reader().use { it.readLines().map(String::trim) }\n } catch (ignore: Exception) {\n emptyList()\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/ErrorReporter.kt", "content": "package maestro.cli.util\n\nimport maestro.cli.api.ApiClient\nimport picocli.CommandLine\nimport java.security.MessageDigest\nimport java.util.concurrent.Executors\nimport java.util.concurrent.TimeUnit\nimport kotlin.Exception\n\nobject ErrorReporter {\n\n private val executor = Executors.newCachedThreadPool {\n Executors.defaultThreadFactory().newThread(it).apply { isDaemon = true }\n }\n\n fun report(exception: Exception, parseResult: CommandLine.ParseResult) {\n val args = parseResult.expandedArgs()\n val scrubbedArgs = args.mapIndexed { idx, arg ->\n if (idx > 0 && args[idx - 1] in listOf(\"-e\", \"--env\")) {\n val (key, value) = arg.split(\"=\", limit = 1)\n key + \"=\" + hashString(value)\n } else arg\n }\n\n val task = executor.submit {\n ApiClient(EnvUtils.BASE_API_URL).sendErrorReport(\n exception,\n scrubbedArgs.joinToString(\" \")\n )\n }\n\n runCatching { task.get(1, TimeUnit.SECONDS) }\n }\n\n private fun hashString(input: String): String {\n return MessageDigest\n .getInstance(\"SHA-256\")\n .digest(input.toByteArray())\n .fold(StringBuilder()) { sb, it ->\n sb.append(\"%02x\".format(it))\n }.toString()\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/FileDownloader.kt", "content": "package maestro.cli.util\n\nimport io.ktor.client.HttpClient\nimport io.ktor.client.engine.cio.CIO\nimport io.ktor.client.request.request\nimport io.ktor.client.request.url\nimport io.ktor.client.statement.bodyAsChannel\nimport io.ktor.http.HttpMethod\nimport io.ktor.http.contentLength\nimport io.ktor.http.isSuccess\nimport io.ktor.utils.io.*\nimport kotlinx.coroutines.flow.Flow\nimport kotlinx.coroutines.flow.flow\nimport java.io.File\n\nobject FileDownloader {\n\n fun downloadFile(\n url: String,\n destination: File\n ): Flow {\n val httpClient = HttpClient(CIO)\n return flow {\n with(httpClient) {\n val response = request {\n url(url)\n method = HttpMethod.Get\n }.call.response\n\n val contentLength = response.contentLength()\n ?: error(\"Content length is null\")\n\n val data = ByteArray(contentLength.toInt())\n\n val bodyChannel = response.bodyAsChannel()\n\n var offset = 0\n do {\n val currentRead = bodyChannel\n .readAvailable(data, offset, data.size)\n\n offset += currentRead\n val progress = offset / data.size.toFloat()\n emit(DownloadResult.Progress(progress))\n } while (currentRead > 0)\n\n if (response.status.isSuccess()) {\n destination.writeBytes(data)\n emit(DownloadResult.Success)\n } else {\n emit(DownloadResult.Error(\"Network error. Response code: ${response.status}\"))\n }\n }\n }\n }\n\n sealed class DownloadResult {\n\n object Success : DownloadResult()\n\n data class Error(val message: String, val cause: Exception? = null) : DownloadResult()\n\n data class Progress(\n val progress: Float\n ) : DownloadResult()\n }\n\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/FileUtils.kt", "content": "package maestro.cli.util\n\nimport maestro.orchestra.yaml.YamlCommandReader\nimport maestro.utils.StringUtils.toRegexSafe\nimport java.io.File\nimport java.util.zip.ZipInputStream\n\nobject FileUtils {\n\n fun File.isZip(): Boolean {\n return try {\n ZipInputStream(inputStream()).close()\n true\n } catch (ignored: Exception) {\n false\n }\n }\n\n fun File.isWebFlow(): Boolean {\n if (isDirectory) {\n return listFiles()\n ?.any { it.isWebFlow() }\n ?: false\n }\n\n val isYaml =\n name.endsWith(\".yaml\", ignoreCase = true) ||\n name.endsWith(\".yml\", ignoreCase = true)\n\n if (\n !isYaml ||\n name.equals(\"config.yaml\", ignoreCase = true) ||\n name.equals(\"config.yml\", ignoreCase = true)\n ) {\n return false\n }\n\n val config = YamlCommandReader.readConfig(toPath())\n return config.url != null\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/IOSEnvUtils.kt", "content": "package maestro.cli.util\n\nimport java.io.IOException\nimport kotlin.io.path.Path\n\nobject IOSEnvUtils {\n\n val simulatorRuntimes: List\n get() {\n // See also: https://stackoverflow.com/a/78755176/7009800\n\n val topLevelDirs = Path(\"/Library/Developer/CoreSimulator/Volumes\").toFile()\n .listFiles()\n ?.filter { it.exists() } ?: emptyList()\n\n val installedRuntimes = topLevelDirs\n .map { it.resolve(\"Library/Developer/CoreSimulator/Profiles/Runtimes\") }\n .map { it.listFiles() ?: emptyArray() }\n .reduceOrNull { acc, list -> acc + list }\n ?.map { file -> file.nameWithoutExtension } ?: emptyList()\n\n return installedRuntimes\n }\n\n val xcodeVersion: String?\n get() {\n val lines = try {\n runProcess(\"xcodebuild\", \"-version\")\n } catch (e: IOException) {\n // Xcode toolchain is probably not installed\n return null\n }\n\n if (lines.size == 2 && lines.first().contains(' ')) {\n // Correct xcodebuild invocation is always 2 lines. Example:\n // $ xcodebuild -version\n // Xcode 15.4\n // Build version 15F31d\n return lines.first().split(' ')[1]\n }\n\n return null\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/PrintUtils.kt", "content": "package maestro.cli.util\n\nimport org.fusesource.jansi.Ansi\nimport java.io.IOException\nimport kotlin.system.exitProcess\n\nobject PrintUtils {\n\n fun info(message: String, bold: Boolean = false, newline: Boolean = true) {\n val function: (Any) -> Unit = if (newline) ::println else ::print\n function(\n Ansi.ansi()\n .bold(apply = bold)\n .render(message)\n .boldOff()\n )\n }\n\n fun message(message: String) {\n println(Ansi.ansi().render(\"@|cyan \\n$message|@\"))\n }\n\n fun prompt(message: String): String {\n print(Ansi.ansi().render(\"\\n@|yellow,bold $message\\n>|@\"))\n try {\n return readln().trim()\n } catch (e: IOException) {\n exitProcess(1)\n }\n }\n\n fun success(message: String, bold: Boolean = false) {\n println(\n Ansi.ansi()\n .render(\"\\n\")\n .fgBrightGreen()\n .bold(apply = bold)\n .render(message)\n .boldOff()\n .fgDefault()\n )\n }\n\n fun err(message: String, bold: Boolean = false) {\n println(\n Ansi.ansi()\n .render(\"\\n\")\n .fgRed()\n .bold(apply = bold)\n .render(message)\n .boldOff()\n .fgDefault()\n )\n }\n\n fun warn(message: String, bold: Boolean = false) {\n println(\n Ansi.ansi()\n .render(\"\\n\")\n .fgYellow()\n .bold(apply = bold)\n .render(message)\n .boldOff()\n .fgDefault()\n )\n }\n\n fun Ansi.bold(apply: Boolean = true): Ansi {\n return if (apply) {\n bold()\n } else {\n this\n }\n }\n\n fun clearConsole() {\n print(\"\\u001b[H\\u001b[2J\")\n System.out.flush()\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/ResourceUtils.kt", "content": "import kotlin.reflect.KClass\n\nfun readResourceAsText(cls: KClass<*>, path: String): String {\n val resourceStream = cls::class.java.getResourceAsStream(path)\n ?: throw IllegalStateException(\"Could not find $path in resources\")\n\n return resourceStream.bufferedReader().use { it.readText() }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/ScreenReporter.kt", "content": "package maestro.cli.util\n\nimport maestro.cli.api.ApiClient\nimport maestro.utils.DepthTracker\n\nobject ScreenReporter {\n\n fun reportMaxDepth() {\n val maxDepth = DepthTracker.getMaxDepth()\n\n if (maxDepth == 0) return\n\n ApiClient(EnvUtils.BASE_API_URL).sendScreenReport(maxDepth = maxDepth)\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/ScreenshotUtils.kt", "content": "package maestro.cli.util\n\nimport java.io.File\nimport maestro.Maestro\nimport maestro.cli.report.FlowDebugOutput\nimport maestro.cli.runner.CommandStatus\nimport okio.Buffer\nimport okio.sink\n\nobject ScreenshotUtils {\n\n fun takeDebugScreenshot(maestro: Maestro, debugOutput: FlowDebugOutput, status: CommandStatus): File? {\n val containsFailed = debugOutput.screenshots.any { it.status == CommandStatus.FAILED }\n\n // Avoids duplicate failed images from parent commands\n if (containsFailed && status == CommandStatus.FAILED) {\n return null\n }\n\n val result = kotlin.runCatching {\n val out = File\n .createTempFile(\"screenshot-${System.currentTimeMillis()}\", \".png\")\n .also { it.deleteOnExit() } // save to another dir before exiting\n maestro.takeScreenshot(out.sink(), false)\n debugOutput.screenshots.add(\n FlowDebugOutput.Screenshot(\n screenshot = out,\n timestamp = System.currentTimeMillis(),\n status = status\n )\n )\n out\n }\n\n return result.getOrNull()\n }\n\n fun takeDebugScreenshotByCommand(maestro: Maestro, debugOutput: FlowDebugOutput, status: CommandStatus): File? {\n val result = kotlin.runCatching {\n val out = File\n .createTempFile(\"screenshot-${status}-${System.currentTimeMillis()}\", \".png\")\n .also { it.deleteOnExit() } // save to another dir before exiting\n maestro.takeScreenshot(out.sink(), false)\n debugOutput.screenshots.add(\n FlowDebugOutput.Screenshot(\n screenshot = out,\n timestamp = System.currentTimeMillis(),\n status = status\n )\n )\n out\n }\n\n return result.getOrNull()\n }\n\n fun writeAIscreenshot(buffer: Buffer): File {\n val out = File\n .createTempFile(\"ai-screenshot-${System.currentTimeMillis()}\", \".png\")\n .also { it.deleteOnExit() }\n out.outputStream().use { it.write(buffer.readByteArray()) }\n return out\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/SocketUtils.kt", "content": "package maestro.cli.util\n\nimport java.net.ServerSocket\n\nfun getFreePort(): Int {\n (9999..11000).forEach { port ->\n try {\n ServerSocket(port).use { return it.localPort }\n } catch (ignore: Exception) {}\n }\n ServerSocket(0).use { return it.localPort }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/TimeUtils.kt", "content": "package maestro.cli.util\n\nimport kotlin.math.roundToLong\nimport kotlin.time.Duration\nimport kotlin.time.Duration.Companion.seconds\n\nobject TimeUtils {\n\n fun durationInSeconds(startTimeInMillis: Long?, endTimeInMillis: Long?): Duration {\n if (startTimeInMillis == null || endTimeInMillis == null) return Duration.ZERO\n return ((endTimeInMillis - startTimeInMillis) / 1000f).roundToLong().seconds\n }\n\n fun durationInSeconds(durationInMillis: Long): Duration {\n return ((durationInMillis) / 1000f).roundToLong().seconds\n }\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/Unpacker.kt", "content": "package maestro.cli.util\n\nimport org.apache.commons.codec.digest.DigestUtils\nimport java.io.File\nimport java.net.URL\nimport java.nio.file.FileSystems\nimport java.nio.file.Files\nimport java.nio.file.Paths\nimport java.nio.file.attribute.PosixFilePermission\n\n/**\n * Unpacks files from jar resources.\n */\nobject Unpacker {\n\n fun unpack(\n jarPath: String,\n target: File,\n ) {\n Unpacker::class.java.classLoader.getResource(jarPath)?.let { resource ->\n if (target.exists()) {\n if (sameContents(resource, target)) {\n return\n }\n }\n\n target.writeBytes(resource.readBytes())\n }\n }\n\n private fun sameContents(resource: URL, target: File): Boolean {\n return DigestUtils.sha1Hex(resource.openStream()) == DigestUtils.sha1Hex(target.inputStream())\n }\n\n fun binaryDependency(name: String): File {\n return Paths\n .get(\n System.getProperty(\"user.home\"),\n \".maestro\",\n \"deps\",\n name\n )\n .toAbsolutePath()\n .toFile()\n .also { file ->\n createParentDirectories(file)\n createFileIfDoesNotExist(file)\n grantBinaryPermissions(file)\n }\n }\n\n private fun createParentDirectories(file: File) {\n file.parentFile?.let { parent ->\n if (!parent.exists()) {\n parent.mkdirs()\n }\n }\n }\n\n private fun createFileIfDoesNotExist(file: File) {\n if (!file.exists()) {\n if (!file.createNewFile()) {\n error(\"Unable to create file $file\")\n }\n }\n }\n\n private fun grantBinaryPermissions(file: File) {\n if (isPosixFilesystem()) {\n Files.setPosixFilePermissions(\n file.toPath(),\n setOf(\n PosixFilePermission.OWNER_EXECUTE,\n PosixFilePermission.OWNER_READ,\n PosixFilePermission.OWNER_WRITE,\n )\n )\n }\n }\n\n private fun isPosixFilesystem() = FileSystems.getDefault()\n .supportedFileAttributeViews()\n .contains(\"posix\")\n\n}" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/WorkingDirectory.kt", "content": "package maestro.cli.util\n\nimport java.io.File\n\nobject WorkingDirectory {\n var baseDir: File = File(System.getProperty(\"user.dir\"))\n\n fun resolve(path: String): File = File(baseDir, path)\n fun resolve(file: File): File = if (file.isAbsolute) file else File(baseDir, file.path)\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/util/WorkspaceUtils.kt", "content": "package maestro.cli.util\n\nimport java.io.FileNotFoundException\nimport java.net.URI\nimport java.nio.file.FileSystems\nimport java.nio.file.Files\nimport java.nio.file.Path\nimport kotlin.io.path.absolutePathString\nimport kotlin.io.path.copyTo\nimport kotlin.io.path.exists\nimport kotlin.io.path.isDirectory\nimport kotlin.streams.toList\n\nobject WorkspaceUtils {\n\n fun createWorkspaceZip(file: Path, out: Path) {\n if (!file.exists()) throw FileNotFoundException(file.absolutePathString())\n if (out.exists()) throw FileAlreadyExistsException(out.toFile())\n \n val filesToInclude = if (!file.isDirectory()) {\n DependencyResolver.discoverAllDependencies(file)\n } else {\n Files.walk(file).filter { !it.isDirectory() }.toList()\n }\n val relativeTo = if (file.isDirectory()) file else file.parent\n createWorkspaceZipFromFiles(filesToInclude, relativeTo, out)\n }\n \n fun createWorkspaceZipFromFiles(files: List, relativeTo: Path, out: Path) {\n if (out.exists()) throw FileAlreadyExistsException(out.toFile())\n \n val outUri = URI.create(\"jar:${out.toUri()}\")\n FileSystems.newFileSystem(outUri, mapOf(\"create\" to \"true\")).use { fs ->\n files.forEach {\n val outPath = fs.getPath(relativeTo.relativize(it).toString())\n if (outPath.parent != null) {\n Files.createDirectories(outPath.parent)\n }\n it.copyTo(outPath)\n }\n }\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/view/ErrorViewUtils.kt", "content": "package maestro.cli.view\n\nimport maestro.MaestroException\nimport maestro.orchestra.error.InvalidFlowFile\nimport maestro.orchestra.error.NoInputException\nimport maestro.orchestra.error.UnicodeNotSupportedError\nimport maestro.orchestra.error.ValidationError\nimport org.mozilla.javascript.EcmaError\n\nobject ErrorViewUtils {\n\n fun exceptionToMessage(e: Exception): String {\n return when (e) {\n is ValidationError -> e.message\n is NoInputException -> \"No commands found in Flow file\"\n is InvalidFlowFile -> \"Flow file is invalid: ${e.flowPath}\"\n is UnicodeNotSupportedError -> \"Unicode character input is not supported: ${e.text}. Please use ASCII characters. Follow the issue: https://github.com/mobile-dev-inc/maestro/issues/146\"\n is InterruptedException -> \"Interrupted\"\n is MaestroException -> e.message\n is EcmaError -> \"${e.name}: ${e.message}}\"\n else -> e.stackTraceToString()\n }\n }\n\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/view/ProgressBar.kt", "content": "package maestro.cli.view\n\nimport maestro.cli.DisableAnsiMixin\nimport org.fusesource.jansi.Ansi\n\nclass ProgressBar(private val width: Int) {\n\n private var progressWidth: Int? = null\n private var alreadyPrinted = 0\n\n fun set(progress: Float) {\n if (DisableAnsiMixin.ansiEnabled) {\n val progressWidth = (progress * width).toInt()\n if (progressWidth == this.progressWidth) return\n this.progressWidth = progressWidth\n val ansi = Ansi.ansi()\n ansi.cursorToColumn(0)\n ansi.fgCyan()\n repeat(progressWidth) { ansi.a(\"โ–ˆ\") }\n repeat(width - progressWidth) { ansi.a(\"โ–‘\") }\n ansi.fgDefault()\n System.err.print(ansi)\n } else {\n val progressFactor = (progress * width).toInt()\n var amountToAdd = progressFactor - alreadyPrinted\n if (amountToAdd < 0) amountToAdd = 0\n alreadyPrinted = progressFactor\n print(\".\".repeat(amountToAdd))\n }\n }\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/view/TestSuiteStatusView.kt", "content": "package maestro.cli.view\n\nimport maestro.cli.api.UploadStatus\nimport maestro.cli.model.FlowStatus\nimport maestro.cli.util.PrintUtils\nimport maestro.cli.view.TestSuiteStatusView.TestSuiteViewModel.FlowResult\nimport maestro.cli.view.TestSuiteStatusView.uploadUrl\nimport org.fusesource.jansi.Ansi\nimport java.util.UUID\nimport kotlin.time.Duration\nimport kotlin.time.Duration.Companion.milliseconds\nimport kotlin.time.Duration.Companion.seconds\n\nobject TestSuiteStatusView {\n\n fun showFlowCompletion(result: FlowResult) {\n val shardPrefix = result.shardIndex?.let { \"[shard ${it + 1}] \" }.orEmpty()\n print(Ansi.ansi().fgCyan().render(shardPrefix).fgDefault())\n\n printStatus(result.status, result.cancellationReason)\n\n val durationString = result.duration?.let { \" ($it)\" }.orEmpty()\n print(\" ${result.name}$durationString\")\n\n if (result.status == FlowStatus.ERROR && result.error != null) {\n val error = \" (${result.error})\"\n print(Ansi.ansi().fgRed().render(error).fgDefault())\n }\n else if (result.status == FlowStatus.WARNING) {\n val warning = \" (Warning)\"\n print(Ansi.ansi().fgYellow().render(warning).fgDefault())\n }\n println()\n }\n\n fun showSuiteResult(\n suite: TestSuiteViewModel,\n uploadUrl: String,\n ) {\n val hasError = suite.flows.find { it.status == FlowStatus.ERROR } != null\n val canceledFlows = suite.flows\n .filter { it.status == FlowStatus.CANCELED }\n val shardPrefix = suite.shardIndex?.let { \"[shard ${it + 1}] \" }.orEmpty()\n\n if (suite.status == FlowStatus.ERROR || hasError) {\n val failedFlows = suite.flows\n .filter { it.status == FlowStatus.ERROR }\n\n PrintUtils.err(\n \"${shardPrefix}${failedFlows.size}/${suite.flows.size} ${flowWord(failedFlows.size)} Failed\",\n bold = true,\n )\n\n if (canceledFlows.isNotEmpty()) {\n PrintUtils.warn(\"${shardPrefix}${canceledFlows.size} ${flowWord(canceledFlows.size)} Canceled\")\n }\n } else {\n val passedFlows = suite.flows\n .filter { it.status == FlowStatus.SUCCESS || it.status == FlowStatus.WARNING }\n\n\n if (passedFlows.isNotEmpty()) {\n val durationMessage = suite.duration?.let { \" in $it\" } ?: \"\"\n PrintUtils.success(\n \"${shardPrefix}${passedFlows.size}/${suite.flows.size} ${flowWord(passedFlows.size)} Passed$durationMessage\",\n bold = true,\n )\n\n if (canceledFlows.isNotEmpty()) {\n PrintUtils.warn(\"${shardPrefix}${canceledFlows.size} ${flowWord(canceledFlows.size)} Canceled\")\n }\n } else {\n println()\n PrintUtils.err(\"${shardPrefix}All flows were canceled\")\n }\n }\n println()\n\n if (suite.uploadDetails != null) {\n PrintUtils.info(\"==== View Details on Maestro Cloud ====\")\n PrintUtils.info(uploadUrl.cyan())\n println()\n }\n }\n\n private fun printStatus(status: FlowStatus, cancellationReason: UploadStatus.CancellationReason?) {\n val color = when (status) {\n FlowStatus.SUCCESS,\n FlowStatus.WARNING -> Ansi.Color.GREEN\n FlowStatus.ERROR -> Ansi.Color.RED\n FlowStatus.STOPPED -> Ansi.Color.RED\n else -> Ansi.Color.DEFAULT\n }\n val title = when (status) {\n FlowStatus.SUCCESS,\n FlowStatus.WARNING -> \"Passed\"\n FlowStatus.ERROR -> \"Failed\"\n FlowStatus.PENDING -> \"Pending\"\n FlowStatus.RUNNING -> \"Running\"\n FlowStatus.STOPPED -> \"Stopped\"\n FlowStatus.PREPARING -> \"Preparing Device\"\n FlowStatus.INSTALLING -> \"Installing App\"\n FlowStatus.CANCELED -> when (cancellationReason) {\n UploadStatus.CancellationReason.TIMEOUT -> \"Timeout\"\n UploadStatus.CancellationReason.OVERLAPPING_BENCHMARK -> \"Skipped\"\n UploadStatus.CancellationReason.BENCHMARK_DEPENDENCY_FAILED -> \"Skipped\"\n UploadStatus.CancellationReason.CANCELED_BY_USER -> \"Canceled by user\"\n UploadStatus.CancellationReason.RUN_EXPIRED -> \"Run expired\"\n else -> \"Canceled (unknown reason)\"\n }\n }\n\n print(\n Ansi.ansi()\n .fgBright(color)\n .render(\"[$title]\")\n .fgDefault()\n )\n }\n\n fun uploadUrl(\n projectId: String,\n appId: String,\n uploadId: String,\n domain: String = \"\"\n ): String {\n return if (domain.contains(\"localhost\")) {\n \"http://localhost:3000/project/$projectId/maestro-test/app/$appId/upload/$uploadId\"\n } else {\n \"https://app.maestro.dev/project/$projectId/maestro-test/app/$appId/upload/$uploadId\"\n }\n }\n\n private fun flowWord(count: Int) = if (count == 1) \"Flow\" else \"Flows\"\n\n data class TestSuiteViewModel(\n val status: FlowStatus,\n val flows: List,\n val duration: Duration? = null,\n val shardIndex: Int? = null,\n val uploadDetails: UploadDetails? = null,\n ) {\n\n data class FlowResult(\n val name: String,\n val status: FlowStatus,\n val duration: Duration? = null,\n val error: String? = null,\n val shardIndex: Int? = null,\n val cancellationReason: UploadStatus.CancellationReason? = null\n )\n\n data class UploadDetails(\n val uploadId: String,\n val appId: String,\n val domain: String,\n )\n\n companion object {\n\n fun UploadStatus.toViewModel(\n uploadDetails: UploadDetails\n ) = TestSuiteViewModel(\n uploadDetails = uploadDetails,\n status = FlowStatus.from(status),\n flows = flows.map {\n it.toViewModel()\n }\n )\n\n fun UploadStatus.FlowResult.toViewModel() = FlowResult(\n name = name,\n status = status,\n error = errors.firstOrNull(),\n cancellationReason = cancellationReason,\n duration = totalTime?.milliseconds\n )\n }\n\n }\n\n}\n\n// Helper launcher to play around with presentation\nfun main() {\n val uploadDetails = TestSuiteStatusView.TestSuiteViewModel.UploadDetails(\n uploadId = UUID.randomUUID().toString(),\n appId = \"appid\",\n domain = \"mobile.dev\",\n )\n val status = TestSuiteStatusView.TestSuiteViewModel(\n uploadDetails = uploadDetails,\n status = FlowStatus.CANCELED,\n flows = listOf(\n FlowResult(\n name = \"A\",\n status = FlowStatus.SUCCESS,\n duration = 42.seconds,\n ),\n FlowResult(\n name = \"B\",\n status = FlowStatus.SUCCESS,\n duration = 231.seconds,\n ),\n FlowResult(\n name = \"C\",\n status = FlowStatus.CANCELED,\n )\n ),\n duration = 273.seconds,\n )\n\n status.flows\n .forEach {\n TestSuiteStatusView.showFlowCompletion(it)\n }\n\n val uploadUrl = uploadUrl(\n uploadDetails.uploadId.toString(),\n \"teamid\",\n uploadDetails.appId,\n uploadDetails.domain,\n )\n TestSuiteStatusView.showSuiteResult(status, uploadUrl)\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/view/ViewUtils.kt", "content": "package maestro.cli.view\n\nimport org.fusesource.jansi.Ansi\n\nfun String.magenta(): String {\n return \"@|magenta $this|@\".render()\n}\n\nfun String.red(): String {\n return \"@|red $this|@\".render()\n}\n\nfun String.brightRed(): String {\n return \"\\u001B[91m$this\\u001B[0m\"\n}\n\nfun String.green(): String {\n return \"@|green $this|@\".render()\n}\n\nfun String.blue(): String {\n return \"@|blue $this|@\".render()\n}\n\nfun String.bold(): String {\n return \"@|bold $this|@\".render()\n}\n\nfun String.yellow(): String {\n return \"@|yellow $this|@\".render()\n}\n\nfun String.cyan(): String {\n return \"@|cyan $this|@\".render()\n}\n\nfun String.faint(): String {\n return \"@|faint $this|@\".render()\n}\n\nfun String.box(): String {\n return boxWithColor { it.magenta() }\n}\n\nfun String.greenBox(): String {\n return boxWithColor { it.green() }\n}\n\nprivate fun String.boxWithColor(colorize: (String) -> String): String {\n val lines = this.lines()\n\n val messageWidth = lines.map { it.replace(Regex(\"\\u001B\\\\[[\\\\d;]*[^\\\\d;]\"),\"\") }.maxOf { it.length }\n val paddingX = 3\n val paddingY = 1\n val width = messageWidth + paddingX * 2\n\n val tl = colorize(\"โ•ญ\")\n val tr = colorize(\"โ•ฎ\")\n val bl = colorize(\"โ•ฐ\")\n val br = colorize(\"โ•ฏ\")\n val hl = colorize(\"โ”€\")\n val vl = colorize(\"โ”‚\")\n\n val py = \"$vl${\" \".repeat(width)}$vl\\n\".repeat(paddingY)\n val px = \" \".repeat(paddingX)\n val l = \"$vl$px\"\n val r = \"$px$vl\"\n\n val sb = StringBuilder()\n sb.appendLine(\"$tl${hl.repeat(width)}$tr\")\n sb.append(py)\n lines.forEach { line ->\n sb.appendLine(\"$l${padRight(line, messageWidth)}$r\")\n }\n sb.append(py)\n sb.appendLine(\"$bl${hl.repeat(width)}$br\")\n\n return sb.toString()\n}\n\nfun String.render(): String {\n return Ansi.ansi().render(this).toString()\n}\n\nprivate fun padRight(s: String, width: Int): String {\n // Strip ANSI escape sequences to compute the visible width\n val visible = s.replace(Regex(\"\\u001B\\\\[[\\\\d;]*[^\\\\d;]\"), \"\")\n val pad = (width - visible.length).coerceAtLeast(0)\n return s + \" \".repeat(pad)\n}\n" }, { "path": "maestro-cli/src/main/java/maestro/cli/web/WebInteractor.kt", "content": "package maestro.cli.web\n\nimport maestro.cli.util.FileUtils.isWebFlow\nimport maestro.orchestra.yaml.YamlCommandReader\nimport java.io.File\n\nobject WebInteractor {\n\n fun createManifestFromWorkspace(workspaceFile: File): File? {\n val appId = inferAppId(workspaceFile) ?: return null\n\n val manifest = \"\"\"\n {\n \"url\": \"$appId\"\n }\n \"\"\".trimIndent()\n\n val manifestFile = File.createTempFile(\"manifest\", \".json\")\n manifestFile.writeText(manifest)\n return manifestFile\n }\n\n private fun inferAppId(file: File): String? {\n if (file.isDirectory) {\n return file.listFiles()\n ?.firstNotNullOfOrNull { inferAppId(it) }\n }\n\n if (!file.isWebFlow()) {\n return null\n }\n\n return file.readText()\n .let { YamlCommandReader.readConfig(file.toPath()) }\n .appId\n }\n\n}" }, { "path": "maestro-cli/src/main/resources/ai_report.css", "content": "@layer components {\n body {\n @apply dark:bg-gray-dark dark:text-gray-1 text-gray-dark;\n }\n\n .screenshot-image {\n @apply w-64 rounded-lg border-2 border-gray-medium dark:border-gray-1 pb-1;\n }\n\n .screen-card {\n @apply flex items-start gap-4;\n }\n\n .defect-card {\n @apply flex flex-col items-start gap-2 rounded-lg bg-[#f8f8f8] p-2 text-gray-dark dark:bg-gray-medium dark:text-gray-1;\n }\n\n .badge {\n @apply dark:text-red-500 rounded-lg bg-[#ececec] dark:bg-gray-dark p-1 font-semibold text-gray-medium dark:text-gray-1;\n }\n\n .toggle-link {\n @apply block border-2 border-gray-medium bg-[#ececec] px-3 py-4 text-gray-medium hover:bg-gray-medium hover:text-[#ececec];\n }\n\n .toggle-link-selected {\n @apply border-orange-2;\n }\n\n .divider {\n @apply h-0.5 rounded-sm bg-gray-medium dark:bg-gray-1 my-2;\n }\n\n .btn {\n @apply hover:text-gray-medium dark:hover:text-gray-medium;\n }\n}\n" }, { "path": "maestro-cli/src/main/resources/html-detailed.css", "content": ".step-item {\n border-left: 3px solid #dee2e6;\n padding-left: 12px;\n padding-top: 8px;\n padding-bottom: 8px;\n}\n\n.step-header {\n font-family: monospace;\n font-size: 14px;\n}\n\n.step-name {\n font-weight: 500;\n}\n" }, { "path": "maestro-cli/src/main/resources/logback-test.xml", "content": "\n \n \n [%-5level] %logger{36} - %msg%n\n \n \n\n \n\n\n \n \n \n\n \n \n \n" }, { "path": "maestro-cli/src/main/resources/tailwind.config.js", "content": "tailwind.config = {\n darkMode: \"media\",\n theme: {\n extend: {\n colors: {\n \"gray-dark\": \"#110c22\", // text-gray-dark\n \"gray-medium\": \"#4f4b5c\", // text-gray-medium\n \"gray-1\": \"#f8f8f8\", // surface-gray-1\n \"gray-0\": \"#110C22\", // surface-gray-0\n \"orange-2\": \"#ff9254\", // surface-orange-2\n },\n },\n },\n};\n" }, { "path": "maestro-cli/src/test/kotlin/maestro/cli/android/AndroidDeviceProvider.kt", "content": "package maestro.cli.android\n\nimport dadb.Dadb\nimport dadb.adbserver.AdbServer\n\nclass AndroidDeviceProvider {\n\n fun local(): Dadb {\n val dadb = AdbServer.createDadb(connectTimeout = 60_000, socketTimeout = 60_000)\n\n return dadb\n }\n}" }, { "path": "maestro-cli/src/test/kotlin/maestro/cli/cloud/CloudInteractorTest.kt", "content": "package maestro.cli.cloud\n\nimport com.google.common.truth.Truth.assertThat\nimport io.mockk.*\nimport maestro.cli.CliError\nimport maestro.cli.api.ApiClient\nimport maestro.cli.api.AppBinaryInfo\nimport maestro.cli.api.DeviceConfiguration\nimport maestro.cli.api.UploadResponse\nimport maestro.cli.api.UploadStatus\nimport maestro.cli.auth.Auth\nimport maestro.cli.model.FlowStatus\nimport maestro.cli.report.ReportFormat\nimport maestro.orchestra.validation.AppMetadataAnalyzer\nimport maestro.orchestra.validation.WorkspaceValidator\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Test\nimport org.junit.jupiter.api.AfterEach\nimport org.junit.jupiter.api.assertThrows\nimport org.junit.jupiter.api.io.TempDir\nimport java.io.ByteArrayOutputStream\nimport java.io.File\nimport java.io.PrintStream\nimport java.util.concurrent.TimeUnit\n\nclass CloudInteractorTest {\n\n private lateinit var mockApiClient: ApiClient\n private lateinit var mockAuth: Auth\n\n private lateinit var originalOut: PrintStream\n private lateinit var outputStream: ByteArrayOutputStream\n\n @TempDir\n lateinit var tempDir: File\n\n @BeforeEach\n fun setUp() {\n mockApiClient = mockk(relaxed = true)\n mockAuth = mockk(relaxed = true)\n every { mockAuth.getAuthToken(any(), any()) } returns \"test-token\"\n every { mockApiClient.getProjects(any()) } returns listOf(\n maestro.cli.api.ProjectResponse(id = \"proj_1\", name = \"Test Project\")\n )\n every { mockApiClient.listCloudDevices() } returns mapOf(\n \"android\" to mapOf(\"pixel_6\" to listOf(\"android-34\", \"android-33\", \"android-31\", \"android-30\", \"android-29\")),\n \"ios\" to mapOf(\n \"iPhone-11\" to listOf(\"iOS-16-2\", \"iOS-17-5\", \"iOS-18-2\"),\n \"iPhone-14\" to listOf(\"iOS-16-2\", \"iOS-17-5\", \"iOS-18-2\"),\n ),\n \"web\" to mapOf(\"chromium\" to listOf(\"default\")),\n )\n\n // Capture console output\n originalOut = System.out\n outputStream = ByteArrayOutputStream()\n System.setOut(PrintStream(outputStream))\n }\n\n @AfterEach\n fun tearDown() {\n System.setOut(originalOut)\n }\n\n // ---- Fixtures from test resources ----\n\n private fun resourceFile(path: String): File =\n File(javaClass.getResource(path)!!.toURI())\n\n private fun androidFlowFile(): File = resourceFile(\"/workspaces/cloud_test/android/flow.yaml\")\n private fun iosFlowFile(): File = resourceFile(\"/workspaces/cloud_test/ios/flow.yaml\")\n private fun webFlowFile(): File = resourceFile(\"/workspaces/cloud_test/web/flow.yaml\")\n private fun taggedFlowDir(): File = resourceFile(\"/workspaces/cloud_test/tagged\")\n private fun iosApp(): File = resourceFile(\"/apps/test-ios.zip\")\n private fun webManifest(): File = resourceFile(\"/apps/web-manifest.json\")\n\n /** Creates a flow file with a custom appId in tempDir (for mismatch / error tests). */\n private fun createFlowFile(appId: String): File {\n return File(tempDir, \"flow.yaml\").also {\n it.writeText(\"appId: $appId\\n---\\n- launchApp\\n\")\n }\n }\n\n private fun stubUploadResponse(\n platform: String = \"Android\",\n appBinaryId: String? = null,\n ) {\n every {\n mockApiClient.upload(\n authToken = any(), appFile = any(), workspaceZip = any(),\n uploadName = any(), mappingFile = any(), repoOwner = any(),\n repoName = any(), branch = any(), commitSha = any(),\n pullRequestId = any(), env = any(), appBinaryId = any(), includeTags = any(),\n excludeTags = any(), disableNotifications = any(),\n deviceLocale = any(), progressListener = any(),\n projectId = any(), deviceModel = any(), deviceOs = any(),\n androidApiLevel = any(), iOSVersion = any(),\n )\n } returns UploadResponse(\n orgId = \"org_1\",\n uploadId = \"upload_1\",\n appId = \"app_1\",\n deviceConfiguration = DeviceConfiguration(\n platform = platform,\n deviceName = \"Test Device\",\n orientation = \"portrait\",\n osVersion = \"33\",\n displayInfo = \"Test Device\",\n deviceLocale = \"en_US\",\n ),\n appBinaryId = appBinaryId,\n )\n\n // Stub the upload status for async=true (not polled)\n every { mockApiClient.uploadStatus(any(), any(), any()) } returns UploadStatus(\n uploadId = \"upload_1\",\n status = UploadStatus.Status.SUCCESS,\n completed = true,\n totalTime = 30L,\n startTime = 0L,\n flows = emptyList(),\n appPackageId = null,\n wasAppLaunched = false,\n )\n }\n\n private fun createCloudInteractor(\n webManifestProvider: (() -> File?)? = null,\n ): CloudInteractor {\n return CloudInteractor(\n client = mockApiClient,\n appFileValidator = { AppMetadataAnalyzer.validateAppFile(it) },\n workspaceValidator = WorkspaceValidator(),\n webManifestProvider = webManifestProvider,\n auth = mockAuth,\n waitTimeoutMs = TimeUnit.SECONDS.toMillis(1),\n minPollIntervalMs = TimeUnit.MILLISECONDS.toMillis(10),\n maxPollingRetries = 2,\n failOnTimeout = true,\n )\n }\n\n // ---- 1. iOS .app + matching workspace (happy path) ----\n\n @Test\n fun `upload with iOS app file and matching workspace succeeds`() {\n stubUploadResponse(platform = \"IOS\")\n\n val result = createCloudInteractor().upload(\n flowFile = iosFlowFile(),\n appFile = iosApp(),\n async = true,\n projectId = \"proj_1\",\n )\n\n assertThat(result).isEqualTo(0)\n verify { mockApiClient.upload(\n authToken = \"test-token\",\n appFile = any(),\n workspaceZip = any(),\n uploadName = any(),\n mappingFile = any(),\n repoOwner = any(),\n repoName = any(),\n branch = any(),\n commitSha = any(),\n pullRequestId = any(),\n env = any(),\n appBinaryId = isNull(),\n includeTags = any(),\n excludeTags = any(),\n disableNotifications = any(),\n deviceLocale = any(),\n progressListener = any(),\n projectId = \"proj_1\",\n deviceModel = any(),\n deviceOs = any(),\n androidApiLevel = any(),\n iOSVersion = any(),\n ) }\n }\n\n // ---- 2. Web flow (no app file) ----\n\n @Test\n fun `upload with web flow and no app file succeeds`() {\n stubUploadResponse(platform = \"WEB\")\n\n val result = createCloudInteractor(webManifestProvider = { webManifest() }).upload(\n flowFile = webFlowFile(),\n appFile = null,\n async = true,\n projectId = \"proj_1\",\n )\n\n assertThat(result).isEqualTo(0)\n }\n\n // ---- 3. --app-binary-id Android ----\n\n @Test\n fun `upload with Android appBinaryId resolves platform from server`() {\n stubUploadResponse(platform = \"Android\", appBinaryId = \"bin_android_1\")\n\n every { mockApiClient.getAppBinaryInfo(\"test-token\", \"bin_android_1\") } returns AppBinaryInfo(\n appBinaryId = \"bin_android_1\",\n platform = \"Android\",\n appId = \"com.example.maestro.orientation\",\n )\n\n val result = createCloudInteractor().upload(\n flowFile = androidFlowFile(),\n appFile = null,\n async = true,\n appBinaryId = \"bin_android_1\",\n projectId = \"proj_1\",\n )\n\n assertThat(result).isEqualTo(0)\n verify(exactly = 1) { mockApiClient.getAppBinaryInfo(\"test-token\", \"bin_android_1\") }\n }\n\n // ---- 4. --app-binary-id iOS ----\n\n @Test\n fun `upload with iOS appBinaryId resolves platform from server`() {\n stubUploadResponse(platform = \"IOS\", appBinaryId = \"bin_ios_1\")\n\n every { mockApiClient.getAppBinaryInfo(\"test-token\", \"bin_ios_1\") } returns AppBinaryInfo(\n appBinaryId = \"bin_ios_1\",\n platform = \"iOS\",\n appId = \"com.example.SimpleWebViewApp\",\n )\n\n val result = createCloudInteractor().upload(\n flowFile = iosFlowFile(),\n appFile = null,\n async = true,\n appBinaryId = \"bin_ios_1\",\n projectId = \"proj_1\",\n )\n\n assertThat(result).isEqualTo(0)\n verify(exactly = 1) { mockApiClient.getAppBinaryInfo(\"test-token\", \"bin_ios_1\") }\n }\n\n // ---- 5. Missing app file + no binary ID + not web ----\n\n @Test\n fun `upload throws CliError when no app file, no binary id, and not web flow`() {\n val error = assertThrows {\n createCloudInteractor().upload(\n flowFile = androidFlowFile(),\n appFile = null,\n async = true,\n projectId = \"proj_1\",\n )\n }\n\n assertThat(error.message).contains(\"Missing required parameter\")\n }\n\n // ---- 6. Workspace with no matching flows ----\n\n @Test\n fun `upload throws CliError when workspace flows do not match app id`() {\n // Flow has appId=com.example.SimpleWebViewApp but we tell the server the app is \"com.different.app\"\n val flowFile = createFlowFile(\"com.nonexistent.app\")\n\n val error = assertThrows {\n createCloudInteractor().upload(\n flowFile = flowFile,\n appFile = iosApp(),\n async = true,\n projectId = \"proj_1\",\n )\n }\n\n assertThat(error.message).contains(\"No flows in workspace match app ID\")\n }\n\n // ---- 7. --app-binary-id not found (404) ----\n\n @Test\n fun `upload throws CliError when appBinaryId not found on server`() {\n every { mockApiClient.getAppBinaryInfo(\"test-token\", \"nonexistent\") } throws ApiClient.ApiException(404)\n\n val error = assertThrows {\n createCloudInteractor().upload(\n flowFile = androidFlowFile(),\n appFile = null,\n async = true,\n appBinaryId = \"nonexistent\",\n projectId = \"proj_1\",\n )\n }\n\n assertThat(error.message).contains(\"not found\")\n }\n\n // ---- 8. --app-binary-id server error ----\n\n @Test\n fun `upload throws CliError when server returns error for appBinaryId`() {\n every { mockApiClient.getAppBinaryInfo(\"test-token\", \"bin_err\") } throws ApiClient.ApiException(500)\n\n val error = assertThrows {\n createCloudInteractor().upload(\n flowFile = androidFlowFile(),\n appFile = null,\n async = true,\n appBinaryId = \"bin_err\",\n projectId = \"proj_1\",\n )\n }\n\n assertThat(error.message).contains(\"Failed to fetch app binary info\")\n }\n\n // ---- 9. --device-locale passed through ----\n\n @Test\n fun `upload passes device locale to api client`() {\n stubUploadResponse(platform = \"IOS\")\n\n createCloudInteractor().upload(\n flowFile = iosFlowFile(),\n appFile = iosApp(),\n async = true,\n deviceLocale = \"fr_FR\",\n projectId = \"proj_1\",\n )\n\n verify { mockApiClient.upload(\n authToken = any(), appFile = any(), workspaceZip = any(),\n uploadName = any(), mappingFile = any(), repoOwner = any(),\n repoName = any(), branch = any(), commitSha = any(),\n pullRequestId = any(), env = any(), appBinaryId = any(), includeTags = any(),\n excludeTags = any(), disableNotifications = any(),\n deviceLocale = eq(\"fr_FR\"), progressListener = any(),\n projectId = any(), deviceModel = any(), deviceOs = any(),\n androidApiLevel = any(), iOSVersion = any(),\n ) }\n }\n\n // ---- 10. --include-tags passed through ----\n\n @Test\n fun `upload passes include tags to workspace validation and api client`() {\n stubUploadResponse(platform = \"IOS\")\n\n createCloudInteractor().upload(\n flowFile = taggedFlowDir(),\n appFile = iosApp(),\n async = true,\n includeTags = listOf(\"smoke\"),\n projectId = \"proj_1\",\n )\n\n verify { mockApiClient.upload(\n authToken = any(), appFile = any(), workspaceZip = any(),\n uploadName = any(), mappingFile = any(), repoOwner = any(),\n repoName = any(), branch = any(), commitSha = any(),\n pullRequestId = any(), env = any(), appBinaryId = any(),\n includeTags = eq(listOf(\"smoke\")),\n excludeTags = any(), disableNotifications = any(),\n deviceLocale = any(), progressListener = any(),\n projectId = any(), deviceModel = any(), deviceOs = any(),\n androidApiLevel = any(), iOSVersion = any(),\n ) }\n }\n\n // ---- 11. Unsupported platform from server ----\n\n @Test\n fun `upload throws CliError when server returns unsupported platform for appBinaryId`() {\n every { mockApiClient.getAppBinaryInfo(\"test-token\", \"bin_symbian\") } returns AppBinaryInfo(\n appBinaryId = \"bin_symbian\",\n platform = \"Symbian\",\n appId = \"com.example.app\",\n )\n\n val error = assertThrows {\n createCloudInteractor().upload(\n flowFile = androidFlowFile(),\n appFile = null,\n async = true,\n appBinaryId = \"bin_symbian\",\n projectId = \"proj_1\",\n )\n }\n\n assertThat(error.message).contains(\"Unsupported platform\")\n }\n\n // ---- 12. CI metadata passed through ----\n\n @Test\n fun `upload passes CI metadata to api client`() {\n stubUploadResponse(platform = \"IOS\")\n\n createCloudInteractor().upload(\n flowFile = iosFlowFile(),\n appFile = iosApp(),\n async = true,\n repoOwner = \"acme\",\n repoName = \"app\",\n branch = \"feature/x\",\n commitSha = \"abc123\",\n pullRequestId = \"42\",\n projectId = \"proj_1\",\n )\n\n verify { mockApiClient.upload(\n authToken = any(), appFile = any(), workspaceZip = any(),\n uploadName = any(), mappingFile = any(),\n repoOwner = eq(\"acme\"), repoName = eq(\"app\"),\n branch = eq(\"feature/x\"), commitSha = eq(\"abc123\"),\n pullRequestId = eq(\"42\"),\n env = any(), appBinaryId = any(), includeTags = any(),\n excludeTags = any(), disableNotifications = any(),\n deviceLocale = any(), progressListener = any(),\n projectId = any(), deviceModel = any(), deviceOs = any(),\n androidApiLevel = any(), iOSVersion = any(),\n ) }\n }\n\n // ---- 13. Env vars passed through ----\n\n @Test\n fun `upload passes env vars to api client`() {\n stubUploadResponse(platform = \"IOS\")\n\n createCloudInteractor().upload(\n flowFile = iosFlowFile(),\n appFile = iosApp(),\n async = true,\n env = mapOf(\"API_KEY\" to \"secret\"),\n projectId = \"proj_1\",\n )\n\n verify { mockApiClient.upload(\n authToken = any(), appFile = any(), workspaceZip = any(),\n uploadName = any(), mappingFile = any(), repoOwner = any(),\n repoName = any(), branch = any(), commitSha = any(),\n pullRequestId = any(),\n env = eq(mapOf(\"API_KEY\" to \"secret\")), appBinaryId = any(),\n includeTags = any(), excludeTags = any(),\n disableNotifications = any(), deviceLocale = any(),\n progressListener = any(), projectId = any(),\n deviceModel = any(), deviceOs = any(),\n androidApiLevel = any(), iOSVersion = any(),\n ) }\n }\n\n // ---- 16. Valid device config and compatible app succeeds ----\n\n @Test\n fun `upload with valid device config and compatible app succeeds`() {\n stubUploadResponse(platform = \"IOS\")\n\n val result = createCloudInteractor().upload(\n flowFile = iosFlowFile(),\n appFile = iosApp(),\n async = true,\n projectId = \"proj_1\",\n deviceModel = \"iPhone-14\",\n deviceOs = \"iOS-18-2\",\n )\n\n assertThat(result).isEqualTo(0)\n }\n\n // ---- waitForCompletion tests (existing) ----\n\n @Test\n fun `waitForCompletion should return 0 when upload completes successfully`() {\n val uploadStatus = createUploadStatus(\n completed = true,\n status = UploadStatus.Status.SUCCESS,\n startTime = 0L,\n totalTime = 30L,\n flows = listOf(\n createFlowResult(\"flow1\", FlowStatus.SUCCESS, 0L, 50L),\n createFlowResult(\"flow2\", FlowStatus.SUCCESS, 0L, 50L)\n )\n )\n every { mockApiClient.uploadStatus(any(), any(), any()) } returns uploadStatus\n val result = createCloudInteractor().waitForCompletion(\n authToken = \"token\",\n uploadId = \"upload123\",\n appId = \"app123\",\n failOnCancellation = false,\n reportFormat = ReportFormat.NOOP,\n reportOutput = null,\n testSuiteName = null,\n uploadUrl = \"http://example.com\",\n projectId = \"project123\"\n )\n\n assertThat(result.status).isEqualTo(UploadStatus.Status.SUCCESS)\n verify(exactly = 1) { mockApiClient.uploadStatus(\"token\", \"upload123\", \"project123\") }\n\n val output = outputStream.toString()\n val cleanOutput = output.replace(Regex(\"\\\\u001B\\\\[[;\\\\d]*m\"), \"\")\n assertThat(cleanOutput).contains(\"[Passed] flow1 (50ms)\")\n assertThat(cleanOutput).contains(\"[Passed] flow2 (50ms)\")\n assertThat(cleanOutput).contains(\"2/2 Flows Passed\")\n assertThat(cleanOutput).contains(\"Process will exit with code 0 (SUCCESS)\")\n assertThat(cleanOutput).contains(\"http://example.com\")\n\n val flow1Occurrences = cleanOutput.split(\"[Passed] flow1 (50ms)\").size - 1\n val flow2Occurrences = cleanOutput.split(\"[Passed] flow2 (50ms)\").size - 1\n assertThat(flow1Occurrences).isEqualTo(1)\n assertThat(flow2Occurrences).isEqualTo(1)\n }\n\n @Test\n fun `waitForCompletion should handle status changes and eventually complete`() {\n val initialStatus = createUploadStatus(\n completed = false,\n status = UploadStatus.Status.RUNNING,\n startTime = 0L,\n totalTime = null,\n flows = listOf(\n createFlowResult(\"flow1\", FlowStatus.RUNNING, 0L, null),\n createFlowResult(\"flow2\", FlowStatus.RUNNING, 0L, null),\n createFlowResult(\"flow3\", FlowStatus.PENDING, 0L, null)\n )\n )\n\n val intermediateStatus = createUploadStatus(\n completed = false,\n status = UploadStatus.Status.RUNNING,\n startTime = 0L,\n totalTime = null,\n flows = listOf(\n createFlowResult(\"flow1\", FlowStatus.SUCCESS, 0L, 45L),\n createFlowResult(\"flow2\", FlowStatus.RUNNING, 0L, null),\n createFlowResult(\"flow3\", FlowStatus.RUNNING, 0L, null)\n )\n )\n\n val finalStatus = createUploadStatus(\n completed = true,\n status = UploadStatus.Status.SUCCESS,\n startTime = 0L,\n totalTime = 60L,\n flows = listOf(\n createFlowResult(\"flow1\", FlowStatus.SUCCESS, 0L, 45L),\n createFlowResult(\"flow2\", FlowStatus.ERROR, 0L, 60L),\n createFlowResult(\"flow3\", FlowStatus.STOPPED, 0L, null)\n )\n )\n\n every { mockApiClient.uploadStatus(any(), any(), any()) } returnsMany listOf(\n initialStatus,\n initialStatus,\n intermediateStatus,\n intermediateStatus,\n intermediateStatus,\n finalStatus\n )\n\n val result = createCloudInteractor().waitForCompletion(\n authToken = \"token\",\n uploadId = \"upload123\",\n appId = \"app123\",\n failOnCancellation = false,\n reportFormat = ReportFormat.NOOP,\n reportOutput = null,\n testSuiteName = null,\n uploadUrl = \"http://example.com\",\n projectId = \"project123\"\n )\n\n assertThat(result.status).isEqualTo(UploadStatus.Status.SUCCESS)\n verify(exactly = 6) { mockApiClient.uploadStatus(\"token\", \"upload123\", \"project123\") }\n\n val output = outputStream.toString()\n val cleanOutput = output.replace(Regex(\"\\\\u001B\\\\[[;\\\\d]*m\"), \"\")\n assertThat(cleanOutput).contains(\"[Passed] flow1 (45ms)\")\n assertThat(cleanOutput).contains(\"[Failed] flow2 (60ms)\")\n assertThat(cleanOutput).contains(\"[Stopped] flow3\")\n assertThat(cleanOutput).contains(\"1/3 Flow Failed\")\n assertThat(cleanOutput).contains(\"Process will exit with code 1 (FAIL)\")\n assertThat(cleanOutput).contains(\"http://example.com\")\n\n val flow1Occurrences = cleanOutput.split(\"[Passed] flow1 (45ms)\").size - 1\n val flow2Occurrences = cleanOutput.split(\"[Failed] flow2 (60ms)\").size - 1\n assertThat(flow1Occurrences).isEqualTo(1)\n assertThat(flow2Occurrences).isEqualTo(1)\n }\n\n // ---- Helpers ----\n\n private fun createUploadStatus(completed: Boolean, status: UploadStatus.Status, flows: List, startTime: Long?, totalTime: Long?): UploadStatus {\n return UploadStatus(\n uploadId = \"upload123\",\n status = status,\n completed = completed,\n flows = flows,\n totalTime = totalTime,\n startTime = startTime,\n appPackageId = null,\n wasAppLaunched = false,\n )\n }\n\n private fun createFlowResult(name: String, status: FlowStatus, startTime: Long = 0L, totalTime: Long?): UploadStatus.FlowResult {\n return UploadStatus.FlowResult(\n name = name,\n status = status,\n errors = emptyList(),\n startTime = startTime,\n totalTime = totalTime\n )\n }\n}\n" }, { "path": "maestro-cli/src/test/kotlin/maestro/cli/command/TestCommandTest.kt", "content": "package maestro.cli.command\n\nimport com.google.common.truth.Truth.assertThat\nimport maestro.orchestra.workspace.WorkspaceExecutionPlanner\nimport maestro.orchestra.WorkspaceConfig\nimport org.junit.jupiter.api.Test\nimport org.junit.jupiter.api.BeforeEach\nimport java.nio.file.Path\n\nclass TestCommandTest {\n\n private lateinit var testCommand: TestCommand\n\n @BeforeEach\n fun setUp() {\n testCommand = TestCommand()\n }\n\n /*****************************************\n *** executionPlanIncludesWebFlow Tests ***\n ******************************************/\n @Test\n fun `executionPlanIncludesWebFlow should return false when both flowsToRun and sequence flows are empty`() {\n val executionPlan = WorkspaceExecutionPlanner.ExecutionPlan(\n flowsToRun = emptyList(),\n sequence = WorkspaceExecutionPlanner.FlowSequence(emptyList(), true),\n workspaceConfig = WorkspaceConfig()\n )\n val result = testCommand.executionPlanIncludesWebFlow(executionPlan)\n assertThat(result).isFalse()\n }\n\n @Test\n fun `executionPlanIncludesWebFlow should return true when flowsToRun contains both mobile & web flow`() {\n val workspacePath = getTestResourcePath(\"workspaces/test_command_test/00_mixed_web_mobile_flow_tests\")\n val executionPlan = WorkspaceExecutionPlanner.plan(\n input = setOf(workspacePath),\n includeTags = emptyList(),\n excludeTags = emptyList(),\n config = null\n )\n val includesWebFlow = testCommand.executionPlanIncludesWebFlow(executionPlan)\n assertThat(includesWebFlow).isTrue()\n }\n\n @Test\n fun `executionPlanIncludesWebFlow should return true when sequence flows contains web flow only`() {\n val workspacePath = getTestResourcePath(\"workspaces/test_command_test/01_web_only\")\n val executionPlan = WorkspaceExecutionPlanner.plan(\n input = setOf(workspacePath),\n includeTags = emptyList(),\n excludeTags = emptyList(),\n config = null\n )\n val result = testCommand.executionPlanIncludesWebFlow(executionPlan)\n assertThat(result).isTrue()\n }\n\n @Test\n fun `executionPlanIncludesWebFlow should return false when no web flows exist`() {\n val workspacePath = getTestResourcePath(\"workspaces/test_command_test/02_mobile_only\")\n val executionPlan = WorkspaceExecutionPlanner.plan(\n input = setOf(workspacePath),\n includeTags = emptyList(),\n excludeTags = emptyList(),\n config = null\n )\n val result = testCommand.executionPlanIncludesWebFlow(executionPlan)\n assertThat(result).isFalse()\n }\n\n @Test\n fun `executionPlanIncludesWebFlow should return true if after config mixed flows exist`() {\n val workspacePath = getTestResourcePath(\"workspaces/test_command_test/03_mixed_with_config_execution_order\")\n val executionPlan = WorkspaceExecutionPlanner.plan(\n input = setOf(workspacePath),\n includeTags = emptyList(),\n excludeTags = emptyList(),\n config = null\n )\n val result = testCommand.executionPlanIncludesWebFlow(executionPlan)\n assertThat(result).isTrue()\n }\n\n @Test\n fun `executionPlanIncludesWebFlow should return false if after config no web flows exist`() {\n val workspacePath = getTestResourcePath(\"workspaces/test_command_test/04_web_only_with_config_execution_order\")\n val executionPlan = WorkspaceExecutionPlanner.plan(\n input = setOf(workspacePath),\n includeTags = emptyList(),\n excludeTags = emptyList(),\n config = null\n )\n val result = testCommand.executionPlanIncludesWebFlow(executionPlan)\n assertThat(result).isFalse()\n }\n\n /*****************************************\n ******** allFlowsAreWebFlow Tests ********\n ******************************************/\n @Test\n fun `allFlowsAreWebFlow should return false when both flowsToRun and sequence flows are empty`() {\n val executionPlan = WorkspaceExecutionPlanner.ExecutionPlan(\n flowsToRun = emptyList(),\n sequence = WorkspaceExecutionPlanner.FlowSequence(emptyList(), true),\n workspaceConfig = WorkspaceConfig()\n )\n val result = testCommand.allFlowsAreWebFlow(executionPlan)\n assertThat(result).isFalse()\n }\n\n @Test\n fun `allFlowsAreWebFlow should return false when flowsToRun contains both mobile & web flow`() {\n val workspacePath = getTestResourcePath(\"workspaces/test_command_test/00_mixed_web_mobile_flow_tests\")\n val executionPlan = WorkspaceExecutionPlanner.plan(\n input = setOf(workspacePath),\n includeTags = emptyList(),\n excludeTags = emptyList(),\n config = null\n )\n val result = testCommand.allFlowsAreWebFlow(executionPlan)\n assertThat(result).isFalse()\n }\n\n @Test\n fun `allFlowsAreWebFlow should return true when sequence flows contains web flow only`() {\n val workspacePath = getTestResourcePath(\"workspaces/test_command_test/01_web_only\")\n val executionPlan = WorkspaceExecutionPlanner.plan(\n input = setOf(workspacePath),\n includeTags = emptyList(),\n excludeTags = emptyList(),\n config = null\n )\n val result = testCommand.allFlowsAreWebFlow(executionPlan)\n assertThat(result).isTrue()\n }\n\n @Test\n fun `allFlowsAreWebFlow should return false when no web flows exist`() {\n val workspacePath = getTestResourcePath(\"workspaces/test_command_test/02_mobile_only\")\n val executionPlan = WorkspaceExecutionPlanner.plan(\n input = setOf(workspacePath),\n includeTags = emptyList(),\n excludeTags = emptyList(),\n config = null\n )\n val result = testCommand.allFlowsAreWebFlow(executionPlan)\n assertThat(result).isFalse()\n }\n\n @Test\n fun `allFlowsAreWebFlow should return false if after config mixed flows exist`() {\n val workspacePath = getTestResourcePath(\"workspaces/test_command_test/03_mixed_with_config_execution_order\")\n val executionPlan = WorkspaceExecutionPlanner.plan(\n input = setOf(workspacePath),\n includeTags = emptyList(),\n excludeTags = emptyList(),\n config = null\n )\n val result = testCommand.allFlowsAreWebFlow(executionPlan)\n assertThat(result).isFalse()\n }\n\n @Test\n fun `allFlowsAreWebFlow should return false if after config no web flows exist`() {\n val workspacePath = getTestResourcePath(\"workspaces/test_command_test/04_web_only_with_config_execution_order\")\n val executionPlan = WorkspaceExecutionPlanner.plan(\n input = setOf(workspacePath),\n includeTags = emptyList(),\n excludeTags = emptyList(),\n config = null\n )\n val result = testCommand.executionPlanIncludesWebFlow(executionPlan)\n assertThat(result).isFalse()\n }\n\n /*****************************************\n ************ Common Functions ************\n ******************************************/\n private fun getTestResourcePath(resourcePath: String): Path {\n val resourceUrl = javaClass.classLoader.getResource(resourcePath)\n requireNotNull(resourceUrl) { \"Test resource not found: $resourcePath\" }\n return Path.of(resourceUrl.toURI())\n }\n}\n" }, { "path": "maestro-cli/src/test/kotlin/maestro/cli/driver/DriverBuilderTest.kt", "content": "package maestro.cli.driver\n\nimport com.google.common.truth.Truth.assertThat\nimport io.mockk.every\nimport io.mockk.mockk\nimport io.mockk.slot\nimport org.junit.jupiter.api.Assertions.*\nimport io.mockk.spyk\nimport maestro.cli.api.CliVersion\nimport org.junit.jupiter.api.Test\nimport org.junit.jupiter.api.io.TempDir\nimport java.io.File\nimport java.nio.file.Files\nimport java.nio.file.Path\nimport java.nio.file.Paths\nimport java.util.concurrent.TimeUnit\nimport kotlin.io.path.exists\nimport kotlin.io.path.pathString\nimport kotlin.io.path.readText\n\nclass DriverBuilderTest {\n\n @TempDir\n lateinit var tempDir: Path\n\n @Test\n fun `test if driver is built successfully and written in directory`() {\n // given\n val mockProcess = mockk(relaxed = true)\n val mockProcessBuilderFactory = mockk()\n val sourceCodeRoot = System.getenv(\"GITHUB_WORKSPACE\") ?: System.getProperty(\"user.home\")\n every { mockProcess.waitFor(120, TimeUnit.SECONDS) } returns true // Simulate successful execution\n every { mockProcess.exitValue() } returns 0\n every { mockProcessBuilderFactory.createProcess(any(), any(), any()) } answers {\n val derivedDataPath = Files.createDirectories(\n Paths.get(sourceCodeRoot , \".maestro\", \"maestro-iphoneos-driver-build\", \"driver-iphoneos\", \"Build\", \"Products\")\n )\n val debugIphoneDir = Files.createDirectories(Paths.get(derivedDataPath.pathString, \"Debug-iphoneos\"))\n // Simulate creating build products\n File(derivedDataPath.toFile(), \"maestro-driver-ios-config.xctestrun\").writeText(\"Fake Runner xctestrun file\")\n File(debugIphoneDir.toFile(), \"maestro-driver-iosUITests-Runner.app\").writeText(\"Fake Runner App Content\")\n File(debugIphoneDir.toFile(), \"maestro-driver-ios.app\").writeText(\"Fake iOS Driver App Content\")\n println(\"Simulated build process: Build products created in derived data path.\")\n\n mockProcess // Return the mocked process\n }\n\n // when\n val builder = DriverBuilder(mockProcessBuilderFactory)\n val buildProducts = builder.buildDriver(\n DriverBuildConfig(\n teamId = \"25CQD4CKK3\",\n derivedDataPath = \"driver-iphoneos\",\n sourceCodePath = \"driver/ios\",\n sourceCodeRoot = System.getenv(\"GITHUB_WORKSPACE\") ?: System.getProperty(\"user.home\"),\n cliVersion = CliVersion(1, 40, 0)\n )\n )\n val xctestRunFile = buildProducts.toFile().walk().firstOrNull { it.extension == \"xctestrun\" }\n val appDir = buildProducts.resolve(\"Debug-iphoneos/maestro-driver-ios.app\")\n val runnerDir = buildProducts.resolve(\"Debug-iphoneos/maestro-driver-iosUITests-Runner.app\")\n\n\n // then\n assertThat(xctestRunFile?.exists()).isTrue()\n assertThat(appDir.exists()).isTrue()\n assertThat(runnerDir.exists()).isTrue()\n\n Paths.get(System.getenv(\"GITHUB_WORKSPACE\") ?: System.getProperty(\"user.home\"), \"maestro-iphoneos-driver-build\").toFile().deleteRecursively()\n }\n\n @Test\n fun `should write error output to file inside _maestro on build failure`() {\n // given\n val sourceCodeRoot = System.getenv(\"GITHUB_WORKSPACE\") ?: System.getProperty(\"user.home\")\n val driverBuildConfig = mockk()\n val processBuilderFactory = mockk()\n val driverBuilder = spyk(DriverBuilder(processBuilderFactory))\n val mockProcess = mockk(relaxed = true)\n val capturedFileSlot = slot()\n\n every { driverBuildConfig.sourceCodePath } returns \"mock/source\"\n every { driverBuildConfig.sourceCodeRoot } returns sourceCodeRoot\n every { driverBuildConfig.derivedDataPath } returns \"mock/source\"\n every { driverBuildConfig.teamId } returns \"mock-team-id\"\n every { driverBuildConfig.architectures } returns \"arm64\"\n every { driverBuildConfig.destination } returns \"generic/platform=ios\"\n every { driverBuildConfig.cliVersion } returns CliVersion.parse(\"1.40.0\")\n every { driverBuilder.getDriverSourceFromResources(any()) } returns tempDir\n every { mockProcess.exitValue() } returns 1\n every { mockProcess.waitFor(120, TimeUnit.SECONDS) } returns true\n every {\n processBuilderFactory.createProcess(commands = any(), workingDirectory = any(), outputFile = capture(capturedFileSlot))\n } answers {\n capturedFileSlot.captured.writeText(\"xcodebuild failed!\")\n mockProcess\n }\n\n // when\n val error = assertThrows(RuntimeException::class.java) {\n driverBuilder.buildDriver(driverBuildConfig)\n }\n\n // then\n assertThat(error.message).contains(\"Failed to build iOS driver for connected iOS device\")\n // Verify that the error log has been written inside the `.maestro` directory\n val maestroDir = Paths.get(sourceCodeRoot, \".maestro\")\n val errorLog = maestroDir.resolve(\"maestro-iphoneos-driver-build\").resolve(\"output.log\")\n\n // Verify file exists and contains error output\n assertTrue(Files.exists(errorLog), \"Expected an error log file to be written.\")\n assertTrue(errorLog.readText().contains(\"xcodebuild failed!\"), \"Log should contain build failure message.\")\n\n Paths.get(System.getenv(\"GITHUB_WORKSPACE\") ?: System.getProperty(\"user.home\"), \"maestro-iphoneos-driver-build\").toFile().deleteRecursively()\n }\n}" }, { "path": "maestro-cli/src/test/kotlin/maestro/cli/driver/RealDeviceDriverTest.kt", "content": "package maestro.cli.driver\n\nimport io.mockk.clearAllMocks\nimport io.mockk.every\nimport io.mockk.mockk\nimport io.mockk.mockkObject\nimport io.mockk.verify\nimport maestro.cli.api.CliVersion\nimport maestro.cli.util.EnvUtils\nimport org.junit.jupiter.api.AfterEach\nimport org.junit.jupiter.api.Test\nimport org.junit.jupiter.api.io.TempDir\nimport java.nio.file.Files\nimport java.nio.file.Path\nimport java.nio.file.Paths\nimport java.util.*\nimport kotlin.io.path.createDirectories\nimport kotlin.io.path.createFile\nimport kotlin.io.path.pathString\nimport kotlin.io.path.writeText\n\n\nclass RealDeviceDriverTest {\n\n @TempDir\n lateinit var tempDir: Path // Temporary directory for test isolation\n\n\n @Test\n fun `should update driver when version is outdated`() {\n // Set up a test version.properties file with an outdated version\n // Mock CLI_VERSION in EnvUtils to return \"1.2.0\"\n mockkObject(EnvUtils)\n val driverBuilder = mockk()\n every { driverBuilder.buildDriver(any()) } returns tempDir.resolve(\"Build/Products\")\n every { EnvUtils.getCLIVersion() } returns CliVersion.parse(\"1.2.0\")\n every { EnvUtils.CLI_VERSION } returns CliVersion.parse(\"1.2.0\")\n val driverDirectory = Files.createDirectories(Paths.get(tempDir.pathString + \"/maestro-iphoneos-driver-build\"))\n val propertiesFile = driverDirectory.resolve(\"version.properties\")\n val teamId = \"dummy-team\"\n val destination = \"destination\"\n\n\n Files.newBufferedWriter(propertiesFile).use { writer ->\n val props = Properties()\n props.setProperty(\"version\", \"1.1.0\") // Outdated version\n props.store(writer, null)\n }\n\n // Call RealIOSDeviceDriver's validateAndUpdateDriver\n RealIOSDeviceDriver(teamId = teamId, destination = destination, driverBuilder)\n .validateAndUpdateDriver(driverRootDirectory = tempDir)\n\n // Verify that the driver was built due to outdated version\n verify(exactly = 1) { driverBuilder.buildDriver(any()) } // Assert buildDriver was called\n driverDirectory.toFile().deleteRecursively()\n }\n\n @Test\n fun `should not update driver when version is up to date`() {\n // Set up a test version.properties file with an outdated version\n // Mock CLI_VERSION in EnvUtils to return \"1.2.0\"\n mockkObject(EnvUtils)\n val driverBuilder = mockk()\n every { driverBuilder.buildDriver(any()) } returns tempDir.resolve(\"Build/Products\")\n every { EnvUtils.getCLIVersion() } returns CliVersion.parse(\"1.3.0\")\n every { EnvUtils.CLI_VERSION } returns CliVersion.parse(\"1.3.0\")\n val driverDirectory = Files.createDirectories(Paths.get(tempDir.pathString + \"/maestro-iphoneos-driver-build\"))\n val productDirectory = driverDirectory.resolve(\"driver-iphoneos\").resolve(\"Build\").resolve(\"Products\").createDirectories()\n productDirectory.resolve(\"maestro-driver-ios-config.xctestrun\").createFile()\n .apply {\n writeText(\"Fake Runner xctestrun file\")\n }\n val propertiesFile = driverDirectory.resolve(\"version.properties\")\n val teamId = \"dummy-team\"\n val destination = \"destination\"\n\n\n Files.newBufferedWriter(propertiesFile).use { writer ->\n val props = Properties()\n props.setProperty(\"version\", \"1.3.0\") // Outdated version\n props.store(writer, null)\n }\n\n // Call RealIOSDeviceDriver's validateAndUpdateDriver\n RealIOSDeviceDriver(teamId = teamId, destination = destination, driverBuilder)\n .validateAndUpdateDriver(driverRootDirectory = tempDir)\n\n // Verify that the driver was built due to outdated version\n verify(exactly = 0) { driverBuilder.buildDriver(any()) } // Assert buildDriver was called\n\n driverDirectory.toFile().deleteRecursively()\n }\n\n @Test\n fun `should update driver when version file is missing`() {\n // Set up a test version.properties file with an outdated version\n // Mock CLI_VERSION in EnvUtils to return \"1.2.0\"\n mockkObject(EnvUtils)\n every { EnvUtils.getCLIVersion() } returns CliVersion.parse(\"1.3.0\")\n every { EnvUtils.CLI_VERSION } returns CliVersion.parse(\"1.3.0\")\n\n val driverBuilder = mockk()\n every { driverBuilder.buildDriver(any()) } returns tempDir.resolve(\"Build/Products\")\n\n val teamId = \"dummy-team\"\n val destination = \"destination\"\n\n // Call RealIOSDeviceDriver's validateAndUpdateDriver\n RealIOSDeviceDriver(teamId = teamId, destination = destination, driverBuilder)\n .validateAndUpdateDriver(driverRootDirectory = tempDir)\n\n // Verify that the driver was built due to outdated version\n verify(exactly = 1) { driverBuilder.buildDriver(any()) } // Assert buildDriver was called\n }\n\n @AfterEach\n fun cleanup() {\n clearAllMocks()\n }\n}" }, { "path": "maestro-cli/src/test/kotlin/maestro/cli/report/HtmlTestSuiteReporterTest.kt", "content": "package maestro.cli.report\n\nimport com.google.common.truth.Truth.assertThat\nimport okio.Buffer\nimport org.junit.jupiter.api.Test\n\nclass HtmlTestSuiteReporterTest : TestSuiteReporterTest() {\n\n @Test\n fun `HTML - Test passed`() {\n // Given\n val testee = HtmlTestSuiteReporter()\n val sink = Buffer()\n\n // When\n testee.report(\n summary = testSuccessWithWarning,\n out = sink\n )\n val resultStr = sink.readUtf8()\n\n // Then\n assertThat(resultStr).isEqualTo(\n \"\"\"\n \n \n Maestro Test Report\n \n \n \n
\n
\n

Flow Execution Summary

\n
Test Result: PASSED
Duration: 31m 55.947s
Start Time: $nowAsIso

\n
\n
\n
\n
Total number of Flows
\n

2

\n
\n
\n
\n
\n
Failed Flows
\n

0

\n
\n
\n
\n
\n
Successful Flows
\n

2

\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Status: SUCCESS
Duration: 7m 1.573s
Start Time: $nowPlus1AsIso
File Name: flow_a

\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Status: WARNING
Duration: 24m 54.749s
Start Time: $nowPlus2AsIso
File Name: flow_b

\n
\n
\n
\n
\n \n
\n \n \n\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `HTML - Test failed`() {\n // Given\n val testee = HtmlTestSuiteReporter()\n val sink = Buffer()\n\n // When\n testee.report(\n summary = testSuccessWithError,\n out = sink\n )\n val resultStr = sink.readUtf8()\n\n // Then\n assertThat(resultStr).isEqualTo(\n \"\"\"\n \n \n Maestro Test Report\n \n \n \n
\n
\n

Flow Execution Summary

\n
Test Result: FAILED
Duration: 9m 12.743s
Start Time: $nowAsIso

\n
\n
\n
\n
Total number of Flows
\n

2

\n
\n
\n
\n
\n
Failed Flows
\n

1

\n
\n
\n
\n
\n
Successful Flows
\n

1

\n
\n
\n
\n
\n
Failed Flow
\n

Flow B

\n
\n
\n
\n
\n
\n
\n
\n
\n

Status: SUCCESS
Duration: 7m 1.573s
Start Time: $nowPlus1AsIso
File Name: flow_a

\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Status: ERROR
Duration: 2m 11.846s
Start Time: $nowPlus2AsIso
File Name: flow_b

\n

Error message

\n
\n
\n
\n
\n \n
\n \n \n\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `HTML - Pretty mode with successful test and steps`() {\n // Given\n val testee = HtmlTestSuiteReporter(detailed = true)\n val sink = Buffer()\n\n // When\n testee.report(\n summary = testSuccessWithSteps,\n out = sink\n )\n val resultStr = sink.readUtf8()\n\n // Then\n // Verify key elements are present\n assertThat(resultStr).contains(\"Test Steps (3)\")\n assertThat(resultStr).contains(\"โœ…\")\n assertThat(resultStr).contains(\"1. Launch app\")\n assertThat(resultStr).contains(\"2. Tap on button\")\n assertThat(resultStr).contains(\"3. Assert visible\")\n assertThat(resultStr).contains(\"1.2s\")\n assertThat(resultStr).contains(\"500ms\")\n assertThat(resultStr).contains(\"100ms\")\n assertThat(resultStr).contains(\".step-item\")\n assertThat(resultStr).contains(\".step-header\")\n assertThat(resultStr).contains(\".step-name\")\n\n // Verify proper HTML structure\n assertThat(resultStr).contains(\"\")\n assertThat(resultStr).contains(\"\")\n assertThat(resultStr).contains(\"Flow Execution Summary\")\n assertThat(resultStr).contains(\"Test Result: PASSED\")\n }\n\n @Test\n fun `HTML - Pretty mode with failed test and steps with various statuses`() {\n // Given\n val testee = HtmlTestSuiteReporter(detailed = true)\n val sink = Buffer()\n\n // When\n testee.report(\n summary = testErrorWithSteps,\n out = sink\n )\n val resultStr = sink.readUtf8()\n\n // Then\n // Verify key elements and various step statuses\n assertThat(resultStr).contains(\"Test Steps (4)\")\n assertThat(resultStr).contains(\"โœ…\") // COMPLETED\n assertThat(resultStr).contains(\"โš ๏ธ\") // WARNED\n assertThat(resultStr).contains(\"โŒ\") // FAILED\n assertThat(resultStr).contains(\"โญ๏ธ\") // SKIPPED\n assertThat(resultStr).contains(\"1. Launch app\")\n assertThat(resultStr).contains(\"2. Tap on optional element\")\n assertThat(resultStr).contains(\"3. Tap on button\")\n assertThat(resultStr).contains(\"4. Assert visible\")\n assertThat(resultStr).contains(\"Element not found\")\n assertThat(resultStr).contains(\".step-item\")\n assertThat(resultStr).contains(\".step-header\")\n assertThat(resultStr).contains(\".step-name\")\n\n // Verify proper HTML structure\n assertThat(resultStr).contains(\"\")\n assertThat(resultStr).contains(\"\")\n assertThat(resultStr).contains(\"Flow Execution Summary\")\n assertThat(resultStr).contains(\"Test Result: FAILED\")\n assertThat(resultStr).contains(\"Failed Flow\")\n }\n\n @Test\n fun `HTML - Basic mode does not show steps even when present`() {\n // Given\n val testee = HtmlTestSuiteReporter(detailed = false)\n val sink = Buffer()\n\n // When\n testee.report(\n summary = testSuccessWithSteps,\n out = sink\n )\n val resultStr = sink.readUtf8()\n\n // Then\n // Should not contain step details\n assertThat(resultStr).doesNotContain(\"Test Steps\")\n assertThat(resultStr).doesNotContain(\"Launch app\")\n assertThat(resultStr).doesNotContain(\"step-item\")\n assertThat(resultStr).doesNotContain(\"step-header\")\n\n // Should contain basic flow information\n assertThat(resultStr).contains(\"Flow A\")\n assertThat(resultStr).contains(\"Status: SUCCESS\")\n assertThat(resultStr).contains(\"File Name: flow_a\")\n }\n\n @Test\n fun `HTML - Tags and properties are displayed`() {\n // Given\n val testee = HtmlTestSuiteReporter(detailed = false)\n val sink = Buffer()\n\n // When\n testee.report(\n summary = testWithTagsAndProperties,\n out = sink\n )\n val resultStr = sink.readUtf8()\n\n // Then\n // Verify tags are displayed\n assertThat(resultStr).contains(\"Tags:\")\n assertThat(resultStr).contains(\"smoke\")\n assertThat(resultStr).contains(\"critical\")\n assertThat(resultStr).contains(\"auth\")\n assertThat(resultStr).contains(\"regression\")\n assertThat(resultStr).contains(\"e2e\")\n assertThat(resultStr).contains(\"badge bg-primary\")\n\n // Verify properties section and table\n assertThat(resultStr).contains(\"Properties\")\n assertThat(resultStr).contains(\"testCaseId\")\n assertThat(resultStr).contains(\"TC-001\")\n assertThat(resultStr).contains(\"xray-test-key\")\n assertThat(resultStr).contains(\"PROJ-123\")\n assertThat(resultStr).contains(\"priority\")\n assertThat(resultStr).contains(\"P0\")\n assertThat(resultStr).contains(\"TC-002\")\n assertThat(resultStr).contains(\"testrail-case-id\")\n assertThat(resultStr).contains(\"C456\")\n assertThat(resultStr).contains(\"table table-sm table-bordered\")\n\n // Verify flow names\n assertThat(resultStr).contains(\"Login Flow\")\n assertThat(resultStr).contains(\"Checkout Flow\")\n }\n}\n" }, { "path": "maestro-cli/src/test/kotlin/maestro/cli/report/JUnitTestSuiteReporterTest.kt", "content": "package maestro.cli.report\n\nimport com.google.common.truth.Truth.assertThat\nimport okio.Buffer\nimport org.junit.jupiter.api.Test\n\nclass JUnitTestSuiteReporterTest : TestSuiteReporterTest() {\n\n @Test\n fun `XML - Test passed`() {\n // Given\n val testee = JUnitTestSuiteReporter.xml()\n val sink = Buffer()\n\n // When\n testee.report(\n summary = testSuccessWithWarning,\n out = sink\n )\n val resultStr = sink.readUtf8()\n\n // Then\n assertThat(resultStr).isEqualTo(\n \"\"\"\n \n \n \n \n \n \n \n \n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `XML - Test failed`() {\n // Given\n val testee = JUnitTestSuiteReporter.xml()\n val sink = Buffer()\n\n // When\n testee.report(\n summary = testSuccessWithError,\n out = sink\n )\n val resultStr = sink.readUtf8()\n\n // Then\n assertThat(resultStr).isEqualTo(\n \"\"\"\n \n \n \n \n \n Error message\n \n \n \n \n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `XML - Custom test suite name is used when present`() {\n // Given\n val testee = JUnitTestSuiteReporter.xml(\"Custom test suite name\")\n val sink = Buffer()\n\n // When\n testee.report(\n summary = testSuccessWithWarning,\n out = sink\n )\n val resultStr = sink.readUtf8()\n\n // Then\n assertThat(resultStr).isEqualTo(\n \"\"\"\n \n \n \n \n \n \n \n \n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `XML - Tags and properties are included in output`() {\n // Given\n val testee = JUnitTestSuiteReporter.xml()\n val sink = Buffer()\n\n // When\n testee.report(\n summary = testWithTagsAndProperties,\n out = sink\n )\n val resultStr = sink.readUtf8()\n\n // Then\n assertThat(resultStr).isEqualTo(\n \"\"\"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \"\"\".trimIndent()\n )\n }\n\n}\n" }, { "path": "maestro-cli/src/test/kotlin/maestro/cli/report/TestDebugReporterTest.kt", "content": "package maestro.cli.report\n\nimport com.google.common.truth.Truth.assertThat\nimport org.junit.jupiter.api.Test\nimport org.junit.jupiter.api.io.TempDir\nimport java.nio.file.Files\nimport java.nio.file.Path\nimport java.nio.file.Paths\nimport kotlin.io.path.createDirectories\nimport kotlin.io.path.exists\nimport kotlin.io.path.pathString\n\n\nclass TestDebugReporterTest {\n\n @TempDir\n lateinit var tempDir: Path\n\n @Test\n fun `will delete old files`() {\n // Create directory structure, and an old test directory\n val oldDir = Files.createDirectories(tempDir.resolve(\".maestro/tests/old\"))\n Files.setLastModifiedTime(oldDir, java.nio.file.attribute.FileTime.fromMillis(System.currentTimeMillis() - 1000 * 60 * 60 * 24 * 15))\n\n // Initialise a new test reporter, which will create ./maestro/tests/\n TestDebugReporter.install(tempDir.pathString, false,false)\n\n // Run the deleteOldFiles method, which happens at the end of each test run\n // This should delete the 'old' directory created above\n TestDebugReporter.deleteOldFiles()\n assertThat(Files.exists(oldDir)).isFalse() // Verify that the old directory was deleted\n assertThat(TestDebugReporter.getDebugOutputPath().exists()).isTrue() // Verify that the logs from this run still exist\n }\n\n}" }, { "path": "maestro-cli/src/test/kotlin/maestro/cli/report/TestSuiteReporterTest.kt", "content": "package maestro.cli.report\n\nimport maestro.cli.model.FlowStatus\nimport maestro.cli.model.TestExecutionSummary\nimport java.time.OffsetDateTime\nimport java.time.format.DateTimeFormatter\nimport java.time.temporal.ChronoUnit\nimport kotlin.time.Duration.Companion.milliseconds\n\nabstract class TestSuiteReporterTest {\n\n // Since timestamps we get from the server have milliseconds precision (specifically epoch millis)\n // we need to truncate off nanoseconds (and any higher) precision.\n val now = OffsetDateTime.now().truncatedTo(ChronoUnit.MILLIS)\n\n val nowPlus1 = now.plusSeconds(1)\n val nowPlus2 = now.plusSeconds(2)\n\n val nowAsIso = now.format(DateTimeFormatter.ISO_LOCAL_DATE_TIME)\n val nowPlus1AsIso = nowPlus1.format(DateTimeFormatter.ISO_LOCAL_DATE_TIME)\n val nowPlus2AsIso = nowPlus2.format(DateTimeFormatter.ISO_LOCAL_DATE_TIME)\n\n val testSuccessWithWarning = TestExecutionSummary(\n passed = true,\n suites = listOf(\n TestExecutionSummary.SuiteResult(\n passed = true,\n deviceName = \"iPhone 15\",\n flows = listOf(\n TestExecutionSummary.FlowResult(\n name = \"Flow A\",\n fileName = \"flow_a\",\n status = FlowStatus.SUCCESS,\n duration = 421573.milliseconds,\n startTime = nowPlus1.toInstant().toEpochMilli()\n ),\n TestExecutionSummary.FlowResult(\n name = \"Flow B\",\n fileName = \"flow_b\",\n status = FlowStatus.WARNING,\n duration = 1494749.milliseconds,\n startTime = nowPlus2.toInstant().toEpochMilli()\n ),\n ),\n duration = 1915947.milliseconds,\n startTime = now.toInstant().toEpochMilli()\n )\n )\n )\n\n val testSuccessWithError = TestExecutionSummary(\n passed = false,\n suites = listOf(\n TestExecutionSummary.SuiteResult(\n passed = false,\n flows = listOf(\n TestExecutionSummary.FlowResult(\n name = \"Flow A\",\n fileName = \"flow_a\",\n status = FlowStatus.SUCCESS,\n duration = 421573.milliseconds,\n startTime = nowPlus1.toInstant().toEpochMilli()\n ),\n TestExecutionSummary.FlowResult(\n name = \"Flow B\",\n fileName = \"flow_b\",\n status = FlowStatus.ERROR,\n failure = TestExecutionSummary.Failure(\"Error message\"),\n duration = 131846.milliseconds,\n startTime = nowPlus2.toInstant().toEpochMilli()\n ),\n ),\n duration = 552743.milliseconds,\n startTime = now.toInstant().toEpochMilli()\n )\n )\n )\n\n val testSuccessWithSteps = TestExecutionSummary(\n passed = true,\n suites = listOf(\n TestExecutionSummary.SuiteResult(\n passed = true,\n flows = listOf(\n TestExecutionSummary.FlowResult(\n name = \"Flow A\",\n fileName = \"flow_a\",\n status = FlowStatus.SUCCESS,\n duration = 5000.milliseconds,\n startTime = nowPlus1.toInstant().toEpochMilli(),\n steps = listOf(\n TestExecutionSummary.StepResult(\n description = \"1. Launch app\",\n status = \"COMPLETED\",\n duration = \"1.2s\"\n ),\n TestExecutionSummary.StepResult(\n description = \"2. Tap on button\",\n status = \"COMPLETED\",\n duration = \"500ms\"\n ),\n TestExecutionSummary.StepResult(\n description = \"3. Assert visible\",\n status = \"COMPLETED\",\n duration = \"100ms\"\n ),\n )\n ),\n ),\n duration = 5000.milliseconds,\n startTime = now.toInstant().toEpochMilli()\n )\n )\n )\n\n val testErrorWithSteps = TestExecutionSummary(\n passed = false,\n suites = listOf(\n TestExecutionSummary.SuiteResult(\n passed = false,\n flows = listOf(\n TestExecutionSummary.FlowResult(\n name = \"Flow B\",\n fileName = \"flow_b\",\n status = FlowStatus.ERROR,\n failure = TestExecutionSummary.Failure(\"Element not found\"),\n duration = 3000.milliseconds,\n startTime = nowPlus1.toInstant().toEpochMilli(),\n steps = listOf(\n TestExecutionSummary.StepResult(\n description = \"1. Launch app\",\n status = \"COMPLETED\",\n duration = \"1.5s\"\n ),\n TestExecutionSummary.StepResult(\n description = \"2. Tap on optional element\",\n status = \"WARNED\",\n duration = \"<1ms\"\n ),\n TestExecutionSummary.StepResult(\n description = \"3. Tap on button\",\n status = \"FAILED\",\n duration = \"2.0s\"\n ),\n TestExecutionSummary.StepResult(\n description = \"4. Assert visible\",\n status = \"SKIPPED\",\n duration = \"0ms\"\n ),\n )\n ),\n ),\n duration = 3000.milliseconds,\n startTime = now.toInstant().toEpochMilli()\n )\n )\n )\n\n val testWithTagsAndProperties = TestExecutionSummary(\n passed = true,\n suites = listOf(\n TestExecutionSummary.SuiteResult(\n passed = true,\n flows = listOf(\n TestExecutionSummary.FlowResult(\n name = \"Login Flow\",\n fileName = \"login_flow\",\n status = FlowStatus.SUCCESS,\n duration = 2500.milliseconds,\n startTime = nowPlus1.toInstant().toEpochMilli(),\n tags = listOf(\"smoke\", \"critical\", \"auth\"),\n properties = mapOf(\n \"testCaseId\" to \"TC-001\",\n \"xray-test-key\" to \"PROJ-123\",\n \"priority\" to \"P0\"\n )\n ),\n TestExecutionSummary.FlowResult(\n name = \"Checkout Flow\",\n fileName = \"checkout_flow\",\n status = FlowStatus.SUCCESS,\n duration = 3500.milliseconds,\n startTime = nowPlus2.toInstant().toEpochMilli(),\n tags = listOf(\"regression\", \"e2e\"),\n properties = mapOf(\n \"testCaseId\" to \"TC-002\",\n \"testrail-case-id\" to \"C456\"\n )\n ),\n ),\n duration = 6000.milliseconds,\n startTime = now.toInstant().toEpochMilli()\n )\n )\n )\n}\n" }, { "path": "maestro-cli/src/test/kotlin/maestro/cli/runner/resultview/PlainTextResultViewTest.kt", "content": "package maestro.cli.runner.resultview\n\nimport com.google.common.truth.Truth.assertThat\nimport maestro.cli.runner.CommandState\nimport maestro.cli.runner.CommandStatus\nimport maestro.orchestra.AssertConditionCommand\nimport maestro.orchestra.Condition\nimport maestro.orchestra.ElementSelector\nimport maestro.orchestra.MaestroCommand\nimport maestro.orchestra.RunFlowCommand\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Test\nimport java.io.ByteArrayOutputStream\nimport java.io.PrintStream\n\nclass PlainTextResultViewTest {\n\n private lateinit var outputStream: ByteArrayOutputStream\n private lateinit var originalOut: PrintStream\n\n @BeforeEach\n fun setUp() {\n outputStream = ByteArrayOutputStream()\n originalOut = System.out\n System.setOut(PrintStream(outputStream))\n }\n\n private fun tearDown() {\n System.setOut(originalOut)\n }\n\n private fun getOutput(): String {\n return outputStream.toString()\n }\n\n /**\n * This test verifies that deeply nested runFlow commands are all printed correctly.\n *\n * Bug description: When using nested complex runFlow inside runFlow (and even deeper),\n * the --no-ansi option fails to keep track and stops printing. It gets out of sync.\n *\n * Example structure that was failing:\n * main.yml:\n * - runFlow: open_app.yml <- printed fine\n * - runFlow: login_to_app.yml <- printed fine\n * - runFlow: tests.yml <- this flow and everything in it were NOT being printed\n *\n * Where tests.yml contains:\n * - runFlow: test1.yml\n * - runFlow: test2.yml\n *\n * And login_to_app.yml contains a conditional runFlow.\n *\n * The fix ensures unique keys are generated for each nested command by using\n * hierarchical prefixes (e.g., \"main:0:sub:0:sub:0\") instead of flat indices.\n */\n @Test\n fun `nested runFlow commands should all be printed correctly`() {\n // Given\n val resultView = PlainTextResultView()\n\n // Create a deeply nested structure similar to the bug scenario:\n // main flow -> runFlow (tests.yml) -> runFlow (test1.yml) -> assertVisible\n\n val deepestCommand = MaestroCommand(\n assertConditionCommand = AssertConditionCommand(\n condition = Condition(visible = ElementSelector(textRegex = \"hello\"))\n )\n )\n\n val deepestCommandState = CommandState(\n status = CommandStatus.COMPLETED,\n command = deepestCommand,\n subOnStartCommands = null,\n subOnCompleteCommands = null,\n subCommands = null\n )\n\n // test1.yml - contains assertVisible\n val test1RunFlow = MaestroCommand(\n runFlowCommand = RunFlowCommand(\n commands = listOf(deepestCommand),\n sourceDescription = \"test1.yml\",\n config = null\n )\n )\n\n val test1State = CommandState(\n status = CommandStatus.COMPLETED,\n command = test1RunFlow,\n subOnStartCommands = null,\n subOnCompleteCommands = null,\n subCommands = listOf(deepestCommandState)\n )\n\n // test2.yml - another nested flow\n val test2RunFlow = MaestroCommand(\n runFlowCommand = RunFlowCommand(\n commands = listOf(deepestCommand),\n sourceDescription = \"test2.yml\",\n config = null\n )\n )\n\n val test2State = CommandState(\n status = CommandStatus.COMPLETED,\n command = test2RunFlow,\n subOnStartCommands = null,\n subOnCompleteCommands = null,\n subCommands = listOf(deepestCommandState.copy())\n )\n\n // tests.yml - contains test1 and test2\n val testsRunFlow = MaestroCommand(\n runFlowCommand = RunFlowCommand(\n commands = listOf(test1RunFlow, test2RunFlow),\n sourceDescription = \"tests.yml\",\n config = null\n )\n )\n\n val testsState = CommandState(\n status = CommandStatus.COMPLETED,\n command = testsRunFlow,\n subOnStartCommands = null,\n subOnCompleteCommands = null,\n subCommands = listOf(test1State, test2State)\n )\n\n // open_app.yml - simple flow\n val openAppRunFlow = MaestroCommand(\n runFlowCommand = RunFlowCommand(\n commands = listOf(deepestCommand),\n sourceDescription = \"open_app.yml\",\n config = null\n )\n )\n\n val openAppState = CommandState(\n status = CommandStatus.COMPLETED,\n command = openAppRunFlow,\n subOnStartCommands = null,\n subOnCompleteCommands = null,\n subCommands = listOf(deepestCommandState.copy())\n )\n\n // login_to_app.yml - contains a conditional runFlow\n val conditionalRunFlow = MaestroCommand(\n runFlowCommand = RunFlowCommand(\n commands = listOf(deepestCommand),\n condition = Condition(visible = ElementSelector(textRegex = \"name@example.com\")),\n sourceDescription = null,\n config = null\n )\n )\n\n val conditionalState = CommandState(\n status = CommandStatus.COMPLETED,\n command = conditionalRunFlow,\n subOnStartCommands = null,\n subOnCompleteCommands = null,\n subCommands = listOf(deepestCommandState.copy())\n )\n\n val loginRunFlow = MaestroCommand(\n runFlowCommand = RunFlowCommand(\n commands = listOf(conditionalRunFlow),\n sourceDescription = \"login_to_app.yml\",\n config = null\n )\n )\n\n val loginState = CommandState(\n status = CommandStatus.COMPLETED,\n command = loginRunFlow,\n subOnStartCommands = null,\n subOnCompleteCommands = null,\n subCommands = listOf(conditionalState)\n )\n\n // Main flow state with all commands\n val state = UiState.Running(\n flowName = \"main.yml\",\n commands = listOf(\n openAppState,\n loginState,\n testsState // This was the problematic flow that wasn't being printed\n )\n )\n\n // When\n resultView.setState(state)\n\n // Then\n val output = getOutput()\n tearDown()\n\n // Verify all nested flows are printed\n assertThat(output).contains(\"Run open_app.yml\")\n assertThat(output).contains(\"Run login_to_app.yml\")\n assertThat(output).contains(\"Run tests.yml\") // This was missing before the fix\n assertThat(output).contains(\"Run test1.yml\") // Nested inside tests.yml\n assertThat(output).contains(\"Run test2.yml\") // Nested inside tests.yml\n\n // Verify the deepest commands are also printed (assertVisible)\n // Count occurrences - we should have multiple \"Assert that\" for each nested flow\n val assertCount = output.split(\"Assert that\").size - 1\n assertThat(assertCount).isAtLeast(3) // At least 3 assertVisible commands should be printed\n }\n\n @Test\n fun `multiple calls with same nested structure should not duplicate output`() {\n // Given\n val resultView = PlainTextResultView()\n\n val command = MaestroCommand(\n assertConditionCommand = AssertConditionCommand(\n condition = Condition(visible = ElementSelector(textRegex = \"hello\"))\n )\n )\n\n val commandState = CommandState(\n status = CommandStatus.COMPLETED,\n command = command,\n subOnStartCommands = null,\n subOnCompleteCommands = null,\n subCommands = null\n )\n\n val runFlowCommand = MaestroCommand(\n runFlowCommand = RunFlowCommand(\n commands = listOf(command),\n sourceDescription = \"test.yml\",\n config = null\n )\n )\n\n val runFlowState = CommandState(\n status = CommandStatus.COMPLETED,\n command = runFlowCommand,\n subOnStartCommands = null,\n subOnCompleteCommands = null,\n subCommands = listOf(commandState)\n )\n\n val state = UiState.Running(\n flowName = \"main.yml\",\n commands = listOf(runFlowState)\n )\n\n // When - call setState multiple times (simulating UI updates)\n resultView.setState(state)\n resultView.setState(state)\n resultView.setState(state)\n\n // Then\n val output = getOutput()\n tearDown()\n\n // Should only print once despite multiple setState calls\n val flowNameCount = output.split(\"Flow main.yml\").size - 1\n assertThat(flowNameCount).isEqualTo(1)\n\n val runTestCount = output.split(\"Run test.yml\").size - 1\n assertThat(runTestCount).isEqualTo(2) // Once for start, once for complete\n }\n\n @Test\n fun `three levels of nested runFlow should all print`() {\n // Given\n val resultView = PlainTextResultView()\n\n // Level 3: deepest assert\n val assertCommand = MaestroCommand(\n assertConditionCommand = AssertConditionCommand(\n condition = Condition(visible = ElementSelector(textRegex = \"deep\"))\n )\n )\n val assertState = CommandState(\n status = CommandStatus.COMPLETED,\n command = assertCommand,\n subOnStartCommands = null,\n subOnCompleteCommands = null,\n subCommands = null\n )\n\n // Level 2: middle runFlow (level2.yml)\n val level2Flow = MaestroCommand(\n runFlowCommand = RunFlowCommand(\n commands = listOf(assertCommand),\n sourceDescription = \"level2.yml\",\n config = null\n )\n )\n val level2State = CommandState(\n status = CommandStatus.COMPLETED,\n command = level2Flow,\n subOnStartCommands = null,\n subOnCompleteCommands = null,\n subCommands = listOf(assertState)\n )\n\n // Level 1: outer runFlow (level1.yml)\n val level1Flow = MaestroCommand(\n runFlowCommand = RunFlowCommand(\n commands = listOf(level2Flow),\n sourceDescription = \"level1.yml\",\n config = null\n )\n )\n val level1State = CommandState(\n status = CommandStatus.COMPLETED,\n command = level1Flow,\n subOnStartCommands = null,\n subOnCompleteCommands = null,\n subCommands = listOf(level2State)\n )\n\n val state = UiState.Running(\n flowName = \"main.yml\",\n commands = listOf(level1State)\n )\n\n // When\n resultView.setState(state)\n\n // Then\n val output = getOutput()\n tearDown()\n\n // All levels should be printed\n assertThat(output).contains(\"Run level1.yml\")\n assertThat(output).contains(\"Run level2.yml\")\n assertThat(output).contains(\"Assert that\")\n }\n}\n\n" }, { "path": "maestro-cli/src/test/kotlin/maestro/cli/util/ChangeLogUtilsTest.kt", "content": "package maestro.cli.util\n\nimport com.google.common.truth.Truth.assertThat\nimport maestro.cli.util.EnvUtils.CLI_VERSION\nimport org.junit.jupiter.api.Test\nimport java.io.File\n\n\nclass ChangeLogUtilsTest {\n\n private val changelogFile = File(System.getProperty(\"user.dir\"), \"../CHANGELOG.md\")\n\n @Test\n fun `test format last version`() {\n val content = changelogFile.readText()\n\n val changelog = ChangeLogUtils.formatBody(content, CLI_VERSION.toString())\n\n assertThat(changelog).isNotNull()\n assertThat(changelog).isNotEmpty()\n }\n\n @Test\n fun `test format unknown version`() {\n val content = changelogFile.readText()\n\n val changelog = ChangeLogUtils.formatBody(content, \"x.yy.z\")\n\n assertThat(changelog).isNull()\n }\n\n @Test\n fun `test format short version`() {\n val content = changelogFile.readText()\n\n val changelog = ChangeLogUtils.formatBody(content, \"1.38.1\")\n\n assertThat(changelog).containsExactly(\n \"- New experimental AI-powered commands for screenshot testing: assertWithAI and assertNoDefectsWithAI (#1906)\",\n \"- Enable basic support for Maestro uploads while keeping Maestro Cloud functioning (#1970)\",\n )\n }\n\n @Test\n fun `test format link and no paragraph`() {\n val content = changelogFile.readText()\n\n val changelog = ChangeLogUtils.formatBody(content, \"1.37.9\")\n\n assertThat(changelog).containsExactly(\n \"- Revert iOS landscape mode fix (#1916)\",\n )\n }\n\n @Test\n fun `test format no subheader`() {\n val content = changelogFile.readText()\n\n val changelog = ChangeLogUtils.formatBody(content, \"1.37.1\")\n\n assertThat(changelog).containsExactly(\n \"- Fix crash when `flutter` or `xcodebuild` is not installed (#1839)\",\n )\n }\n\n @Test\n fun `test format strong no paragraph and no sublist`() {\n val content = changelogFile.readText()\n\n val changelog = ChangeLogUtils.formatBody(content, \"1.37.0\")\n\n assertThat(changelog).containsExactly(\n \"- Sharding tests for parallel execution on many devices ๐ŸŽ‰ย (#1732 by Kaan)\",\n \"- Reports in HTML (#1750 by Depa Panjie Purnama)\",\n \"- Homebrew is back!\",\n \"- Current platform exposed in JavaScript (#1747 by Dan Caseley)\",\n \"- Control airplaneย mode (#1672 by NyCodeGHG)\",\n \"- New `killApp` command (#1727 by Alexandre Favre)\",\n \"- Fix cleaning up retries in iOS driver (#1669)\",\n \"- Fix some commands not respecting custom labels (#1762 by Dan Caseley)\",\n \"- Fix โ€œProtocol family unavailableโ€ when rerunning iOS tests (#1671 by Stanisล‚aw Chmiela)\",\n )\n }\n\n @Test\n fun `test print`() {\n val content = changelogFile.readText()\n val changelog = ChangeLogUtils.formatBody(content, \"1.17.1\")\n\n val printed = ChangeLogUtils.print(changelog)\n\n assertThat(printed).isEqualTo(\n \"\\n\" +\n \"- Tweak: Remove Maestro Studio icon from Mac dock\\n\" +\n \"- Tweak: Prefer port 9999 for Maestro Studio app\\n\" +\n \"- Fix: Fix Maestro Studio conditional code snippet\\n\"\n )\n }\n}\n" }, { "path": "maestro-cli/src/test/kotlin/maestro/cli/util/DependencyResolverTest.kt", "content": "package maestro.cli.util\n\nimport com.google.common.truth.Truth.assertThat\nimport org.junit.jupiter.api.Test\nimport org.junit.jupiter.api.io.TempDir\nimport java.nio.file.Path\nimport kotlin.io.path.writeText\n\nclass DependencyResolverTest {\n \n @Test\n fun `test dependency discovery for single flow file`(@TempDir tempDir: Path) {\n // Create a main flow file\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - runFlow: subflow1.yaml\n - runFlow: subflow2.yaml\n - runScript: validation.js\n - addMedia:\n - \"images/logo.png\"\n \"\"\".trimIndent())\n \n // Create subflow files\n val subflow1 = tempDir.resolve(\"subflow1.yaml\")\n subflow1.writeText(\"\"\"\n appId: com.example.app\n ---\n - tapOn: \"Button\"\n \"\"\".trimIndent())\n \n val subflow2 = tempDir.resolve(\"subflow2.yaml\")\n subflow2.writeText(\"\"\"\n appId: com.example.app\n ---\n - runFlow: nested_subflow.yaml\n \"\"\".trimIndent())\n \n // Create nested subflow\n val nestedSubflow = tempDir.resolve(\"nested_subflow.yaml\")\n nestedSubflow.writeText(\"\"\"\n appId: com.example.app\n ---\n - assertVisible: \"Text\"\n \"\"\".trimIndent())\n \n // Create script file\n val script = tempDir.resolve(\"validation.js\")\n script.writeText(\"console.log('validation script');\")\n \n // Create media file\n val mediaDir = tempDir.resolve(\"images\")\n mediaDir.toFile().mkdirs()\n val mediaFile = mediaDir.resolve(\"logo.png\")\n mediaFile.writeText(\"fake png content\")\n \n // Test dependency discovery\n val dependencies = DependencyResolver.discoverAllDependencies(mainFlow)\n \n // Should include all files\n assertThat(dependencies).hasSize(6)\n assertThat(dependencies).contains(mainFlow)\n assertThat(dependencies).contains(subflow1)\n assertThat(dependencies).contains(subflow2)\n assertThat(dependencies).contains(nestedSubflow)\n assertThat(dependencies).contains(script)\n assertThat(dependencies).contains(mediaFile)\n }\n \n @Test\n fun `test dependency summary generation`(@TempDir tempDir: Path) {\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - runFlow: subflow.yaml\n - runScript: script.js\n - addMedia:\n - \"images/logo.png\"\n \"\"\".trimIndent())\n \n val subflow = tempDir.resolve(\"subflow.yaml\")\n subflow.writeText(\"\"\"\n appId: com.example.app\n ---\n - tapOn: \"Button\"\n \"\"\".trimIndent())\n \n val script = tempDir.resolve(\"script.js\")\n script.writeText(\"console.log('test');\")\n \n val mediaDir = tempDir.resolve(\"images\")\n mediaDir.toFile().mkdirs()\n val mediaFile = mediaDir.resolve(\"logo.png\")\n mediaFile.writeText(\"fake png content\")\n \n val summary = DependencyResolver.getDependencySummary(mainFlow)\n \n assertThat(summary).contains(\"Total files: 4\")\n assertThat(summary).contains(\"Subflows: 1\")\n assertThat(summary).contains(\"Scripts: 1\")\n assertThat(summary).contains(\"Other files: 1\")\n }\n \n @Test\n fun `test enhanced dependency discovery finds all types`(@TempDir tempDir: Path) {\n // Create a main flow file with runScript and addMedia\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - runFlow: subflow.yaml\n - runScript: script.js\n - addMedia:\n - \"images/logo.png\"\n \"\"\".trimIndent())\n \n val subflow = tempDir.resolve(\"subflow.yaml\")\n subflow.writeText(\"\"\"\n appId: com.example.app\n ---\n - tapOn: \"Button\"\n \"\"\".trimIndent())\n \n val script = tempDir.resolve(\"script.js\")\n script.writeText(\"console.log('test');\")\n \n val mediaDir = tempDir.resolve(\"images\")\n mediaDir.toFile().mkdirs()\n val mediaFile = mediaDir.resolve(\"logo.png\")\n mediaFile.writeText(\"fake png content\")\n \n // Test enhanced discovery (should find all dependencies)\n val enhancedDependencies = DependencyResolver.discoverAllDependencies(mainFlow)\n assertThat(enhancedDependencies).hasSize(4)\n assertThat(enhancedDependencies).contains(script)\n assertThat(enhancedDependencies).contains(mediaFile)\n assertThat(enhancedDependencies).contains(subflow)\n }\n \n @Test\n fun `test composite commands - repeat with nested dependencies`(@TempDir tempDir: Path) {\n // Create main flow with repeat command containing nested dependencies\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - repeat:\n times: 3\n commands:\n - runFlow: nested_subflow.yaml\n - runScript: validation.js\n - addMedia:\n - \"images/repeat_logo.png\"\n \"\"\".trimIndent())\n \n // Create nested dependencies\n val nestedSubflow = tempDir.resolve(\"nested_subflow.yaml\")\n nestedSubflow.writeText(\"\"\"\n appId: com.example.app\n ---\n - tapOn: \"Button\"\n \"\"\".trimIndent())\n \n val script = tempDir.resolve(\"validation.js\")\n script.writeText(\"console.log('repeat validation');\")\n \n val mediaDir = tempDir.resolve(\"images\")\n mediaDir.toFile().mkdirs()\n val mediaFile = mediaDir.resolve(\"repeat_logo.png\")\n mediaFile.writeText(\"fake png content\")\n \n // Test dependency discovery\n val dependencies = DependencyResolver.discoverAllDependencies(mainFlow)\n \n // Should find all nested dependencies within repeat command\n assertThat(dependencies).hasSize(4)\n assertThat(dependencies).contains(mainFlow)\n assertThat(dependencies).contains(nestedSubflow)\n assertThat(dependencies).contains(script)\n assertThat(dependencies).contains(mediaFile)\n }\n \n @Test\n fun `test composite commands - retry with file reference`(@TempDir tempDir: Path) {\n // Create main flow with retry command referencing external file\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - retry:\n file: external_retry.yaml\n maxRetries: 3\n \"\"\".trimIndent())\n \n // Create external retry file\n val retryFile = tempDir.resolve(\"external_retry.yaml\")\n retryFile.writeText(\"\"\"\n appId: com.example.app\n ---\n - tapOn: \"Retry Button\"\n - runFlow: nested_flow.yaml\n \"\"\".trimIndent())\n \n // Create nested flow referenced by retry file\n val nestedFlow = tempDir.resolve(\"nested_flow.yaml\")\n nestedFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - assertVisible: \"Success\"\n \"\"\".trimIndent())\n \n // Test dependency discovery\n val dependencies = DependencyResolver.discoverAllDependencies(mainFlow)\n \n // Should find retry file and its nested dependencies\n assertThat(dependencies).hasSize(3)\n assertThat(dependencies).contains(mainFlow)\n assertThat(dependencies).contains(retryFile)\n assertThat(dependencies).contains(nestedFlow)\n }\n \n @Test\n fun `test composite commands - retry with inline commands`(@TempDir tempDir: Path) {\n // Create main flow with retry command containing inline nested dependencies\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - retry:\n maxRetries: 2\n commands:\n - runFlow: retry_subflow.yaml\n - runScript: cleanup.js\n - addMedia:\n - \"images/retry_media.png\"\n \"\"\".trimIndent())\n \n // Create nested dependencies\n val retrySubflow = tempDir.resolve(\"retry_subflow.yaml\")\n retrySubflow.writeText(\"\"\"\n appId: com.example.app\n ---\n - tapOn: \"Retry Action\"\n \"\"\".trimIndent())\n \n val cleanupScript = tempDir.resolve(\"cleanup.js\")\n cleanupScript.writeText(\"console.log('cleanup after retry');\")\n \n val mediaDir = tempDir.resolve(\"images\")\n mediaDir.toFile().mkdirs()\n val retryMedia = mediaDir.resolve(\"retry_media.png\")\n retryMedia.writeText(\"fake retry media content\")\n \n // Test dependency discovery\n val dependencies = DependencyResolver.discoverAllDependencies(mainFlow)\n \n // Should find all nested dependencies within retry command\n assertThat(dependencies).hasSize(4)\n assertThat(dependencies).contains(mainFlow)\n assertThat(dependencies).contains(retrySubflow)\n assertThat(dependencies).contains(cleanupScript)\n assertThat(dependencies).contains(retryMedia)\n }\n \n @Test\n fun `test deeply nested composite commands`(@TempDir tempDir: Path) {\n // Create complex nested structure: runFlow -> repeat -> retry -> runFlow\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - runFlow:\n commands:\n - repeat:\n times: 2\n commands:\n - retry:\n maxRetries: 3\n commands:\n - runFlow: deeply_nested.yaml\n - runScript: deep_script.js\n \"\"\".trimIndent())\n \n // Create deeply nested dependencies\n val deeplyNested = tempDir.resolve(\"deeply_nested.yaml\")\n deeplyNested.writeText(\"\"\"\n appId: com.example.app\n ---\n - tapOn: \"Deep Button\"\n - addMedia:\n - \"images/deep_media.png\"\n \"\"\".trimIndent())\n \n val deepScript = tempDir.resolve(\"deep_script.js\")\n deepScript.writeText(\"console.log('deeply nested script');\")\n \n val mediaDir = tempDir.resolve(\"images\")\n mediaDir.toFile().mkdirs()\n val deepMedia = mediaDir.resolve(\"deep_media.png\")\n deepMedia.writeText(\"deep media content\")\n \n // Test dependency discovery\n val dependencies = DependencyResolver.discoverAllDependencies(mainFlow)\n \n // Should find all dependencies at any nesting level\n assertThat(dependencies).hasSize(4)\n assertThat(dependencies).contains(mainFlow)\n assertThat(dependencies).contains(deeplyNested)\n assertThat(dependencies).contains(deepScript)\n assertThat(dependencies).contains(deepMedia)\n }\n \n @Test\n fun `test mixed composite commands with external and inline`(@TempDir tempDir: Path) {\n // Create flow mixing external file references and inline commands\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - runFlow: external_flow.yaml\n - repeat:\n times: 2\n commands:\n - runScript: inline_script.js\n - retry:\n file: external_retry.yaml\n \"\"\".trimIndent())\n \n // Create external flow\n val externalFlow = tempDir.resolve(\"external_flow.yaml\")\n externalFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - tapOn: \"External Button\"\n \"\"\".trimIndent())\n \n // Create inline script\n val inlineScript = tempDir.resolve(\"inline_script.js\")\n inlineScript.writeText(\"console.log('inline script in repeat');\")\n \n // Create external retry\n val externalRetry = tempDir.resolve(\"external_retry.yaml\")\n externalRetry.writeText(\"\"\"\n appId: com.example.app\n ---\n - assertVisible: \"Retry Success\"\n - runFlow: retry_nested.yaml\n \"\"\".trimIndent())\n \n // Create retry nested flow\n val retryNested = tempDir.resolve(\"retry_nested.yaml\")\n retryNested.writeText(\"\"\"\n appId: com.example.app\n ---\n - tapOn: \"Final Button\"\n \"\"\".trimIndent())\n \n // Test dependency discovery\n val dependencies = DependencyResolver.discoverAllDependencies(mainFlow)\n \n // Should find all dependencies from mixed sources\n assertThat(dependencies).hasSize(5)\n assertThat(dependencies).contains(mainFlow)\n assertThat(dependencies).contains(externalFlow)\n assertThat(dependencies).contains(inlineScript)\n assertThat(dependencies).contains(externalRetry)\n assertThat(dependencies).contains(retryNested)\n }\n \n @Test\n fun `test circular dependency prevention`(@TempDir tempDir: Path) {\n // Create circular dependency: flow1 -> flow2 -> flow1\n val flow1 = tempDir.resolve(\"flow1.yaml\")\n flow1.writeText(\"\"\"\n appId: com.example.app\n ---\n - runFlow: flow2.yaml\n - tapOn: \"Button1\"\n \"\"\".trimIndent())\n \n val flow2 = tempDir.resolve(\"flow2.yaml\")\n flow2.writeText(\"\"\"\n appId: com.example.app\n ---\n - runFlow: flow1.yaml\n - tapOn: \"Button2\"\n \"\"\".trimIndent())\n \n // Test dependency discovery should handle circular references\n val dependencies = DependencyResolver.discoverAllDependencies(flow1)\n \n // Should include both files but not loop infinitely\n // Note: The exact count may vary based on parsing, but should include at least flow1\n // and should not hang due to circular reference\n assertThat(dependencies.size).isAtLeast(1)\n assertThat(dependencies).contains(flow1)\n // flow2 might not be included if parsing fails, but the important thing is no infinite loop\n }\n \n @Test\n fun `test dependency summary with composite commands`(@TempDir tempDir: Path) {\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - repeat:\n times: 2\n commands:\n - runFlow: repeat_subflow.yaml\n - runScript: repeat_script.js\n - retry:\n file: retry_flow.yaml\n - addMedia:\n - \"images/main_logo.png\"\n \"\"\".trimIndent())\n \n // Create all dependencies\n val repeatSubflow = tempDir.resolve(\"repeat_subflow.yaml\")\n repeatSubflow.writeText(\"appId: com.example.app\\n---\\n- tapOn: 'Button'\")\n \n val repeatScript = tempDir.resolve(\"repeat_script.js\")\n repeatScript.writeText(\"console.log('repeat');\")\n \n val retryFlow = tempDir.resolve(\"retry_flow.yaml\")\n retryFlow.writeText(\"appId: com.example.app\\n---\\n- assertVisible: 'Text'\")\n \n val mediaDir = tempDir.resolve(\"images\")\n mediaDir.toFile().mkdirs()\n val mainLogo = mediaDir.resolve(\"main_logo.png\")\n mainLogo.writeText(\"logo content\")\n \n val summary = DependencyResolver.getDependencySummary(mainFlow)\n \n assertThat(summary).contains(\"Total files: 5\")\n assertThat(summary).contains(\"Subflows: 2\") // repeat_subflow.yaml + retry_flow.yaml\n assertThat(summary).contains(\"Scripts: 1\") // repeat_script.js\n assertThat(summary).contains(\"Other files: 1\") // main_logo.png\n }\n \n @Test\n fun `test configuration commands - onFlowStart and onFlowComplete with dependencies`(@TempDir tempDir: Path) {\n // Create main flow with onFlowStart and onFlowComplete containing file dependencies\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\"\"\"\n appId: com.example.app\n onFlowStart:\n - runFlow: startup_flow.yaml\n - runScript: startup_script.js\n - addMedia:\n - \"images/startup_logo.png\"\n onFlowComplete:\n - runFlow: cleanup_flow.yaml \n - runScript: cleanup_script.js\n - addMedia:\n - \"images/completion_badge.png\"\n ---\n - tapOn: \"Main Button\"\n \"\"\".trimIndent())\n \n // Create startup dependencies\n val startupFlow = tempDir.resolve(\"startup_flow.yaml\")\n startupFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - tapOn: \"Startup Button\"\n - runFlow: nested_startup.yaml\n \"\"\".trimIndent())\n \n val nestedStartup = tempDir.resolve(\"nested_startup.yaml\")\n nestedStartup.writeText(\"\"\"\n appId: com.example.app\n ---\n - assertVisible: \"Startup Complete\"\n \"\"\".trimIndent())\n \n val startupScript = tempDir.resolve(\"startup_script.js\")\n startupScript.writeText(\"console.log('startup initialization');\")\n \n val imagesDir = tempDir.resolve(\"images\")\n imagesDir.toFile().mkdirs()\n val startupLogo = imagesDir.resolve(\"startup_logo.png\")\n startupLogo.writeText(\"startup logo content\")\n \n // Create cleanup dependencies\n val cleanupFlow = tempDir.resolve(\"cleanup_flow.yaml\")\n cleanupFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - tapOn: \"Cleanup Button\"\n \"\"\".trimIndent())\n \n val cleanupScript = tempDir.resolve(\"cleanup_script.js\")\n cleanupScript.writeText(\"console.log('cleanup finalization');\")\n \n val completionBadge = imagesDir.resolve(\"completion_badge.png\")\n completionBadge.writeText(\"completion badge content\")\n \n // Test dependency discovery\n val dependencies = DependencyResolver.discoverAllDependencies(mainFlow)\n \n // Should find all dependencies from onFlowStart and onFlowComplete\n assertThat(dependencies).hasSize(8) // main + 2 startup flows + 2 scripts + 2 images + 1 cleanup flow\n assertThat(dependencies).contains(mainFlow)\n assertThat(dependencies).contains(startupFlow)\n assertThat(dependencies).contains(nestedStartup)\n assertThat(dependencies).contains(startupScript)\n assertThat(dependencies).contains(startupLogo)\n assertThat(dependencies).contains(cleanupFlow)\n assertThat(dependencies).contains(cleanupScript)\n assertThat(dependencies).contains(completionBadge)\n }\n \n @Test\n fun `test mixed configuration and composite commands`(@TempDir tempDir: Path) {\n // Create complex flow with both configuration commands and composite commands\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\"\"\"\n appId: com.example.app\n onFlowStart:\n - repeat:\n times: 2\n commands:\n - runFlow: repeated_startup.yaml\n onFlowComplete:\n - retry:\n maxRetries: 3\n commands:\n - runScript: retry_cleanup.js\n ---\n - tapOn: \"Main Action\"\n - runFlow: main_subflow.yaml\n \"\"\".trimIndent())\n \n // Create all dependencies\n val repeatedStartup = tempDir.resolve(\"repeated_startup.yaml\")\n repeatedStartup.writeText(\"\"\"\n appId: com.example.app\n ---\n - tapOn: \"Repeated Action\"\n \"\"\".trimIndent())\n \n val retryCleanup = tempDir.resolve(\"retry_cleanup.js\")\n retryCleanup.writeText(\"console.log('retry cleanup');\")\n \n val mainSubflow = tempDir.resolve(\"main_subflow.yaml\")\n mainSubflow.writeText(\"\"\"\n appId: com.example.app\n ---\n - assertVisible: \"Main Complete\"\n \"\"\".trimIndent())\n \n // Test dependency discovery\n val dependencies = DependencyResolver.discoverAllDependencies(mainFlow)\n \n // Should find dependencies from configuration commands AND main flow\n assertThat(dependencies).hasSize(4)\n assertThat(dependencies).contains(mainFlow)\n assertThat(dependencies).contains(repeatedStartup) // From onFlowStart -> repeat -> runFlow\n assertThat(dependencies).contains(retryCleanup) // From onFlowComplete -> retry -> runScript \n assertThat(dependencies).contains(mainSubflow) // From main flow -> runFlow\n }\n\n @Test\n fun `test dependency discovery for repeated flow references`(@TempDir tempDir: Path) {\n // Create a main flow file\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - runFlow: subflow.yaml\n - runFlow: subflow.yaml\n - runFlow:\n commands:\n - runFlow: subflow.yaml\n \"\"\".trimIndent())\n\n // Create subflow files\n val subflow1 = tempDir.resolve(\"subflow.yaml\")\n subflow1.writeText(\"\"\"\n appId: com.example.app\n ---\n - tapOn: \"Button\"\n \"\"\".trimIndent())\n\n // Test dependency discovery\n val dependencies = DependencyResolver.discoverAllDependencies(mainFlow)\n\n // Should include all files\n assertThat(dependencies).hasSize(2)\n assertThat(dependencies).contains(mainFlow)\n assertThat(dependencies).contains(subflow1)\n\n }\n\n @Test\n fun `deduplicates same script referenced via different relative paths`(@TempDir tempDir: Path) {\n // Directory layout:\n // tempDir/\n // main_flow.yaml\n // sub/\n // subflow.yaml\n // scripts/\n // createAccount.js\n\n // Create directories\n tempDir.resolve(\"sub\").toFile().mkdirs()\n tempDir.resolve(\"scripts\").toFile().mkdirs()\n\n // Create shared script\n val script = tempDir.resolve(\"scripts/createAccount.js\")\n script.writeText(\"console.log('create account');\")\n\n // Subflow that references script with a simple relative path\n val subflow = tempDir.resolve(\"sub/subflow.yaml\")\n subflow.writeText(\n \"\"\"\n appId: com.example.app\n ---\n - runScript: ../scripts/createAccount.js\n \"\"\".trimIndent()\n )\n\n // Main flow references the same script using a different path notation and the subflow\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\n \"\"\"\n appId: com.example.app\n ---\n - runFlow: sub/subflow.yaml\n - runScript: ./sub/../scripts/createAccount.js\n \"\"\".trimIndent()\n )\n\n val dependencies = DependencyResolver.discoverAllDependencies(mainFlow)\n\n // Expect exactly one instance of the script, despite two different references\n val scriptCount = dependencies.count { it.fileName.toString() == \"createAccount.js\" }\n assertThat(scriptCount).isEqualTo(1)\n\n // Also expect both flows to be included\n assertThat(dependencies.any { it.fileName.toString() == \"main_flow.yaml\" }).isTrue()\n assertThat(dependencies.any { it.fileName.toString() == \"subflow.yaml\" }).isTrue()\n }\n\n @Test\n fun `test assertScreenshot reference image is discovered as a dependency`(@TempDir tempDir: Path) {\n val referenceImage = tempDir.resolve(\"reference.png\")\n referenceImage.writeText(\"fake png content\")\n\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - assertScreenshot: reference.png\n \"\"\".trimIndent())\n\n val dependencies = DependencyResolver.discoverAllDependencies(mainFlow)\n\n assertThat(dependencies).hasSize(2)\n assertThat(dependencies).contains(mainFlow)\n assertThat(dependencies).contains(referenceImage)\n }\n\n @Test\n fun `test assertScreenshot inside repeat block is discovered as a dependency`(@TempDir tempDir: Path) {\n val referenceImage = tempDir.resolve(\"reference.png\")\n referenceImage.writeText(\"fake png content\")\n\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\"\"\"\n appId: com.example.app\n ---\n - repeat:\n times: 3\n commands:\n - assertScreenshot: reference.png\n \"\"\".trimIndent())\n\n val dependencies = DependencyResolver.discoverAllDependencies(mainFlow)\n\n assertThat(dependencies).hasSize(2)\n assertThat(dependencies).contains(mainFlow)\n assertThat(dependencies).contains(referenceImage)\n }\n\n @Test\n fun `treats files with same name but different real paths as different dependencies`(@TempDir tempDir: Path) {\n // Directory layout:\n // tempDir/\n // main_flow.yaml\n // scripts/\n // createUser.js\n // usa/\n // createUser.js\n\n // Create directories\n tempDir.resolve(\"scripts\").toFile().mkdirs()\n tempDir.resolve(\"scripts/usa\").toFile().mkdirs()\n\n // Create two different scripts with the same filename\n val script1 = tempDir.resolve(\"scripts/createUser.js\")\n script1.writeText(\"console.log('create user - default');\")\n\n val script2 = tempDir.resolve(\"scripts/usa/createUser.js\")\n script2.writeText(\"console.log('create user - USA');\")\n\n // Main flow references both scripts\n val mainFlow = tempDir.resolve(\"main_flow.yaml\")\n mainFlow.writeText(\n \"\"\"\n appId: com.example.app\n ---\n - runScript: scripts/createUser.js\n - runScript: scripts/usa/createUser.js\n \"\"\".trimIndent()\n )\n\n val dependencies = DependencyResolver.discoverAllDependencies(mainFlow)\n\n // Expect both scripts to be included as separate dependencies\n assertThat(dependencies).hasSize(3) // main_flow.yaml + 2 scripts\n assertThat(dependencies).contains(mainFlow)\n assertThat(dependencies).contains(script1)\n assertThat(dependencies).contains(script2)\n\n // Verify both are present by checking their real paths\n val scriptPaths = dependencies.filter { it.fileName.toString() == \"createUser.js\" }\n assertThat(scriptPaths).hasSize(2)\n assertThat(scriptPaths).contains(script1)\n assertThat(scriptPaths).contains(script2)\n }\n\n}\n" }, { "path": "maestro-cli/src/test/kotlin/maestro/cli/util/WorkspaceUtilsTest.kt", "content": "package maestro.cli.util\n\nimport com.google.common.truth.Truth.assertThat\nimport org.junit.jupiter.api.Test\nimport org.junit.jupiter.api.io.TempDir\nimport java.net.URI\nimport java.nio.file.FileSystems\nimport java.nio.file.Files\nimport java.nio.file.Path\nimport kotlin.io.path.readText\n\nclass WorkspaceUtilsTest {\n\n @Test\n fun `includes files outside workspace directory using path traversal`(@TempDir tempDir: Path) {\n // Layout:\n // tempDir/\n // flows/main.yaml\n // scripts/outside.js\n val flowsDir = tempDir.resolve(\"flows\").toFile()\n flowsDir.mkdirs()\n val scriptsDir = tempDir.resolve(\"scripts\").toFile()\n scriptsDir.mkdirs()\n\n val outsideScript = tempDir.resolve(\"scripts/outside.js\")\n Files.writeString(outsideScript, \"console.log('outside');\")\n\n val mainFlow = tempDir.resolve(\"flows/main.yaml\")\n Files.writeString(\n mainFlow,\n \"\"\"\n appId: com.example.app\n ---\n - runScript: ../scripts/outside.js\n \"\"\".trimIndent()\n )\n\n // Create ZIP\n val outZip = tempDir.resolve(\"workspace.zip\")\n WorkspaceUtils.createWorkspaceZip(mainFlow, outZip)\n\n // Open ZIP FS and collect entry names\n val zipUri = URI.create(\"jar:${outZip.toUri()}\")\n val entryNames = mutableListOf()\n FileSystems.newFileSystem(zipUri, emptyMap()).use { fs ->\n Files.walk(fs.getPath(\"/\")).use { paths ->\n paths.filter { Files.isRegularFile(it) }\n .forEach { entryNames.add(it.toString().removePrefix(\"/\")) }\n }\n }\n\n // Current behavior: Path traversal entries are NOT rejected\n // The script is outside the flows/ directory, so relativize produces \"../scripts/outside.js\"\n // This entry IS created in the ZIP (no validation/rejection happens)\n val hasTraversalEntry = entryNames.any { it.contains(\"..\") && it.contains(\"scripts/outside.js\") }\n val hasScriptEntry = entryNames.any { it.endsWith(\"outside.js\") || it.endsWith(\"scripts/outside.js\") }\n \n // Either the traversal path is preserved OR normalization resolves it - both are acceptable\n // The key point: NO rejection happens, the ZIP is created successfully\n assertThat(hasTraversalEntry || hasScriptEntry).isTrue()\n assertThat(entryNames.size).isAtLeast(2) // Should have at least main.yaml and the script\n }\n\n @Test\n fun `handles symlinks correctly`(@TempDir tempDir: Path) {\n // Layout:\n // tempDir/\n // flows/main.yaml\n // scripts/real.js (actual file)\n // scripts/link.js -> real.js (symlink pointing to real.js)\n \n // The flow references link.js normally, but link.js is a symlink\n // This tests what happens when a dependency file is actually a symlink\n \n val flowsDir = tempDir.resolve(\"flows\").toFile()\n flowsDir.mkdirs()\n val scriptsDir = tempDir.resolve(\"scripts\").toFile()\n scriptsDir.mkdirs()\n\n val realScript = tempDir.resolve(\"scripts/real.js\")\n Files.writeString(realScript, \"console.log('real');\")\n\n // Create symlink: link.js is a symlink that points to real.js\n val linkScript = tempDir.resolve(\"scripts/link.js\")\n Files.createSymbolicLink(linkScript, realScript)\n\n val mainFlow = tempDir.resolve(\"flows/main.yaml\")\n Files.writeString(\n mainFlow,\n \"\"\"\n appId: com.example.app\n ---\n - runScript: ../scripts/link.js\n \"\"\".trimIndent()\n )\n\n val outZip = tempDir.resolve(\"workspace.zip\")\n WorkspaceUtils.createWorkspaceZip(mainFlow, outZip)\n\n // With normalization using toRealPath(NOFOLLOW_LINKS), symlink paths are preserved\n // The ZIP should include the script (as link.js or normalized to real.js)\n val zipUri = URI.create(\"jar:${outZip.toUri()}\")\n val entryNames = mutableListOf()\n FileSystems.newFileSystem(zipUri, emptyMap()).use { fs ->\n Files.walk(fs.getPath(\"/\")).use { paths ->\n paths.filter { Files.isRegularFile(it) }\n .forEach { entryNames.add(it.toString().removePrefix(\"/\")) }\n }\n }\n\n // Should have main.yaml and the script (either link.js or real.js, depending on normalization)\n assertThat(entryNames.size).isAtLeast(2)\n assertThat(entryNames.any { it.endsWith(\"main.yaml\") }).isTrue()\n // Script should be included (either as link.js or normalized to real.js)\n assertThat(entryNames.any { it.contains(\"real.js\") || it.contains(\"link.js\") }).isTrue()\n }\n\n @Test\n fun `handles special characters in file paths`(@TempDir tempDir: Path) {\n // Test paths with spaces, unicode, and other special characters\n val mainFlow = tempDir.resolve(\"main.yaml\")\n Files.writeString(\n mainFlow,\n \"\"\"\n appId: com.example.app\n ---\n - runScript: \"scripts/script with spaces.js\"\n - addMedia:\n - \"images/รฉmoji๐ŸŽ‰.png\"\n \"\"\".trimIndent()\n )\n\n val scriptsDir = tempDir.resolve(\"scripts\").toFile()\n scriptsDir.mkdirs()\n val scriptWithSpaces = tempDir.resolve(\"scripts/script with spaces.js\")\n Files.writeString(scriptWithSpaces, \"console.log('spaces');\")\n\n val imagesDir = tempDir.resolve(\"images\").toFile()\n imagesDir.mkdirs()\n val emojiFile = tempDir.resolve(\"images/รฉmoji๐ŸŽ‰.png\")\n Files.writeString(emojiFile, \"fake png\")\n\n val outZip = tempDir.resolve(\"workspace.zip\")\n WorkspaceUtils.createWorkspaceZip(mainFlow, outZip)\n\n // ZIP should be created successfully with special characters\n assertThat(outZip.toFile().exists()).isTrue()\n \n val zipUri = URI.create(\"jar:${outZip.toUri()}\")\n val entryNames = mutableListOf()\n FileSystems.newFileSystem(zipUri, emptyMap()).use { fs ->\n Files.walk(fs.getPath(\"/\")).use { paths ->\n paths.filter { Files.isRegularFile(it) }\n .forEach { entryNames.add(it.toString().removePrefix(\"/\")) }\n }\n }\n\n // All files should be included\n assertThat(entryNames.size).isAtLeast(3)\n assertThat(entryNames.any { it.contains(\"script with spaces.js\") }).isTrue()\n assertThat(entryNames.any { it.contains(\"รฉmoji\") || it.contains(\"๐ŸŽ‰\") }).isTrue()\n }\n\n @Test\n fun `handles empty files`(@TempDir tempDir: Path) {\n val mainFlow = tempDir.resolve(\"main.yaml\")\n Files.writeString(\n mainFlow,\n \"\"\"\n appId: com.example.app\n ---\n - runScript: empty.js\n \"\"\".trimIndent()\n )\n\n val emptyScript = tempDir.resolve(\"empty.js\")\n Files.createFile(emptyScript) // Create empty file\n\n val outZip = tempDir.resolve(\"workspace.zip\")\n WorkspaceUtils.createWorkspaceZip(mainFlow, outZip)\n\n // Should handle empty files gracefully\n assertThat(outZip.toFile().exists()).isTrue()\n \n val zipUri = URI.create(\"jar:${outZip.toUri()}\")\n val entryNames = mutableListOf()\n FileSystems.newFileSystem(zipUri, emptyMap()).use { fs ->\n Files.walk(fs.getPath(\"/\")).use { paths ->\n paths.filter { Files.isRegularFile(it) }\n .forEach { entryNames.add(it.toString().removePrefix(\"/\")) }\n }\n }\n\n assertThat(entryNames.size).isAtLeast(2)\n assertThat(entryNames.any { it.endsWith(\"empty.js\") }).isTrue()\n }\n}\n\n" }, { "path": "maestro-cli/src/test/mcp/README.md", "content": "# MCP Testing Framework\n\nThis directory contains testing infrastructure for Maestro's MCP (Model Context Protocol) server.\n\n## Quick Start\n\n```bash\n# Test tool functionality (API validation)\n./run_mcp_tool_tests.sh ios\n\n# Test LLM behavior evaluations\n./run_mcp_evals.sh ios\n```\n\n## Testing Types\n\n### Tool Functionality Tests (`run_mcp_tool_tests.sh`)\n- **Purpose**: Validate that MCP tools execute without errors and return expected data types\n- **Speed**: Fast (no complex setup required)\n- **Use case**: CI/CD gating, quick smoke tests during development\n\n### LLM Behavior Evaluations (`run_mcp_evals.sh`)\n- **Purpose**: Validate that LLMs can properly use MCP tools to complete tasks\n- **Speed**: Slower (includes LLM reasoning evaluation)\n- **Use case**: Behavior validation, regression testing of LLM interactions\n" }, { "path": "maestro-cli/src/test/mcp/full-evals.yaml", "content": "# yaml-language-server: $schema=https://raw.githubusercontent.com/steviec/mcp-server-tester/refs/heads/main/src/schemas/tests-schema.json\n# MCP LLM Evaluations (evals) Test Configuration\n# Updated to current YAML format syntax\n\nevals:\n models:\n - claude-3-5-haiku-latest\n timeout: 30000\n max_steps: 3\n tests:\n - name: Lists all available tools\n prompt: Please list all available maestro tools you have access to.\n expected_tool_calls:\n allowed: []\n response_scorers:\n - type: llm-judge\n criteria: >\n The assistant makes no tool calls and instead provides a list of all\n 14 available tools: list_devices, start_device, launch_app, take_screenshot,\n tap_on, input_text, back, stop_app, run_flow, run_flow_files, check_flow_syntax,\n inspect_view_hierarchy, cheat_sheet, and query_docs. The response should be\n comprehensive and not mention any other tool names.\n threshold: 1.0\n\n - name: Lists all devices\n prompt: Please list all available devices for testing\n expected_tool_calls:\n required:\n - list_devices\n\n - name: Starts iOS device\n prompt: Start an iOS device for testing\n expected_tool_calls:\n required:\n - start_device\n response_scorers:\n - type: llm-judge\n criteria: Did the assistant correctly start an iOS device and mention the device ID or confirm successful startup?\n\n - name: Queries Maestro documentation\n prompt: How do I tap on an element with specific text in Maestro?\n expected_tool_calls:\n required:\n - query_docs\n allowed:\n - cheat_sheet\n response_scorers:\n - type: regex\n pattern: '(tap|tapOn|text)'\n - type: llm-judge\n criteria: >\n Did the assistant provide accurate information about tapping elements\n with text in Maestro, including proper syntax or examples?\n threshold: 0.8\n\n - name: Validates flow syntax\n prompt: 'Check if this Maestro flow syntax is valid: ''- tapOn: \"Submit button\"'''\n expected_tool_calls:\n required:\n - check_flow_syntax\n allowed:\n - cheat_sheet\n response_scorers:\n - type: regex\n pattern: '(valid|invalid|syntax|error)'\n\n - name: Runs flow file by description\n prompt: Please run our \"launch-safari-ios\" flow file in the setup/flows folder\n expected_tool_calls:\n required:\n - run_flow_files\n" }, { "path": "maestro-cli/src/test/mcp/inspect-view-hierarchy-evals.yaml", "content": "\n# yaml-language-server: $schema=https://raw.githubusercontent.com/steviec/mcp-server-tester/refs/heads/main/src/schemas/tests-schema.json\nevals:\n models:\n - claude-3-7-sonnet-latest\n - claude-3-5-haiku-latest\n timeout: 40000\n max_steps: 10\n tests:\n - name: LLM can understand csv-based view hierarchy format\n prompt: >\n Using the inspect_view_hierarchy tool, describe the number of clickable elements and their position on the screen. Do not take a screenshot.\n expected_tool_calls:\n required:\n - inspect_view_hierarchy\n allowed:\n - list_devices\n - start_device\n - launch_app\n response_scorers:\n - type: llm-judge\n criteria: >\n The assistant successfully uses the inspect_view_hierarchy tool with format=csv.\n The assistant correctly identifies two buttons: \"allow\", and \"don't allow\" in the middle of the screen.\n threshold: 0.6\n\n # NOTE: Below are old tests when we were doing evals on various format types. We might want to resuscitate these at some point\n # to make the format even more optimal, but for now we'll \n # - name: yaml_compact_format_comprehension\n # description: Test if LLM can understand and extract information from yaml compact view hierarchy format\n # prompt: >\n # Using the inspect_view_hierarchy tool with the \"yaml\" format, describe the number of clickable elements on the screen, and their position on the screen. Do not take a screenshot.\n # expectedToolCalls:\n # required:\n # - inspect_view_hierarchy\n # allowed:\n # - list_devices\n # - start_device\n # - launch_app\n # responseScorers:\n # - type: llm-judge\n # criteria: >\n # The assistant successfully uses the inspect_view_hierarchy tool with format=yaml.\n # The assistant correctly identifies exactly 8 clickable elements: 7 buttons in a column, and a final button in the bottom right corner.\n # threshold: 1.0\n\n # - name: csv_original_format_comprehension\n # description: Test if LLM can understand and extract information from csv compact view hierarchy format\n # prompt: >\n # Using the inspect_view_hierarchy tool with the \"csv-original\" format, describe the number of clickable elements and their position on the screen. Do not take a screenshot.\n # expectedToolCalls:\n # required:\n # - inspect_view_hierarchy\n # allowed:\n # - list_devices\n # - start_device\n # - launch_app\n # responseScorers:\n # - type: llm-judge\n # criteria: >\n # The assistant successfully uses the inspect_view_hierarchy tool.\n # The assistant correctly identifies exactly 8 clickable elements: 7 buttons in a column, and a final button in the bottom right corner.\n # threshold: 1.0\n \n # - name: json_compact_format_comprehension\n # description: Test if LLM can understand and extract information from json compact view hierarchy format\n # prompt: >\n # Using the inspect_view_hierarchy tool with the \"json\" format, describe the number of clickable elements and their position on the screen. Do not take a screenshot.\n # expectedToolCalls:\n # required:\n # - inspect_view_hierarchy\n # allowed:\n # - list_devices\n # - start_device\n # - launch_app\n # responseScorers:\n # - type: llm-judge\n # criteria: >\n # The assistant successfully uses the inspect_view_hierarchy tool with format=json.\n # The assistant correctly identifies exactly 8 clickable elements: 7 buttons in a column, and a final button in the bottom right corner.\n # threshold: 0.8 \n\n # - name: schema_guided_navigation\n # description: Test if LLM can use the YAML compact schema to understand abbreviations\n # prompt: >\n # Use the yaml compact format to get the view hierarchy. Using the schema provided in the output,\n # find an element that has both text content and is clickable. Explain how you identified it.\n # expectedToolCalls:\n # required:\n # - inspect_view_hierarchy\n # responseScorers:\n # - type: llm-judge\n # criteria: >\n # The assistant uses inspect_view_hierarchy with yaml compact format, references the\n # ui_schema section to understand abbreviations, correctly identifies that 'txt' means text\n # and 'clickable: true' indicates an interactive element, and explains the process clearly.\n # threshold: 0.8\n\n # - name: multi_format_comparison\n # description: Test LLM ability to work with multiple formats and choose the best one for a task\n # prompt: >\n # I want to get a quick overview of all interactive elements on the screen for automated testing.\n # Which format would be most suitable and why? Demonstrate by getting the hierarchy in that format.\n # expectedToolCalls:\n # required:\n # - inspect_view_hierarchy\n # responseScorers:\n # - type: llm-judge\n # criteria: >\n # The assistant analyzes the different format options, makes a reasoned choice \n # (likely yaml compact or json compact for efficiency, or CSV for structured processing),\n # explains the reasoning, and demonstrates by calling inspect_view_hierarchy with\n # the chosen format.\n # threshold: 0.8\n\n # - name: error_handling_invalid_format\n # description: Test how LLM handles invalid format parameters\n # prompt: >\n # Try to get the view hierarchy using an invalid format parameter like \"xml\".\n # What happens and how would you handle this?\n # expectedToolCalls:\n # required:\n # - inspect_view_hierarchy\n # responseScorers:\n # - type: llm-judge\n # criteria: >\n # The assistant attempts inspect_view_hierarchy with an invalid format,\n # observes that it falls back to the default (yaml compact), and explains\n # that the tool has built-in error handling with sensible defaults.\n # threshold: 0.8" }, { "path": "maestro-cli/src/test/mcp/launch_app_with_env_replacement.yaml", "content": "appId: ${APP_ID}\n---\n- launchApp" }, { "path": "maestro-cli/src/test/mcp/maestro-mcp.json", "content": "{\n \"mcpServers\": {\n \"maestro-mcp\": {\n \"command\": \"../../../build/install/maestro/bin/maestro\",\n \"args\": [\n \"mcp\",\n \"--working-dir\",\n \".\"\n ],\n \"env\": {\n \"MAESTRO_API_KEY\": \"ADD_YOUR_API_KEY_HERE\"\n }\n }\n }\n}\n" }, { "path": "maestro-cli/src/test/mcp/mcp-server-config.json", "content": "{\n \"mcpServers\": {\n \"maestro-mcp\": {\n \"command\": \"../../../../maestro-cli/build/install/maestro/bin/maestro\",\n \"args\": [\n \"mcp\",\n \"--working-dir\",\n \".\"\n ],\n \"env\": {\n \"MAESTRO_API_KEY\": \"ADD_YOUR_API_KEY_HERE\"\n }\n }\n }\n}\n" }, { "path": "maestro-cli/src/test/mcp/run_mcp_evals.sh", "content": "#!/bin/bash\nset -e\n\n# Run MCP evaluation tests\n#\n# These tests validate MCP server behavior using LLM-based evaluations.\n# They test actual task completion and response quality.\n#\n# Usage: ./run_mcp_evals.sh [ios|android]\n\nplatform=\"${1:-ios}\"\n\nif [ \"$platform\" != \"android\" ] && [ \"$platform\" != \"ios\" ]; then\n echo \"usage: $0 [ios|android]\"\n exit 1\nfi\n\necho \"๐Ÿ”ง Running MCP evaluation tests for $platform\"\n\n# Get the script directory for relative paths\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\n\n# Check if Maestro CLI is built\n\"$SCRIPT_DIR/setup/check-maestro-cli-built.sh\"\n\n# Run the evaluation tests (from mcp directory so paths work correctly)\necho \"๐Ÿงช Executing MCP evaluation tests...\"\ncd \"$SCRIPT_DIR\"\nnpx -y mcp-server-tester@1.3.1 evals full-evals.yaml --server-config maestro-mcp.json || true\n\necho \"โœ… MCP evaluation tests completed!\"" }, { "path": "maestro-cli/src/test/mcp/run_mcp_tool_tests.sh", "content": "#!/bin/bash\nset -e\n\n# Run MCP tool functionality tests\n#\n# These tests validate that tools execute without errors and return expected data types.\n# They test the API functionality, not LLM behavior.\n#\n# Usage: ./run_tool_tests.sh [ios|android]\n\nplatform=\"${1:-ios}\"\n\nif [ \"$platform\" != \"android\" ] && [ \"$platform\" != \"ios\" ]; then\n echo \"usage: $0 [ios|android]\"\n exit 1\nfi\n\n# Get the script directory for relative paths\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\n\n# Check if Maestro CLI is built\n\"$SCRIPT_DIR/setup/check-maestro-cli-built.sh\"\n\n# Run the tests that do not require a simulator\necho \"๐Ÿงช Executing tool functionality tests that do not require a simulator...\"\nnpx -y mcp-server-tester@1.3.1 tools tool-tests-without-device.yaml --server-config maestro-mcp.json || true\n\n# Ensure simulator/emulator is running (required for tool tests)\necho \"๐Ÿงช Launching simulator...\"\nDEVICE_ID=$(\"$SCRIPT_DIR/setup/launch-simulator.sh\" \"$platform\")\n\n# Run the tool tests (from mcp directory so paths work correctly)\necho \"๐Ÿงช Executing tool functionality tests...\"\ncd \"$SCRIPT_DIR\"\nDEVICE_ID=\"$DEVICE_ID\" npx -y mcp-server-tester@1.3.1 tools tool-tests-with-device.yaml --server-config maestro-mcp.json || true\n\necho \"โœ… Tool functionality tests completed!\"\n" }, { "path": "maestro-cli/src/test/mcp/setup/check-maestro-cli-built.sh", "content": "#!/bin/bash\nset -e\n\n# Check if Maestro CLI is built for MCP testing\n#\n# This script verifies that the Maestro CLI has been built and is available\n# at the expected location for MCP testing.\n#\n# Usage: ./check-maestro-cli-built.sh\n\n# Get the script directory and find the repo root\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nMAESTRO_ROOT=\"$(cd \"$SCRIPT_DIR/../../../../..\" && pwd)\"\n\n# Check if Maestro CLI is built\nMAESTRO_CLI_PATH=\"$MAESTRO_ROOT/maestro-cli/build/install/maestro/bin/maestro\"\nif [ ! -f \"$MAESTRO_CLI_PATH\" ]; then\n echo \"โŒ Error: Maestro CLI not found at expected location.\"\n echo \" MCP tests require the Maestro CLI to be built first.\"\n echo \" Please run: ./gradlew :maestro-cli:installDist\"\n echo \" From the repository root: $MAESTRO_ROOT\"\n exit 1\nfi\n" }, { "path": "maestro-cli/src/test/mcp/setup/download-and-install-apps.sh", "content": "#!/bin/bash\nset -e\n\n# Download and install apps for MCP testing\n#\n# Uses the existing e2e infrastructure to download and install test apps\n# on the specified platform.\n#\n# Usage: ./download-and-install-apps.sh \n\nplatform=\"${1:-}\"\n\nif [ \"$platform\" != \"android\" ] && [ \"$platform\" != \"ios\" ]; then\n echo \"usage: $0 \"\n exit 1\nfi\n\necho \"๐Ÿ“ฅ Setting up apps for MCP testing on $platform\"\n\n# Get the script directory and find e2e directory\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nMAESTRO_ROOT=\"$(cd \"$SCRIPT_DIR/../../../../..\" && pwd)\"\nE2E_DIR=\"$MAESTRO_ROOT/e2e\"\n\n# Check if we can find the e2e directory\nif [ ! -d \"$E2E_DIR\" ]; then\n echo \"โŒ Error: Could not find e2e directory at $E2E_DIR\"\n exit 1\nfi\n\necho \"๐Ÿ“‚ Using e2e directory: $E2E_DIR\"\n\n# Step 1: Download apps using e2e infrastructure\necho \"๐Ÿ“ฅ Downloading test apps...\"\ncd \"$E2E_DIR\"\n./download_apps\n\n# Step 2: Install apps for the specified platform\necho \"๐Ÿ“ฑ Installing apps on $platform...\"\n./install_apps \"$platform\"\n\necho \"โœ… Apps ready for MCP testing on $platform\"" }, { "path": "maestro-cli/src/test/mcp/setup/flows/launch-demo-app-ios.yaml", "content": "appId: com.example.example\n---\n# Launch Demo App with clear state for evaluations\n\n- launchApp:\n appId: com.example.example\n clearState: true\n\n# Wait for app to load\n- waitForAnimationToEnd:\n timeout: 3000" }, { "path": "maestro-cli/src/test/mcp/setup/flows/launch-safari-ios.yaml", "content": "appId: com.apple.mobilesafari\n---\n# Simple Safari launch for view hierarchy testing\n- launchApp:\n clearState: true\n\n# Wait for Safari to load\n- waitForAnimationToEnd:\n timeout: 2000" }, { "path": "maestro-cli/src/test/mcp/setup/flows/setup-wikipedia-search-android.yaml", "content": "appId: org.wikipedia\n---\n# Navigate Wikipedia to search screen for view hierarchy testing\n# Assumes onboarding is already completed\n\n# Dismiss any auth modals that might appear\n- tapOn:\n text: \"Continue without logging in\"\n optional: true\n\n# Navigate to search to get an interesting hierarchy\n- tapOn:\n text: \"Search Wikipedia\"\n optional: true\n\n# Enter a search term to populate results\n- inputText:\n text: \"Artificial Intelligence\"\n optional: true\n\n# Wait for search results to load\n- waitForAnimationToEnd:\n timeout: 3000\n\n# App should now show search results with rich hierarchy" }, { "path": "maestro-cli/src/test/mcp/setup/flows/setup-wikipedia-search-ios.yaml", "content": "appId: org.wikimedia.wikipedia\n---\n# Navigate Wikipedia to search screen for view hierarchy testing\n# Assumes onboarding is already completed\n\n# Dismiss any auth modals that might appear (from e2e advanced flow)\n- tapOn:\n text: \"Continue without logging in\"\n optional: true\n\n# Navigate to search to get an interesting hierarchy\n- tapOn:\n text: \"Search Wikipedia\"\n optional: true\n\n# Enter a search term to populate results\n- inputText:\n text: \"Artificial Intelligence\"\n optional: true\n\n# Wait for search results to load\n- waitForAnimationToEnd:\n timeout: 3000\n\n# App should now show search results with rich hierarchy" }, { "path": "maestro-cli/src/test/mcp/setup/flows/verify-ready-state.yaml", "content": "appId: org.wikimedia.wikipedia\n---\n# Verify Wikipedia is in a good state for view hierarchy testing\n# Should be showing search results or main interface\n\n# Check that we can see some expected elements\n- assertVisible:\n text: \"Search\"\n optional: true\n\n# Or search results if we're on search page\n- assertVisible:\n text: \"Intelligence\"\n optional: true\n\n# Or main page elements\n- assertVisible:\n text: \"Wikipedia\"\n optional: true\n\n# Just ensure the app is responsive and loaded\n- waitForAnimationToEnd:\n timeout: 2000" }, { "path": "maestro-cli/src/test/mcp/setup/launch-simulator.sh", "content": "#!/bin/bash\nset -e\n\n# Launch simulator/emulator for MCP testing\n#\n# Checks if a simulator is running and launches if it's not running\n#\n# Usage: ./launch-simulator.sh \n\nplatform=\"${1:-}\"\n\nif [ \"$platform\" != \"android\" ] && [ \"$platform\" != \"ios\" ]; then\n echo \"usage: $0 [--auto-launch]\"\n exit 1\nfi\n\nif [ \"$platform\" = \"ios\" ]; then\n if xcrun simctl list devices | grep -q \"(Booted)\"; then\n echo \"โœ… iOS simulator is already running\" >&2\n device_id=$(xcrun simctl list devices | grep \"(Booted)\" | head -1 | grep -o '[A-F0-9-]\\{36\\}')\n echo \"$device_id\"\n exit 0\n fi\n \n # Find the first available iPhone simulator\n available_sim=$(xcrun simctl list devices | grep \"iPhone\" | grep -v \"unavailable\" | head -1 | sed 's/.*iPhone \\([^(]*\\).*/iPhone \\1/' | sed 's/ *$//')\n \n if [ -n \"$available_sim\" ]; then\n echo \"๐Ÿ“ฑ Booting: $available_sim\" >&2\n device_id=$(xcrun simctl list devices | grep \"iPhone\" | grep -v \"unavailable\" | head -1 | grep -o '[A-F0-9-]\\{36\\}')\n xcrun simctl boot \"$device_id\"\n xcrun simctl bootstatus \"$device_id\" > /dev/null\n echo \"โœ… iOS simulator launched successfully\" >&2\n else\n echo \"โŒ Error: No available iOS simulators found\" >&2\n exit 1\n fi\n \nelif [ \"$platform\" = \"android\" ]; then\n if adb devices | grep -q \"device$\"; then\n echo \"โœ… Android emulator/device is connected\" >&2\n device_id=$(adb devices | grep \"device$\" | head -1 | awk '{print $1}')\n elif [ \"$auto_launch\" = true ]; then\n echo \"๐Ÿš€ Auto-launching Android emulator not implemented yet\" >&2\n echo \" Please start an Android emulator manually\" >&2\n exit 1\n else\n echo \"โŒ No Android emulator/device is connected\" >&2\n echo \" Please start an Android emulator first\" >&2\n echo \" Or connect a physical device\" >&2\n exit 1\n fi\nfi\n\necho \"$device_id\"" }, { "path": "maestro-cli/src/test/mcp/setup/setup_and_run_eval.sh", "content": "#!/bin/bash\nset -e\n\n# Run MCP LLM behavior evaluations\n#\n# These tests validate that LLMs can properly use MCP tools, including reasoning,\n# safety, and interaction patterns. They test client/server interaction and LLM capabilities.\n#\n# Usage: ./run_mcp_evals.sh [--app mobilesafari|wikipedia|demo_app] [eval-file2.yaml] [...]\n\n# Parse arguments\napp_setup=\"none\" # Default to clean home screen\neval_files=()\n\nwhile [[ $# -gt 0 ]]; do\n case $1 in\n --app)\n app_setup=\"$2\"\n if [[ ! \"$app_setup\" =~ ^(none|mobilesafari|wikipedia|demo_app)$ ]]; then\n echo \"Error: --app must be one of: none, mobilesafari, wikipedia, demo_app\"\n exit 1\n fi\n shift 2\n ;;\n *.yaml)\n eval_files+=(\"$1\")\n shift\n ;;\n *)\n echo \"Unknown argument: $1\"\n echo \"usage: $0 [--app mobilesafari|wikipedia|demo_app] [eval-file2.yaml] [...]\"\n exit 1\n ;;\n esac\ndone\n\nif [ ${#eval_files[@]} -eq 0 ]; then\n echo \"โŒ Error: No eval files provided\"\n echo \"usage: $0 [--app mobilesafari|wikipedia|demo_app] [eval-file2.yaml] [...]\"\n echo \" Default app setup: none (clean home screen)\"\n echo \"\"\n echo \"Available eval files:\"\n find evals/ -name \"*.yaml\" 2>/dev/null | sed 's/^/ /' || echo \" (none found)\"\n exit 1\nfi\n\n# Get the script directory for relative paths\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nCONFIG=\"$SCRIPT_DIR/mcp-server-config.json\"\n\n# Check if Maestro CLI is built\n\"$SCRIPT_DIR/setup/check-maestro-cli-built.sh\"\n\n# Ensure simulator is running (required for MCP evals that test device tools)\nplatform=\"ios\"\n\"$SCRIPT_DIR/setup/launch-simulator.sh\" \"$platform\"\n\n# App setup based on chosen option\ncase \"$app_setup\" in\n \"none\")\n echo \"๐Ÿ“ฑ No app setup - using clean simulator home screen\"\n ;;\n \"mobilesafari\")\n echo \"๐Ÿ“ฑ Launching Mobile Safari for evaluations...\"\n cd \"$(dirname \"$SCRIPT_DIR\")/../../..\"\n maestro test \"$SCRIPT_DIR/setup/flows/launch-safari-ios.yaml\"\n echo \"โœ… Mobile Safari ready for evaluations\"\n ;;\n \"wikipedia\")\n echo \"๐Ÿ“ฑ Setting up Wikipedia app environment for complex evaluations...\"\n \n # Use setup utilities for app environment\n \"$SCRIPT_DIR/setup/download-and-install-apps.sh\" ios\n \n # Setup Wikipedia in a good state for hierarchy testing\n cd \"$(dirname \"$SCRIPT_DIR\")/../../..\"\n maestro test \"$SCRIPT_DIR/setup/flows/setup-wikipedia-search-ios.yaml\"\n maestro test \"$SCRIPT_DIR/setup/flows/verify-ready-state.yaml\"\n \n echo \"โœ… Wikipedia app environment ready for evaluations\"\n ;;\n \"demo_app\")\n echo \"๐Ÿ“ฑ Launching Demo App for evaluations...\"\n\n # Use setup utilities for app environment\n \"$SCRIPT_DIR/setup/download-and-install-apps.sh\" ios\n\n cd \"$(dirname \"$SCRIPT_DIR\")/../../..\"\n maestro test \"$SCRIPT_DIR/setup/flows/launch-demo-app-ios.yaml\"\n echo \"โœ… Demo App ready for evaluations\"\n ;;\nesac\n\n# Run each eval file (from mcp directory so paths work correctly)\ncd \"$SCRIPT_DIR\"\n\neval_count=0\nfor eval_file in \"${eval_files[@]}\"; do\n eval_count=$((eval_count + 1))\n echo \"๐Ÿ“‹ Running eval $eval_count: $eval_file\"\n \n # Check if file exists, try relative to evals/ if not absolute\n if [ ! -f \"$eval_file\" ]; then\n if [ -f \"evals/$eval_file\" ]; then\n eval_file=\"evals/$eval_file\"\n else\n echo \"โŒ Error: Eval file not found: $eval_file\"\n exit 1\n fi\n fi\n \n # Run the evals using MCP inspector\n npx -y mcp-server-tester@1.3.1 evals \"$eval_file\" --server-config \"$CONFIG\"\ndone\n" }, { "path": "maestro-cli/src/test/mcp/tool-tests-with-device.yaml", "content": "# yaml-language-server: $schema=https://raw.githubusercontent.com/steviec/mcp-server-tester/refs/heads/main/src/schemas/tests-schema.json\ntools:\n tests:\n - name: \"Test take_screenshot\"\n tool: \"take_screenshot\"\n params:\n device_id: \"${DEVICE_ID}\"\n expect:\n success: true\n\n - name: \"Test inspect_view_hierarchy\"\n tool: \"inspect_view_hierarchy\"\n params:\n device_id: \"${DEVICE_ID}\"\n expect:\n success: true\n\n - name: \"Test launch_app\"\n tool: \"launch_app\"\n params:\n device_id: \"${DEVICE_ID}\"\n appId: \"com.apple.mobilesafari\"\n expect:\n success: true\n\n - name: \"Test tap_on\"\n tool: \"tap_on\"\n params:\n device_id: \"${DEVICE_ID}\"\n text: \"Search\"\n expect:\n success: true\n\n - name: \"Test input_text\"\n tool: \"input_text\"\n params:\n device_id: \"${DEVICE_ID}\"\n text: \"hello\"\n expect:\n success: true\n\n - name: \"Test stop_app\"\n tool: \"stop_app\"\n params:\n device_id: \"${DEVICE_ID}\"\n appId: \"com.apple.mobilesafari\"\n expect:\n success: true\n\n - name: \"Test run_flow\"\n tool: \"run_flow\"\n params:\n device_id: \"${DEVICE_ID}\"\n flow_yaml: |\n appId: com.apple.mobilesafari\n ---\n - launchApp\n expect:\n success: true\n \n - name: \"Test run_flow_files (expect failure - nonexistent file)\"\n tool: \"run_flow_files\"\n params:\n device_id: \"${DEVICE_ID}\"\n flow_files: \"nonexistent.yaml\"\n expect:\n success: false\n error:\n contains: \"not found\"\n\n - name: \"Test run_flow_files with env replacement\"\n tool: \"run_flow_files\"\n params:\n device_id: \"${DEVICE_ID}\"\n flow_files: \"launch_app_with_env_replacement.yaml\"\n env: \n APP_ID: \"com.apple.mobilesafari\"\n expect:\n success: true\n" }, { "path": "maestro-cli/src/test/mcp/tool-tests-without-device.yaml", "content": "# yaml-language-server: $schema=https://raw.githubusercontent.com/steviec/mcp-server-tester/refs/heads/main/src/schemas/tests-schema.json\ntools:\n expected_tool_list:\n - list_devices\n - start_device\n - launch_app\n - take_screenshot\n - tap_on\n - input_text\n - back\n - stop_app\n - run_flow\n - run_flow_files\n - check_flow_syntax\n - inspect_view_hierarchy\n - cheat_sheet\n - query_docs\n\n tests:\n - name: \"List available devices\"\n tool: \"list_devices\"\n params: {}\n expect:\n success: true\n result:\n contains: \"device\"\n\n - name: \"Get Maestro cheat sheet (expect API key required)\"\n tool: \"cheat_sheet\"\n params: {}\n expect:\n success: false\n error:\n contains: \"MAESTRO_CLOUD_API_KEY\"\n\n - name: \"Query Maestro docs (expect API key required)\"\n tool: \"query_docs\"\n params:\n question: \"How do I tap on an element?\"\n expect:\n success: false\n error:\n contains: \"MAESTRO_CLOUD_API_KEY\"\n\n - name: \"Check valid flow syntax\"\n tool: \"check_flow_syntax\"\n params:\n flow_yaml: |\n appId: com.apple.mobilesafari\n ---\n - tapOn: \"Search\"\n - inputText: \"hello world\"\n expect:\n success: true\n result:\n contains: \"valid\"\n\n - name: \"Check invalid flow syntax\"\n tool: \"check_flow_syntax\"\n params:\n flow_yaml: \"invalid[yaml\"\n expect:\n success: true\n result:\n contains: \"invalid\"\n\n - name: \"Start iOS device\"\n tool: \"start_device\"\n params:\n platform: \"ios\"\n expect:\n success: true\n result:\n contains: \"device_id\"" }, { "path": "maestro-cli/src/test/resources/apps/web-manifest.json", "content": "{\"url\":\"https://example.com\"}" }, { "path": "maestro-cli/src/test/resources/location/assert_multiple_locations.yaml", "content": "appId: \"com.google.android.apps.maps\"\n---\n- launchApp\n- tapOn:\n text: Skip\n optional: true\n- setLocation:\n longitude: 2.295188\n latitude: 48.8578065\n- assertVisible: .*Eiffel.*\n- setLocation:\n latitude: 43.7230\n longitude: 10.3966\n- assertVisible: .*(Piazza|Pisa).*" }, { "path": "maestro-cli/src/test/resources/travel/assert_travel_command.yaml", "content": "appId: \"com.google.android.apps.maps\"\n---\n- launchApp\n- tapOn:\n text: Skip\n optional: true\n- setLocation:\n latitude: 48.8578065\n longitude: 2.295188\n- assertVisible: .*Eiffel.*\n- travel:\n points:\n - 48.8578065, 2.295188\n - 46.2276, 5.9900\n - 43.7230, 10.3966\n - 41.8902, 12.4922\n speed: 1000\n- assertVisible: .*Colosseo.*\n\n\n\n\n\n\n\n" }, { "path": "maestro-cli/src/test/resources/workspaces/cloud_test/android/flow.yaml", "content": "appId: com.example.maestro.orientation\n---\n- launchApp\n" }, { "path": "maestro-cli/src/test/resources/workspaces/cloud_test/ios/flow.yaml", "content": "appId: com.example.SimpleWebViewApp\n---\n- launchApp\n" }, { "path": "maestro-cli/src/test/resources/workspaces/cloud_test/tagged/regression.yaml", "content": "appId: com.example.SimpleWebViewApp\ntags:\n - regression\n---\n- launchApp\n" }, { "path": "maestro-cli/src/test/resources/workspaces/cloud_test/tagged/smoke.yaml", "content": "appId: com.example.SimpleWebViewApp\ntags:\n - smoke\n---\n- launchApp\n" }, { "path": "maestro-cli/src/test/resources/workspaces/cloud_test/web/flow.yaml", "content": "appId: https://example.com\nurl: https://example.com\n---\n- launchApp\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/00_mixed_web_mobile_flow_tests/mobileflow.yaml", "content": "appId: com.example.mobileapp\n---\n- launchApp\n- tapOn: 'Button'\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/00_mixed_web_mobile_flow_tests/mobileflow2.yaml", "content": "appId: com.example.mobileapp2\n---\n- launchApp\n- tapOn: 'Submit'\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/00_mixed_web_mobile_flow_tests/webflow.yaml", "content": "url: https://example.com\n---\n- launchApp\n- tapOn: 'Button'\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/00_mixed_web_mobile_flow_tests/webflow2.yaml", "content": "url: https://example2.com\n---\n- launchApp\n- tapOn: 'Button'\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/01_web_only/webflow.yaml", "content": "appId: com.example.webapp\nurl: https://example.com\n---\n- launchApp\n- tapOn: 'Button'\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/01_web_only/webflow2.yaml", "content": "url: https://example2.com\n---\n- launchApp\n- tapOn: 'Button'\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/02_mobile_only/mobileflow1.yaml", "content": "appId: com.example.mobileapp1\n---\n- launchApp\n- tapOn: 'Button'\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/02_mobile_only/mobileflow2.yaml", "content": "appId: com.example.mobileapp2\n---\n- launchApp\n- tapOn: 'Submit'\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/03_mixed_with_config_execution_order/config.yaml", "content": "flows:\n - 'subFolder/*'\nincludeTags:\n - tagNameToInclude\nexcludeTags:\n - tagNameToExclude\nexecutionOrder:\n continueOnFailure: false\n flowsOrder:\n - mobileflow\n - mobileflow2\n - webflow\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/03_mixed_with_config_execution_order/subFolder/mobileflow.yaml", "content": "appId: com.example.mobileapp\nname: mobileflow\ntags:\n - tagNameToInclude\n---\n- launchApp\n- tapOn: 'Button'\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/03_mixed_with_config_execution_order/subFolder/mobileflow2.yaml", "content": "appId: com.example.mobileapp2\nname: mobileflow2\nproperties:\n property-1: property1 value\n property-2: property2 value\ntags:\n - tagNameToInclude\n---\n- launchApp\n- tapOn: 'Submit'\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/03_mixed_with_config_execution_order/subFolder/webflow.yaml", "content": "url: https://example.com\nname: webflow\ntags:\n - tagNameToInclude\n---\n- launchApp\n- tapOn: 'Button'\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/03_mixed_with_config_execution_order/subFolder/webflow2.yaml", "content": "url: https://example2.com\nname: webflow2\ntags:\n - tagNameToExclude\n---\n- launchApp\n- tapOn: 'Button'\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/04_web_only_with_config_execution_order/config.yaml", "content": "flows:\n - 'subFolder/*'\nexcludeTags:\n - tagNameToExclude\nexecutionOrder:\n continueOnFailure: false\n flowsOrder:\n - mobileflow\n - mobileflow2\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/04_web_only_with_config_execution_order/subFolder/mobileflow.yaml", "content": "appId: com.example.mobileapp\nname: mobileflow\ntags:\n - tagNameToInclude\n---\n- launchApp\n- tapOn: 'Button'\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/04_web_only_with_config_execution_order/subFolder/mobileflow2.yaml", "content": "appId: com.example.mobileapp2\nname: mobileflow2\ntags:\n - tagNameToInclude\n---\n- launchApp\n- tapOn: 'Submit'\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/04_web_only_with_config_execution_order/subFolder/webflow.yaml", "content": "url: https://example.com\nname: webflow\ntags:\n - tagNameToExclude\n---\n- launchApp\n- tapOn: 'Button'\n" }, { "path": "maestro-cli/src/test/resources/workspaces/test_command_test/04_web_only_with_config_execution_order/subFolder/webflow2.yaml", "content": "url: https://example2.com\nname: webflow2\ntags:\n - tagNameToExclude\n---\n- launchApp\n- tapOn: 'Button'\n" }, { "path": "maestro-client/build.gradle.kts", "content": "import org.jetbrains.kotlin.gradle.tasks.KotlinCompilationTask\n\nplugins {\n id(\"maven-publish\")\n alias(libs.plugins.kotlin.jvm)\n alias(libs.plugins.mavenPublish)\n alias(libs.plugins.protobuf)\n}\n\nprotobuf {\n protoc {\n artifact = \"com.google.protobuf:protoc:${libs.versions.googleProtobuf.get()}\"\n }\n\n plugins {\n create(\"grpc\") {\n artifact = \"io.grpc:protoc-gen-grpc-java:${libs.versions.grpc.get()}\"\n }\n }\n\n generateProtoTasks {\n all().forEach { task ->\n task.plugins {\n create(\"grpc\")\n }\n\n task.builtins {\n create(\"kotlin\")\n }\n }\n }\n}\n\ntasks.named(\"compileKotlin\") {\n dependsOn(\"generateProto\")\n}\n\ntasks.named(\"processResources\") {\n dependsOn(\":maestro-android:copyMaestroAndroid\")\n}\n\ntasks.whenTaskAdded {\n if (name == \"sourcesJar\" && this is Jar) {\n dependsOn(\":maestro-android:copyMaestroAndroid\")\n duplicatesStrategy = DuplicatesStrategy.EXCLUDE\n }\n}\n\nkotlin.sourceSets.all {\n // Prevent build warnings for grpc's generated opt-in code\n languageSettings.optIn(\"kotlin.RequiresOptIn\")\n}\n\nsourceSets {\n main {\n java {\n srcDirs(\n \"build/generated/source/proto/main/grpc\",\n \"build/generated/source/proto/main/java\",\n \"build/generated/source/proto/main/kotlin\"\n )\n }\n }\n}\n\ndependencies {\n protobuf(project(\":maestro-proto\"))\n implementation(project(\":maestro-utils\"))\n implementation(project(\":maestro-ios-driver\"))\n\n api(libs.graaljs)\n api(libs.graaljsEngine)\n api(libs.graaljsLanguage)\n\n api(libs.grpc.kotlin.stub)\n api(libs.grpc.stub)\n api(libs.grpc.netty)\n api(libs.grpc.protobuf)\n api(libs.grpc.okhttp)\n api(libs.google.protobuf.kotlin)\n api(libs.kotlin.result)\n api(libs.dadb)\n api(libs.square.okio)\n api(libs.square.okio.jvm)\n api(libs.image.comparison)\n api(libs.mozilla.rhino)\n api(libs.square.okhttp)\n api(libs.jarchivelib)\n api(libs.jackson.core.databind)\n api(libs.jackson.module.kotlin)\n api(libs.jackson.dataformat.yaml)\n api(libs.jackson.dataformat.xml)\n api(libs.apk.parser)\n\n implementation(project(\":maestro-ios\"))\n implementation(project(\":maestro-web\"))\n implementation(libs.google.findbugs)\n implementation(libs.axml)\n implementation(libs.selenium)\n implementation(libs.selenium.devtools)\n implementation(libs.jcodec)\n implementation(libs.datafaker)\n\n api(libs.logging.sl4j)\n api(libs.logging.api)\n api(libs.logging.layout.template)\n api(libs.log4j.core)\n\n testImplementation(libs.junit.jupiter.api)\n testRuntimeOnly(libs.junit.jupiter.engine)\n testImplementation(libs.google.truth)\n testImplementation(libs.square.mock.server)\n testImplementation(libs.junit.jupiter.params)\n}\n\njava {\n sourceCompatibility = JavaVersion.VERSION_17\n targetCompatibility = JavaVersion.VERSION_17\n}\n\nkotlin {\n jvmToolchain {\n languageVersion.set(JavaLanguageVersion.of(17))\n }\n}\n\ntasks.named(\"compileKotlin\", KotlinCompilationTask::class.java) {\n compilerOptions {\n freeCompilerArgs.addAll(\"-Xjdk-release=17\")\n }\n}\n\nmavenPublishing {\n publishToMavenCentral(true)\n signAllPublications()\n}\n\ntasks.named(\"test\") {\n useJUnitPlatform()\n}\n" }, { "path": "maestro-client/gradle.properties", "content": "POM_NAME=Maestro Client\nPOM_ARTIFACT_ID=maestro-client\nPOM_PACKAGING=jar" }, { "path": "maestro-client/src/main/java/maestro/Bounds.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro\n\ndata class Bounds(\n val x: Int,\n val y: Int,\n val width: Int,\n val height: Int\n) {\n\n fun center(): Point {\n return Point(\n x = x + width / 2,\n y = y + height / 2\n )\n }\n\n fun area(): Int {\n return width * height\n }\n\n fun contains(x: Int, y: Int): Boolean {\n return x in this.x until this.x + width\n && y in this.y until this.y + height\n }\n\n}\n" }, { "path": "maestro-client/src/main/java/maestro/Capability.kt", "content": "package maestro\n\nenum class Capability {\n FAST_HIERARCHY,\n}" }, { "path": "maestro-client/src/main/java/maestro/DeviceInfo.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro\n\nimport maestro.device.Platform\n\ndata class DeviceInfo(\n val platform: Platform,\n val widthPixels: Int,\n val heightPixels: Int,\n val widthGrid: Int,\n val heightGrid: Int,\n)\n\nfun xcuitest.api.DeviceInfo.toCommonDeviceInfo(): DeviceInfo {\n return DeviceInfo(\n platform = Platform.IOS,\n widthPixels = widthPixels,\n heightPixels = heightPixels,\n widthGrid = widthPoints,\n heightGrid = heightPoints,\n )\n}\n" }, { "path": "maestro-client/src/main/java/maestro/Driver.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro\n\nimport maestro.device.DeviceOrientation\nimport okio.Sink\nimport java.io.File\n\ninterface Driver {\n\n fun name(): String\n\n fun open()\n\n fun close()\n\n fun deviceInfo(): DeviceInfo\n\n fun launchApp(\n appId: String,\n launchArguments: Map,\n )\n\n fun stopApp(appId: String)\n\n fun killApp(appId: String)\n\n fun clearAppState(appId: String)\n\n fun clearKeychain()\n\n fun tap(point: Point)\n\n fun longPress(point: Point)\n\n fun pressKey(code: KeyCode)\n\n fun contentDescriptor(excludeKeyboardElements: Boolean = false): TreeNode\n\n fun scrollVertical()\n\n fun isKeyboardVisible(): Boolean\n\n fun swipe(start: Point, end: Point, durationMs: Long)\n\n fun swipe(swipeDirection: SwipeDirection, durationMs: Long)\n\n fun swipe(elementPoint: Point, direction: SwipeDirection, durationMs: Long)\n\n fun backPress()\n\n fun inputText(text: String)\n\n fun openLink(link: String, appId: String?, autoVerify: Boolean, browser: Boolean)\n\n fun hideKeyboard()\n\n fun takeScreenshot(out: Sink, compressed: Boolean)\n\n fun startScreenRecording(out: Sink): ScreenRecording\n\n fun setLocation(latitude: Double, longitude: Double)\n\n fun setOrientation(orientation: DeviceOrientation)\n\n fun eraseText(charactersToErase: Int)\n\n fun setProxy(host: String, port: Int)\n\n fun resetProxy()\n\n fun isShutdown(): Boolean\n\n fun isUnicodeInputSupported(): Boolean\n\n fun waitUntilScreenIsStatic(timeoutMs: Long): Boolean\n\n fun waitForAppToSettle(initialHierarchy: ViewHierarchy?, appId: String?, timeoutMs: Int? = null): ViewHierarchy?\n\n fun capabilities(): List\n\n fun setPermissions(appId: String, permissions: Map)\n\n fun addMedia(mediaFiles: List)\n\n fun isAirplaneModeEnabled(): Boolean\n\n fun setAirplaneMode(enabled: Boolean)\n\n fun setAndroidChromeDevToolsEnabled(enabled: Boolean) = Unit\n\n fun queryOnDeviceElements(query: OnDeviceElementQuery): List {\n return listOf()\n }\n\n}\n" }, { "path": "maestro-client/src/main/java/maestro/Errors.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro\n\nsealed class MaestroException(override val message: String, cause: Throwable? = null) : RuntimeException(message, cause) {\n\n class UnableToLaunchApp(message: String, cause: Throwable? = null) : MaestroException(message, cause)\n\n class UnableToClearState(message: String, cause: Throwable? = null) : MaestroException(message, cause)\n\n class UnableToSetPermissions(message: String, cause: Throwable? = null) : MaestroException(message, cause)\n\n class AppCrash(message: String, cause: Throwable? = null): MaestroException(message, cause)\n\n class DriverTimeout(message: String, val debugMessage: String? = null, cause: Throwable? = null): MaestroException(message, cause)\n\n open class AssertionFailure(\n message: String,\n val hierarchyRoot: TreeNode,\n val debugMessage: String,\n cause: Throwable? = null,\n ) : MaestroException(message, cause)\n\n class ElementNotFound(\n message: String,\n hierarchyRoot: TreeNode,\n debugMessage: String,\n cause: Throwable? = null,\n ) : AssertionFailure(message, hierarchyRoot, debugMessage, cause)\n\n class CloudApiKeyNotAvailable(message: String, cause: Throwable? = null) : MaestroException(message, cause)\n\n class DestinationIsNotWritable(message: String, cause: Throwable? = null) : MaestroException(message, cause)\n\n class UnableToCopyTextFromElement(message: String, cause: Throwable? = null): MaestroException(message, cause)\n\n class InvalidCommand(\n message: String,\n cause: Throwable? = null,\n ) : MaestroException(message, cause)\n\n class HideKeyboardFailure(message: String, cause: Throwable? = null, val debugMessage: String) : MaestroException(message, cause)\n\n class NoRootAccess(message: String, cause: Throwable? = null) : MaestroException(message, cause)\n\n class UnsupportedJavaVersion(message: String, cause: Throwable? = null) : MaestroException(message, cause)\n\n class MissingAppleTeamId(message: String, cause: Throwable? = null): MaestroException(message, cause)\n\n class IOSDeviceDriverSetupException(message: String, cause: Throwable? = null): MaestroException(message, cause)\n}\n\nsealed class MaestroDriverStartupException(override val message: String, cause: Throwable? = null): RuntimeException(message, cause) {\n class AndroidDriverTimeoutException(message: String, cause: Throwable? = null): MaestroDriverStartupException(message, cause)\n class AndroidInstrumentationSetupFailure(message: String, cause: Throwable? = null): MaestroDriverStartupException(message, cause)\n}\n" }, { "path": "maestro-client/src/main/java/maestro/Filters.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro\n\nimport maestro.UiElement.Companion.toUiElement\nimport maestro.UiElement.Companion.toUiElementOrNull\nimport kotlin.math.abs\n\ntypealias ElementFilter = (List) -> List\n\ntypealias ElementLookupPredicate = (TreeNode) -> Boolean\n\nobject Filters {\n\n val INDEX_COMPARATOR: Comparator = compareBy(\n { it.toUiElementOrNull()?.bounds?.y ?: Int.MAX_VALUE },\n { it.toUiElementOrNull()?.bounds?.x ?: Int.MAX_VALUE },\n )\n\n fun intersect(filters: List): ElementFilter = { nodes ->\n filters\n .map { it(nodes).toSet() }\n .reduceOrNull { a, b -> a.intersect(b) }\n ?.toList() ?: nodes\n }\n\n fun compose(first: ElementFilter, second: ElementFilter): ElementFilter = compose(listOf(first, second))\n\n fun compose(filters: List): ElementFilter = { nodes ->\n filters\n .fold(nodes) { acc, filter ->\n filter(acc)\n }\n }\n\n fun ElementLookupPredicate.asFilter(): ElementFilter = { nodes ->\n nodes.filter { this(it) }\n }\n\n fun nonClickable(): ElementFilter {\n return { nodes -> nodes.filter { it.clickable == false } }\n }\n\n fun textMatches(regex: Regex): ElementFilter {\n return { nodes ->\n val textMatches = nodes.filter {\n it.attributes[\"text\"]?.let { value ->\n val strippedValue = value.replace('\\n', ' ')\n\n regex.matches(value)\n || regex.pattern == value\n || regex.matches(strippedValue)\n || regex.pattern == strippedValue\n } ?: false\n }.toSet()\n\n val hintTextMatches = nodes.filter {\n it.attributes[\"hintText\"]?.let { value ->\n val strippedValue = value.replace('\\n', ' ')\n\n regex.matches(value)\n || regex.pattern == value\n || regex.matches(strippedValue)\n || regex.pattern == strippedValue\n } ?: false\n }\n\n val accessibilityTextMatches = nodes.filter {\n it.attributes[\"accessibilityText\"]?.let { value ->\n val strippedValue = value.replace('\\n', ' ')\n\n regex.matches(value)\n || regex.pattern == value\n || regex.matches(strippedValue)\n || regex.pattern == strippedValue\n } ?: false\n }.toSet()\n\n textMatches.union(hintTextMatches).union(accessibilityTextMatches).toList()\n }\n }\n\n fun idMatches(regex: Regex): ElementFilter {\n return { nodes ->\n val exactMatches = nodes\n .filter {\n it.attributes[\"resource-id\"]?.let { value ->\n regex.matches(value)\n } ?: false\n }\n .toSet()\n\n val idWithoutPrefixMatches = nodes\n .filter {\n it.attributes[\"resource-id\"]?.let { value ->\n regex.matches(value.substringAfterLast('/'))\n } ?: false\n }\n .toSet()\n\n exactMatches\n .union(idWithoutPrefixMatches)\n .toList()\n }\n }\n\n fun sizeMatches(\n width: Int? = null,\n height: Int? = null,\n tolerance: Int? = null,\n ): ElementLookupPredicate {\n fun predicate(it: TreeNode): Boolean {\n if (it.attributes[\"bounds\"] == null) {\n return false\n }\n\n val uiElement = it.toUiElement()\n\n val finalTolerance = tolerance ?: 0\n if (width != null) {\n if (abs(uiElement.bounds.width - width) > finalTolerance) {\n return false\n }\n }\n\n if (height != null) {\n if (abs(uiElement.bounds.height - height) > finalTolerance) {\n return false\n }\n }\n\n return true\n }\n\n return { predicate(it) }\n }\n\n fun below(otherFilter: ElementFilter): ElementFilter {\n return relativeTo(otherFilter) { it, other -> it.bounds.y > other.bounds.y }\n }\n\n fun above(otherFilter: ElementFilter): ElementFilter {\n return relativeTo(otherFilter) { it, other -> it.bounds.y < other.bounds.y }\n }\n\n fun leftOf(otherFilter: ElementFilter): ElementFilter {\n return relativeTo(otherFilter) { it, other -> it.bounds.x < other.bounds.x }\n }\n\n fun rightOf(otherFilter: ElementFilter): ElementFilter {\n return relativeTo(otherFilter) { it, other -> it.bounds.x > other.bounds.x }\n }\n\n fun relativeTo(otherFilter: ElementFilter, predicate: (UiElement, UiElement) -> Boolean): ElementFilter {\n return { nodes ->\n val matchingOthers = otherFilter(nodes)\n .mapNotNull { it.toUiElementOrNull() }\n\n nodes\n .mapNotNull { it.toUiElementOrNull() }\n .flatMap {\n matchingOthers\n .filter { other -> predicate(it, other) }\n .map { other -> it to it.distanceTo(other) }\n }\n .sortedBy { (_, distance) -> distance }\n .map { (element, _) -> element.treeNode }\n }\n }\n\n fun containsChild(other: UiElement): ElementLookupPredicate {\n val otherNode = other.treeNode\n return {\n it.children\n .any { child -> child == otherNode }\n }\n }\n\n fun containsDescendants(filters: List): ElementFilter {\n fun ElementFilter.matches(node: TreeNode): Boolean {\n return invoke(listOf(node)).isNotEmpty() || node.children.any { matches(it) }\n }\n return { nodes ->\n nodes.filter { node ->\n filters.all { filter ->\n node.children.any { filter.matches(it) }\n }\n }\n }\n }\n\n fun hasText(): ElementLookupPredicate {\n return {\n it.attributes[\"text\"] != null\n }\n }\n\n fun isSquare(): ElementLookupPredicate {\n return {\n it.toUiElementOrNull()\n ?.let { element ->\n abs(1.0f - (element.bounds.width / element.bounds.height.toFloat())) < 0.03f\n } ?: false\n }\n }\n\n fun hasLongText(): ElementLookupPredicate {\n return {\n (it.attributes[\"text\"]?.length ?: 0) > 200\n }\n }\n\n fun index(idx: Int): ElementFilter {\n return { nodes ->\n val sortedNodes = nodes.sortedWith(INDEX_COMPARATOR)\n val resolvedIndex = if (idx >= 0) idx else sortedNodes.size + idx\n\n if (resolvedIndex < 0) {\n emptyList()\n } else {\n listOfNotNull(sortedNodes.getOrNull(resolvedIndex))\n }\n }\n }\n\n fun clickableFirst(): ElementFilter {\n return { nodes ->\n nodes.sortedByDescending { it.clickable }\n }\n }\n\n fun enabled(expected: Boolean): ElementFilter {\n return { nodes ->\n nodes.filter { it.enabled == expected }\n }\n }\n\n fun selected(expected: Boolean): ElementFilter {\n return { nodes ->\n nodes.filter { it.selected == expected }\n }\n }\n\n fun checked(expected: Boolean): ElementFilter {\n return { nodes ->\n nodes.filter { it.checked == expected }\n }\n }\n\n fun focused(expected: Boolean): ElementFilter {\n return { nodes ->\n nodes.filter { it.focused == expected }\n }\n }\n\n fun deepestMatchingElement(filter: ElementFilter): ElementFilter {\n return { nodes ->\n nodes.flatMap { node ->\n val matchingChildren = deepestMatchingElement(filter)(node.children)\n if (matchingChildren.isNotEmpty()) {\n matchingChildren\n } else if (filter(listOf(node)).isNotEmpty()) {\n listOf(node)\n } else {\n emptyList()\n }\n }.distinct()\n }\n }\n\n fun css(maestro: Maestro, cssSelector: String): ElementFilter {\n return { nodes ->\n val matchingNodes = maestro.findElementsByOnDeviceQuery(\n timeoutMs = 5000,\n query = OnDeviceElementQuery.Css(css = cssSelector),\n )?.elements?.map { it.treeNode } ?: emptyList()\n\n nodes.filter { node ->\n matchingNodes.any { it == node }\n }\n }\n }\n\n}\n" }, { "path": "maestro-client/src/main/java/maestro/FindElementResult.kt", "content": "package maestro\n\ndata class FindElementResult(val element: UiElement, val hierarchy: ViewHierarchy)" }, { "path": "maestro-client/src/main/java/maestro/KeyCode.kt", "content": "package maestro\n\nenum class KeyCode(\n val description: String,\n) {\n\n ENTER(\"Enter\"),\n BACKSPACE(\"Backspace\"),\n BACK(\"Back\"),\n HOME(\"Home\"),\n LOCK(\"Lock\"),\n VOLUME_UP(\"Volume Up\"),\n VOLUME_DOWN(\"Volume Down\"),\n REMOTE_UP(\"Remote Dpad Up\"),\n REMOTE_DOWN(\"Remote Dpad Down\"),\n REMOTE_LEFT(\"Remote Dpad Left\"),\n REMOTE_RIGHT(\"Remote Dpad Right\"),\n REMOTE_CENTER(\"Remote Dpad Center\"),\n REMOTE_PLAY_PAUSE(\"Remote Media Play Pause\"),\n REMOTE_STOP(\"Remote Media Stop\"),\n REMOTE_NEXT(\"Remote Media Next\"),\n REMOTE_PREVIOUS(\"Remote Media Previous\"),\n REMOTE_REWIND(\"Remote Media Rewind\"),\n REMOTE_FAST_FORWARD(\"Remote Media Fast Forward\"),\n ESCAPE(\"Escape\"),\n POWER(\"Power\"),\n TAB(\"Tab\"),\n REMOTE_SYSTEM_NAVIGATION_UP(\"Remote System Navigation Up\"),\n REMOTE_SYSTEM_NAVIGATION_DOWN(\"Remote System Navigation Down\"),\n REMOTE_BUTTON_A(\"Remote Button A\"),\n REMOTE_BUTTON_B(\"Remote Button B\"),\n REMOTE_MENU(\"Remote Menu\"),\n TV_INPUT(\"TV Input\"),\n TV_INPUT_HDMI_1(\"TV Input HDMI 1\"),\n TV_INPUT_HDMI_2(\"TV Input HDMI 2\"),\n TV_INPUT_HDMI_3(\"TV Input HDMI 3\");\n\n companion object {\n fun getByName(name: String): KeyCode? {\n val lowercaseName = name.lowercase()\n return values().find { it.description.lowercase() == lowercaseName }\n }\n }\n\n}\n" }, { "path": "maestro-client/src/main/java/maestro/Maestro.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro\n\nimport com.github.romankh3.image.comparison.ImageComparison\nimport maestro.UiElement.Companion.toUiElementOrNull\nimport maestro.device.DeviceOrientation\nimport maestro.drivers.CdpWebDriver\nimport maestro.utils.MaestroTimer\nimport maestro.utils.ScreenshotUtils\nimport maestro.utils.SocketUtils\nimport okio.Buffer\nimport okio.Sink\nimport okio.buffer\nimport okio.sink\nimport okio.use\nimport org.slf4j.LoggerFactory\nimport java.awt.image.BufferedImage\nimport java.io.File\nimport javax.imageio.ImageIO\nimport kotlin.system.measureTimeMillis\n\n@Suppress(\"unused\", \"MemberVisibilityCanBePrivate\")\nclass Maestro(\n val driver: Driver,\n) : AutoCloseable {\n\n val deviceName: String\n get() = driver.name()\n\n val cachedDeviceInfo by lazy {\n LOGGER.info(\"Getting device info\")\n val deviceInfo = driver.deviceInfo()\n LOGGER.info(\"Got device info: $deviceInfo\")\n deviceInfo\n }\n\n @Deprecated(\"This function should be removed and its usages refactored. See issue #2031\")\n fun deviceInfo() = driver.deviceInfo()\n\n private var screenRecordingInProgress = false\n\n fun launchApp(\n appId: String,\n launchArguments: Map = emptyMap(),\n stopIfRunning: Boolean = true\n ) {\n LOGGER.info(\"Launching app $appId\")\n\n if (stopIfRunning) {\n LOGGER.info(\"Stopping $appId app during launch\")\n driver.stopApp(appId)\n }\n driver.launchApp(appId, launchArguments)\n }\n\n fun stopApp(appId: String) {\n LOGGER.info(\"Stopping app $appId\")\n\n driver.stopApp(appId)\n }\n\n fun killApp(appId: String) {\n LOGGER.info(\"Killing app $appId\")\n\n driver.killApp(appId)\n }\n\n fun clearAppState(appId: String) {\n LOGGER.info(\"Clearing app state $appId\")\n\n driver.clearAppState(appId)\n }\n\n fun setPermissions(appId: String, permissions: Map) {\n driver.setPermissions(appId, permissions)\n }\n\n fun clearKeychain() {\n LOGGER.info(\"Clearing keychain\")\n\n driver.clearKeychain()\n }\n\n fun backPress() {\n LOGGER.info(\"Pressing back\")\n\n driver.backPress()\n waitForAppToSettle()\n }\n\n fun hideKeyboard() {\n LOGGER.info(\"Hiding Keyboard\")\n\n driver.hideKeyboard()\n }\n\n fun isKeyboardVisible(): Boolean {\n return driver.isKeyboardVisible()\n }\n\n fun swipe(\n swipeDirection: SwipeDirection? = null,\n startPoint: Point? = null,\n endPoint: Point? = null,\n startRelative: String? = null,\n endRelative: String? = null,\n duration: Long,\n waitToSettleTimeoutMs: Int? = null\n ) {\n val deviceInfo = deviceInfo()\n\n when {\n swipeDirection != null -> driver.swipe(swipeDirection, duration)\n startPoint != null && endPoint != null -> driver.swipe(startPoint, endPoint, duration)\n startRelative != null && endRelative != null -> {\n val startPoints = startRelative.replace(\"%\", \"\")\n .split(\",\").map { it.trim().toInt() }\n val startX = deviceInfo.widthGrid * startPoints[0] / 100\n val startY = deviceInfo.heightGrid * startPoints[1] / 100\n val start = Point(startX, startY)\n\n val endPoints = endRelative.replace(\"%\", \"\")\n .split(\",\").map { it.trim().toInt() }\n val endX = deviceInfo.widthGrid * endPoints[0] / 100\n val endY = deviceInfo.heightGrid * endPoints[1] / 100\n val end = Point(endX, endY)\n\n driver.swipe(start, end, duration)\n }\n }\n\n waitForAppToSettle(waitToSettleTimeoutMs = waitToSettleTimeoutMs)\n }\n\n fun swipe(swipeDirection: SwipeDirection, uiElement: UiElement, durationMs: Long, waitToSettleTimeoutMs: Int?) {\n LOGGER.info(\"Swiping ${swipeDirection.name} on element: $uiElement\")\n driver.swipe(uiElement.bounds.center(), swipeDirection, durationMs)\n\n waitForAppToSettle(waitToSettleTimeoutMs = waitToSettleTimeoutMs)\n }\n\n fun swipeFromCenter(swipeDirection: SwipeDirection, durationMs: Long, waitToSettleTimeoutMs: Int?) {\n val deviceInfo = deviceInfo()\n\n LOGGER.info(\"Swiping ${swipeDirection.name} from center\")\n val center = Point(x = deviceInfo.widthGrid / 2, y = deviceInfo.heightGrid / 2)\n driver.swipe(center, swipeDirection, durationMs)\n waitForAppToSettle(waitToSettleTimeoutMs = waitToSettleTimeoutMs)\n }\n\n fun scrollVertical() {\n LOGGER.info(\"Scrolling vertically\")\n\n driver.scrollVertical()\n waitForAppToSettle()\n }\n\n fun tap(\n element: UiElement,\n initialHierarchy: ViewHierarchy,\n retryIfNoChange: Boolean = false,\n waitUntilVisible: Boolean = false,\n longPress: Boolean = false,\n appId: String? = null,\n tapRepeat: TapRepeat? = null,\n waitToSettleTimeoutMs: Int? = null\n ) {\n LOGGER.info(\"Tapping on element: ${tapRepeat ?: \"\"} $element\")\n\n val hierarchyBeforeTap = waitForAppToSettle(initialHierarchy, appId, waitToSettleTimeoutMs) ?: initialHierarchy\n\n val center = (\n hierarchyBeforeTap\n .refreshElement(element.treeNode)\n ?.also { LOGGER.info(\"Refreshed element\") }\n ?.toUiElementOrNull()\n ?: element\n ).bounds\n .center()\n performTap(\n x = center.x,\n y = center.y,\n retryIfNoChange = retryIfNoChange,\n longPress = longPress,\n initialHierarchy = hierarchyBeforeTap,\n tapRepeat = tapRepeat,\n waitToSettleTimeoutMs = waitToSettleTimeoutMs\n )\n\n if (waitUntilVisible) {\n val hierarchyAfterTap = viewHierarchy()\n\n if (hierarchyBeforeTap == hierarchyAfterTap\n && !hierarchyAfterTap.isVisible(element.treeNode)\n ) {\n LOGGER.info(\"Still no change in hierarchy. Wait until element is visible and try again.\")\n\n val hierarchy = waitUntilVisible(element)\n\n tap(\n element = element,\n initialHierarchy = hierarchy,\n retryIfNoChange = false,\n waitUntilVisible = false,\n longPress = longPress,\n tapRepeat = tapRepeat\n )\n }\n }\n }\n\n fun tapOnRelative(\n percentX: Int,\n percentY: Int,\n retryIfNoChange: Boolean = false,\n longPress: Boolean = false,\n tapRepeat: TapRepeat? = null,\n waitToSettleTimeoutMs: Int? = null\n ) {\n val deviceInfo = driver.deviceInfo()\n val x = deviceInfo.widthGrid * percentX / 100\n val y = deviceInfo.heightGrid * percentY / 100\n tap(\n x = x,\n y = y,\n retryIfNoChange = retryIfNoChange,\n longPress = longPress,\n tapRepeat = tapRepeat,\n waitToSettleTimeoutMs = waitToSettleTimeoutMs\n )\n }\n\n fun tap(\n x: Int,\n y: Int,\n retryIfNoChange: Boolean = false,\n longPress: Boolean = false,\n tapRepeat: TapRepeat? = null,\n waitToSettleTimeoutMs: Int? = null\n ) {\n performTap(\n x = x,\n y = y,\n retryIfNoChange = retryIfNoChange,\n longPress = longPress,\n tapRepeat = tapRepeat,\n waitToSettleTimeoutMs = waitToSettleTimeoutMs\n )\n }\n\n private fun getNumberOfRetries(retryIfNoChange: Boolean): Int {\n return if (retryIfNoChange) 2 else 1\n }\n\n private fun performTap(\n x: Int,\n y: Int,\n retryIfNoChange: Boolean = false,\n longPress: Boolean = false,\n initialHierarchy: ViewHierarchy? = null,\n tapRepeat: TapRepeat? = null,\n waitToSettleTimeoutMs: Int? = null\n ) {\n val capabilities = driver.capabilities()\n\n if (Capability.FAST_HIERARCHY in capabilities) {\n hierarchyBasedTap(x, y, retryIfNoChange, longPress, initialHierarchy, tapRepeat, waitToSettleTimeoutMs)\n } else {\n screenshotBasedTap(x, y, retryIfNoChange, longPress, initialHierarchy, tapRepeat, waitToSettleTimeoutMs)\n }\n }\n\n private fun hierarchyBasedTap(\n x: Int,\n y: Int,\n retryIfNoChange: Boolean = false,\n longPress: Boolean = false,\n initialHierarchy: ViewHierarchy? = null,\n tapRepeat: TapRepeat? = null,\n waitToSettleTimeoutMs: Int? = null\n ) {\n LOGGER.info(\"Tapping at ($x, $y) using hierarchy based logic for wait\")\n\n val hierarchyBeforeTap = initialHierarchy ?: viewHierarchy()\n\n val retries = getNumberOfRetries(retryIfNoChange)\n repeat(retries) {\n if (longPress) {\n driver.longPress(Point(x, y))\n } else if (tapRepeat != null) {\n for (i in 0 until tapRepeat.repeat) {\n\n // subtract execution duration from tap delay\n val duration = measureTimeMillis { driver.tap(Point(x, y)) }\n val delay = if (duration >= tapRepeat.delay) 0 else tapRepeat.delay - duration\n\n if (tapRepeat.repeat > 1) Thread.sleep(delay) // do not wait for single taps\n }\n } else driver.tap(Point(x, y))\n val hierarchyAfterTap = waitForAppToSettle(waitToSettleTimeoutMs = waitToSettleTimeoutMs)\n\n if (hierarchyAfterTap == null || hierarchyBeforeTap != hierarchyAfterTap) {\n LOGGER.info(\"Something has changed in the UI judging by view hierarchy. Proceed.\")\n return\n }\n }\n }\n\n private fun screenshotBasedTap(\n x: Int,\n y: Int,\n retryIfNoChange: Boolean = false,\n longPress: Boolean = false,\n initialHierarchy: ViewHierarchy? = null,\n tapRepeat: TapRepeat? = null,\n waitToSettleTimeoutMs: Int? = null\n ) {\n LOGGER.info(\"Try tapping at ($x, $y) using hierarchy based logic for wait\")\n\n val hierarchyBeforeTap = initialHierarchy ?: viewHierarchy()\n val screenshotBeforeTap: BufferedImage? = ScreenshotUtils.tryTakingScreenshot(driver)\n\n val retries = getNumberOfRetries(retryIfNoChange)\n repeat(retries) {\n if (longPress) {\n driver.longPress(Point(x, y))\n } else if (tapRepeat != null) {\n for (i in 0 until tapRepeat.repeat) {\n\n // subtract execution duration from tap delay\n val duration = measureTimeMillis { driver.tap(Point(x, y)) }\n val delay = if (duration >= tapRepeat.delay) 0 else tapRepeat.delay - duration\n\n if (tapRepeat.repeat > 1) Thread.sleep(delay) // do not wait for single taps\n }\n } else {\n driver.tap(Point(x, y))\n }\n val hierarchyAfterTap = waitForAppToSettle(waitToSettleTimeoutMs = waitToSettleTimeoutMs)\n\n if (hierarchyBeforeTap != hierarchyAfterTap) {\n LOGGER.info(\"Something have changed in the UI judging by view hierarchy. Proceed.\")\n return\n }\n\n LOGGER.info(\"Tapping at ($x, $y) using screenshot based logic for wait\")\n\n val screenshotAfterTap: BufferedImage? = ScreenshotUtils.tryTakingScreenshot(driver)\n if (screenshotBeforeTap != null &&\n screenshotAfterTap != null &&\n screenshotBeforeTap.width == screenshotAfterTap.width &&\n screenshotBeforeTap.height == screenshotAfterTap.height\n ) {\n val imageDiff = ImageComparison(\n screenshotBeforeTap,\n screenshotAfterTap\n ).compareImages().differencePercent\n\n if (imageDiff > SCREENSHOT_DIFF_THRESHOLD) {\n LOGGER.info(\"Something have changed in the UI judging by screenshot (d=$imageDiff). Proceed.\")\n return\n } else {\n LOGGER.info(\"Screenshots are not different enough (d=$imageDiff)\")\n }\n } else {\n LOGGER.info(\"Skipping screenshot comparison\")\n }\n\n LOGGER.info(\"Nothing changed in the UI.\")\n }\n }\n\n private fun waitUntilVisible(element: UiElement): ViewHierarchy {\n var hierarchy = ViewHierarchy(TreeNode())\n repeat(10) {\n hierarchy = viewHierarchy()\n if (!hierarchy.isVisible(element.treeNode)) {\n LOGGER.info(\"Element is not visible yet. Waiting.\")\n MaestroTimer.sleep(MaestroTimer.Reason.WAIT_UNTIL_VISIBLE, 1000)\n } else {\n LOGGER.info(\"Element became visible.\")\n return hierarchy\n }\n }\n\n return hierarchy\n }\n\n fun pressKey(code: KeyCode, waitForAppToSettle: Boolean = true) {\n LOGGER.info(\"Pressing key $code\")\n\n driver.pressKey(code)\n\n if (waitForAppToSettle) {\n waitForAppToSettle()\n }\n }\n\n fun viewHierarchy(excludeKeyboardElements: Boolean = false): ViewHierarchy {\n return ViewHierarchy.from(driver, excludeKeyboardElements)\n }\n\n fun findElementWithTimeout(\n timeoutMs: Long,\n filter: ElementFilter,\n viewHierarchy: ViewHierarchy? = null\n ): FindElementResult? {\n var hierarchy = viewHierarchy ?: ViewHierarchy(TreeNode())\n val element = MaestroTimer.withTimeout(timeoutMs) {\n hierarchy = viewHierarchy ?: viewHierarchy()\n filter(hierarchy.aggregate()).firstOrNull()\n }?.toUiElementOrNull()\n\n return if (element == null) {\n null\n } else {\n if (viewHierarchy != null) {\n hierarchy = ViewHierarchy(element.treeNode)\n }\n return FindElementResult(element, hierarchy)\n }\n }\n\n fun findElementsByOnDeviceQuery(\n timeoutMs: Long,\n query: OnDeviceElementQuery\n ): OnDeviceElementQueryResult? {\n return MaestroTimer.withTimeout(timeoutMs) {\n val elements = driver.queryOnDeviceElements(query)\n\n OnDeviceElementQueryResult(\n elements = elements.mapNotNull { it.toUiElementOrNull() },\n )\n }\n }\n\n fun allElementsMatching(filter: ElementFilter): List {\n return filter(viewHierarchy().aggregate())\n }\n\n fun waitForAppToSettle(\n initialHierarchy: ViewHierarchy? = null,\n appId: String? = null,\n waitToSettleTimeoutMs: Int? = null\n ): ViewHierarchy? {\n return driver.waitForAppToSettle(initialHierarchy, appId, waitToSettleTimeoutMs)\n }\n\n fun inputText(text: String) {\n LOGGER.info(\"Inputting text: $text\")\n\n driver.inputText(text)\n waitForAppToSettle()\n }\n\n fun openLink(link: String, appId: String?, autoVerify: Boolean, browser: Boolean) {\n LOGGER.info(\"Opening link $link for app: $appId with autoVerify config as $autoVerify\")\n\n driver.openLink(link, appId, autoVerify, browser)\n waitForAppToSettle()\n }\n\n fun addMedia(fileNames: List) {\n val mediaFiles = fileNames.map { File(it) }\n driver.addMedia(mediaFiles)\n }\n\n override fun close() {\n driver.close()\n }\n\n @Deprecated(\"Use takeScreenshot(Sink, Boolean) instead\")\n fun takeScreenshot(outFile: File, compressed: Boolean) {\n LOGGER.info(\"Taking screenshot to a file: $outFile\")\n\n val absoluteOutFile = outFile.absoluteFile\n\n if (absoluteOutFile.parentFile.exists() || absoluteOutFile.parentFile.mkdirs()) {\n outFile\n .sink()\n .buffer()\n .use {\n ScreenshotUtils.takeScreenshot(it, compressed, driver)\n }\n } else {\n throw MaestroException.DestinationIsNotWritable(\n \"Failed to create directory for screenshot: ${absoluteOutFile.parentFile}\"\n )\n }\n }\n\n fun takeScreenshot(sink: Sink, compressed: Boolean, bounds: Bounds? = null) {\n if (bounds == null) {\n LOGGER.info(\"Taking screenshot\")\n sink\n .buffer()\n .use {\n ScreenshotUtils.takeScreenshot(it, compressed, driver)\n }\n } else {\n LOGGER.info(\"Taking screenshot (cropped to bounds)\")\n val (x, y, width, height) = bounds\n\n val originalImage = Buffer().apply {\n ScreenshotUtils.takeScreenshot(this, compressed, driver)\n }.let { buffer ->\n buffer.inputStream().use { ImageIO.read(it) }\n }\n\n val info = cachedDeviceInfo\n val scale = if (info.heightGrid > 0) {\n info.heightPixels.toDouble() / info.heightGrid\n } else {\n 1.0\n }\n val startX = (x * scale).toInt().coerceIn(0, originalImage.width)\n val startY = (y * scale).toInt().coerceIn(0, originalImage.height)\n val cropWidthPx = (width * scale).toInt()\n .coerceIn(0, originalImage.width - startX)\n val cropHeightPx = (height * scale).toInt()\n .coerceIn(0, originalImage.height - startY)\n\n if (cropWidthPx <= 0 || cropHeightPx <= 0) {\n throw MaestroException.AssertionFailure(\n message = \"Cannot crop screenshot: invalid dimensions (width: $cropWidthPx, height: $cropHeightPx).\",\n hierarchyRoot = viewHierarchy(excludeKeyboardElements = false).root,\n debugMessage = \"Bounds (grid units) x=$x, y=$y, width=$width, height=$height with scale=$scale produced non-positive crop size.\"\n )\n }\n\n val croppedImage = originalImage.getSubimage(\n startX, startY, cropWidthPx, cropHeightPx\n )\n\n sink\n .buffer()\n .use {\n ImageIO.write(croppedImage, \"png\", it.outputStream())\n }\n }\n }\n\n fun startScreenRecording(out: Sink): ScreenRecording {\n LOGGER.info(\"Starting screen recording\")\n\n if (screenRecordingInProgress) {\n LOGGER.info(\"Screen recording not started: Already in progress\")\n return object : ScreenRecording {\n override fun close() {\n // No-op\n }\n }\n }\n screenRecordingInProgress = true\n\n LOGGER.info(\"Starting screen recording\")\n val screenRecording = driver.startScreenRecording(out)\n val startTimestamp = System.currentTimeMillis()\n return object : ScreenRecording {\n override fun close() {\n LOGGER.info(\"Stopping screen recording\")\n // Ensure minimum screen recording duration of 3 seconds.\n // This addresses an edge case where the launch command completes too quickly.\n val durationPadding = 3000 - (System.currentTimeMillis() - startTimestamp)\n if (durationPadding > 0) {\n Thread.sleep(durationPadding)\n }\n screenRecording.close()\n screenRecordingInProgress = false\n }\n }\n }\n\n fun setLocation(latitude: String, longitude: String) {\n LOGGER.info(\"Setting location: ($latitude, $longitude)\")\n\n driver.setLocation(latitude.toDouble(), longitude.toDouble())\n }\n\n fun setOrientation(orientation: DeviceOrientation, waitForAppToSettle: Boolean = true) {\n LOGGER.info(\"Setting orientation: $orientation\")\n\n driver.setOrientation(orientation)\n\n if (waitForAppToSettle) {\n waitForAppToSettle()\n }\n }\n\n fun eraseText(charactersToErase: Int) {\n LOGGER.info(\"Erasing $charactersToErase characters\")\n\n driver.eraseText(charactersToErase)\n }\n\n fun waitForAnimationToEnd(timeout: Long?) {\n @Suppress(\"NAME_SHADOWING\")\n val timeout = timeout ?: ANIMATION_TIMEOUT_MS\n LOGGER.info(\"Waiting for animation to end with timeout $timeout\")\n\n ScreenshotUtils.waitUntilScreenIsStatic(timeout, SCREENSHOT_DIFF_THRESHOLD, driver)\n }\n\n fun setProxy(\n host: String = SocketUtils.localIp(),\n port: Int\n ) {\n LOGGER.info(\"Setting proxy: $host:$port\")\n\n driver.setProxy(host, port)\n }\n\n fun resetProxy() {\n LOGGER.info(\"Resetting proxy\")\n\n driver.resetProxy()\n }\n\n fun isShutDown(): Boolean {\n return driver.isShutdown()\n }\n\n fun isUnicodeInputSupported(): Boolean {\n return driver.isUnicodeInputSupported()\n }\n\n fun isAirplaneModeEnabled(): Boolean {\n return driver.isAirplaneModeEnabled()\n }\n\n fun setAirplaneModeState(enabled: Boolean) {\n driver.setAirplaneMode(enabled)\n }\n\n fun setAndroidChromeDevToolsEnabled(enabled: Boolean) {\n driver.setAndroidChromeDevToolsEnabled(enabled)\n }\n\n companion object {\n\n private val LOGGER = LoggerFactory.getLogger(Maestro::class.java)\n\n private const val SCREENSHOT_DIFF_THRESHOLD = 0.005 // 0.5%\n private const val ANIMATION_TIMEOUT_MS: Long = 15000\n\n fun ios(driver: Driver, openDriver: Boolean = true): Maestro {\n if (openDriver) {\n driver.open()\n }\n return Maestro(driver)\n }\n\n fun android(driver: Driver, openDriver: Boolean = true): Maestro {\n if (openDriver) {\n driver.open()\n }\n return Maestro(driver)\n }\n\n fun web(\n isStudio: Boolean,\n isHeadless: Boolean,\n screenSize: String?,\n ): Maestro {\n // Check that JRE is at least 11\n val version = System.getProperty(\"java.version\")\n if (version.startsWith(\"1.\")) {\n val majorVersion = version.substring(2, 3).toInt()\n if (majorVersion < 11) {\n throw MaestroException.UnsupportedJavaVersion(\n \"Maestro Web requires Java 11 or later. Current version: $version\"\n )\n }\n }\n\n val driver = CdpWebDriver(\n isStudio = isStudio,\n isHeadless = isHeadless,\n screenSize = screenSize,\n )\n driver.open()\n return Maestro(driver)\n }\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/Media.kt", "content": "package maestro\n\nimport okio.Source\n\nclass NamedSource(val name: String, val source: Source, val extension: String, val path: String)\n\nenum class MediaExt(val extName: String) {\n PNG(\"png\"),\n JPEG(\"jpeg\"),\n JPG(\"jpg\"),\n GIF(\"gif\"),\n MP4(\"mp4\"),\n}" }, { "path": "maestro-client/src/main/java/maestro/OnDeviceElementQuery.kt", "content": "package maestro\n\nsealed class OnDeviceElementQuery {\n\n data class Css(\n val css: String,\n ) : OnDeviceElementQuery()\n\n}" }, { "path": "maestro-client/src/main/java/maestro/OnDeviceElementQueryResult.kt", "content": "package maestro\n\ndata class OnDeviceElementQueryResult(\n val elements: List,\n)\n" }, { "path": "maestro-client/src/main/java/maestro/Point.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro\n\nimport kotlin.math.pow\nimport kotlin.math.sqrt\n\nfun distance(\n fromX: T,\n fromY: T,\n toX: T,\n toY: T\n): Float {\n return sqrt(\n (fromX.toDouble() - toX.toDouble()).pow(2.0) + (fromY.toDouble() - toY.toDouble()).pow(2.0)\n ).toFloat()\n}\n\ndata class Point(\n val x: Int,\n val y: Int\n) {\n\n fun distance(other: Point): Float {\n return distance(x, y, other.x, other.y)\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/ScreenRecording.kt", "content": "package maestro\n\ninterface ScreenRecording : AutoCloseable" }, { "path": "maestro-client/src/main/java/maestro/ScrollDirection.kt", "content": "package maestro\n\nenum class ScrollDirection {\n UP,\n DOWN,\n RIGHT,\n LEFT\n}\n\nfun ScrollDirection.toSwipeDirection(): SwipeDirection = when (this) {\n ScrollDirection.DOWN -> SwipeDirection.UP\n ScrollDirection.UP -> SwipeDirection.DOWN\n ScrollDirection.LEFT -> SwipeDirection.RIGHT\n ScrollDirection.RIGHT -> SwipeDirection.LEFT\n}" }, { "path": "maestro-client/src/main/java/maestro/SwipeDirection.kt", "content": "package maestro\n\nenum class SwipeDirection {\n UP,\n DOWN,\n RIGHT,\n LEFT\n}\n\ninline fun > directionValueOfOrNull(input: String): SwipeDirection? {\n return enumValues().find { it.name == input || it.name.lowercase() == input }\n}" }, { "path": "maestro-client/src/main/java/maestro/TapRepeat.kt", "content": "package maestro\n\ndata class TapRepeat(\n val repeat: Int,\n val delay: Long // millis\n)" }, { "path": "maestro-client/src/main/java/maestro/TreeNode.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro\n\ndata class TreeNode(\n val attributes: MutableMap = mutableMapOf(),\n val children: List = emptyList(),\n val clickable: Boolean? = null,\n val enabled: Boolean? = null,\n val focused: Boolean? = null,\n val checked: Boolean? = null,\n val selected: Boolean? = null,\n) {\n\n fun aggregate(): List {\n return listOf(this) + children.flatMap { it.aggregate() }\n }\n\n}\n" }, { "path": "maestro-client/src/main/java/maestro/UiElement.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro\n\ndata class UiElement(\n val treeNode: TreeNode,\n val bounds: Bounds,\n) {\n\n fun distanceTo(other: UiElement): Float {\n return bounds.center().distance(other.bounds.center())\n }\n\n fun getVisiblePercentage(screenWidth: Int, screenHeight: Int): Double {\n if (bounds.width == 0 && bounds.height == 0) {\n return 0.0\n }\n\n val overflow = (bounds.x <= 0) && (bounds.y <= 0) && (bounds.x + bounds.width >= screenWidth) && (bounds.y + bounds.height >= screenHeight)\n if (overflow) {\n return 1.0\n }\n\n val visibleX = maxOf(0, minOf(bounds.x + bounds.width, screenWidth) - maxOf(bounds.x, 0))\n val visibleY = maxOf(0, minOf(bounds.y + bounds.height, screenHeight) - maxOf(bounds.y, 0))\n val visibleArea = visibleX * visibleY\n val totalArea = bounds.width * bounds.height\n\n return visibleArea.toDouble() / totalArea.toDouble()\n }\n\n fun isElementNearScreenCenter(direction: SwipeDirection, screenWidth: Int, screenHeight: Int): Boolean {\n val centerX = screenWidth / 2\n val centerY = screenHeight / 2\n\n val elementCenterX = bounds.x + (bounds.width / 2)\n val elementCenterY = bounds.y + (bounds.height / 2)\n\n val margin = when(direction) {\n SwipeDirection.DOWN, SwipeDirection.UP -> screenHeight / 5\n SwipeDirection.LEFT, SwipeDirection.RIGHT -> screenWidth / 5\n }\n\n // return true when the element center is within the half of the screen bounds plus margin\n return when(direction) {\n SwipeDirection.RIGHT -> elementCenterX > centerX - margin\n SwipeDirection.LEFT -> elementCenterX < centerX + margin\n SwipeDirection.UP -> elementCenterY < centerY + margin\n SwipeDirection.DOWN -> elementCenterY > centerY - margin\n }\n }\n\n fun isWithinViewPortBounds(info: DeviceInfo, paddingHorizontal: Float = 0f, paddingVertical: Float = 0f): Boolean {\n val paddingX = (info.widthGrid * paddingHorizontal).toInt()\n val paddingY = (info.heightGrid * paddingVertical).toInt()\n val xEnd = info.widthGrid - paddingX\n val yEnd = info.heightGrid - paddingY\n\n val isXWithinBounds = bounds.x in paddingX..xEnd\n val isYWithinBounds = bounds.y in paddingY..yEnd\n\n return isXWithinBounds && isYWithinBounds\n }\n\n companion object {\n\n fun TreeNode.toUiElement(): UiElement {\n return toUiElementOrNull()\n ?: throw IllegalStateException(\"Node has no bounds\")\n }\n\n fun TreeNode.toUiElementOrNull(): UiElement? {\n // TODO needs different impl for iOS\n val boundsStr = attributes[\"bounds\"]\n ?: return null\n\n val boundsArr = boundsStr\n .replace(\"][\", \",\")\n .removePrefix(\"[\")\n .removeSuffix(\"]\")\n .split(\",\")\n .map { it.toInt() }\n\n return UiElement(\n this,\n Bounds(\n x = boundsArr[0],\n y = boundsArr[1],\n width = boundsArr[2] - boundsArr[0],\n height = boundsArr[3] - boundsArr[1]\n ),\n )\n }\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/ViewHierarchy.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro\n\nimport maestro.UiElement.Companion.toUiElement\n\n@JvmInline\nvalue class ViewHierarchy(val root: TreeNode) {\n companion object {\n fun from(driver: Driver, excludeKeyboardElements: Boolean): ViewHierarchy {\n val deviceInfo = driver.deviceInfo()\n val root = driver.contentDescriptor(excludeKeyboardElements).let {\n val filtered = it.filterOutOfBounds(\n width = deviceInfo.widthGrid,\n height = deviceInfo.heightGrid\n )\n filtered ?: it\n }\n return ViewHierarchy(root)\n }\n }\n\n fun isVisible(node: TreeNode): Boolean {\n if (!node.attributes.containsKey(\"bounds\")) {\n return false\n }\n\n val center = node.toUiElement().bounds.center()\n\n val elementAtPosition = getElementAt(root, center.x, center.y)\n\n return node == elementAtPosition\n }\n\n fun refreshElement(node: TreeNode): TreeNode? {\n val matches = root.aggregate()\n .filter {\n (it.attributes - \"bounds\") == (node.attributes - \"bounds\")\n }\n\n if (matches.size != 1) {\n return null\n }\n\n return matches[0]\n }\n\n fun getElementAt(\n node: TreeNode,\n x: Int,\n y: Int\n ): TreeNode? {\n return node\n .children\n .asReversed()\n .asSequence()\n .mapNotNull {\n val elementWithinChild = if (it.children.isNotEmpty()) {\n getElementAt(it, x, y)\n } else {\n null\n }\n\n elementWithinChild\n ?: if (it.attributes.containsKey(\"bounds\")) {\n val bounds = it.toUiElement().bounds\n\n if (bounds.contains(x, y)) {\n it\n } else {\n null\n }\n } else {\n null\n }\n }\n .firstOrNull()\n }\n\n fun aggregate(): List {\n return root.aggregate()\n }\n}\n\nfun TreeNode.filterOutOfBounds(width: Int, height: Int): TreeNode? {\n if (attributes.containsKey(\"ignoreBoundsFiltering\") && attributes[\"ignoreBoundsFiltering\"] == \"true\") {\n return this\n }\n\n val filtered = children.mapNotNull {\n it.filterOutOfBounds(width, height)\n }.toList()\n\n // parent can have missing bounds\n val element = kotlin.runCatching { toUiElement() }.getOrNull()\n val visiblePercentage = element?.getVisiblePercentage(width, height) ?: 0.0\n\n if (visiblePercentage < 0.1 && filtered.isEmpty()) {\n return null\n }\n\n return TreeNode(\n attributes = attributes,\n children = filtered,\n clickable = clickable,\n enabled = enabled,\n focused = focused,\n checked = checked,\n selected = selected\n )\n}\n\n\n" }, { "path": "maestro-client/src/main/java/maestro/android/AndroidAppFiles.kt", "content": "package maestro.android\n\nimport dadb.Dadb\nimport java.io.File\nimport java.io.IOException\nimport java.net.URI\nimport java.nio.file.FileSystems\nimport java.nio.file.Files\nimport java.nio.file.Path\nimport kotlin.io.path.createDirectories\n\nobject AndroidAppFiles {\n\n fun pull(dadb: Dadb, packageName: String, zipOutFile: File) {\n zipOutFile.delete()\n val zipOutUri = URI(\"jar:${zipOutFile.toURI().scheme}\", zipOutFile.absolutePath, null)\n FileSystems.newFileSystem(zipOutUri, mapOf(\"create\" to \"true\")).use { fs ->\n // Create zip directories first\n listRemoteFiles(dadb, packageName, \"-type d\").forEach { remoteDir ->\n val dstLocation = remoteDir\n .removePrefix(\"/\")\n .removeSuffix(\"/.\")\n .removeSuffix(\"/\")\n val dstPath = fs.getPath(dstLocation)\n dstPath.createDirectories()\n }\n\n // Create zip files\n listRemoteFiles(dadb, packageName, \"-type f\").forEach { remoteFile ->\n val dstLocation = remoteFile\n .removePrefix(\"/\")\n .removeSuffix(\"/.\")\n .removeSuffix(\"/\")\n val dstPath = fs.getPath(dstLocation)\n pullAppFile(dadb, packageName, dstPath, remoteFile)\n }\n }\n }\n\n fun getApkFile(dadb: Dadb, appId: String): File {\n val apkPath = dadb.shell(\"pm list packages -f --user 0 | grep $appId | head -1\")\n .output.substringAfterLast(\"package:\").substringBefore(\"=$appId\")\n apkPath.substringBefore(\"=$appId\")\n val dst = File.createTempFile(\"tmp\", \".apk\")\n dadb.pull(dst, apkPath)\n return dst\n }\n\n fun push(dadb: Dadb, packageName: String, appFilesZip: File) {\n val remoteZip = \"/data/local/tmp/app.zip\"\n dadb.push(appFilesZip, remoteZip)\n try {\n shell(dadb, \"run-as $packageName unzip -o -d / $remoteZip\")\n } finally {\n shell(dadb, \"rm $remoteZip\")\n }\n }\n\n private fun pullAppFile(dadb: Dadb, packageName: String, localPath: Path, remotePath: String) {\n dadb.open(\"exec:run-as $packageName cat $remotePath\").use { stream ->\n Files.copy(stream.source.inputStream(), localPath)\n }\n }\n\n private fun listRemoteFiles(dadb: Dadb, packageName: String, options: String): List {\n val result = shell(dadb, \"run-as $packageName find $options\")\n val appDataDir = \"/data/data/$packageName\"\n return result.lines()\n .filter { it.isNotBlank() }\n .map { \"$appDataDir/${it.removePrefix(\"./\")}\" }\n }\n\n private fun shell(dadb: Dadb, command: String): String {\n val response = dadb.shell(command)\n if (response.exitCode != 0) throw IOException(\"Shell command failed ($command):\\n${response.allOutput}\")\n return response.allOutput\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/android/AndroidBuildToolsDirectory.kt", "content": "package maestro.android\n\nimport java.io.File\nimport java.util.regex.Pattern\n\ninternal object AndroidBuildToolsDirectory {\n\n fun findBuildToolsDir(androidHome: File): File {\n val buildToolsParent = File(androidHome, \"build-tools\")\n if (!buildToolsParent.exists()) {\n throw IllegalStateException(\"build-tools directory does not exist: $buildToolsParent\")\n }\n\n val latestBuildToolsVersion = getLatestToolsVersion(buildToolsParent)\n ?: throw IllegalStateException(\"Could not find a valid build-tools subdirectory in $buildToolsParent\")\n\n return File(buildToolsParent, latestBuildToolsVersion.toString())\n }\n\n private fun getLatestToolsVersion(buildToolsParent: File): BuildToolsVersion? {\n return buildToolsParent.listFiles()!!\n .mapNotNull { BuildToolsVersion.parse(it.name) }\n .maxOfOrNull { it }\n }\n\n private class BuildToolsVersion(\n val major: Int,\n val minor: Int,\n val patch: Int,\n ) : Comparable {\n override fun toString(): String {\n return \"$major.$minor.$patch\"\n }\n\n override fun compareTo(other: BuildToolsVersion): Int {\n return VERSION_COMPARATOR.compare(this, other)\n }\n\n companion object {\n\n private val VERSION_PATTERN = Pattern.compile(\"([0-9]+)\\\\.([0-9]+)\\\\.([0-9]+)\")\n\n private val VERSION_COMPARATOR = compareBy(\n { v -> v.major },\n { v -> v.minor },\n { v -> v.patch },\n )\n\n fun parse(name: String): BuildToolsVersion? {\n val m = VERSION_PATTERN.matcher(name)\n if (!m.matches()) return null\n return BuildToolsVersion(\n major = m.group(1).toInt(),\n minor = m.group(2).toInt(),\n patch = m.group(3).toInt(),\n )\n }\n }\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/android/AndroidLaunchArguments.kt", "content": "package maestro.android\n\nimport maestro_android.MaestroAndroid\n\nobject AndroidLaunchArguments {\n\n fun Map.toAndroidLaunchArguments(): List {\n return toList().map {\n when (val value = it.second) {\n is Boolean -> MaestroAndroid.ArgumentValue.newBuilder()\n .setKey(it.first)\n .setValue(value.toString())\n .setType(Boolean::class.java.name)\n .build()\n is Int -> MaestroAndroid.ArgumentValue.newBuilder()\n .setKey(it.first)\n .setValue(value.toString())\n .setType(Int::class.java.name)\n .build()\n is Double -> MaestroAndroid.ArgumentValue.newBuilder()\n .setKey(it.first)\n .setValue(value.toString())\n .setType(Double::class.java.name)\n .build()\n is Long -> MaestroAndroid.ArgumentValue.newBuilder()\n .setKey(it.first)\n .setValue(value.toString())\n .setType(Long::class.java.name)\n .build()\n is String -> MaestroAndroid.ArgumentValue.newBuilder()\n .setKey(it.first)\n .setValue(value.toString())\n .setType(String::class.java.name)\n .build()\n else -> MaestroAndroid.ArgumentValue.newBuilder()\n .setKey(it.first)\n .setValue(value.toString())\n .setType(String::class.java.name)\n .build()\n }\n }\n }\n}" }, { "path": "maestro-client/src/main/java/maestro/android/chromedevtools/AndroidWebViewHierarchyClient.kt", "content": "package maestro.android.chromedevtools\n\nimport dadb.Dadb\nimport maestro.Bounds\nimport maestro.TreeNode\nimport maestro.UiElement\nimport maestro.UiElement.Companion.toUiElementOrNull\nimport java.io.Closeable\n\nclass AndroidWebViewHierarchyClient(dadb: Dadb): Closeable {\n\n private val devToolsClient = DadbChromeDevToolsClient(dadb)\n\n fun augmentHierarchy(baseHierarchy: TreeNode, chromeDevToolsEnabled: Boolean): TreeNode {\n if (!chromeDevToolsEnabled) return baseHierarchy\n if (!hasWebView(baseHierarchy)) return baseHierarchy\n // TODO: Adapt to handle chrome in the same way\n val webViewHierarchy = devToolsClient.getWebViewTreeNodes()\n val merged = mergeHierarchies(baseHierarchy, webViewHierarchy)\n return merged\n }\n\n override fun close() {\n devToolsClient.close()\n }\n\n companion object {\n\n fun mergeHierarchies(baseHierarchy: TreeNode, webViewHierarchy: List): TreeNode {\n if (webViewHierarchy.isEmpty()) return baseHierarchy\n val newNodes = mutableListOf()\n val baseNodes = baseHierarchy.aggregate().mapNotNull { it.toUiElementOrNull() }\n // We can use a quadtree here if this is too slow\n val webViewNodes = webViewHierarchy.flatMap { it.aggregate() }.filter {\n it.attributes[\"text\"]?.isNotBlank() == true\n || it.attributes[\"resource-id\"]?.isNotBlank() == true\n || it.attributes[\"hintText\"]?.isNotBlank() == true\n || it.attributes[\"accessibilityText\"]?.isNotBlank() == true\n }.mapNotNull { it.toUiElementOrNull() }.filter {\n it.bounds.width > 0 && it.bounds.height > 0\n }\n webViewNodes.forEach { webViewNode ->\n if (!baseNodes.any { webViewNode.mergeWith(it) }) {\n newNodes.add(webViewNode.treeNode)\n }\n }\n if (newNodes.isEmpty()) return baseHierarchy\n return TreeNode(children = listOf(baseHierarchy) + newNodes)\n }\n\n private fun UiElement.mergeWith(base: UiElement): Boolean {\n if (!this.bounds.intersects(base.bounds)) return false\n val thisTexts = this.treeNode.texts()\n val baseTexts = base.treeNode.texts()\n val thisId = this.treeNode.attributes[\"resource-id\"]\n val baseId = base.treeNode.attributes[\"resource-id\"]\n\n // web view text is a substring of base text\n val mergeableText = thisTexts.any { baseTexts.any { baseText -> baseText.contains(it) } }\n\n // web view id matches base id\n val mergeableId = thisId?.isNotEmpty() == true && baseId?.isNotEmpty() == true && thisId == baseId\n\n // web view id matches base text\n val mergeableId2 = baseTexts.any { it == thisId }\n\n if (!mergeableText && !mergeableId && !mergeableId2) return false\n\n val newAttributes = this.treeNode.attributes\n\n newAttributes.remove(\"bounds\")\n if (baseTexts.isNotEmpty()) {\n newAttributes.remove(\"text\")\n newAttributes.remove(\"hintText\")\n newAttributes.remove(\"accessibilityText\")\n }\n if (baseId?.isNotEmpty() == true) newAttributes.remove(\"resource-id\")\n\n newAttributes.entries.removeIf { it.value.isEmpty() }\n\n base.treeNode.attributes += newAttributes\n\n return true\n }\n\n private fun TreeNode.texts(): List {\n return listOfNotNull(attributes[\"text\"], attributes[\"hintText\"], attributes[\"accessibilityText\"]).filter { it.isNotEmpty() }\n }\n\n private fun Bounds.intersects(other: Bounds): Boolean {\n return this.x < other.x + other.width && this.x + this.width > other.x && this.y < other.y + other.height && this.y + this.height > other.y\n }\n\n private fun hasWebView(node: TreeNode): Boolean {\n if (isWebView(node)) return true\n for (child in node.children) {\n if (hasWebView(child)) return true\n }\n return false\n }\n\n private fun isWebView(node: TreeNode): Boolean {\n return node.attributes[\"class\"] == \"android.webkit.WebView\"\n }\n }\n}" }, { "path": "maestro-client/src/main/java/maestro/android/chromedevtools/DadbChromeDevToolsClient.kt", "content": "package maestro.android.chromedevtools\n\nimport com.fasterxml.jackson.core.JsonProcessingException\nimport com.fasterxml.jackson.core.type.TypeReference\nimport com.fasterxml.jackson.databind.DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES\nimport com.fasterxml.jackson.databind.type.TypeFactory\nimport com.fasterxml.jackson.module.kotlin.jacksonObjectMapper\nimport com.fasterxml.jackson.module.kotlin.readValue\nimport dadb.Dadb\nimport maestro.Maestro\nimport maestro.TreeNode\nimport maestro.utils.HttpClient\nimport okhttp3.HttpUrl\nimport okhttp3.HttpUrl.Companion.toHttpUrl\nimport okhttp3.OkHttpClient\nimport okhttp3.Request\nimport okhttp3.Response\nimport okhttp3.WebSocket\nimport okhttp3.WebSocketListener\nimport okio.use\nimport org.slf4j.LoggerFactory\nimport java.io.Closeable\nimport java.io.IOException\nimport java.util.concurrent.CompletableFuture\nimport java.util.concurrent.ExecutionException\nimport java.util.concurrent.TimeUnit\nimport java.util.concurrent.TimeoutException\nimport kotlin.system.measureTimeMillis\n\nprivate data class RuntimeResponse(\n val result: RemoteObject\n)\n\nprivate data class RemoteObject(\n val type: String,\n val value: T,\n)\n\ndata class WebViewInfo(\n val socketName: String,\n val webSocketDebuggerUrl: String,\n val visible: Boolean,\n val attached: Boolean,\n val empty: Boolean,\n val screenX: Int,\n val screenY: Int,\n val width: Int,\n val height: Int,\n)\n\nprivate data class WebViewResponse(\n val description: String,\n val webSocketDebuggerUrl: String,\n)\n\nprivate data class WebViewDescription(\n val visible: Boolean,\n val attached: Boolean,\n val empty: Boolean,\n val screenX: Int,\n val screenY: Int,\n val width: Int,\n val height: Int,\n)\n\nprivate data class DevToolsResponse(\n val id: Int,\n val result: T,\n)\n\nclass DadbChromeDevToolsClient(private val dadb: Dadb): Closeable {\n\n private val json = jacksonObjectMapper().configure(FAIL_ON_UNKNOWN_PROPERTIES, false)\n\n private val okhttp = HttpClient.build(\"DadbChromeDevToolsClient\").newBuilder()\n .dadb(dadb)\n .build()\n\n private val script = Maestro::class.java.getResourceAsStream(\"/maestro-web.js\")?.let {\n it.bufferedReader().use { br ->\n br.readText()\n }\n } ?: error(\"Could not read maestro web script\")\n\n override fun close() {\n okhttp.dispatcher.executorService.shutdown()\n okhttp.connectionPool.evictAll()\n okhttp.cache?.close()\n }\n\n fun getWebViewTreeNodes(): List {\n return getWebViewInfos()\n .filter { it.visible }\n .mapNotNull { info ->\n try {\n evaluateScript>(info.socketName, info.webSocketDebuggerUrl, \"$script; maestro.viewportX = ${info.screenX}; maestro.viewportY = ${info.screenY}; maestro.viewportWidth = ${info.width}; maestro.viewportHeight = ${info.height}; window.maestro.getContentDescription();\").result.value\n } catch (e: IOException) {\n logger.warn(\"Failed to retrieve WebView hierarchy from chrome devtools: ${info.socketName} ${info.webSocketDebuggerUrl}\", e)\n null\n }\n }\n }\n\n inline fun evaluateScript(socketName: String, webSocketDebuggerUrl: String, script: String) = makeRequest(\n socketName = socketName,\n webSocketDebuggerUrl = webSocketDebuggerUrl,\n method = \"Runtime.evaluate\",\n params = mapOf(\n \"expression\" to script,\n \"returnByValue\" to true,\n ),\n )\n\n inline fun makeRequest(socketName: String, webSocketDebuggerUrl: String, method: String, params: Any?): T {\n val resultTypeReference = object : TypeReference() {}\n return makeRequest(resultTypeReference, socketName, webSocketDebuggerUrl, method, params)\n }\n\n fun makeRequest(resultTypeReference: TypeReference, socketName: String, webSocketDebuggerUrl: String, method: String, params: Any?): T {\n val request = json.writeValueAsString(mapOf(\"id\" to 1, \"method\" to method, \"params\" to params))\n val url = webSocketDebuggerUrl.replace(\"ws\", \"http\").toHttpUrl().newBuilder()\n .host(\"localabstract.$socketName.adb\")\n .build()\n val response = makeSingleWebsocketRequest(url, request)\n return try {\n val resultType = TypeFactory.defaultInstance().constructType(resultTypeReference)\n val responseType = TypeFactory.defaultInstance()\n .constructParametricType(DevToolsResponse::class.java, resultType)\n json.readValue>(response, responseType).result\n } catch (e: JsonProcessingException) {\n throw IOException(\"Failed to parse DOM snapshot: $response\", e)\n }\n }\n\n fun getWebViewInfos(): List {\n return getWebViewSocketNames().flatMap(::getWebViewInfos)\n }\n\n fun makeSingleWebsocketRequest(url: HttpUrl, message: String): String {\n val future = CompletableFuture()\n val ws = okhttp.newWebSocket(\n Request.Builder()\n .url(url)\n .build(),\n object : WebSocketListener() {\n override fun onMessage(webSocket: WebSocket, text: String) {\n future.complete(text)\n }\n\n override fun onFailure(webSocket: WebSocket, t: Throwable, response: Response?) {\n future.completeExceptionally(t)\n }\n }\n )\n ws.send(message)\n val response = try {\n future.get(5, TimeUnit.SECONDS)\n } catch (_: TimeoutException) {\n throw TimeoutException(\"Timed out waiting for websocket response\")\n } catch (e: ExecutionException) {\n throw e.cause ?: e\n }\n ws.close(1000, null)\n return response\n }\n\n private fun getWebViewInfos(socketName: String): List {\n val url = \"http://localabstract.$socketName.adb/json\"\n\n val call = okhttp.newCall(Request.Builder()\n .url(url)\n .header(\"Host\", \"localhost:9222\") // Expected by devtools server\n .build())\n\n val response = try {\n call.execute()\n } catch (e: IOException) {\n logger.error(\"IOException while getting WebView info from $url. Defaulting to empty list.\", e)\n return emptyList()\n }\n\n if (response.code != 200) {\n logger.error(\"Request to get WebView infos failed with code ${response.code}. Defaulting to empty list.\")\n return emptyList()\n }\n\n val body = response.body?.string() ?: throw IllegalStateException(\"No body found\")\n\n return try {\n json.readValue>(body).mapNotNull { parsed ->\n // Description is empty for eg. service workers\n if (parsed.description.isBlank()) return@mapNotNull null\n val description = json.readValue(parsed.description, WebViewDescription::class.java)\n WebViewInfo(\n socketName = socketName,\n webSocketDebuggerUrl = parsed.webSocketDebuggerUrl,\n visible = description.visible,\n attached = description.attached,\n empty = description.empty,\n screenX = description.screenX,\n screenY = description.screenY,\n width = description.width,\n height = description.height,\n )\n }.filter { it.attached && it.visible && !it.empty }\n } catch (e: JsonProcessingException) {\n throw IllegalStateException(\"Failed to parse WebView chrome dev tools response:\\n$body\", e)\n }\n }\n\n private fun getWebViewSocketNames(): Set {\n val response = dadb.shell(\"cat /proc/net/unix\")\n if (response.exitCode != 0) {\n throw IllegalStateException(\"Failed get WebView socket names. Command 'cat /proc/net/unix' failed: ${response.allOutput}\")\n }\n return response.allOutput.trim().lines().mapNotNull { line ->\n line.split(Regex(\"\\\\s+\")).lastOrNull()?.takeIf { it.startsWith(WEB_VIEW_SOCKET_PREFIX) }?.substring(1)\n }.toSet()\n }\n\n companion object {\n private const val WEB_VIEW_SOCKET_PREFIX = \"@webview_devtools_remote_\"\n\n private val logger = LoggerFactory.getLogger(Maestro::class.java)\n }\n}\n\nfun main() {\n (Dadb.discover() ?: throw IllegalStateException(\"No devices found\")).use { dadb ->\n DadbChromeDevToolsClient(dadb).apply {\n while (true) {\n measureTimeMillis {\n println(getWebViewTreeNodes().size)\n }.also { println(\"time: $it\") }\n }\n }\n }\n}" }, { "path": "maestro-client/src/main/java/maestro/android/chromedevtools/DadbSocket.kt", "content": "package maestro.android.chromedevtools\n\nimport dadb.AdbStream\nimport dadb.Dadb\nimport okhttp3.Dns\nimport okhttp3.OkHttpClient\nimport java.io.FilterOutputStream\nimport java.io.InputStream\nimport java.io.OutputStream\nimport java.net.InetAddress\nimport java.net.InetSocketAddress\nimport java.net.Socket\nimport java.net.SocketAddress\nimport java.net.SocketException\nimport java.nio.channels.SocketChannel\nimport javax.net.SocketFactory\n\nfun OkHttpClient.Builder.dadb(dadb: Dadb): OkHttpClient.Builder {\n dns(DadbDns())\n socketFactory(DadbSocketFactory(dadb))\n return this\n}\n\nclass DadbDns : Dns {\n\n override fun lookup(hostname: String): List {\n if (!hostname.endsWith(\".adb\")) throw IllegalArgumentException(\"Invalid hostname. Eg. tcp.8000.adb, localabstract.chrome_devtools_remote.adb\")\n return listOf(InetAddress.getByAddress(hostname, byteArrayOf(0, 0, 0, 0)))\n }\n}\n\nclass DadbSocketFactory(private val dadb: Dadb) : SocketFactory() {\n\n override fun createSocket(): Socket {\n return DadbStreamSocket(dadb)\n }\n\n override fun createSocket(host: String?, port: Int): Socket {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun createSocket(\n host: String?,\n port: Int,\n localHost: InetAddress?,\n localPort: Int\n ): Socket {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun createSocket(host: InetAddress?, port: Int): Socket {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun createSocket(\n address: InetAddress?,\n port: Int,\n localAddress: InetAddress?,\n localPort: Int\n ): Socket {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n}\n\nclass DadbStreamSocket(private val dadb: Dadb) : Socket() {\n\n private var closed = false\n private var adbStream: AdbStream? = null\n\n override fun getInputStream(): InputStream {\n val adbStream = this.adbStream ?: throw SocketException(\"Socket is not connected\")\n return adbStream.source.inputStream()\n }\n\n override fun getOutputStream(): OutputStream {\n val adbStream = this.adbStream ?: throw SocketException(\"Socket is not connected\")\n return object : FilterOutputStream(adbStream.sink.outputStream()) {\n\n override fun write(b: ByteArray) {\n super.write(b)\n flush()\n }\n\n override fun write(b: ByteArray, off: Int, len: Int) {\n super.write(b, off, len)\n flush()\n }\n }\n }\n\n override fun connect(endpoint: SocketAddress, timeout: Int) {\n if (endpoint !is InetSocketAddress) throw UnsupportedOperationException(\"Endpoint must be a InetSocketAddress: $endpoint (${endpoint::class})\")\n val destination = endpoint.hostName.removeSuffix(\".adb\").replace(\".\", \":\")\n this.adbStream = dadb.open(destination)\n }\n\n override fun isClosed() = closed\n\n override fun close() {\n if (isClosed()) return\n adbStream?.close()\n adbStream = null\n closed = true\n }\n\n override fun setSoTimeout(timeout: Int) = Unit\n\n override fun isInputShutdown() = false\n\n override fun isOutputShutdown() = false\n\n\n override fun connect(endpoint: SocketAddress?) {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun bind(bindpoint: SocketAddress?) {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getInetAddress(): InetAddress {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getLocalAddress(): InetAddress {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getPort(): Int {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getLocalPort(): Int {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getRemoteSocketAddress(): SocketAddress {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getLocalSocketAddress(): SocketAddress {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getChannel(): SocketChannel {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun setTcpNoDelay(on: Boolean) {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getTcpNoDelay(): Boolean {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun setSoLinger(on: Boolean, linger: Int) {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getSoLinger(): Int {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun sendUrgentData(data: Int) {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun setOOBInline(on: Boolean) {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getOOBInline(): Boolean {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getSoTimeout(): Int {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun setSendBufferSize(size: Int) {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getSendBufferSize(): Int {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun setReceiveBufferSize(size: Int) {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getReceiveBufferSize(): Int {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun setKeepAlive(on: Boolean) {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getKeepAlive(): Boolean {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun setTrafficClass(tc: Int) {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getTrafficClass(): Int {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun setReuseAddress(on: Boolean) {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun getReuseAddress(): Boolean {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun shutdownInput() {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun shutdownOutput() {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun isConnected(): Boolean {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun isBound(): Boolean {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n\n override fun setPerformancePreferences(connectionTime: Int, latency: Int, bandwidth: Int) {\n throw UnsupportedOperationException(\"Not implemented\")\n }\n}" }, { "path": "maestro-client/src/main/java/maestro/auth/ApiKey.kt", "content": "package maestro.auth\n\nimport java.nio.file.Paths\nimport kotlin.io.path.deleteIfExists\nimport kotlin.io.path.exists\nimport kotlin.io.path.isDirectory\nimport kotlin.io.path.readText\n\nclass ApiKey {\n companion object {\n private val cachedAuthTokenFile by lazy {\n Paths.get(\n System.getProperty(\"user.home\"),\n \".mobiledev\",\n \"authtoken\"\n )\n }\n\n private fun maestroCloudApiKey(): String? {\n return System.getenv(\"MAESTRO_CLOUD_API_KEY\")\n }\n\n private fun getCachedAuthToken(): String? {\n if (!cachedAuthTokenFile.exists()) return null\n if (cachedAuthTokenFile.isDirectory()) return null\n val cachedAuthToken = cachedAuthTokenFile.readText()\n return cachedAuthToken\n }\n\n fun getToken(): String? {\n return maestroCloudApiKey() ?: // Resolve API key from shell if set\n getCachedAuthToken() // Otherwise, if the user has already logged in, use the cached auth token\n }\n\n fun setToken(token: String?) {\n cachedAuthTokenFile.parent.toFile().mkdirs()\n if (token == null) {\n cachedAuthTokenFile.deleteIfExists()\n return\n }\n cachedAuthTokenFile.toFile().writeText(token)\n }\n }\n}" }, { "path": "maestro-client/src/main/java/maestro/debuglog/DebugLogStore.kt", "content": "package maestro.debuglog\n\nimport maestro.Driver\nimport maestro.utils.FileUtils\nimport net.harawata.appdirs.AppDirsFactory\nimport java.io.File\nimport java.time.LocalDateTime\nimport java.time.format.DateTimeFormatter\nimport java.util.Date\nimport java.util.Properties\nimport java.util.logging.ConsoleHandler\nimport java.util.logging.FileHandler\nimport java.util.logging.Level\nimport java.util.logging.LogRecord\nimport java.util.logging.Logger\nimport java.util.logging.SimpleFormatter\n\nobject DebugLogStore {\n\n private const val APP_NAME = \"maestro\"\n private const val APP_AUTHOR = \"mobile_dev\"\n private const val LOG_DIR_DATE_FORMAT = \"yyyy-MM-dd_HHmmss\"\n private const val KEEP_LOG_COUNT = 6\n val logDirectory = File(AppDirsFactory.getInstance().getUserLogDir(APP_NAME, null, APP_AUTHOR))\n\n private val currentRunLogDirectory: File\n private val consoleHandler: ConsoleHandler\n private val fileHandler: FileHandler\n\n init {\n val dateFormatter = DateTimeFormatter.ofPattern(LOG_DIR_DATE_FORMAT)\n val date = dateFormatter.format(LocalDateTime.now())\n\n currentRunLogDirectory = File(logDirectory, date)\n currentRunLogDirectory.mkdirs()\n removeOldLogs(logDirectory)\n\n consoleHandler = ConsoleHandler()\n consoleHandler.level = Level.WARNING\n consoleHandler.formatter = object : SimpleFormatter() {\n override fun format(record: LogRecord): String {\n val level = if (record.level.intValue() > 900) \"Error: \" else \"\"\n return \"$level${record.message}\\n\"\n }\n }\n\n val maestroLogFile = logFile(\"maestro\")\n fileHandler = FileHandler(maestroLogFile.absolutePath)\n fileHandler.level = Level.ALL\n fileHandler.formatter = object : SimpleFormatter() {\n private val format = \"[%1\\$tF %1\\$tT] [%2$-7s] %3\\$s %n\"\n\n @Suppress(\"DefaultLocale\")\n @Synchronized\n override fun format(lr: LogRecord): String {\n return java.lang.String.format(\n format,\n Date(lr.millis),\n lr.level.localizedName,\n lr.message\n )\n }\n }\n }\n\n fun copyTo(file: File) {\n val local = logFile(\"maestro\")\n local.copyTo(file)\n }\n\n fun loggerFor(clazz: Class<*>): Logger {\n val logger = Logger.getLogger(clazz.name)\n logger.useParentHandlers = false\n logger.addHandler(consoleHandler)\n logger.addHandler(fileHandler)\n return logger\n }\n\n fun logOutputOf(processBuilder: ProcessBuilder) {\n val command = processBuilder.command().first() ?: \"unknown\"\n val logFile = logFile(command)\n val redirect = ProcessBuilder.Redirect.to(logFile)\n processBuilder\n .redirectOutput(redirect)\n .redirectError(redirect)\n }\n\n fun finalizeRun() {\n fileHandler.close()\n val output = File(currentRunLogDirectory.parent, \"${currentRunLogDirectory.name}.zip\")\n FileUtils.zipDir(currentRunLogDirectory.toPath(), output.toPath())\n currentRunLogDirectory.deleteRecursively()\n }\n\n private fun logFile(named: String): File {\n return File(currentRunLogDirectory, \"$named.log\")\n }\n\n private fun removeOldLogs(baseDir: File) {\n if (!baseDir.isDirectory) {\n return\n }\n\n val existing = baseDir.listFiles() ?: return\n val toDelete = existing.sortedByDescending { it.name }\n .drop(KEEP_LOG_COUNT)\n .toList()\n\n toDelete.forEach { it.deleteRecursively() }\n }\n\n fun logSystemInfo() {\n val logData = \"\"\"\n Maestro version: ${appVersion()}\n OS: ${System.getProperty(\"os.name\")}\n OS version: ${System.getProperty(\"os.version\")}\n Architecture: ${System.getProperty(\"os.arch\")}\n \"\"\".trimIndent() + \"\\n\"\n\n logFile(\"system_info\").writeText(logData)\n }\n\n private fun appVersion(): String {\n try {\n val props = Driver::class.java.classLoader.getResourceAsStream(\"version.properties\").use {\n Properties().apply { load(it) }\n }\n return props[\"version\"].toString()\n } catch (ignore: Exception) {\n // no-action\n }\n return \"Undefined\"\n }\n}\n\nfun Logger.warn(message: String, throwable: Throwable? = null) {\n if (throwable != null) {\n log(Level.WARNING, message, throwable)\n } else log(Level.WARNING, message)\n}\n\nfun Logger.error(message: String, throwable: Throwable? = null) {\n if (throwable != null) {\n log(Level.SEVERE, message, throwable)\n } else log(Level.SEVERE, message)\n}\n" }, { "path": "maestro-client/src/main/java/maestro/debuglog/LogConfig.kt", "content": "package maestro.debuglog\n\nimport org.apache.logging.log4j.core.appender.FileAppender\nimport org.apache.logging.log4j.core.config.Configurator\nimport org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder\nimport org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilderFactory\nimport org.apache.logging.log4j.core.config.builder.impl.BuiltConfiguration\n\nobject LogConfig {\n\n private const val DEFAULT_FILE_LOG_PATTERN = \"%d{HH:mm:ss.SSS} [%5level] %logger.%method: %msg%n\"\n private const val DEFAULT_CONSOLE_LOG_PATTERN = \"%highlight([%5level]) %msg%n\"\n\n private val FILE_LOG_PATTERN: String = System.getenv(\"MAESTRO_CLI_LOG_PATTERN_FILE\") ?: DEFAULT_FILE_LOG_PATTERN\n private val CONSOLE_LOG_PATTERN: String = System.getenv(\"MAESTRO_CLI_LOG_PATTERN_CONSOLE\") ?: DEFAULT_CONSOLE_LOG_PATTERN\n\n fun configure(logFileName: String? = null, printToConsole: Boolean) {\n val builder = ConfigurationBuilderFactory.newConfigurationBuilder()\n builder.setStatusLevel(org.apache.logging.log4j.Level.ERROR)\n builder.setConfigurationName(\"MaestroConfig\")\n\n // Disable ktor logging completely\n builder.add(\n builder.newLogger(\"io.ktor\", org.apache.logging.log4j.Level.OFF)\n .addAttribute(\"additivity\", false)\n )\n\n val rootLogger = builder.newRootLogger(org.apache.logging.log4j.Level.ALL)\n\n if (logFileName != null) {\n val fileAppender = createFileAppender(builder, logFileName)\n rootLogger.add(builder.newAppenderRef(fileAppender.getName()))\n }\n\n if (printToConsole) {\n val consoleAppender = createConsoleAppender(builder)\n rootLogger.add(builder.newAppenderRef(consoleAppender.getName()))\n }\n\n\n builder.add(rootLogger)\n\n val config = builder.build()\n\n Configurator.reconfigure(config)\n }\n\n private fun createConsoleAppender(builder: ConfigurationBuilder): org.apache.logging.log4j.core.config.builder.api.AppenderComponentBuilder {\n val consoleAppender = builder.newAppender(\"Console\", \"CONSOLE\")\n\n val consoleLayout = builder.newLayout(\"PatternLayout\")\n consoleLayout.addAttribute(\"pattern\", CONSOLE_LOG_PATTERN)\n consoleAppender.add(consoleLayout)\n\n builder.add(consoleAppender)\n\n return consoleAppender\n }\n\n private fun createFileAppender(builder: ConfigurationBuilder, logFileName: String): org.apache.logging.log4j.core.config.builder.api.AppenderComponentBuilder {\n val fileAppender = builder.newAppender(\"File\", FileAppender.PLUGIN_NAME)\n fileAppender.addAttribute(\"fileName\", logFileName)\n\n val fileLayout = builder.newLayout(\"PatternLayout\")\n fileLayout.addAttribute(\"pattern\", FILE_LOG_PATTERN)\n\n fileAppender.add(fileLayout)\n builder.add(fileAppender)\n\n return fileAppender\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/Device.kt", "content": "package maestro.device\n\nsealed class Device(\n open val description: String,\n open val platform: Platform,\n open val deviceType: DeviceType,\n open val deviceSpec: DeviceSpec\n) {\n\n enum class DeviceType {\n REAL,\n SIMULATOR,\n EMULATOR,\n BROWSER\n }\n\n data class Connected(\n val instanceId: String,\n override val deviceSpec: DeviceSpec,\n override val description: String,\n override val platform: Platform,\n override val deviceType: DeviceType,\n ) : Device(description, platform, deviceType, deviceSpec)\n\n data class AvailableForLaunch(\n val modelId: String,\n override val deviceSpec: DeviceSpec,\n override val description: String,\n override val platform: Platform,\n override val deviceType: DeviceType,\n ) : Device(description, platform, deviceType, deviceSpec)\n\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/DeviceError.kt", "content": "package maestro.device\n\n/**\n * Exception class specifically for device-related errors in the client module.\n * Functionally equivalent to CliError in maestro-cli.\n */\nclass DeviceError(override val message: String, override val cause: Throwable? = null) : RuntimeException(message, cause)\n" }, { "path": "maestro-client/src/main/java/maestro/device/DeviceOrientation.kt", "content": "package maestro.device\n\nenum class DeviceOrientation {\n PORTRAIT,\n LANDSCAPE_LEFT,\n LANDSCAPE_RIGHT,\n UPSIDE_DOWN;\n\n // Return the camelCase representation of the enum name, for example \"landscapeLeft\"\n val camelCaseName: String\n get() = name.split(\"_\")\n .mapIndexed { index, part ->\n if (index == 0) part.lowercase()\n else part.lowercase().capitalize()\n }\n .joinToString(\"\")\n\n companion object {\n // Support lookup of enum value by name, ignoring underscores and case. This allow inputs like\n // \"LANDSCAPE_LEFT\" or \"landscapeLeft\" to both be matched to the LANDSCAPE_LEFT enum value.\n fun getByName(name: String): DeviceOrientation? {\n return values().find {\n comparableName(it.name) == comparableName(name)\n }\n }\n\n private fun comparableName(name: String): String {\n return name.lowercase().replace(\"_\", \"\")\n }\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/DeviceService.kt", "content": "package maestro.device\n\nimport dadb.Dadb\nimport dadb.adbserver.AdbServer\nimport maestro.device.util.AndroidEnvUtils\nimport maestro.device.util.AvdDevice\nimport maestro.device.util.PrintUtils\nimport maestro.drivers.AndroidDriver\nimport maestro.drivers.CdpWebDriver\nimport maestro.utils.MaestroTimer\nimport maestro.utils.TempFileHandler\nimport okio.buffer\nimport okio.source\nimport org.slf4j.LoggerFactory\nimport util.DeviceCtlResponse\nimport util.LocalIOSDevice\nimport util.LocalSimulatorUtils\nimport util.SimctlList\nimport java.io.File\nimport java.util.UUID\nimport java.util.concurrent.TimeUnit\nimport java.util.concurrent.TimeoutException\n\ndata class AvdInfo(val name: String, val model: String, val os: String)\n\nobject DeviceService {\n private val logger = LoggerFactory.getLogger(DeviceService::class.java)\n\n private val tempFileHandler = TempFileHandler()\n private val localSimulatorUtils = LocalSimulatorUtils(tempFileHandler)\n\n fun startDevice(\n device: Device.AvailableForLaunch,\n driverHostPort: Int?,\n connectedDevices: Set = setOf()\n ): Device.Connected {\n when (device.deviceSpec.platform) {\n Platform.IOS -> {\n PrintUtils.message(\"Launching Simulator...\")\n try {\n localSimulatorUtils.bootSimulator(device.modelId)\n PrintUtils.message(\"Setting the device locale to ${device.deviceSpec.locale.code}...\")\n localSimulatorUtils.setDeviceLanguage(device.modelId, device.deviceSpec.locale.languageCode)\n localSimulatorUtils.setDeviceLocale(device.modelId, device.deviceSpec.locale.code)\n localSimulatorUtils.reboot(device.modelId)\n localSimulatorUtils.launchSimulator(device.modelId)\n localSimulatorUtils.awaitLaunch(device.modelId)\n } catch (e: LocalSimulatorUtils.SimctlError) {\n logger.error(\"Failed to launch simulator\", e)\n throw DeviceError(e.message)\n }\n\n return Device.Connected(\n instanceId = device.modelId,\n description = device.description,\n platform = device.platform,\n deviceType = device.deviceType,\n deviceSpec = device.deviceSpec,\n )\n }\n\n Platform.ANDROID -> {\n PrintUtils.message(\"Launching Emulator...\")\n val emulatorBinary = requireEmulatorBinary()\n\n ProcessBuilder(\n emulatorBinary.absolutePath,\n \"-avd\",\n device.modelId,\n \"-netdelay\",\n \"none\",\n \"-netspeed\",\n \"full\"\n ).start().waitFor(10, TimeUnit.SECONDS)\n\n var lastException: Exception? = null\n\n val dadb = MaestroTimer.withTimeout(60000) {\n try {\n Dadb.list().lastOrNull { dadb ->\n !connectedDevices.contains(dadb.toString())\n }\n } catch (ignored: Exception) {\n Thread.sleep(100)\n lastException = ignored\n null\n }\n } ?: throw DeviceError(\"Unable to start device: ${device.modelId}\", lastException)\n\n PrintUtils.message(\"Waiting for emulator ( ${device.modelId} ) to boot...\")\n while (!bootComplete(dadb)) {\n Thread.sleep(1000)\n }\n\n PrintUtils.message(\"Setting the device locale to ${device.deviceSpec.locale.code}...\")\n val driver = AndroidDriver(dadb, driverHostPort)\n driver.installMaestroDriverApp()\n val result = driver.setDeviceLocale(\n country = device.deviceSpec.locale.countryCode,\n language = device.deviceSpec.locale.languageCode,\n )\n\n when (result) {\n SET_LOCALE_RESULT_SUCCESS -> PrintUtils.message(\"[Done] Setting the device locale to ${device.deviceSpec.locale.code}...\")\n SET_LOCALE_RESULT_LOCALE_NOT_VALID -> throw IllegalStateException(\"Failed to set locale ${device.deviceSpec.locale.code}, the locale is not valid for a chosen device\")\n SET_LOCALE_RESULT_UPDATE_CONFIGURATION_FAILED -> throw IllegalStateException(\"Failed to set locale ${device.deviceSpec.locale.code}, exception during updating configuration occurred\")\n else -> throw IllegalStateException(\"Failed to set locale ${device.deviceSpec.locale.code}, unknown exception happened\")\n }\n driver.uninstallMaestroDriverApp()\n\n return Device.Connected(\n instanceId = dadb.toString(),\n description = device.description,\n platform = device.platform,\n deviceType = device.deviceType,\n deviceSpec = device.deviceSpec,\n )\n }\n\n Platform.WEB -> {\n PrintUtils.message(\"Launching Web...\")\n CdpWebDriver(isStudio = false, isHeadless = false, screenSize = null).open()\n\n return Device.Connected(\n instanceId = \"chromium\",\n description = \"Chromium Web Browser\",\n platform = device.platform,\n deviceType = device.deviceType,\n deviceSpec = device.deviceSpec,\n )\n }\n }\n }\n\n fun listConnectedDevices(\n includeWeb: Boolean = false,\n host: String? = null,\n port: Int? = null,\n ): List {\n return listDevices(includeWeb = includeWeb, host, port)\n .filterIsInstance()\n }\n\n fun List.withPlatform(platform: Platform?) =\n filter { platform == null || it.platform == platform }\n\n fun listAvailableForLaunchDevices(includeWeb: Boolean = false): List {\n return listDevices(includeWeb = includeWeb)\n .filterIsInstance()\n }\n\n fun listDevices(includeWeb: Boolean, host: String? = null, port: Int? = null): List {\n return listAndroidDevices(host, port) +\n listIOSDevices() +\n if (includeWeb) {\n listWebDevices()\n } else {\n listOf()\n }\n }\n\n fun listWebDevices(): List {\n return listOf(\n Device.Connected(\n platform = Platform.WEB,\n description = \"Chromium Web Browser\",\n instanceId = \"chromium\",\n deviceType = Device.DeviceType.BROWSER,\n deviceSpec = DeviceSpec.fromRequest(DeviceSpecRequest.Web())\n ),\n Device.AvailableForLaunch(\n modelId = \"chromium\",\n description = \"Chromium Web Browser\",\n platform = Platform.WEB,\n deviceType = Device.DeviceType.BROWSER,\n deviceSpec = DeviceSpec.fromRequest(DeviceSpecRequest.Web())\n )\n )\n }\n\n fun listAndroidDevices(host: String? = null, port: Int? = null): List {\n val host = host ?: \"localhost\"\n if (port != null) {\n val dadb = Dadb.create(host, port)\n return listOf(\n Device.Connected(\n instanceId = dadb.toString(),\n description = dadb.toString(),\n platform = Platform.ANDROID,\n deviceType = Device.DeviceType.EMULATOR,\n deviceSpec = DeviceSpec.fromRequest(\n DeviceSpecRequest.Android()\n )\n )\n )\n }\n\n // Fetch AVD info once (model + os) to avoid repeated avdmanager calls\n val avdInfoList = fetchAndroidAvdInfo()\n\n val connected = runCatching {\n Dadb.list(host = host).map { dadb ->\n val avdName = runCatching {\n dadb.shell(\"getprop ro.kernel.qemu\").output.trim().let { qemuProp ->\n if (qemuProp == \"1\") {\n val avdNameResult = ProcessBuilder(\"adb\", \"-s\", dadb.toString(), \"emu\", \"avd\", \"name\")\n .redirectErrorStream(true)\n .start()\n .apply { waitFor(5, TimeUnit.SECONDS) }\n .inputStream.bufferedReader().readLine()?.trim() ?: \"\"\n\n if (avdNameResult.isNotBlank() && !avdNameResult.contains(\"unknown AVD\")) {\n avdNameResult\n } else null\n } else null\n }\n }.getOrNull()\n\n val instanceId = dadb.toString()\n val deviceType = when {\n instanceId.startsWith(\"emulator\") -> Device.DeviceType.EMULATOR\n else -> Device.DeviceType.REAL\n }\n val avdInfo = avdInfoList.find { it.name == avdName } ?: AvdInfo(name = avdName ?: \"\", model = \"\", os = \"\")\n Device.Connected(\n instanceId = instanceId,\n description = avdName ?: dadb.toString(),\n platform = Platform.ANDROID,\n deviceType = deviceType,\n deviceSpec = DeviceSpec.fromRequest(\n DeviceSpecRequest.Android()\n ),\n )\n }\n }.getOrNull() ?: emptyList()\n\n // Note that there is a possibility that AVD is actually already connected and is present in\n // connectedDevices.\n val avds = try {\n val emulatorBinary = requireEmulatorBinary()\n ProcessBuilder(emulatorBinary.absolutePath, \"-list-avds\")\n .start()\n .inputStream\n .bufferedReader()\n .useLines { lines ->\n lines\n .map { avdName ->\n val avdInfo = avdInfoList.find { it.name == avdName } ?: AvdInfo(name = avdName, model = \"\", os = \"\")\n Device.AvailableForLaunch(\n modelId = avdName,\n description = avdName,\n platform = Platform.ANDROID,\n deviceType = Device.DeviceType.EMULATOR,\n deviceSpec = DeviceSpec.fromRequest(\n DeviceSpecRequest.Android(avdInfo.model, avdInfo.os)\n )\n )\n }\n .toList()\n }\n } catch (ignored: Exception) {\n emptyList()\n }\n\n return connected + avds\n }\n\n /**\n * Runs `avdmanager list avd` and returns a list of AvdInfo\n * - name\n * - model: the canonical device ID from avdmanager, e.g. \"pixel_6\"\n * - os: \"android-XX\" derived from the API level, e.g. \"android-34\"\n *\n * Falls back to config.ini for the OS if avdmanager output lacks it.\n * Returns empty string on any failure\n */\n private fun fetchAndroidAvdInfo(): List {\n return try {\n val avd = requireAvdManagerBinary()\n val output = ProcessBuilder(avd.absolutePath, \"list\", \"avd\")\n .redirectErrorStream(true)\n .start()\n .apply { waitFor(30, TimeUnit.SECONDS) }\n .inputStream.bufferedReader().readText()\n parseAvdInfo(output, AndroidEnvUtils.androidAvdHome)\n } catch (e: Exception) {\n emptyList()\n }\n }\n\n internal fun parseAvdInfo(output: String, avdHome: File): List {\n val result = mutableListOf()\n var currentName: String? = null\n var currentModel: String? = null\n var currentOs: String? = null\n\n for (line in output.lines()) {\n val trimmed = line.trim()\n when {\n trimmed.startsWith(\"Name:\") -> {\n // Save previous block\n if (currentName != null) {\n result += AvdInfo(name = currentName, model = currentModel ?: \"\", os = currentOs ?: \"\")\n }\n currentName = trimmed.removePrefix(\"Name:\").trim()\n currentModel = null\n currentOs = null\n }\n trimmed.startsWith(\"Device:\") -> {\n // \"pixel_6 (Google Pixel 6)\" โ†’ \"pixel_6\"\n currentModel = trimmed.removePrefix(\"Device:\").trim().substringBefore(\" \")\n }\n currentOs == null && currentName != null -> {\n // Read OS from config.ini once we have the AVD name\n val configFile = File(avdHome, \"$currentName.avd/config.ini\")\n if (configFile.exists()) {\n val sysdir = configFile.readLines()\n .firstOrNull { it.startsWith(\"image.sysdir.1=\") }\n ?.substringAfter(\"=\")\n currentOs = sysdir?.split(\"/\")?.firstOrNull { it.startsWith(\"android-\") }\n }\n }\n }\n }\n // Save last block\n if (currentName != null) {\n result += AvdInfo(name = currentName, model = currentModel ?: \"\", os = currentOs ?: \"\")\n }\n return result\n }\n\n fun listIOSDevices(): List {\n val simctlList = try {\n localSimulatorUtils.list()\n } catch (ignored: Exception) {\n return emptyList()\n }\n\n val runtimeNameByIdentifier = simctlList\n .runtimes\n .associate { it.identifier to it.name }\n\n return simctlList\n .devices\n .flatMap { runtime ->\n runtime.value\n .filter { it.isAvailable }\n .map { device(runtimeNameByIdentifier, runtime, it) }\n } + listIOSConnectedDevices()\n }\n\n fun listIOSConnectedDevices(): List {\n val connectedIphoneList = LocalIOSDevice().listDeviceViaDeviceCtl()\n\n return connectedIphoneList.mapNotNull { device ->\n val udid = device.hardwareProperties?.udid\n if (device.connectionProperties.tunnelState != DeviceCtlResponse.ConnectionProperties.CONNECTED || udid == null) {\n return@mapNotNull null\n }\n\n val description = listOfNotNull(\n device.deviceProperties?.name,\n device.deviceProperties?.osVersionNumber,\n device.identifier\n ).joinToString(\" - \")\n\n Device.Connected(\n instanceId = udid,\n description = description,\n platform = Platform.IOS,\n deviceType = Device.DeviceType.REAL,\n deviceSpec = DeviceSpec.fromRequest(\n DeviceSpecRequest.Ios()\n )\n )\n }\n }\n\n private fun device(\n runtimeNameByIdentifier: Map,\n runtime: Map.Entry>,\n device: SimctlList.Device,\n ): Device {\n val runtimeName = runtimeNameByIdentifier[runtime.key] ?: \"Unknown runtime\"\n val description = \"${device.name} - $runtimeName - ${device.udid}\"\n\n // \"com.apple.CoreSimulator.SimDeviceType.iPhone-XS\" โ†’ \"iPhone-XS\"\n val model = device.deviceTypeIdentifier?.substringAfterLast(\".\") ?: \"\"\n // \"com.apple.CoreSimulator.SimRuntime.iOS-17-5\" โ†’ \"iOS-17-5\"\n val os = runtime.key.substringAfterLast(\".\")\n\n return if (device.state == \"Booted\") {\n Device.Connected(\n instanceId = device.udid,\n description = description,\n platform = Platform.IOS,\n deviceType = Device.DeviceType.SIMULATOR,\n deviceSpec = DeviceSpec.fromRequest(\n DeviceSpecRequest.Ios(model, os)\n )\n )\n } else {\n Device.AvailableForLaunch(\n modelId = device.udid,\n description = description,\n platform = Platform.IOS,\n deviceType = Device.DeviceType.SIMULATOR,\n deviceSpec = DeviceSpec.fromRequest(\n DeviceSpecRequest.Ios(model, os)\n )\n )\n }\n }\n\n /**\n * @return true if ios simulator or android emulator is currently connected\n */\n fun isDeviceConnected(deviceName: String, platform: Platform): Device.Connected? {\n return when (platform) {\n Platform.IOS -> listIOSDevices()\n .filterIsInstance()\n .find { it.description.contains(deviceName, ignoreCase = true) }\n\n else -> runCatching {\n (Dadb.list() + AdbServer.listDadbs(adbServerPort = 5038))\n .mapNotNull { dadb -> runCatching { dadb.shell(\"getprop ro.kernel.qemu.avd_name\").output }.getOrNull() }\n .map { output ->\n Device.Connected(\n instanceId = output,\n description = output,\n platform = Platform.ANDROID,\n deviceType = Device.DeviceType.EMULATOR,\n deviceSpec = DeviceSpec.fromRequest(\n DeviceSpecRequest.Android()\n )\n )\n }\n .find { connectedDevice -> connectedDevice.description.contains(deviceName, ignoreCase = true) }\n }.getOrNull()\n }\n }\n\n /**\n * @return true if ios simulator or android emulator is available to launch\n */\n fun isDeviceAvailableToLaunch(deviceName: String, platform: Platform): Device.AvailableForLaunch? {\n return if (platform == Platform.IOS) {\n listIOSDevices()\n .filterIsInstance()\n .find { it.description.contains(deviceName, ignoreCase = true) }\n } else {\n listAndroidDevices()\n .filterIsInstance()\n .find { it.description.contains(deviceName, ignoreCase = true) }\n }\n }\n\n /**\n * Creates an iOS simulator\n *\n * @param deviceName Any name\n * @param device Simulator type as specified by Apple i.e. iPhone-11\n * @param os OS runtime name as specified by Apple i.e. iOS-16-2\n */\n fun createIosDevice(deviceName: String, device: String, os: String): UUID {\n val command = listOf(\n \"xcrun\",\n \"simctl\",\n \"create\",\n deviceName,\n \"com.apple.CoreSimulator.SimDeviceType.$device\",\n \"com.apple.CoreSimulator.SimRuntime.$os\"\n )\n\n val process = ProcessBuilder(*command.toTypedArray()).start()\n if (!process.waitFor(5, TimeUnit.MINUTES)) {\n throw TimeoutException()\n }\n\n if (process.exitValue() != 0) {\n val processOutput = process.errorStream\n .source()\n .buffer()\n .readUtf8()\n\n throw IllegalStateException(processOutput)\n } else {\n val output = String(process.inputStream.readBytes()).trim()\n return try {\n UUID.fromString(output)\n } catch (ignore: IllegalArgumentException) {\n throw IllegalStateException(\"Unable to create device. No UUID was generated\")\n }\n }\n }\n\n /**\n * Creates an Android emulator\n *\n * @param deviceName Any device name\n * @param device Device type as specified by the Android SDK i.e. \"pixel_6\"\n * @param systemImage Full system package i.e \"system-images;android-28;google_apis;x86_64\"\n * @param tag google apis or playstore tag i.e. google_apis or google_apis_playstore\n * @param abi x86_64, x86, arm64 etc..\n */\n fun createAndroidDevice(\n deviceName: String,\n device: String,\n systemImage: String,\n tag: String,\n abi: String,\n force: Boolean = false,\n ): String {\n val avd = requireAvdManagerBinary()\n val name = deviceName\n val command = mutableListOf(\n avd.absolutePath,\n \"create\", \"avd\",\n \"--name\", name,\n \"--package\", systemImage,\n \"--tag\", tag,\n \"--abi\", abi,\n \"--device\", device,\n )\n\n if (force) command.add(\"--force\")\n\n val process = ProcessBuilder(*command.toTypedArray()).start()\n\n if (!process.waitFor(5, TimeUnit.MINUTES)) {\n throw TimeoutException()\n }\n\n if (process.exitValue() != 0) {\n val processOutput = process.errorStream\n .source()\n .buffer()\n .readUtf8()\n\n throw IllegalStateException(\"Failed to start android emulator: $processOutput\")\n }\n\n return name\n }\n\n fun getAvailablePixelDevices(): List {\n val avd = requireAvdManagerBinary()\n val command = mutableListOf(\n avd.absolutePath,\n \"list\", \"device\"\n )\n\n val process = ProcessBuilder(*command.toTypedArray()).start()\n\n if (!process.waitFor(1, TimeUnit.MINUTES)) {\n throw TimeoutException()\n }\n\n if (process.exitValue() != 0) {\n val processOutput = process.inputStream.source().buffer().readUtf8() + \"\\n\" + process.errorStream.source().buffer().readUtf8()\n\n throw IllegalStateException(\"Failed to list avd devices emulator: $processOutput\")\n }\n\n return runCatching {\n AndroidEnvUtils.parsePixelDevices(String(process.inputStream.readBytes()).trim())\n }.getOrNull() ?: emptyList()\n }\n\n /**\n * @return true is Android system image is already installed\n */\n fun isAndroidSystemImageInstalled(image: String): Boolean {\n val command = listOf(\n requireSdkManagerBinary().absolutePath,\n \"--list_installed\"\n )\n try {\n val process = ProcessBuilder(*command.toTypedArray()).start()\n if (!process.waitFor(1, TimeUnit.MINUTES)) {\n throw TimeoutException()\n }\n\n if (process.exitValue() == 0) {\n val output = String(process.inputStream.readBytes()).trim()\n\n return output.contains(image)\n }\n } catch (e: Exception) {\n logger.error(\"Unable to detect if SDK package is installed\", e)\n }\n\n return false\n }\n\n /**\n * Uses the Android SDK manager to install android image\n */\n fun installAndroidSystemImage(image: String): Boolean {\n val command = listOf(\n requireSdkManagerBinary().absolutePath,\n image\n )\n try {\n val process = ProcessBuilder(*command.toTypedArray())\n .inheritIO()\n .start()\n if (!process.waitFor(120, TimeUnit.MINUTES)) {\n throw TimeoutException()\n }\n\n if (process.exitValue() == 0) {\n val output = String(process.inputStream.readBytes()).trim()\n\n return output.contains(image)\n }\n } catch (e: Exception) {\n logger.error(\"Unable to install if SDK package is installed\", e)\n }\n\n return false\n }\n\n fun getAndroidSystemImageInstallCommand(pkg: String): String {\n return listOf(\n requireSdkManagerBinary().absolutePath,\n \"\\\"$pkg\\\"\"\n ).joinToString(separator = \" \")\n }\n\n fun deleteIosDevice(uuid: String): Boolean {\n val command = listOf(\n \"xcrun\",\n \"simctl\",\n \"delete\",\n uuid\n )\n\n val process = ProcessBuilder(*command.toTypedArray()).start()\n\n if (!process.waitFor(1, TimeUnit.MINUTES)) {\n throw TimeoutException()\n }\n\n return process.exitValue() == 0\n }\n\n fun killAndroidDevice(deviceId: String): Boolean {\n val command = listOf(\"adb\", \"-s\", deviceId, \"emu\", \"kill\")\n\n try {\n val process = ProcessBuilder(*command.toTypedArray()).start()\n\n if (!process.waitFor(1, TimeUnit.MINUTES)) {\n throw TimeoutException(\"Android kill command timed out\")\n }\n\n val success = process.exitValue() == 0\n if (success) {\n logger.info(\"Killed Android device: $deviceId\")\n } else {\n logger.error(\"Failed to kill Android device: $deviceId\")\n }\n\n return success\n } catch (e: Exception) {\n logger.error(\"Error killing Android device: $deviceId\", e)\n return false\n }\n }\n\n fun killIOSDevice(deviceId: String): Boolean {\n val command = listOf(\"xcrun\", \"simctl\", \"shutdown\", deviceId)\n\n try {\n val process = ProcessBuilder(*command.toTypedArray()).start()\n\n if (!process.waitFor(1, TimeUnit.MINUTES)) {\n throw TimeoutException(\"iOS kill command timed out\")\n }\n\n val success = process.exitValue() == 0\n if (success) {\n logger.info(\"Killed iOS device: $deviceId\")\n } else {\n logger.error(\"Failed to kill iOS device: $deviceId\")\n }\n\n return success\n } catch (e: Exception) {\n logger.error(\"Error killing iOS device: $deviceId\", e)\n return false\n }\n }\n\n private fun bootComplete(dadb: Dadb): Boolean {\n return try {\n val booted = dadb.shell(\"getprop sys.boot_completed\").output.trim() == \"1\"\n val settingsAvailable = dadb.shell(\"settings list global\").exitCode == 0\n val packageManagerAvailable = dadb.shell(\"pm get-max-users\").exitCode == 0\n return settingsAvailable && packageManagerAvailable && booted\n } catch (e: IllegalStateException) {\n false\n }\n }\n\n private fun requireEmulatorBinary(): File = AndroidEnvUtils.requireEmulatorBinary()\n\n private fun requireAvdManagerBinary(): File = AndroidEnvUtils.requireCommandLineTools(\"avdmanager\")\n\n private fun requireSdkManagerBinary(): File = AndroidEnvUtils.requireCommandLineTools(\"sdkmanager\")\n\n private const val SET_LOCALE_RESULT_SUCCESS = 0\n private const val SET_LOCALE_RESULT_LOCALE_NOT_VALID = 1\n private const val SET_LOCALE_RESULT_UPDATE_CONFIGURATION_FAILED = 2\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/DeviceSpec.kt", "content": "package maestro.device\n\nimport com.fasterxml.jackson.annotation.JsonSubTypes\nimport com.fasterxml.jackson.annotation.JsonTypeInfo\nimport maestro.device.locale.DeviceLocale\n\nenum class CPU_ARCHITECTURE(val value: String) {\n X86_64(\"x86_64\"),\n ARM64(\"arm64-v8a\"),\n UNKNOWN(\"unknown\");\n\n companion object {\n fun fromString(p: String?): Platform? {\n return Platform.entries.firstOrNull { it.description.equals(p, ignoreCase = true) }\n }\n }\n}\n\n/**\n * Returned Sealed class that has all non-nullable values\n */\n@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXISTING_PROPERTY, property = \"platform\")\n@JsonSubTypes(\n JsonSubTypes.Type(DeviceSpec.Android::class, name = \"ANDROID\"),\n JsonSubTypes.Type(DeviceSpec.Ios::class, name = \"IOS\"),\n JsonSubTypes.Type(DeviceSpec.Web::class, name = \"WEB\"),\n)\nsealed class DeviceSpec {\n abstract val platform: Platform\n abstract val model: String\n abstract val os: String\n abstract val osVersion: Int\n abstract val deviceName: String\n abstract val locale: DeviceLocale\n\n data class Android(\n override val model: String,\n override val os: String,\n override val locale: DeviceLocale,\n val orientation: DeviceOrientation,\n val disableAnimations: Boolean,\n val cpuArchitecture: CPU_ARCHITECTURE,\n ) : DeviceSpec() {\n override val platform = Platform.ANDROID\n override val osVersion: Int = os.removePrefix(\"android-\").toIntOrNull() ?: 0\n override val deviceName = \"Maestro_ANDROID_${model}_${os}\"\n val tag = \"google_apis\"\n val emulatorImage = \"system-images;$os;$tag;${cpuArchitecture.value}\"\n }\n\n data class Ios(\n override val model: String,\n override val os: String,\n override val locale: DeviceLocale,\n val orientation: DeviceOrientation,\n val disableAnimations: Boolean,\n val snapshotKeyHonorModalViews: Boolean,\n ) : DeviceSpec() {\n override val platform = Platform.IOS\n override val osVersion: Int = os.removePrefix(\"iOS-\").substringBefore(\"-\").toIntOrNull() ?: 0\n override val deviceName = \"Maestro_IOS_${model}_${osVersion}\"\n }\n\n data class Web(\n override val model: String,\n override val os: String,\n override val locale: DeviceLocale\n ) : DeviceSpec() {\n override val platform = Platform.WEB\n override val osVersion: Int = 0\n override val deviceName = \"Maestro_WEB_${model}_${osVersion}\"\n }\n\n companion object {\n /**\n * Creates a fully resolved DeviceSpec from a DeviceRequest, filling in platform-aware defaults.\n * The returned spec is not environment-validated.\n * Environment-specific validation for model & os can happen via SupportedDevices.validate().\n */\n fun fromRequest(request: DeviceSpecRequest): DeviceSpec {\n return when (request) {\n is DeviceSpecRequest.Android -> Android(\n model = request.model ?: \"pixel_6\",\n os = request.os ?: \"android-33\",\n locale = DeviceLocale.fromString(request.locale ?: \"en_US\", Platform.ANDROID),\n orientation = request.orientation ?: DeviceOrientation.PORTRAIT,\n disableAnimations = request.disableAnimations ?: true,\n cpuArchitecture = request.cpuArchitecture ?: CPU_ARCHITECTURE.ARM64,\n )\n is DeviceSpecRequest.Ios -> Ios(\n model = request.model ?: \"iPhone-11\",\n os = request.os ?: \"iOS-17-5\",\n locale = DeviceLocale.fromString(request.locale ?: \"en_US\", Platform.IOS),\n orientation = request.orientation ?: DeviceOrientation.PORTRAIT,\n disableAnimations = request.disableAnimations ?: true,\n snapshotKeyHonorModalViews = request.snapshotKeyHonorModalViews ?: true,\n )\n is DeviceSpecRequest.Web -> Web(\n model = request.model ?: \"chromium\",\n os = request.os ?: \"default\",\n locale = DeviceLocale.fromString(request.locale ?: \"en_US\", Platform.WEB),\n )\n }\n }\n }\n}\n\n/**\n * Request for setting up device config\n */\nsealed class DeviceSpecRequest {\n abstract val platform: Platform\n\n data class Android(\n val model: String? = null,\n val os: String? = null,\n val locale: String? = null,\n val orientation: DeviceOrientation? = null,\n val disableAnimations: Boolean? = null,\n val cpuArchitecture: CPU_ARCHITECTURE? = null,\n ) : DeviceSpecRequest() {\n override val platform = Platform.ANDROID\n }\n\n data class Ios(\n val model: String? = null,\n val os: String? = null,\n val locale: String? = null,\n val orientation: DeviceOrientation? = null,\n val disableAnimations: Boolean? = null,\n val snapshotKeyHonorModalViews: Boolean? = null,\n ) : DeviceSpecRequest() {\n override val platform = Platform.IOS\n }\n\n data class Web(\n val model: String? = null,\n val os: String? = null,\n val locale: String? = null,\n ) : DeviceSpecRequest() {\n override val platform = Platform.WEB\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/Platform.kt", "content": "package maestro.device\n\nenum class Platform(val description: String) {\n ANDROID(\"Android\"),\n IOS(\"iOS\"),\n WEB(\"Web\");\n\n companion object {\n fun fromString(p: String): Platform {\n return entries.firstOrNull { it.description.equals(p, ignoreCase = true) }\n ?: throw IllegalArgumentException(\n \"Unknown platform: '$p'. Must be one of: ${entries.joinToString { it.description }}\"\n )\n }\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/locale/AndroidLocale.kt", "content": "package maestro.device.locale\n\nimport maestro.device.Platform\nimport java.util.Locale\n\n/**\n * Type-safe enum representing Android-supported languages.\n * These are a subset of languages available in Java's Locale API.\n */\nenum class AndroidLanguage(val code: String) {\n ARABIC(\"ar\"),\n BULGARIAN(\"bg\"),\n CATALAN(\"ca\"),\n CHINESE(\"zh\"),\n CROATIAN(\"hr\"),\n CZECH(\"cs\"),\n DANISH(\"da\"),\n DUTCH(\"nl\"),\n ENGLISH(\"en\"),\n FINNISH(\"fi\"),\n FRENCH(\"fr\"),\n GERMAN(\"de\"),\n GREEK(\"el\"),\n HEBREW(\"he\"),\n HINDI(\"hi\"),\n HUNGARIAN(\"hu\"),\n INDONESIAN(\"id\"),\n ITALIAN(\"it\"),\n JAPANESE(\"ja\"),\n KOREAN(\"ko\"),\n LATVIAN(\"lv\"),\n LITHUANIAN(\"lt\"),\n NORWEGIAN_BOKMOL(\"nb\"),\n POLISH(\"pl\"),\n PORTUGUESE(\"pt\"),\n ROMANIAN(\"ro\"),\n RUSSIAN(\"ru\"),\n SERBIAN(\"sr\"),\n SLOVAK(\"sk\"),\n SLOVENIAN(\"sl\"),\n SPANISH(\"es\"),\n SWEDISH(\"sv\"),\n TAGALOG(\"tl\"),\n THAI(\"th\"),\n TURKISH(\"tr\"),\n UKRAINIAN(\"uk\"),\n VIETNAMESE(\"vi\");\n\n // Gets the display name for this language using Java's Locale API.\n // Falls back to the enum name if Locale doesn't recognize the code.\n val displayName: String\n get() = try {\n Locale(code).getDisplayLanguage(Locale.US).takeIf { it.isNotBlank() }\n ?: code.uppercase()\n } catch (e: Exception) {\n code.uppercase()\n }\n\n companion object {\n init {\n // Validate that all enum codes are valid ISO-639-1 language codes\n val validISOCodes = Locale.getISOLanguages().toSet()\n entries.forEach { language ->\n require(language.code in validISOCodes) {\n \"Language code '${language.code}' in AndroidLanguage enum is not a valid ISO-639-1 code\"\n }\n }\n }\n\n // Gets all language codes as a set.\n val allCodes: Set\n get() = entries.map { it.code }.toSet()\n\n // Finds a language by its code.\n fun fromCode(code: String): AndroidLanguage? {\n return entries.find { it.code == code }\n }\n }\n}\n\n/**\n * Type-safe enum representing Android-supported countries.\n * These are a subset of countries available in Java's Locale API.\n */\nenum class AndroidCountry(val code: String) {\n AUSTRALIA(\"AU\"),\n AUSTRIA(\"AT\"),\n BELGIUM(\"BE\"),\n BRAZIL(\"BR\"),\n BRITAIN(\"GB\"),\n BULGARIA(\"BG\"),\n CANADA(\"CA\"),\n CROATIA(\"HR\"),\n CZECH_REPUBLIC(\"CZ\"),\n DENMARK(\"DK\"),\n EGYPT(\"EG\"),\n FINLAND(\"FI\"),\n FRANCE(\"FR\"),\n GERMANY(\"DE\"),\n GREECE(\"GR\"),\n HONG_KONG(\"HK\"),\n HUNGARY(\"HU\"),\n INDIA(\"IN\"),\n INDONESIA(\"ID\"),\n IRELAND(\"IE\"),\n ISRAEL(\"IL\"),\n ITALY(\"IT\"),\n JAPAN(\"JP\"),\n KOREA(\"KR\"),\n LATVIA(\"LV\"),\n LIECHTENSTEIN(\"LI\"),\n LITHUANIA(\"LT\"),\n MEXICO(\"MX\"),\n NETHERLANDS(\"NL\"),\n NEW_ZEALAND(\"NZ\"),\n NORWAY(\"NO\"),\n PHILIPPINES(\"PH\"),\n POLAND(\"PL\"),\n PORTUGAL(\"PT\"),\n PRC(\"CN\"),\n ROMANIA(\"RO\"),\n RUSSIA(\"RU\"),\n SERBIA(\"RS\"),\n SINGAPORE(\"SG\"),\n SLOVAKIA(\"SK\"),\n SLOVENIA(\"SI\"),\n SPAIN(\"ES\"),\n SWEDEN(\"SE\"),\n SWITZERLAND(\"CH\"),\n TAIWAN(\"TW\"),\n THAILAND(\"TH\"),\n TURKEY(\"TR\"),\n UKRAINE(\"UA\"),\n USA(\"US\"),\n VIETNAM(\"VN\"),\n ZIMBABWE(\"ZA\");\n\n // Gets the display name for this country using Java's Locale API.\n // Falls back to the enum name if Locale doesn't recognize the code.\n val displayName: String\n get() = try {\n Locale(\"\", code).getDisplayCountry(Locale.US).takeIf { it.isNotBlank() }\n ?: code\n } catch (e: Exception) {\n code\n }\n\n companion object {\n init {\n // Validate that all enum codes are valid ISO-3166-1 country codes\n val validISOCodes = Locale.getISOCountries().toSet()\n entries.forEach { country ->\n require(country.code in validISOCodes) {\n \"Country code '${country.code}' in AndroidCountry enum is not a valid ISO-3166-1 code\"\n }\n }\n }\n\n // Gets all country codes as a set.\n val allCodes: Set\n get() = entries.map { it.code }.toSet()\n\n // Finds a country by its code.\n fun fromCode(code: String): AndroidCountry? {\n return entries.find { it.code == code }\n }\n }\n}\n\n/**\n * Android device locale - a dynamic combination of language and country.\n * Android supports all combinations of supported languages and countries.\n */\ndata class AndroidLocale(\n val language: AndroidLanguage,\n val country: AndroidCountry\n) : DeviceLocale {\n\n override val code: String\n get() = \"${language.code}_${country.code}\"\n\n override val displayName: String\n get() = try {\n Locale(language.code, country.code).getDisplayName(Locale.US)\n } catch (e: Exception) {\n \"${language.displayName} (${country.displayName})\"\n }\n\n override val languageCode: String\n get() = language.code\n\n override val countryCode: String\n get() = country.code\n\n override val platform: Platform = Platform.ANDROID\n\n companion object {\n /**\n * Cached set of available Java Locale combinations (language_country format).\n * Computed once and reused for efficient O(1) lookups.\n */\n private val availableJavaLocaleCombinations: Set = Locale.getAvailableLocales()\n .map { \"${it.language}_${it.country}\" }\n .toSet()\n\n /**\n * Creates an AndroidLocale from a locale string (e.g., \"en_US\").\n * Validates that both language and country codes are supported.\n * @throws LocaleValidationException if the locale string is invalid or unsupported\n */\n fun fromString(localeString: String): AndroidLocale {\n val parts = localeString.split(\"_\", \"-\")\n if (parts.size != 2) {\n throw LocaleValidationException(\n \"Failed to validate device locale, $localeString is not a valid format. Expected format: language_country, e.g., en_US.\"\n )\n }\n\n val languageCode = parts[0]\n val countryCode = parts[1]\n\n val language = AndroidLanguage.fromCode(languageCode)\n ?: throw LocaleValidationException(\n \"Failed to validate Android device language, $languageCode is not a supported Android language. Here is a full list of supported languageCode: \\n\\n ${AndroidLanguage.allCodes.joinToString(\", \")}\"\n )\n\n val country = AndroidCountry.fromCode(countryCode)\n ?: throw LocaleValidationException(\n \"Failed to validate Android device country, $countryCode is not a supported Android country. Here is a full list of supported countryCode: \\n\\n ${AndroidCountry.allCodes.joinToString(\", \")}\"\n )\n\n // Validate that the language-country combination exists in Java Locale\n if (\"${languageCode}_${countryCode}\" !in availableJavaLocaleCombinations) {\n throw LocaleValidationException(\n \"Failed to validate Android device locale combination, $localeString is not a valid locale combination. Here is a full list of supported locales: \\n\\n ${allCodes.joinToString(\", \")}\"\n )\n }\n\n return AndroidLocale(language, country)\n }\n\n /**\n * Validates if a locale string represents a valid Android locale combination.\n */\n fun isValid(localeString: String): Boolean {\n return try {\n fromString(localeString)\n true\n } catch (e: LocaleValidationException) {\n false\n }\n }\n\n /**\n * Generates all valid Android locale combinations dynamically.\n * This creates all combinations of supported languages and countries\n * that are valid Java locale combinations.\n */\n val all: List\n get() = AndroidLanguage.entries.flatMap { language ->\n AndroidCountry.entries.mapNotNull { country ->\n val localeKey = \"${language.code}_${country.code}\"\n // Only include combinations that are valid Java locales\n if (localeKey in availableJavaLocaleCombinations) {\n AndroidLocale(language, country)\n } else {\n null\n }\n }\n }\n\n /**\n * Gets all locale codes as a set.\n */\n val allCodes: Set\n get() = all.map { it.code }.toSet()\n\n /**\n * Finds a locale code given language and country codes for Android.\n * @return Locale code if found (e.g., \"en_US\"), null otherwise\n */\n fun find(languageCode: String, countryCode: String): String? {\n return if (isValid(\"${languageCode}_${countryCode}\")) {\n \"${languageCode}_${countryCode}\"\n } else {\n null\n }\n }\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/locale/DeviceLocale.kt", "content": "package maestro.device.locale\n\nimport maestro.device.Platform\nimport java.util.Locale\n\n/**\n * Sealed interface for device locales to provide common behavior when needed.\n * This allows platform-agnostic code to work with locales while keeping\n * Android, iOS, and Web types separate for platform-specific code.\n */\nsealed interface DeviceLocale {\n // Gets the locale code representation (e.g., \"en_US\", \"zh-Hans\").\n val code: String\n\n // Gets the display name for this locale.\n val displayName: String\n\n // Gets the language code for this locale (e.g., \"en\", \"fr\", \"zh\").\n val languageCode: String\n\n // Gets the country code for this locale (e.g., \"US\", \"FR\", \"CN\").\n val countryCode: String\n\n // Gets the platform this locale is for.\n val platform: Platform\n\n companion object {\n /**\n * Creates a DeviceLocale from a locale string and platform.\n * This is useful for platform-agnostic code that needs to work with locales.\n *\n * @throws LocaleValidationException if the locale string is invalid or unsupported\n */\n fun fromString(localeString: String, platform: Platform): DeviceLocale {\n return when (platform) {\n Platform.ANDROID -> AndroidLocale.fromString(localeString)\n Platform.IOS -> IosLocale.fromString(localeString)\n Platform.WEB -> WebLocale.fromString(localeString)\n }\n }\n\n /**\n * Validates if a locale string is valid for the given platform.\n */\n fun isValid(localeString: String, platform: Platform): Boolean {\n return try {\n fromString(localeString, platform)\n true\n } catch (e: LocaleValidationException) {\n false\n }\n }\n\n /**\n * Gets all supported locales for a platform.\n */\n fun all(platform: Platform): List {\n return when (platform) {\n Platform.ANDROID -> AndroidLocale.all\n Platform.IOS -> IosLocale.entries\n Platform.WEB -> WebLocale.entries\n }\n }\n\n /**\n * Gets all supported locale codes for a platform.\n */\n fun allCodes(platform: Platform): Set {\n return when (platform) {\n Platform.ANDROID -> AndroidLocale.allCodes\n Platform.IOS -> IosLocale.allCodes\n Platform.WEB -> WebLocale.allCodes\n }\n }\n\n /**\n * Finds a locale code given language and country codes for the specified platform.\n * @return Locale code if found (e.g., \"en_US\" or \"en-US\"), null otherwise\n */\n fun find(languageCode: String, countryCode: String, platform: Platform): String? {\n return when (platform) {\n Platform.ANDROID -> AndroidLocale.find(languageCode, countryCode)\n Platform.IOS -> IosLocale.find(languageCode, countryCode)\n Platform.WEB -> WebLocale.find(languageCode, countryCode)\n }\n }\n\n // Gets the default locale value\n fun getDefault(platform: Platform): DeviceLocale {\n return when(platform) {\n Platform.ANDROID -> AndroidLocale.fromString(\"en_US\")\n Platform.IOS -> IosLocale.fromString(\"en_US\")\n Platform.WEB -> WebLocale.fromString(\"en_US\")\n }\n }\n\n /**\n * Generates a display name for a locale code using Java's Locale API.\n * Parses locale codes in both underscore (en_US) and hyphen (en-US) formats.\n * Falls back to returning the original code if parsing fails.\n *\n * @param localeCode The locale code to generate a display name for\n * @return A human-readable display name (e.g., \"en_US\" -> \"English (United States)\"), or the original code if parsing fails\n */\n internal fun getDisplayNameFromCode(localeCode: String): String {\n try {\n val parts = localeCode.split(\"_\", \"-\")\n if (parts.size == 2) {\n val javaLocale = Locale(parts[0], parts[1])\n val displayName = javaLocale.getDisplayName(Locale.US)\n if (displayName.isNotBlank()) {\n return displayName\n }\n }\n } catch (e: Exception) {\n // Fall through to return locale string\n }\n return localeCode\n }\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/locale/IosLocale.kt", "content": "package maestro.device.locale\n\nimport maestro.device.Platform\n\n/**\n * iOS device locale - fixed enum of supported locale combinations.\n */\nenum class IosLocale(override val code: String) : DeviceLocale {\n EN_AU(\"en_AU\"),\n NL_BE(\"nl_BE\"),\n FR_BE(\"fr_BE\"),\n MS_BN(\"ms_BN\"),\n EN_CA(\"en_CA\"),\n FR_CA(\"fr_CA\"),\n CS_CZ(\"cs_CZ\"),\n FI_FI(\"fi_FI\"),\n DE_DE(\"de_DE\"),\n EL_GR(\"el_GR\"),\n HU_HU(\"hu_HU\"),\n HI_IN(\"hi_IN\"),\n ID_ID(\"id_ID\"),\n HE_IL(\"he_IL\"),\n IT_IT(\"it_IT\"),\n JA_JP(\"ja_JP\"),\n MS_MY(\"ms_MY\"),\n NL_NL(\"nl_NL\"),\n EN_NZ(\"en_NZ\"),\n NB_NO(\"nb_NO\"),\n TL_PH(\"tl_PH\"),\n PL_PL(\"pl_PL\"),\n ZH_CN(\"zh_CN\"),\n RO_RO(\"ro_RO\"),\n RU_RU(\"ru_RU\"),\n EN_SG(\"en_SG\"),\n SK_SK(\"sk_SK\"),\n KO_KR(\"ko_KR\"),\n SV_SE(\"sv_SE\"),\n ZH_TW(\"zh_TW\"),\n TH_TH(\"th_TH\"),\n TR_TR(\"tr_TR\"),\n EN_GB(\"en_GB\"),\n UK_UA(\"uk_UA\"),\n ES_US(\"es_US\"),\n EN_US(\"en_US\"),\n VI_VN(\"vi_VN\"),\n ES_ES(\"es_ES\"),\n FR_FR(\"fr_FR\"),\n\n // Hyphenated locales (language-country format)\n PT_BR(\"pt-BR\"),\n ZH_HK(\"zh-HK\"),\n EN_IN(\"en-IN\"),\n EN_IE(\"en-IE\"),\n ES_MX(\"es-MX\"),\n EN_ZA(\"en-ZA\"),\n\n // iOS-specific locale formats (not standard ISO locale combinations)\n ZH_HANS(\"zh-Hans\"),\n ZH_HANT(\"zh-Hant\"),\n ES_419(\"es-419\");\n\n override val displayName: String\n get() {\n return when (this) {\n ZH_HANS -> \"Chinese (Simplified)\"\n ZH_HANT -> \"Chinese (Traditional)\"\n ES_419 -> \"Spanish (Latin America)\"\n else -> DeviceLocale.getDisplayNameFromCode(code)\n }\n }\n\n override val languageCode: String\n get() {\n val parts = code.split(\"_\", \"-\")\n return parts[0]\n }\n\n override val countryCode: String\n get() = code.split(\"_\", \"-\")[1]\n\n override val platform: Platform = Platform.IOS\n\n companion object {\n /**\n * Gets all locale codes as a set.\n */\n val allCodes: Set\n get() = entries.map { it.code }.toSet()\n\n /**\n * Finds a locale by its string representation.\n * Accepts both underscore and hyphen formats.\n *\n * @throws LocaleValidationException if not found\n */\n fun fromString(localeString: String): IosLocale {\n return entries.find {\n it.code == localeString ||\n it.code.replace(\"_\", \"-\") == localeString ||\n it.code.replace(\"-\", \"_\") == localeString\n } ?: throw LocaleValidationException(\"Failed to validate iOS device locale. Here is a full list of supported locales: \\n\\n ${allCodes.joinToString(\", \")}\")\n }\n\n /**\n * Validates if a locale string is valid for iOS.\n */\n fun isValid(localeString: String): Boolean {\n return entries.any {\n it.code == localeString ||\n it.code.replace(\"_\", \"-\") == localeString ||\n it.code.replace(\"-\", \"_\") == localeString\n }\n }\n\n /**\n * Finds a locale code given language and country codes.\n * Tries both underscore and hyphen formats.\n * @return Locale code if found (e.g., \"en_US\" or \"en-US\"), null otherwise\n */\n fun find(languageCode: String, countryCode: String): String? {\n // Try underscore format first\n val underscoreFormat = \"${languageCode}_$countryCode\"\n if (isValid(underscoreFormat)) {\n return underscoreFormat\n }\n\n // Try hyphen format\n val hyphenFormat = \"$languageCode-$countryCode\"\n if (isValid(hyphenFormat)) {\n return hyphenFormat\n }\n\n return null\n }\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/locale/LocaleValidationException.kt", "content": "package maestro.device.locale\n\nclass LocaleValidationException(message: String): Exception(message)\n" }, { "path": "maestro-client/src/main/java/maestro/device/locale/WebLocale.kt", "content": "package maestro.device.locale\nimport maestro.device.Platform\n\n/**\n * Web device locale - fixed enum of supported locale combinations.\n */\nenum class WebLocale(override val code: String) : DeviceLocale {\n EN_US(\"en_US\");\n\n override val displayName: String\n get() = DeviceLocale.getDisplayNameFromCode(code)\n\n override val languageCode: String\n get() {\n val parts = code.split(\"_\", \"-\")\n return parts[0]\n }\n\n override val countryCode: String\n get() = code.split(\"_\", \"-\")[1]\n\n override val platform: Platform = Platform.WEB\n\n companion object {\n /**\n * Gets all locale codes as a set.\n */\n val allCodes: Set\n get() = entries.map { it.code }.toSet()\n\n /**\n * Finds a locale by its string representation.\n * @throws LocaleValidationException if not found\n */\n fun fromString(localeString: String): WebLocale {\n return entries.find { it.code == localeString }\n ?: throw LocaleValidationException(\"Failed to validate web browser locale: $localeString. Here is a full list of supported locales: \\n\\n ${allCodes.joinToString(\", \")}\")\n }\n\n /**\n * Validates if a locale string is valid for Web.\n */\n fun isValid(localeString: String): Boolean {\n return entries.any { it.code == localeString }\n }\n\n /**\n * Finds a locale code given language and country codes.\n */\n fun find(languageCode: String, countryCode: String): String? {\n val underscoreFormat = \"${languageCode}_$countryCode\"\n if (isValid(underscoreFormat)) {\n return underscoreFormat\n }\n return null\n }\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/serialization/DeviceLocaleSerializer.kt", "content": "package maestro.device.serialization\n\nimport com.fasterxml.jackson.core.JsonGenerator\nimport com.fasterxml.jackson.core.JsonParser\nimport com.fasterxml.jackson.databind.DeserializationContext\nimport com.fasterxml.jackson.databind.JsonNode\nimport com.fasterxml.jackson.databind.SerializerProvider\nimport com.fasterxml.jackson.databind.deser.std.StdDeserializer\nimport com.fasterxml.jackson.databind.ser.std.StdSerializer\nimport maestro.device.Platform\nimport maestro.device.locale.DeviceLocale\n\nclass DeviceLocaleSerializer : StdSerializer(DeviceLocale::class.java) {\n override fun serialize(value: DeviceLocale, gen: JsonGenerator, provider: SerializerProvider) {\n gen.writeStartObject()\n gen.writeStringField(\"code\", value.code)\n gen.writeStringField(\"platform\", value.platform.name)\n gen.writeEndObject()\n }\n}\n\nclass DeviceLocaleDeserializer : StdDeserializer(DeviceLocale::class.java) {\n override fun deserialize(p: JsonParser, ctxt: DeserializationContext): DeviceLocale {\n val node = p.codec.readTree(p)\n val code = node.get(\"code\").asText()\n val platform = Platform.valueOf(node.get(\"platform\").asText())\n return DeviceLocale.fromString(code, platform)\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/serialization/DeviceSpecModule.kt", "content": "package maestro.device.serialization\n\nimport com.fasterxml.jackson.databind.module.SimpleModule\nimport maestro.device.locale.DeviceLocale\n\nclass DeviceSpecModule : SimpleModule(\"DeviceSpecModule\") {\n init {\n addSerializer(DeviceLocale::class.java, DeviceLocaleSerializer())\n addDeserializer(DeviceLocale::class.java, DeviceLocaleDeserializer())\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/util/AndroidEnvUtils.kt", "content": "package maestro.device.util\n\nimport maestro.device.DeviceError\nimport okio.buffer\nimport okio.source\nimport java.io.File\nimport java.nio.file.Path\nimport java.nio.file.Paths\nimport java.util.concurrent.TimeUnit\nimport java.util.concurrent.TimeoutException\n\nobject AndroidEnvUtils {\n\n private val androidHome: String?\n get() {\n return System.getenv(\"ANDROID_HOME\")\n ?: System.getenv(\"ANDROID_SDK_ROOT\")\n ?: System.getenv(\"ANDROID_SDK_HOME\")\n ?: System.getenv(\"ANDROID_SDK\")\n ?: System.getenv(\"ANDROID\")\n }\n\n private val androidUserHome: Path\n get() {\n if (System.getenv(\"ANDROID_USER_HOME\") != null) {\n return Paths.get(System.getenv(\"ANDROID_USER_HOME\"))\n }\n\n return Paths.get(System.getProperty(\"user.home\"), \".android\")\n }\n\n val androidAvdHome: File\n get() {\n System.getenv(\"ANDROID_AVD_HOME\")?.let { return File(it) }\n return androidUserHome.resolve(\"avd\").toFile()\n }\n\n /**\n * Returns SDK versions that are used by AVDs present in the system.\n */\n val androidEmulatorSdkVersions: List\n get() {\n val iniFiles = androidUserHome.resolve(\"avd\").toFile()\n .listFiles { file -> file.extension == \"ini\" }\n ?.map { it } ?: emptyList()\n\n val versions = iniFiles\n .mapNotNull { iniFile -> iniFile.readLines().firstOrNull { it.startsWith(\"target=\") } }\n .map { line -> line.split('=') }\n .filter { lineParts -> lineParts.size == 2 }\n .map { lineParts -> lineParts[1] }\n .distinct()\n .toList()\n\n return versions\n }\n\n /**\n * @return Path to java compatible android cmdline-tools\n */\n fun requireCommandLineTools(tool: String): File {\n val androidHome = androidHome\n ?: throw DeviceError(\"Could not detect Android home environment variable is not set. Ensure that either ANDROID_HOME or ANDROID_SDK_ROOT is set.\")\n\n val javaVersion = SystemInfo.getJavaVersion()\n val recommendedToolsVersion = getRecommendedToolsVersion()\n\n val tools = File(androidHome, \"cmdline-tools\")\n if (!tools.exists()) {\n throw DeviceError(\n \"Missing required component cmdline-tools. To install:\\n\" +\n \"1) Open Android Studio SDK manager \\n\" +\n \"2) Check \\\"Show package details\\\" to show all versions\\n\" +\n \"3) Install Android SDK Command-Line Tools. Recommended version: $recommendedToolsVersion\\n\" +\n \"* https://developer.android.com/studio/intro/update#sdk-manager\"\n )\n }\n\n return findCompatibleCommandLineTool(tool)\n ?: throw DeviceError(\n \"Unable to find compatible cmdline-tools ($tools/) for java version $javaVersion.\\n\\n\" +\n \"Try to install a different cmdline-tools version:\\n\" +\n \"1) Open Android Studio SDK manager \\n\" +\n \"2) Check \\\"Show package details\\\" to show all versions\\n\" +\n \"3) Install Android SDK Command-Line Tools. Recommended version: $recommendedToolsVersion\\n\" +\n \"* https://developer.android.com/studio/intro/update#sdk-manager\"\n )\n }\n\n private fun getRecommendedToolsVersion(): String {\n return when (SystemInfo.getJavaVersion()) {\n 8 -> \"8.0\"\n 11 -> \"10.0\"\n 17 -> \"11.0\"\n else -> \"latest\"\n }\n }\n\n private fun findCompatibleCommandLineTool(tool: String): File? {\n val path = File(androidHome, \"cmdline-tools\")\n\n var thisTool = tool\n if (EnvUtils.isWindows()){\n thisTool = \"$tool.bat\"\n }\n\n return path.listFiles()\n ?.filter { it.isDirectory && File(it, \"/bin/$thisTool\").exists() }\n ?.filter { isCommandLineToolCompatible(File(it, \"bin/$thisTool\")) }\n ?.sortedWith(compareBy { it.name != \"latest\" }\n .thenByDescending { it.name.toDoubleOrNull() })\n ?.map { File(it, \"bin/$thisTool\") }\n ?.firstOrNull()\n }\n\n /**\n * @return true if tool is compatible with running java version\n */\n private fun isCommandLineToolCompatible(toolPath: File): Boolean {\n return runCatching {\n val process = ProcessBuilder(listOf(toolPath.absolutePath, \"-h\")).start()\n if (!process.waitFor(20, TimeUnit.SECONDS)) throw TimeoutException()\n // don't rely on exit code, it's wrong\n val output = process.errorStream\n .source()\n .buffer()\n .readUtf8()\n return !output.contains(\"UnsupportedClassVersionError\", ignoreCase = true)\n }.getOrNull() ?: false\n }\n\n /**\n * @return parses a string from 'avdmanager list device' and returns the pixel devices\n */\n fun parsePixelDevices(input: String): List {\n val pattern = \"id: (\\\\d+) or \\\"(pixel.*?)\\\"\\\\n.*?Name: (.*?)\\\\n\".toRegex()\n return pattern.findAll(input)\n .map { matchResult ->\n AvdDevice(\n matchResult.groupValues[1],\n matchResult.groupValues[2],\n matchResult.groupValues[3]\n )\n }\n .toList()\n }\n\n fun requireEmulatorBinary(): File {\n val androidHome = androidHome\n ?: throw DeviceError(\"Could not detect Android home environment variable is not set. Ensure that either ANDROID_HOME or ANDROID_SDK_ROOT is set.\")\n val firstChoice = File(androidHome, \"emulator/emulator\")\n val secondChoice = File(androidHome, \"tools/emulator\")\n return firstChoice.takeIf { it.exists() } ?: secondChoice.takeIf { it.exists() }\n ?: throw DeviceError(\"Could not find emulator binary at either of the following paths:\\n$firstChoice\\n$secondChoice\")\n }\n}\n\n" }, { "path": "maestro-client/src/main/java/maestro/device/util/AvdDevice.kt", "content": "package maestro.device.util\n\ndata class AvdDevice(val numericId: String, val nameId: String, val name: String)\n" }, { "path": "maestro-client/src/main/java/maestro/device/util/CommandLineUtils.kt", "content": "package maestro.device.util\n\nimport okio.buffer\nimport okio.source\nimport org.slf4j.LoggerFactory\nimport java.io.File\nimport java.util.concurrent.TimeUnit\nimport java.util.concurrent.TimeoutException\n\nobject CommandLineUtils {\n\n private val isWindows = System.getProperty(\"os.name\").startsWith(\"Windows\")\n private val nullFile = File(if (isWindows) \"NUL\" else \"/dev/null\")\n private val logger = LoggerFactory.getLogger(CommandLineUtils::class.java)\n\n @Suppress(\"SpreadOperator\")\n fun runCommand(parts: List, waitForCompletion: Boolean = true, outputFile: File? = null, params: Map = emptyMap()): Process {\n logger.info(\"Running command line operation: $parts\")\n\n val processBuilder = if (outputFile != null) {\n ProcessBuilder(*parts.toTypedArray())\n .redirectOutput(outputFile)\n .redirectError(outputFile)\n } else {\n ProcessBuilder(*parts.toTypedArray())\n .redirectOutput(nullFile)\n .redirectError(ProcessBuilder.Redirect.PIPE)\n }\n\n processBuilder.environment().putAll(params)\n val process = processBuilder.start()\n\n if (waitForCompletion) {\n if (!process.waitFor(5, TimeUnit.MINUTES)) {\n throw TimeoutException()\n }\n\n if (process.exitValue() != 0) {\n val processOutput = process.errorStream\n .source()\n .buffer()\n .readUtf8()\n\n logger.error(\"Process failed with exit code ${process.exitValue()}\")\n logger.error(\"Error output $processOutput\")\n\n throw IllegalStateException(processOutput)\n }\n }\n\n return process\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/util/EnvUtils.kt", "content": "package maestro.device.util\n\nimport java.util.concurrent.TimeUnit\nimport java.util.concurrent.TimeoutException\n\nobject EnvUtils {\n val OS_NAME: String = System.getProperty(\"os.name\")\n val OS_ARCH: String = System.getProperty(\"os.arch\")\n val OS_VERSION: String = System.getProperty(\"os.version\")\n\n /**\n * @return true, if we're executing from Windows Linux shell (WSL)\n */\n fun isWSL(): Boolean {\n try {\n val p1 = ProcessBuilder(\"printenv\", \"WSL_DISTRO_NAME\").start()\n if (!p1.waitFor(20, TimeUnit.SECONDS)) throw TimeoutException()\n if (p1.exitValue() == 0 && String(p1.inputStream.readBytes()).trim().isNotEmpty()) {\n return true\n }\n\n val p2 = ProcessBuilder(\"printenv\", \"IS_WSL\").start()\n if (!p2.waitFor(20, TimeUnit.SECONDS)) throw TimeoutException()\n if (p2.exitValue() == 0 && String(p2.inputStream.readBytes()).trim().isNotEmpty()) {\n return true\n }\n } catch (ignore: Exception) {\n // ignore\n }\n\n return false\n }\n\n fun isWindows(): Boolean {\n return OS_NAME.lowercase().startsWith(\"windows\")\n }\n\n /**\n * Returns major version of Java, e.g. 8, 11, 17, 21.\n */\n fun getJavaVersion(): Int {\n // Adapted from https://stackoverflow.com/a/2591122/7009800\n val version = System.getProperty(\"java.version\")\n return if (version.startsWith(\"1.\")) {\n version.substring(2, 3).toInt()\n } else {\n val dot = version.indexOf(\".\")\n if (dot != -1) version.substring(0, dot).toInt() else 0\n }\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/util/PrintUtils.kt", "content": "package maestro.device.util\n\nimport org.slf4j.LoggerFactory\n\n/**\n * Simplified version of PrintUtils for DeviceService\n */\nobject PrintUtils {\n private val logger = LoggerFactory.getLogger(PrintUtils::class.java)\n\n fun message(message: String) {\n logger.info(message)\n println(message)\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/util/SimctlList.kt", "content": "package maestro.device.util\n\nimport com.fasterxml.jackson.annotation.JsonIgnoreProperties\n\n@JsonIgnoreProperties(ignoreUnknown = true)\ndata class SimctlList(\n val devicetypes: List,\n val runtimes: List,\n val devices: Map>,\n val pairs: Map,\n) {\n @JsonIgnoreProperties(ignoreUnknown = true)\n data class DeviceType(\n val identifier: String,\n val name: String,\n val bundlePath: String,\n val productFamily: String,\n val maxRuntimeVersion: Long?,\n val maxRuntimeVersionString: String?,\n val minRuntimeVersion: Long?,\n val minRuntimeVersionString: String?,\n val modelIdentifier: String?,\n )\n\n @JsonIgnoreProperties(ignoreUnknown = true)\n data class Runtime(\n val bundlePath: String,\n val buildversion: String,\n val platform: String?,\n val runtimeRoot: String,\n val identifier: String,\n val version: String,\n val isInternal: Boolean,\n val isAvailable: Boolean,\n val name: String,\n val supportedDeviceTypes: List,\n )\n\n @JsonIgnoreProperties(ignoreUnknown = true)\n data class Device(\n val name: String,\n val dataPath: String?,\n val logPath: String?,\n val udid: String,\n val isAvailable: Boolean,\n val deviceTypeIdentifier: String?,\n val state: String,\n val availabilityError: String?,\n )\n\n @JsonIgnoreProperties(ignoreUnknown = true)\n data class Pair(\n val watch: Device,\n val phone: Device,\n val state: String,\n )\n}\n" }, { "path": "maestro-client/src/main/java/maestro/device/util/SystemInfo.kt", "content": "package maestro.device.util\n\nobject SystemInfo {\n fun getJavaVersion(): Int {\n // Adapted from https://stackoverflow.com/a/2591122/7009800\n val version = System.getProperty(\"java.version\")\n return if (version.startsWith(\"1.\")) {\n version.substring(2, 3).toInt()\n } else {\n val dot = version.indexOf(\".\")\n if (dot != -1) version.substring(0, dot).toInt() else 0\n }\n }\n}\n\n" }, { "path": "maestro-client/src/main/java/maestro/drivers/AndroidDriver.kt", "content": "/*\n *\n * Copyright (c) 2022 mobile.dev inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n *\n *\n */\n\npackage maestro.drivers\n\nimport com.fasterxml.jackson.module.kotlin.jacksonObjectMapper\nimport com.google.protobuf.ByteString\nimport dadb.AdbShellPacket\nimport dadb.AdbShellResponse\nimport dadb.AdbShellStream\nimport dadb.Dadb\nimport io.grpc.ManagedChannelBuilder\nimport io.grpc.Metadata\nimport io.grpc.Status\nimport io.grpc.StatusRuntimeException\nimport maestro.*\nimport maestro.MaestroDriverStartupException.AndroidDriverTimeoutException\nimport maestro.MaestroDriverStartupException.AndroidInstrumentationSetupFailure\nimport maestro.UiElement.Companion.toUiElementOrNull\nimport maestro.android.AndroidAppFiles\nimport maestro.android.AndroidLaunchArguments.toAndroidLaunchArguments\nimport maestro.android.chromedevtools.AndroidWebViewHierarchyClient\nimport maestro.device.DeviceOrientation\nimport maestro.device.Platform\nimport maestro.utils.BlockingStreamObserver\nimport maestro.utils.MaestroTimer\nimport maestro.utils.Metrics\nimport maestro.utils.MetricsProvider\nimport maestro.utils.ScreenshotUtils\nimport maestro.utils.StringUtils.toRegexSafe\nimport maestro_android.*\nimport net.dongliu.apk.parser.ApkFile\nimport okio.*\nimport org.slf4j.LoggerFactory\nimport org.w3c.dom.Element\nimport org.w3c.dom.Node\nimport java.io.File\nimport java.io.IOException\nimport java.util.concurrent.CompletableFuture\nimport java.util.concurrent.Executors\nimport java.util.concurrent.TimeUnit\nimport java.util.concurrent.TimeoutException\nimport javax.xml.parsers.DocumentBuilderFactory\nimport kotlin.io.use\n\nprivate val logger = LoggerFactory.getLogger(Maestro::class.java)\n\nprivate const val DefaultDriverHostPort = 7001\n\nclass AndroidDriver(\n private val dadb: Dadb,\n hostPort: Int? = null,\n private var emulatorName: String = \"\",\n private val reinstallDriver: Boolean = true,\n private val metricsProvider: Metrics = MetricsProvider.getInstance(),\n ) : Driver {\n private var portForwarder: AutoCloseable? = null\n private var open = false\n private val hostPort: Int = hostPort ?: DefaultDriverHostPort\n\n private val metrics = metricsProvider.withPrefix(\"maestro.driver\").withTags(mapOf(\"platform\" to \"android\", \"emulatorName\" to emulatorName))\n\n private val channel = ManagedChannelBuilder.forAddress(\"localhost\", this.hostPort)\n .usePlaintext()\n .keepAliveTime(2, TimeUnit.MINUTES)\n .keepAliveTimeout(20, TimeUnit.SECONDS)\n .keepAliveWithoutCalls(true)\n .build()\n private val blockingStub = MaestroDriverGrpc.newBlockingStub(channel)\n private val blockingStubWithTimeout get() = blockingStub.withDeadlineAfter(120, TimeUnit.SECONDS)\n private val asyncStub = MaestroDriverGrpc.newStub(channel)\n private val documentBuilderFactory = DocumentBuilderFactory.newInstance()\n\n private val androidWebViewHierarchyClient = AndroidWebViewHierarchyClient(dadb)\n\n private var instrumentationSession: AdbShellStream? = null\n private var proxySet = false\n\n private var isLocationMocked = false\n private var chromeDevToolsEnabled = false\n\n override fun name(): String {\n return \"Android Device ($dadb)\"\n }\n\n override fun open() {\n allocateForwarder()\n installMaestroApks()\n startInstrumentationSession(hostPort)\n\n try {\n awaitLaunch()\n } catch (ignored: InterruptedException) {\n instrumentationSession?.close()\n return\n }\n }\n\n private fun startInstrumentationSession(port: Int = 7001) {\n val startTime = System.currentTimeMillis()\n val apiLevel = getDeviceApiLevel()\n\n val instrumentationCommand = buildString {\n append(\"am instrument -w \")\n if (apiLevel >= 26) append(\"-m \")\n append(\"-e debug false \")\n append(\"-e class 'dev.mobile.maestro.MaestroDriverService#grpcServer' \")\n append(\"-e port $port \")\n append(\"dev.mobile.maestro.test/androidx.test.runner.AndroidJUnitRunner &\\n\")\n }\n\n open = true\n while (System.currentTimeMillis() - startTime < getStartupTimeout()) {\n instrumentationSession = dadb.openShell(instrumentationCommand)\n\n if (instrumentationSession.successfullyStarted()) {\n return\n }\n\n instrumentationSession?.close()\n Thread.sleep(100)\n }\n throw AndroidInstrumentationSetupFailure(\"Maestro instrumentation could not be initialized\")\n }\n\n private fun getDeviceApiLevel(): Int {\n val response = dadb.openShell(\"getprop ro.build.version.sdk\").readAll()\n if (response.exitCode != 0) {\n throw IOException(\"Failed to get device API level: ${response.errorOutput}\")\n }\n return response.output.trim().toIntOrNull() ?: throw IOException(\"Invalid API level: ${response.output}\")\n }\n\n\n private fun allocateForwarder() {\n portForwarder?.close()\n\n portForwarder = dadb.tcpForward(\n hostPort,\n hostPort\n )\n }\n\n private fun awaitLaunch() {\n val startTime = System.currentTimeMillis()\n\n while (System.currentTimeMillis() - startTime < getStartupTimeout()) {\n runCatching {\n dadb.open(\"tcp:$hostPort\").close()\n return\n }\n Thread.sleep(100)\n }\n\n throw AndroidDriverTimeoutException(\"Maestro Android driver did not start up in time --- emulator [ ${emulatorName} ] & port [ dadb.open( tcp:${hostPort} ) ]\")\n }\n\n override fun close() {\n if (proxySet) {\n resetProxy()\n }\n if (isLocationMocked) {\n blockingStubWithTimeout.disableLocationUpdates(emptyRequest { })\n isLocationMocked = false\n }\n\n LOGGER.info(\"[Start] close port forwarder\")\n portForwarder?.close()\n LOGGER.info(\"[Done] close port forwarder\")\n\n LOGGER.info(\"[Start] Uninstall driver from device\")\n if (reinstallDriver) {\n uninstallMaestroDriverApp()\n }\n if (reinstallDriver) {\n uninstallMaestroServerApp()\n }\n LOGGER.info(\"[Done] Uninstall driver from device\")\n\n LOGGER.info(\"[Start] Close instrumentation session\")\n instrumentationSession?.close()\n instrumentationSession = null\n LOGGER.info(\"[Done] Close instrumentation session\")\n\n LOGGER.info(\"[Start] Shutdown GRPC channel\")\n channel.shutdown()\n LOGGER.info(\"[Done] Shutdown GRPC channel\")\n\n androidWebViewHierarchyClient.close()\n\n if (!channel.awaitTermination(5, TimeUnit.SECONDS)) {\n throw TimeoutException(\"Couldn't close Maestro Android driver due to gRPC timeout\")\n }\n }\n\n override fun deviceInfo(): DeviceInfo {\n return runDeviceCall(\"deviceInfo\") {\n val response = blockingStubWithTimeout.deviceInfo(deviceInfoRequest {})\n\n DeviceInfo(\n platform = Platform.ANDROID,\n widthPixels = response.widthPixels,\n heightPixels = response.heightPixels,\n widthGrid = response.widthPixels,\n heightGrid = response.heightPixels,\n )\n }\n }\n\n override fun launchApp(\n appId: String,\n launchArguments: Map,\n ) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"launchApp\", \"appId\" to appId)) {\n if(!open) // pick device flow, no open() invocation\n open()\n\n if (!isPackageInstalled(appId)) {\n throw IllegalArgumentException(\"Package $appId is not installed\")\n }\n\n val arguments = launchArguments.toAndroidLaunchArguments()\n runDeviceCall(\"launchApp\") {\n blockingStubWithTimeout.launchApp(\n launchAppRequest {\n this.packageName = appId\n this.arguments.addAll(arguments)\n }\n ) ?: throw IllegalStateException(\"Maestro driver failed to launch app\")\n }\n }\n }\n\n override fun stopApp(appId: String) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"stopApp\", \"appId\" to appId)) {\n // Note: If the package does not exist, this call does *not* throw an exception\n shell(\"am force-stop $appId\")\n }\n }\n\n override fun killApp(appId: String) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"killApp\", \"appId\" to appId)) {\n // Kill is the adb command needed to trigger System-initiated Process Death\n shell(\"am kill $appId\")\n }\n }\n\n override fun clearAppState(appId: String) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"clearAppState\", \"appId\" to appId)) {\n if (!isPackageInstalled(appId)) {\n return@measured\n }\n\n shell(\"pm clear $appId\")\n }\n }\n\n override fun clearKeychain() {\n // No op\n }\n\n override fun tap(point: Point) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"tap\")) {\n runDeviceCall(\"tap\") {\n blockingStubWithTimeout.tap(\n tapRequest {\n x = point.x\n y = point.y\n }\n ) ?: throw IllegalStateException(\"Response can't be null\")\n }\n }\n }\n\n override fun longPress(point: Point) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"longPress\")) {\n dadb.shell(\"input swipe ${point.x} ${point.y} ${point.x} ${point.y} 3000\")\n }\n }\n\n override fun pressKey(code: KeyCode) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"pressKey\")) {\n val intCode: Int = when (code) {\n KeyCode.ENTER -> 66\n KeyCode.BACKSPACE -> 67\n KeyCode.BACK -> 4\n KeyCode.VOLUME_UP -> 24\n KeyCode.VOLUME_DOWN -> 25\n KeyCode.HOME -> 3\n KeyCode.LOCK -> 276\n KeyCode.REMOTE_UP -> 19\n KeyCode.REMOTE_DOWN -> 20\n KeyCode.REMOTE_LEFT -> 21\n KeyCode.REMOTE_RIGHT -> 22\n KeyCode.REMOTE_CENTER -> 23\n KeyCode.REMOTE_PLAY_PAUSE -> 85\n KeyCode.REMOTE_STOP -> 86\n KeyCode.REMOTE_NEXT -> 87\n KeyCode.REMOTE_PREVIOUS -> 88\n KeyCode.REMOTE_REWIND -> 89\n KeyCode.REMOTE_FAST_FORWARD -> 90\n KeyCode.POWER -> 26\n KeyCode.ESCAPE -> 111\n KeyCode.TAB -> 62\n KeyCode.REMOTE_SYSTEM_NAVIGATION_UP -> 280\n KeyCode.REMOTE_SYSTEM_NAVIGATION_DOWN -> 281\n KeyCode.REMOTE_BUTTON_A -> 96\n KeyCode.REMOTE_BUTTON_B -> 97\n KeyCode.REMOTE_MENU -> 82\n KeyCode.TV_INPUT -> 178\n KeyCode.TV_INPUT_HDMI_1 -> 243\n KeyCode.TV_INPUT_HDMI_2 -> 244\n KeyCode.TV_INPUT_HDMI_3 -> 245\n }\n\n dadb.shell(\"input keyevent $intCode\")\n Thread.sleep(300)\n }\n }\n\n override fun contentDescriptor(excludeKeyboardElements: Boolean): TreeNode {\n return metrics.measured(\"operation\", mapOf(\"command\" to \"contentDescriptor\")) {\n val response = callViewHierarchy()\n\n val document = documentBuilderFactory\n .newDocumentBuilder()\n .parse(response.hierarchy.byteInputStream())\n\n val baseTree = mapHierarchy(document)\n\n val treeNode = androidWebViewHierarchyClient.augmentHierarchy(baseTree, chromeDevToolsEnabled)\n\n if (excludeKeyboardElements) {\n treeNode.excludeKeyboardElements() ?: treeNode\n } else {\n treeNode\n }\n }\n }\n\n private fun TreeNode.excludeKeyboardElements(): TreeNode? {\n val filtered = children.mapNotNull {\n it.excludeKeyboardElements()\n }.toList()\n\n val resourceId = attributes[\"resource-id\"]\n if (resourceId != null && resourceId.startsWith(\"com.google.android.inputmethod.latin:id/\")) {\n return null\n }\n return TreeNode(\n attributes = attributes,\n children = filtered,\n clickable = clickable,\n enabled = enabled,\n focused = focused,\n checked = checked,\n selected = selected\n )\n }\n\n private fun callViewHierarchy(attempt: Int = 1): MaestroAndroid.ViewHierarchyResponse {\n return try {\n blockingStubWithTimeout.viewHierarchy(viewHierarchyRequest {})\n } catch (throwable: StatusRuntimeException) {\n val status = Status.fromThrowable(throwable)\n when (status.code) {\n Status.Code.DEADLINE_EXCEEDED -> {\n LOGGER.error(\"Timeout while fetching view hierarchy\")\n throw throwable\n }\n Status.Code.UNAVAILABLE -> {\n if (throwable.cause is IOException || throwable.message?.contains(\"io exception\", ignoreCase = true) == true) {\n LOGGER.error(\"Not able to reach the gRPC server while fetching view hierarchy\")\n } else {\n LOGGER.error(\"Received UNAVAILABLE status with message: ${throwable.message}\")\n }\n }\n else -> {\n LOGGER.error(\"Unexpected error: ${status.code} - ${throwable.message}\")\n }\n }\n\n // There is a bug in Android UiAutomator that rarely throws an NPE while dumping a view hierarchy.\n // Trying to recover once by giving it a bit of time to settle.\n LOGGER.error(\"Failed to get view hierarchy: ${status.description}\", throwable)\n\n if (attempt > 0) {\n MaestroTimer.sleep(MaestroTimer.Reason.BUFFER, 1000L)\n return callViewHierarchy(attempt - 1)\n }\n throw throwable\n }\n }\n\n override fun scrollVertical() {\n metrics.measured(\"operation\", mapOf(\"command\" to \"scrollVertical\")) {\n swipe(SwipeDirection.UP, 400)\n }\n }\n\n override fun isKeyboardVisible(): Boolean {\n return metrics.measured(\"operation\", mapOf(\"command\" to \"isKeyboardVisible\")) {\n val root = contentDescriptor().let {\n val deviceInfo = deviceInfo()\n val filtered = it.filterOutOfBounds(\n width = deviceInfo.widthGrid,\n height = deviceInfo.heightGrid\n )\n filtered ?: it\n }\n \"com.google.android.inputmethod.latin:id\" in jacksonObjectMapper().writeValueAsString(root)\n }\n }\n\n override fun swipe(start: Point, end: Point, durationMs: Long) {\n dadb.shell(\"input swipe ${start.x} ${start.y} ${end.x} ${end.y} $durationMs\")\n }\n\n override fun swipe(swipeDirection: SwipeDirection, durationMs: Long) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"swipeWithDirection\", \"direction\" to swipeDirection.name, \"durationMs\" to durationMs.toString())) {\n val deviceInfo = deviceInfo()\n when (swipeDirection) {\n SwipeDirection.UP -> {\n val startX = (deviceInfo.widthGrid * 0.5f).toInt()\n val startY = (deviceInfo.heightGrid * 0.5f).toInt()\n val endX = (deviceInfo.widthGrid * 0.5f).toInt()\n val endY = (deviceInfo.heightGrid * 0.1f).toInt()\n directionalSwipe(\n durationMs,\n Point(startX, startY),\n Point(endX, endY)\n )\n }\n\n SwipeDirection.DOWN -> {\n val startX = (deviceInfo.widthGrid * 0.5f).toInt()\n val startY = (deviceInfo.heightGrid * 0.2f).toInt()\n val endX = (deviceInfo.widthGrid * 0.5f).toInt()\n val endY = (deviceInfo.heightGrid * 0.9f).toInt()\n directionalSwipe(\n durationMs,\n Point(startX, startY),\n Point(endX, endY)\n )\n }\n\n SwipeDirection.RIGHT -> {\n val startX = (deviceInfo.widthGrid * 0.1f).toInt()\n val startY = (deviceInfo.heightGrid * 0.5f).toInt()\n val endX = (deviceInfo.widthGrid * 0.9f).toInt()\n val endY = (deviceInfo.heightGrid * 0.5f).toInt()\n directionalSwipe(\n durationMs,\n Point(startX, startY),\n Point(endX, endY)\n )\n }\n\n SwipeDirection.LEFT -> {\n val startX = (deviceInfo.widthGrid * 0.9f).toInt()\n val startY = (deviceInfo.heightGrid * 0.5f).toInt()\n val endX = (deviceInfo.widthGrid * 0.1f).toInt()\n val endY = (deviceInfo.heightGrid * 0.5f).toInt()\n directionalSwipe(\n durationMs,\n Point(startX, startY),\n Point(endX, endY)\n )\n }\n }\n }\n }\n\n override fun swipe(elementPoint: Point, direction: SwipeDirection, durationMs: Long) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"swipeWithElementPoint\", \"direction\" to direction.name, \"durationMs\" to durationMs.toString())) {\n val deviceInfo = deviceInfo()\n when (direction) {\n SwipeDirection.UP -> {\n val endY = (deviceInfo.heightGrid * 0.1f).toInt()\n directionalSwipe(durationMs, elementPoint, Point(elementPoint.x, endY))\n }\n\n SwipeDirection.DOWN -> {\n val endY = (deviceInfo.heightGrid * 0.9f).toInt()\n directionalSwipe(durationMs, elementPoint, Point(elementPoint.x, endY))\n }\n\n SwipeDirection.RIGHT -> {\n val endX = (deviceInfo.widthGrid * 0.9f).toInt()\n directionalSwipe(durationMs, elementPoint, Point(endX, elementPoint.y))\n }\n\n SwipeDirection.LEFT -> {\n val endX = (deviceInfo.widthGrid * 0.1f).toInt()\n directionalSwipe(durationMs, elementPoint, Point(endX, elementPoint.y))\n }\n }\n }\n }\n\n private fun directionalSwipe(durationMs: Long, start: Point, end: Point) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"directionalSwipe\", \"durationMs\" to durationMs.toString())) {\n dadb.shell(\"input swipe ${start.x} ${start.y} ${end.x} ${end.y} $durationMs\")\n }\n }\n\n override fun backPress() {\n metrics.measured(\"operation\", mapOf(\"command\" to \"backPress\")) {\n dadb.shell(\"input keyevent 4\")\n Thread.sleep(300)\n }\n }\n\n override fun hideKeyboard() {\n metrics.measured(\"operation\", mapOf(\"command\" to \"hideKeyboard\")) {\n dadb.shell(\"input keyevent 4\") // 'Back', which dismisses the keyboard before handing over to navigation\n Thread.sleep(300)\n waitForAppToSettle(null, null)\n }\n }\n\n override fun takeScreenshot(out: Sink, compressed: Boolean) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"takeScreenshot\", \"compressed\" to compressed.toString())) {\n runDeviceCall(\"takeScreenshot\") {\n val response = blockingStubWithTimeout.screenshot(screenshotRequest {})\n out.buffer().use {\n it.write(response.bytes.toByteArray())\n }\n }\n }\n }\n\n override fun startScreenRecording(out: Sink): ScreenRecording {\n return metrics.measured(\"operation\", mapOf(\"command\" to \"startScreenRecording\")) {\n\n val deviceScreenRecordingPath = \"/sdcard/maestro-screenrecording.mp4\"\n\n val future = CompletableFuture.runAsync({\n val timeLimit = if (getDeviceApiLevel() >= 34) \"--time-limit 0\" else \"\"\n try {\n shell(\"screenrecord $timeLimit --bit-rate '100000' $deviceScreenRecordingPath\")\n } catch (e: IOException) {\n throw IOException(\n \"Failed to capture screen recording on the device. Note that some Android emulators do not support screen recording. \" +\n \"Try using a different Android emulator (eg. Pixel 5 / API 30)\",\n e,\n )\n }\n }, Executors.newSingleThreadExecutor())\n\n object : ScreenRecording {\n override fun close() {\n dadb.shell(\"killall -INT screenrecord\") // Ignore exit code\n future.get()\n Thread.sleep(3000)\n dadb.pull(out, deviceScreenRecordingPath)\n }\n }\n }\n }\n\n override fun inputText(text: String) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"inputText\")) {\n runDeviceCall(\"inputText\") {\n blockingStubWithTimeout.inputText(inputTextRequest {\n this.text = text\n }) ?: throw IllegalStateException(\"Input Response can't be null\")\n }\n }\n }\n\n override fun openLink(link: String, appId: String?, autoVerify: Boolean, browser: Boolean) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"openLink\", \"appId\" to appId, \"autoVerify\" to autoVerify.toString(), \"browser\" to browser.toString())) {\n if (browser) {\n openBrowser(link)\n } else {\n dadb.shell(\"am start -a android.intent.action.VIEW -d \\\"$link\\\"\")\n }\n\n if (autoVerify) {\n autoVerifyApp(appId)\n }\n }\n }\n\n private fun autoVerifyApp(appId: String?) {\n if (appId != null) {\n autoVerifyWithAppName(appId)\n }\n autoVerifyChromeAgreement()\n }\n\n private fun autoVerifyWithAppName(appId: String) {\n val appNameResult = runCatching {\n val apkFile = AndroidAppFiles.getApkFile(dadb, appId)\n val appName = ApkFile(apkFile).apkMeta.name\n apkFile.delete()\n appName\n }\n if (appNameResult.isSuccess) {\n val appName = appNameResult.getOrThrow()\n waitUntilScreenIsStatic(3000)\n val appNameElement = filterByText(appName)\n if (appNameElement != null) {\n tap(appNameElement.bounds.center())\n filterById(\"android:id/button_once\")?.let {\n tap(it.bounds.center())\n }\n } else {\n val openWithAppElement = filterByText(\".*$appName.*\")\n if (openWithAppElement != null) {\n filterById(\"android:id/button_once\")?.let {\n tap(it.bounds.center())\n }\n }\n }\n }\n }\n\n private fun autoVerifyChromeAgreement() {\n filterById(\"com.android.chrome:id/terms_accept\")?.let { tap(it.bounds.center()) }\n waitForAppToSettle(null, null)\n filterById(\"com.android.chrome:id/negative_button\")?.let { tap(it.bounds.center()) }\n }\n\n private fun filterByText(textRegex: String): UiElement? {\n val textMatcher = Filters.textMatches(textRegex.toRegexSafe(REGEX_OPTIONS))\n val filterFunc = Filters.deepestMatchingElement(textMatcher)\n return filterFunc(contentDescriptor().aggregate()).firstOrNull()?.toUiElementOrNull()\n }\n\n private fun filterById(idRegex: String): UiElement? {\n val idMatcher = Filters.idMatches(idRegex.toRegexSafe(REGEX_OPTIONS))\n val filterFunc = Filters.deepestMatchingElement(idMatcher)\n return filterFunc(contentDescriptor().aggregate()).firstOrNull()?.toUiElementOrNull()\n }\n\n private fun openBrowser(link: String) {\n val installedPackages = installedPackages()\n when {\n installedPackages.contains(\"com.android.chrome\") -> {\n dadb.shell(\"am start -a android.intent.action.VIEW -d \\\"$link\\\" com.android.chrome\")\n }\n\n installedPackages.contains(\"org.mozilla.firefox\") -> {\n dadb.shell(\"am start -a android.intent.action.VIEW -d \\\"$link\\\" org.mozilla.firefox\")\n }\n\n else -> {\n dadb.shell(\"am start -a android.intent.action.VIEW -d \\\"$link\\\"\")\n }\n }\n }\n\n private fun installedPackages() = shell(\"pm list packages\").split(\"\\n\")\n .map { line: String -> line.split(\":\".toRegex()).toTypedArray() }\n .filter { parts: Array -> parts.size == 2 }\n .map { parts: Array -> parts[1] }\n\n override fun setLocation(latitude: Double, longitude: Double) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"setLocation\")) {\n if (!isLocationMocked) {\n LOGGER.info(\"[Start] Setting up for mocking location $latitude, $longitude\")\n shell(\"pm grant dev.mobile.maestro android.permission.ACCESS_FINE_LOCATION\")\n shell(\"pm grant dev.mobile.maestro android.permission.ACCESS_COARSE_LOCATION\")\n shell(\"appops set dev.mobile.maestro android:mock_location allow\")\n runDeviceCall(\"enableMockLocationProviders\") {\n blockingStubWithTimeout.enableMockLocationProviders(emptyRequest { })\n }\n LOGGER.info(\"[Done] Setting up for mocking location $latitude, $longitude\")\n\n isLocationMocked = true\n }\n\n runDeviceCall(\"setLocation\") {\n blockingStubWithTimeout.setLocation(\n setLocationRequest {\n this.latitude = latitude\n this.longitude = longitude\n }\n ) ?: error(\"Set Location Response can't be null\")\n }\n }\n }\n\n override fun setOrientation(orientation: DeviceOrientation) {\n // Disable accelerometer based rotation before overriding orientation\n dadb.shell(\"settings put system accelerometer_rotation 0\")\n\n when(orientation) {\n DeviceOrientation.PORTRAIT -> dadb.shell(\"settings put system user_rotation 0\")\n DeviceOrientation.LANDSCAPE_LEFT -> dadb.shell(\"settings put system user_rotation 1\")\n DeviceOrientation.UPSIDE_DOWN -> dadb.shell(\"settings put system user_rotation 2\")\n DeviceOrientation.LANDSCAPE_RIGHT -> dadb.shell(\"settings put system user_rotation 3\")\n }\n }\n\n override fun eraseText(charactersToErase: Int) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"eraseText\", \"charactersToErase\" to charactersToErase.toString())) {\n runDeviceCall(\"eraseText\") {\n blockingStubWithTimeout.eraseAllText(\n eraseAllTextRequest {\n this.charactersToErase = charactersToErase\n }\n ) ?: throw IllegalStateException(\"Erase Response can't be null\")\n }\n }\n }\n\n override fun setProxy(host: String, port: Int) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"setProxy\")) {\n shell(\"\"\"settings put global http_proxy \"${host}:${port}\"\"\"\")\n proxySet = true\n }\n }\n\n override fun resetProxy() {\n metrics.measured(\"operation\", mapOf(\"command\" to \"resetProxy\")) {\n shell(\"settings put global http_proxy :0\")\n }\n }\n\n override fun isShutdown(): Boolean {\n return metrics.measured(\"operation\", mapOf(\"command\" to \"isShutdown\")) {\n channel.isShutdown\n }\n }\n\n override fun isUnicodeInputSupported(): Boolean {\n return false\n }\n\n override fun waitForAppToSettle(initialHierarchy: ViewHierarchy?, appId: String?, timeoutMs: Int?): ViewHierarchy? {\n return metrics.measured(\"operation\", mapOf(\"command\" to \"waitForAppToSettle\", \"appId\" to appId, \"timeoutMs\" to timeoutMs.toString())) {\n if (appId != null) {\n waitForWindowToSettle(appId, initialHierarchy, timeoutMs)\n } else {\n ScreenshotUtils.waitForAppToSettle(initialHierarchy, this, timeoutMs)\n }\n }\n }\n\n private fun waitForWindowToSettle(\n appId: String,\n initialHierarchy: ViewHierarchy?,\n timeoutMs: Int? = null\n ): ViewHierarchy {\n val endTime = System.currentTimeMillis() + WINDOW_UPDATE_TIMEOUT_MS\n var hierarchy: ViewHierarchy? = null\n do {\n runDeviceCall(\"isWindowUpdating\") {\n val windowUpdating = blockingStubWithTimeout.isWindowUpdating(checkWindowUpdatingRequest {\n this.appId = appId\n }).isWindowUpdating\n\n if (windowUpdating) {\n hierarchy = ScreenshotUtils.waitForAppToSettle(initialHierarchy, this, timeoutMs)\n }\n }\n } while (System.currentTimeMillis() < endTime)\n\n return hierarchy ?: ScreenshotUtils.waitForAppToSettle(initialHierarchy, this)\n }\n\n override fun waitUntilScreenIsStatic(timeoutMs: Long): Boolean {\n return metrics.measured(\"operation\", mapOf(\"command\" to \"waitUntilScreenIsStatic\", \"timeoutMs\" to timeoutMs.toString())) {\n ScreenshotUtils.waitUntilScreenIsStatic(timeoutMs, SCREENSHOT_DIFF_THRESHOLD, this)\n }\n }\n\n override fun capabilities(): List {\n return metrics.measured(\"operation\", mapOf(\"command\" to \"capabilities\")) {\n listOf(\n Capability.FAST_HIERARCHY\n )\n }\n }\n\n override fun setPermissions(appId: String, permissions: Map) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"setPermissions\", \"appId\" to appId)) {\n val mutable = permissions.toMutableMap()\n mutable.remove(\"all\")?.let { value ->\n setAllPermissions(appId, value)\n }\n\n mutable.forEach { permission ->\n val permissionValue = translatePermissionValue(permission.value)\n translatePermissionName(permission.key).forEach { permissionName ->\n setPermissionInternal(appId, permissionName, permissionValue)\n }\n }\n }\n }\n\n override fun addMedia(mediaFiles: List) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"addMedia\", \"mediaFilesCount\" to mediaFiles.size.toString())) {\n LOGGER.info(\"[Start] Adding media files\")\n mediaFiles.forEach { addMediaToDevice(it) }\n LOGGER.info(\"[Done] Adding media files\")\n }\n }\n\n override fun isAirplaneModeEnabled(): Boolean {\n return metrics.measured(\"operation\", mapOf(\"command\" to \"isAirplaneModeEnabled\")) {\n when (val result = shell(\"cmd connectivity airplane-mode\").trim()) {\n \"No shell command implementation.\", \"\" -> {\n LOGGER.debug(\"Falling back to old airplane mode read method\")\n when (val fallbackResult = shell(\"settings get global airplane_mode_on\").trim()) {\n \"0\" -> false\n \"1\" -> true\n else -> throw IllegalStateException(\"Received invalid response from while trying to read airplane mode state: $fallbackResult\")\n }\n }\n\n \"disabled\" -> false\n \"enabled\" -> true\n else -> throw IllegalStateException(\"Received invalid response while trying to read airplane mode state: $result\")\n }\n }\n }\n\n override fun setAirplaneMode(enabled: Boolean) {\n metrics.measured(\"operation\", mapOf(\"command\" to \"setAirplaneMode\", \"enabled\" to enabled.toString())) {\n // fallback to old way on API < 28\n if (getDeviceApiLevel() < 28) {\n val num = if (enabled) 1 else 0\n shell(\"settings put global airplane_mode_on $num\")\n // We need to broadcast the change to really apply it\n broadcastAirplaneMode(enabled)\n return@measured\n }\n val value = if (enabled) \"enable\" else \"disable\"\n shell(\"cmd connectivity airplane-mode $value\")\n }\n }\n\n private fun broadcastAirplaneMode(enabled: Boolean) {\n val command = \"am broadcast -a android.intent.action.AIRPLANE_MODE --ez state $enabled\"\n try {\n shell(command)\n } catch (e: IOException) {\n if (e.message?.contains(\"Security exception: Permission Denial:\") == true) {\n try {\n shell(\"su root $command\")\n } catch (e: IOException) {\n throw MaestroException.NoRootAccess(\"Failed to broadcast airplane mode change. Make sure to run an emulator with root access for API < 28\")\n }\n }\n }\n }\n\n override fun setAndroidChromeDevToolsEnabled(enabled: Boolean) {\n this.chromeDevToolsEnabled = enabled\n }\n\n fun setDeviceLocale(country: String, language: String): Int {\n return metrics.measured(\"operation\", mapOf(\"command\" to \"setDeviceLocale\", \"country\" to country, \"language\" to language)) {\n dadb.shell(\"pm grant dev.mobile.maestro android.permission.CHANGE_CONFIGURATION\")\n val response =\n dadb.shell(\"am broadcast -a dev.mobile.maestro.locale -n dev.mobile.maestro/.receivers.LocaleSettingReceiver --es lang $language --es country $country\")\n extractSetLocaleResult(response.output)\n }\n }\n\n private fun extractSetLocaleResult(result: String): Int {\n val regex = Regex(\"result=(-?\\\\d+)\")\n val match = regex.find(result)\n return match?.groups?.get(1)?.value?.toIntOrNull() ?: -1\n }\n\n private fun addMediaToDevice(mediaFile: File) {\n val namedSource = NamedSource(\n mediaFile.name,\n mediaFile.source(),\n mediaFile.extension,\n mediaFile.path\n )\n val responseObserver = BlockingStreamObserver()\n val requestStream = asyncStub.addMedia(responseObserver)\n val ext =\n MediaExt.values().firstOrNull { it.extName == namedSource.extension } ?: throw IllegalArgumentException(\n \"Extension .${namedSource.extension} is not yet supported for add media\"\n )\n\n val buffer = Buffer()\n val source = namedSource.source\n while (source.read(buffer, CHUNK_SIZE) != -1L) {\n requestStream.onNext(\n addMediaRequest {\n this.payload = payload {\n data = ByteString.copyFrom(buffer.readByteArray())\n }\n this.mediaName = namedSource.name\n this.mediaExt = ext.extName\n }\n )\n buffer.clear()\n }\n source.close()\n requestStream.onCompleted()\n responseObserver.awaitResult()\n }\n\n private fun setAllPermissions(appId: String, permissionValue: String) {\n val permissionsResult = runCatching {\n val apkFile = AndroidAppFiles.getApkFile(dadb, appId)\n val permissions = ApkFile(apkFile).apkMeta.usesPermissions\n apkFile.delete()\n permissions\n }\n if (permissionsResult.isSuccess) {\n permissionsResult.getOrNull()?.let {\n it.forEach { permission ->\n setPermissionInternal(appId, permission, translatePermissionValue(permissionValue))\n }\n }\n }\n }\n\n private fun setPermissionInternal(appId: String, permission: String, permissionValue: String) {\n try {\n shell(\"pm $permissionValue $appId $permission\")\n } catch (exception: Exception) {\n // Ignore if it's something that the user doesn't have control over (e.g. you can't grant / deny INTERNET)\n if (exception.message?.contains(\"is not a changeable permission type\") == false) {\n // Debug level is fine.\n // We don't need to be loud about this. IOExceptions were already caught in shell(..)\n // Remaining issues are likely due to \"all\" containing permissions that the app doesn't support.\n logger.debug(\"Failed to set permission $permission for app $appId: ${exception.message}\")\n }\n }\n }\n\n private fun translatePermissionName(name: String): List {\n return when (name) {\n \"location\" -> listOf(\n \"android.permission.ACCESS_FINE_LOCATION\",\n \"android.permission.ACCESS_COARSE_LOCATION\",\n )\n\n \"camera\" -> listOf(\"android.permission.CAMERA\")\n \"contacts\" -> listOf(\n \"android.permission.READ_CONTACTS\",\n \"android.permission.WRITE_CONTACTS\"\n )\n\n \"phone\" -> listOf(\n \"android.permission.CALL_PHONE\",\n \"android.permission.ANSWER_PHONE_CALLS\",\n )\n\n \"microphone\" -> listOf(\n \"android.permission.RECORD_AUDIO\"\n )\n\n \"bluetooth\" -> listOf(\n \"android.permission.BLUETOOTH_CONNECT\",\n \"android.permission.BLUETOOTH_SCAN\",\n )\n\n \"storage\" -> listOf(\n \"android.permission.WRITE_EXTERNAL_STORAGE\",\n \"android.permission.READ_EXTERNAL_STORAGE\"\n )\n\n \"notifications\" -> listOf(\n \"android.permission.POST_NOTIFICATIONS\"\n )\n\n \"medialibrary\" -> listOf(\n \"android.permission.WRITE_EXTERNAL_STORAGE\",\n \"android.permission.READ_EXTERNAL_STORAGE\",\n \"android.permission.READ_MEDIA_AUDIO\",\n \"android.permission.READ_MEDIA_IMAGES\",\n \"android.permission.READ_MEDIA_VIDEO\"\n )\n\n \"calendar\" -> listOf(\n \"android.permission.WRITE_CALENDAR\",\n \"android.permission.READ_CALENDAR\"\n )\n\n \"sms\" -> listOf(\n \"android.permission.READ_SMS\",\n \"android.permission.RECEIVE_SMS\",\n \"android.permission.SEND_SMS\"\n )\n\n else -> listOf(name.replace(\"[^A-Za-z0-9._]+\".toRegex(), \"\"))\n }\n }\n\n private fun translatePermissionValue(value: String): String {\n return when (value) {\n \"allow\" -> \"grant\"\n \"deny\" -> \"revoke\"\n \"unset\" -> \"revoke\"\n else -> \"revoke\"\n }\n }\n\n private fun mapHierarchy(node: Node): TreeNode {\n val attributes = if (node is Element) {\n val attributesBuilder = mutableMapOf()\n\n if (node.hasAttribute(\"text\")) {\n val text = node.getAttribute(\"text\")\n attributesBuilder[\"text\"] = text\n }\n\n if (node.hasAttribute(\"content-desc\")) {\n attributesBuilder[\"accessibilityText\"] = node.getAttribute(\"content-desc\")\n }\n\n if (node.hasAttribute(\"hintText\")) {\n attributesBuilder[\"hintText\"] = node.getAttribute(\"hintText\")\n }\n\n if (node.hasAttribute(\"class\") && node.getAttribute(\"class\") == TOAST_CLASS_NAME) {\n attributesBuilder[\"ignoreBoundsFiltering\"] = true.toString()\n } else {\n attributesBuilder[\"ignoreBoundsFiltering\"] = false.toString()\n }\n\n if (node.hasAttribute(\"resource-id\")) {\n attributesBuilder[\"resource-id\"] = node.getAttribute(\"resource-id\")\n }\n\n if (node.hasAttribute(\"clickable\")) {\n attributesBuilder[\"clickable\"] = node.getAttribute(\"clickable\")\n }\n\n if (node.hasAttribute(\"bounds\")) {\n attributesBuilder[\"bounds\"] = node.getAttribute(\"bounds\")\n }\n\n if (node.hasAttribute(\"enabled\")) {\n attributesBuilder[\"enabled\"] = node.getAttribute(\"enabled\")\n }\n\n if (node.hasAttribute(\"focused\")) {\n attributesBuilder[\"focused\"] = node.getAttribute(\"focused\")\n }\n\n if (node.hasAttribute(\"checked\")) {\n attributesBuilder[\"checked\"] = node.getAttribute(\"checked\")\n }\n\n if (node.hasAttribute(\"scrollable\")) {\n attributesBuilder[\"scrollable\"] = node.getAttribute(\"scrollable\")\n }\n\n if (node.hasAttribute(\"selected\")) {\n attributesBuilder[\"selected\"] = node.getAttribute(\"selected\")\n }\n\n if (node.hasAttribute(\"class\")) {\n attributesBuilder[\"class\"] = node.getAttribute(\"class\")\n }\n\n if (node.hasAttribute(\"important-for-accessibility\")) {\n attributesBuilder[\"important-for-accessibility\"] = node.getAttribute(\"important-for-accessibility\")\n }\n\n if (node.hasAttribute(\"error\")) {\n attributesBuilder[\"error\"] = node.getAttribute(\"error\")\n }\n\n attributesBuilder\n } else {\n emptyMap()\n }\n\n val children = mutableListOf()\n val childNodes = node.childNodes\n (0 until childNodes.length).forEach { i ->\n children += mapHierarchy(childNodes.item(i))\n }\n\n return TreeNode(\n attributes = attributes.toMutableMap(),\n children = children,\n clickable = node.getBoolean(\"clickable\"),\n enabled = node.getBoolean(\"enabled\"),\n focused = node.getBoolean(\"focused\"),\n checked = node.getBoolean(\"checked\"),\n selected = node.getBoolean(\"selected\"),\n )\n }\n\n private fun Node.getBoolean(name: String): Boolean? {\n return (this as? Element)\n ?.getAttribute(name)\n ?.let { it == \"true\" }\n }\n\n fun installMaestroDriverApp() {\n metrics.measured(\"operation\", mapOf(\"command\" to \"installMaestroDriverApp\")) {\n if (reinstallDriver) {\n uninstallMaestroDriverApp()\n } else if (isPackageInstalled(\"dev.mobile.maestro\")) {\n return@measured\n }\n\n val maestroAppApk = File.createTempFile(\"maestro-app\", \".apk\")\n\n Maestro::class.java.getResourceAsStream(\"/maestro-app.apk\")?.let {\n val bufferedSink = maestroAppApk.sink().buffer()\n bufferedSink.writeAll(it.source())\n bufferedSink.flush()\n }\n\n install(maestroAppApk)\n if (!isPackageInstalled(\"dev.mobile.maestro\")) {\n throw IllegalStateException(\"dev.mobile.maestro was not installed\")\n }\n maestroAppApk.delete()\n }\n }\n\n private fun installMaestroServerApp() {\n if (reinstallDriver) {\n uninstallMaestroServerApp()\n } else if (isPackageInstalled(\"dev.mobile.maestro.test\")) {\n return\n }\n\n val maestroServerApk = File.createTempFile(\"maestro-server\", \".apk\")\n\n Maestro::class.java.getResourceAsStream(\"/maestro-server.apk\")?.let {\n val bufferedSink = maestroServerApk.sink().buffer()\n bufferedSink.writeAll(it.source())\n bufferedSink.flush()\n }\n\n install(maestroServerApk)\n if (!isPackageInstalled(\"dev.mobile.maestro.test\")) {\n throw IllegalStateException(\"dev.mobile.maestro.test was not installed\")\n }\n maestroServerApk.delete()\n }\n\n private fun installMaestroApks() {\n installMaestroDriverApp()\n installMaestroServerApp()\n }\n\n fun uninstallMaestroDriverApp() {\n metrics.measured(\"operation\", mapOf(\"command\" to \"uninstallMaestroDriverApp\")) {\n try {\n if (isPackageInstalled(\"dev.mobile.maestro\")) {\n uninstall(\"dev.mobile.maestro\")\n }\n } catch (e: IOException) {\n logger.warn(\"Failed to check or uninstall maestro driver app: ${e.message}\")\n // Continue with cleanup even if we can't check package status\n try {\n uninstall(\"dev.mobile.maestro\")\n } catch (e2: IOException) {\n logger.warn(\"Failed to uninstall maestro driver app: ${e2.message}\")\n // Just log and continue, don't throw\n }\n }\n }\n }\n\n private fun uninstallMaestroServerApp() {\n try {\n if (isPackageInstalled(\"dev.mobile.maestro.test\")) {\n uninstall(\"dev.mobile.maestro.test\")\n }\n } catch (e: IOException) {\n logger.warn(\"Failed to check or uninstall maestro server app: ${e.message}\")\n // Continue with cleanup even if we can't check package status\n try {\n uninstall(\"dev.mobile.maestro.test\")\n } catch (e2: IOException) {\n logger.warn(\"Failed to uninstall maestro server app: ${e2.message}\")\n // Just log and continue, don't throw\n }\n }\n }\n\n private fun uninstallMaestroApks() {\n uninstallMaestroDriverApp()\n uninstallMaestroServerApp()\n }\n\n private fun install(apkFile: File) {\n try {\n dadb.install(apkFile)\n } catch (installError: IOException) {\n throw IOException(\"Failed to install apk \" + apkFile + \": \" + installError.message, installError)\n }\n }\n\n private fun uninstall(packageName: String) {\n try {\n dadb.uninstall(packageName)\n } catch (error: IOException) {\n throw IOException(\"Failed to uninstall package \" + packageName + \": \" + error.message, error)\n }\n }\n\n private fun isPackageInstalled(packageName: String): Boolean {\n try {\n val output: String = shell(\"pm list packages --user 0 $packageName\")\n return output.split(\"\\n\".toRegex())\n .map { line -> line.split(\":\".toRegex()) }\n .filter { parts -> parts.size == 2 }\n .map { parts -> parts[1] }\n .any { linePackageName -> linePackageName == packageName }\n } catch (e: IOException) {\n logger.warn(\"Failed to check if package $packageName is installed: ${e.message}\")\n // If we can't check, we'll assume it's not installed\n throw e\n }\n }\n\n private fun shell(command: String): String {\n val response: AdbShellResponse = try {\n dadb.shell(command)\n } catch (e: IOException) {\n throw IOException(command, e)\n }\n\n if (response.exitCode != 0) {\n throw IOException(\"$command: ${response.allOutput}\")\n }\n return response.output\n }\n\n private fun getStartupTimeout(): Long = runCatching {\n System.getenv(MAESTRO_DRIVER_STARTUP_TIMEOUT).toLong()\n }.getOrDefault(SERVER_LAUNCH_TIMEOUT_MS)\n\n private fun AdbShellStream?.successfullyStarted(): Boolean {\n val output = this?.read()\n return when {\n output is AdbShellPacket.StdError -> false\n output.toString().contains(\"FAILED\", true) -> false\n output.toString().contains(\"UNABLE\", true) -> false\n else -> true\n }\n }\n\n private fun runDeviceCall(callName: String, call: () -> T): T {\n return try {\n call()\n } catch (throwable: StatusRuntimeException) {\n val status = Status.fromThrowable(throwable)\n when (status.code) {\n Status.Code.DEADLINE_EXCEEDED -> {\n LOGGER.error(\"$callName call failed on android with $status\", throwable)\n throw throwable\n }\n Status.Code.UNAVAILABLE -> {\n if (throwable.cause is IOException || throwable.message?.contains(\"io exception\", ignoreCase = true) == true) {\n LOGGER.error(\"Not able to reach the gRPC server while processing $callName command\")\n throw throwable\n } else {\n LOGGER.error(\"Received UNAVAILABLE status with message: ${throwable.message} while processing $callName command\", throwable)\n throw throwable\n }\n }\n Status.Code.INTERNAL -> {\n val trailers = Status.trailersFromThrowable(throwable)\n val errorType = trailers?.get(ERROR_TYPE_KEY)\n val errorMsg = trailers?.get(ERROR_MSG_KEY)\n val errorCause = trailers?.get(ERROR_CAUSE_KEY)\n LOGGER.error(\"$callName call failed: type=$errorType, message=$errorMsg, cause=$errorCause\", throwable)\n throw throwable.cause ?: throwable\n }\n else -> {\n LOGGER.error(\"Unexpected error during $callName: ${status.code} - ${throwable.message} and cause ${throwable.cause}\", throwable)\n throw throwable\n }\n }\n }\n }\n\n\n companion object {\n\n private const val SERVER_LAUNCH_TIMEOUT_MS = 15000L\n private const val MAESTRO_DRIVER_STARTUP_TIMEOUT = \"MAESTRO_DRIVER_STARTUP_TIMEOUT\"\n private const val WINDOW_UPDATE_TIMEOUT_MS = 750\n\n private val REGEX_OPTIONS = setOf(RegexOption.IGNORE_CASE, RegexOption.DOT_MATCHES_ALL, RegexOption.MULTILINE)\n\n private val ERROR_TYPE_KEY: Metadata.Key =\n Metadata.Key.of(\"error-type\", Metadata.ASCII_STRING_MARSHALLER)\n private val ERROR_MSG_KEY: Metadata.Key =\n Metadata.Key.of(\"error-message\", Metadata.ASCII_STRING_MARSHALLER)\n private val ERROR_CAUSE_KEY: Metadata.Key =\n Metadata.Key.of(\"error-cause\", Metadata.ASCII_STRING_MARSHALLER)\n\n private val LOGGER = LoggerFactory.getLogger(AndroidDriver::class.java)\n\n private const val TOAST_CLASS_NAME = \"android.widget.Toast\"\n private const val SCREENSHOT_DIFF_THRESHOLD = 0.005\n private const val CHUNK_SIZE = 1024L * 1024L * 3L\n }\n}\n" }, { "path": "maestro-client/src/main/java/maestro/drivers/CdpWebDriver.kt", "content": "package maestro.drivers\n\nimport CdpClient\nimport com.fasterxml.jackson.module.kotlin.jacksonObjectMapper\nimport kotlinx.coroutines.runBlocking\nimport maestro.Capability\nimport maestro.DeviceInfo\nimport maestro.device.DeviceOrientation\nimport maestro.Driver\nimport maestro.KeyCode\nimport maestro.Maestro\nimport maestro.OnDeviceElementQuery\nimport maestro.Point\nimport maestro.ScreenRecording\nimport maestro.SwipeDirection\nimport maestro.TreeNode\nimport maestro.ViewHierarchy\nimport maestro.device.Platform\nimport maestro.utils.ScreenshotUtils\nimport maestro.web.record.JcodecVideoEncoder\nimport maestro.web.record.WebScreenRecorder\nimport okio.Sink\nimport okio.buffer\nimport org.openqa.selenium.By\nimport org.openqa.selenium.JavascriptExecutor\nimport org.openqa.selenium.Keys\nimport org.openqa.selenium.WebDriver\nimport org.openqa.selenium.WebElement\nimport org.openqa.selenium.chrome.ChromeDriver\nimport org.openqa.selenium.chrome.ChromeDriverService\nimport org.openqa.selenium.chrome.ChromeOptions\nimport org.openqa.selenium.chromium.ChromiumDriverLogLevel\nimport org.openqa.selenium.devtools.HasDevTools\nimport org.openqa.selenium.devtools.v144.emulation.Emulation\nimport org.openqa.selenium.interactions.Actions\nimport org.openqa.selenium.interactions.PointerInput\nimport org.openqa.selenium.interactions.Sequence\nimport org.openqa.selenium.remote.RemoteWebDriver\nimport org.slf4j.LoggerFactory\nimport java.io.File\nimport java.net.URI\nimport java.time.Duration\nimport java.util.*\nimport java.util.logging.Level\nimport java.util.logging.Logger\n\n\nprivate const val SYNTHETIC_COORDINATE_SPACE_OFFSET = 100000\n\nclass CdpWebDriver(\n val isStudio: Boolean,\n private val isHeadless: Boolean = false,\n private val screenSize: String?\n) : Driver {\n\n private lateinit var cdpClient: CdpClient\n\n private var seleniumDriver: org.openqa.selenium.WebDriver? = null\n private var maestroWebScript: String? = null\n private var lastSeenWindowHandles = setOf()\n private var injectedArguments: Map = emptyMap()\n\n private var webScreenRecorder: WebScreenRecorder? = null\n\n init {\n Maestro::class.java.getResourceAsStream(\"/maestro-web.js\")?.let {\n it.bufferedReader().use { br ->\n maestroWebScript = br.readText()\n }\n } ?: error(\"Could not read maestro web script\")\n }\n\n override fun name(): String {\n return \"Chromium Desktop Browser (Experimental)\"\n }\n\n override fun open() {\n seleniumDriver = createSeleniumDriver()\n\n try {\n seleniumDriver\n ?.let { it as? HasDevTools }\n ?.devTools\n ?.createSessionIfThereIsNotOne()\n } catch (e: Exception) {\n // Swallow the exception to avoid crashing the whole process.\n // Some implementations of Selenium do not support DevTools\n // and do not fail gracefully.\n }\n\n if (isStudio) {\n seleniumDriver?.get(\"https://maestro.mobile.dev\")\n }\n }\n\n private fun createSeleniumDriver(): WebDriver {\n System.setProperty(\"webdriver.chrome.silentOutput\", \"true\")\n System.setProperty(ChromeDriverService.CHROME_DRIVER_SILENT_OUTPUT_PROPERTY, \"true\")\n Logger.getLogger(\"org.openqa.selenium\").level = Level.OFF\n Logger.getLogger(\"org.openqa.selenium.devtools.CdpVersionFinder\").level = Level.OFF\n\n val driverService = ChromeDriverService.Builder()\n .withLogLevel(ChromiumDriverLogLevel.OFF)\n .build()\n\n val driver = ChromeDriver(\n driverService,\n ChromeOptions().apply {\n addArguments(\"--remote-allow-origins=*\")\n addArguments(\"--disable-search-engine-choice-screen\")\n addArguments(\"--lang=en\")\n\n // Disable password management\n addArguments(\"--password-store=basic\")\n val chromePrefs = hashMapOf(\n \"credentials_enable_service\" to false,\n \"profile.password_manager_enabled\" to false,\n \"profile.password_manager_leak_detection\" to false // important one\n )\n setExperimentalOption(\"prefs\", chromePrefs)\n\n setExperimentalOption(\"detach\", true)\n\n if (isHeadless) {\n addArguments(\"--headless=new\")\n if(screenSize != null){\n addArguments(\"--window-size=\" + screenSize.replace('x',','))\n }\n else{\n addArguments(\"--window-size=1024,768\")\n }\n }\n }\n )\n\n val options = driver.capabilities.getCapability(\"goog:chromeOptions\") as Map\n val debuggerAddress = options[\"debuggerAddress\"] as String\n val parts = debuggerAddress.split(\":\")\n\n cdpClient = CdpClient(\n host = parts[0],\n port = parts[1].toInt()\n )\n\n return driver\n }\n\n private fun ensureOpen(): org.openqa.selenium.WebDriver {\n return seleniumDriver ?: error(\"Driver is not open\")\n }\n\n private fun executeJS(js: String): Any? {\n return runBlocking {\n try {\n val target = cdpClient.listTargets().first()\n\n cdpClient.evaluate(\"$maestroWebScript\", target)\n\n injectedArguments.forEach { (key, value) ->\n cdpClient.evaluate(\"$key = '$value'\", target)\n }\n\n Thread.sleep(100)\n\n var resultStr = cdpClient.evaluate(js, target)\n\n // Convert from string to Map if needed\n return@runBlocking jacksonObjectMapper().readValue(resultStr, Any::class.java)\n } catch (e: Exception) {\n if (e.message?.contains(\"getContentDescription\") == true) {\n return@runBlocking executeJS(js)\n } else {\n LOGGER.error(\"Failed to execute JS\", e)\n }\n return@runBlocking null\n }\n }\n }\n\n private fun scrollToPoint(point: Point): Long {\n ensureOpen()\n val windowHeight = executeJS(\"window.innerHeight\") as Int\n\n if (point.y >= 0 && point.y.toLong() <= windowHeight) return 0L\n\n val scrolledPixels =\n executeJS(\"() => {const delta = ${point.y} - Math.floor(window.innerHeight / 2); window.scrollBy({ top: delta, left: 0, behavior: 'smooth' }); return delta}()\") as Int\n sleep(3000L)\n return scrolledPixels.toLong()\n }\n\n private fun sleep(ms: Long) {\n Thread.sleep(ms)\n }\n\n private fun scroll(top: String, left: String) {\n executeJS(\"window.scroll({ top: $top, left: $left, behavior: 'smooth' })\")\n }\n\n private fun random(start: Int, end: Int): Int {\n return Random().nextInt((end + 1) - start) + start\n }\n\n override fun close() {\n injectedArguments = emptyMap()\n\n try {\n seleniumDriver?.quit()\n webScreenRecorder?.close()\n } catch (e: Exception) {\n // Swallow the exception to avoid crashing the whole process\n }\n\n seleniumDriver = null\n lastSeenWindowHandles = setOf()\n webScreenRecorder = null\n }\n\n override fun deviceInfo(): DeviceInfo {\n val width = executeJS(\"window.innerWidth\") as Int\n val height = executeJS(\"window.innerHeight\") as Int\n\n return DeviceInfo(\n platform = Platform.WEB,\n widthPixels = width,\n heightPixels = height,\n widthGrid = width,\n heightGrid = height,\n )\n }\n\n override fun launchApp(\n appId: String,\n launchArguments: Map,\n ) {\n injectedArguments = injectedArguments + launchArguments\n\n runBlocking {\n val target = cdpClient.listTargets().first()\n cdpClient.openUrl(appId, target)\n }\n }\n\n override fun stopApp(appId: String) {\n // Not supported at the moment.\n // Simply calling driver.close() can kill the Selenium session, rendering\n // the driver inoperable.\n }\n\n override fun killApp(appId: String) {\n // On Web there is no Process Death like on Android so this command will be a synonym to the stop command\n stopApp(appId)\n }\n\n override fun contentDescriptor(excludeKeyboardElements: Boolean): TreeNode {\n ensureOpen()\n\n detectWindowChange()\n\n // retrieve view hierarchy from DOM\n // There are edge cases where executeJS returns null, and we cannot get the hierarchy. In this situation\n // we retry multiple times until throwing an error eventually. (See issue #1936)\n var contentDesc: Any? = null\n var retry = 0\n while (contentDesc == null) {\n contentDesc = executeJS(\"window.maestro.getContentDescription()\")\n if (contentDesc == null) {\n retry++\n }\n if (retry == RETRY_FETCHING_CONTENT_DESCRIPTION) {\n throw IllegalStateException(\"Could not retrieve hierarchy through maestro.getContentDescription() (tried $retry times\")\n }\n }\n\n val rawMap = contentDesc as Map\n val enrichedMap = injectCrossOriginIframes(rawMap)\n val root = parseDomAsTreeNodes(enrichedMap)\n seleniumDriver?.currentUrl?.let { url ->\n root.attributes[\"url\"] = url\n }\n return root\n }\n\n fun parseDomAsTreeNodes(domRepresentation: Map): TreeNode {\n val attrs = domRepresentation[\"attributes\"] as Map\n\n val attributes = mutableMapOf(\n \"text\" to attrs[\"text\"] as String,\n \"bounds\" to attrs[\"bounds\"] as String,\n )\n if (attrs.containsKey(\"resource-id\") && attrs[\"resource-id\"] != null) {\n attributes[\"resource-id\"] = attrs[\"resource-id\"] as String\n }\n if (attrs.containsKey(\"selected\") && attrs[\"selected\"] != null) {\n attributes[\"selected\"] = (attrs[\"selected\"] as Boolean).toString()\n }\n if (attrs.containsKey(\"synthetic\") && attrs[\"synthetic\"] != null) {\n attributes[\"synthetic\"] = (attrs[\"synthetic\"] as Boolean).toString()\n }\n if (attrs.containsKey(\"ignoreBoundsFiltering\") && attrs[\"ignoreBoundsFiltering\"] != null) {\n attributes[\"ignoreBoundsFiltering\"] = (attrs[\"ignoreBoundsFiltering\"] as Boolean).toString()\n }\n\n val children = domRepresentation[\"children\"] as List>\n\n return TreeNode(attributes = attributes, children = children.map { parseDomAsTreeNodes(it) })\n }\n\n private fun detectWindowChange() {\n // Checks whether there are any new window handles available and, if so, switches Selenium driver focus to it\n val driver = ensureOpen()\n\n if (lastSeenWindowHandles != driver.windowHandles) {\n val newHandles = driver.windowHandles - lastSeenWindowHandles\n lastSeenWindowHandles = driver.windowHandles\n\n if (newHandles.isNotEmpty()) {\n val newHandle = newHandles.first()\n LOGGER.info(\"Detected a window change, switching to new window handle $newHandle\")\n\n driver.switchTo().window(newHandle)\n\n webScreenRecorder?.onWindowChange()\n }\n }\n }\n\n override fun clearAppState(appId: String) {\n ensureOpen()\n\n val origin = try {\n val uri = URI(appId)\n if (uri.scheme.isNullOrBlank() || uri.host.isNullOrBlank()) {\n null\n } else if (uri.port == -1) {\n \"${uri.scheme}://${uri.host}\"\n } else {\n \"${uri.scheme}://${uri.host}:${uri.port}\"\n }\n } catch (e: Exception) {\n LOGGER.warn(\"Failed to parse origin from $appId\", e)\n null\n }\n\n if (origin == null) {\n return\n }\n\n try {\n runBlocking {\n val target = cdpClient.listTargets().first()\n cdpClient.clearDataForOrigin(origin, \"all\", target)\n }\n } catch (e: Exception) {\n LOGGER.warn(\"Failed to clear browser data for $origin\", e)\n }\n }\n\n override fun clearKeychain() {\n // Do nothing\n }\n\n override fun tap(point: Point) {\n val driver = ensureOpen()\n\n if (point.x >= SYNTHETIC_COORDINATE_SPACE_OFFSET && point.y >= SYNTHETIC_COORDINATE_SPACE_OFFSET) {\n tapOnSyntheticCoordinateSpace(point)\n return\n }\n\n val pixelsScrolled = scrollToPoint(point)\n\n val mouse = PointerInput(PointerInput.Kind.MOUSE, \"default mouse\")\n val actions = Sequence(mouse, 1)\n .addAction(\n mouse.createPointerMove(\n Duration.ofMillis(400),\n PointerInput.Origin.viewport(),\n point.x,\n point.y - pixelsScrolled.toInt()\n )\n )\n\n (driver as RemoteWebDriver).perform(listOf(actions))\n\n Actions(driver).click().build().perform()\n }\n\n private fun tapOnSyntheticCoordinateSpace(point: Point) {\n val elements = contentDescriptor()\n\n val hit = ViewHierarchy.from(this, true)\n .getElementAt(elements, point.x, point.y)\n\n if (hit == null) {\n return\n }\n\n if (hit.attributes[\"synthetic\"] != \"true\") {\n return\n }\n\n executeJS(\"window.maestro.tapOnSyntheticElement(${point.x}, ${point.y})\")\n }\n\n override fun longPress(point: Point) {\n val driver = ensureOpen()\n\n val mouse = PointerInput(PointerInput.Kind.MOUSE, \"default mouse\")\n val actions = Sequence(mouse, 0)\n .addAction(mouse.createPointerMove(Duration.ZERO, PointerInput.Origin.viewport(), point.x, point.y))\n (driver as RemoteWebDriver).perform(listOf(actions))\n\n Actions(driver).clickAndHold().pause(3000L).release().build().perform()\n }\n\n override fun pressKey(code: KeyCode) {\n val key = mapToSeleniumKey(code)\n withActiveElement { it.sendKeys(key) }\n }\n\n private fun mapToSeleniumKey(code: KeyCode): Keys {\n return when (code) {\n KeyCode.ENTER -> Keys.ENTER\n KeyCode.BACKSPACE -> Keys.BACK_SPACE\n else -> error(\"Keycode $code is not supported on web\")\n }\n }\n\n override fun scrollVertical() {\n // Check if this is a Flutter web app\n val isFlutter = executeJS(\"window.maestro.isFlutterApp()\") as? Boolean ?: false\n \n if (isFlutter) {\n // Use Flutter-specific smooth animated scrolling\n executeJS(\"window.maestro.smoothScrollFlutter('UP', 500)\")\n } else {\n // Use standard scroll for regular web pages\n scroll(\"window.scrollY + Math.round(window.innerHeight / 2)\", \"window.scrollX\")\n }\n }\n\n override fun isKeyboardVisible(): Boolean {\n return false\n }\n\n override fun swipe(start: Point, end: Point, durationMs: Long) {\n val driver = ensureOpen()\n\n val finger = PointerInput(PointerInput.Kind.TOUCH, \"finger\")\n val swipe = Sequence(finger, 1)\n swipe.addAction(\n finger.createPointerMove(\n Duration.ofMillis(0),\n PointerInput.Origin.viewport(),\n start.x,\n start.y\n )\n )\n swipe.addAction(finger.createPointerDown(PointerInput.MouseButton.LEFT.asArg()))\n swipe.addAction(\n finger.createPointerMove(\n Duration.ofMillis(durationMs),\n PointerInput.Origin.viewport(),\n end.x,\n end.y\n )\n )\n swipe.addAction(finger.createPointerUp(PointerInput.MouseButton.LEFT.asArg()))\n (driver as RemoteWebDriver).perform(listOf(swipe))\n }\n\n override fun swipe(swipeDirection: SwipeDirection, durationMs: Long) {\n val isFlutter = executeJS(\"window.maestro.isFlutterApp()\") as? Boolean ?: false\n \n if (isFlutter) {\n // Flutter web: Use smooth animated scrolling with easing\n executeJS(\"window.maestro.smoothScrollFlutter('${swipeDirection.name}', $durationMs)\")\n } else {\n // HTML web: Use standard window scrolling\n when (swipeDirection) {\n SwipeDirection.UP -> scroll(\"window.scrollY + Math.round(window.innerHeight / 2)\", \"window.scrollX\")\n SwipeDirection.DOWN -> scroll(\"window.scrollY - Math.round(window.innerHeight / 2)\", \"window.scrollX\")\n SwipeDirection.LEFT -> scroll(\"window.scrollY\", \"window.scrollX + Math.round(window.innerWidth / 2)\")\n SwipeDirection.RIGHT -> scroll(\"window.scrollY\", \"window.scrollX - Math.round(window.innerWidth / 2)\")\n }\n }\n }\n\n override fun swipe(elementPoint: Point, direction: SwipeDirection, durationMs: Long) {\n // Ignoring elementPoint to enable a rudimentary implementation of scrollUntilVisible for web\n swipe(direction, durationMs)\n }\n\n override fun backPress() {\n val driver = ensureOpen()\n driver.navigate().back()\n }\n\n override fun inputText(text: String) {\n withActiveElement { element ->\n for (c in text.toCharArray()) {\n element.sendKeys(\"$c\")\n sleep(random(20, 100).toLong())\n }\n }\n }\n\n override fun openLink(link: String, appId: String?, autoVerify: Boolean, browser: Boolean) {\n val driver = ensureOpen()\n\n driver.get(if (link.startsWith(\"http\")) link else \"https://$link\")\n }\n\n override fun hideKeyboard() {\n // no-op on web\n return\n }\n\n override fun takeScreenshot(out: Sink, compressed: Boolean) {\n runBlocking {\n val target = cdpClient.listTargets().first()\n val bytes = cdpClient.captureScreenshot(target)\n\n out.buffer().use { it.write(bytes) }\n }\n }\n\n override fun startScreenRecording(out: Sink): ScreenRecording {\n val driver = ensureOpen()\n webScreenRecorder = WebScreenRecorder(\n JcodecVideoEncoder(),\n driver\n )\n webScreenRecorder?.startScreenRecording(out)\n\n return object : ScreenRecording {\n override fun close() {\n webScreenRecorder?.close()\n }\n }\n }\n\n override fun setLocation(latitude: Double, longitude: Double) {\n val driver = ensureOpen() as HasDevTools\n\n driver.devTools.createSessionIfThereIsNotOne()\n\n driver.devTools.send(\n Emulation.setGeolocationOverride(\n Optional.of(latitude),\n Optional.of(longitude),\n Optional.of(0.0),\n Optional.empty(),\n Optional.empty(),\n Optional.empty(),\n Optional.empty()\n )\n )\n }\n\n override fun setOrientation(orientation: DeviceOrientation) {\n // No op\n }\n\n override fun eraseText(charactersToErase: Int) {\n withActiveElement { element ->\n for (i in 0 until charactersToErase) {\n element.sendKeys(Keys.BACK_SPACE)\n sleep(random(20, 50).toLong())\n }\n }\n sleep(1000)\n }\n\n override fun setProxy(host: String, port: Int) {\n // Do nothing\n }\n\n override fun resetProxy() {\n // Do nothing\n }\n\n override fun isShutdown(): Boolean {\n close()\n return true\n }\n\n override fun isUnicodeInputSupported(): Boolean {\n return true\n }\n\n override fun waitForAppToSettle(initialHierarchy: ViewHierarchy?, appId: String?, timeoutMs: Int?): ViewHierarchy {\n return ScreenshotUtils.waitForAppToSettle(initialHierarchy, this)\n }\n\n override fun waitUntilScreenIsStatic(timeoutMs: Long): Boolean {\n return ScreenshotUtils.waitUntilScreenIsStatic(timeoutMs, SCREENSHOT_DIFF_THRESHOLD, this)\n }\n\n override fun capabilities(): List {\n return listOf(\n Capability.FAST_HIERARCHY\n )\n }\n\n override fun setPermissions(appId: String, permissions: Map) {\n // no-op for web\n }\n\n override fun addMedia(mediaFiles: List) {\n // noop for web\n }\n\n override fun isAirplaneModeEnabled(): Boolean {\n return false\n }\n\n override fun setAirplaneMode(enabled: Boolean) {\n // Do nothing\n }\n\n override fun queryOnDeviceElements(query: OnDeviceElementQuery): List {\n return when (query) {\n is OnDeviceElementQuery.Css -> queryCss(query)\n else -> super.queryOnDeviceElements(query)\n }\n }\n\n private fun queryCss(query: OnDeviceElementQuery.Css): List {\n ensureOpen()\n\n val jsResult: Any? = executeJS(\"window.maestro.queryCss('${query.css}')\")\n\n if (jsResult == null) {\n return emptyList()\n }\n\n if (jsResult is List<*>) {\n return jsResult\n .mapNotNull { it as? Map<*, *> }\n .map { parseDomAsTreeNodes(it as Map) }\n } else {\n LOGGER.error(\"Unexpected result type from queryCss: ${jsResult.javaClass.name}\")\n return emptyList()\n }\n }\n\n @Suppress(\"UNCHECKED_CAST\")\n private fun injectCrossOriginIframes(node: Map): Map {\n val attrs = node[\"attributes\"] as Map\n val iframeSrc = attrs[\"__crossOriginIframe\"] as? String\n\n if (iframeSrc != null) {\n val iframeContent = fetchCrossOriginIframeContent(iframeSrc)\n if (iframeContent != null) return iframeContent\n val cleanAttrs = attrs - \"__crossOriginIframe\"\n return mapOf(\"attributes\" to cleanAttrs, \"children\" to emptyList())\n }\n\n val children = (node[\"children\"] as List>)\n .map { injectCrossOriginIframes(it) }\n return mapOf(\"attributes\" to attrs, \"children\" to children)\n }\n\n @Suppress(\"UNCHECKED_CAST\")\n private fun fetchCrossOriginIframeContent(iframeSrc: String): Map? {\n val driver = seleniumDriver ?: return null\n val jsExecutor = driver as? JavascriptExecutor ?: return null\n\n // Find the iframe element by its resolved src property (absolute URL)\n val iframeElement = try {\n jsExecutor.executeScript(\n \"return [...document.querySelectorAll('iframe')].find(f => f.src === arguments[0]);\",\n iframeSrc\n ) as? WebElement\n } catch (e: Exception) {\n LOGGER.warn(\"Could not find iframe element with src $iframeSrc\", e)\n return null\n } ?: run {\n LOGGER.warn(\"No iframe element found with src $iframeSrc\")\n return null\n }\n\n // Get the iframe's scaled viewport params (accounts for parent viewportWidth/Height scaling)\n val paramsJson = try {\n jsExecutor.executeScript(\n \"return JSON.stringify(window.maestro.getIframeViewportParams(arguments[0]));\",\n iframeSrc\n ) as? String\n } catch (e: Exception) {\n LOGGER.warn(\"Could not get viewport params for iframe $iframeSrc\", e)\n return null\n } ?: return null\n\n val params = jacksonObjectMapper().readValue(paramsJson, Map::class.java) as Map\n val iframeX = (params[\"viewportX\"] as? Number)?.toDouble() ?: 0.0\n val iframeY = (params[\"viewportY\"] as? Number)?.toDouble() ?: 0.0\n val iframeW = (params[\"viewportWidth\"] as? Number)?.toDouble() ?: 0.0\n val iframeH = (params[\"viewportHeight\"] as? Number)?.toDouble() ?: 0.0\n\n // ChromeDriver can execute scripts inside cross-origin iframes via switchTo().frame()\n driver.switchTo().frame(iframeElement)\n return try {\n val resultJson = jsExecutor.executeScript(\"\"\"\n $maestroWebScript\n window.maestro.viewportX = $iframeX;\n window.maestro.viewportY = $iframeY;\n window.maestro.viewportWidth = $iframeW;\n window.maestro.viewportHeight = $iframeH;\n return JSON.stringify(window.maestro.getContentDescription());\n \"\"\".trimIndent()) as? String ?: return null\n jacksonObjectMapper().readValue(resultJson, Map::class.java) as? Map\n } catch (e: Exception) {\n LOGGER.warn(\"Failed to get content description from cross-origin iframe $iframeSrc\", e)\n null\n } finally {\n try { driver.switchTo().defaultContent() }\n catch (e: Exception) { LOGGER.warn(\"Failed to switch back to default content\", e) }\n }\n }\n\n /**\n * Locates the truly focused element, even when it lives inside a cross-origin iframe.\n *\n * When the user taps inside a cross-origin iframe the main frame's\n * `document.activeElement` is the `