[flutter_plugin_tools] Improve process mocking (flutter#4254)

The mock process runner used in most of the tests had poor handling of
stdout/stderr:
- By default it would return the `List<int>` output from the mock
  process, which was never correct since the parent process runner
  interface always sets encodings, thus the `dynamic` should always be
  of type `String`
- The process for setting output on a `MockProcess` was awkward, since
  it was based on a `Stream<Lint<int>>`, even though in every case what
  we actually want to do is just set the full output to a string.
- A hack was at some point added (presumably due to the above issues)
  to bypass that flow at the process runner level, and instead return a
  `String` set there. That meant there were two ways of setting output
  (one of which that only worked for one of the ways of running
  processes)
  - That hack wasn't updated when the ability to return multiple mock
    processes instead of a single global mock process was added, so the
    API was even more confusing, and there was no way to set different
    output for different processes.

This changes the test APIs so that:
- `MockProcess` takes stdout and stderr as strings, and internally
  manages converting them to a `Stream<List<int>>`.
- `RecordingProcessRunner` correctly decodes and returns the output
  streams when constructing a process result.

It also removes the resultStdout and resultStderr hacks, as well as the
legacy `processToReturn` API, and converts all uses to the new
structure, which is both simpler to use, and clearly associates output
with specific processes.

script/tool/test/analyze_command_test.dart

@@ -211,7 +211,7 @@ void main() {
     createFakePlugin('foo', packagesDir);
 
     processRunner.mockProcessesForExecutable['flutter'] = <io.Process>[
-      MockProcess.failing() // flutter packages get
+      MockProcess(exitCode: 1) // flutter packages get
     ];
 
     Error? commandError;
@@ -233,7 +233,7 @@ void main() {
     createFakePlugin('foo', packagesDir);
 
     processRunner.mockProcessesForExecutable['dart'] = <io.Process>[
-      MockProcess.failing() // dart analyze
+      MockProcess(exitCode: 1) // dart analyze
     ];
 
     Error? commandError;

script/tool/test/build_examples_command_test.dart

@@ -63,7 +63,7 @@ void main() {
       processRunner
               .mockProcessesForExecutable[getFlutterCommand(mockPlatform)] =
           <io.Process>[
-        MockProcess.failing() // flutter packages get
+        MockProcess(exitCode: 1) // flutter packages get
       ];
 
       Error? commandError;

script/tool/test/common/gradle_test.dart

@@ -168,7 +168,7 @@ void main() {
 
       processRunner.mockProcessesForExecutable[project.gradleWrapper.path] =
           <io.Process>[
-        MockProcess.failing(),
+        MockProcess(exitCode: 1),
       ];
 
       final int exitCode = await project.runCommand('foo');

script/tool/test/common/xcode_test.dart

@@ -94,8 +94,9 @@ void main() {
         }
       };
 
-      processRunner.processToReturn = MockProcess.succeeding();
-      processRunner.resultStdout = jsonEncode(devices);
+      processRunner.mockProcessesForExecutable['xcrun'] = <io.Process>[
+        MockProcess(stdout: jsonEncode(devices)),
+      ];
 
       expect(await xcode.findBestAvailableIphoneSimulator(), expectedDeviceId);
     });
@@ -137,15 +138,16 @@ void main() {
         }
       };
 
-      processRunner.processToReturn = MockProcess.succeeding();
-      processRunner.resultStdout = jsonEncode(devices);
+      processRunner.mockProcessesForExecutable['xcrun'] = <io.Process>[
+        MockProcess(stdout: jsonEncode(devices)),
+      ];
 
       expect(await xcode.findBestAvailableIphoneSimulator(), null);
     });
 
     test('returns null if simctl fails', () async {
       processRunner.mockProcessesForExecutable['xcrun'] = <io.Process>[
-        MockProcess.failing(),
+        MockProcess(exitCode: 1),
       ];
 
       expect(await xcode.findBestAvailableIphoneSimulator(), null);
@@ -216,7 +218,7 @@ void main() {
 
     test('returns error codes', () async {
       processRunner.mockProcessesForExecutable['xcrun'] = <io.Process>[
-        MockProcess.failing(),
+        MockProcess(exitCode: 1),
       ];
       final Directory directory = const LocalFileSystem().currentDirectory;
 
@@ -247,8 +249,7 @@ void main() {
 
   group('projectHasTarget', () {
     test('returns true when present', () async {
-      processRunner.processToReturn = MockProcess.succeeding();
-      processRunner.resultStdout = '''
+      const String stdout = '''
 {
   "project" : {
     "configurations" : [
@@ -266,6 +267,9 @@ void main() {
     ]
   }
 }''';
+      processRunner.mockProcessesForExecutable['xcrun'] = <io.Process>[
+        MockProcess(stdout: stdout),
+      ];
 
       final Directory project =
           const LocalFileSystem().directory('/foo.xcodeproj');
@@ -287,8 +291,7 @@ void main() {
     });
 
     test('returns false when not present', () async {
-      processRunner.processToReturn = MockProcess.succeeding();
-      processRunner.resultStdout = '''
+      const String stdout = '''
 {
   "project" : {
     "configurations" : [
@@ -305,6 +308,9 @@ void main() {
     ]
   }
 }''';
+      processRunner.mockProcessesForExecutable['xcrun'] = <io.Process>[
+        MockProcess(stdout: stdout),
+      ];
 
       final Directory project =
           const LocalFileSystem().directory('/foo.xcodeproj');
@@ -326,8 +332,9 @@ void main() {
     });
 
     test('returns null for unexpected output', () async {
-      processRunner.processToReturn = MockProcess.succeeding();
-      processRunner.resultStdout = '{}';
+      processRunner.mockProcessesForExecutable['xcrun'] = <io.Process>[
+        MockProcess(stdout: '{}'),
+      ];
 
       final Directory project =
           const LocalFileSystem().directory('/foo.xcodeproj');
@@ -349,8 +356,9 @@ void main() {
     });
 
     test('returns null for invalid output', () async {
-      processRunner.processToReturn = MockProcess.succeeding();
-      processRunner.resultStdout = ':)';
+      processRunner.mockProcessesForExecutable['xcrun'] = <io.Process>[
+        MockProcess(stdout: ':)'),
+      ];
 
       final Directory project =
           const LocalFileSystem().directory('/foo.xcodeproj');
@@ -372,7 +380,9 @@ void main() {
     });
 
     test('returns null for failure', () async {
-      processRunner.processToReturn = MockProcess.failing();
+      processRunner.mockProcessesForExecutable['xcrun'] = <io.Process>[
+        MockProcess(exitCode: 1), // xcodebuild -list
+      ];
 
       final Directory project =
           const LocalFileSystem().directory('/foo.xcodeproj');

script/tool/test/drive_examples_command_test.dart

@@ -60,12 +60,10 @@ void main() {
       final String output =
           '''${includeBanner ? updateBanner : ''}[${devices.join(',')}]''';
 
-      final MockProcess mockDevicesProcess = MockProcess.succeeding();
-      mockDevicesProcess.stdoutController.close(); // ignore: unawaited_futures
+      final MockProcess mockDevicesProcess = MockProcess(stdout: output);
       processRunner
               .mockProcessesForExecutable[getFlutterCommand(mockPlatform)] =
           <io.Process>[mockDevicesProcess];
-      processRunner.resultStdout = output;
     }
 
     test('fails if no platforms are provided', () async {
@@ -151,7 +149,7 @@ void main() {
       // Simulate failure from `flutter devices`.
       processRunner
               .mockProcessesForExecutable[getFlutterCommand(mockPlatform)] =
-          <io.Process>[MockProcess.failing()];
+          <io.Process>[MockProcess(exitCode: 1)];
 
       Error? commandError;
       final List<String> output = await runCapturingPrint(
@@ -954,8 +952,8 @@ void main() {
               .mockProcessesForExecutable[getFlutterCommand(mockPlatform)] =
           <io.Process>[
         // No mock for 'devices', since it's running for macOS.
-        MockProcess.failing(), // 'drive' #1
-        MockProcess.failing(), // 'drive' #2
+        MockProcess(exitCode: 1), // 'drive' #1
+        MockProcess(exitCode: 1), // 'drive' #2
       ];
 
       Error? commandError;

script/tool/test/firebase_test_lab_command_test.dart

@@ -40,7 +40,7 @@ void main() {
 
     test('fails if gcloud auth fails', () async {
       processRunner.mockProcessesForExecutable['gcloud'] = <Process>[
-        MockProcess.failing()
+        MockProcess(exitCode: 1)
       ];
       createFakePlugin('plugin', packagesDir, extraFiles: <String>[
         'example/integration_test/foo_test.dart',
@@ -64,8 +64,8 @@ void main() {
 
     test('retries gcloud set', () async {
       processRunner.mockProcessesForExecutable['gcloud'] = <Process>[
-        MockProcess.succeeding(), // auth
-        MockProcess.failing(), // config
+        MockProcess(), // auth
+        MockProcess(exitCode: 1), // config
       ];
       createFakePlugin('plugin', packagesDir, extraFiles: <String>[
         'example/integration_test/foo_test.dart',
@@ -245,10 +245,10 @@ void main() {
       ]);
 
       processRunner.mockProcessesForExecutable['gcloud'] = <Process>[
-        MockProcess.succeeding(), // auth
-        MockProcess.succeeding(), // config
-        MockProcess.failing(), // integration test #1
-        MockProcess.succeeding(), // integration test #2
+        MockProcess(), // auth
+        MockProcess(), // config
+        MockProcess(exitCode: 1), // integration test #1
+        MockProcess(), // integration test #2
       ];
 
       Error? commandError;
@@ -459,7 +459,7 @@ void main() {
       ]);
 
       processRunner.mockProcessesForExecutable['flutter'] = <Process>[
-        MockProcess.failing() // flutter build
+        MockProcess(exitCode: 1) // flutter build
       ];
 
       Error? commandError;
@@ -496,7 +496,7 @@ void main() {
           .childFile('gradlew')
           .path;
       processRunner.mockProcessesForExecutable[gradlewPath] = <Process>[
-        MockProcess.failing()
+        MockProcess(exitCode: 1)
       ];
 
       Error? commandError;
@@ -533,8 +533,8 @@ void main() {
           .childFile('gradlew')
           .path;
       processRunner.mockProcessesForExecutable[gradlewPath] = <Process>[
-        MockProcess.succeeding(), // assembleAndroidTest
-        MockProcess.failing(), // assembleDebug
+        MockProcess(), // assembleAndroidTest
+        MockProcess(exitCode: 1), // assembleDebug
       ];
 
       Error? commandError;

script/tool/test/format_command_test.dart

@@ -115,7 +115,7 @@ void main() {
     createFakePlugin('a_plugin', packagesDir, extraFiles: files);
 
     processRunner.mockProcessesForExecutable[getFlutterCommand(mockPlatform)] =
-        <io.Process>[MockProcess.failing()];
+        <io.Process>[MockProcess(exitCode: 1)];
     Error? commandError;
     final List<String> output = await runCapturingPrint(
         runner, <String>['format'], errorHandler: (Error e) {
@@ -167,7 +167,7 @@ void main() {
     createFakePlugin('a_plugin', packagesDir, extraFiles: files);
 
     processRunner.mockProcessesForExecutable['java'] = <io.Process>[
-      MockProcess.failing()
+      MockProcess(exitCode: 1)
     ];
     Error? commandError;
     final List<String> output = await runCapturingPrint(
@@ -193,8 +193,8 @@ void main() {
     createFakePlugin('a_plugin', packagesDir, extraFiles: files);
 
     processRunner.mockProcessesForExecutable['java'] = <io.Process>[
-      MockProcess.succeeding(), // check for working java
-      MockProcess.failing(), // format
+      MockProcess(), // check for working java
+      MockProcess(exitCode: 1), // format
     ];
     Error? commandError;
     final List<String> output = await runCapturingPrint(
@@ -280,7 +280,7 @@ void main() {
     createFakePlugin('a_plugin', packagesDir, extraFiles: files);
 
     processRunner.mockProcessesForExecutable['clang-format'] = <io.Process>[
-      MockProcess.failing()
+      MockProcess(exitCode: 1)
     ];
     Error? commandError;
     final List<String> output = await runCapturingPrint(
@@ -335,8 +335,8 @@ void main() {
     createFakePlugin('a_plugin', packagesDir, extraFiles: files);
 
     processRunner.mockProcessesForExecutable['clang-format'] = <io.Process>[
-      MockProcess.succeeding(), // check for working clang-format
-      MockProcess.failing(), // format
+      MockProcess(), // check for working clang-format
+      MockProcess(exitCode: 1), // format
     ];
     Error? commandError;
     final List<String> output = await runCapturingPrint(
@@ -418,11 +418,11 @@ void main() {
     ];
     createFakePlugin('a_plugin', packagesDir, extraFiles: files);
 
+    const String changedFilePath = 'packages/a_plugin/linux/foo_plugin.cc';
     processRunner.mockProcessesForExecutable['git'] = <io.Process>[
-      MockProcess.succeeding(),
+      MockProcess(stdout: changedFilePath),
     ];
-    const String changedFilePath = 'packages/a_plugin/linux/foo_plugin.cc';
-    processRunner.resultStdout = changedFilePath;
+
     Error? commandError;
     final List<String> output =
         await runCapturingPrint(runner, <String>['format', '--fail-on-change'],
@@ -448,7 +448,7 @@ void main() {
     createFakePlugin('a_plugin', packagesDir, extraFiles: files);
 
     processRunner.mockProcessesForExecutable['git'] = <io.Process>[
-      MockProcess.failing()
+      MockProcess(exitCode: 1)
     ];
     Error? commandError;
     final List<String> output =
@@ -472,12 +472,12 @@ void main() {
     ];
     createFakePlugin('a_plugin', packagesDir, extraFiles: files);
 
+    const String changedFilePath = 'packages/a_plugin/linux/foo_plugin.cc';
     processRunner.mockProcessesForExecutable['git'] = <io.Process>[
-      MockProcess.succeeding(), // ls-files
-      MockProcess.failing(), // diff
+      MockProcess(stdout: changedFilePath), // ls-files
+      MockProcess(exitCode: 1), // diff
     ];
-    const String changedFilePath = 'packages/a_plugin/linux/foo_plugin.cc';
-    processRunner.resultStdout = changedFilePath;
+
     Error? commandError;
     final List<String> output =
         await runCapturingPrint(runner, <String>['format', '--fail-on-change'],

script/tool/test/lint_android_command_test.dart

@@ -101,7 +101,7 @@ void main() {
           });
 
       processRunner.mockProcessesForExecutable['gradlew'] = <io.Process>[
-        MockProcess.failing(),
+        MockProcess(exitCode: 1),
       ];
 
       Error? commandError;

script/tool/test/lint_podspecs_command_test.dart

@@ -75,11 +75,9 @@ void main() {
       );
 
       processRunner.mockProcessesForExecutable['pod'] = <io.Process>[
-        MockProcess.succeeding(),
-        MockProcess.succeeding(),
+        MockProcess(stdout: 'Foo', stderr: 'Bar'),
+        MockProcess(),
       ];
-      processRunner.resultStdout = 'Foo';
-      processRunner.resultStderr = 'Bar';
 
       final List<String> output =
           await runCapturingPrint(runner, <String>['podspecs']);
@@ -173,7 +171,7 @@ void main() {
 
       // Simulate failure from `which pod`.
       processRunner.mockProcessesForExecutable['which'] = <io.Process>[
-        MockProcess.failing(),
+        MockProcess(exitCode: 1),
       ];
 
       Error? commandError;
@@ -199,7 +197,7 @@ void main() {
 
       // Simulate failure from `pod`.
       processRunner.mockProcessesForExecutable['pod'] = <io.Process>[
-        MockProcess.failing(),
+        MockProcess(exitCode: 1),
       ];
 
       Error? commandError;
@@ -227,8 +225,8 @@ void main() {
 
       // Simulate failure from the second call to `pod`.
       processRunner.mockProcessesForExecutable['pod'] = <io.Process>[
-        MockProcess.succeeding(),
-        MockProcess.failing(),
+        MockProcess(),
+        MockProcess(exitCode: 1),
       ];
 
       Error? commandError;