Improve test coverage, drop unused code (#403)

Author: kevmoo

mono_repo/lib/src/mono_config.dart

@@ -233,7 +233,10 @@ String? _selfValidateFromValue(Object? value) {
   throw ArgumentError.value(value, 'value', 'Must be a `String` or `bool`.');
 }
 
-@JsonSerializable(disallowUnrecognizedKeys: true)
+@JsonSerializable(
+  createToJson: false,
+  disallowUnrecognizedKeys: true,
+)
 class ConditionalStage {
   @JsonKey(required: true, disallowNullValue: true)
   final String name;
@@ -249,13 +252,6 @@ class ConditionalStage {
     }
     return _$ConditionalStageFromJson(json as Map);
   }
-
-  Object toJson() {
-    if (ifCondition == null) {
-      return name;
-    }
-    return _$ConditionalStageToJson(this);
-  }
 }
 
 // The available CI providers that we generate config for.

mono_repo/lib/src/mono_config.g.dart

@@ -3,7 +3,6 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:checked_yaml/checked_yaml.dart';
-import 'package:collection/collection.dart';
 import 'package:io/ansi.dart';
 import 'package:json_annotation/json_annotation.dart';
 import 'package:pub_semver/pub_semver.dart';
@@ -191,24 +190,34 @@ abstract class HasStageName {
   String get stageName;
 }
 
-@JsonSerializable(explicitToJson: true)
+@JsonSerializable(
+  explicitToJson: true,
+  createFactory: false,
+  ignoreUnannotated: true,
+)
 class CIJob implements HasStageName {
   @JsonKey(includeIfNull: false)
   final String? description;
 
+  @JsonKey()
   final String os;
 
   /// Relative path to the directory containing the source package from the root
   /// of the repository.
+  @JsonKey()
   final String package;
 
+  @JsonKey()
   final String sdk;
 
   @override
+  @JsonKey()
   final String stageName;
 
+  @JsonKey()
   final List<Task> tasks;
 
+  @JsonKey()
   final PackageFlavor flavor;
 
   Iterable<String> get _taskCommandsTickQuoted =>
@@ -240,8 +249,6 @@ class CIJob implements HasStageName {
           'Should have caught bad sdk value `$sdk` before here!',
         );
 
-  factory CIJob.fromJson(Map<String, dynamic> json) => _$CIJobFromJson(json);
-
   factory CIJob.parse(
     String os,
     String package,
@@ -271,6 +278,7 @@ class CIJob implements HasStageName {
   }
 
   /// If [sdk] is a valid [Version], return it. Otherwise, `null`.
+  @JsonKey(ignore: true)
   Version? get explicitSdkVersion {
     try {
       return Version.parse(sdk);
@@ -280,26 +288,21 @@ class CIJob implements HasStageName {
   }
 
   Map<String, dynamic> toJson() => _$CIJobToJson(this);
-
-  @override
-  String toString() => 'CIJob: ${toJson()}';
-
-  @override
-  bool operator ==(Object other) =>
-      other is CIJob && _equality.equals(_items, other._items);
-
-  @override
-  int get hashCode => _equality.hash(_items);
-
-  List get _items => [description, package, sdk, stageName, tasks];
 }
 
-@JsonSerializable(includeIfNull: false)
+@JsonSerializable(
+  createFactory: false,
+  ignoreUnannotated: true,
+  includeIfNull: false,
+)
 class Task {
+  @JsonKey()
   final PackageFlavor flavor;
 
+  @JsonKey()
   final TaskType type;
 
+  @JsonKey()
   final String? args;
 
   final String command;
@@ -405,7 +408,16 @@ class Task {
           badKey: true,
         );
       }
-      return Task(flavor, taskType, args: args);
+      try {
+        return Task(flavor, taskType, args: args);
+      } on InvalidTaskConfigException catch (e) {
+        throw CheckedFromJsonException(
+          yamlValue,
+          taskName,
+          'Task',
+          e.message,
+        );
+      }
     }
 
     if (yamlValue is YamlNode) {
@@ -415,8 +427,6 @@ class Task {
     throw ArgumentError('huh? $yamlValue ${yamlValue.runtimeType}');
   }
 
-  factory Task.fromJson(Map<String, dynamic> json) => _$TaskFromJson(json);
-
   Map<String, dynamic> toJson() => _$TaskToJson(this);
 
   /// Stores the job names we've already warned about. Only warn once!
@@ -434,15 +444,4 @@ class Task {
     }
     return taskName;
   }
-
-  @override
-  bool operator ==(Object other) =>
-      other is Task && _equality.equals(_items, other._items);
-
-  @override
-  int get hashCode => _equality.hash(_items);
-
-  List get _items => [type, args];
 }
-
-const _equality = DeepCollectionEquality();

mono_repo/lib/src/package_config.dart

@@ -23,9 +23,6 @@ abstract class TaskType implements Comparable<TaskType> {
 
   const TaskType._(this.name);
 
-  factory TaskType.fromJson(String name) =>
-      _values.singleWhere((element) => element.name == name);
-
   List<String> commandValue(PackageFlavor flavor, String? args);
 
   String toJson() => name;
@@ -57,6 +54,14 @@ abstract class TaskType implements Comparable<TaskType> {
       );
 }
 
+/// Special [Exception] type used to convey error state that can be caught and
+/// re-thrown with more context.
+class InvalidTaskConfigException implements Exception {
+  final String message;
+
+  const InvalidTaskConfigException(this.message);
+}
+
 class _FormatTask extends TaskType {
   const _FormatTask() : super._('format');
 
@@ -110,7 +115,7 @@ class _TestWithCoverageTask extends TaskType {
   @override
   List<String> commandValue(PackageFlavor flavor, String? args) {
     if (flavor == PackageFlavor.flutter) {
-      throw ArgumentError(
+      throw const InvalidTaskConfigException(
         'Code coverage tests are not supported with Flutter.',
       );
     }

mono_repo/lib/src/package_config.g.dart

@@ -626,6 +626,66 @@ $_writeScriptOutput''',
     await d.file(ciScriptPath, ciShellOutput).validate();
   });
 
+  test('test_with_coverage', () async {
+    await d.dir('pkg_a', [
+      d.file(monoPkgFileName, r'''
+stages:
+  - test:
+    - description: "chrome tests"
+      test: --platform chrome
+      sdk: dev
+      os: macos
+    - test_with_coverage: --preset travis
+      sdk: stable
+'''),
+      d.file('pubspec.yaml', '''
+name: pkg_a
+      ''')
+    ]).create();
+
+    testGenerateBothConfig(
+      printMatcher: '''
+package:pkg_a
+$_writeScriptOutput''',
+    );
+
+    validateSandbox(
+      'github_output_test_with_coverage.txt',
+      defaultGitHubWorkflowFilePath,
+    );
+  });
+
+  test('test_with_coverage not supported with flutter', () async {
+    await d.dir('pkg_a', [
+      d.file(monoPkgFileName, r'''
+stages:
+  - test:
+    - test_with_coverage:
+      sdk: stable
+'''),
+      d.file('pubspec.yaml', '''
+name: pkg_a
+
+environment:
+  sdk: ">=2.17.0 <3.0.0"
+
+dependencies:
+  flutter:
+    sdk: flutter
+      ''')
+    ]).create();
+
+    expect(
+      testGenerateGitHubConfig,
+      throwsAParsedYamlException('''
+line 3, column 25 of ${p.join('pkg_a', 'mono_pkg.yaml')}: Unsupported value for "test_with_coverage". Code coverage tests are not supported with Flutter.
+  ╷
+3 │     - test_with_coverage:
+  │                         ^
+  ╵'''),
+    );
+  });
+
   test(
     'command values must be either a String or a List containing strings',
     () async {