// 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 IOSink, ProcessSignal, Stdout, StdoutException; import 'package:flutter_tools/src/android/android_device.dart'; import 'package:flutter_tools/src/android/android_sdk.dart' show AndroidSdk; import 'package:flutter_tools/src/application_package.dart'; import 'package:flutter_tools/src/base/bot_detector.dart'; import 'package:flutter_tools/src/base/context.dart'; import 'package:flutter_tools/src/base/file_system.dart' hide IOSink; import 'package:flutter_tools/src/base/io.dart'; import 'package:flutter_tools/src/base/platform.dart'; import 'package:flutter_tools/src/build_info.dart'; import 'package:flutter_tools/src/compile.dart'; import 'package:flutter_tools/src/device.dart'; import 'package:flutter_tools/src/globals.dart' as globals; import 'package:flutter_tools/src/ios/devices.dart'; import 'package:flutter_tools/src/ios/simulators.dart'; import 'package:flutter_tools/src/project.dart'; import 'package:flutter_tools/src/runner/flutter_command.dart'; import 'package:mockito/mockito.dart'; import 'package:package_config/package_config.dart'; import 'package:process/process.dart'; import 'common.dart'; // TODO(fujino): replace FakePlatform.fromPlatform() with FakePlatform() final Generator kNoColorTerminalPlatform = () { return FakePlatform.fromPlatform( const LocalPlatform() )..stdoutSupportsAnsi = false; }; class MockApplicationPackageStore extends ApplicationPackageStore { MockApplicationPackageStore() : super( android: AndroidApk( id: 'io.flutter.android.mock', file: globals.fs.file('/mock/path/to/android/SkyShell.apk'), versionCode: 1, launchActivity: 'io.flutter.android.mock.MockActivity', ), iOS: BuildableIOSApp(MockIosProject(), MockIosProject.bundleId, MockIosProject.appBundleName), ); } class MockApplicationPackageFactory extends Mock implements ApplicationPackageFactory { final MockApplicationPackageStore _store = MockApplicationPackageStore(); @override Future getPackageForPlatform( TargetPlatform platform, { BuildInfo buildInfo, File applicationBinary, }) async { return _store.getPackageForPlatform(platform, buildInfo); } } /// An SDK installation with several SDK levels (19, 22, 23). class MockAndroidSdk extends Mock implements AndroidSdk { static Directory createSdkDirectory({ bool withAndroidN = false, bool withSdkManager = true, bool withPlatformTools = true, bool withBuildTools = true, }) { final Directory dir = globals.fs.systemTempDirectory.createTempSync('flutter_mock_android_sdk.'); final String exe = globals.platform.isWindows ? '.exe' : ''; final String bat = globals.platform.isWindows ? '.bat' : ''; _createDir(dir, 'licenses'); if (withPlatformTools) { _createSdkFile(dir, 'platform-tools/adb$exe'); } if (withBuildTools) { _createSdkFile(dir, 'build-tools/19.1.0/aapt$exe'); _createSdkFile(dir, 'build-tools/22.0.1/aapt$exe'); _createSdkFile(dir, 'build-tools/23.0.2/aapt$exe'); if (withAndroidN) { _createSdkFile(dir, 'build-tools/24.0.0-preview/aapt$exe'); } } _createSdkFile(dir, 'platforms/android-22/android.jar'); _createSdkFile(dir, 'platforms/android-23/android.jar'); if (withAndroidN) { _createSdkFile(dir, 'platforms/android-N/android.jar'); _createSdkFile(dir, 'platforms/android-N/build.prop', contents: _buildProp); } if (withSdkManager) { _createSdkFile(dir, 'tools/bin/sdkmanager$bat'); } return dir; } static void _createSdkFile(Directory dir, String filePath, { String contents }) { final File file = dir.childFile(filePath); file.createSync(recursive: true); if (contents != null) { file.writeAsStringSync(contents, flush: true); } } static void _createDir(Directory dir, String path) { final Directory directory = globals.fs.directory(globals.fs.path.join(dir.path, path)); directory.createSync(recursive: true); } static const String _buildProp = r''' ro.build.version.incremental=1624448 ro.build.version.sdk=24 ro.build.version.codename=REL '''; } /// A strategy for creating Process objects from a list of commands. typedef ProcessFactory = Process Function(List command); /// A ProcessManager that starts Processes by delegating to a ProcessFactory. class MockProcessManager extends Mock implements ProcessManager { ProcessFactory processFactory = (List commands) => MockProcess(); bool canRunSucceeds = true; bool runSucceeds = true; List commands; @override bool canRun(dynamic command, { String workingDirectory }) => canRunSucceeds; @override Future start( List command, { String workingDirectory, Map environment, bool includeParentEnvironment = true, bool runInShell = false, ProcessStartMode mode = ProcessStartMode.normal, }) { final List commands = command.cast(); if (!runSucceeds) { final String executable = commands[0]; final List arguments = commands.length > 1 ? commands.sublist(1) : []; throw ProcessException(executable, arguments); } this.commands = commands; return Future.value(processFactory(commands)); } } /// A function that generates a process factory that gives processes that fail /// a given number of times before succeeding. The returned processes will /// fail after a delay if one is supplied. ProcessFactory flakyProcessFactory({ int flakes, bool Function(List command) filter, Duration delay, Stream> Function() stdout, Stream> Function() stderr, }) { int flakesLeft = flakes; stdout ??= () => const Stream>.empty(); stderr ??= () => const Stream>.empty(); return (List command) { if (filter != null && !filter(command)) { return MockProcess(); } if (flakesLeft == 0) { return MockProcess( exitCode: Future.value(0), stdout: stdout(), stderr: stderr(), ); } flakesLeft = flakesLeft - 1; Future exitFuture; if (delay == null) { exitFuture = Future.value(-9); } else { exitFuture = Future.delayed(delay, () => Future.value(-9)); } return MockProcess( exitCode: exitFuture, stdout: stdout(), stderr: stderr(), ); }; } /// Creates a mock process that returns with the given [exitCode], [stdout] and [stderr]. Process createMockProcess({ int exitCode = 0, String stdout = '', String stderr = '' }) { final Stream> stdoutStream = Stream>.fromIterable(>[ utf8.encode(stdout), ]); final Stream> stderrStream = Stream>.fromIterable(>[ utf8.encode(stderr), ]); final Process process = MockBasicProcess(); when(process.stdout).thenAnswer((_) => stdoutStream); when(process.stderr).thenAnswer((_) => stderrStream); when(process.exitCode).thenAnswer((_) => Future.value(exitCode)); return process; } class MockBasicProcess extends Mock implements Process {} /// A process that exits successfully with no output and ignores all input. class MockProcess extends Mock implements Process { MockProcess({ this.pid = 1, Future exitCode, Stream> stdin, this.stdout = const Stream>.empty(), this.stderr = const Stream>.empty(), }) : exitCode = exitCode ?? Future.value(0), stdin = stdin as IOSink ?? MemoryIOSink(); @override final int pid; @override final Future exitCode; @override final io.IOSink stdin; @override final Stream> stdout; @override final Stream> stderr; } /// A fake process implementation which can be provided all necessary values. class FakeProcess implements Process { FakeProcess({ this.pid = 1, Future exitCode, Stream> stdin, this.stdout = const Stream>.empty(), this.stderr = const Stream>.empty(), }) : exitCode = exitCode ?? Future.value(0), stdin = stdin as IOSink ?? MemoryIOSink(); @override final int pid; @override final Future exitCode; @override final io.IOSink stdin; @override final Stream> stdout; @override final Stream> stderr; @override bool kill([io.ProcessSignal signal = io.ProcessSignal.sigterm]) { return true; } } /// A process that prompts the user to proceed, then asynchronously writes /// some lines to stdout before it exits. class PromptingProcess implements Process { PromptingProcess({ bool stdinError = false, }) : _stdin = CompleterIOSink(throwOnAdd: stdinError); Future showPrompt(String prompt, List outputLines) async { try { _stdoutController.add(utf8.encode(prompt)); final List bytesOnStdin = await _stdin.future; // Echo stdin to stdout. _stdoutController.add(bytesOnStdin); if (bytesOnStdin.isNotEmpty && bytesOnStdin[0] == utf8.encode('y')[0]) { for (final String line in outputLines) { _stdoutController.add(utf8.encode('$line\n')); } } } finally { await _stdoutController.close(); } } final StreamController> _stdoutController = StreamController>(); final CompleterIOSink _stdin; @override Stream> get stdout => _stdoutController.stream; @override Stream> get stderr => const Stream>.empty(); @override IOSink get stdin => _stdin; @override Future get exitCode async { await _stdoutController.done; return 0; } @override dynamic noSuchMethod(Invocation invocation) => null; } /// An IOSink that completes a future with the first line written to it. class CompleterIOSink extends MemoryIOSink { CompleterIOSink({ this.throwOnAdd = false, }); final bool throwOnAdd; final Completer> _completer = Completer>(); Future> get future => _completer.future; @override void add(List data) { if (!_completer.isCompleted) { // When throwOnAdd is true, complete with empty so any expected output // doesn't appear. _completer.complete(throwOnAdd ? [] : data); } if (throwOnAdd) { throw Exception('CompleterIOSink Error'); } super.add(data); } } /// An IOSink that collects whatever is written to it. class MemoryIOSink implements IOSink { @override Encoding encoding = utf8; final List> writes = >[]; @override void add(List data) { writes.add(data); } @override Future addStream(Stream> stream) { final Completer completer = Completer(); StreamSubscription> sub; sub = stream.listen( (List data) { try { add(data); // Catches all exceptions to propagate them to the completer. } catch (err, stack) { // ignore: avoid_catches_without_on_clauses sub.cancel(); completer.completeError(err, stack); } }, onError: completer.completeError, onDone: completer.complete, cancelOnError: true, ); return completer.future; } @override void writeCharCode(int charCode) { add([charCode]); } @override void write(Object obj) { add(encoding.encode('$obj')); } @override void writeln([ Object obj = '' ]) { add(encoding.encode('$obj\n')); } @override void writeAll(Iterable objects, [ String separator = '' ]) { bool addSeparator = false; for (final dynamic object in objects) { if (addSeparator) { write(separator); } write(object); addSeparator = true; } } @override void addError(dynamic error, [ StackTrace stackTrace ]) { throw UnimplementedError(); } @override Future get done => close(); @override Future close() async { } @override Future flush() async { } } class MemoryStdout extends MemoryIOSink implements io.Stdout { @override bool get hasTerminal => _hasTerminal; set hasTerminal(bool value) { assert(value != null); _hasTerminal = value; } bool _hasTerminal = true; @override io.IOSink get nonBlocking => this; @override bool get supportsAnsiEscapes => _supportsAnsiEscapes; set supportsAnsiEscapes(bool value) { assert(value != null); _supportsAnsiEscapes = value; } bool _supportsAnsiEscapes = true; @override int get terminalColumns { if (_terminalColumns != null) { return _terminalColumns; } throw const io.StdoutException('unspecified mock value'); } set terminalColumns(int value) => _terminalColumns = value; int _terminalColumns; @override int get terminalLines { if (_terminalLines != null) { return _terminalLines; } throw const io.StdoutException('unspecified mock value'); } set terminalLines(int value) => _terminalLines = value; int _terminalLines; } /// A Stdio that collects stdout and supports simulated stdin. class MockStdio extends Stdio { final MemoryStdout _stdout = MemoryStdout(); final MemoryIOSink _stderr = MemoryIOSink(); final StreamController> _stdin = StreamController>(); @override MemoryStdout get stdout => _stdout; @override MemoryIOSink get stderr => _stderr; @override Stream> get stdin => _stdin.stream; void simulateStdin(String line) { _stdin.add(utf8.encode('$line\n')); } List get writtenToStdout => _stdout.writes.map(_stdout.encoding.decode).toList(); List get writtenToStderr => _stderr.writes.map(_stderr.encoding.decode).toList(); } class FakePollingDeviceDiscovery extends PollingDeviceDiscovery { FakePollingDeviceDiscovery() : super('mock'); final List _devices = []; final StreamController _onAddedController = StreamController.broadcast(); final StreamController _onRemovedController = StreamController.broadcast(); @override Future> pollingGetDevices({ Duration timeout }) async { lastPollingTimeout = timeout; return _devices; } Duration lastPollingTimeout; @override bool get supportsPlatform => true; @override bool get canListAnything => true; void addDevice(Device device) { _devices.add(device); _onAddedController.add(device); } void _removeDevice(Device device) { _devices.remove(device); _onRemovedController.add(device); } void setDevices(List devices) { while(_devices.isNotEmpty) { _removeDevice(_devices.first); } devices.forEach(addDevice); } @override Stream get onAdded => _onAddedController.stream; @override Stream get onRemoved => _onRemovedController.stream; } class MockIosProject extends Mock implements IosProject { static const String bundleId = 'com.example.test'; static const String appBundleName = 'My Super Awesome App.app'; @override Future productBundleIdentifier(BuildInfo buildInfo) async => bundleId; @override Future hostAppBundleName(BuildInfo buildInfo) async => appBundleName; } class MockAndroidDevice extends Mock implements AndroidDevice { @override Future get targetPlatform async => TargetPlatform.android_arm; @override bool isSupported() => true; @override bool get supportsHotRestart => true; @override bool get supportsFlutterExit => false; @override bool isSupportedForProject(FlutterProject flutterProject) => true; } class MockIOSDevice extends Mock implements IOSDevice { @override Future get targetPlatform async => TargetPlatform.ios; @override bool isSupported() => true; @override bool isSupportedForProject(FlutterProject flutterProject) => true; } class MockIOSSimulator extends Mock implements IOSSimulator { @override Future get targetPlatform async => TargetPlatform.ios; @override bool isSupported() => true; @override bool isSupportedForProject(FlutterProject flutterProject) => true; } void applyMocksToCommand(FlutterCommand command) { command.applicationPackages = MockApplicationPackageStore(); } /// Common functionality for tracking mock interaction class BasicMock { final List messages = []; void expectMessages(List expectedMessages) { final List actualMessages = List.of(messages); messages.clear(); expect(actualMessages, unorderedEquals(expectedMessages)); } bool contains(String match) { print('Checking for `$match` in:'); print(messages); final bool result = messages.contains(match); messages.clear(); return result; } } class MockResidentCompiler extends BasicMock implements ResidentCompiler { @override void accept() { } @override Future reject() async { return null; } @override void reset() { } @override Future shutdown() async { } @override Future compileExpression( String expression, List definitions, List typeDefinitions, String libraryUri, String klass, bool isStatic, ) async { return null; } @override Future compileExpressionToJs( String libraryUri, int line, int column, Map jsModules, Map jsFrameValues, String moduleName, String expression, ) async { return null; } @override Future recompile(Uri mainPath, List invalidatedFiles, { String outputPath, PackageConfig packageConfig, bool suppressErrors = false, }) async { globals.fs.file(outputPath).createSync(recursive: true); globals.fs.file(outputPath).writeAsStringSync('compiled_kernel_output'); return CompilerOutput(outputPath, 0, []); } @override void addFileSystemRoot(String root) { } } /// A fake implementation of [ProcessResult]. class FakeProcessResult implements ProcessResult { FakeProcessResult({ this.exitCode = 0, this.pid = 1, this.stderr, this.stdout, }); @override final int exitCode; @override final int pid; @override final dynamic stderr; @override final dynamic stdout; @override String toString() => stdout?.toString() ?? stderr?.toString() ?? runtimeType.toString(); } class MockStdIn extends Mock implements IOSink { final StringBuffer stdInWrites = StringBuffer(); String getAndClear() { final String result = stdInWrites.toString(); stdInWrites.clear(); return result; } @override void write([ Object o = '' ]) { stdInWrites.write(o); } @override void writeln([ Object o = '' ]) { stdInWrites.writeln(o); } } class MockStream extends Mock implements Stream> {} class AlwaysTrueBotDetector implements BotDetector { const AlwaysTrueBotDetector(); @override Future get isRunningOnBot async => true; } class AlwaysFalseBotDetector implements BotDetector { const AlwaysFalseBotDetector(); @override Future get isRunningOnBot async => false; }