Merge remote-tracking branch 'google/master' into feat/actions-config

Author: Dillon Nys

.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

@@ -3,44 +3,59 @@ import 'step.dart';
 
 enum ActionInfo implements Comparable<ActionInfo> {
   checkout(
+    name: 'Checkout repository',
     repo: 'actions/checkout',
     version: 'd0651293c4a5a52e711f25b41b05b2212f385d28', // v3
   ),
   cache(
+    name: 'Cache Pub hosted dependencies',
     repo: 'actions/cache',
     version: '4504faf7e9bcf8f3ed0bc863c4e1d21499ab8ef8', // v3
   ),
   setupDart(
+    name: 'Setup Dart SDK',
     repo: 'dart-lang/setup-dart',
     version: '6a218f2413a3e78e9087f638a238f6b40893203d', // v1.3
   ),
   setupFlutter(
+    name: 'Setup Flutter SDK',
     repo: 'subosito/flutter-action',
     version: '2fb73e25c9488eb544b9b14b2ce00c4c2baf789e', // v2.4.0
   ),
 
   /// See https://github.com/marketplace/actions/coveralls-github-action
   coveralls(
+    name: 'Upload coverage to Coveralls',
     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({
     required this.repo,
     required this.version,
+    required this.name,
     this.completionJobFactory,
   });
 
   final String repo;
   final String version;
+  final String name;
   final Job Function()? completionJobFactory;
 
   Step usage({
-    required String name,
+    String? name,
     String? id,
     Map<String, String>? withContent,
   }) {
+    name ??= this.name;
     final step = Step.uses(
       uses: '$repo@$version',
       id: id,

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

@@ -52,10 +52,7 @@ class _GeneratedGitHubConfig {
   _GeneratedGitHubConfig._(this.workflowFiles);
 
   factory _GeneratedGitHubConfig.generate(RootConfig rootConfig) {
-    final commandsToKeys = extractCommands(rootConfig);
-
-    final result = generateGitHubYml(rootConfig, commandsToKeys);
-
+    final result = generateGitHubYml(rootConfig);
     return _GeneratedGitHubConfig._(result);
   }
 }

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

@@ -6,6 +6,7 @@ import 'dart:collection';
 
 import 'package:path/path.dart';
 
+import '../../basic_config.dart';
 import '../../ci_shared.dart';
 import '../../github_config.dart';
 import '../../mono_config.dart';
@@ -22,10 +23,7 @@ import 'step.dart';
 
 const _onCompletionStage = '_on_completion';
 
-Map<String, String> generateGitHubYml(
-  RootConfig rootConfig,
-  Map<String, String> commandsToKeys,
-) {
+Map<String, String> generateGitHubYml(RootConfig rootConfig) {
   final jobs = <HasStageName>[
     ...rootConfig.expand((config) => config.jobs),
   ];
@@ -82,7 +80,6 @@ Map<String, String> generateGitHubYml(
     final allJobs = _listJobs(
       rootConfig,
       sortedJobs,
-      commandsToKeys,
       rootConfig.monoConfig.mergeStages,
       rootConfig.monoConfig.github.onCompletion,
       rootConfig.monoConfig.githubConditionalStages,
@@ -178,7 +175,6 @@ ${toYaml({'jobs': jobList})}
 Iterable<_MapEntryWithStage> _listJobs(
   RootConfig rootConfig,
   List<HasStageName> jobs,
-  Map<String, String> commandsToKeys,
   Set<String> mergeStages,
   List<Job>? onCompletionJobs,
   Map<String, ConditionalStage> conditionalStages,
@@ -203,12 +199,14 @@ 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;
     }
 
     final ciJob = job as CIJob;
 
+    final commandsToKeys = extractCommands(rootConfig);
+
     final commands =
         ciJob.tasks.map((task) => commandsToKeys[task.command]!).toList();
 
@@ -357,6 +355,7 @@ extension on CIJobEntry {
       job.flavor,
       job.sdk,
       commandEntries,
+      config: rootConfig.monoConfig,
       additionalCacheKeys: {
         'packages': packages.join('-'),
         'commands': commands.join('-'),
@@ -399,6 +398,7 @@ Job _githubJob(
   PackageFlavor packageFlavor,
   String sdkVersion,
   List<_CommandEntryBase> runCommands, {
+  required BasicConfiguration config,
   Map<String, String>? additionalCacheKeys,
 }) =>
     Job(
@@ -416,10 +416,9 @@ Job _githubJob(
         packageFlavor.setupStep(sdkVersion),
         ..._beforeSteps(runCommands.whereType<_CommandEntry>()),
         ActionInfo.checkout.usage(
-          name: 'Checkout repository',
           id: 'checkout',
         ),
-        for (var command in runCommands) ...command.runContent,
+        for (var command in runCommands) ...command.runContent(config),
       ],
     );
 
@@ -440,7 +439,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 implements GitHubActionOverrides {
@@ -489,9 +489,9 @@ class _CommandEntry extends _CommandEntryBase implements GitHubActionOverrides {
   });
 
   @override
-  Iterable<Step> get runContent => [
+  Iterable<Step> runContent(BasicConfiguration config) => [
         Step.fromOverrides(this),
-        ...?type?.afterEachSteps(workingDirectory),
+        ...?type?.afterEachSteps(workingDirectory, config),
       ];
 }
 
@@ -524,7 +524,6 @@ Step _cacheEntries(
   const pubCacheHosted = '~/.pub-cache/hosted';
 
   return ActionInfo.cache.usage(
-    name: 'Cache Pub hosted dependencies',
     withContent: {
       'path': pubCacheHosted,
       'key': restoreKeys.first,
@@ -540,7 +539,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,
@@ -549,6 +548,7 @@ Job _selfValidateJob() => _githubJob(
         for (var command in selfValidateCommands)
           _CommandEntryBase(selfValidateJobName, command),
       ],
+      config: config,
     );
 
 const _ubuntuLatest = 'ubuntu-latest';
@@ -580,13 +580,11 @@ extension on PackageFlavor {
     switch (this) {
       case PackageFlavor.dart:
         return ActionInfo.setupDart.usage(
-          name: 'Setup Dart SDK',
           withContent: {'sdk': sdkVersion},
         );
 
       case PackageFlavor.flutter:
         return ActionInfo.setupFlutter.usage(
-          name: 'Setup Flutter SDK',
           withContent: {'channel': sdkVersion},
         );
     }

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);
+}