mirror of
https://github.com/flutter/packages.git
synced 2025-06-07 11:59:30 +08:00
74cf0287f9
The mock process runner used in most of the tests had poor handling of
stdout/stderr:
- By default it would return the `List<int>` output from the mock
process, which was never correct since the parent process runner
interface always sets encodings, thus the `dynamic` should always be
of type `String`
- The process for setting output on a `MockProcess` was awkward, since
it was based on a `Stream<Lint<int>>`, even though in every case what
we actually want to do is just set the full output to a string.
- A hack was at some point added (presumably due to the above issues)
to bypass that flow at the process runner level, and instead return a
`String` set there. That meant there were two ways of setting output
(one of which that only worked for one of the ways of running
processes)
- That hack wasn't updated when the ability to return multiple mock
processes instead of a single global mock process was added, so the
API was even more confusing, and there was no way to set different
output for different processes.
This changes the test APIs so that:
- `MockProcess` takes stdout and stderr as strings, and internally
manages converting them to a `Stream<List<int>>`.
- `RecordingProcessRunner` correctly decodes and returns the output
streams when constructing a process result.
It also removes the resultStdout and resultStderr hacks, as well as the
legacy `processToReturn` API, and converts all uses to the new
structure, which is both simpler to use, and clearly associates output
with specific processes.
294 lines
9.2 KiB
Dart
294 lines
9.2 KiB
Dart
// Copyright 2013 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:io' as io;
|
|
|
|
import 'package:args/command_runner.dart';
|
|
import 'package:file/file.dart';
|
|
import 'package:file/memory.dart';
|
|
import 'package:flutter_plugin_tools/src/analyze_command.dart';
|
|
import 'package:flutter_plugin_tools/src/common/core.dart';
|
|
import 'package:test/test.dart';
|
|
|
|
import 'mocks.dart';
|
|
import 'util.dart';
|
|
|
|
void main() {
|
|
late FileSystem fileSystem;
|
|
late MockPlatform mockPlatform;
|
|
late Directory packagesDir;
|
|
late RecordingProcessRunner processRunner;
|
|
late CommandRunner<void> runner;
|
|
|
|
setUp(() {
|
|
fileSystem = MemoryFileSystem();
|
|
mockPlatform = MockPlatform();
|
|
packagesDir = createPackagesDirectory(fileSystem: fileSystem);
|
|
processRunner = RecordingProcessRunner();
|
|
final AnalyzeCommand analyzeCommand = AnalyzeCommand(
|
|
packagesDir,
|
|
processRunner: processRunner,
|
|
platform: mockPlatform,
|
|
);
|
|
|
|
runner = CommandRunner<void>('analyze_command', 'Test for analyze_command');
|
|
runner.addCommand(analyzeCommand);
|
|
});
|
|
|
|
test('analyzes all packages', () async {
|
|
final Directory plugin1Dir = createFakePlugin('a', packagesDir);
|
|
final Directory plugin2Dir = createFakePlugin('b', packagesDir);
|
|
|
|
await runCapturingPrint(runner, <String>['analyze']);
|
|
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
'flutter', const <String>['packages', 'get'], plugin1Dir.path),
|
|
ProcessCall(
|
|
'flutter', const <String>['packages', 'get'], plugin2Dir.path),
|
|
ProcessCall('dart', const <String>['analyze', '--fatal-infos'],
|
|
plugin1Dir.path),
|
|
ProcessCall('dart', const <String>['analyze', '--fatal-infos'],
|
|
plugin2Dir.path),
|
|
]));
|
|
});
|
|
|
|
test('skips flutter pub get for examples', () async {
|
|
final Directory plugin1Dir = createFakePlugin('a', packagesDir);
|
|
|
|
await runCapturingPrint(runner, <String>['analyze']);
|
|
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
'flutter', const <String>['packages', 'get'], plugin1Dir.path),
|
|
ProcessCall('dart', const <String>['analyze', '--fatal-infos'],
|
|
plugin1Dir.path),
|
|
]));
|
|
});
|
|
|
|
test('don\'t elide a non-contained example package', () async {
|
|
final Directory plugin1Dir = createFakePlugin('a', packagesDir);
|
|
final Directory plugin2Dir = createFakePlugin('example', packagesDir);
|
|
|
|
await runCapturingPrint(runner, <String>['analyze']);
|
|
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
'flutter', const <String>['packages', 'get'], plugin1Dir.path),
|
|
ProcessCall(
|
|
'flutter', const <String>['packages', 'get'], plugin2Dir.path),
|
|
ProcessCall('dart', const <String>['analyze', '--fatal-infos'],
|
|
plugin1Dir.path),
|
|
ProcessCall('dart', const <String>['analyze', '--fatal-infos'],
|
|
plugin2Dir.path),
|
|
]));
|
|
});
|
|
|
|
test('uses a separate analysis sdk', () async {
|
|
final Directory pluginDir = createFakePlugin('a', packagesDir);
|
|
|
|
await runCapturingPrint(
|
|
runner, <String>['analyze', '--analysis-sdk', 'foo/bar/baz']);
|
|
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
'flutter',
|
|
const <String>['packages', 'get'],
|
|
pluginDir.path,
|
|
),
|
|
ProcessCall(
|
|
'foo/bar/baz/bin/dart',
|
|
const <String>['analyze', '--fatal-infos'],
|
|
pluginDir.path,
|
|
),
|
|
]),
|
|
);
|
|
});
|
|
|
|
group('verifies analysis settings', () {
|
|
test('fails analysis_options.yaml', () async {
|
|
createFakePlugin('foo', packagesDir,
|
|
extraFiles: <String>['analysis_options.yaml']);
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(
|
|
runner, <String>['analyze'], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains(
|
|
'Found an extra analysis_options.yaml at /packages/foo/analysis_options.yaml'),
|
|
contains(' foo:\n'
|
|
' Unexpected local analysis options'),
|
|
]),
|
|
);
|
|
});
|
|
|
|
test('fails .analysis_options', () async {
|
|
createFakePlugin('foo', packagesDir,
|
|
extraFiles: <String>['.analysis_options']);
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(
|
|
runner, <String>['analyze'], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains(
|
|
'Found an extra analysis_options.yaml at /packages/foo/.analysis_options'),
|
|
contains(' foo:\n'
|
|
' Unexpected local analysis options'),
|
|
]),
|
|
);
|
|
});
|
|
|
|
test('takes an allow list', () async {
|
|
final Directory pluginDir = createFakePlugin('foo', packagesDir,
|
|
extraFiles: <String>['analysis_options.yaml']);
|
|
|
|
await runCapturingPrint(
|
|
runner, <String>['analyze', '--custom-analysis', 'foo']);
|
|
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
'flutter', const <String>['packages', 'get'], pluginDir.path),
|
|
ProcessCall('dart', const <String>['analyze', '--fatal-infos'],
|
|
pluginDir.path),
|
|
]));
|
|
});
|
|
|
|
test('takes an allow config file', () async {
|
|
final Directory pluginDir = createFakePlugin('foo', packagesDir,
|
|
extraFiles: <String>['analysis_options.yaml']);
|
|
final File allowFile = packagesDir.childFile('custom.yaml');
|
|
allowFile.writeAsStringSync('- foo');
|
|
|
|
await runCapturingPrint(
|
|
runner, <String>['analyze', '--custom-analysis', allowFile.path]);
|
|
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
'flutter', const <String>['packages', 'get'], pluginDir.path),
|
|
ProcessCall('dart', const <String>['analyze', '--fatal-infos'],
|
|
pluginDir.path),
|
|
]));
|
|
});
|
|
|
|
// See: https://github.com/flutter/flutter/issues/78994
|
|
test('takes an empty allow list', () async {
|
|
createFakePlugin('foo', packagesDir,
|
|
extraFiles: <String>['analysis_options.yaml']);
|
|
|
|
await expectLater(
|
|
() => runCapturingPrint(
|
|
runner, <String>['analyze', '--custom-analysis', '']),
|
|
throwsA(isA<ToolExit>()));
|
|
});
|
|
});
|
|
|
|
test('fails if "packages get" fails', () async {
|
|
createFakePlugin('foo', packagesDir);
|
|
|
|
processRunner.mockProcessesForExecutable['flutter'] = <io.Process>[
|
|
MockProcess(exitCode: 1) // flutter packages get
|
|
];
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(
|
|
runner, <String>['analyze'], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains('Unable to get dependencies'),
|
|
]),
|
|
);
|
|
});
|
|
|
|
test('fails if "analyze" fails', () async {
|
|
createFakePlugin('foo', packagesDir);
|
|
|
|
processRunner.mockProcessesForExecutable['dart'] = <io.Process>[
|
|
MockProcess(exitCode: 1) // dart analyze
|
|
];
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(
|
|
runner, <String>['analyze'], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains('The following packages had errors:'),
|
|
contains(' foo'),
|
|
]),
|
|
);
|
|
});
|
|
|
|
// Ensure that the command used to analyze flutter/plugins in the Dart repo:
|
|
// https://github.com/dart-lang/sdk/blob/master/tools/bots/flutter/analyze_flutter_plugins.sh
|
|
// continues to work.
|
|
//
|
|
// DO NOT remove or modify this test without a coordination plan in place to
|
|
// modify the script above, as it is run from source, but out-of-repo.
|
|
// Contact stuartmorgan or devoncarew for assistance.
|
|
test('Dart repo analyze command works', () async {
|
|
final Directory pluginDir = createFakePlugin('foo', packagesDir,
|
|
extraFiles: <String>['analysis_options.yaml']);
|
|
final File allowFile = packagesDir.childFile('custom.yaml');
|
|
allowFile.writeAsStringSync('- foo');
|
|
|
|
await runCapturingPrint(runner, <String>[
|
|
// DO NOT change this call; see comment above.
|
|
'analyze',
|
|
'--analysis-sdk',
|
|
'foo/bar/baz',
|
|
'--custom-analysis',
|
|
allowFile.path
|
|
]);
|
|
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
'flutter',
|
|
const <String>['packages', 'get'],
|
|
pluginDir.path,
|
|
),
|
|
ProcessCall(
|
|
'foo/bar/baz/bin/dart',
|
|
const <String>['analyze', '--fatal-infos'],
|
|
pluginDir.path,
|
|
),
|
|
]),
|
|
);
|
|
});
|
|
}
|