flutter/packages
1
0
Fork 0
mirror of https://github.com/flutter/packages.git synced 2025-05-25 16:58:01 +08:00
Code Issues Packages Projects Releases Wiki Activity

[flutter_plugin_tool] Add support for running Windows unit tests (#4276)

Browse Source 
Implements support for `--windows` in `native-test`, for unit tests only. The structure of the new code has most of the new functionality in a generic utility for running GoogleTest test binaries, so that it can be trivially extended to Linux support in a follow-up once the Linux test PoC has landed.

This runs the recently-added `url_launcher_windows` unit test. However, it's not yet run in CI since it needs LUCI bringup; that will be done one this support is in place.

Requires new logic to check if a plugin contains native code, and some new test utility plumbing to generate plugins whose pubspecs indicate that they only contain Dart code to test it, to allow filtering filtering out the FFI-based Windows plugins.

Part of flutter/flutter#82445
This commit is contained in:
stuartmorgan
2021-08-30 14:51:58 -04:00
committed by GitHub
parent d3a20df4dc
commit c7e7f65108
9 changed files with 510 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
script/tool/lib/src/native_test_command.dart
View File

@ -40,6 +40,7 @@ class NativeTestCommand extends PackageLoopingCommand {
argParser.addFlag(kPlatformAndroid, help: 'Runs Android tests');
argParser.addFlag(kPlatformIos, help: 'Runs iOS tests');
argParser.addFlag(kPlatformMacos, help: 'Runs macOS tests');
argParser.addFlag(kPlatformWindows, help: 'Runs Windows tests');
// By default, both unit tests and integration tests are run, but provide
// flags to disable one or the other.
@ -80,6 +81,7 @@ this command.
kPlatformAndroid: _PlatformDetails('Android', _testAndroid),
kPlatformIos: _PlatformDetails('iOS', _testIos),
kPlatformMacos: _PlatformDetails('macOS', _testMacOS),
kPlatformWindows: _PlatformDetails('Windows', _testWindows),
};
_requestedPlatforms = _platforms.keys
.where((String platform) => getBoolArg(platform))
@ -96,6 +98,11 @@ this command.
throw ToolExit(exitInvalidArguments);
}
if (getBoolArg(kPlatformWindows) && getBoolArg(_integrationTestFlag)) {
logWarning('This command currently only supports unit tests for Windows. '
'See https://github.com/flutter/flutter/issues/70233.');
}
// iOS-specific run-level state.
if (_requestedPlatforms.contains('ios')) {
String destination = getStringArg(_iosDestinationFlag);
@ -119,16 +126,20 @@ this command.
Future<PackageResult> runForPackage(RepositoryPackage package) async {
final List<String> testPlatforms = <String>[];
for (final String platform in _requestedPlatforms) {
if (pluginSupportsPlatform(platform, package,
if (!pluginSupportsPlatform(platform, package,
requiredMode: PlatformSupport.inline)) {
testPlatforms.add(platform);
} else {
print('No implementation for ${_platforms[platform]!.label}.');
continue;
}
if (!pluginHasNativeCodeForPlatform(platform, package)) {
print('No native code for ${_platforms[platform]!.label}.');
continue;
}
testPlatforms.add(platform);
}
if (testPlatforms.isEmpty) {
return PackageResult.skip('Not implemented for target platform(s).');
return PackageResult.skip('Nothing to test for target platform(s).');
}
final _TestMode mode = _TestMode(
@ -228,6 +239,8 @@ this command.
final bool hasIntegrationTests =
exampleHasNativeIntegrationTests(example);
// TODO(stuartmorgan): Make !hasUnitTests fatal. See
// https://github.com/flutter/flutter/issues/85469
if (mode.unit && !hasUnitTests) {
_printNoExampleTestsMessage(example, 'Android unit');
}
@ -335,6 +348,9 @@ this command.
for (final RepositoryPackage example in plugin.getExamples()) {
final String exampleName = example.displayName;
// TODO(stuartmorgan): Always check for RunnerTests, and make it fatal if
// no examples have it. See
// https://github.com/flutter/flutter/issues/85469
if (testTarget != null) {
final Directory project = example.directory
.childDirectory(platform.toLowerCase())
@ -387,6 +403,71 @@ this command.
return _PlatformResult(overallResult);
}
Future<_PlatformResult> _testWindows(
RepositoryPackage plugin, _TestMode mode) async {
if (mode.integrationOnly) {
return _PlatformResult(RunState.skipped);
}
bool isTestBinary(File file) {
return file.basename.endsWith('_test.exe') ||
file.basename.endsWith('_tests.exe');
}
return _runGoogleTestTests(plugin,
buildDirectoryName: 'windows', isTestBinary: isTestBinary);
}
/// Finds every file in the [buildDirectoryName] subdirectory of [plugin]'s
/// build directory for which [isTestBinary] is true, and runs all of them,
/// returning the overall result.
///
/// The binaries are assumed to be Google Test test binaries, thus returning
/// zero for success and non-zero for failure.
Future<_PlatformResult> _runGoogleTestTests(
RepositoryPackage plugin, {
required String buildDirectoryName,
required bool Function(File) isTestBinary,
}) async {
final List<File> testBinaries = <File>[];
for (final RepositoryPackage example in plugin.getExamples()) {
final Directory buildDir = example.directory
.childDirectory('build')
.childDirectory(buildDirectoryName);
if (!buildDir.existsSync()) {
continue;
}
testBinaries.addAll(buildDir
.listSync(recursive: true)
.whereType<File>()
.where(isTestBinary)
.where((File file) {
// Only run the debug build of the unit tests, to avoid running the
// same tests multiple times.
final List<String> components = path.split(file.path);
return components.contains('debug') || components.contains('Debug');
}));
}
if (testBinaries.isEmpty) {
final String binaryExtension = platform.isWindows ? '.exe' : '';
printError(
'No test binaries found. At least one *_test(s)$binaryExtension '
'binary should be built by the example(s)');
return _PlatformResult(RunState.failed,
error: 'No $buildDirectoryName unit tests found');
}
bool passing = true;
for (final File test in testBinaries) {
print('Running ${test.basename}...');
final int exitCode =
await processRunner.runAndStream(test.path, <String>[]);
passing &= exitCode == 0;
}
return _PlatformResult(passing ? RunState.succeeded : RunState.failed);
}
/// Prints a standard format message indicating that [platform] tests for
/// [plugin]'s [example] are about to be run.
void _printRunningExampleTestsMessage(