mirror of
https://github.com/flutter/packages.git
synced 2025-05-23 03:36:45 +08:00
10486b0ceb
common.dart is a large-and-growing file containing all shared code, which makes it hard to navigate. To make maintenance easier, this splits the file (and its test file) into separate files for each major component or category.
636 lines
20 KiB
Dart
636 lines
20 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 'package:args/command_runner.dart';
|
|
import 'package:file/file.dart';
|
|
import 'package:file/memory.dart';
|
|
import 'package:flutter_plugin_tools/src/common/core.dart';
|
|
import 'package:flutter_plugin_tools/src/drive_examples_command.dart';
|
|
import 'package:path/path.dart' as p;
|
|
import 'package:platform/platform.dart';
|
|
import 'package:test/test.dart';
|
|
|
|
import 'util.dart';
|
|
|
|
void main() {
|
|
group('test drive_example_command', () {
|
|
late FileSystem fileSystem;
|
|
late Directory packagesDir;
|
|
late CommandRunner<void> runner;
|
|
late RecordingProcessRunner processRunner;
|
|
final String flutterCommand =
|
|
const LocalPlatform().isWindows ? 'flutter.bat' : 'flutter';
|
|
|
|
setUp(() {
|
|
fileSystem = MemoryFileSystem();
|
|
packagesDir = createPackagesDirectory(fileSystem: fileSystem);
|
|
processRunner = RecordingProcessRunner();
|
|
final DriveExamplesCommand command =
|
|
DriveExamplesCommand(packagesDir, processRunner: processRunner);
|
|
|
|
runner = CommandRunner<void>(
|
|
'drive_examples_command', 'Test for drive_example_command');
|
|
runner.addCommand(command);
|
|
});
|
|
|
|
test('driving under folder "test"', () async {
|
|
final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
|
|
withExtraFiles: <List<String>>[
|
|
<String>['example', 'test_driver', 'plugin_test.dart'],
|
|
<String>['example', 'test', 'plugin.dart'],
|
|
],
|
|
isIosPlugin: true,
|
|
isAndroidPlugin: true);
|
|
|
|
final Directory pluginExampleDirectory =
|
|
pluginDirectory.childDirectory('example');
|
|
|
|
createFakePubspec(pluginExampleDirectory, isFlutter: true);
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'drive-examples',
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
orderedEquals(<String>[
|
|
'\n==========\nChecking plugin...',
|
|
'\n\n',
|
|
'All driver tests successful!',
|
|
]),
|
|
);
|
|
|
|
final String deviceTestPath = p.join('test', 'plugin.dart');
|
|
final String driverTestPath = p.join('test_driver', 'plugin_test.dart');
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
flutterCommand,
|
|
<String>[
|
|
'drive',
|
|
'--driver',
|
|
driverTestPath,
|
|
'--target',
|
|
deviceTestPath
|
|
],
|
|
pluginExampleDirectory.path),
|
|
]));
|
|
});
|
|
|
|
test('driving under folder "test_driver"', () async {
|
|
final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
|
|
withExtraFiles: <List<String>>[
|
|
<String>['example', 'test_driver', 'plugin_test.dart'],
|
|
<String>['example', 'test_driver', 'plugin.dart'],
|
|
],
|
|
isAndroidPlugin: true,
|
|
isIosPlugin: true);
|
|
|
|
final Directory pluginExampleDirectory =
|
|
pluginDirectory.childDirectory('example');
|
|
|
|
createFakePubspec(pluginExampleDirectory, isFlutter: true);
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'drive-examples',
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
orderedEquals(<String>[
|
|
'\n==========\nChecking plugin...',
|
|
'\n\n',
|
|
'All driver tests successful!',
|
|
]),
|
|
);
|
|
|
|
final String deviceTestPath = p.join('test_driver', 'plugin.dart');
|
|
final String driverTestPath = p.join('test_driver', 'plugin_test.dart');
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
flutterCommand,
|
|
<String>[
|
|
'drive',
|
|
'--driver',
|
|
driverTestPath,
|
|
'--target',
|
|
deviceTestPath
|
|
],
|
|
pluginExampleDirectory.path),
|
|
]));
|
|
});
|
|
|
|
test('driving under folder "test_driver" when test files are missing"',
|
|
() async {
|
|
final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
|
|
withExtraFiles: <List<String>>[
|
|
<String>['example', 'test_driver', 'plugin_test.dart'],
|
|
],
|
|
isAndroidPlugin: true,
|
|
isIosPlugin: true);
|
|
|
|
final Directory pluginExampleDirectory =
|
|
pluginDirectory.childDirectory('example');
|
|
|
|
createFakePubspec(pluginExampleDirectory, isFlutter: true);
|
|
|
|
await expectLater(
|
|
() => runCapturingPrint(runner, <String>['drive-examples']),
|
|
throwsA(const TypeMatcher<ToolExit>()));
|
|
});
|
|
|
|
test('a plugin without any integration test files is reported as an error',
|
|
() async {
|
|
final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
|
|
withExtraFiles: <List<String>>[
|
|
<String>['example', 'lib', 'main.dart'],
|
|
],
|
|
isAndroidPlugin: true,
|
|
isIosPlugin: true);
|
|
|
|
final Directory pluginExampleDirectory =
|
|
pluginDirectory.childDirectory('example');
|
|
|
|
createFakePubspec(pluginExampleDirectory, isFlutter: true);
|
|
|
|
await expectLater(
|
|
() => runCapturingPrint(runner, <String>['drive-examples']),
|
|
throwsA(const TypeMatcher<ToolExit>()));
|
|
});
|
|
|
|
test(
|
|
'driving under folder "test_driver" when targets are under "integration_test"',
|
|
() async {
|
|
final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
|
|
withExtraFiles: <List<String>>[
|
|
<String>['example', 'test_driver', 'integration_test.dart'],
|
|
<String>['example', 'integration_test', 'bar_test.dart'],
|
|
<String>['example', 'integration_test', 'foo_test.dart'],
|
|
<String>['example', 'integration_test', 'ignore_me.dart'],
|
|
],
|
|
isAndroidPlugin: true,
|
|
isIosPlugin: true);
|
|
|
|
final Directory pluginExampleDirectory =
|
|
pluginDirectory.childDirectory('example');
|
|
|
|
createFakePubspec(pluginExampleDirectory, isFlutter: true);
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'drive-examples',
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
orderedEquals(<String>[
|
|
'\n==========\nChecking plugin...',
|
|
'\n\n',
|
|
'All driver tests successful!',
|
|
]),
|
|
);
|
|
|
|
final String driverTestPath =
|
|
p.join('test_driver', 'integration_test.dart');
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
flutterCommand,
|
|
<String>[
|
|
'drive',
|
|
'--driver',
|
|
driverTestPath,
|
|
'--target',
|
|
p.join('integration_test', 'bar_test.dart'),
|
|
],
|
|
pluginExampleDirectory.path),
|
|
ProcessCall(
|
|
flutterCommand,
|
|
<String>[
|
|
'drive',
|
|
'--driver',
|
|
driverTestPath,
|
|
'--target',
|
|
p.join('integration_test', 'foo_test.dart'),
|
|
],
|
|
pluginExampleDirectory.path),
|
|
]));
|
|
});
|
|
|
|
test('driving when plugin does not support Linux is a no-op', () async {
|
|
final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
|
|
withExtraFiles: <List<String>>[
|
|
<String>['example', 'test_driver', 'plugin_test.dart'],
|
|
<String>['example', 'test_driver', 'plugin.dart'],
|
|
],
|
|
isMacOsPlugin: false);
|
|
|
|
final Directory pluginExampleDirectory =
|
|
pluginDirectory.childDirectory('example');
|
|
|
|
createFakePubspec(pluginExampleDirectory, isFlutter: true);
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'drive-examples',
|
|
'--linux',
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
orderedEquals(<String>[
|
|
'\n==========\nChecking plugin...',
|
|
'Not supported for the target platform; skipping.',
|
|
'\n\n',
|
|
'All driver tests successful!',
|
|
]),
|
|
);
|
|
|
|
// Output should be empty since running drive-examples --linux on a non-Linux
|
|
// plugin is a no-op.
|
|
expect(processRunner.recordedCalls, <ProcessCall>[]);
|
|
});
|
|
|
|
test('driving on a Linux plugin', () async {
|
|
final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
|
|
withExtraFiles: <List<String>>[
|
|
<String>['example', 'test_driver', 'plugin_test.dart'],
|
|
<String>['example', 'test_driver', 'plugin.dart'],
|
|
],
|
|
isLinuxPlugin: true);
|
|
|
|
final Directory pluginExampleDirectory =
|
|
pluginDirectory.childDirectory('example');
|
|
|
|
createFakePubspec(pluginExampleDirectory, isFlutter: true);
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'drive-examples',
|
|
'--linux',
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
orderedEquals(<String>[
|
|
'\n==========\nChecking plugin...',
|
|
'\n\n',
|
|
'All driver tests successful!',
|
|
]),
|
|
);
|
|
|
|
final String deviceTestPath = p.join('test_driver', 'plugin.dart');
|
|
final String driverTestPath = p.join('test_driver', 'plugin_test.dart');
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
flutterCommand,
|
|
<String>[
|
|
'drive',
|
|
'-d',
|
|
'linux',
|
|
'--driver',
|
|
driverTestPath,
|
|
'--target',
|
|
deviceTestPath
|
|
],
|
|
pluginExampleDirectory.path),
|
|
]));
|
|
});
|
|
|
|
test('driving when plugin does not suppport macOS is a no-op', () async {
|
|
final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
|
|
withExtraFiles: <List<String>>[
|
|
<String>['example', 'test_driver', 'plugin_test.dart'],
|
|
<String>['example', 'test_driver', 'plugin.dart'],
|
|
]);
|
|
|
|
final Directory pluginExampleDirectory =
|
|
pluginDirectory.childDirectory('example');
|
|
|
|
createFakePubspec(pluginExampleDirectory, isFlutter: true);
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'drive-examples',
|
|
'--macos',
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
orderedEquals(<String>[
|
|
'\n==========\nChecking plugin...',
|
|
'Not supported for the target platform; skipping.',
|
|
'\n\n',
|
|
'All driver tests successful!',
|
|
]),
|
|
);
|
|
|
|
// Output should be empty since running drive-examples --macos with no macos
|
|
// implementation is a no-op.
|
|
expect(processRunner.recordedCalls, <ProcessCall>[]);
|
|
});
|
|
test('driving on a macOS plugin', () async {
|
|
final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
|
|
withExtraFiles: <List<String>>[
|
|
<String>['example', 'test_driver', 'plugin_test.dart'],
|
|
<String>['example', 'test_driver', 'plugin.dart'],
|
|
<String>['example', 'macos', 'macos.swift'],
|
|
],
|
|
isMacOsPlugin: true);
|
|
|
|
final Directory pluginExampleDirectory =
|
|
pluginDirectory.childDirectory('example');
|
|
|
|
createFakePubspec(pluginExampleDirectory, isFlutter: true);
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'drive-examples',
|
|
'--macos',
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
orderedEquals(<String>[
|
|
'\n==========\nChecking plugin...',
|
|
'\n\n',
|
|
'All driver tests successful!',
|
|
]),
|
|
);
|
|
|
|
final String deviceTestPath = p.join('test_driver', 'plugin.dart');
|
|
final String driverTestPath = p.join('test_driver', 'plugin_test.dart');
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
flutterCommand,
|
|
<String>[
|
|
'drive',
|
|
'-d',
|
|
'macos',
|
|
'--driver',
|
|
driverTestPath,
|
|
'--target',
|
|
deviceTestPath
|
|
],
|
|
pluginExampleDirectory.path),
|
|
]));
|
|
});
|
|
|
|
test('driving when plugin does not suppport web is a no-op', () async {
|
|
final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
|
|
withExtraFiles: <List<String>>[
|
|
<String>['example', 'test_driver', 'plugin_test.dart'],
|
|
<String>['example', 'test_driver', 'plugin.dart'],
|
|
],
|
|
isWebPlugin: false);
|
|
|
|
final Directory pluginExampleDirectory =
|
|
pluginDirectory.childDirectory('example');
|
|
|
|
createFakePubspec(pluginExampleDirectory, isFlutter: true);
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'drive-examples',
|
|
'--web',
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
orderedEquals(<String>[
|
|
'\n==========\nChecking plugin...',
|
|
'Not supported for the target platform; skipping.',
|
|
'\n\n',
|
|
'All driver tests successful!',
|
|
]),
|
|
);
|
|
|
|
// Output should be empty since running drive-examples --web on a non-web
|
|
// plugin is a no-op.
|
|
expect(processRunner.recordedCalls, <ProcessCall>[]);
|
|
});
|
|
|
|
test('driving a web plugin', () async {
|
|
final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
|
|
withExtraFiles: <List<String>>[
|
|
<String>['example', 'test_driver', 'plugin_test.dart'],
|
|
<String>['example', 'test_driver', 'plugin.dart'],
|
|
],
|
|
isWebPlugin: true);
|
|
|
|
final Directory pluginExampleDirectory =
|
|
pluginDirectory.childDirectory('example');
|
|
|
|
createFakePubspec(pluginExampleDirectory, isFlutter: true);
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'drive-examples',
|
|
'--web',
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
orderedEquals(<String>[
|
|
'\n==========\nChecking plugin...',
|
|
'\n\n',
|
|
'All driver tests successful!',
|
|
]),
|
|
);
|
|
|
|
final String deviceTestPath = p.join('test_driver', 'plugin.dart');
|
|
final String driverTestPath = p.join('test_driver', 'plugin_test.dart');
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
flutterCommand,
|
|
<String>[
|
|
'drive',
|
|
'-d',
|
|
'web-server',
|
|
'--web-port=7357',
|
|
'--browser-name=chrome',
|
|
'--driver',
|
|
driverTestPath,
|
|
'--target',
|
|
deviceTestPath
|
|
],
|
|
pluginExampleDirectory.path),
|
|
]));
|
|
});
|
|
|
|
test('driving when plugin does not suppport Windows is a no-op', () async {
|
|
final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
|
|
withExtraFiles: <List<String>>[
|
|
<String>['example', 'test_driver', 'plugin_test.dart'],
|
|
<String>['example', 'test_driver', 'plugin.dart'],
|
|
],
|
|
isWindowsPlugin: false);
|
|
|
|
final Directory pluginExampleDirectory =
|
|
pluginDirectory.childDirectory('example');
|
|
|
|
createFakePubspec(pluginExampleDirectory, isFlutter: true);
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'drive-examples',
|
|
'--windows',
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
orderedEquals(<String>[
|
|
'\n==========\nChecking plugin...',
|
|
'Not supported for the target platform; skipping.',
|
|
'\n\n',
|
|
'All driver tests successful!',
|
|
]),
|
|
);
|
|
|
|
// Output should be empty since running drive-examples --windows on a
|
|
// non-Windows plugin is a no-op.
|
|
expect(processRunner.recordedCalls, <ProcessCall>[]);
|
|
});
|
|
|
|
test('driving on a Windows plugin', () async {
|
|
final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
|
|
withExtraFiles: <List<String>>[
|
|
<String>['example', 'test_driver', 'plugin_test.dart'],
|
|
<String>['example', 'test_driver', 'plugin.dart'],
|
|
],
|
|
isWindowsPlugin: true);
|
|
|
|
final Directory pluginExampleDirectory =
|
|
pluginDirectory.childDirectory('example');
|
|
|
|
createFakePubspec(pluginExampleDirectory, isFlutter: true);
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'drive-examples',
|
|
'--windows',
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
orderedEquals(<String>[
|
|
'\n==========\nChecking plugin...',
|
|
'\n\n',
|
|
'All driver tests successful!',
|
|
]),
|
|
);
|
|
|
|
final String deviceTestPath = p.join('test_driver', 'plugin.dart');
|
|
final String driverTestPath = p.join('test_driver', 'plugin_test.dart');
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
flutterCommand,
|
|
<String>[
|
|
'drive',
|
|
'-d',
|
|
'windows',
|
|
'--driver',
|
|
driverTestPath,
|
|
'--target',
|
|
deviceTestPath
|
|
],
|
|
pluginExampleDirectory.path),
|
|
]));
|
|
});
|
|
|
|
test('driving when plugin does not support mobile is no-op', () async {
|
|
final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
|
|
withExtraFiles: <List<String>>[
|
|
<String>['example', 'test_driver', 'plugin_test.dart'],
|
|
<String>['example', 'test_driver', 'plugin.dart'],
|
|
],
|
|
isMacOsPlugin: true);
|
|
|
|
final Directory pluginExampleDirectory =
|
|
pluginDirectory.childDirectory('example');
|
|
|
|
createFakePubspec(pluginExampleDirectory, isFlutter: true);
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'drive-examples',
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
orderedEquals(<String>[
|
|
'\n==========\nChecking plugin...',
|
|
'Not supported for the target platform; skipping.',
|
|
'\n\n',
|
|
'All driver tests successful!',
|
|
]),
|
|
);
|
|
|
|
// Output should be empty since running drive-examples --macos with no macos
|
|
// implementation is a no-op.
|
|
expect(processRunner.recordedCalls, <ProcessCall>[]);
|
|
});
|
|
|
|
test('platform interface plugins are silently skipped', () async {
|
|
createFakePlugin('aplugin_platform_interface', packagesDir);
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'drive-examples',
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
orderedEquals(<String>[
|
|
'\n\n',
|
|
'All driver tests successful!',
|
|
]),
|
|
);
|
|
|
|
// Output should be empty since running drive-examples --macos with no macos
|
|
// implementation is a no-op.
|
|
expect(processRunner.recordedCalls, <ProcessCall>[]);
|
|
});
|
|
|
|
test('enable-experiment flag', () async {
|
|
final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
|
|
withExtraFiles: <List<String>>[
|
|
<String>['example', 'test_driver', 'plugin_test.dart'],
|
|
<String>['example', 'test', 'plugin.dart'],
|
|
],
|
|
isIosPlugin: true,
|
|
isAndroidPlugin: true);
|
|
|
|
final Directory pluginExampleDirectory =
|
|
pluginDirectory.childDirectory('example');
|
|
|
|
createFakePubspec(pluginExampleDirectory, isFlutter: true);
|
|
|
|
await runCapturingPrint(runner, <String>[
|
|
'drive-examples',
|
|
'--enable-experiment=exp1',
|
|
]);
|
|
|
|
final String deviceTestPath = p.join('test', 'plugin.dart');
|
|
final String driverTestPath = p.join('test_driver', 'plugin_test.dart');
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
flutterCommand,
|
|
<String>[
|
|
'drive',
|
|
'--enable-experiment=exp1',
|
|
'--driver',
|
|
driverTestPath,
|
|
'--target',
|
|
deviceTestPath
|
|
],
|
|
pluginExampleDirectory.path),
|
|
]));
|
|
});
|
|
});
|
|
}
|