test: pin patrol version to 3.14.1 to fix hanging tests (#343)

* ci: pin patrol version to 3.14.1 to fix hanging tests
* ci: fix hanging issue on location permission acceptance.

Author: jokerttu

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

@@ -225,6 +225,7 @@ jobs:
       labels: ubuntu-latest
     env:
       MAPS_API_KEY: ${{ secrets.ACTIONS_API_KEY }}
+      PATROL_ANALYTICS_ENABLED: false
       patrol_cli_version: "3.5.0"
       working_directory: "example"
     steps:
@@ -294,7 +295,8 @@ jobs:
         run: flutter build apk --config-only
       - name: Run integration tests
         working-directory: ${{ env.working_directory }}
-        run: patrol test --verbose
+        run: |
+          patrol test ${{ runner.debug && '--show-flutter-logs --verbose' || '' }}
       - name: Upload test report
         uses: actions/upload-artifact@v4
         if: ${{ always() }}
@@ -312,6 +314,7 @@ jobs:
       labels: macos-latest-xlarge
     env:
       MAPS_API_KEY: ${{ secrets.ACTIONS_API_KEY }}
+      PATROL_ANALYTICS_ENABLED: false
       patrol_cli_version: "3.5.0"
       working_directory: "example"
     steps:
@@ -378,7 +381,7 @@ jobs:
         id: tests_step
         working-directory: ${{ env.working_directory }}
         run: |
-          patrol test --dart-define=MAPS_API_KEY="$MAPS_API_KEY" --verbose -d "$DEVICE_ID"
+          patrol test --dart-define=MAPS_API_KEY="$MAPS_API_KEY" ${{ runner.debug && '--show-flutter-logs --verbose' || '' }} -d "$DEVICE_ID"
       - name: Upload test report
         uses: actions/upload-artifact@v4
         if: ${{ always() }}

example/integration_test/shared.dart

@@ -163,8 +163,11 @@ Future<void> checkLocationDialogAcceptance(PatrolIntegrationTester $) async {
     final Future<PermissionStatus> locationGranted =
         Permission.locationWhenInUse.request();
 
-    // Grant location permission.
-    await $.native.grantPermissionWhenInUse();
+    if (await $.native
+        .isPermissionDialogVisible(timeout: const Duration(seconds: 5))) {
+      // Grant location permission.
+      await $.native.grantPermissionWhenInUse();
+    }
 
     // Check that the location permission is granted.
     await locationGranted.then((PermissionStatus status) async {

example/integration_test/t01_initialization_test.dart

@@ -28,7 +28,15 @@ import 'package:flutter/material.dart';
 import 'shared.dart';
 
 void main() {
-  patrol('C01 - Test session initialization errors',
+  // Patrol runs the tests in alphabetical order, add a prefix to the test
+  // name to control the order with script:
+  int testCounter = 0;
+  String prefix(String name) {
+    testCounter++;
+    return 'IT${testCounter.toString().padLeft(2, '0')} $name';
+  }
+
+  patrol(prefix('Test session initialization errors'),
       (PatrolIntegrationTester $) async {
     await GoogleMapsNavigator.resetTermsAccepted();
     expect(await GoogleMapsNavigator.areTermsAccepted(), false);
@@ -174,7 +182,7 @@ void main() {
     }
   });
 
-  patrol('C02 - Test Maps initialization', (PatrolIntegrationTester $) async {
+  patrol(prefix('Test Maps initialization'), (PatrolIntegrationTester $) async {
     final Completer<GoogleNavigationViewController> viewControllerCompleter =
         Completer<GoogleNavigationViewController>();
 
@@ -266,7 +274,7 @@ void main() {
     expect(await controller.isNavigationUIEnabled(), true);
   });
 
-  patrol('C03 - Test Maps initialization without navigation',
+  patrol(prefix('Test Maps initialization without navigation'),
       (PatrolIntegrationTester $) async {
     final Completer<GoogleMapViewController> viewControllerCompleter =
         Completer<GoogleMapViewController>();

example/pubspec.yaml

@@ -36,7 +36,7 @@ dev_dependencies:
   integration_test:
     sdk: flutter
   meta: any
-  patrol: ^3.14.0
+  patrol: 3.14.1 # Patrol 3.15.1 has hang issues on Android. Pinging to 3.14.1 for now.
   pub_semver: ^2.1.4
   test_api: any
 

melos.yaml

@@ -51,7 +51,7 @@ scripts:
   format:
     run: |
       melos run format:dart && \
-      melos run format:ios &&  \
+      melos run format:ios && \
       melos run format:android
     description: |
       Formats the code of all packages (Dart, iOS, Android).