coverage: Allow specifying coverage flags via a yaml file (#1954)

Author: Dhruv-Maradiya

pkgs/coverage/.gitignore

@@ -15,4 +15,4 @@ build
 # Temp files
 *~
 coverage/
-var/
+var/

pkgs/coverage/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.12.0-wip
+
+- Introduced support for specifying coverage flags through a YAML file.
+
 ## 1.11.1
 
 - Update `package:vm_service` constraints to '>=12.0.0 <16.0.0'.

pkgs/coverage/bin/collect_coverage.dart

@@ -8,7 +8,10 @@ import 'dart:io';
 
 import 'package:args/args.dart';
 import 'package:coverage/src/collect.dart';
+import 'package:coverage/src/coverage_options.dart';
 import 'package:logging/logging.dart';
+import 'package:meta/meta.dart';
+import 'package:path/path.dart' as p;
 import 'package:stack_trace/stack_trace.dart';
 
 Future<void> main(List<String> arguments) async {
@@ -17,15 +20,19 @@ Future<void> main(List<String> arguments) async {
     print('${rec.level.name}: ${rec.time}: ${rec.message}');
   });
 
-  final options = _parseArgs(arguments);
+  final defaultOptions = CoverageOptionsProvider().coverageOptions;
+  final options = parseArgs(arguments, defaultOptions);
+
+  final out = options.out == null ? stdout : File(options.out!).openWrite();
+
   await Chain.capture(() async {
     final coverage = await collect(options.serviceUri, options.resume,
         options.waitPaused, options.includeDart, options.scopedOutput,
         timeout: options.timeout,
         functionCoverage: options.functionCoverage,
         branchCoverage: options.branchCoverage);
-    options.out.write(json.encode(coverage));
-    await options.out.close();
+    out.write(json.encode(coverage));
+    await out.close();
   }, onError: (dynamic error, Chain chain) {
     stderr.writeln(error);
     stderr.writeln(chain.terse);
@@ -48,7 +55,7 @@ class Options {
       this.scopedOutput);
 
   final Uri serviceUri;
-  final IOSink out;
+  final String? out;
   final Duration? timeout;
   final bool waitPaused;
   final bool resume;
@@ -58,7 +65,8 @@ class Options {
   final Set<String> scopedOutput;
 }
 
-Options _parseArgs(List<String> arguments) {
+@visibleForTesting
+Options parseArgs(List<String> arguments, CoverageOptions defaultOptions) {
   final parser = ArgParser()
     ..addOption('host',
         abbr: 'H',
@@ -69,11 +77,11 @@ Options _parseArgs(List<String> arguments) {
         help: 'remote VM port. DEPRECATED: use --uri',
         defaultsTo: '8181')
     ..addOption('uri', abbr: 'u', help: 'VM observatory service URI')
-    ..addOption('out',
-        abbr: 'o', defaultsTo: 'stdout', help: 'output: may be file or stdout')
+    ..addOption('out', abbr: 'o', help: 'output: may be file or stdout')
     ..addOption('connect-timeout',
         abbr: 't', help: 'connect timeout in seconds')
     ..addMultiOption('scope-output',
+        defaultsTo: defaultOptions.scopeOutput,
         help: 'restrict coverage results so that only scripts that start with '
             'the provided package path are considered')
     ..addFlag('wait-paused',
@@ -85,10 +93,12 @@ Options _parseArgs(List<String> arguments) {
     ..addFlag('include-dart',
         abbr: 'd', defaultsTo: false, help: 'include "dart:" libraries')
     ..addFlag('function-coverage',
-        abbr: 'f', defaultsTo: false, help: 'Collect function coverage info')
+        abbr: 'f',
+        defaultsTo: defaultOptions.functionCoverage,
+        help: 'Collect function coverage info')
     ..addFlag('branch-coverage',
         abbr: 'b',
-        defaultsTo: false,
+        defaultsTo: defaultOptions.branchCoverage,
         help: 'Collect branch coverage info (Dart VM must also be run with '
             '--branch-coverage for this to work)')
     ..addFlag('help', abbr: 'h', negatable: false, help: 'show this help');
@@ -125,13 +135,24 @@ Options _parseArgs(List<String> arguments) {
   }
 
   final scopedOutput = args['scope-output'] as List<String>;
-  IOSink out;
-  if (args['out'] == 'stdout') {
-    out = stdout;
+  String? out;
+  final outPath = args['out'] as String?;
+  if (outPath == 'stdout' ||
+      (outPath == null && defaultOptions.outputDirectory == null)) {
+    out = null;
   } else {
-    final outfile = File(args['out'] as String)..createSync(recursive: true);
-    out = outfile.openWrite();
+    final outFilePath = p.normalize(outPath ??
+        p.absolute(defaultOptions.outputDirectory!, 'coverage.json'));
+
+    final outFile = File(outFilePath);
+    if (!FileSystemEntity.isDirectorySync(outFilePath) &&
+        !FileSystemEntity.isFileSync(outFilePath)) {
+      outFile.createSync(recursive: true);
+    }
+
+    out = outFile.path;
   }
+
   final timeout = (args['connect-timeout'] == null)
       ? null
       : Duration(seconds: int.parse(args['connect-timeout'] as String));

pkgs/coverage/bin/format_coverage.dart

@@ -6,6 +6,7 @@ import 'dart:io';
 
 import 'package:args/args.dart';
 import 'package:coverage/coverage.dart';
+import 'package:coverage/src/coverage_options.dart';
 import 'package:glob/glob.dart';
 import 'package:path/path.dart' as p;
 
@@ -37,7 +38,7 @@ class Environment {
   bool checkIgnore;
   String input;
   bool lcov;
-  IOSink output;
+  String? output;
   String? packagesPath;
   String packagePath;
   bool prettyPrint;
@@ -51,7 +52,8 @@ class Environment {
 }
 
 Future<void> main(List<String> arguments) async {
-  final env = parseArgs(arguments);
+  final defaultOptions = CoverageOptionsProvider().coverageOptions;
+  final env = parseArgs(arguments, defaultOptions);
 
   final files = filesToProcess(env.input);
   if (env.verbose) {
@@ -104,8 +106,11 @@ Future<void> main(List<String> arguments) async {
         basePath: env.baseDirectory);
   }
 
-  env.output.write(output);
-  await env.output.flush();
+  final outputSink =
+      env.output == null ? stdout : File(env.output!).openWrite();
+
+  outputSink.write(output);
+  await outputSink.flush();
   if (env.verbose) {
     print('Done flushing output. Took ${clock.elapsedMilliseconds} ms.');
   }
@@ -124,26 +129,43 @@ Future<void> main(List<String> arguments) async {
       }
     }
   }
-  await env.output.close();
+  await outputSink.close();
 }
 
 /// Checks the validity of the provided arguments. Does not initialize actual
 /// processing.
-Environment parseArgs(List<String> arguments) {
+Environment parseArgs(List<String> arguments, CoverageOptions defaultOptions) {
   final parser = ArgParser();
 
   parser
-    ..addOption('sdk-root', abbr: 's', help: 'path to the SDK root')
-    ..addOption('packages', help: '[DEPRECATED] path to the package spec file')
+    ..addOption(
+      'sdk-root',
+      abbr: 's',
+      help: 'path to the SDK root',
+    )
+    ..addOption(
+      'packages',
+      help: '[DEPRECATED] path to the package spec file',
+    )
     ..addOption('package',
-        help: 'root directory of the package', defaultsTo: '.')
-    ..addOption('in', abbr: 'i', help: 'input(s): may be file or directory')
-    ..addOption('out',
-        abbr: 'o', defaultsTo: 'stdout', help: 'output: may be file or stdout')
-    ..addMultiOption('report-on',
-        help: 'which directories or files to report coverage on')
-    ..addOption('workers',
-        abbr: 'j', defaultsTo: '1', help: 'number of workers')
+        help: 'root directory of the package',
+        defaultsTo: defaultOptions.packageDirectory)
+    ..addOption(
+      'in',
+      abbr: 'i',
+      help: 'input(s): may be file or directory',
+    )
+    ..addOption('out', abbr: 'o', help: 'output: may be file or stdout')
+    ..addMultiOption(
+      'report-on',
+      help: 'which directories or files to report coverage on',
+    )
+    ..addOption(
+      'workers',
+      abbr: 'j',
+      defaultsTo: '1',
+      help: 'number of workers',
+    )
     ..addOption('bazel-workspace',
         defaultsTo: '', help: 'Bazel workspace directory')
     ..addOption('base-directory',
@@ -220,20 +242,31 @@ Environment parseArgs(List<String> arguments) {
     fail('Package spec "${args["package"]}" not found, or not a directory.');
   }
 
-  if (args['in'] == null) fail('No input files given.');
-  final input = p.absolute(p.normalize(args['in'] as String));
+  if (args['in'] == null && defaultOptions.outputDirectory == null) {
+    fail('No input files given.');
+  }
+  final input = p.normalize((args['in'] as String?) ??
+      p.absolute(defaultOptions.outputDirectory!, 'coverage.json'));
   if (!FileSystemEntity.isDirectorySync(input) &&
       !FileSystemEntity.isFileSync(input)) {
     fail('Provided input "${args["in"]}" is neither a directory nor a file.');
   }
 
-  IOSink output;
-  if (args['out'] == 'stdout') {
-    output = stdout;
+  String? output;
+  final outPath = args['out'] as String?;
+  if (outPath == 'stdout' ||
+      (outPath == null && defaultOptions.outputDirectory == null)) {
+    output = null;
   } else {
-    final outpath = p.absolute(p.normalize(args['out'] as String));
-    final outfile = File(outpath)..createSync(recursive: true);
-    output = outfile.openWrite();
+    final outFilePath = p.normalize(
+        outPath ?? p.absolute(defaultOptions.outputDirectory!, 'lcov.info'));
+
+    final outfile = File(outFilePath);
+    if (!FileSystemEntity.isDirectorySync(outFilePath) &&
+        !FileSystemEntity.isFileSync(outFilePath)) {
+      outfile.createSync(recursive: true);
+    }
+    output = outfile.path;
   }
 
   final reportOnRaw = args['report-on'] as List<String>;

pkgs/coverage/bin/test_with_coverage.dart

@@ -6,8 +6,10 @@ import 'dart:async';
 import 'dart:io';
 
 import 'package:args/args.dart';
+import 'package:coverage/src/coverage_options.dart';
 import 'package:coverage/src/util.dart'
     show StandardOutExtension, extractVMServiceUri;
+import 'package:meta/meta.dart';
 import 'package:package_config/package_config.dart';
 import 'package:path/path.dart' as path;
 
@@ -50,37 +52,41 @@ void _watchExitSignal(ProcessSignal signal) {
   });
 }
 
-ArgParser _createArgParser() => ArgParser()
+ArgParser _createArgParser(CoverageOptions defaultOptions) => ArgParser()
   ..addOption(
     'package',
     help: 'Root directory of the package to test.',
-    defaultsTo: '.',
+    defaultsTo: defaultOptions.packageDirectory,
   )
   ..addOption(
     'package-name',
     help: 'Name of the package to test. '
         'Deduced from --package if not provided.',
+    defaultsTo: defaultOptions.packageName,
   )
   ..addOption('port', help: 'VM service port.', defaultsTo: '8181')
   ..addOption(
     'out',
+    defaultsTo: defaultOptions.outputDirectory,
     abbr: 'o',
     help: 'Output directory. Defaults to <package-dir>/coverage.',
   )
-  ..addOption('test', help: 'Test script to run.', defaultsTo: 'test')
+  ..addOption('test',
+      help: 'Test script to run.', defaultsTo: defaultOptions.testScript)
   ..addFlag(
     'function-coverage',
     abbr: 'f',
-    defaultsTo: false,
+    defaultsTo: defaultOptions.functionCoverage,
     help: 'Collect function coverage info.',
   )
   ..addFlag(
     'branch-coverage',
     abbr: 'b',
-    defaultsTo: false,
+    defaultsTo: defaultOptions.branchCoverage,
     help: 'Collect branch coverage info.',
   )
   ..addMultiOption('scope-output',
+      defaultsTo: defaultOptions.scopeOutput,
       help: 'restrict coverage results so that only scripts that start with '
           'the provided package path are considered. Defaults to the name of '
           'the package under test.')
@@ -110,8 +116,10 @@ class Flags {
   final List<String> rest;
 }
 
-Future<Flags> _parseArgs(List<String> arguments) async {
-  final parser = _createArgParser();
+@visibleForTesting
+Future<Flags> parseArgs(
+    List<String> arguments, CoverageOptions defaultOptions) async {
+  final parser = _createArgParser(defaultOptions);
   final args = parser.parse(arguments);
 
   void printUsage() {
@@ -138,7 +146,7 @@ ${parser.usage}
     exit(0);
   }
 
-  final packageDir = path.canonicalize(args['package'] as String);
+  final packageDir = path.normalize(path.absolute(args['package'] as String));
   if (!FileSystemEntity.isDirectorySync(packageDir)) {
     fail('--package is not a valid directory.');
   }
@@ -166,7 +174,8 @@ ${parser.usage}
 }
 
 Future<void> main(List<String> arguments) async {
-  final flags = await _parseArgs(arguments);
+  final defaultOptions = CoverageOptionsProvider().coverageOptions;
+  final flags = await parseArgs(arguments, defaultOptions);
   final outJson = path.join(flags.outDir, 'coverage.json');
   final outLcov = path.join(flags.outDir, 'lcov.info');