refactor(dart_frog_cli): do not mock process result (#652)

Author: renancaraujo

bricks/dart_frog_prod_server/hooks/test/post_gen_test.dart

@@ -30,13 +30,19 @@ class _MockLogger extends Mock implements Logger {}
 
 class _MockProgress extends Mock implements Progress {}
 
-class _MockProcessResult extends Mock implements ProcessResult {}
-
 void main() {
   group('postGen', () {
     late HookContext context;
     late Logger logger;
 
+    const processId = 42;
+    final processResult = ProcessResult(
+      processId,
+      ExitCode.success.code,
+      '',
+      '',
+    );
+
     setUp(() {
       logger = _MockLogger();
       context = _FakeHookContext(logger: logger);
@@ -57,8 +63,7 @@ void main() {
     test('runs dart pub get and outputs next steps', () async {
       var processRunnerCallCount = 0;
       final exitCalls = <int>[];
-      final result = _MockProcessResult();
-      when(() => result.exitCode).thenReturn(ExitCode.success.code);
+
       await postGen(
         context,
         runProcess: (
@@ -75,7 +80,7 @@ void main() {
             equals(path.join(Directory.current.path, 'build')),
           );
           expect(runInShell, isTrue);
-          return result;
+          return processResult;
         },
         exit: exitCalls.add,
       );

bricks/dart_frog_prod_server/hooks/test/src/dart_pub_get_test.dart

@@ -27,13 +27,19 @@ class _MockLogger extends Mock implements Logger {}
 
 class _MockProgress extends Mock implements Progress {}
 
-class _MockProcessResult extends Mock implements ProcessResult {}
-
 void main() {
   group('dartPubGet', () {
     late HookContext context;
     late Logger logger;
 
+    const processId = 42;
+    final processResult = ProcessResult(
+      processId,
+      ExitCode.success.code,
+      '',
+      '',
+    );
+
     setUp(() {
       logger = _MockLogger();
       context = _FakeHookContext(logger: logger);
@@ -43,8 +49,7 @@ void main() {
 
     test('completes when process succeeds', () async {
       final exitCalls = <int>[];
-      final result = _MockProcessResult();
-      when(() => result.exitCode).thenReturn(ExitCode.success.code);
+
       await dartPubGet(
         context,
         workingDirectory: '.',
@@ -58,7 +63,7 @@ void main() {
           expect(args, equals(['pub', 'get']));
           expect(workingDirectory, equals('.'));
           expect(runInShell, isTrue);
-          return result;
+          return processResult;
         },
         exit: exitCalls.add,
       );
@@ -69,10 +74,14 @@ void main() {
     test('exits when process fails', () async {
       const error = 'oops something went wrong';
       final exitCalls = <int>[];
-      final result = _MockProcessResult();
-      final code = ExitCode.software.code;
-      when(() => result.exitCode).thenReturn(code);
-      when(() => result.stderr).thenReturn(error);
+
+      final processResult = ProcessResult(
+        processId,
+        ExitCode.software.code,
+        '',
+        error,
+      );
+
       await dartPubGet(
         context,
         workingDirectory: '.',
@@ -82,21 +91,17 @@ void main() {
           String? workingDirectory,
           bool? runInShell,
         }) async {
-          return result;
+          return processResult;
         },
         exit: exitCalls.add,
       );
-      expect(exitCalls, equals([code]));
+      expect(exitCalls, equals([ExitCode.software.code]));
       verify(() => logger.err(error)).called(1);
     });
 
     test('exits when ProcessException occurs', () async {
       const error = 'oops something went wrong';
       final exitCalls = <int>[];
-      final result = _MockProcessResult();
-      final code = ExitCode.software.code;
-      when(() => result.exitCode).thenReturn(code);
-      when(() => result.stderr).thenReturn(error);
       await dartPubGet(
         context,
         workingDirectory: '.',
@@ -106,11 +111,16 @@ void main() {
           String? workingDirectory,
           bool? runInShell,
         }) async {
-          throw ProcessException('dart', ['pub', 'get'], error, code);
+          throw ProcessException(
+            'dart',
+            ['pub', 'get'],
+            error,
+            ExitCode.software.code,
+          );
         },
         exit: exitCalls.add,
       );
-      expect(exitCalls, equals([code]));
+      expect(exitCalls, equals([ExitCode.software.code]));
       verify(() => logger.err(error)).called(1);
     });
   });

packages/dart_frog_cli/lib/src/commands/dev/dev.dart

@@ -8,6 +8,7 @@ import 'package:dart_frog_cli/src/commands/dev/templates/dart_frog_dev_server_bu
 import 'package:dart_frog_cli/src/runtime_compatibility.dart'
     as runtime_compatibility;
 import 'package:mason/mason.dart';
+import 'package:meta/meta.dart';
 import 'package:path/path.dart' as path;
 import 'package:stream_transform/stream_transform.dart';
 import 'package:watcher/watcher.dart';
@@ -62,7 +63,6 @@ class DevCommand extends DartFrogCommand {
     RestorableDirectoryGeneratorTargetBuilder? generatorTarget,
     Exit? exit,
     bool? isWindows,
-    ProcessRun? runProcess,
     io.ProcessSignal? sigint,
     ProcessStart? startProcess,
   })  : _ensureRuntimeCompatibility = ensureRuntimeCompatibility ??
@@ -71,7 +71,6 @@ class DevCommand extends DartFrogCommand {
         _generator = generator ?? MasonGenerator.fromBundle,
         _exit = exit ?? io.exit,
         _isWindows = isWindows ?? io.Platform.isWindows,
-        _runProcess = runProcess ?? io.Process.run,
         _sigint = sigint ?? io.ProcessSignal.sigint,
         _startProcess = startProcess ?? io.Process.start,
         _generatorTarget = generatorTarget ?? _defaultGeneratorTarget {
@@ -88,7 +87,13 @@ class DevCommand extends DartFrogCommand {
   final GeneratorBuilder _generator;
   final Exit _exit;
   final bool _isWindows;
-  final ProcessRun _runProcess;
+
+  /// Function used to start a process used for testing purposes only.
+  @visibleForTesting
+  ProcessRun? testRunProcess;
+
+  ProcessRun get _runProcess => testRunProcess ?? io.Process.run;
+
   final io.ProcessSignal _sigint;
   final ProcessStart _startProcess;
   final RestorableDirectoryGeneratorTargetBuilder _generatorTarget;

packages/dart_frog_cli/test/src/commands/dev/dev_test.dart

@@ -23,8 +23,6 @@ class _MockGeneratorHooks extends Mock implements GeneratorHooks {}
 
 class _MockProcess extends Mock implements Process {}
 
-class _MockProcessResult extends Mock implements ProcessResult {}
-
 class _MockProcessSignal extends Mock implements ProcessSignal {}
 
 class _MockProgress extends Mock implements Progress {}
@@ -43,14 +41,17 @@ void main() {
       registerFallbackValue(_FakeDirectoryGeneratorTarget());
     });
 
+    const processId = 42;
+    final processResult = ProcessResult(processId, 0, '', '');
+
     late ArgResults argResults;
     late DirectoryWatcher directoryWatcher;
     late MasonGenerator generator;
     late bool isWindows;
     late Progress progress;
     late Logger logger;
     late Process process;
-    late ProcessResult processResult;
+
     late ProcessSignal sigint;
     late RestorableDirectoryGeneratorTarget generatorTarget;
     late DevCommand command;
@@ -65,7 +66,6 @@ void main() {
       progress = _MockProgress();
       when(() => logger.progress(any())).thenReturn(progress);
       process = _MockProcess();
-      processResult = _MockProcessResult();
       sigint = _MockProcessSignal();
       when(() => sigint.watch()).thenAnswer((_) => const Stream.empty());
       generatorTarget = _MockRestorableDirectoryGeneratorTarget();
@@ -76,9 +76,6 @@ void main() {
         generator: (_) async => generator,
         generatorTarget: (_) => generatorTarget,
         isWindows: isWindows,
-        runProcess: (String executable, List<String> arguments) async {
-          return processResult;
-        },
         startProcess: (
           String executable,
           List<String> arguments, {
@@ -87,7 +84,9 @@ void main() {
           return process;
         },
         sigint: sigint,
-      )..testArgResults = argResults;
+      )
+        ..testArgResults = argResults
+        ..testRunProcess = (_, __) async => processResult;
     });
 
     test('throws if ensureRuntimeCompatibility fails', () {
@@ -529,9 +528,9 @@ void main() {
     });
 
     test('kills all child processes when sigint received on windows', () async {
-      const processId = 42;
       final generatorHooks = _MockGeneratorHooks();
       final processRunCalls = <List<String>>[];
+
       when(
         () => generatorHooks.preGen(
           vars: any(named: 'vars'),
@@ -565,10 +564,6 @@ void main() {
         generator: (_) async => generator,
         exit: (code) => exitCode = code,
         isWindows: true,
-        runProcess: (String executable, List<String> arguments) async {
-          processRunCalls.add([executable, ...arguments]);
-          return processResult;
-        },
         startProcess: (
           String executable,
           List<String> arguments, {
@@ -577,7 +572,12 @@ void main() {
           return process;
         },
         sigint: sigint,
-      )..testArgResults = argResults;
+      )
+        ..testArgResults = argResults
+        ..testRunProcess = (String executable, List<String> arguments) async {
+          processRunCalls.add([executable, ...arguments]);
+          return processResult;
+        };
       command.run().ignore();
       await untilCalled(() => process.pid);
       expect(
@@ -592,7 +592,6 @@ void main() {
     test(
         'kills process if error occurs before '
         'hotreload is enabled on windows', () async {
-      const processId = 42;
       final generatorHooks = _MockGeneratorHooks();
       final processRunCalls = <List<String>>[];
       int? exitCode;
@@ -620,7 +619,6 @@ void main() {
         (_) => Stream.value(utf8.encode('oops')),
       );
       when(() => process.pid).thenReturn(processId);
-      when(() => processResult.exitCode).thenReturn(ExitCode.success.code);
       when(
         () => directoryWatcher.events,
       ).thenAnswer((_) => StreamController<WatchEvent>().stream);
@@ -632,10 +630,6 @@ void main() {
         generator: (_) async => generator,
         exit: (code) => exitCode = code,
         isWindows: true,
-        runProcess: (String executable, List<String> arguments) async {
-          processRunCalls.add([executable, ...arguments]);
-          return processResult;
-        },
         startProcess: (
           String executable,
           List<String> arguments, {
@@ -644,7 +638,12 @@ void main() {
           return process;
         },
         sigint: sigint,
-      )..testArgResults = argResults;
+      )
+        ..testArgResults = argResults
+        ..testRunProcess = (String executable, List<String> arguments) async {
+          processRunCalls.add([executable, ...arguments]);
+          return processResult;
+        };
       command.run().ignore();
       await untilCalled(() => process.pid);
       expect(exitCode, equals(1));
@@ -764,10 +763,6 @@ lib/my_model.g.dart:53:20: Warning: Operand of null-aware operation '!' has type
         directoryWatcher: (_) => directoryWatcher,
         generator: (_) async => generator,
         exit: (code) => exitCode = code,
-        runProcess: (String executable, List<String> arguments) async {
-          processRunCalls.add([executable, ...arguments]);
-          return processResult;
-        },
         startProcess: (
           String executable,
           List<String> arguments, {
@@ -776,7 +771,12 @@ lib/my_model.g.dart:53:20: Warning: Operand of null-aware operation '!' has type
           return process;
         },
         sigint: sigint,
-      )..testArgResults = argResults;
+      )
+        ..testArgResults = argResults
+        ..testRunProcess = (String executable, List<String> arguments) async {
+          processRunCalls.add([executable, ...arguments]);
+          return processResult;
+        };
       command.run().ignore();
       await untilCalled(() => process.kill());
       expect(exitCode, equals(1));

packages/dart_frog_cli/test/src/commands/update/update_test.dart

@@ -12,23 +12,22 @@ class MockLogger extends Mock implements Logger {}
 
 class MockPubUpdater extends Mock implements PubUpdater {}
 
-class MockProcessResult extends Mock implements ProcessResult {}
-
 class MockProgress extends Mock implements Progress {}
 
 void main() {
   const latestVersion = '0.0.0';
 
   group('dart_frog update', () {
+    const processId = 42;
+    final processResult = ProcessResult(processId, 0, '', '');
+
     late Logger logger;
     late PubUpdater pubUpdater;
     late UpdateCommand command;
-    late ProcessResult processResult;
 
     setUp(() {
       logger = MockLogger();
       pubUpdater = MockPubUpdater();
-      processResult = MockProcessResult();
 
       when(() => logger.progress(any())).thenReturn(MockProgress());
       when(
@@ -84,8 +83,9 @@ void main() {
 
     test('handles pub update process errors', () async {
       const error = 'Oh no! Installing this is not possible right now!';
-      when(() => processResult.exitCode).thenReturn(1);
-      when<dynamic>(() => processResult.stderr).thenReturn(error);
+
+      final processResult = ProcessResult(processId, 1, '', error);
+
       when(
         () => pubUpdater.getLatestVersion(any()),
       ).thenAnswer((_) async => latestVersion);
@@ -118,7 +118,7 @@ void main() {
           versionConstraint: any(named: 'versionConstraint'),
         ),
       ).thenAnswer((_) => Future.value(processResult));
-      when(() => processResult.exitCode).thenReturn(0);
+
       when(() => logger.progress(any())).thenReturn(MockProgress());
       final result = await command.run();
       expect(result, equals(ExitCode.success.code));