coverage: Allow specifying coverage flags via a yaml file

pkgs/coverage/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 1.12.0
+## 1.12.0-wip
 
 - Introduced support for specifying coverage flags through a YAML file.
 

pkgs/coverage/bin/collect_coverage.dart

@@ -133,11 +133,11 @@ Options _parseArgs(List<String> arguments, CoverageOptions defaultOptions) {
   IOSink out;
   final outPath = args['out'] as String?;
   if (outPath == 'stdout' ||
-      (outPath == null && defaultOptions.output == null)) {
+      (outPath == null && defaultOptions.outputDirectory == null)) {
     out = stdout;
   } else {
-    final outFilePath = p.absolute(
-        p.normalize(outPath ?? '${defaultOptions.output}/coverage.json'));
+    final outFilePath = p.canonicalize(
+        outPath ?? '${defaultOptions.outputDirectory}/coverage.json');
     final outFile = File(outFilePath)..createSync(recursive: true);
     out = outFile.openWrite();
   }

pkgs/coverage/bin/format_coverage.dart

@@ -146,7 +146,7 @@ Environment parseArgs(List<String> arguments, CoverageOptions defaultOptions) {
     )
     ..addOption('package',
         help: 'root directory of the package',
-        defaultsTo: defaultOptions.packagePath)
+        defaultsTo: defaultOptions.packageDirectory)
     ..addOption(
       'in',
       abbr: 'i',
@@ -239,11 +239,11 @@ Environment parseArgs(List<String> arguments, CoverageOptions defaultOptions) {
     fail('Package spec "${args["package"]}" not found, or not a directory.');
   }
 
-  if (args['in'] == null && defaultOptions.output == null) {
+  if (args['in'] == null && defaultOptions.outputDirectory == null) {
     fail('No input files given.');
   }
-  final inputPath =
-      args['in'] as String? ?? '${defaultOptions.output}/coverage.json';
+  final inputPath = args['in'] as String? ??
+      '${defaultOptions.outputDirectory}/coverage.json';
   final input = p.absolute(p.normalize(inputPath));
   if (!FileSystemEntity.isDirectorySync(input) &&
       !FileSystemEntity.isFileSync(input)) {
@@ -253,11 +253,11 @@ Environment parseArgs(List<String> arguments, CoverageOptions defaultOptions) {
   IOSink output;
   final outPath = args['out'] as String?;
   if (outPath == 'stdout' ||
-      (outPath == null && defaultOptions.output == null)) {
+      (outPath == null && defaultOptions.outputDirectory == null)) {
     output = stdout;
   } else {
     final outFilePath = p
-        .absolute(p.normalize(outPath ?? '${defaultOptions.output}/lcov.info'));
+        .canonicalize(outPath ?? '${defaultOptions.outputDirectory}/lcov.info');
     final outfile = File(outFilePath)..createSync(recursive: true);
     output = outfile.openWrite();
   }

pkgs/coverage/bin/test_with_coverage.dart

@@ -55,7 +55,7 @@ ArgParser _createArgParser(CoverageOptions defaultOptions) => ArgParser()
   ..addOption(
     'package',
     help: 'Root directory of the package to test.',
-    defaultsTo: defaultOptions.packagePath,
+    defaultsTo: defaultOptions.packageDirectory,
   )
   ..addOption(
     'package-name',
@@ -66,7 +66,7 @@ ArgParser _createArgParser(CoverageOptions defaultOptions) => ArgParser()
   ..addOption('port', help: 'VM service port.', defaultsTo: '8181')
   ..addOption(
     'out',
-    defaultsTo: defaultOptions.output,
+    defaultsTo: defaultOptions.outputDirectory,
     abbr: 'o',
     help: 'Output directory. Defaults to <package-dir>/coverage.',
   )
@@ -174,19 +174,6 @@ ${parser.usage}
 Future<void> main(List<String> arguments) async {
   final defaultOptions = CoverageOptionsProvider().coverageOptions;
   final flags = await _parseArgs(arguments, defaultOptions);
-
-  print('Flags: ');
-  print('  packageDir: ${flags.packageDir}');
-  print('  packageName: ${flags.packageName}');
-  print('  outDir: ${flags.outDir}');
-  print('  port: ${flags.port}');
-  print('  testScript: ${flags.testScript}');
-  print('  functionCoverage: ${flags.functionCoverage}');
-  print('  branchCoverage: ${flags.branchCoverage}');
-  print('  scopeOutput: ${flags.scopeOutput}');
-  print('  rest: ${flags.rest}');
-  print('');
-
   final outJson = path.join(flags.outDir, 'coverage.json');
   final outLcov = path.join(flags.outDir, 'lcov.info');
 

pkgs/coverage/lib/src/coverage_options.dart

@@ -1,40 +1,55 @@
 import 'dart:io';
 import 'package:cli_config/cli_config.dart';
+import 'package:path/path.dart' as path;
 
 class CoverageOptions {
   const CoverageOptions({
-    required this.output,
+    this.outputDirectory,
     required this.scopeOutput,
     required this.functionCoverage,
     required this.branchCoverage,
-    required this.packagePath,
+    required this.packageDirectory,
     this.packageName,
     required this.testScript,
   });
 
   factory CoverageOptions.fromConfig(
-      Config options, CoverageOptions defaultOptions) {
+      Config options, CoverageOptions defaultOptions, String optionsFilePath) {
+    var outputDirectory = options.optionalString('output_directory') ??
+        defaultOptions.outputDirectory;
+    var packageDirectory = options.optionalString('package_directory') ??
+        defaultOptions.packageDirectory;
+
+    if (outputDirectory != null && !path.isAbsolute(outputDirectory)) {
+      outputDirectory = path.canonicalize(
+          path.join(path.dirname(optionsFilePath), outputDirectory));
+    }
+    if (!path.isAbsolute(packageDirectory)) {
+      packageDirectory = path.canonicalize(
+          path.join(path.dirname(optionsFilePath), packageDirectory));
+    }
+
     return CoverageOptions(
-      output: options.optionalString('out') ?? defaultOptions.output,
+      outputDirectory: outputDirectory,
       scopeOutput: options.optionalStringList('scope_output') ??
           defaultOptions.scopeOutput,
       functionCoverage: options.optionalBool('function_coverage') ??
           defaultOptions.functionCoverage,
       branchCoverage: options.optionalBool('branch_coverage') ??
           defaultOptions.branchCoverage,
-      packagePath:
-          options.optionalString('package') ?? defaultOptions.packagePath,
+      packageDirectory: packageDirectory,
       packageName:
           options.optionalString('package_name') ?? defaultOptions.packageName,
-      testScript: options.optionalString('test') ?? defaultOptions.testScript,
+      testScript:
+          options.optionalString('test_script') ?? defaultOptions.testScript,
     );
   }
 
-  final String? output;
+  final String? outputDirectory;
   final List<String> scopeOutput;
   final bool functionCoverage;
   final bool branchCoverage;
-  final String packagePath;
+  final String packageDirectory;
   final String? packageName;
   final String testScript;
 }
@@ -43,7 +58,7 @@ class CoverageOptionsProvider {
   CoverageOptionsProvider({
     String? filePath,
   }) {
-    final file = _getOptionsFile(filePath ?? CoverageOptionsProvider.filePath);
+    final file = _getOptionsFile(filePath);
     final fileContents = file?.readAsStringSync();
 
     final isFileEmpty = fileContents?.isEmpty ?? false;
@@ -54,24 +69,48 @@ class CoverageOptionsProvider {
       fileSourceUri: file?.uri,
     );
 
-    coverageOptions = CoverageOptions.fromConfig(options, defaultOptions);
+    coverageOptions =
+        CoverageOptions.fromConfig(options, defaultOptions, optionsFilePath);
   }
 
   late final CoverageOptions coverageOptions;
+  late final String optionsFilePath;
+  static const defaultFilePath = 'coverage_options.yaml';
+
+  File? _getOptionsFile(String? filePath) {
+    filePath ??= _findOptionsFilePath();
+    if (filePath == null) {
+      throw StateError('Could not find a pubspec.yaml file.');
+    }
 
-  static const filePath = 'coverage.yaml';
+    optionsFilePath = path.canonicalize(filePath);
 
-  static File? _getOptionsFile(String filePath) {
-    final file = File(filePath);
+    final file = File(optionsFilePath);
     return file.existsSync() ? file : null;
   }
 
+  String? _findOptionsFilePath() {
+    var currentDir = Directory.current;
+
+    while (true) {
+      final pubSpecFilePath = path.join(currentDir.path, 'pubspec.yaml');
+      if (File(pubSpecFilePath).existsSync()) {
+        return path.join(currentDir.path, defaultFilePath);
+      }
+      final parentDir = currentDir.parent;
+      if (parentDir.path == currentDir.path) {
+        return null;
+      }
+      currentDir = parentDir;
+    }
+  }
+
   static const defaultOptions = CoverageOptions(
-    output: null,
+    outputDirectory: null,
     scopeOutput: [],
     functionCoverage: false,
     branchCoverage: false,
-    packagePath: '.',
+    packageDirectory: '.',
     packageName: null,
     testScript: 'test',
   );

pkgs/coverage/pubspec.yaml

@@ -1,5 +1,5 @@
 name: coverage
-version: 1.12.0
+version: 1.12.0-wip
 description: Coverage data manipulation and formatting
 repository: https://github.com/dart-lang/tools/tree/main/pkgs/coverage
 issue_tracker: https://github.com/dart-lang/tools/issues?q=is%3Aissue+is%3Aopen+label%3Apackage%3Acoverage