mirror of
https://github.com/flutter/packages.git
synced 2025-05-23 03:36:45 +08:00
12ec9fe3f0
Extracts common logic for running `pub get`, and switches commands to use it. The common logic always uses `flutter pub get` for Flutter packages, rather than `dart pub get`, since the latter will fail if someone has a non-Flutter `dart` in their path before `flutter` (e.g., Dart team members contributing PRs).
588 lines
18 KiB
Dart
588 lines
18 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:convert';
|
|
|
|
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/update_dependency_command.dart';
|
|
import 'package:http/http.dart' as http;
|
|
import 'package:http/testing.dart';
|
|
import 'package:pubspec_parse/pubspec_parse.dart';
|
|
import 'package:test/test.dart';
|
|
|
|
import 'mocks.dart';
|
|
import 'util.dart';
|
|
|
|
void main() {
|
|
FileSystem fileSystem;
|
|
late Directory packagesDir;
|
|
late RecordingProcessRunner processRunner;
|
|
late CommandRunner<void> runner;
|
|
Future<http.Response> Function(http.Request request)? mockHttpResponse;
|
|
|
|
setUp(() {
|
|
fileSystem = MemoryFileSystem();
|
|
processRunner = RecordingProcessRunner();
|
|
packagesDir = createPackagesDirectory(fileSystem: fileSystem);
|
|
final UpdateDependencyCommand command = UpdateDependencyCommand(
|
|
packagesDir,
|
|
processRunner: processRunner,
|
|
httpClient:
|
|
MockClient((http.Request request) => mockHttpResponse!(request)),
|
|
);
|
|
|
|
runner = CommandRunner<void>(
|
|
'update_dependency_command', 'Test for update-dependency command.');
|
|
runner.addCommand(command);
|
|
});
|
|
|
|
/// Adds a dummy 'dependencies:' entries for [dependency] to [package].
|
|
void addDependency(RepositoryPackage package, String dependency,
|
|
{String version = '^1.0.0'}) {
|
|
final List<String> lines = package.pubspecFile.readAsLinesSync();
|
|
final int dependenciesStartIndex = lines.indexOf('dependencies:');
|
|
assert(dependenciesStartIndex != -1);
|
|
lines.insert(dependenciesStartIndex + 1, ' $dependency: $version');
|
|
package.pubspecFile.writeAsStringSync(lines.join('\n'));
|
|
}
|
|
|
|
/// Adds a 'dev_dependencies:' section with an entry for [dependency] to
|
|
/// [package].
|
|
void addDevDependency(RepositoryPackage package, String dependency,
|
|
{String version = '^1.0.0'}) {
|
|
final String originalContent = package.pubspecFile.readAsStringSync();
|
|
package.pubspecFile.writeAsStringSync('''
|
|
$originalContent
|
|
|
|
dev_dependencies:
|
|
$dependency: $version
|
|
''');
|
|
}
|
|
|
|
test('throws if no target is provided', () async {
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(
|
|
runner, <String>['update-dependency'], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains('Exactly one of the target flags must be provided:'),
|
|
]),
|
|
);
|
|
});
|
|
|
|
group('pub dependencies', () {
|
|
test('throws if no version is given for an unpublished target', () async {
|
|
mockHttpResponse = (http.Request request) async {
|
|
return http.Response('', 404);
|
|
};
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'target_package'
|
|
], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains('target_package does not exist on pub'),
|
|
]),
|
|
);
|
|
});
|
|
|
|
test('skips if there is no dependency', () async {
|
|
createFakePackage('a_package', packagesDir, examples: <String>[]);
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'target_package',
|
|
'--version',
|
|
'1.5.0'
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains('SKIPPING: Does not depend on target_package'),
|
|
]),
|
|
);
|
|
});
|
|
|
|
test('skips if the dependency is already the target version', () async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir, examples: <String>[]);
|
|
addDependency(package, 'target_package', version: '^1.5.0');
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'target_package',
|
|
'--version',
|
|
'1.5.0'
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains('SKIPPING: Already depends on ^1.5.0'),
|
|
]),
|
|
);
|
|
});
|
|
|
|
test('logs updates', () async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir, examples: <String>[]);
|
|
addDependency(package, 'target_package');
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'target_package',
|
|
'--version',
|
|
'1.5.0'
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains('Updating to "^1.5.0"'),
|
|
]),
|
|
);
|
|
});
|
|
|
|
test('updates normal dependency', () async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir, examples: <String>[]);
|
|
addDependency(package, 'target_package');
|
|
|
|
await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'target_package',
|
|
'--version',
|
|
'1.5.0'
|
|
]);
|
|
|
|
final Dependency? dep =
|
|
package.parsePubspec().dependencies['target_package'];
|
|
expect(dep, isA<HostedDependency>());
|
|
expect((dep! as HostedDependency).version.toString(), '^1.5.0');
|
|
});
|
|
|
|
test('updates dev dependency', () async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir, examples: <String>[]);
|
|
addDevDependency(package, 'target_package');
|
|
|
|
await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'target_package',
|
|
'--version',
|
|
'1.5.0'
|
|
]);
|
|
|
|
final Dependency? dep =
|
|
package.parsePubspec().devDependencies['target_package'];
|
|
expect(dep, isA<HostedDependency>());
|
|
expect((dep! as HostedDependency).version.toString(), '^1.5.0');
|
|
});
|
|
|
|
test('updates dependency in example', () async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir);
|
|
final RepositoryPackage example = package.getExamples().first;
|
|
addDevDependency(example, 'target_package');
|
|
|
|
await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'target_package',
|
|
'--version',
|
|
'1.5.0'
|
|
]);
|
|
|
|
final Dependency? dep =
|
|
example.parsePubspec().devDependencies['target_package'];
|
|
expect(dep, isA<HostedDependency>());
|
|
expect((dep! as HostedDependency).version.toString(), '^1.5.0');
|
|
});
|
|
|
|
test('uses provided constraint as-is', () async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir, examples: <String>[]);
|
|
addDependency(package, 'target_package');
|
|
|
|
const String providedConstraint = '>=1.6.0 <3.0.0';
|
|
await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'target_package',
|
|
'--version',
|
|
providedConstraint
|
|
]);
|
|
|
|
final Dependency? dep =
|
|
package.parsePubspec().dependencies['target_package'];
|
|
expect(dep, isA<HostedDependency>());
|
|
expect((dep! as HostedDependency).version.toString(), providedConstraint);
|
|
});
|
|
|
|
test('uses provided version as lower bound for unpinned', () async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir, examples: <String>[]);
|
|
addDependency(package, 'target_package');
|
|
|
|
await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'target_package',
|
|
'--version',
|
|
'1.5.0'
|
|
]);
|
|
|
|
final Dependency? dep =
|
|
package.parsePubspec().dependencies['target_package'];
|
|
expect(dep, isA<HostedDependency>());
|
|
expect((dep! as HostedDependency).version.toString(), '^1.5.0');
|
|
});
|
|
|
|
test('uses provided version as exact version for pinned', () async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir, examples: <String>[]);
|
|
addDependency(package, 'target_package', version: '1.0.0');
|
|
|
|
await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'target_package',
|
|
'--version',
|
|
'1.5.0'
|
|
]);
|
|
|
|
final Dependency? dep =
|
|
package.parsePubspec().dependencies['target_package'];
|
|
expect(dep, isA<HostedDependency>());
|
|
expect((dep! as HostedDependency).version.toString(), '1.5.0');
|
|
});
|
|
|
|
test('uses latest pub version as lower bound for unpinned', () async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir, examples: <String>[]);
|
|
addDependency(package, 'target_package');
|
|
|
|
const Map<String, dynamic> targetPackagePubResponse = <String, dynamic>{
|
|
'name': 'a',
|
|
'versions': <String>[
|
|
'0.0.1',
|
|
'1.0.0',
|
|
'1.5.0',
|
|
],
|
|
};
|
|
mockHttpResponse = (http.Request request) async {
|
|
if (request.url.pathSegments.last == 'target_package.json') {
|
|
return http.Response(json.encode(targetPackagePubResponse), 200);
|
|
}
|
|
return http.Response('', 500);
|
|
};
|
|
|
|
await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'target_package',
|
|
]);
|
|
|
|
final Dependency? dep =
|
|
package.parsePubspec().dependencies['target_package'];
|
|
expect(dep, isA<HostedDependency>());
|
|
expect((dep! as HostedDependency).version.toString(), '^1.5.0');
|
|
});
|
|
|
|
test('uses latest pub version as exact version for pinned', () async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir, examples: <String>[]);
|
|
addDependency(package, 'target_package', version: '1.0.0');
|
|
|
|
const Map<String, dynamic> targetPackagePubResponse = <String, dynamic>{
|
|
'name': 'a',
|
|
'versions': <String>[
|
|
'0.0.1',
|
|
'1.0.0',
|
|
'1.5.0',
|
|
],
|
|
};
|
|
mockHttpResponse = (http.Request request) async {
|
|
if (request.url.pathSegments.last == 'target_package.json') {
|
|
return http.Response(json.encode(targetPackagePubResponse), 200);
|
|
}
|
|
return http.Response('', 500);
|
|
};
|
|
|
|
await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'target_package',
|
|
]);
|
|
|
|
final Dependency? dep =
|
|
package.parsePubspec().dependencies['target_package'];
|
|
expect(dep, isA<HostedDependency>());
|
|
expect((dep! as HostedDependency).version.toString(), '1.5.0');
|
|
});
|
|
|
|
test('regenerates all pigeon files when updating pigeon', () async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir, extraFiles: <String>[
|
|
'pigeons/foo.dart',
|
|
'pigeons/bar.dart',
|
|
]);
|
|
addDependency(package, 'pigeon', version: '1.0.0');
|
|
|
|
await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'pigeon',
|
|
'--version',
|
|
'1.5.0',
|
|
]);
|
|
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
'dart',
|
|
const <String>['pub', 'get'],
|
|
package.path,
|
|
),
|
|
ProcessCall(
|
|
'dart',
|
|
const <String>['run', 'pigeon', '--input', 'pigeons/foo.dart'],
|
|
package.path,
|
|
),
|
|
ProcessCall(
|
|
'dart',
|
|
const <String>['run', 'pigeon', '--input', 'pigeons/bar.dart'],
|
|
package.path,
|
|
),
|
|
]),
|
|
);
|
|
});
|
|
|
|
test('warns when regenerating pigeon if there are no pigeon files',
|
|
() async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir);
|
|
addDependency(package, 'pigeon', version: '1.0.0');
|
|
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'pigeon',
|
|
'--version',
|
|
'1.5.0',
|
|
]);
|
|
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains('No pigeon input files found'),
|
|
]),
|
|
);
|
|
});
|
|
|
|
test('updating pigeon fails if pub get fails', () async {
|
|
final RepositoryPackage package = createFakePackage(
|
|
'a_package', packagesDir,
|
|
extraFiles: <String>['pigeons/foo.dart']);
|
|
addDependency(package, 'pigeon', version: '1.0.0');
|
|
|
|
processRunner.mockProcessesForExecutable['dart'] = <FakeProcessInfo>[
|
|
FakeProcessInfo(MockProcess(exitCode: 1), <String>['pub', 'get'])
|
|
];
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'pigeon',
|
|
'--version',
|
|
'1.5.0',
|
|
], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains('Fetching dependencies failed'),
|
|
contains('Failed to update pigeon files'),
|
|
]),
|
|
);
|
|
});
|
|
|
|
test('updating pigeon fails if running pigeon fails', () async {
|
|
final RepositoryPackage package = createFakePackage(
|
|
'a_package', packagesDir,
|
|
extraFiles: <String>['pigeons/foo.dart']);
|
|
addDependency(package, 'pigeon', version: '1.0.0');
|
|
|
|
processRunner.mockProcessesForExecutable['dart'] = <FakeProcessInfo>[
|
|
FakeProcessInfo(MockProcess(), <String>['pub', 'get']),
|
|
FakeProcessInfo(MockProcess(exitCode: 1), <String>['run', 'pigeon']),
|
|
];
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'pigeon',
|
|
'--version',
|
|
'1.5.0',
|
|
], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains('dart run pigeon failed'),
|
|
contains('Failed to update pigeon files'),
|
|
]),
|
|
);
|
|
});
|
|
|
|
test('regenerates mocks when updating mockito if necessary', () async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir);
|
|
addDependency(package, 'mockito', version: '1.0.0');
|
|
addDevDependency(package, 'build_runner');
|
|
|
|
await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'mockito',
|
|
'--version',
|
|
'1.5.0',
|
|
]);
|
|
|
|
expect(
|
|
processRunner.recordedCalls,
|
|
orderedEquals(<ProcessCall>[
|
|
ProcessCall(
|
|
'dart',
|
|
const <String>['pub', 'get'],
|
|
package.path,
|
|
),
|
|
ProcessCall(
|
|
'dart',
|
|
const <String>[
|
|
'run',
|
|
'build_runner',
|
|
'build',
|
|
'--delete-conflicting-outputs'
|
|
],
|
|
package.path,
|
|
),
|
|
]),
|
|
);
|
|
});
|
|
|
|
test('skips regenerating mocks when there is no build_runner dependency',
|
|
() async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir);
|
|
addDependency(package, 'mockito', version: '1.0.0');
|
|
|
|
await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'mockito',
|
|
'--version',
|
|
'1.5.0',
|
|
]);
|
|
|
|
expect(processRunner.recordedCalls.isEmpty, true);
|
|
});
|
|
|
|
test('updating mockito fails if pub get fails', () async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir);
|
|
addDependency(package, 'mockito', version: '1.0.0');
|
|
addDevDependency(package, 'build_runner');
|
|
|
|
processRunner.mockProcessesForExecutable['dart'] = <FakeProcessInfo>[
|
|
FakeProcessInfo(MockProcess(exitCode: 1), <String>['pub', 'get'])
|
|
];
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'mockito',
|
|
'--version',
|
|
'1.5.0',
|
|
], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains('Fetching dependencies failed'),
|
|
contains('Failed to update mocks'),
|
|
]),
|
|
);
|
|
});
|
|
|
|
test('updating mockito fails if running build_runner fails', () async {
|
|
final RepositoryPackage package =
|
|
createFakePackage('a_package', packagesDir);
|
|
addDependency(package, 'mockito', version: '1.0.0');
|
|
addDevDependency(package, 'build_runner');
|
|
|
|
processRunner.mockProcessesForExecutable['dart'] = <FakeProcessInfo>[
|
|
FakeProcessInfo(MockProcess(), <String>['pub', 'get']),
|
|
FakeProcessInfo(
|
|
MockProcess(exitCode: 1), <String>['run', 'build_runner']),
|
|
];
|
|
|
|
Error? commandError;
|
|
final List<String> output = await runCapturingPrint(runner, <String>[
|
|
'update-dependency',
|
|
'--pub-package',
|
|
'mockito',
|
|
'--version',
|
|
'1.5.0',
|
|
], errorHandler: (Error e) {
|
|
commandError = e;
|
|
});
|
|
|
|
expect(commandError, isA<ToolExit>());
|
|
expect(
|
|
output,
|
|
containsAllInOrder(<Matcher>[
|
|
contains('"dart run build_runner build" failed'),
|
|
contains('Failed to update mocks'),
|
|
]),
|
|
);
|
|
});
|
|
});
|
|
}
|