Merge branch 'mobile-dev-inc:main' into develop

Author: cem2ran

.github/workflows/test.yaml

@@ -100,64 +100,40 @@ jobs:
           retention-days: 1
           include-hidden-files: true
 
-  ios-integration-test:
-    name: iOS Integration Test on Java ${{ matrix.java-version }}
+  ios-driver-lib-test:
+    name: MaestroDriverLib Unit Tests
     runs-on: macos-latest
-    timeout-minutes: 50
-
-    strategy:
-      fail-fast: false
-      matrix:
-        java-version: [17]
+    timeout-minutes: 10
 
     steps:
-      - name: Clone repository (only needed for the e2e directory)
+      - name: Clone repository
         uses: actions/checkout@v4
 
-      - name: Set up Java
-        uses: actions/setup-java@v4
-        with:
-          distribution: zulu
-          java-version: ${{ matrix.java-version }}
-          cache: gradle
-
-      - name: Set permission to scripts
-        run: chmod +x .github/scripts/boot_simulator.sh
-
-      - name: Boot Simulator
-        run: ./.github/scripts/boot_simulator.sh
+      - name: Run MaestroDriverLib Tests
+        working-directory: ${{ github.workspace }}/maestro-ios-xctest-runner/MaestroDriverLib
+        run: swift test
 
-      - name: Set Simulator
-        run: |
-          SIMULATOR_ID=$(xcrun simctl list -j | jq -r '.devices | to_entries[] | .value[] | select(.isAvailable==true and .state=="Booted") | .udid' | head -n 1)
-          echo "SIMULATOR_ID=$SIMULATOR_ID" >> $GITHUB_ENV
-
-      - name: Download apps
-        working-directory: ${{ github.workspace }}/e2e
-        run: ./download_apps iOS
+  ios-xctest-runner-test:
+    name: iOS XCTest Runner Unit Tests
+    runs-on: macos-latest
+    timeout-minutes: 15
 
-      - name: Install apps
-        working-directory: ${{ github.workspace }}/e2e
-        run: |
-          unzip apps/wikipedia.zip
-          xcrun simctl install $SIMULATOR_ID ./Wikipedia.app
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v4
 
-      - name: Build for Testing
-        working-directory: ${{ github.workspace }}
-        run: |
-          xcodebuild clean build-for-testing \
-          -project ./maestro-ios-xctest-runner/maestro-driver-ios.xcodeproj \
-          -derivedDataPath "./driver-verification" \
-          -scheme driver-verification-tests \
-          -destination "generic/platform=iOS Simulator"
+      - name: Select Xcode
+        run: sudo xcode-select -s /Applications/Xcode.app/Contents/Developer
 
-      - name: Run Integration tests
+      - name: Run iOS Unit Tests
+        working-directory: ${{ github.workspace }}/maestro-ios-xctest-runner
         run: |
-          XCTESTRUN_FILE=$(find ./driver-verification/Build/Products -name "driver-verification-tests*.xctestrun" | head -n 1)
-          echo "Running tests on $SIMULATOR_ID"
-          xcodebuild test-without-building \
-            -xctestrun "$XCTESTRUN_FILE" \
-            -destination "id=$SIMULATOR_ID"
+          xcodebuild test \
+            -project maestro-driver-ios.xcodeproj \
+            -scheme maestro-driver-iosTests \
+            -destination 'platform=iOS Simulator,name=iPhone 16' \
+            -only-testing:maestro-driver-iosTests \
+            | xcpretty --color || exit ${PIPESTATUS[0]}
 
   validate-gradle-wrapper:
     runs-on: ubuntu-latest
@@ -167,4 +143,4 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Validate Gradle Wrapper
-        uses: gradle/actions/wrapper-validation@v3
+        uses: gradle/actions/wrapper-validation@v4

.github/workflows/warn_build_xctestrunner.yaml

@@ -2,6 +2,25 @@
 
 ## Unreleased
 
+## 2.2.0
+
+- Add `--screen-size` option to test command, to specify the headless browser window size when testing web flows
+- Add `MAESTRO_DEVICE_UDID`, `MAESTRO_SHARD_ID`, and `MAESTRO_SHARD_INDEX` as default environment variables (useful for screenshot filenames when sharding)
+- Add step information to HTML test reports via a new `html-detailed` formatter
+- Add tags and custom property information to HTML and JUnit test reports
+- Add a new `assertScreenshot` command for visual regression testing
+- Add a `cropOn` property to the `takeScreenshot` command to crop screenshots to a specific element
+- Fix scrolling in Flutter Web
+- Fix output of subflows when using `--no-ansi` flag
+- Show `maestro hierarchy` and `maestro check-syntax` commands in `maestro --help`
+- Fix iOS driver app on Simulators running on Intel-based Macs
+- Fix a potential hang between Maestro and the on-device drivers when calls take too long
+- Some logging adjustments for less noise during web tests
+- Bump web support to Chrome v144
+- Bump DataFaker to v2.5.3, GraalJS engine to v24.2.0, log4j to v2.25.3
+
+Thanks to @sazquatch17, @ImL1s, @sidferreira, @SosenWiosen, @TheKohan, @Fl0p, @ff-vivek and @eldare who all contributed changes included in this release ❤️
+
 ## 2.1.0
 
 - Add `setPermissions` command, for setting app permissions outside of `launchApp`

CHANGELOG.md

@@ -0,0 +1,13 @@
+appId: com.example.example
+tags:
+  - passing
+---
+- launchApp
+- tapOn: "Cropped Screenshot Test"
+- waitForAnimationToEnd
+
+- assertScreenshot:
+    path: workspaces/demo_app/screenshots/assertScreenshotCropped.png
+    thresholdPercentage: 99.9
+    cropOn:
+      id: "testContainer"

e2e/workspaces/demo_app/commands/assertScreenshotCropped.yaml

@@ -0,0 +1,12 @@
+appId: com.example.example
+tags:
+  - failing
+---
+- launchApp
+- tapOn: "Cropped Screenshot Test"
+- waitForAnimationToEnd
+
+- assertScreenshot:
+    path: workspaces/demo_app/screenshots/assertScreenshotCroppedHEIC.heic
+    cropOn:
+      id: "testContainer"

e2e/workspaces/demo_app/commands/assertScreenshotCroppedHEIC.yaml

@@ -0,0 +1,13 @@
+appId: com.example.example
+tags:
+  - passing
+---
+- launchApp
+- tapOn: "Cropped Screenshot Test"
+- waitForAnimationToEnd
+
+- assertScreenshot:
+    path: workspaces/demo_app/screenshots/assertScreenshotCroppedJPG.jpg
+    thresholdPercentage: 99.9
+    cropOn:
+      id: "testContainer"

e2e/workspaces/demo_app/commands/assertScreenshotCroppedJPG.yaml

@@ -2,7 +2,7 @@ appId: com.example.example
 ---
 - launchApp # For idempotence of sections
 
-- tapOn: 'Input Test'
+- tapOn: 'Input/Keyboard'
 - tapOn:
     id: 'textInput'
 - inputRandomEmail

e2e/workspaces/demo_app/commands/inputRandomEmail.yaml

@@ -2,7 +2,7 @@ appId: com.example.example
 ---
 - launchApp # For idempotence of sections
 
-- tapOn: 'Input Test'
+- tapOn: 'Input/Keyboard'
 - tapOn:
     id: 'textInput'
 - inputRandomNumber

e2e/workspaces/demo_app/commands/inputRandomNumber.yaml

@@ -2,7 +2,7 @@ appId: com.example.example
 ---
 - launchApp # For idempotence of sections
 
-- tapOn: 'Input Test'
+- tapOn: 'Input/Keyboard'
 - tapOn:
     id: 'textInput'
 - inputRandomPersonName

e2e/workspaces/demo_app/commands/inputRandomPersonName.yaml

@@ -2,7 +2,7 @@ appId: com.example.example
 ---
 - launchApp # For idempotence of sections
 
-- tapOn: 'Input Test'
+- tapOn: 'Input/Keyboard'
 - tapOn:
     id: 'textInput'
 - inputRandomText