chore: improve patrol tests (#197)

* test: instead of for loop, use variants for patrol tests

* test: improve network error test

* chore: meta package version dependency for testing

Author: jokerttu

example/integration_test/shared.dart

@@ -14,6 +14,7 @@
 
 import 'dart:async';
 import 'dart:io';
+import 'package:meta/meta.dart';
 
 // This is a basic Flutter integration test.
 //
@@ -36,17 +37,23 @@ export 'package:patrol/patrol.dart';
 // Type used for iterating over different maps to be tested.
 enum TestMapType {
   /// Regular google map view.
-  map,
+  mapView,
 
-  /// Navigation map.
-  navigation,
+  /// Navigation map view.
+  navigationView,
 }
 
+// Map types to be tested
 const List<TestMapType> testMapTypes = <TestMapType>[
-  TestMapType.map,
-  TestMapType.navigation
+  TestMapType.mapView,
+  TestMapType.navigationView
 ];
 
+// Get a variants for the test map types.
+ValueVariant<TestMapType> getMapTypeVariants() {
+  return ValueVariant<TestMapType>(testMapTypes.toSet());
+}
+
 /// Location coordinates for starting position simulation in Finland - Näkkäläntie.
 const double startLocationLat = 68.593793;
 const double startLocationLng = 23.510763;
@@ -59,12 +66,14 @@ const NativeAutomatorConfig _nativeAutomatorConfig = NativeAutomatorConfig(
 );
 
 /// Create a wrapper [patrol] for [patrolTest] with custom options.
+@isTest
 void patrol(
   String description,
   Future<void> Function(PatrolIntegrationTester) callback, {
   bool skip = false,
   int timeoutSeconds = testTimeoutSeconds,
   NativeAutomatorConfig? nativeAutomatorConfig,
+  TestVariant<Object?> variant = const DefaultTestVariant(),
 }) {
   /// The patrolTest skip functionality does not work as expected and can
   /// hang the test execution.
@@ -74,10 +83,12 @@ void patrol(
     debugPrint('Skipping test: $description');
     return;
   }
+
   patrolTest(
     description,
     callback,
     skip: skip,
+    variant: variant,
     timeout: Timeout(Duration(seconds: timeoutSeconds)),
     nativeAutomatorConfig: nativeAutomatorConfig ?? _nativeAutomatorConfig,
   );
@@ -265,7 +276,7 @@ Future<GoogleMapViewController> getMapViewControllerForTestMapType(
 
   switch (testMapType) {
     /// Set up map.
-    case TestMapType.map:
+    case TestMapType.mapView:
       viewController = await startMapView(
         $,
         onMarkerClicked: onMarkerClicked,
@@ -286,7 +297,7 @@ Future<GoogleMapViewController> getMapViewControllerForTestMapType(
       break;
 
     /// Set up navigation map.
-    case TestMapType.navigation:
+    case TestMapType.navigationView:
       viewController = await startNavigationWithoutDestination($,
           initializeNavigation: initializeNavigation,
           simulateLocation: simulateLocation,

example/integration_test/t03_navigation_test.dart

@@ -598,23 +598,30 @@ void main() {
       displayOptions: NavigationDisplayOptions(showDestinationMarkers: false),
     );
 
-    /// Cut network connection.
-    await $.native.disableCellular();
-    await $.native.disableWifi();
-
-    /// Test that the error is received.
-    final NavigationRouteStatus routeStatus =
-        await GoogleMapsNavigator.setDestinations(destinations);
-    expect(routeStatus, equals(NavigationRouteStatus.networkError));
-
-    final NavigationRouteStatus routeStatusSim = await GoogleMapsNavigator
-        .simulator
-        .simulateLocationsAlongNewRoute(waypoint);
-    expect(routeStatusSim, equals(NavigationRouteStatus.networkError));
-
-    /// Re-enable network connection.
-    await $.native.enableCellular();
-    await $.native.enableWifi();
+    try {
+      /// Cut network connection.
+      await $.native.disableCellular();
+      await $.native.disableWifi();
+
+      // Wait a while to ensure network is down.
+      await $.pumpAndSettle(duration: const Duration(seconds: 1));
+
+      /// Test that the error is received.
+      final NavigationRouteStatus routeStatus =
+          await GoogleMapsNavigator.setDestinations(destinations);
+      expect(routeStatus, equals(NavigationRouteStatus.networkError),
+          reason: 'setDestinations did not return networkError');
+
+      final NavigationRouteStatus routeStatusSim = await GoogleMapsNavigator
+          .simulator
+          .simulateLocationsAlongNewRoute(waypoint);
+      expect(routeStatusSim, equals(NavigationRouteStatus.networkError),
+          reason: 'simulateLocationsAlongNewRoute did not return networkError');
+    } finally {
+      /// Re-enable network connection.
+      await $.native.enableCellular();
+      await $.native.enableWifi();
+    }
   }, skip: Platform.isIOS && !isPhysicalDevice);
 
   patrol('Test route not found errors', (PatrolIntegrationTester $) async {

example/integration_test/t06_map_test.dart

@@ -26,12 +26,14 @@ import 'package:flutter/material.dart';
 import 'shared.dart';
 
 void main() {
-  for (final TestMapType testMapType in testMapTypes) {
-    patrol('Test map types (${testMapType.name})',
-        (PatrolIntegrationTester $) async {
+  final mapTypeVariants = getMapTypeVariants();
+  patrol(
+    'Test map types',
+    (PatrolIntegrationTester $) async {
       /// Get viewController for the test type (navigation map or regular map).
       GoogleMapViewController viewController =
-          await getMapViewControllerForTestMapType($, testMapType: testMapType);
+          await getMapViewControllerForTestMapType($,
+              testMapType: mapTypeVariants.currentValue!);
 
       // Test default type.
       expect(await viewController.getMapType(), MapType.normal);
@@ -47,17 +49,18 @@ void main() {
         await viewController.setMapType(mapType: type);
         expect(await viewController.getMapType(), type);
       }
-    });
-  }
+    },
+    variant: mapTypeVariants,
+  );
 
-  for (final TestMapType testMapType in testMapTypes) {
-    patrol('Test platform view creation params (${testMapType.name})',
-        (PatrolIntegrationTester $) async {
+  patrol(
+    'Test platform view creation params',
+    (PatrolIntegrationTester $) async {
       final Completer<GoogleMapViewController> controllerCompleter =
           Completer<GoogleMapViewController>();
 
-      switch (testMapType) {
-        case TestMapType.map:
+      switch (mapTypeVariants.currentValue!) {
+        case TestMapType.mapView:
           final Key key = GlobalKey();
           await pumpMapView(
             $,
@@ -78,7 +81,7 @@ void main() {
             ),
           );
           break;
-        case TestMapType.navigation:
+        case TestMapType.navigationView:
           final Key key = GlobalKey();
           await pumpNavigationView(
             $,
@@ -119,12 +122,13 @@ void main() {
         expect(await controller.settings.isZoomControlsEnabled(), false);
         expect(await controller.settings.isMapToolbarEnabled(), false);
       }
-    });
-  }
+    },
+    variant: mapTypeVariants,
+  );
 
-  for (final TestMapType testMapType in testMapTypes) {
-    patrol('Test map UI settings (${testMapType.name})',
-        (PatrolIntegrationTester $) async {
+  patrol(
+    'Test map UI settings',
+    (PatrolIntegrationTester $) async {
       /// The events are not tested because there's currently no reliable way to trigger them.
       void onMyLocationButtonClicked(MyLocationButtonClickedEvent event) {
         debugPrint('My location button clicked event: currently $event');
@@ -149,7 +153,7 @@ void main() {
           /// Get viewController for the test type (navigation map or regular map).
           await getMapViewControllerForTestMapType(
         $,
-        testMapType: testMapType,
+        testMapType: mapTypeVariants.currentValue!,
         initializeNavigation: false,
         onMapClicked: expectAsync1((LatLng msg) {
           expectSync(msg, isA<LatLng>());
@@ -247,15 +251,17 @@ void main() {
           expect(e, const TypeMatcher<UnsupportedError>());
         }
       }
-    });
-  }
+    },
+    variant: mapTypeVariants,
+  );
 
-  for (final TestMapType testMapType in testMapTypes) {
-    patrol('Test map style (${testMapType.name})',
-        (PatrolIntegrationTester $) async {
+  patrol(
+    'Test map style',
+    (PatrolIntegrationTester $) async {
       /// Get viewController for the test type (navigation map or regular map).
       GoogleMapViewController viewController =
-          await getMapViewControllerForTestMapType($, testMapType: testMapType);
+          await getMapViewControllerForTestMapType($,
+              testMapType: mapTypeVariants.currentValue!);
 
       // Test that valid json doens't throw exception.
       await viewController.setMapStyle(
@@ -271,21 +277,22 @@ void main() {
       } on MapStyleException catch (e) {
         expect(e, isNotNull);
       }
-    });
-  }
+    },
+    variant: mapTypeVariants,
+  );
 
-  for (final TestMapType testMapType in testMapTypes) {
-    patrol('Test min max zoom level (${testMapType.name})',
-        (PatrolIntegrationTester $) async {
+  patrol(
+    'Test min max zoom level',
+    (PatrolIntegrationTester $) async {
       /// For some reason the functionality works on Android example app, but it doesn't work
       /// during the testing. Will skip Android testing for now.
       final Completer<GoogleMapViewController> viewControllerCompleter =
           Completer<GoogleMapViewController>();
 
       await checkLocationDialogAcceptance($);
 
-      switch (testMapType) {
-        case TestMapType.map:
+      switch (mapTypeVariants.currentValue!) {
+        case TestMapType.mapView:
 
           /// Display map view.
           final Key key = GlobalKey();
@@ -299,7 +306,7 @@ void main() {
             ),
           );
           break;
-        case TestMapType.navigation:
+        case TestMapType.navigationView:
 
           /// Display navigation view.
           final Key key = GlobalKey();
@@ -363,6 +370,7 @@ void main() {
       // Expect the same values. The actual zoom level will be limited by the map.
       expect(newMinZoomPreference, 0.0);
       expect(newMaxZoomPreference, 50.0);
-    });
-  }
+    },
+    variant: mapTypeVariants,
+  );
 }