mirror of
https://github.com/flutter/packages.git
synced 2025-08-23 10:25:45 +08:00
8c287e99d6
Consolidates the code to find all changed file paths into the `PackageLoopingCommand` class that is the base of almost all of the repo tooling commands. This in a preparatory PR for a future change to allow each command to define a list of files or file patterns that definitively *don't* affect that test, so that CI can be smarter about what tests to run (e.g., not running expensive integration tests for README changes). A side effect of this change is that tests of almost all commands now need a mock `GitDir` instance. This would add a lot of copy/pasted boilerplate to the test setup, and there is already too much of that, so instead this refactors common test setup: - Creating a memory file system - Populating it with a packages directory - Creating a RecordingProcessRunner to mock out process calls - Creating a mock GitDir that forwards to a RecordingProcessRunner into a helper method (using records and destructuring to easily return multiple values). While some tests don't need all of these steps, those that don't can easily ignore parts of it, and it will make it much easier to update tests in the future if they need them, and it makes the setup much more consistent which makes it easier to reason about test setup in general. Prep for https://github.com/flutter/flutter/issues/136394
412 lines
17 KiB
Dart
412 lines
17 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:flutter_plugin_tools/src/common/core.dart';
|
|
import 'package:flutter_plugin_tools/src/repo_package_info_check_command.dart';
|
|
import 'package:git/git.dart';
|
|
import 'package:test/test.dart';
|
|
|
|
import 'util.dart';
|
|
|
|
void main() {
|
|
late CommandRunner<void> runner;
|
|
late Directory root;
|
|
late Directory packagesDir;
|
|
|
|
setUp(() {
|
|
final GitDir gitDir;
|
|
(:packagesDir, processRunner: _, gitProcessRunner: _, :gitDir) =
|
|
configureBaseCommandMocks();
|
|
root = packagesDir.fileSystem.currentDirectory;
|
|
|
|
final RepoPackageInfoCheckCommand command = RepoPackageInfoCheckCommand(
|
|
packagesDir,
|
|
gitDir: gitDir,
|
|
);
|
|
runner = CommandRunner<void>(
|
|
'dependabot_test', 'Test for $RepoPackageInfoCheckCommand');
|
|
runner.addCommand(command);
|
|
});
|
|
|
|
String readmeTableHeader() {
|
|
return '''
|
|
| Package | Pub | Points | Popularity | Issues | Pull requests |
|
|
|---------|-----|--------|------------|--------|---------------|
|
|
''';
|
|
}
|
|
|
|
void writeCodeOwners(List<RepositoryPackage> ownedPackages) {
|
|
final List<String> subpaths = ownedPackages
|
|
.map((RepositoryPackage p) => p.isFederated
|
|
? <String>[p.directory.parent.basename, p.directory.basename]
|
|
.join('/')
|
|
: p.directory.basename)
|
|
.toList();
|
|
root.childFile('CODEOWNERS').writeAsStringSync('''
|
|
${subpaths.map((String subpath) => 'packages/$subpath/** @someone').join('\n')}
|
|
''');
|
|
}
|
|
|
|
String readmeTableEntry(String packageName) {
|
|
final String encodedTag = Uri.encodeComponent('p: $packageName');
|
|
return '| [$packageName](./packages/$packageName/) | '
|
|
'[](https://pub.dev/packages/$packageName) | '
|
|
'[](https://pub.dev/packages/$packageName/score) | '
|
|
'[](https://pub.dev/packages/$packageName/score) | '
|
|
'[](https://github.com/flutter/flutter/labels/$encodedTag) | '
|
|
'[](https://github.com/flutter/packages/labels/$encodedTag) |';
|
|
}
|
|
|
|
test('passes for correct README coverage', () async {
|
|
final List<RepositoryPackage> packages = <RepositoryPackage>[
|
|
createFakePackage('a_package', packagesDir),
|
|
];
|
|
|
|
root.childFile('README.md').writeAsStringSync('''
|
|
${readmeTableHeader()}
|
|
${readmeTableEntry('a_package')}
|
|
''');
|
|
writeCodeOwners(packages);
|
|
|
|
final List<String> output =
|
|
await runCapturingPrint(runner, <String>['repo-package-info-check']);
|
|
|
|
expect(output,
|
|
containsAllInOrder(<Matcher>[contains('Ran for 1 package(s)')]));
|
|
});
|
|
|
|
test('passes for federated plugins with only app-facing package listed',
|
|
() async {
|
|
const String pluginName = 'foo';
|
|
final Directory pluginDir = packagesDir.childDirectory(pluginName);
|
|
final List<RepositoryPackage> packages = <RepositoryPackage>[
|
|
createFakePlugin(pluginName, pluginDir),
|
|
createFakePlugin('${pluginName}_platform_interface', pluginDir),
|
|
createFakePlugin('${pluginName}_android', pluginDir),
|
|
createFakePlugin('${pluginName}_ios', pluginDir),
|
|
];
|
|
|
|
root.childFile('README.md').writeAsStringSync('''
|
|
${readmeTableHeader()}
|
|
${readmeTableEntry(pluginName)}
|
|
''');
|
|
writeCodeOwners(packages);
|
|
|
|
final List<String> output =
|
|
await runCapturingPrint(runner, <String>['repo-package-info-check']);
|
|
|
|
expect(output,
|
|
containsAllInOrder(<Matcher>[contains('Ran for 4 package(s)')]));
|
|
});
|
|
|
|
test('fails for unexpected README table entry', () async {
|
|
final List<RepositoryPackage> packages = <RepositoryPackage>[
|
|
createFakePackage('a_package', packagesDir),
|
|
];
|
|
|
|
root.childFile('README.md').writeAsStringSync('''
|
|
${readmeTableHeader()}
|
|
${readmeTableEntry('another_package')}
|
|
''');
|
|
writeCodeOwners(packages);
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(
|
|
runner, <String>['repo-package-info-check'], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains('Unknown package "another_package" in root README.md table'),
|
|
]));
|
|
});
|
|
|
|
test('fails for missing README table entry', () async {
|
|
final List<RepositoryPackage> packages = <RepositoryPackage>[
|
|
createFakePackage('a_package', packagesDir),
|
|
createFakePackage('another_package', packagesDir),
|
|
];
|
|
|
|
root.childFile('README.md').writeAsStringSync('''
|
|
${readmeTableHeader()}
|
|
${readmeTableEntry('another_package')}
|
|
''');
|
|
writeCodeOwners(packages);
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(
|
|
runner, <String>['repo-package-info-check'], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains('Missing repo root README.md table entry'),
|
|
contains('a_package:\n'
|
|
' Missing repo root README.md table entry')
|
|
]));
|
|
});
|
|
|
|
test('fails for unexpected format in README table entry', () async {
|
|
const String packageName = 'a_package';
|
|
final String encodedTag = Uri.encodeComponent('p: $packageName');
|
|
final List<RepositoryPackage> packages = <RepositoryPackage>[
|
|
createFakePackage('a_package', packagesDir),
|
|
];
|
|
|
|
final String entry = '| [$packageName](./packages/$packageName/) | '
|
|
'Some random text | '
|
|
'[](https://pub.dev/packages/$packageName/score) | '
|
|
'[](https://pub.dev/packages/$packageName/score) | '
|
|
'[](https://github.com/flutter/flutter/labels/$encodedTag) | '
|
|
'[](https://github.com/flutter/packages/labels/$encodedTag) |';
|
|
|
|
root.childFile('README.md').writeAsStringSync('''
|
|
${readmeTableHeader()}
|
|
$entry
|
|
''');
|
|
writeCodeOwners(packages);
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(
|
|
runner, <String>['repo-package-info-check'], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains(
|
|
'Invalid repo root README.md table entry: "Some random text"'),
|
|
contains('a_package:\n'
|
|
' Invalid root README.md table entry')
|
|
]));
|
|
});
|
|
|
|
test('fails for incorrect source link in README table entry', () async {
|
|
const String packageName = 'a_package';
|
|
final String encodedTag = Uri.encodeComponent('p: $packageName');
|
|
const String incorrectPackageName = 'a_pakage';
|
|
final List<RepositoryPackage> packages = <RepositoryPackage>[
|
|
createFakePackage('a_package', packagesDir),
|
|
];
|
|
|
|
final String entry =
|
|
'| [$packageName](./packages/$incorrectPackageName/) | '
|
|
'[](https://pub.dev/packages/$packageName) | '
|
|
'[](https://pub.dev/packages/$packageName/score) | '
|
|
'[](https://pub.dev/packages/$packageName/score) | '
|
|
'[](https://github.com/flutter/flutter/labels/$encodedTag) | '
|
|
'[](https://github.com/flutter/packages/labels/$encodedTag) |';
|
|
|
|
root.childFile('README.md').writeAsStringSync('''
|
|
${readmeTableHeader()}
|
|
$entry
|
|
''');
|
|
writeCodeOwners(packages);
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(
|
|
runner, <String>['repo-package-info-check'], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains(
|
|
'Incorrect link in root README.md table: "./packages/$incorrectPackageName/"'),
|
|
contains('a_package:\n'
|
|
' Incorrect link in root README.md table')
|
|
]));
|
|
});
|
|
|
|
test('fails for incorrect packages/* link in README table entry', () async {
|
|
const String packageName = 'a_package';
|
|
final String encodedTag = Uri.encodeComponent('p: $packageName');
|
|
const String incorrectPackageName = 'a_pakage';
|
|
final List<RepositoryPackage> packages = <RepositoryPackage>[
|
|
createFakePackage('a_package', packagesDir),
|
|
];
|
|
|
|
final String entry = '| [$packageName](./packages/$packageName/) | '
|
|
'[](https://pub.dev/packages/$packageName) | '
|
|
'[](https://pub.dev/packages/$incorrectPackageName/score) | '
|
|
'[](https://pub.dev/packages/$packageName/score) | '
|
|
'[](https://github.com/flutter/flutter/labels/$encodedTag) | '
|
|
'[](https://github.com/flutter/packages/labels/$encodedTag) |';
|
|
|
|
root.childFile('README.md').writeAsStringSync('''
|
|
${readmeTableHeader()}
|
|
$entry
|
|
''');
|
|
writeCodeOwners(packages);
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(
|
|
runner, <String>['repo-package-info-check'], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains(
|
|
'Incorrect link in root README.md table: "https://pub.dev/packages/$incorrectPackageName/score"'),
|
|
contains('a_package:\n'
|
|
' Incorrect link in root README.md table')
|
|
]));
|
|
});
|
|
|
|
test('fails for incorrect labels/* link in README table entry', () async {
|
|
const String packageName = 'a_package';
|
|
final String encodedTag = Uri.encodeComponent('p: $packageName');
|
|
final String incorrectTag = Uri.encodeComponent('p: a_pakage');
|
|
final List<RepositoryPackage> packages = <RepositoryPackage>[
|
|
createFakePackage('a_package', packagesDir),
|
|
];
|
|
|
|
final String entry = '| [$packageName](./packages/$packageName/) | '
|
|
'[](https://pub.dev/packages/$packageName) | '
|
|
'[](https://pub.dev/packages/$packageName/score) | '
|
|
'[](https://pub.dev/packages/$packageName/score) | '
|
|
'[](https://github.com/flutter/flutter/labels/$incorrectTag) | '
|
|
'[](https://github.com/flutter/packages/labels/$encodedTag) |';
|
|
|
|
root.childFile('README.md').writeAsStringSync('''
|
|
${readmeTableHeader()}
|
|
$entry
|
|
''');
|
|
writeCodeOwners(packages);
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(
|
|
runner, <String>['repo-package-info-check'], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains(
|
|
'Incorrect link in root README.md table: "https://github.com/flutter/flutter/labels/$incorrectTag"'),
|
|
contains('a_package:\n'
|
|
' Incorrect link in root README.md table')
|
|
]));
|
|
});
|
|
|
|
test('fails for incorrect packages/* anchor in README table entry', () async {
|
|
const String packageName = 'a_package';
|
|
final String encodedTag = Uri.encodeComponent('p: $packageName');
|
|
const String incorrectPackageName = 'a_pakage';
|
|
final List<RepositoryPackage> packages = <RepositoryPackage>[
|
|
createFakePackage('a_package', packagesDir),
|
|
];
|
|
|
|
final String entry = '| [$packageName](./packages/$packageName/) | '
|
|
'[](https://pub.dev/packages/$packageName) | '
|
|
'[](https://pub.dev/packages/$packageName/score) | '
|
|
'[](https://pub.dev/packages/$packageName/score) | '
|
|
'[](https://github.com/flutter/flutter/labels/$encodedTag) | '
|
|
'[](https://github.com/flutter/packages/labels/$encodedTag) |';
|
|
|
|
root.childFile('README.md').writeAsStringSync('''
|
|
${readmeTableHeader()}
|
|
$entry
|
|
''');
|
|
writeCodeOwners(packages);
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(
|
|
runner, <String>['repo-package-info-check'], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains(
|
|
'Incorrect anchor in root README.md table: ""'),
|
|
contains('a_package:\n'
|
|
' Incorrect anchor in root README.md table')
|
|
]));
|
|
});
|
|
|
|
test('fails for incorrect tag query anchor in README table entry', () async {
|
|
const String packageName = 'a_package';
|
|
final String encodedTag = Uri.encodeComponent('p: $packageName');
|
|
final String incorrectTag = Uri.encodeComponent('p: a_pakage');
|
|
final List<RepositoryPackage> packages = <RepositoryPackage>[
|
|
createFakePackage('a_package', packagesDir),
|
|
];
|
|
|
|
final String entry = '| [$packageName](./packages/$packageName/) | '
|
|
'[](https://pub.dev/packages/$packageName) | '
|
|
'[](https://pub.dev/packages/$packageName/score) | '
|
|
'[](https://pub.dev/packages/$packageName/score) | '
|
|
'[](https://github.com/flutter/flutter/labels/$encodedTag) | '
|
|
'[](https://github.com/flutter/packages/labels/$encodedTag) |';
|
|
|
|
root.childFile('README.md').writeAsStringSync('''
|
|
${readmeTableHeader()}
|
|
$entry
|
|
''');
|
|
writeCodeOwners(packages);
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(
|
|
runner, <String>['repo-package-info-check'], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains(
|
|
'Incorrect anchor in root README.md table: "'),
|
|
contains('a_package:\n'
|
|
' Incorrect anchor in root README.md table')
|
|
]));
|
|
});
|
|
|
|
test('fails for missing CODEOWNER', () async {
|
|
const String packageName = 'a_package';
|
|
createFakePackage(packageName, packagesDir);
|
|
|
|
root.childFile('README.md').writeAsStringSync('''
|
|
${readmeTableHeader()}
|
|
${readmeTableEntry(packageName)}
|
|
''');
|
|
writeCodeOwners(<RepositoryPackage>[]);
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(
|
|
runner, <String>['repo-package-info-check'], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains('Missing CODEOWNERS entry.'),
|
|
contains('a_package:\n'
|
|
' Missing CODEOWNERS entry')
|
|
]));
|
|
});
|
|
}
|