1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'dart:async';
import 'dart:convert';
import 'dart:io' as io show Process, ProcessResult, ProcessSignal, ProcessStartMode, systemEncoding;
import 'package:file/file.dart';
import 'package:meta/meta.dart';
import 'package:process/process.dart';
import 'test_wrapper.dart';
export 'package:process/process.dart' show ProcessManager;
typedef VoidCallback = void Function();
/// A command for [FakeProcessManager].
@immutable
class FakeCommand {
const FakeCommand({
required this.command,
this.workingDirectory,
this.environment,
this.encoding,
this.duration = Duration.zero,
this.onRun,
this.exitCode = 0,
this.stdout = '',
this.stderr = '',
this.completer,
this.stdin,
this.exception,
this.outputFollowsExit = false,
this.processStartMode,
});
/// The exact commands that must be matched for this [FakeCommand] to be
/// considered correct.
final List<Pattern> command;
/// The exact working directory that must be matched for this [FakeCommand] to
/// be considered correct.
///
/// If this is null, the working directory is ignored.
final String? workingDirectory;
/// The environment that must be matched for this [FakeCommand] to be considered correct.
///
/// If this is null, then the environment is ignored.
///
/// Otherwise, each key in this environment must be present and must have a
/// value that matches the one given here for the [FakeCommand] to match.
final Map<String, String>? environment;
/// The stdout and stderr encoding that must be matched for this [FakeCommand]
/// to be considered correct.
///
/// If this is null, then the encodings are ignored.
final Encoding? encoding;
/// The time to allow to elapse before returning the [exitCode], if this command
/// is "executed".
///
/// If you set this to a non-zero time, you should use a [FakeAsync] zone,
/// otherwise the test will be artificially slow.
final Duration duration;
/// A callback that is run after [duration] expires but before the [exitCode]
/// (and output) are passed back.
final VoidCallback? onRun;
/// The process' exit code.
///
/// To simulate a never-ending process, set [duration] to a value greater than
/// 15 minutes (the timeout for our tests).
///
/// To simulate a crash, subtract the crash signal number from 256. For example,
/// SIGPIPE (-13) is 243.
final int exitCode;
/// The output to simulate on stdout. This will be encoded as UTF-8 and
/// returned in one go.
final String stdout;
/// The output to simulate on stderr. This will be encoded as UTF-8 and
/// returned in one go.
final String stderr;
/// If provided, allows the command completion to be blocked until the future
/// resolves.
final Completer<void>? completer;
/// An optional stdin sink that will be exposed through the resulting
/// [FakeProcess].
final IOSink? stdin;
/// If provided, this exception will be thrown when the fake command is run.
final Object? exception;
/// When true, stdout and stderr will only be emitted after the `exitCode`
/// [Future] on [io.Process] completes.
final bool outputFollowsExit;
final io.ProcessStartMode? processStartMode;
void _matches(
List<String> command,
String? workingDirectory,
Map<String, String>? environment,
Encoding? encoding,
io.ProcessStartMode? mode,
) {
final List<dynamic> matchers = this.command.map((Pattern x) => x is String ? x : matches(x)).toList();
expect(command, matchers);
if (processStartMode != null) {
expect(mode, processStartMode);
}
if (this.workingDirectory != null) {
expect(workingDirectory, this.workingDirectory);
}
if (this.environment != null) {
expect(environment, this.environment);
}
if (this.encoding != null) {
expect(encoding, this.encoding);
}
}
}
/// A fake process for use with [FakeProcessManager].
///
/// The process delays exit until both [duration] (if specified) has elapsed
/// and [completer] (if specified) has completed.
///
/// When [outputFollowsExit] is specified, bytes are streamed to [stderr] and
/// [stdout] after the process exits.
@visibleForTesting
class FakeProcess implements io.Process {
FakeProcess({
int exitCode = 0,
Duration duration = Duration.zero,
this.pid = 1234,
List<int> stderr = const <int>[],
IOSink? stdin,
List<int> stdout = const <int>[],
Completer<void>? completer,
bool outputFollowsExit = false,
}) : _exitCode = exitCode,
exitCode = Future<void>.delayed(duration).then((void value) {
if (completer != null) {
return completer.future.then((void _) => exitCode);
}
return exitCode;
}),
_stderr = stderr,
stdin = stdin ?? IOSink(StreamController<List<int>>().sink),
_stdout = stdout,
_completer = completer
{
if (_stderr.isEmpty) {
this.stderr = const Stream<List<int>>.empty();
} else if (outputFollowsExit) {
// Wait for the process to exit before emitting stderr.
this.stderr = Stream<List<int>>.fromFuture(this.exitCode.then((_) {
// Return a Future so stderr isn't immediately available to those who
// await exitCode, but is available asynchronously later.
return Future<List<int>>(() => _stderr);
}));
} else {
this.stderr = Stream<List<int>>.value(_stderr);
}
if (_stdout.isEmpty) {
this.stdout = const Stream<List<int>>.empty();
} else if (outputFollowsExit) {
// Wait for the process to exit before emitting stdout.
this.stdout = Stream<List<int>>.fromFuture(this.exitCode.then((_) {
// Return a Future so stdout isn't immediately available to those who
// await exitCode, but is available asynchronously later.
return Future<List<int>>(() => _stdout);
}));
} else {
this.stdout = Stream<List<int>>.value(_stdout);
}
}
/// The process exit code.
final int _exitCode;
/// When specified, blocks process exit until completed.
final Completer<void>? _completer;
@override
final Future<int> exitCode;
@override
final int pid;
/// The raw byte content of stderr.
final List<int> _stderr;
@override
late final Stream<List<int>> stderr;
@override
final IOSink stdin;
@override
late final Stream<List<int>> stdout;
/// The raw byte content of stdout.
final List<int> _stdout;
@override
bool kill([io.ProcessSignal signal = io.ProcessSignal.sigterm]) {
// Killing a fake process has no effect.
return false;
}
}
abstract class FakeProcessManager implements ProcessManager {
/// A fake [ProcessManager] which responds to all commands as if they had run
/// instantaneously with an exit code of 0 and no output.
factory FakeProcessManager.any() = _FakeAnyProcessManager;
/// A fake [ProcessManager] which responds to particular commands with
/// particular results.
///
/// On creation, pass in a list of [FakeCommand] objects. When the
/// [ProcessManager] methods such as [start] are invoked, the next
/// [FakeCommand] must match (otherwise the test fails); its settings are used
/// to simulate the result of running that command.
///
/// If no command is found, then one is implied which immediately returns exit
/// code 0 with no output.
///
/// There is no logic to ensure that all the listed commands are run. Use
/// [FakeCommand.onRun] to set a flag, or specify a sentinel command as your
/// last command and verify its execution is successful, to ensure that all
/// the specified commands are actually called.
factory FakeProcessManager.list(List<FakeCommand> commands) = _SequenceProcessManager;
factory FakeProcessManager.empty() => _SequenceProcessManager(<FakeCommand>[]);
FakeProcessManager._();
/// Adds a new [FakeCommand] to the current process manager.
///
/// This can be used to configure test expectations after the [ProcessManager] has been
/// provided to another interface.
///
/// This is a no-op on [FakeProcessManager.any].
void addCommand(FakeCommand command);
/// Add multiple [FakeCommand] to the current process manager.
void addCommands(Iterable<FakeCommand> commands) {
commands.forEach(addCommand);
}
final Map<int, FakeProcess> _fakeRunningProcesses = <int, FakeProcess>{};
/// Whether this fake has more [FakeCommand]s that are expected to run.
///
/// This is always `true` for [FakeProcessManager.any].
bool get hasRemainingExpectations;
/// The expected [FakeCommand]s that have not yet run.
List<FakeCommand> get _remainingExpectations;
@protected
FakeCommand findCommand(
List<String> command,
String? workingDirectory,
Map<String, String>? environment,
Encoding? encoding,
io.ProcessStartMode? mode,
);
int _pid = 9999;
FakeProcess _runCommand(
List<String> command, {
String? workingDirectory,
Map<String, String>? environment,
Encoding? encoding,
io.ProcessStartMode? mode,
}) {
_pid += 1;
final FakeCommand fakeCommand = findCommand(
command,
workingDirectory,
environment,
encoding,
mode,
);
if (fakeCommand.exception != null) {
assert(fakeCommand.exception is Exception || fakeCommand.exception is Error);
throw fakeCommand.exception!; // ignore: only_throw_errors
}
if (fakeCommand.onRun != null) {
fakeCommand.onRun!();
}
return FakeProcess(
duration: fakeCommand.duration,
exitCode: fakeCommand.exitCode,
pid: _pid,
stderr: encoding?.encode(fakeCommand.stderr) ?? fakeCommand.stderr.codeUnits,
stdin: fakeCommand.stdin,
stdout: encoding?.encode(fakeCommand.stdout) ?? fakeCommand.stdout.codeUnits,
completer: fakeCommand.completer,
outputFollowsExit: fakeCommand.outputFollowsExit,
);
}
@override
Future<io.Process> start(
List<dynamic> command, {
String? workingDirectory,
Map<String, String>? environment,
bool includeParentEnvironment = true, // ignored
bool runInShell = false, // ignored
io.ProcessStartMode mode = io.ProcessStartMode.normal,
}) {
final FakeProcess process = _runCommand(
command.cast<String>(),
workingDirectory: workingDirectory,
environment: environment,
encoding: io.systemEncoding,
mode: mode,
);
if (process._completer != null) {
_fakeRunningProcesses[process.pid] = process;
process.exitCode.whenComplete(() {
_fakeRunningProcesses.remove(process.pid);
});
}
return Future<io.Process>.value(process);
}
@override
Future<io.ProcessResult> run(
List<dynamic> command, {
String? workingDirectory,
Map<String, String>? environment,
bool includeParentEnvironment = true, // ignored
bool runInShell = false, // ignored
Encoding? stdoutEncoding = io.systemEncoding,
Encoding? stderrEncoding = io.systemEncoding,
}) async {
final FakeProcess process = _runCommand(
command.cast<String>(),
workingDirectory: workingDirectory,
environment: environment,
encoding: stdoutEncoding,
);
await process.exitCode;
return io.ProcessResult(
process.pid,
process._exitCode,
stdoutEncoding == null ? process._stdout : await stdoutEncoding.decodeStream(process.stdout),
stderrEncoding == null ? process._stderr : await stderrEncoding.decodeStream(process.stderr),
);
}
@override
io.ProcessResult runSync(
List<dynamic> command, {
String? workingDirectory,
Map<String, String>? environment,
bool includeParentEnvironment = true, // ignored
bool runInShell = false, // ignored
Encoding? stdoutEncoding = io.systemEncoding,
Encoding? stderrEncoding = io.systemEncoding,
}) {
final FakeProcess process = _runCommand(
command.cast<String>(),
workingDirectory: workingDirectory,
environment: environment,
encoding: stdoutEncoding,
);
return io.ProcessResult(
process.pid,
process._exitCode,
stdoutEncoding == null ? process._stdout : stdoutEncoding.decode(process._stdout),
stderrEncoding == null ? process._stderr : stderrEncoding.decode(process._stderr),
);
}
/// Returns false if executable in [excludedExecutables].
@override
bool canRun(dynamic executable, {String? workingDirectory}) => !excludedExecutables.contains(executable);
Set<String> excludedExecutables = <String>{};
@override
bool killPid(int pid, [io.ProcessSignal signal = io.ProcessSignal.sigterm]) {
// Killing a fake process has no effect unless it has an attached completer.
final FakeProcess? fakeProcess = _fakeRunningProcesses[pid];
if (fakeProcess == null) {
return false;
}
if (fakeProcess._completer != null) {
fakeProcess._completer!.complete();
}
return true;
}
}
class _FakeAnyProcessManager extends FakeProcessManager {
_FakeAnyProcessManager() : super._();
@override
FakeCommand findCommand(
List<String> command,
String? workingDirectory,
Map<String, String>? environment,
Encoding? encoding,
io.ProcessStartMode? mode,
) {
return FakeCommand(
command: command,
workingDirectory: workingDirectory,
environment: environment,
encoding: encoding,
processStartMode: mode,
);
}
@override
void addCommand(FakeCommand command) { }
@override
bool get hasRemainingExpectations => true;
@override
List<FakeCommand> get _remainingExpectations => <FakeCommand>[];
}
class _SequenceProcessManager extends FakeProcessManager {
_SequenceProcessManager(this._commands) : super._();
final List<FakeCommand> _commands;
@override
FakeCommand findCommand(
List<String> command,
String? workingDirectory,
Map<String, String>? environment,
Encoding? encoding,
io.ProcessStartMode? mode,
) {
expect(_commands, isNotEmpty,
reason: 'ProcessManager was told to execute $command (in $workingDirectory) '
'but the FakeProcessManager.list expected no more processes.'
);
_commands.first._matches(command, workingDirectory, environment, encoding, mode);
return _commands.removeAt(0);
}
@override
void addCommand(FakeCommand command) {
_commands.add(command);
}
@override
bool get hasRemainingExpectations => _commands.isNotEmpty;
@override
List<FakeCommand> get _remainingExpectations => _commands;
}
/// Matcher that successfully matches against a [FakeProcessManager] with
/// no remaining expectations ([item.hasRemainingExpectations] returns false).
const Matcher hasNoRemainingExpectations = _HasNoRemainingExpectations();
class _HasNoRemainingExpectations extends Matcher {
const _HasNoRemainingExpectations();
@override
bool matches(dynamic item, Map<dynamic, dynamic> matchState) =>
item is FakeProcessManager && !item.hasRemainingExpectations;
@override
Description describe(Description description) =>
description.add('a fake process manager with no remaining expectations');
@override
Description describeMismatch(
dynamic item,
Description description,
Map<dynamic, dynamic> matchState,
bool verbose,
) {
final FakeProcessManager fakeProcessManager = item as FakeProcessManager;
return description.add(
'has remaining expectations:\n${fakeProcessManager._remainingExpectations.map((FakeCommand command) => command.command).join('\n')}');
}
}