chore: improve tests by adding realtime delays (#477)

* test: improve navigation tests by adding realtime delays

* ci: run patrol tests with older iOS version

Author: jokerttu

.github/workflows/test-and-build.yaml

@@ -226,7 +226,7 @@ jobs:
     env:
       MAPS_API_KEY: ${{ secrets.ACTIONS_API_KEY }}
       PATROL_ANALYTICS_ENABLED: false
-      patrol_cli_version: "3.5.0"
+      patrol_cli_version: "3.10.0"
       working_directory: "example"
     steps:
       - name: Fail if workflow has no access to API key
@@ -311,12 +311,13 @@ jobs:
     if: contains(github.base_ref, 'main')
     timeout-minutes: 90
     runs-on:
-      labels: macos-latest-xlarge
+      labels: macos-15-xlarge
     env:
       MAPS_API_KEY: ${{ secrets.ACTIONS_API_KEY }}
       PATROL_ANALYTICS_ENABLED: false
-      patrol_cli_version: "3.5.0"
+      patrol_cli_version: "3.10.0"
       working_directory: "example"
+      IOS_VERSION: "18.6"
     steps:
       - name: Fail if workflow has no access to API key
         if: ${{ env.MAPS_API_KEY == '' }}
@@ -337,14 +338,16 @@ jobs:
         run: |
           SIMULATOR_NAME="iPhone 16 Pro"
 
-          # Find the UUID of the existing simulator by name
-          DEVICE_ID=$(xcrun simctl list devices | grep "$SIMULATOR_NAME (" | grep -Eo "\([A-F0-9-]+\)" | head -n 1 | tr -d "()")
+          # Find the UUID of the existing simulator by name and iOS version using the correct filter command
+          DEVICE_ID=$(xcrun simctl list devices $IOS_VERSION | grep "$SIMULATOR_NAME (" | grep -Eo "\([A-F0-9-]+\)" | head -n 1 | tr -d "()")
 
           if [ -z "$DEVICE_ID" ]; then
-            echo "Simulator $SIMULATOR_NAME not found."
+            echo "Simulator $SIMULATOR_NAME with iOS $IOS_VERSION not found."
+            echo "Available simulators for iOS $IOS_VERSION:"
+            xcrun simctl list devices $IOS_VERSION
             exit 1
           else
-            echo "Found existing simulator: $SIMULATOR_NAME ($DEVICE_ID)"
+            echo "Found existing simulator: $SIMULATOR_NAME iOS $IOS_VERSION ($DEVICE_ID)"
             echo "Erasing the simulator to ensure a clean state..."
             xcrun simctl erase "$DEVICE_ID"
           fi
@@ -381,7 +384,7 @@ jobs:
         id: tests_step
         working-directory: ${{ env.working_directory }}
         run: |
-          patrol test --dart-define=MAPS_API_KEY="$MAPS_API_KEY" ${{ runner.debug && '--show-flutter-logs --verbose' || '' }} -d "$DEVICE_ID"
+          patrol test --dart-define=MAPS_API_KEY="$MAPS_API_KEY" --ios=$IOS_VERSION ${{ runner.debug && '--show-flutter-logs --verbose' || '' }} -d "$DEVICE_ID"
       - name: Upload test report
         uses: actions/upload-artifact@v4
         if: ${{ always() }}

CONTRIBUTING.md

@@ -132,7 +132,7 @@ Specify the device you want to run the tests on with the DEVICE env variable.
 Integration tests are responsible for ensuring that the plugin works against the native Navigation SDK for both Android and iOS platforms. Patrol is used for the integration tests to simplify interactions with native elements. To use patrol, you first need to activate the patrol_cli.  
 
 ```bash
-flutter pub global activate patrol_cli 3.5.0
+flutter pub global activate patrol_cli 3.10.0
 ```
 
 To ensure that all necessary dependencies for patrol are properly set up, run the following command:

example/android/app/build.gradle.kts

@@ -58,7 +58,7 @@ android {
         applicationId = "com.google.maps.flutter.navigation_example"
         // You can update the following values to match your application needs.
         // For more information, see: https://flutter.dev/to/review-gradle-config.
-        minSdk = flutter.minSdkVersion
+        minSdk = 24
         targetSdk = flutter.targetSdkVersion
         versionCode = flutter.versionCode
         versionName = flutter.versionName

example/android/gradle/wrapper/gradle-wrapper.properties

@@ -2,6 +2,6 @@
 //=limitations under the License.
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.12-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

example/android/settings.gradle.kts

@@ -32,7 +32,7 @@ pluginManagement {
 
 plugins {
     id("dev.flutter.flutter-plugin-loader") version "1.0.0"
-    id("com.android.application") version "8.7.3" apply false
+    id("com.android.application") version "8.13.0" apply false
     id("org.jetbrains.kotlin.android") version "2.1.0" apply false
     id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") version "2.0.1" apply false
 }

example/integration_test/shared.dart

@@ -136,6 +136,11 @@ Future<void> checkTermsAndConditionsAcceptance(
         );
 
     await $.pumpAndSettle();
+    // Force wait a bit for the dialog to appear.
+    await $.tester.runAsync(
+      () => Future.delayed(const Duration(milliseconds: 250)),
+    );
+
     // Tap accept or cancel.
     if (Platform.isAndroid) {
       await $.native.tap(Selector(text: "Got It"));
@@ -188,37 +193,17 @@ Future<GoogleNavigationViewController> startNavigation(
   void Function(CameraPosition)? onCameraStartedFollowingLocation,
   void Function(CameraPosition)? onCameraStoppedFollowingLocation,
 }) async {
-  final ControllerCompleter<GoogleNavigationViewController>
-  controllerCompleter = ControllerCompleter();
-
-  await checkLocationDialogAndTosAcceptance($);
-
-  final Key key = GlobalKey();
-  await pumpNavigationView(
-    $,
-    GoogleMapsNavigationView(
-      key: key,
-      onViewCreated: (GoogleNavigationViewController viewController) {
-        controllerCompleter.complete(viewController);
-      },
-      onCameraMoveStarted: onCameraMoveStarted,
-      onCameraMove: onCameraMove,
-      onCameraIdle: onCameraIdle,
-      onCameraStartedFollowingLocation: onCameraStartedFollowingLocation,
-      onCameraStoppedFollowingLocation: onCameraStoppedFollowingLocation,
-    ),
-  );
-
   final GoogleNavigationViewController controller =
-      await controllerCompleter.future;
-
-  await GoogleMapsNavigator.initializeNavigationSession();
-  await $.pumpAndSettle();
-
-  await GoogleMapsNavigator.simulator.setUserLocation(
-    const LatLng(latitude: startLocationLat, longitude: startLocationLng),
-  );
-  await $.pumpAndSettle(timeout: const Duration(seconds: 1));
+      await startNavigationWithoutDestination(
+        $,
+        initializeNavigation: true,
+        simulateLocation: true,
+        onCameraMoveStarted: onCameraMoveStarted,
+        onCameraMove: onCameraMove,
+        onCameraIdle: onCameraIdle,
+        onCameraStartedFollowingLocation: onCameraStartedFollowingLocation,
+        onCameraStoppedFollowingLocation: onCameraStoppedFollowingLocation,
+      );
 
   /// Set Destination.
   final Destinations destinations = Destinations(
@@ -236,11 +221,9 @@ Future<GoogleNavigationViewController> startNavigation(
   final NavigationRouteStatus status =
       await GoogleMapsNavigator.setDestinations(destinations);
   expect(status, NavigationRouteStatus.statusOk);
-  await $.pumpAndSettle();
 
   /// Start guidance.
   await GoogleMapsNavigator.startGuidance();
-  await $.pumpAndSettle();
 
   expect(await GoogleMapsNavigator.isGuidanceRunning(), true);
 
@@ -350,9 +333,13 @@ Future<GoogleNavigationViewController> startNavigationWithoutDestination(
   void Function(bool)? onNavigationUIEnabledChanged,
   void Function(String)? onPolygonClicked,
   void Function(String)? onPolylineClicked,
+  void Function(CameraPosition, bool)? onCameraMoveStarted,
+  void Function(CameraPosition)? onCameraMove,
+  void Function(CameraPosition)? onCameraIdle,
+  void Function(CameraPosition)? onCameraStartedFollowingLocation,
+  void Function(CameraPosition)? onCameraStoppedFollowingLocation,
   void Function(NavigationViewRecenterButtonClickedEvent)?
   onRecenterButtonClicked,
-  void Function(CameraPosition)? onCameraIdle,
 }) async {
   final Completer<GoogleNavigationViewController> controllerCompleter =
       Completer<GoogleNavigationViewController>();
@@ -383,24 +370,30 @@ Future<GoogleNavigationViewController> startNavigationWithoutDestination(
       onPolygonClicked: onPolygonClicked,
       onPolylineClicked: onPolylineClicked,
       onRecenterButtonClicked: onRecenterButtonClicked,
+      onCameraMoveStarted: onCameraMoveStarted,
+      onCameraMove: onCameraMove,
       onCameraIdle: onCameraIdle,
+      onCameraStartedFollowingLocation: onCameraStartedFollowingLocation,
+      onCameraStoppedFollowingLocation: onCameraStoppedFollowingLocation,
     ),
   );
 
   final GoogleNavigationViewController controller =
       await controllerCompleter.future;
-  await $.pumpAndSettle();
 
   if (initializeNavigation) {
     await GoogleMapsNavigator.initializeNavigationSession();
-    await $.pumpAndSettle();
   }
 
   if (simulateLocation) {
-    await GoogleMapsNavigator.simulator.setUserLocation(
-      const LatLng(latitude: startLocationLat, longitude: startLocationLng),
+    const double tolerance = 0.001;
+    await setSimulatedUserLocationWithCheck(
+      $,
+      controller,
+      startLocationLat,
+      startLocationLng,
+      tolerance,
     );
-    await $.pumpAndSettle(timeout: const Duration(seconds: 1));
   }
 
   return controller;
@@ -432,8 +425,6 @@ Future<GoogleMapViewController> startMapView(
   final ControllerCompleter<GoogleMapViewController> controllerCompleter =
       ControllerCompleter();
 
-  //await checkLocationDialogAndTosAcceptance($);
-
   final Key key = GlobalKey();
   await pumpMapView(
     $,
@@ -485,11 +476,58 @@ Future<Value?> waitForValueMatchingPredicate<Value>(
     if (predicate(currentValue)) {
       return currentValue;
     }
-    await $.pump(Duration(milliseconds: delayMs));
+    await $.tester.runAsync(
+      () => Future.delayed(Duration(milliseconds: delayMs)),
+    );
   }
   return null;
 }
 
+/// Sets the simulated user location to [startLat], [startLng] and checks that
+/// the location was set correctly within the given [tolerance].
+Future<void> setSimulatedUserLocationWithCheck(
+  PatrolIntegrationTester $,
+  GoogleNavigationViewController viewController,
+  double startLat,
+  double startLng,
+  double tolerance,
+) async {
+  // Simulate location
+  await GoogleMapsNavigator.simulator.setUserLocation(
+    LatLng(latitude: startLat, longitude: startLng),
+  );
+
+  // Wait a bit for the location to be set, as this always seems to take a bit
+  // of time on both Android and iOS platforms.
+  await $.tester.runAsync(
+    () => Future.delayed(const Duration(milliseconds: 500)),
+  );
+
+  final LatLng? currentLocation = await waitForValueMatchingPredicate<LatLng?>(
+    $,
+    viewController.getMyLocation,
+    (LatLng? location) {
+      if (location == null) return false;
+
+      bool isCloseTo(double a, double b) {
+        var diff = a - b;
+        if (diff < 0) diff = -diff;
+        return diff <= tolerance;
+      }
+
+      return isCloseTo(location.latitude, startLat) &&
+          isCloseTo(location.longitude, startLng);
+    },
+    // Total time before giving up: 100 * 200ms = 20s
+    maxTries: 100,
+    delayMs: 200,
+  );
+
+  expect(currentLocation, isNotNull);
+  expect(currentLocation?.latitude, closeTo(startLat, tolerance));
+  expect(currentLocation?.longitude, closeTo(startLng, tolerance));
+}
+
 // Convert a Color to an integer.
 int? colorToInt(Color? color) {
   if (color == null) {