2016-12-13 21:43:19 +00:00
|
|
|
// 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.
|
|
|
|
|
2018-07-06 22:18:57 +00:00
|
|
|
import 'dart:async';
|
|
|
|
|
2018-08-31 22:40:00 +00:00
|
|
|
import 'package:flutter_tools/src/artifacts.dart';
|
2018-11-09 18:33:22 +00:00
|
|
|
import 'package:flutter_tools/src/devfs.dart';
|
2018-07-06 22:18:57 +00:00
|
|
|
import 'package:flutter_tools/src/device.dart';
|
|
|
|
import 'package:flutter_tools/src/resident_runner.dart';
|
2017-01-28 22:26:49 +00:00
|
|
|
import 'package:flutter_tools/src/run_hot.dart';
|
2018-07-06 22:18:57 +00:00
|
|
|
import 'package:meta/meta.dart';
|
|
|
|
import 'package:mockito/mockito.dart';
|
2016-12-13 21:43:19 +00:00
|
|
|
|
2018-08-15 03:33:58 +00:00
|
|
|
import 'src/common.dart';
|
2016-12-13 21:43:19 +00:00
|
|
|
import 'src/context.dart';
|
2018-08-31 22:40:00 +00:00
|
|
|
import 'src/mocks.dart';
|
2016-12-13 21:43:19 +00:00
|
|
|
|
2018-02-02 22:27:29 +00:00
|
|
|
void main() {
|
2016-12-13 21:43:19 +00:00
|
|
|
group('validateReloadReport', () {
|
|
|
|
testUsingContext('invalid', () async {
|
|
|
|
expect(HotRunner.validateReloadReport(<String, dynamic>{}), false);
|
2018-06-05 02:12:55 +00:00
|
|
|
expect(HotRunner.validateReloadReport(<String, dynamic>{
|
|
|
|
'type': 'ReloadReport',
|
|
|
|
'success': false,
|
|
|
|
'details': <String, dynamic>{},
|
|
|
|
}), false);
|
|
|
|
expect(HotRunner.validateReloadReport(<String, dynamic>{
|
|
|
|
'type': 'ReloadReport',
|
|
|
|
'success': false,
|
|
|
|
'details': <String, dynamic>{
|
|
|
|
'notices': <Map<String, dynamic>>[
|
|
|
|
],
|
|
|
|
},
|
|
|
|
}), false);
|
|
|
|
expect(HotRunner.validateReloadReport(<String, dynamic>{
|
|
|
|
'type': 'ReloadReport',
|
|
|
|
'success': false,
|
|
|
|
'details': <String, dynamic>{
|
|
|
|
'notices': <String, dynamic>{
|
|
|
|
'message': 'error',
|
|
|
|
},
|
|
|
|
},
|
|
|
|
}), false);
|
|
|
|
expect(HotRunner.validateReloadReport(<String, dynamic>{
|
|
|
|
'type': 'ReloadReport',
|
|
|
|
'success': false,
|
|
|
|
'details': <String, dynamic>{
|
|
|
|
'notices': <Map<String, dynamic>>[],
|
|
|
|
},
|
|
|
|
}), false);
|
|
|
|
expect(HotRunner.validateReloadReport(<String, dynamic>{
|
|
|
|
'type': 'ReloadReport',
|
|
|
|
'success': false,
|
|
|
|
'details': <String, dynamic>{
|
|
|
|
'notices': <Map<String, dynamic>>[
|
2019-03-20 22:23:31 +00:00
|
|
|
<String, dynamic>{'message': false},
|
2018-06-05 02:12:55 +00:00
|
|
|
],
|
|
|
|
},
|
|
|
|
}), false);
|
|
|
|
expect(HotRunner.validateReloadReport(<String, dynamic>{
|
|
|
|
'type': 'ReloadReport',
|
|
|
|
'success': false,
|
|
|
|
'details': <String, dynamic>{
|
|
|
|
'notices': <Map<String, dynamic>>[
|
2019-03-20 22:23:31 +00:00
|
|
|
<String, dynamic>{'message': <String>['error']},
|
2018-06-05 02:12:55 +00:00
|
|
|
],
|
|
|
|
},
|
|
|
|
}), false);
|
|
|
|
expect(HotRunner.validateReloadReport(<String, dynamic>{
|
|
|
|
'type': 'ReloadReport',
|
|
|
|
'success': false,
|
|
|
|
'details': <String, dynamic>{
|
|
|
|
'notices': <Map<String, dynamic>>[
|
2019-03-20 22:23:31 +00:00
|
|
|
<String, dynamic>{'message': 'error'},
|
|
|
|
<String, dynamic>{'message': <String>['error']},
|
2018-06-05 02:12:55 +00:00
|
|
|
],
|
|
|
|
},
|
|
|
|
}), false);
|
|
|
|
expect(HotRunner.validateReloadReport(<String, dynamic>{
|
|
|
|
'type': 'ReloadReport',
|
|
|
|
'success': false,
|
|
|
|
'details': <String, dynamic>{
|
|
|
|
'notices': <Map<String, dynamic>>[
|
2019-03-20 22:23:31 +00:00
|
|
|
<String, dynamic>{'message': 'error'},
|
2018-06-05 02:12:55 +00:00
|
|
|
],
|
|
|
|
},
|
|
|
|
}), false);
|
|
|
|
expect(HotRunner.validateReloadReport(<String, dynamic>{
|
|
|
|
'type': 'ReloadReport',
|
|
|
|
'success': true,
|
|
|
|
}), true);
|
2016-12-13 21:43:19 +00:00
|
|
|
});
|
|
|
|
});
|
2018-07-06 22:18:57 +00:00
|
|
|
|
|
|
|
group('hotRestart', () {
|
2018-09-12 06:29:29 +00:00
|
|
|
final MockResidentCompiler residentCompiler = MockResidentCompiler();
|
2018-11-09 18:33:22 +00:00
|
|
|
final MockDevFs mockDevFs = MockDevFs();
|
2018-08-31 22:40:00 +00:00
|
|
|
MockLocalEngineArtifacts mockArtifacts;
|
2018-07-06 22:18:57 +00:00
|
|
|
|
2018-11-09 18:33:22 +00:00
|
|
|
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'),
|
2019-03-15 22:02:45 +00:00
|
|
|
invalidatedFiles: anyNamed('invalidatedFiles'),
|
2018-12-27 17:53:24 +00:00
|
|
|
)).thenAnswer((Invocation _) => Future<UpdateFSReport>.value(
|
|
|
|
UpdateFSReport(success: true, syncedBytes: 1000, invalidatedSourcesCount: 1)));
|
2019-03-06 19:05:16 +00:00
|
|
|
when(mockDevFs.assetPathsToEvict).thenReturn(<String>{});
|
2018-11-09 18:33:22 +00:00
|
|
|
when(mockDevFs.baseUri).thenReturn(Uri.file('test'));
|
|
|
|
|
2018-07-06 22:18:57 +00:00
|
|
|
setUp(() {
|
2018-09-12 06:29:29 +00:00
|
|
|
mockArtifacts = MockLocalEngineArtifacts();
|
2018-08-31 22:40:00 +00:00
|
|
|
when(mockArtifacts.getArtifactPath(Artifact.flutterPatchedSdkPath)).thenReturn('some/path');
|
2018-07-06 22:18:57 +00:00
|
|
|
});
|
|
|
|
|
2018-11-09 18:33:22 +00:00
|
|
|
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<FlutterDevice> devices = <FlutterDevice>[
|
2019-03-01 07:17:55 +00:00
|
|
|
FlutterDevice(mockDevice, generator: residentCompiler, trackWidgetCreation: false)..devFS = mockDevFs,
|
2018-11-09 18:33:22 +00:00
|
|
|
];
|
2018-10-05 20:48:41 +00:00
|
|
|
final OperationResult result = await HotRunner(devices).restart(fullRestart: true);
|
2018-11-09 18:33:22 +00:00
|
|
|
// Expect hot restart failed.
|
2018-10-05 20:48:41 +00:00
|
|
|
expect(result.isOk, false);
|
2018-11-09 18:33:22 +00:00
|
|
|
expect(result.message, 'hotRestart not supported');
|
2018-07-06 22:18:57 +00:00
|
|
|
}, overrides: <Type, Generator>{
|
2018-08-31 22:40:00 +00:00
|
|
|
Artifacts: () => mockArtifacts,
|
2019-03-15 22:02:45 +00:00
|
|
|
HotRunnerConfig: () => TestHotRunnerConfig(successfulSetup: true),
|
2018-11-09 18:33:22 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
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<FlutterDevice> devices = <FlutterDevice>[
|
|
|
|
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: <Type, Generator>{
|
|
|
|
Artifacts: () => mockArtifacts,
|
2019-03-15 22:02:45 +00:00
|
|
|
HotRunnerConfig: () => TestHotRunnerConfig(successfulSetup: true),
|
2018-11-09 18:33:22 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
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<FlutterDevice> devices = <FlutterDevice>[
|
|
|
|
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: <Type, Generator>{
|
|
|
|
Artifacts: () => mockArtifacts,
|
2019-03-15 22:02:45 +00:00
|
|
|
HotRunnerConfig: () => TestHotRunnerConfig(successfulSetup: true),
|
2018-07-06 22:18:57 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
testUsingContext('setup function fails', () async {
|
2018-11-09 18:33:22 +00:00
|
|
|
final MockDevice mockDevice = MockDevice();
|
|
|
|
when(mockDevice.supportsHotReload).thenReturn(true);
|
|
|
|
when(mockDevice.supportsHotRestart).thenReturn(true);
|
|
|
|
final List<FlutterDevice> devices = <FlutterDevice>[
|
2019-03-01 07:17:55 +00:00
|
|
|
FlutterDevice(mockDevice, generator: residentCompiler, trackWidgetCreation: false),
|
2018-11-09 18:33:22 +00:00
|
|
|
];
|
2018-10-05 20:48:41 +00:00
|
|
|
final OperationResult result = await HotRunner(devices).restart(fullRestart: true);
|
|
|
|
expect(result.isOk, false);
|
|
|
|
expect(result.message, 'setupHotRestart failed');
|
2018-07-06 22:18:57 +00:00
|
|
|
}, overrides: <Type, Generator>{
|
2018-08-31 22:40:00 +00:00
|
|
|
Artifacts: () => mockArtifacts,
|
2018-09-12 06:29:29 +00:00
|
|
|
HotRunnerConfig: () => TestHotRunnerConfig(successfulSetup: false),
|
2018-07-06 22:18:57 +00:00
|
|
|
});
|
2018-11-09 18:33:22 +00:00
|
|
|
|
|
|
|
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<FlutterDevice> devices = <FlutterDevice>[
|
2019-03-01 07:17:55 +00:00
|
|
|
FlutterDevice(mockDevice, generator: residentCompiler, trackWidgetCreation: false)..devFS = mockDevFs,
|
2018-11-09 18:33:22 +00:00
|
|
|
];
|
|
|
|
final OperationResult result = await HotRunner(devices).restart(fullRestart: true);
|
|
|
|
// Expect hot restart successful.
|
|
|
|
expect(result.isOk, true);
|
|
|
|
expect(result.message, isNot('setupHotRestart failed'));
|
|
|
|
}, overrides: <Type, Generator>{
|
|
|
|
Artifacts: () => mockArtifacts,
|
2019-03-15 22:02:45 +00:00
|
|
|
HotRunnerConfig: () => TestHotRunnerConfig(successfulSetup: true),
|
2018-11-09 18:33:22 +00:00
|
|
|
});
|
2019-01-17 16:49:02 +00:00
|
|
|
|
|
|
|
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<FlutterDevice> devices = <FlutterDevice>[
|
2019-03-01 07:17:55 +00:00
|
|
|
FlutterDevice(mockDevice, generator: residentCompiler, trackWidgetCreation: false),
|
2019-01-17 16:49:02 +00:00
|
|
|
];
|
|
|
|
await HotRunner(devices).cleanupAfterSignal();
|
|
|
|
expect(shutdownTestingConfig.shutdownHookCalled, true);
|
|
|
|
}, overrides: <Type, Generator> {
|
|
|
|
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<FlutterDevice> devices = <FlutterDevice>[
|
2019-03-01 07:17:55 +00:00
|
|
|
FlutterDevice(mockDevice, generator: residentCompiler, trackWidgetCreation: false),
|
2019-01-17 16:49:02 +00:00
|
|
|
];
|
|
|
|
await HotRunner(devices).preStop();
|
|
|
|
expect(shutdownTestingConfig.shutdownHookCalled, true);
|
|
|
|
}, overrides: <Type, Generator> {
|
|
|
|
Artifacts: () => mockArtifacts,
|
|
|
|
HotRunnerConfig: () => shutdownTestingConfig,
|
|
|
|
});
|
|
|
|
});
|
2018-07-06 22:18:57 +00:00
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2018-11-09 18:33:22 +00:00
|
|
|
class MockDevFs extends Mock implements DevFS {}
|
|
|
|
|
2018-08-31 22:40:00 +00:00
|
|
|
class MockLocalEngineArtifacts extends Mock implements LocalEngineArtifacts {}
|
|
|
|
|
2018-07-06 22:18:57 +00:00
|
|
|
class MockDevice extends Mock implements Device {
|
|
|
|
MockDevice() {
|
|
|
|
when(isSupported()).thenReturn(true);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
class TestHotRunnerConfig extends HotRunnerConfig {
|
2019-03-15 22:02:45 +00:00
|
|
|
TestHotRunnerConfig({@required this.successfulSetup});
|
2018-10-04 05:28:07 +00:00
|
|
|
bool successfulSetup;
|
2019-01-17 16:49:02 +00:00
|
|
|
bool shutdownHookCalled = false;
|
2018-10-04 05:28:07 +00:00
|
|
|
|
2018-07-06 22:18:57 +00:00
|
|
|
@override
|
|
|
|
Future<bool> setupHotRestart() async {
|
|
|
|
return successfulSetup;
|
|
|
|
}
|
2019-01-17 16:49:02 +00:00
|
|
|
|
|
|
|
@override
|
|
|
|
Future<void> runPreShutdownOperations() async {
|
|
|
|
shutdownHookCalled = true;
|
|
|
|
}
|
2016-12-13 21:43:19 +00:00
|
|
|
}
|