feat: Adding report-on flag to the dart test command (#1348)

Author: erickzanardo

lib/src/cli/dart_cli.dart

@@ -110,6 +110,7 @@ class Dart {
     void Function(String)? stdout,
     void Function(String)? stderr,
     GeneratorBuilder buildGenerator = MasonGenerator.fromBundle,
+    String? reportOn,
   }) async {
     return TestCLIRunner.test(
       logger: logger,
@@ -126,6 +127,7 @@ class Dart {
       arguments: arguments,
       stdout: stdout,
       stderr: stderr,
+      reportOn: reportOn,
       buildGenerator: buildGenerator,
     );
   }

lib/src/cli/test_cli_runner.dart

@@ -78,6 +78,7 @@ class TestCLIRunner {
     void Function(String)? stdout,
     void Function(String)? stderr,
     GeneratorBuilder buildGenerator = MasonGenerator.fromBundle,
+    String? reportOn,
     @visibleForTesting VeryGoodTestRunner? overrideTestRunner,
   }) async {
     final initialCwd = cwd;
@@ -182,7 +183,7 @@ class TestCLIRunner {
 
                   final output = hitmap.formatLcov(
                     resolver,
-                    reportOn: ['lib'],
+                    reportOn: [reportOn ?? 'lib'],
                     basePath: cwd,
                   );
 

lib/src/commands/dart/commands/dart_test_command.dart

@@ -21,6 +21,7 @@ class DartTestOptions {
     required this.optimizePerformance,
     required this.forceAnsi,
     required this.rest,
+    required this.reportOn,
   });
 
   /// Parses [ArgResults] into a [DartTestOptions] instance.
@@ -40,6 +41,7 @@ class DartTestOptions {
         : randomOrderingSeed;
     final optimizePerformance = argResults['optimization'] as bool;
     final forceAnsi = argResults['force-ansi'] as bool?;
+    final reportOn = argResults['report-on'] as String?;
     final rest = argResults.rest;
 
     return DartTestOptions._(
@@ -52,6 +54,7 @@ class DartTestOptions {
       randomSeed: randomSeed,
       optimizePerformance: optimizePerformance,
       forceAnsi: forceAnsi,
+      reportOn: reportOn,
       rest: rest,
     );
   }
@@ -84,6 +87,9 @@ class DartTestOptions {
   /// default behavior based on stdout and stderr.
   final bool? forceAnsi;
 
+  /// An optional file path to report coverage information to.
+  final String? reportOn;
+
   /// The remaining arguments passed to the `dart test` command.
   final List<String> rest;
 }
@@ -106,6 +112,7 @@ typedef DartTestCommandCall =
       List<String>? arguments,
       void Function(String)? stdout,
       void Function(String)? stderr,
+      String? reportOn,
     });
 
 /// {@template dart_test_command}
@@ -176,6 +183,13 @@ class DartTestCommand extends Command<int> {
             'Whether to force ansi output. If not specified, '
             'it will maintain the default behavior based on stdout and stderr.',
         negatable: false,
+      )
+      ..addOption(
+        'report-on',
+        help:
+            'An optional file path to report coverage information to. '
+            'This should be a path relative to the current working directory.',
+        valueHelp: 'lib/',
       );
   }
 
@@ -234,6 +248,7 @@ This command should be run from the root of your Dart project.''');
             ...['-j', options.concurrency],
             ...options.rest,
           ],
+          reportOn: options.reportOn,
         );
         if (results.any((code) => code != ExitCode.success.code)) {
           return ExitCode.unavailable.code;

test/src/commands/dart/commands/dart_test_test.dart

@@ -37,6 +37,7 @@ const expectedTestUsage = [
       '    --min-coverage                    Whether to enforce a minimum coverage percentage.\n'
       '    --test-randomize-ordering-seed    The seed to randomize the execution order of test cases within test files.\n'
       '    --force-ansi                      Whether to force ansi output. If not specified, it will maintain the default behavior based on stdout and stderr.\n'
+      '    --report-on=<lib/>                An optional file path to report coverage information to. This should be a path relative to the current working directory.\n'
       '\n'
       'Run "very_good help" to see global options.',
 ];
@@ -58,6 +59,7 @@ abstract class DartTestCommandCall {
     void Function(String)? stdout,
     void Function(String)? stderr,
     bool? forceAnsi,
+    String? reportOn,
   });
 }
 
@@ -97,6 +99,7 @@ void main() {
           stdout: any(named: 'stdout'),
           stderr: any(named: 'stderr'),
           forceAnsi: any(named: 'forceAnsi'),
+          reportOn: any(named: 'reportOn'),
         ),
       ).thenAnswer((_) async => [0]);
       when<dynamic>(() => argResults['concurrency']).thenReturn(concurrency);
@@ -367,6 +370,28 @@ void main() {
       },
     );
 
+    test(
+      'reports on a different directory when --report-on is supplied',
+      () async {
+        when<dynamic>(() => argResults['min-coverage']).thenReturn('0');
+        when<dynamic>(() => argResults['report-on']).thenReturn('routes');
+        final result = await testCommand.run();
+        expect(result, equals(ExitCode.success.code));
+        verify(
+          () => dartTest(
+            optimizePerformance: true,
+            collectCoverage: true,
+            arguments: defaultArguments,
+            minCoverage: 0,
+            logger: logger,
+            stdout: logger.write,
+            stderr: logger.err,
+            reportOn: 'routes',
+          ),
+        ).called(1);
+      },
+    );
+
     test('fails when coverage not met', () async {
       when<dynamic>(() => argResults['coverage']).thenReturn(true);
       when<dynamic>(() => argResults['min-coverage']).thenReturn('100');