// Copyright 2016 The Chromium 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 'package:flutter_tools/src/artifacts.dart'; import 'package:flutter_tools/src/devfs.dart'; import 'package:flutter_tools/src/device.dart'; import 'package:flutter_tools/src/resident_runner.dart'; import 'package:flutter_tools/src/run_hot.dart'; import 'package:meta/meta.dart'; import 'package:mockito/mockito.dart'; import 'src/common.dart'; import 'src/context.dart'; import 'src/mocks.dart'; void main() { group('validateReloadReport', () { testUsingContext('invalid', () async { expect(HotRunner.validateReloadReport({}), false); expect(HotRunner.validateReloadReport({ 'type': 'ReloadReport', 'success': false, 'details': {}, }), false); expect(HotRunner.validateReloadReport({ 'type': 'ReloadReport', 'success': false, 'details': { 'notices': >[ ], }, }), false); expect(HotRunner.validateReloadReport({ 'type': 'ReloadReport', 'success': false, 'details': { 'notices': { 'message': 'error', }, }, }), false); expect(HotRunner.validateReloadReport({ 'type': 'ReloadReport', 'success': false, 'details': { 'notices': >[], }, }), false); expect(HotRunner.validateReloadReport({ 'type': 'ReloadReport', 'success': false, 'details': { 'notices': >[ { 'message': false, }, ], }, }), false); expect(HotRunner.validateReloadReport({ 'type': 'ReloadReport', 'success': false, 'details': { 'notices': >[ { 'message': ['error'], }, ], }, }), false); expect(HotRunner.validateReloadReport({ 'type': 'ReloadReport', 'success': false, 'details': { 'notices': >[ { 'message': 'error', }, { 'message': ['error'], }, ], }, }), false); expect(HotRunner.validateReloadReport({ 'type': 'ReloadReport', 'success': false, 'details': { 'notices': >[ { 'message': 'error', }, ], }, }), false); expect(HotRunner.validateReloadReport({ 'type': 'ReloadReport', 'success': true, }), true); }); }); group('hotRestart', () { final MockResidentCompiler residentCompiler = MockResidentCompiler(); final MockDevFs mockDevFs = MockDevFs(); MockLocalEngineArtifacts mockArtifacts; when(mockDevFs.update( mainPath: anyNamed('mainPath'), target: anyNamed('target'), bundle: anyNamed('bundle'), firstBuildTime: anyNamed('firstBuildTime'), bundleFirstUpload: anyNamed('bundleFirstUpload'), bundleDirty: anyNamed('bundleDirty'), generator: anyNamed('generator'), fullRestart: anyNamed('fullRestart'), dillOutputPath: anyNamed('dillOutputPath'), trackWidgetCreation: anyNamed('trackWidgetCreation'), projectRootPath: anyNamed('projectRootPath'), pathToReload: anyNamed('pathToReload'), invalidatedFiles: anyNamed('invalidatedFiles'), )).thenAnswer((Invocation _) => Future.value( UpdateFSReport(success: true, syncedBytes: 1000, invalidatedSourcesCount: 1))); when(mockDevFs.assetPathsToEvict).thenReturn({}); when(mockDevFs.baseUri).thenReturn(Uri.file('test')); setUp(() { mockArtifacts = MockLocalEngineArtifacts(); when(mockArtifacts.getArtifactPath(Artifact.flutterPatchedSdkPath)).thenReturn('some/path'); }); testUsingContext('Does not hot restart when device does not support it', () async { // Setup mocks final MockDevice mockDevice = MockDevice(); when(mockDevice.supportsHotReload).thenReturn(true); when(mockDevice.supportsHotRestart).thenReturn(false); // Trigger hot restart. final List devices = [ FlutterDevice(mockDevice, generator: residentCompiler, trackWidgetCreation: false)..devFS = mockDevFs, ]; final OperationResult result = await HotRunner(devices).restart(fullRestart: true); // Expect hot restart failed. expect(result.isOk, false); expect(result.message, 'hotRestart not supported'); }, overrides: { Artifacts: () => mockArtifacts, HotRunnerConfig: () => TestHotRunnerConfig(successfulSetup: true), }); testUsingContext('Does not hot restart when one of many devices does not support it', () async { // Setup mocks final MockDevice mockDevice = MockDevice(); final MockDevice mockHotDevice = MockDevice(); when(mockDevice.supportsHotReload).thenReturn(true); when(mockDevice.supportsHotRestart).thenReturn(false); when(mockHotDevice.supportsHotReload).thenReturn(true); when(mockHotDevice.supportsHotRestart).thenReturn(true); // Trigger hot restart. final List devices = [ FlutterDevice(mockDevice, generator: residentCompiler, trackWidgetCreation: false)..devFS = mockDevFs, FlutterDevice(mockHotDevice, generator: residentCompiler, trackWidgetCreation: false)..devFS = mockDevFs, ]; final OperationResult result = await HotRunner(devices).restart(fullRestart: true); // Expect hot restart failed. expect(result.isOk, false); expect(result.message, 'hotRestart not supported'); }, overrides: { Artifacts: () => mockArtifacts, HotRunnerConfig: () => TestHotRunnerConfig(successfulSetup: true), }); testUsingContext('Does hot restarts when all devices support it', () async { // Setup mocks final MockDevice mockDevice = MockDevice(); final MockDevice mockHotDevice = MockDevice(); when(mockDevice.supportsHotReload).thenReturn(true); when(mockDevice.supportsHotRestart).thenReturn(true); when(mockHotDevice.supportsHotReload).thenReturn(true); when(mockHotDevice.supportsHotRestart).thenReturn(true); // Trigger a restart. final List devices = [ FlutterDevice(mockDevice, generator: residentCompiler, trackWidgetCreation: false)..devFS = mockDevFs, FlutterDevice(mockHotDevice, generator: residentCompiler, trackWidgetCreation: false)..devFS = mockDevFs, ]; final OperationResult result = await HotRunner(devices).restart(fullRestart: true); // Expect hot restart was successful. expect(result.isOk, true); expect(result.message, isNot('hotRestart not supported')); }, overrides: { Artifacts: () => mockArtifacts, HotRunnerConfig: () => TestHotRunnerConfig(successfulSetup: true), }); testUsingContext('setup function fails', () async { final MockDevice mockDevice = MockDevice(); when(mockDevice.supportsHotReload).thenReturn(true); when(mockDevice.supportsHotRestart).thenReturn(true); final List devices = [ FlutterDevice(mockDevice, generator: residentCompiler, trackWidgetCreation: false), ]; final OperationResult result = await HotRunner(devices).restart(fullRestart: true); expect(result.isOk, false); expect(result.message, 'setupHotRestart failed'); }, overrides: { Artifacts: () => mockArtifacts, HotRunnerConfig: () => TestHotRunnerConfig(successfulSetup: false), }); testUsingContext('hot restart supported', () async { // Setup mocks final MockDevice mockDevice = MockDevice(); when(mockDevice.supportsHotReload).thenReturn(true); when(mockDevice.supportsHotRestart).thenReturn(true); // Trigger hot restart. final List devices = [ FlutterDevice(mockDevice, generator: residentCompiler, trackWidgetCreation: false)..devFS = mockDevFs, ]; final OperationResult result = await HotRunner(devices).restart(fullRestart: true); // Expect hot restart successful. expect(result.isOk, true); expect(result.message, isNot('setupHotRestart failed')); }, overrides: { Artifacts: () => mockArtifacts, HotRunnerConfig: () => TestHotRunnerConfig(successfulSetup: true), }); group('shutdown hook tests', () { TestHotRunnerConfig shutdownTestingConfig; setUp(() { shutdownTestingConfig = TestHotRunnerConfig( successfulSetup: true, ); }); testUsingContext('shutdown hook called after signal', () async { final MockDevice mockDevice = MockDevice(); when(mockDevice.supportsHotReload).thenReturn(true); when(mockDevice.supportsHotRestart).thenReturn(true); when(mockDevice.supportsStopApp).thenReturn(false); final List devices = [ FlutterDevice(mockDevice, generator: residentCompiler, trackWidgetCreation: false), ]; await HotRunner(devices).cleanupAfterSignal(); expect(shutdownTestingConfig.shutdownHookCalled, true); }, overrides: { Artifacts: () => mockArtifacts, HotRunnerConfig: () => shutdownTestingConfig, }); testUsingContext('shutdown hook called after app stop', () async { final MockDevice mockDevice = MockDevice(); when(mockDevice.supportsHotReload).thenReturn(true); when(mockDevice.supportsHotRestart).thenReturn(true); when(mockDevice.supportsStopApp).thenReturn(false); final List devices = [ FlutterDevice(mockDevice, generator: residentCompiler, trackWidgetCreation: false), ]; await HotRunner(devices).preStop(); expect(shutdownTestingConfig.shutdownHookCalled, true); }, overrides: { Artifacts: () => mockArtifacts, HotRunnerConfig: () => shutdownTestingConfig, }); }); }); } class MockDevFs extends Mock implements DevFS {} class MockLocalEngineArtifacts extends Mock implements LocalEngineArtifacts {} class MockDevice extends Mock implements Device { MockDevice() { when(isSupported()).thenReturn(true); } } class TestHotRunnerConfig extends HotRunnerConfig { TestHotRunnerConfig({@required this.successfulSetup}); bool successfulSetup; bool shutdownHookCalled = false; @override Future setupHotRestart() async { return successfulSetup; } @override Future runPreShutdownOperations() async { shutdownHookCalled = true; } }