Code coverage

packages/patrol/lib/src/binding.dart

@@ -1,5 +1,7 @@
 import 'dart:convert';
+import 'dart:developer';
 import 'dart:io' as io;
+import 'dart:isolate';
 
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
@@ -93,6 +95,29 @@ class PatrolBinding extends LiveTestWidgetsFlutterBinding {
       final nameOfRequestedTest = await patrolAppService.testExecutionRequested;
 
       if (nameOfRequestedTest == _currentDartTest) {
+        if (const bool.fromEnvironment('COVERAGE_ENABLED')) {
+          postEvent(
+            'waitForCoverageCollection',
+            {'mainIsolateId': Service.getIsolateId(Isolate.current)},
+          );
+
+          var coverageCollected = false;
+
+          registerExtension(
+            'ext.patrol.markTestCompleted',
+            (method, parameters) async {
+              coverageCollected = true;
+              return ServiceExtensionResponse.result(jsonEncode({}));
+            },
+          );
+
+          while (!coverageCollected) {
+            // The loop is needed to keep this isolate alive until the coverage
+            // data is collected.
+            await Future<void>.delayed(const Duration(seconds: 1));
+          }
+        }
+
         logger(
           'finished test $_currentDartTest. Will report its status back to the native side',
         );
@@ -101,6 +126,7 @@ class PatrolBinding extends LiveTestWidgetsFlutterBinding {
         logger(
           'tearDown(): test "$testName" in group "$_currentDartTest", passed: $passed',
         );
+
         await patrolAppService.markDartTestAsCompleted(
           dartFileName: _currentDartTest!,
           passed: passed,

packages/patrol/lib/src/common.dart

@@ -1,3 +1,4 @@
+import 'dart:developer';
 import 'dart:io' as io;
 
 import 'package:flutter/foundation.dart';
@@ -237,19 +238,34 @@ String deduplicateGroupEntryName(String parentName, String currentName) {
   );
 }
 
-/// Recursively prints the structure of the test suite.
+/// Recursively prints the structure of the test suite and reports test count
+/// of the top-most group
 @internal
-void printGroupStructure(DartGroupEntry group, {int indentation = 0}) {
+int reportGroupStructure(DartGroupEntry group, {int indentation = 0}) {
+  var testCount = group.type == GroupEntryType.test ? 1 : 0;
+
   final indent = ' ' * indentation;
-  debugPrint("$indent-- group: '${group.name}'");
+  final tag = group.type == GroupEntryType.group ? 'group' : 'test';
+  debugPrint("$indent-- $tag: '${group.name}'");
 
   for (final entry in group.entries) {
     if (entry.type == GroupEntryType.test) {
+      ++testCount;
       debugPrint("$indent     -- test: '${entry.name}'");
     } else {
       for (final subgroup in entry.entries) {
-        printGroupStructure(subgroup, indentation: indentation + 5);
+        testCount +=
+            reportGroupStructure(subgroup, indentation: indentation + 5);
       }
     }
   }
+
+  if (indentation == 0) {
+    postEvent(
+      'testCount',
+      {'testCount': testCount},
+    );
+  }
+
+  return testCount;
 }

packages/patrol_cli/lib/src/commands/test.dart

@@ -1,10 +1,12 @@
 import 'dart:async';
 
+import 'package:glob/glob.dart';
 import 'package:patrol_cli/src/analytics/analytics.dart';
 import 'package:patrol_cli/src/android/android_test_backend.dart';
 import 'package:patrol_cli/src/base/extensions/core.dart';
 import 'package:patrol_cli/src/base/logger.dart';
 import 'package:patrol_cli/src/compatibility_checker.dart';
+import 'package:patrol_cli/src/coverage/coverage_tool.dart';
 import 'package:patrol_cli/src/crossplatform/app_options.dart';
 import 'package:patrol_cli/src/dart_defines_reader.dart';
 import 'package:patrol_cli/src/devices.dart';
@@ -26,6 +28,7 @@ class TestCommand extends PatrolCommand {
     required AndroidTestBackend androidTestBackend,
     required IOSTestBackend iosTestBackend,
     required MacOSTestBackend macOSTestBackend,
+    required CoverageTool coverageTool,
     required Analytics analytics,
     required Logger logger,
   })  : _deviceFinder = deviceFinder,
@@ -37,6 +40,7 @@ class TestCommand extends PatrolCommand {
         _androidTestBackend = androidTestBackend,
         _iosTestBackend = iosTestBackend,
         _macosTestBackend = macOSTestBackend,
+        _coverageTool = coverageTool,
         _analytics = analytics,
         _logger = logger {
     usesTargetOption();
@@ -47,6 +51,7 @@ class TestCommand extends PatrolCommand {
     usesLabelOption();
     usesWaitOption();
     usesPortOptions();
+    useCoverageOptions();
 
     usesUninstallOption();
 
@@ -63,6 +68,7 @@ class TestCommand extends PatrolCommand {
   final AndroidTestBackend _androidTestBackend;
   final IOSTestBackend _iosTestBackend;
   final MacOSTestBackend _macosTestBackend;
+  final CoverageTool _coverageTool;
 
   final Analytics _analytics;
   final Logger _logger;
@@ -146,6 +152,8 @@ See https://github.com/leancodepl/patrol/issues/1316 to learn more.
     final wait = intArg('wait') ?? defaultWait;
     final displayLabel = boolArg('label');
     final uninstall = boolArg('uninstall');
+    final coverageEnabled = boolArg('coverage');
+    final ignoreGlobs = stringsArg('coverage-ignore').map(Glob.new).toSet();
 
     final customDartDefines = {
       ..._dartDefinesReader.fromFile(),
@@ -162,6 +170,7 @@ See https://github.com/leancodepl/patrol/issues/1316 to learn more.
       'PATROL_TEST_LABEL_ENABLED': displayLabel.toString(),
       'PATROL_TEST_SERVER_PORT': super.testServerPort.toString(),
       'PATROL_APP_SERVER_PORT': super.appServerPort.toString(),
+      'COVERAGE_ENABLED': coverageEnabled.toString(),
     }.withNullsRemoved();
 
     final dartDefines = {...customDartDefines, ...internalDartDefines};
@@ -214,6 +223,18 @@ See https://github.com/leancodepl/patrol/issues/1316 to learn more.
 
     await _build(androidOpts, iosOpts, macosOpts, device);
     await _preExecute(androidOpts, iosOpts, macosOpts, device, uninstall);
+
+    if (coverageEnabled) {
+      unawaited(
+        _coverageTool.run(
+          flutterPackageName: config.flutterPackageName,
+          platform: device.targetPlatform,
+          logger: _logger,
+          ignoreGlobs: ignoreGlobs,
+        ),
+      );
+    }
+
     final allPassed = await _execute(
       flutterOpts,
       androidOpts,
@@ -340,4 +361,16 @@ See https://github.com/leancodepl/patrol/issues/1316 to learn more.
 
     return allPassed;
   }
+
+  void useCoverageOptions() {
+    argParser
+      ..addFlag(
+        'coverage',
+        help: 'Generate coverage.',
+      )
+      ..addMultiOption(
+        'coverage-ignore',
+        help: 'Exclude files from coverage using glob patterns.',
+      );
+  }
 }