Add ignore flag to health workflows

.github/workflows/health.yaml

@@ -82,6 +82,21 @@ on:
         default: false
         required: false
         type: boolean
+      ignore_license:
+        description: Which files to ignore for the license check.
+        default: "\"\""
+        required: false
+        type: string
+      ignore_coverage:
+        description: Which files to ignore for the coverage check.
+        default: "\"\""
+        required: false
+        type: string
+      ignore_packages:
+        description: Which packages to ignore.
+        default: "\"\""
+        required: false
+        type: string
       checkout_submodules:
         description: Whether to checkout submodules of git repositories.
         default: false
@@ -104,6 +119,7 @@ jobs:
       warn_on: ${{ inputs.warn_on }}
       local_debug: ${{ inputs.local_debug }}
       use-flutter: ${{ inputs.use-flutter }}
+      ignore_packages: ${{ inputs.ignore_packages }}
       checkout_submodules: ${{ inputs.checkout_submodules }}
 
   changelog:
@@ -116,6 +132,7 @@ jobs:
       warn_on: ${{ inputs.warn_on }}
       local_debug: ${{ inputs.local_debug }}
       use-flutter: ${{ inputs.use-flutter }}
+      ignore_packages: ${{ inputs.ignore_packages }}
       checkout_submodules: ${{ inputs.checkout_submodules }}
 
   license:
@@ -128,6 +145,8 @@ jobs:
       warn_on: ${{ inputs.warn_on }}
       local_debug: ${{ inputs.local_debug }}
       use-flutter: ${{ inputs.use-flutter }}
+      ignore_license: ${{ inputs.ignore_license }}
+      ignore_packages: ${{ inputs.ignore_packages }}
       checkout_submodules: ${{ inputs.checkout_submodules }}
 
   coverage:
@@ -142,6 +161,8 @@ jobs:
       coverage_web: ${{ inputs.coverage_web }}
       local_debug: ${{ inputs.local_debug }}
       use-flutter: ${{ inputs.use-flutter }}
+      ignore_coverage: ${{ inputs.ignore_coverage }}
+      ignore_packages: ${{ inputs.ignore_packages }}
       checkout_submodules: ${{ inputs.checkout_submodules }}
       experiments: ${{ inputs.experiments }}
 
@@ -155,6 +176,7 @@ jobs:
       warn_on: ${{ inputs.warn_on }}
       local_debug: ${{ inputs.local_debug }}
       use-flutter: ${{ inputs.use-flutter }}
+      ignore_packages: ${{ inputs.ignore_packages }}
       checkout_submodules: ${{ inputs.checkout_submodules }}
 
   do-not-submit:
@@ -167,6 +189,7 @@ jobs:
       warn_on: ${{ inputs.warn_on }}
       local_debug: ${{ inputs.local_debug }}
       use-flutter: ${{ inputs.use-flutter }}
+      ignore_packages: ${{ inputs.ignore_packages }}
       checkout_submodules: ${{ inputs.checkout_submodules }}
 
   comment:

.github/workflows/health_base.yaml

@@ -49,6 +49,21 @@ on:
         default: false
         required: false
         type: boolean
+      ignore_license:
+        description: Which files to ignore for the license check.
+        default: "\"\""
+        required: false
+        type: string
+      ignore_coverage:
+        description: Which files to ignore for the coverage check.
+        default: "\"\""
+        required: false
+        type: string
+      ignore_packages:
+        description: Which packages to ignore.
+        default: "\"\""
+        required: false
+        type: string
       checkout_submodules:
         description: Whether to checkout submodules of git repositories.
         default: false
@@ -124,6 +139,9 @@ jobs:
             ${{ fromJSON('{"true":"--coverage_web","false":""}')[inputs.coverage_web] }} \
             --fail_on ${{ inputs.fail_on }} \
             --warn_on ${{ inputs.warn_on }} \
+            --ignore_license ${{ inputs.ignore_license }} \
+            --ignore_coverage ${{ inputs.ignore_coverage }} \
+            --ignore_packages ${{ inputs.ignore_packages }} \
             --experiments ${{ inputs.experiments }}
 
       - run: test -f current_repo/output/comment.md || echo $'The ${{ inputs.check }} workflow has encountered an exception and did not complete.' >> current_repo/output/comment.md

.github/workflows/health_internal.yaml

@@ -15,3 +15,5 @@ jobs:
       checks: version,changelog,license,coverage,breaking,do-not-submit
       fail_on: version,changelog,do-not-submit
       warn_on: license,coverage,breaking
+      ignore_license: 'pkgs/firehose/test_data'
+      ignore_coverage: 'pkgs/firehose/bin'

pkgs/firehose/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.6.1
+
+- Add `ignore` flags to the health workflow.
+
 ## 0.6.0
 
 - Make the health workflow testable with golden tests.

pkgs/firehose/bin/health.dart

@@ -15,6 +15,21 @@ void main(List<String> arguments) async {
       allowed: checkTypes,
       help: 'Check PR health.',
     )
+    ..addMultiOption(
+      'ignore_packages',
+      defaultsTo: [],
+      help: 'Which packages to ignore.',
+    )
+    ..addMultiOption(
+      'ignore_license',
+      defaultsTo: [],
+      help: 'Which files to ignore for the license check.',
+    )
+    ..addMultiOption(
+      'ignore_coverage',
+      defaultsTo: [],
+      help: 'Which files to ignore for the coverage check.',
+    )
     ..addMultiOption(
       'warn_on',
       allowed: checkTypes,
@@ -33,14 +48,15 @@ void main(List<String> arguments) async {
       'coverage_web',
       help: 'Whether to run web tests for coverage',
     );
-  var parsedArgs = argParser.parse(arguments);
-  var check = parsedArgs['check'] as String;
-  var warnOn = parsedArgs['warn_on'] as List<String>;
-  var failOn = parsedArgs['fail_on'] as List<String>;
-  var experiments = (parsedArgs['experiments'] as List<String>)
-      .where((name) => name.isNotEmpty)
-      .toList();
-  var coverageWeb = parsedArgs['coverage_web'] as bool;
+  final parsedArgs = argParser.parse(arguments);
+  final check = parsedArgs['check'] as String;
+  final warnOn = parsedArgs['warn_on'] as List<String>;
+  final failOn = parsedArgs['fail_on'] as List<String>;
+  final ignorePackages = _listNonEmpty(parsedArgs, 'ignore_packages');
+  final ignoreLicense = _listNonEmpty(parsedArgs, 'ignore_license');
+  final ignoreCoverage = _listNonEmpty(parsedArgs, 'ignore_coverage');
+  final experiments = _listNonEmpty(parsedArgs, 'experiments');
+  final coverageWeb = parsedArgs['coverage_web'] as bool;
   if (warnOn.toSet().intersection(failOn.toSet()).isNotEmpty) {
     throw ArgumentError('The checks for which warnings are displayed and the '
         'checks which lead to failure must be disjoint.');
@@ -51,7 +67,13 @@ void main(List<String> arguments) async {
     warnOn,
     failOn,
     coverageWeb,
+    ignorePackages,
+    ignoreLicense,
+    ignoreCoverage,
     experiments,
     GithubApi(),
   ).healthCheck();
 }
+
+List<String> _listNonEmpty(ArgResults parsedArgs, String key) =>
+    (parsedArgs[key] as List<String>).where((e) => e.isNotEmpty).toList();

pkgs/firehose/lib/firehose.dart

@@ -7,6 +7,8 @@
 import 'dart:io';
 import 'dart:math';
 
+import 'package:glob/glob.dart';
+
 import 'src/github.dart';
 import 'src/pub.dart';
 import 'src/repo.dart';
@@ -90,9 +92,12 @@ Saving existing comment id $existingCommentId to file ${idFile.path}''');
     github.close();
   }
 
-  Future<VerificationResults> verify(GithubApi github) async {
+  Future<VerificationResults> verify(
+    GithubApi github, [
+    List<Glob> ignoredPackages = const [],
+  ]) async {
     var repo = Repository(directory);
-    var packages = repo.locatePackages();
+    var packages = repo.locatePackages(ignoredPackages);
 
     var pub = Pub();
 

pkgs/firehose/lib/src/github.dart

@@ -5,7 +5,9 @@
 
 import 'dart:io';
 
+import 'package:collection/collection.dart';
 import 'package:github/github.dart';
+import 'package:glob/glob.dart';
 import 'package:http/http.dart' as http;
 import 'package:path/path.dart' as path;
 
@@ -107,14 +109,19 @@ class GithubApi {
     return matchingComment?.id;
   }
 
-  Future<List<GitFile>> listFilesForPR(Directory directory) async =>
+  Future<List<GitFile>> listFilesForPR(
+    Directory directory, [
+    List<Glob> ignoredFiles = const [],
+  ]) async =>
       await _github.pullRequests
           .listFiles(repoSlug!, issueNumber!)
           .map((prFile) => GitFile(
                 prFile.filename!,
                 FileStatus.fromString(prFile.status!),
                 directory,
               ))
+          .where((file) =>
+              ignoredFiles.none((glob) => glob.matches(file.filename)))
           .toList();
 
   /// Write a notice message to the github log.
@@ -135,9 +142,8 @@ class GitFile {
   final FileStatus status;
   final Directory directory;
 
-  bool isInPackage(Package package) {
-    return path.isWithin(package.directory.path, pathInRepository);
-  }
+  bool isInPackage(Package package) =>
+      path.isWithin(package.directory.path, pathInRepository);
 
   String get pathInRepository => path.join(directory.path, filename);
 

pkgs/firehose/lib/src/health/changelog.dart

@@ -4,19 +4,21 @@
 
 import 'dart:io';
 
+import 'package:glob/glob.dart';
 import 'package:path/path.dart' as path;
 
 import '../github.dart';
 import '../repo.dart';
 
 Future<Map<Package, List<GitFile>>> packagesWithoutChangelog(
   GithubApi github,
+  List<Glob> ignoredPackages,
   Directory directory,
 ) async {
   final repo = Repository(directory);
-  final packages = repo.locatePackages();
+  final packages = repo.locatePackages(ignoredPackages);
 
-  final files = await github.listFilesForPR(directory);
+  final files = await github.listFilesForPR(directory, ignoredPackages);
 
   var packagesWithoutChangedChangelog = collectPackagesWithoutChangelogChanges(
     packages,

pkgs/firehose/lib/src/health/coverage.dart

@@ -6,6 +6,7 @@
 import 'dart:io';
 
 import 'package:collection/collection.dart';
+import 'package:glob/glob.dart';
 import 'package:path/path.dart' as path;
 
 import '../github.dart';
@@ -15,21 +16,28 @@ import 'lcov.dart';
 
 class Coverage {
   final bool coverageWeb;
+  final List<Glob> ignoredFiles;
+  final List<Glob> ignoredPackages;
   final Directory directory;
   final List<String> experiments;
 
-  Coverage(this.coverageWeb, this.directory, this.experiments);
+  Coverage(
+    this.coverageWeb,
+    this.ignoredFiles,
+    this.ignoredPackages,
+    this.directory,
+    this.experiments,
+  );
 
   Future<CoverageResult> compareCoverages(
       GithubApi github, Directory base) async {
-    var files = await github.listFilesForPR(directory);
-
+    var files = await github.listFilesForPR(directory, ignoredFiles);
     return compareCoveragesFor(files, base);
   }
 
   CoverageResult compareCoveragesFor(List<GitFile> files, Directory base) {
     var repository = Repository(directory);
-    var packages = repository.locatePackages();
+    var packages = repository.locatePackages(ignoredPackages);
     print('Found packages $packages at $directory');
 
     var filesOfInterest = files
@@ -41,7 +49,7 @@ class Coverage {
     print('The files of interest are $filesOfInterest');
 
     var baseRepository = Repository(base);
-    var basePackages = baseRepository.locatePackages();
+    var basePackages = baseRepository.locatePackages(ignoredFiles);
     print('Found packages $basePackages at $base');
 
     var changedPackages = packages
@@ -120,9 +128,12 @@ Get coverage for ${package.name} by running coverage in ${package.directory.path
             ],
             workingDirectory: package.directory.path,
           );
-          print(resultChrome.stdout);
-          print(resultChrome.stderr);
+          if (resultChrome.exitCode != 0) {
+            print(resultChrome.stderr);
+          }
+          print('Dart test browser: ${resultChrome.stdout}');
         }
+
         print('Run tests with coverage for vm');
         var resultVm = Process.runSync(
           'dart',
@@ -134,8 +145,11 @@ Get coverage for ${package.name} by running coverage in ${package.directory.path
           ],
           workingDirectory: package.directory.path,
         );
-        print('dart test stdout: ${resultVm.stdout}');
-        print('dart test stderr: ${resultVm.stderr}');
+        if (resultVm.exitCode != 0) {
+          print(resultVm.stderr);
+        }
+        print('Dart test VM: ${resultVm.stdout}');
+
         print('Compute coverage from runs');
         var resultLcov = Process.runSync(
           'dart',
@@ -154,8 +168,10 @@ Get coverage for ${package.name} by running coverage in ${package.directory.path
           ],
           workingDirectory: package.directory.path,
         );
-        print('dart coverage stdout: ${resultLcov.stdout}');
-        print('dart coverage stderr: ${resultLcov.stderr}');
+        if (resultLcov.exitCode != 0) {
+          print(resultLcov.stderr);
+        }
+        print('Dart coverage: ${resultLcov.stdout}');
         return parseLCOV(
           path.join(package.directory.path, 'coverage/lcov.info'),
           relativeTo: package.repository.baseDirectory.path,