Support codecov (with configuration) for test_with_coverage (#405)

Author: kevmoo

.github/workflows/dart.yml

@@ -2,6 +2,10 @@
 merge_stages:
 - smoke_test
 
+coverage_service:
+- coveralls
+- codecov
+
 github:
   # Setting just `cron` keeps the defaults for `push` and `pull_request`
   cron: '0 0 * * 0' # “At 00:00 (UTC) on Sunday.”

mono_repo.yaml

@@ -2,8 +2,8 @@
 ## 6.4.0-dev
 
 - Added support for `test_with_coverage`.
-  Uses `package:coverage` and [Coveralls](https://coveralls.io) to track test
-  code coverage.
+  Uses `package:coverage` and supports [Coveralls](https://coveralls.io)
+  (the default) and [Codecov](https://codecov.com/) to track test code coverage.
 - Added `--verbose` flag. Helps when debugging failures.
 
 ## 6.3.0

mono_repo/CHANGELOG.md

@@ -137,6 +137,17 @@ self_validate: analyze
 # Use this key to merge stages across packages to create fewer jobs
 merge_stages:
 - analyze
+
+# When using `test_with_coverage`, this setting configures the service that
+# results are uploaded to.
+# Note: you can configure both options, but this would be unusual.
+# Note: you can configure this key with no values, to just generate the files
+#   locally. This may be to enable other, custom processing.
+coverage_service:
+# https://coveralls.io/ - the default
+- coveralls
+# https://codecov.io/ – the other option
+- codecov
 ```
 
 ### Adding a package config

mono_repo/README.md

@@ -0,0 +1,13 @@
+// Copyright (c) 2022, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'coverage_processor.dart';
+
+/// Represents top-level configuration values that are needed by specific
+/// jobs or actions.
+///
+/// Meant to be minimal and expanded on an as-needed basis.
+abstract class BasicConfiguration {
+  Set<CoverageProcessor> get coverageProcessors;
+}

mono_repo/lib/src/basic_config.dart

@@ -29,6 +29,13 @@ enum ActionInfo implements Comparable<ActionInfo> {
     repo: 'coverallsapp/github-action',
     version: 'master',
     completionJobFactory: _coverageCompletionJob,
+  ),
+
+  /// See https://github.com/marketplace/actions/codecov
+  codecov(
+    name: 'Upload coverage to codecov.io',
+    repo: 'codecov/codecov-action',
+    version: 'master',
   );
 
   const ActionInfo({

mono_repo/lib/src/commands/github/action_info.dart

@@ -4,6 +4,7 @@
 
 import 'dart:collection';
 
+import '../../basic_config.dart';
 import '../../ci_shared.dart';
 import '../../github_config.dart';
 import '../../mono_config.dart';
@@ -195,7 +196,7 @@ Iterable<_MapEntryWithStage> _listJobs(
 
   for (var job in jobs) {
     if (job is _SelfValidateJob) {
-      yield jobEntry(_selfValidateJob(), job.stageName);
+      yield jobEntry(_selfValidateJob(rootConfig.monoConfig), job.stageName);
       continue;
     }
 
@@ -331,6 +332,7 @@ extension on CIJobEntry {
       job.flavor,
       job.sdk,
       commandEntries,
+      config: rootConfig.monoConfig,
       additionalCacheKeys: {
         'packages': packages.join('-'),
         'commands': commands.join('-'),
@@ -373,6 +375,7 @@ Job _githubJob(
   PackageFlavor packageFlavor,
   String sdkVersion,
   List<_CommandEntryBase> runCommands, {
+  required BasicConfiguration config,
   Map<String, String>? additionalCacheKeys,
 }) =>
     Job(
@@ -392,7 +395,7 @@ Job _githubJob(
         ActionInfo.checkout.usage(
           id: 'checkout',
         ),
-        for (var command in runCommands) ...command.runContent,
+        for (var command in runCommands) ...command.runContent(config),
       ],
     );
 
@@ -413,7 +416,8 @@ class _CommandEntryBase {
 
   _CommandEntryBase(this.name, this.run);
 
-  Iterable<Step> get runContent => [Step.run(name: name, run: run)];
+  Iterable<Step> runContent(BasicConfiguration config) =>
+      [Step.run(name: name, run: run)];
 }
 
 class _CommandEntry extends _CommandEntryBase {
@@ -432,15 +436,15 @@ class _CommandEntry extends _CommandEntryBase {
   });
 
   @override
-  Iterable<Step> get runContent => [
+  Iterable<Step> runContent(BasicConfiguration config) => [
         Step.run(
           id: id,
           name: name,
           ifContent: ifCondition,
           workingDirectory: workingDirectory,
           run: run,
         ),
-        ...?type?.afterEachSteps(workingDirectory),
+        ...?type?.afterEachSteps(workingDirectory, config),
       ];
 }
 
@@ -488,7 +492,7 @@ String _maxLength(String input) {
   return input.substring(0, 512 - hash.length) + hash;
 }
 
-Job _selfValidateJob() => _githubJob(
+Job _selfValidateJob(BasicConfiguration config) => _githubJob(
       selfValidateJobName,
       _ubuntuLatest,
       PackageFlavor.dart,
@@ -497,6 +501,7 @@ Job _selfValidateJob() => _githubJob(
         for (var command in selfValidateCommands)
           _CommandEntryBase(selfValidateJobName, command),
       ],
+      config: config,
     );
 
 const _ubuntuLatest = 'ubuntu-latest';

mono_repo/lib/src/commands/github/github_yaml.dart

@@ -0,0 +1,14 @@
+// Copyright (c) 2022, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'commands/github/action_info.dart';
+
+enum CoverageProcessor {
+  coveralls(ActionInfo.coveralls),
+  codecov(ActionInfo.codecov);
+
+  final ActionInfo actionInfo;
+
+  const CoverageProcessor(this.actionInfo);
+}

mono_repo/lib/src/coverage_processor.dart

@@ -5,6 +5,8 @@
 import 'package:json_annotation/json_annotation.dart';
 import 'package:path/path.dart' as p;
 
+import 'basic_config.dart';
+import 'coverage_processor.dart';
 import 'github_config.dart';
 import 'yaml.dart';
 
@@ -18,6 +20,7 @@ const _allowedMonoConfigKeys = {
   'pretty_ansi',
   'pub_action',
   'self_validate',
+  'coverage_service',
 };
 
 const _defaultPubAction = 'upgrade';
@@ -27,41 +30,25 @@ const _allowedPubActions = {
   _defaultPubAction,
 };
 
-class MonoConfig {
+class MonoConfig implements BasicConfiguration {
   final Map<String, ConditionalStage> githubConditionalStages;
   final Set<String> mergeStages;
   final bool prettyAnsi;
   final String pubAction;
   final String? selfValidateStage;
   final GitHubConfig github;
-
-  factory MonoConfig({
-    required Set<String> mergeStages,
-    required bool prettyAnsi,
-    required String pubAction,
-    required String? selfValidateStage,
-    required Map github,
-  }) {
-    final githubConditionalStages = _readConditionalStages(github);
-
-    return MonoConfig._(
-      githubConditionalStages: githubConditionalStages,
-      mergeStages: mergeStages,
-      prettyAnsi: prettyAnsi,
-      pubAction: pubAction,
-      selfValidateStage: selfValidateStage,
-      github: GitHubConfig.fromJson(github),
-    );
-  }
+  @override
+  final Set<CoverageProcessor> coverageProcessors;
 
   MonoConfig._({
-    required this.githubConditionalStages,
     required this.mergeStages,
     required this.prettyAnsi,
     required this.pubAction,
     required this.selfValidateStage,
-    required this.github,
-  });
+    required Map github,
+    required this.coverageProcessors,
+  })  : githubConditionalStages = _readConditionalStages(github),
+        github = GitHubConfig.fromJson(github);
 
   factory MonoConfig.fromJson(Map json) {
     final unsupportedKeys =
@@ -135,53 +122,63 @@ class MonoConfig {
       );
     }
 
-    final mergeStages = json['merge_stages'] ?? [];
+    final mergeStages = _asList(json, 'merge_stages');
 
-    if (mergeStages is List) {
-      if (mergeStages.any((v) => v is! String)) {
-        throw CheckedFromJsonException(
-          json,
-          'merge_stages',
-          'MonoConfig',
-          'All values must be strings.',
-        );
-      }
+    final coverageServices = _asList(json, 'coverage_service');
 
-      return MonoConfig(
-        mergeStages: Set.from(mergeStages),
-        prettyAnsi: prettyAnsi,
-        pubAction: pubAction,
-        selfValidateStage: _selfValidateFromValue(selfValidate),
-        github: github,
-      );
-    } else {
-      throw CheckedFromJsonException(
-        json,
-        'merge_stages',
-        'MonoConfig',
-        '`merge_stages` must be an array.',
-      );
-    }
+    return MonoConfig._(
+      mergeStages: Set.from(mergeStages),
+      prettyAnsi: prettyAnsi,
+      pubAction: pubAction,
+      selfValidateStage: _selfValidateFromValue(selfValidate),
+      github: github,
+      coverageProcessors: coverageServices
+          .map((e) => CoverageProcessor.values.byName(e))
+          .toSet(),
+    );
   }
 
   factory MonoConfig.fromRepo({String? rootDirectory}) {
     rootDirectory ??= p.current;
 
     final yaml = yamlMapOrNull(rootDirectory, _monoConfigFileName);
     if (yaml == null || yaml.isEmpty) {
-      return MonoConfig(
+      return MonoConfig._(
         mergeStages: <String>{},
         pubAction: _defaultPubAction,
         prettyAnsi: true,
         selfValidateStage: null,
         github: {},
+        coverageProcessors: {CoverageProcessor.coveralls},
       );
     }
 
     return createWithCheck(() => MonoConfig.fromJson(yaml));
   }
 }
 
+List<String> _asList(Map json, String key) {
+  final value = json[key] ?? <String>[];
+
+  if (value is List) {
+    if (value.any((v) => v is! String)) {
+      throw CheckedFromJsonException(
+        json,
+        key,
+        'MonoConfig',
+        'All values must be strings.',
+      );
+    }
+    return List.from(value);
+  }
+  throw CheckedFromJsonException(
+    json,
+    key,
+    'MonoConfig',
+    '`$key` must be an array.',
+  );
+}
+
 /// Parses the `stages` key from a CI config map, into a Map from stage name
 /// to [ConditionalStage] instance.
 Map<String, ConditionalStage> _readConditionalStages(