449f4a6673
* Update project.pbxproj files to say Flutter rather than Chromium Also, the templates now have an empty organization so that we don't cause people to give their apps a Flutter copyright. * Update the copyright notice checker to require a standard notice on all files * Update copyrights on Dart files. (This was a mechanical commit.) * Fix weird license headers on Dart files that deviate from our conventions; relicense Shrine. Some were already marked "The Flutter Authors", not clear why. Their dates have been normalized. Some were missing the blank line after the license. Some were randomly different in trivial ways for no apparent reason (e.g. missing the trailing period). * Clean up the copyrights in non-Dart files. (Manual edits.) Also, make sure templates don't have copyrights. * Fix some more ORGANIZATIONNAMEs
411 lines
12 KiB
Dart
411 lines
12 KiB
Dart
// 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:io' as io;
|
|
|
|
import 'package:flutter_tools/src/base/common.dart';
|
|
import 'package:flutter_tools/src/base/io.dart';
|
|
import 'package:flutter_tools/src/base/signals.dart';
|
|
import 'package:flutter_tools/src/base/time.dart';
|
|
import 'package:flutter_tools/src/cache.dart';
|
|
import 'package:flutter_tools/src/reporting/reporting.dart';
|
|
import 'package:flutter_tools/src/runner/flutter_command.dart';
|
|
import 'package:flutter_tools/src/version.dart';
|
|
import 'package:mockito/mockito.dart';
|
|
|
|
import '../../src/common.dart';
|
|
import '../../src/context.dart';
|
|
import 'utils.dart';
|
|
|
|
void main() {
|
|
group('Flutter Command', () {
|
|
MockitoCache cache;
|
|
MockitoUsage usage;
|
|
MockClock clock;
|
|
MockProcessInfo mockProcessInfo;
|
|
List<int> mockTimes;
|
|
|
|
setUp(() {
|
|
cache = MockitoCache();
|
|
usage = MockitoUsage();
|
|
clock = MockClock();
|
|
mockProcessInfo = MockProcessInfo();
|
|
|
|
when(usage.isFirstRun).thenReturn(false);
|
|
when(clock.now()).thenAnswer(
|
|
(Invocation _) => DateTime.fromMillisecondsSinceEpoch(mockTimes.removeAt(0))
|
|
);
|
|
when(mockProcessInfo.maxRss).thenReturn(10);
|
|
});
|
|
|
|
testUsingContext('honors shouldUpdateCache false', () async {
|
|
final DummyFlutterCommand flutterCommand = DummyFlutterCommand(shouldUpdateCache: false);
|
|
await flutterCommand.run();
|
|
verifyZeroInteractions(cache);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
Cache: () => cache,
|
|
});
|
|
|
|
testUsingContext('honors shouldUpdateCache true', () async {
|
|
final DummyFlutterCommand flutterCommand = DummyFlutterCommand(shouldUpdateCache: true);
|
|
await flutterCommand.run();
|
|
// First call for universal, second for the rest
|
|
expect(
|
|
verify(cache.updateAll(captureAny)).captured,
|
|
<Set<DevelopmentArtifact>>[
|
|
<DevelopmentArtifact>{DevelopmentArtifact.universal},
|
|
<DevelopmentArtifact>{},
|
|
],
|
|
);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
Cache: () => cache,
|
|
});
|
|
|
|
void testUsingCommandContext(String testName, dynamic Function() testBody) {
|
|
testUsingContext(testName, testBody, overrides: <Type, Generator>{
|
|
ProcessInfo: () => mockProcessInfo,
|
|
SystemClock: () => clock,
|
|
Usage: () => usage,
|
|
});
|
|
}
|
|
|
|
testUsingCommandContext('reports command that results in success', () async {
|
|
// Crash if called a third time which is unexpected.
|
|
mockTimes = <int>[1000, 2000];
|
|
|
|
final DummyFlutterCommand flutterCommand = DummyFlutterCommand(
|
|
commandFunction: () async {
|
|
return const FlutterCommandResult(ExitStatus.success);
|
|
}
|
|
);
|
|
await flutterCommand.run();
|
|
|
|
verify(usage.sendCommand(
|
|
'dummy',
|
|
parameters: anyNamed('parameters'),
|
|
));
|
|
verify(usage.sendEvent(
|
|
'tool-command-result',
|
|
'dummy',
|
|
label: 'success',
|
|
parameters: anyNamed('parameters'),
|
|
));
|
|
expect(verify(usage.sendEvent(
|
|
'tool-command-max-rss',
|
|
'dummy',
|
|
label: 'success',
|
|
value: captureAnyNamed('value'),
|
|
)).captured[0],
|
|
10,
|
|
);
|
|
});
|
|
|
|
testUsingCommandContext('reports command that results in warning', () async {
|
|
// Crash if called a third time which is unexpected.
|
|
mockTimes = <int>[1000, 2000];
|
|
|
|
final DummyFlutterCommand flutterCommand = DummyFlutterCommand(
|
|
commandFunction: () async {
|
|
return const FlutterCommandResult(ExitStatus.warning);
|
|
}
|
|
);
|
|
await flutterCommand.run();
|
|
|
|
verify(usage.sendCommand(
|
|
'dummy',
|
|
parameters: anyNamed('parameters'),
|
|
));
|
|
verify(usage.sendEvent(
|
|
'tool-command-result',
|
|
'dummy',
|
|
label: 'warning',
|
|
parameters: anyNamed('parameters'),
|
|
));
|
|
expect(verify(usage.sendEvent(
|
|
'tool-command-max-rss',
|
|
'dummy',
|
|
label: 'warning',
|
|
value: captureAnyNamed('value'),
|
|
)).captured[0],
|
|
10,
|
|
);
|
|
});
|
|
|
|
testUsingCommandContext('reports command that results in failure', () async {
|
|
// Crash if called a third time which is unexpected.
|
|
mockTimes = <int>[1000, 2000];
|
|
|
|
final DummyFlutterCommand flutterCommand = DummyFlutterCommand(
|
|
commandFunction: () async {
|
|
return const FlutterCommandResult(ExitStatus.fail);
|
|
}
|
|
);
|
|
|
|
try {
|
|
await flutterCommand.run();
|
|
} on ToolExit {
|
|
verify(usage.sendCommand(
|
|
'dummy',
|
|
parameters: anyNamed('parameters'),
|
|
));
|
|
verify(usage.sendEvent(
|
|
'tool-command-result',
|
|
'dummy',
|
|
label: 'fail',
|
|
parameters: anyNamed('parameters'),
|
|
));
|
|
expect(verify(usage.sendEvent(
|
|
'tool-command-max-rss',
|
|
'dummy',
|
|
label: 'fail',
|
|
value: captureAnyNamed('value'),
|
|
)).captured[0],
|
|
10,
|
|
);
|
|
}
|
|
});
|
|
|
|
testUsingCommandContext('reports command that results in error', () async {
|
|
// Crash if called a third time which is unexpected.
|
|
mockTimes = <int>[1000, 2000];
|
|
|
|
final DummyFlutterCommand flutterCommand = DummyFlutterCommand(
|
|
commandFunction: () async {
|
|
throwToolExit('fail');
|
|
return null; // unreachable
|
|
}
|
|
);
|
|
|
|
try {
|
|
await flutterCommand.run();
|
|
fail('Mock should make this fail');
|
|
} on ToolExit {
|
|
verify(usage.sendCommand(
|
|
'dummy',
|
|
parameters: anyNamed('parameters'),
|
|
));
|
|
verify(usage.sendEvent(
|
|
'tool-command-result',
|
|
'dummy',
|
|
label: 'fail',
|
|
parameters: anyNamed('parameters'),
|
|
));
|
|
expect(verify(usage.sendEvent(
|
|
'tool-command-max-rss',
|
|
'dummy',
|
|
label: 'fail',
|
|
value: captureAnyNamed('value'),
|
|
)).captured[0],
|
|
10,
|
|
);
|
|
}
|
|
});
|
|
|
|
group('signals tests', () {
|
|
MockIoProcessSignal mockSignal;
|
|
ProcessSignal signalUnderTest;
|
|
StreamController<io.ProcessSignal> signalController;
|
|
|
|
setUp(() {
|
|
mockSignal = MockIoProcessSignal();
|
|
signalUnderTest = ProcessSignal(mockSignal);
|
|
signalController = StreamController<io.ProcessSignal>();
|
|
when(mockSignal.watch()).thenAnswer((Invocation invocation) => signalController.stream);
|
|
});
|
|
|
|
testUsingContext('reports command that is killed', () async {
|
|
// Crash if called a third time which is unexpected.
|
|
mockTimes = <int>[1000, 2000];
|
|
|
|
final Completer<void> completer = Completer<void>();
|
|
setExitFunctionForTests((int exitCode) {
|
|
expect(exitCode, 0);
|
|
restoreExitFunction();
|
|
completer.complete();
|
|
});
|
|
|
|
final DummyFlutterCommand flutterCommand = DummyFlutterCommand(
|
|
commandFunction: () async {
|
|
final Completer<void> c = Completer<void>();
|
|
await c.future;
|
|
return null; // unreachable
|
|
}
|
|
);
|
|
|
|
unawaited(flutterCommand.run());
|
|
signalController.add(mockSignal);
|
|
await completer.future;
|
|
|
|
verify(usage.sendCommand(
|
|
'dummy',
|
|
parameters: anyNamed('parameters'),
|
|
));
|
|
verify(usage.sendEvent(
|
|
'tool-command-result',
|
|
'dummy',
|
|
label: 'killed',
|
|
parameters: anyNamed('parameters'),
|
|
));
|
|
expect(verify(usage.sendEvent(
|
|
'tool-command-max-rss',
|
|
'dummy',
|
|
label: 'killed',
|
|
value: captureAnyNamed('value'),
|
|
)).captured[0],
|
|
10,
|
|
);
|
|
}, overrides: <Type, Generator>{
|
|
ProcessInfo: () => mockProcessInfo,
|
|
Signals: () => FakeSignals(
|
|
subForSigTerm: signalUnderTest,
|
|
exitSignals: <ProcessSignal>[signalUnderTest],
|
|
),
|
|
SystemClock: () => clock,
|
|
Usage: () => usage,
|
|
});
|
|
});
|
|
|
|
testUsingCommandContext('report execution timing by default', () async {
|
|
// Crash if called a third time which is unexpected.
|
|
mockTimes = <int>[1000, 2000];
|
|
|
|
final DummyFlutterCommand flutterCommand = DummyFlutterCommand();
|
|
await flutterCommand.run();
|
|
verify(clock.now()).called(2);
|
|
|
|
expect(
|
|
verify(usage.sendTiming(
|
|
captureAny, captureAny, captureAny,
|
|
label: captureAnyNamed('label'))).captured,
|
|
<dynamic>[
|
|
'flutter',
|
|
'dummy',
|
|
const Duration(milliseconds: 1000),
|
|
null,
|
|
],
|
|
);
|
|
});
|
|
|
|
testUsingCommandContext('no timing report without usagePath', () async {
|
|
// Crash if called a third time which is unexpected.
|
|
mockTimes = <int>[1000, 2000];
|
|
|
|
final DummyFlutterCommand flutterCommand =
|
|
DummyFlutterCommand(noUsagePath: true);
|
|
await flutterCommand.run();
|
|
verify(clock.now()).called(2);
|
|
verifyNever(usage.sendTiming(
|
|
any, any, any,
|
|
label: anyNamed('label')));
|
|
});
|
|
|
|
testUsingCommandContext('report additional FlutterCommandResult data', () async {
|
|
// Crash if called a third time which is unexpected.
|
|
mockTimes = <int>[1000, 2000];
|
|
|
|
final FlutterCommandResult commandResult = FlutterCommandResult(
|
|
ExitStatus.success,
|
|
// nulls should be cleaned up.
|
|
timingLabelParts: <String> ['blah1', 'blah2', null, 'blah3'],
|
|
endTimeOverride: DateTime.fromMillisecondsSinceEpoch(1500),
|
|
);
|
|
|
|
final DummyFlutterCommand flutterCommand = DummyFlutterCommand(
|
|
commandFunction: () async => commandResult
|
|
);
|
|
await flutterCommand.run();
|
|
verify(clock.now()).called(2);
|
|
expect(
|
|
verify(usage.sendTiming(
|
|
captureAny, captureAny, captureAny,
|
|
label: captureAnyNamed('label'))).captured,
|
|
<dynamic>[
|
|
'flutter',
|
|
'dummy',
|
|
const Duration(milliseconds: 500), // FlutterCommandResult's end time used instead.
|
|
'success-blah1-blah2-blah3',
|
|
],
|
|
);
|
|
});
|
|
|
|
testUsingCommandContext('report failed execution timing too', () async {
|
|
// Crash if called a third time which is unexpected.
|
|
mockTimes = <int>[1000, 2000];
|
|
|
|
final DummyFlutterCommand flutterCommand = DummyFlutterCommand(
|
|
commandFunction: () async {
|
|
throwToolExit('fail');
|
|
return null; // unreachable
|
|
},
|
|
);
|
|
|
|
try {
|
|
await flutterCommand.run();
|
|
fail('Mock should make this fail');
|
|
} on ToolExit {
|
|
// Should have still checked time twice.
|
|
verify(clock.now()).called(2);
|
|
|
|
expect(
|
|
verify(usage.sendTiming(
|
|
captureAny, captureAny, captureAny,
|
|
label: captureAnyNamed('label'))).captured,
|
|
<dynamic>[
|
|
'flutter',
|
|
'dummy',
|
|
const Duration(milliseconds: 1000),
|
|
'fail',
|
|
],
|
|
);
|
|
}
|
|
});
|
|
});
|
|
}
|
|
|
|
|
|
class FakeCommand extends FlutterCommand {
|
|
@override
|
|
String get description => null;
|
|
|
|
@override
|
|
String get name => 'fake';
|
|
|
|
@override
|
|
Future<FlutterCommandResult> runCommand() async {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
class MockVersion extends Mock implements FlutterVersion {}
|
|
class MockProcessInfo extends Mock implements ProcessInfo {}
|
|
class MockIoProcessSignal extends Mock implements io.ProcessSignal {}
|
|
|
|
class FakeSignals implements Signals {
|
|
FakeSignals({
|
|
this.subForSigTerm,
|
|
List<ProcessSignal> exitSignals,
|
|
}) : delegate = Signals(exitSignals: exitSignals);
|
|
|
|
final ProcessSignal subForSigTerm;
|
|
final Signals delegate;
|
|
|
|
@override
|
|
Object addHandler(ProcessSignal signal, SignalHandler handler) {
|
|
if (signal == ProcessSignal.SIGTERM) {
|
|
return delegate.addHandler(subForSigTerm, handler);
|
|
}
|
|
return delegate.addHandler(signal, handler);
|
|
}
|
|
|
|
@override
|
|
Future<bool> removeHandler(ProcessSignal signal, Object token) =>
|
|
delegate.removeHandler(signal, token);
|
|
|
|
@override
|
|
Stream<Object> get errors => delegate.errors;
|
|
}
|