Skip to content

F
Front-End
Unverified Commit eae05c7d authored by Ian Hickson's avatar Ian Hickson Committed by GitHub
Browse files
Options

Test framework for analyze.dart (#44772) 

* Prepare analyze.dart for testing.

* Reorder the file for easier understanding

* Add a test for analyze.dart

* Fix review comments
parent afe4830a
Hide whitespace changes
Inline Side-by-side
Showing with 430 additions and 353 deletions
dev/bots/analyze.dart
View file @ eae05c7d
...@@ -4,7 +4,10 @@ ...@@ -4,7 +4,10 @@
import 'dart:async'; import 'dart:async';
import 'dart:convert'; import 'dart:convert';
import 'dart:io'; import 'dart:core' as core_internals show print;
import 'dart:core' hide print;
import 'dart:io' as io_internals show exit;
import 'dart:io' hide exit;
import 'package:path/path.dart' as path; import 'package:path/path.dart' as path;
import 'package:meta/meta.dart'; import 'package:meta/meta.dart';
...@@ -17,34 +20,59 @@ final String dart = path.join(flutterRoot, 'bin', 'cache', 'dart-sdk', 'bin', Pl ...@@ -17,34 +20,59 @@ final String dart = path.join(flutterRoot, 'bin', 'cache', 'dart-sdk', 'bin', Pl
final String pub = path.join(flutterRoot, 'bin', 'cache', 'dart-sdk', 'bin', Platform.isWindows ? 'pub.bat' : 'pub'); final String pub = path.join(flutterRoot, 'bin', 'cache', 'dart-sdk', 'bin', Platform.isWindows ? 'pub.bat' : 'pub');
final String pubCache = path.join(flutterRoot, '.pub-cache'); final String pubCache = path.join(flutterRoot, '.pub-cache');
class ExitException implements Exception {
ExitException(this.exitCode);
final int exitCode;
void apply() {
io_internals.exit(exitCode);
}
}
// We actually reimplement exit() so that it uses exceptions rather
// than truly immediately terminating the application, so that we can
// test the exit code in unit tests (see test/analyze_test.dart).
void exit(int exitCode) {
throw ExitException(exitCode);
}
typedef PrintCallback = void Function(Object line);
// Allow print() to be overridden, for tests.
PrintCallback print = core_internals.print;
/// When you call this, you can pass additional arguments to pass custom /// When you call this, you can pass additional arguments to pass custom
/// arguments to flutter analyze. For example, you might want to call this /// arguments to flutter analyze. For example, you might want to call this
/// script with the parameter --dart-sdk to use custom dart sdk. /// script with the parameter --dart-sdk to use custom dart sdk.
/// ///
/// For example: /// For example:
/// bin/cache/dart-sdk/bin/dart dev/bots/analyze.dart --dart-sdk=/tmp/dart-sdk /// bin/cache/dart-sdk/bin/dart dev/bots/analyze.dart --dart-sdk=/tmp/dart-sdk
Future<void> main(List<String> args) async { Future<void> main(List<String> arguments) async {
try {
await run(arguments);
} on ExitException catch (error) {
error.apply();
}
print('${bold}DONE: Analysis successful.$reset');
}
Future<void> run(List<String> arguments) async {
bool assertsEnabled = false; bool assertsEnabled = false;
assert(() { assertsEnabled = true; return true; }()); assert(() { assertsEnabled = true; return true; }());
if (!assertsEnabled) { if (!assertsEnabled) {
print('The analyze.dart script must be run with --enable-asserts.'); print('The analyze.dart script must be run with --enable-asserts.');
exit(1); exit(1);
} }
await _verifyNoMissingLicense(flutterRoot);
await _verifyNoTestImports(flutterRoot); await verifyNoMissingLicense(flutterRoot);
await _verifyNoTestPackageImports(flutterRoot); await verifyNoTestImports(flutterRoot);
await _verifyGeneratedPluginRegistrants(flutterRoot); await verifyNoTestPackageImports(flutterRoot);
await _verifyNoBadImportsInFlutter(flutterRoot); await verifyGeneratedPluginRegistrants(flutterRoot);
await _verifyNoBadImportsInFlutterTools(flutterRoot); await verifyNoBadImportsInFlutter(flutterRoot);
await _verifyInternationalizations(); await verifyNoBadImportsInFlutterTools(flutterRoot);
await verifyInternationalizations();
{ await verifyNoTrailingSpaces();
// Analyze all the Dart code in the repo.
await _runFlutterAnalyze(flutterRoot, options: <String>[
'--flutter-repo',
...args,
]);
}
// Ensure that all package dependencies are in sync. // Ensure that all package dependencies are in sync.
await runCommand(flutter, <String>['update-packages', '--verify-only'], await runCommand(flutter, <String>['update-packages', '--verify-only'],
...@@ -57,18 +85,20 @@ Future<void> main(List<String> args) async { ...@@ -57,18 +85,20 @@ Future<void> main(List<String> args) async {
workingDirectory: flutterRoot, workingDirectory: flutterRoot,
); );
// Analyze all the Dart code in the repo.
await _runFlutterAnalyze(flutterRoot, options: <String>[
'--flutter-repo',
...arguments,
]);
// Try with the --watch analyzer, to make sure it returns success also. // Try with the --watch analyzer, to make sure it returns success also.
// The --benchmark argument exits after one run. // The --benchmark argument exits after one run.
{ await _runFlutterAnalyze(flutterRoot, options: <String>[
await _runFlutterAnalyze(flutterRoot, options: <String>[ '--flutter-repo',
'--flutter-repo', '--watch',
'--watch', '--benchmark',
'--benchmark', ...arguments,
...args, ]);
]);
}
await _checkForTrailingSpaces();
// Try analysis against a big version of the gallery; generate into a temporary directory. // Try analysis against a big version of the gallery; generate into a temporary directory.
final Directory outDir = Directory.systemTemp.createTempSync('flutter_mega_gallery.'); final Directory outDir = Directory.systemTemp.createTempSync('flutter_mega_gallery.');
...@@ -86,195 +116,70 @@ Future<void> main(List<String> args) async { ...@@ -86,195 +116,70 @@ Future<void> main(List<String> args) async {
await _runFlutterAnalyze(outDir.path, options: <String>[ await _runFlutterAnalyze(outDir.path, options: <String>[
'--watch', '--watch',
'--benchmark', '--benchmark',
...args, ...arguments,
]); ]);
} }
} finally { } finally {
outDir.deleteSync(recursive: true); outDir.deleteSync(recursive: true);
} }
print('${bold}DONE: Analysis successful.$reset');
} }
Future<void> _verifyInternationalizations() async { Future<void> verifyNoMissingLicense(String workingDirectory) async {
final EvalResult materialGenResult = await _evalCommand( final List<String> errors = <String>[];
dart, for (FileSystemEntity entity in Directory(path.join(workingDirectory, 'packages'))
<String>[ .listSync(recursive: true)
path.join('dev', 'tools', 'localization', 'gen_localizations.dart'), .where((FileSystemEntity entity) => entity is File && path.extension(entity.path) == '.dart')) {
'--material', final File file = entity;
], bool hasLicense = false;
workingDirectory: flutterRoot, final List<String> lines = file.readAsLinesSync();
); if (lines.isNotEmpty)
final EvalResult cupertinoGenResult = await _evalCommand( hasLicense = lines.first.startsWith(RegExp(r'// Copyright \d{4}'));
dart, if (!hasLicense)
<String>[ errors.add(file.path);
path.join('dev', 'tools', 'localization', 'gen_localizations.dart'),
'--cupertino',
],
workingDirectory: flutterRoot,
);
final String materialLocalizationsFile = path.join('packages', 'flutter_localizations', 'lib', 'src', 'l10n', 'generated_material_localizations.dart');
final String cupertinoLocalizationsFile = path.join('packages', 'flutter_localizations', 'lib', 'src', 'l10n', 'generated_cupertino_localizations.dart');
final String expectedMaterialResult = await File(materialLocalizationsFile).readAsString();
final String expectedCupertinoResult = await File(cupertinoLocalizationsFile).readAsString();
if (materialGenResult.stdout.trim() != expectedMaterialResult.trim()) {
stderr
..writeln('<<<<<<< $materialLocalizationsFile')
..writeln(expectedMaterialResult.trim())
..writeln('=======')
..writeln(materialGenResult.stdout.trim())
..writeln('>>>>>>> gen_localizations')
..writeln('The contents of $materialLocalizationsFile are different from that produced by gen_localizations.')
..writeln()
..writeln('Did you forget to run gen_localizations.dart after updating a .arb file?');
exit(1);
} }
if (cupertinoGenResult.stdout.trim() != expectedCupertinoResult.trim()) { // Fail if any errors
stderr if (errors.isNotEmpty) {
..writeln('<<<<<<< $cupertinoLocalizationsFile') print('$redLine');
..writeln(expectedCupertinoResult.trim()) final String s = errors.length == 1 ? '' : 's';
..writeln('=======') print('${bold}License headers cannot be found at the beginning of the following file$s.$reset\n');
..writeln(cupertinoGenResult.stdout.trim()) print(errors.join('\n'));
..writeln('>>>>>>> gen_localizations') print('$redLine\n');
..writeln('The contents of $cupertinoLocalizationsFile are different from that produced by gen_localizations.')
..writeln()
..writeln('Did you forget to run gen_localizations.dart after updating a .arb file?');
exit(1); exit(1);
} }
} }
Future<String> _getCommitRange() async { final RegExp _testImportPattern = RegExp(r'''import (['"])([^'"]+_test\.dart)\1''');
// Using --fork-point is more conservative, and will result in the correct const Set<String> _exemptTestImports = <String>{
// fork point, but when running locally, it may return nothing. Git is 'package:flutter_test/flutter_test.dart',
// guaranteed to return a (reasonable, but maybe not optimal) result when not 'hit_test.dart',
// using --fork-point, so we fall back to that if we can't get a definitive 'package:test_api/src/backend/live_test.dart',
// fork point. See "git merge-base" documentation for more info. };
EvalResult result = await _evalCommand(
'git',
<String>['merge-base', '--fork-point', 'FETCH_HEAD', 'HEAD'],
workingDirectory: flutterRoot,
allowNonZeroExit: true,
);
if (result.exitCode != 0) {
result = await _evalCommand(
'git',
<String>['merge-base', 'FETCH_HEAD', 'HEAD'],
workingDirectory: flutterRoot,
);
}
return result.stdout.trim();
}
Future<void> _checkForTrailingSpaces() async { Future<void> verifyNoTestImports(String workingDirectory) async {
if (!Platform.isWindows) { final List<String> errors = <String>[];
final String commitRange = Platform.environment.containsKey('TEST_COMMIT_RANGE') assert("// foo\nimport 'binding_test.dart' as binding;\n'".contains(_testImportPattern));
? Platform.environment['TEST_COMMIT_RANGE'] for (FileSystemEntity entity in Directory(path.join(workingDirectory, 'packages'))
: await _getCommitRange(); .listSync(recursive: true)
final List<String> fileTypes = <String>[ .where((FileSystemEntity entity) => entity is File && path.extension(entity.path) == '.dart')) {
'*.dart', '*.cxx', '*.cpp', '*.cc', '*.c', '*.C', '*.h', '*.java', '*.mm', '*.m', '*.yml', final File file = entity;
]; for (String line in file.readAsLinesSync()) {
final EvalResult changedFilesResult = await _evalCommand( final Match match = _testImportPattern.firstMatch(line);
'git', <String>['diff', '-U0', '--no-color', '--name-only', commitRange, '--', ...fileTypes], if (match != null && !_exemptTestImports.contains(match.group(2)))
workingDirectory: flutterRoot, errors.add(file.path);
);
if (changedFilesResult.stdout == null || changedFilesResult.stdout.trim().isEmpty) {
print('No files found that need to be checked for trailing whitespace.');
return;
}
// Only include files that actually exist, so that we don't try and grep for
// nonexistent files, which can occur when files are deleted or moved.
final List<String> changedFiles = changedFilesResult.stdout.split('\n').where((String filename) {
return File(filename).existsSync();
}).toList();
if (changedFiles.isNotEmpty) {
await runCommand('grep',
<String>[
'--line-number',
'--extended-regexp',
r'[[:blank:]]$',
...changedFiles,
],
workingDirectory: flutterRoot,
failureMessage: '${red}Detected trailing whitespace in the file[s] listed above.$reset\nPlease remove them from the offending line[s].',
expectNonZeroExit: true, // Just means a non-zero exit code is expected.
expectedExitCode: 1, // Indicates that zero lines were found.
);
} }
} }
} // Fail if any errors
if (errors.isNotEmpty) {
class EvalResult { print('$redLine');
EvalResult({ final String s = errors.length == 1 ? '' : 's';
this.stdout, print('${bold}The following file$s import a test directly. Test utilities should be in their own file.$reset\n');
this.stderr, print(errors.join('\n'));
this.exitCode = 0, print('$redLine\n');
});
final String stdout;
final String stderr;
final int exitCode;
}
Future<EvalResult> _evalCommand(String executable, List<String> arguments, {
@required String workingDirectory,
Map<String, String> environment,
bool skip = false,
bool allowNonZeroExit = false,
}) async {
final String commandDescription = '${path.relative(executable, from: workingDirectory)} ${arguments.join(' ')}';
final String relativeWorkingDir = path.relative(workingDirectory);
if (skip) {
printProgress('SKIPPING', relativeWorkingDir, commandDescription);
return null;
}
printProgress('RUNNING', relativeWorkingDir, commandDescription);
final Stopwatch time = Stopwatch()..start();
final Process process = await Process.start(executable, arguments,
workingDirectory: workingDirectory,
environment: environment,
);
final Future<List<List<int>>> savedStdout = process.stdout.toList();
final Future<List<List<int>>> savedStderr = process.stderr.toList();
final int exitCode = await process.exitCode;
final EvalResult result = EvalResult(
stdout: utf8.decode((await savedStdout).expand<int>((List<int> ints) => ints).toList()),
stderr: utf8.decode((await savedStderr).expand<int>((List<int> ints) => ints).toList()),
exitCode: exitCode,
);
print('$clock ELAPSED TIME: $bold${prettyPrintDuration(time.elapsed)}$reset for $commandDescription in $relativeWorkingDir');
if (exitCode != 0 && !allowNonZeroExit) {
stderr.write(result.stderr);
print(
'$redLine\n'
'${bold}ERROR:$red Last command exited with $exitCode.$reset\n'
'${bold}Command:$red $commandDescription$reset\n'
'${bold}Relative working directory:$red $relativeWorkingDir$reset\n'
'$redLine'
);
exit(1); exit(1);
} }
return result;
}
Future<void> _runFlutterAnalyze(String workingDirectory, {
List<String> options = const <String>[],
}) {
return runCommand(
flutter,
<String>['analyze', '--dartdocs', ...options],
workingDirectory: workingDirectory,
);
} }
Future<void> _verifyNoTestPackageImports(String workingDirectory) async { Future<void> verifyNoTestPackageImports(String workingDirectory) async {
// TODO(ianh): Remove this whole test once https://github.com/dart-lang/matcher/issues/98 is fixed. // TODO(ianh): Remove this whole test once https://github.com/dart-lang/matcher/issues/98 is fixed.
final List<String> shims = <String>[]; final List<String> shims = <String>[];
final List<String> errors = Directory(workingDirectory) final List<String> errors = Directory(workingDirectory)
...@@ -353,37 +258,82 @@ Future<void> _verifyNoTestPackageImports(String workingDirectory) async { ...@@ -353,37 +258,82 @@ Future<void> _verifyNoTestPackageImports(String workingDirectory) async {
} }
} }
Future<void> _verifyNoBadImportsInFlutter(String workingDirectory) async { Future<void> verifyGeneratedPluginRegistrants(String flutterRoot) async {
final List<String> errors = <String>[]; final Directory flutterRootDir = Directory(flutterRoot);
final String libPath = path.join(workingDirectory, 'packages', 'flutter', 'lib');
final String srcPath = path.join(workingDirectory, 'packages', 'flutter', 'lib', 'src'); final Map<String, List<File>> packageToRegistrants = <String, List<File>>{};
// Verify there's one libPath/*.dart for each srcPath/*/.
final List<String> packages = Directory(libPath).listSync() for (FileSystemEntity entity in flutterRootDir.listSync(recursive: true)) {
.where((FileSystemEntity entity) => entity is File && path.extension(entity.path) == '.dart') if (entity is! File)
.map<String>((FileSystemEntity entity) => path.basenameWithoutExtension(entity.path)) continue;
.toList()..sort(); if (_isGeneratedPluginRegistrant(entity)) {
final List<String> directories = Directory(srcPath).listSync() final String package = _getPackageFor(entity, flutterRootDir);
.whereType<Directory>() final List<File> registrants = packageToRegistrants.putIfAbsent(package, () => <File>[]);
.map<String>((Directory entity) => path.basename(entity.path)) registrants.add(entity);
.toList()..sort(); }
if (!_matches<String>(packages, directories)) { }
errors.add(
'flutter/lib/*.dart does not match flutter/lib/src/*/:\n' final Set<String> outOfDate = <String>{};
'These are the exported packages:\n' +
packages.map<String>((String path) => ' lib/$path.dart').join('\n') + for (String package in packageToRegistrants.keys) {
'These are the directories:\n' + final Map<File, String> fileToContent = <File, String>{};
directories.map<String>((String path) => ' lib/src/$path/').join('\n') for (File f in packageToRegistrants[package]) {
); fileToContent[f] = f.readAsStringSync();
} }
// Verify that the imports are well-ordered. await runCommand(flutter, <String>['inject-plugins'],
final Map<String, Set<String>> dependencyMap = <String, Set<String>>{}; workingDirectory: package,
for (String directory in directories) { outputMode: OutputMode.discard,
dependencyMap[directory] = _findFlutterDependencies(path.join(srcPath, directory), errors, checkForMeta: directory != 'foundation'); );
} for (File registrant in fileToContent.keys) {
assert(dependencyMap['material'].contains('widgets') && if (registrant.readAsStringSync() != fileToContent[registrant]) {
dependencyMap['widgets'].contains('rendering') && outOfDate.add(registrant.path);
dependencyMap['rendering'].contains('painting')); // to make sure we're convinced _findFlutterDependencies is finding some }
for (String package in dependencyMap.keys) { }
}
if (outOfDate.isNotEmpty) {
print('$redLine');
print('${bold}The following GeneratedPluginRegistrants are out of date:$reset');
for (String registrant in outOfDate) {
print(' - $registrant');
}
print('\nRun "flutter inject-plugins" in the package that\'s out of date.');
print('$redLine');
exit(1);
}
}
Future<void> verifyNoBadImportsInFlutter(String workingDirectory) async {
final List<String> errors = <String>[];
final String libPath = path.join(workingDirectory, 'packages', 'flutter', 'lib');
final String srcPath = path.join(workingDirectory, 'packages', 'flutter', 'lib', 'src');
// Verify there's one libPath/*.dart for each srcPath/*/.
final List<String> packages = Directory(libPath).listSync()
.where((FileSystemEntity entity) => entity is File && path.extension(entity.path) == '.dart')
.map<String>((FileSystemEntity entity) => path.basenameWithoutExtension(entity.path))
.toList()..sort();
final List<String> directories = Directory(srcPath).listSync()
.whereType<Directory>()
.map<String>((Directory entity) => path.basename(entity.path))
.toList()..sort();
if (!_listEquals<String>(packages, directories)) {
errors.add(
'flutter/lib/*.dart does not match flutter/lib/src/*/:\n'
'These are the exported packages:\n' +
packages.map<String>((String path) => ' lib/$path.dart').join('\n') +
'These are the directories:\n' +
directories.map<String>((String path) => ' lib/src/$path/').join('\n')
);
}
// Verify that the imports are well-ordered.
final Map<String, Set<String>> dependencyMap = <String, Set<String>>{};
for (String directory in directories) {
dependencyMap[directory] = _findFlutterDependencies(path.join(srcPath, directory), errors, checkForMeta: directory != 'foundation');
}
assert(dependencyMap['material'].contains('widgets') &&
dependencyMap['widgets'].contains('rendering') &&
dependencyMap['rendering'].contains('painting')); // to make sure we're convinced _findFlutterDependencies is finding some
for (String package in dependencyMap.keys) {
if (dependencyMap[package].contains(package)) { if (dependencyMap[package].contains(package)) {
errors.add( errors.add(
'One of the files in the $yellow$package$reset package imports that package recursively.' 'One of the files in the $yellow$package$reset package imports that package recursively.'
...@@ -413,7 +363,121 @@ Future<void> _verifyNoBadImportsInFlutter(String workingDirectory) async { ...@@ -413,7 +363,121 @@ Future<void> _verifyNoBadImportsInFlutter(String workingDirectory) async {
} }
} }
bool _matches<T>(List<T> a, List<T> b) { Future<void> verifyNoBadImportsInFlutterTools(String workingDirectory) async {
final List<String> errors = <String>[];
for (FileSystemEntity entity in Directory(path.join(workingDirectory, 'packages', 'flutter_tools', 'lib'))
.listSync(recursive: true)
.where((FileSystemEntity entity) => entity is File && path.extension(entity.path) == '.dart')) {
final File file = entity;
if (file.readAsStringSync().contains('package:flutter_tools/')) {
errors.add('$yellow${file.path}$reset imports flutter_tools.');
}
}
// Fail if any errors
if (errors.isNotEmpty) {
print('$redLine');
if (errors.length == 1) {
print('${bold}An error was detected when looking at import dependencies within the flutter_tools package:$reset\n');
} else {
print('${bold}Multiple errors were detected when looking at import dependencies within the flutter_tools package:$reset\n');
}
print(errors.join('\n\n'));
print('$redLine\n');
exit(1);
}
}
Future<void> verifyInternationalizations() async {
final EvalResult materialGenResult = await _evalCommand(
dart,
<String>[
path.join('dev', 'tools', 'localization', 'gen_localizations.dart'),
'--material',
],
workingDirectory: flutterRoot,
);
final EvalResult cupertinoGenResult = await _evalCommand(
dart,
<String>[
path.join('dev', 'tools', 'localization', 'gen_localizations.dart'),
'--cupertino',
],
workingDirectory: flutterRoot,
);
final String materialLocalizationsFile = path.join('packages', 'flutter_localizations', 'lib', 'src', 'l10n', 'generated_material_localizations.dart');
final String cupertinoLocalizationsFile = path.join('packages', 'flutter_localizations', 'lib', 'src', 'l10n', 'generated_cupertino_localizations.dart');
final String expectedMaterialResult = await File(materialLocalizationsFile).readAsString();
final String expectedCupertinoResult = await File(cupertinoLocalizationsFile).readAsString();
if (materialGenResult.stdout.trim() != expectedMaterialResult.trim()) {
stderr
..writeln('<<<<<<< $materialLocalizationsFile')
..writeln(expectedMaterialResult.trim())
..writeln('=======')
..writeln(materialGenResult.stdout.trim())
..writeln('>>>>>>> gen_localizations')
..writeln('The contents of $materialLocalizationsFile are different from that produced by gen_localizations.')
..writeln()
..writeln('Did you forget to run gen_localizations.dart after updating a .arb file?');
exit(1);
}
if (cupertinoGenResult.stdout.trim() != expectedCupertinoResult.trim()) {
stderr
..writeln('<<<<<<< $cupertinoLocalizationsFile')
..writeln(expectedCupertinoResult.trim())
..writeln('=======')
..writeln(cupertinoGenResult.stdout.trim())
..writeln('>>>>>>> gen_localizations')
..writeln('The contents of $cupertinoLocalizationsFile are different from that produced by gen_localizations.')
..writeln()
..writeln('Did you forget to run gen_localizations.dart after updating a .arb file?');
exit(1);
}
}
Future<void> verifyNoTrailingSpaces() async {
if (!Platform.isWindows) {
final String commitRange = Platform.environment.containsKey('TEST_COMMIT_RANGE')
? Platform.environment['TEST_COMMIT_RANGE']
: await _getCommitRange();
final List<String> fileTypes = <String>[
'*.dart', '*.cxx', '*.cpp', '*.cc', '*.c', '*.C', '*.h', '*.java', '*.mm', '*.m', '*.yml',
];
final EvalResult changedFilesResult = await _evalCommand(
'git', <String>['diff', '-U0', '--no-color', '--name-only', commitRange, '--', ...fileTypes],
workingDirectory: flutterRoot,
);
if (changedFilesResult.stdout == null || changedFilesResult.stdout.trim().isEmpty) {
print('No files found that need to be checked for trailing whitespace.');
return;
}
// Only include files that actually exist, so that we don't try and grep for
// nonexistent files, which can occur when files are deleted or moved.
final List<String> changedFiles = changedFilesResult.stdout.split('\n').where((String filename) {
return File(filename).existsSync();
}).toList();
if (changedFiles.isNotEmpty) {
await runCommand('grep',
<String>[
'--line-number',
'--extended-regexp',
r'[[:blank:]]$',
...changedFiles,
],
workingDirectory: flutterRoot,
failureMessage: '${red}Detected trailing whitespace in the file[s] listed above.$reset\nPlease remove them from the offending line[s].',
expectNonZeroExit: true, // Just means a non-zero exit code is expected.
expectedExitCode: 1, // Indicates that zero lines were found.
);
}
}
}
// UTILITY FUNCTIONS
bool _listEquals<T>(List<T> a, List<T> b) {
assert(a != null); assert(a != null);
assert(b != null); assert(b != null);
if (a.length != b.length) if (a.length != b.length)
...@@ -425,6 +489,96 @@ bool _matches<T>(List<T> a, List<T> b) { ...@@ -425,6 +489,96 @@ bool _matches<T>(List<T> a, List<T> b) {
return true; return true;
} }
Future<String> _getCommitRange() async {
// Using --fork-point is more conservative, and will result in the correct
// fork point, but when running locally, it may return nothing. Git is
// guaranteed to return a (reasonable, but maybe not optimal) result when not
// using --fork-point, so we fall back to that if we can't get a definitive
// fork point. See "git merge-base" documentation for more info.
EvalResult result = await _evalCommand(
'git',
<String>['merge-base', '--fork-point', 'FETCH_HEAD', 'HEAD'],
workingDirectory: flutterRoot,
allowNonZeroExit: true,
);
if (result.exitCode != 0) {
result = await _evalCommand(
'git',
<String>['merge-base', 'FETCH_HEAD', 'HEAD'],
workingDirectory: flutterRoot,
);
}
return result.stdout.trim();
}
class EvalResult {
EvalResult({
this.stdout,
this.stderr,
this.exitCode = 0,
});
final String stdout;
final String stderr;
final int exitCode;
}
Future<EvalResult> _evalCommand(String executable, List<String> arguments, {
@required String workingDirectory,
Map<String, String> environment,
bool skip = false,
bool allowNonZeroExit = false,
}) async {
final String commandDescription = '${path.relative(executable, from: workingDirectory)} ${arguments.join(' ')}';
final String relativeWorkingDir = path.relative(workingDirectory);
if (skip) {
printProgress('SKIPPING', relativeWorkingDir, commandDescription);
return null;
}
printProgress('RUNNING', relativeWorkingDir, commandDescription);
final Stopwatch time = Stopwatch()..start();
final Process process = await Process.start(executable, arguments,
workingDirectory: workingDirectory,
environment: environment,
);
final Future<List<List<int>>> savedStdout = process.stdout.toList();
final Future<List<List<int>>> savedStderr = process.stderr.toList();
final int exitCode = await process.exitCode;
final EvalResult result = EvalResult(
stdout: utf8.decode((await savedStdout).expand<int>((List<int> ints) => ints).toList()),
stderr: utf8.decode((await savedStderr).expand<int>((List<int> ints) => ints).toList()),
exitCode: exitCode,
);
print('$clock ELAPSED TIME: $bold${prettyPrintDuration(time.elapsed)}$reset for $commandDescription in $relativeWorkingDir');
if (exitCode != 0 && !allowNonZeroExit) {
stderr.write(result.stderr);
print(
'$redLine\n'
'${bold}ERROR:$red Last command exited with $exitCode.$reset\n'
'${bold}Command:$red $commandDescription$reset\n'
'${bold}Relative working directory:$red $relativeWorkingDir$reset\n'
'$redLine'
);
exit(1);
}
return result;
}
Future<void> _runFlutterAnalyze(String workingDirectory, {
List<String> options = const <String>[],
}) {
return runCommand(
flutter,
<String>['analyze', '--dartdocs', ...options],
workingDirectory: workingDirectory,
);
}
final RegExp _importPattern = RegExp(r'''^\s*import (['"])package:flutter/([^.]+)\.dart\1'''); final RegExp _importPattern = RegExp(r'''^\s*import (['"])package:flutter/([^.]+)\.dart\1''');
final RegExp _importMetaPattern = RegExp(r'''^\s*import (['"])package:meta/meta\.dart\1'''); final RegExp _importMetaPattern = RegExp(r'''^\s*import (['"])package:meta/meta\.dart\1''');
...@@ -483,130 +637,6 @@ List<T> _deepSearch<T>(Map<T, Set<T>> map, T start, [ Set<T> seen ]) { ...@@ -483,130 +637,6 @@ List<T> _deepSearch<T>(Map<T, Set<T>> map, T start, [ Set<T> seen ]) {
return null; return null;
} }
Future<void> _verifyNoBadImportsInFlutterTools(String workingDirectory) async {
final List<String> errors = <String>[];
for (FileSystemEntity entity in Directory(path.join(workingDirectory, 'packages', 'flutter_tools', 'lib'))
.listSync(recursive: true)
.where((FileSystemEntity entity) => entity is File && path.extension(entity.path) == '.dart')) {
final File file = entity;
if (file.readAsStringSync().contains('package:flutter_tools/')) {
errors.add('$yellow${file.path}$reset imports flutter_tools.');
}
}
// Fail if any errors
if (errors.isNotEmpty) {
print('$redLine');
if (errors.length == 1) {
print('${bold}An error was detected when looking at import dependencies within the flutter_tools package:$reset\n');
} else {
print('${bold}Multiple errors were detected when looking at import dependencies within the flutter_tools package:$reset\n');
}
print(errors.join('\n\n'));
print('$redLine\n');
exit(1);
}
}
Future<void> _verifyNoMissingLicense(String workingDirectory) async {
final List<String> errors = <String>[];
for (FileSystemEntity entity in Directory(path.join(workingDirectory, 'packages'))
.listSync(recursive: true)
.where((FileSystemEntity entity) => entity is File && path.extension(entity.path) == '.dart')) {
final File file = entity;
bool hasLicense = false;
final List<String> lines = file.readAsLinesSync();
if (lines.isNotEmpty)
hasLicense = lines.first.startsWith(RegExp(r'// Copyright \d{4}'));
if (!hasLicense)
errors.add(file.path);
}
// Fail if any errors
if (errors.isNotEmpty) {
print('$redLine');
final String s = errors.length == 1 ? '' : 's';
print('${bold}License headers cannot be found at the beginning of the following file$s.$reset\n');
print(errors.join('\n'));
print('$redLine\n');
exit(1);
}
}
final RegExp _testImportPattern = RegExp(r'''import (['"])([^'"]+_test\.dart)\1''');
const Set<String> _exemptTestImports = <String>{
'package:flutter_test/flutter_test.dart',
'hit_test.dart',
'package:test_api/src/backend/live_test.dart',
};
Future<void> _verifyNoTestImports(String workingDirectory) async {
final List<String> errors = <String>[];
assert("// foo\nimport 'binding_test.dart' as binding;\n'".contains(_testImportPattern));
for (FileSystemEntity entity in Directory(path.join(workingDirectory, 'packages'))
.listSync(recursive: true)
.where((FileSystemEntity entity) => entity is File && path.extension(entity.path) == '.dart')) {
final File file = entity;
for (String line in file.readAsLinesSync()) {
final Match match = _testImportPattern.firstMatch(line);
if (match != null && !_exemptTestImports.contains(match.group(2)))
errors.add(file.path);
}
}
// Fail if any errors
if (errors.isNotEmpty) {
print('$redLine');
final String s = errors.length == 1 ? '' : 's';
print('${bold}The following file$s import a test directly. Test utilities should be in their own file.$reset\n');
print(errors.join('\n'));
print('$redLine\n');
exit(1);
}
}
Future<void> _verifyGeneratedPluginRegistrants(String flutterRoot) async {
final Directory flutterRootDir = Directory(flutterRoot);
final Map<String, List<File>> packageToRegistrants = <String, List<File>>{};
for (FileSystemEntity entity in flutterRootDir.listSync(recursive: true)) {
if (entity is! File)
continue;
if (_isGeneratedPluginRegistrant(entity)) {
final String package = _getPackageFor(entity, flutterRootDir);
final List<File> registrants = packageToRegistrants.putIfAbsent(package, () => <File>[]);
registrants.add(entity);
}
}
final Set<String> outOfDate = <String>{};
for (String package in packageToRegistrants.keys) {
final Map<File, String> fileToContent = <File, String>{};
for (File f in packageToRegistrants[package]) {
fileToContent[f] = f.readAsStringSync();
}
await runCommand(flutter, <String>['inject-plugins'],
workingDirectory: package,
outputMode: OutputMode.discard,
);
for (File registrant in fileToContent.keys) {
if (registrant.readAsStringSync() != fileToContent[registrant]) {
outOfDate.add(registrant.path);
}
}
}
if (outOfDate.isNotEmpty) {
print('$redLine');
print('${bold}The following GeneratedPluginRegistrants are out of date:$reset');
for (String registrant in outOfDate) {
print(' - $registrant');
}
print('\nRun "flutter inject-plugins" in the package that\'s out of date.');
print('$redLine');
exit(1);
}
}
String _getPackageFor(File entity, Directory flutterRootDir) { String _getPackageFor(File entity, Directory flutterRootDir) {
for (Directory dir = entity.parent; dir != flutterRootDir; dir = dir.parent) { for (Directory dir = entity.parent; dir != flutterRootDir; dir = dir.parent) {
if (File(path.join(dir.path, 'pubspec.yaml')).existsSync()) { if (File(path.join(dir.path, 'pubspec.yaml')).existsSync()) {
......
dev/bots/test/analyze-test-input/packages/foo/foo.dart 0 → 100644
View file @ eae05c7d
// THIS FILE HAS NO LICENSE.
// IT IS PART OF A TEST FOR MISSING LICENSES.
dev/bots/test/analyze_test.dart 0 → 100644
View file @ eae05c7d
// Copyright 2017 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.
import 'dart:io';
import 'package:path/path.dart' as path;
import '../analyze.dart';
import 'common.dart';
typedef AsyncVoidCallback = Future<void> Function();
Future<String> capture(AsyncVoidCallback callback, { int exitCode = 0 }) async {
final StringBuffer buffer = StringBuffer();
final PrintCallback oldPrint = print;
try {
print = (Object line) {
buffer.writeln(line);
};
try {
await callback();
expect(exitCode, 0);
} on ExitException catch (error) {
expect(error.exitCode, exitCode);
}
} finally {
print = oldPrint;
}
return buffer.toString();
}
void main() {
test('analyze.dart - verifyNoMissingLicense', () async {
final String result = await capture(() => verifyNoMissingLicense(path.join('test', 'analyze-test-input')), exitCode: 1);
expect(result, '''
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
License headers cannot be found at the beginning of the following file.
test/analyze-test-input/packages/foo/foo.dart
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
'''.replaceAll('/', Platform.isWindows ? '\\' : '/'));
});
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

HIAST - GitLab