Flutter build aar (#36732)
`flutter build aar`
This new build command works just like `flutter build apk` or `flutter build appbundle`, but for plugin and module projects.
This PR also refactors how plugins are included in app or module projects. By building the plugins as AARs, the Android Gradle plugin is able to use Jetifier to translate support libraries into AndroidX libraries for all the plugin's native code. Thus, reducing the error rate when using AndroidX in apps.
This change also allows to build modules as AARs, so developers can take these artifacts and distribute them along with the native host app without the need of the Flutter tool. This is a requirement for add to app.
`flutter build aar` generates POM artifacts (XML files) which contain metadata about the native dependencies used by the plugin. This allows Gradle to resolve dependencies at the app level. The result of this new build command is a single build/outputs/repo, the local repository that contains all the generated AARs and POM files.
In a Flutter app project, this local repo is used by the Flutter Gradle plugin to resolve the plugin dependencies. In add to app case, the developer needs to configure the local repo and the dependency manually in `build.gradle`:
repositories {
maven {
url "<path-to-flutter-module>build/host/outputs/repo"
}
}
dependencies {
implementation("<package-name>:flutter_<build-mode>:1.0@aar") {
transitive = true
}
}
diff --git a/packages/flutter_tools/test/general.shard/android/gradle_test.dart b/packages/flutter_tools/test/general.shard/android/gradle_test.dart
index b09f73f..d6380f0 100644
--- a/packages/flutter_tools/test/general.shard/android/gradle_test.dart
+++ b/packages/flutter_tools/test/general.shard/android/gradle_test.dart
@@ -6,7 +6,9 @@
import 'package:file/memory.dart';
import 'package:flutter_tools/src/android/gradle.dart';
+import 'package:flutter_tools/src/base/logger.dart';
import 'package:flutter_tools/src/artifacts.dart';
+import 'package:flutter_tools/src/base/common.dart';
import 'package:flutter_tools/src/base/file_system.dart';
import 'package:flutter_tools/src/build_info.dart';
import 'package:flutter_tools/src/cache.dart';
@@ -168,20 +170,20 @@
expect(project.productFlavors, <String>['free', 'paid']);
});
test('should provide apk file name for default build types', () {
- final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>[], fs.directory('/some/dir'),fs.directory('/some/dir'));
+ final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>[], '/some/dir');
expect(project.apkFilesFor(const AndroidBuildInfo(BuildInfo.debug)).first, 'app-debug.apk');
expect(project.apkFilesFor(const AndroidBuildInfo(BuildInfo.profile)).first, 'app-profile.apk');
expect(project.apkFilesFor(const AndroidBuildInfo(BuildInfo.release)).first, 'app-release.apk');
expect(project.apkFilesFor(const AndroidBuildInfo(BuildInfo(BuildMode.release, 'unknown'))).isEmpty, isTrue);
});
test('should provide apk file name for flavored build types', () {
- final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>['free', 'paid'], fs.directory('/some/dir'),fs.directory('/some/dir'));
+ final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>['free', 'paid'], '/some/dir');
expect(project.apkFilesFor(const AndroidBuildInfo(BuildInfo(BuildMode.debug, 'free'))).first, 'app-free-debug.apk');
expect(project.apkFilesFor(const AndroidBuildInfo(BuildInfo(BuildMode.release, 'paid'))).first, 'app-paid-release.apk');
expect(project.apkFilesFor(const AndroidBuildInfo(BuildInfo(BuildMode.release, 'unknown'))).isEmpty, isTrue);
});
test('should provide apks for default build types and each ABI', () {
- final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>[], fs.directory('/some/dir'),fs.directory('/some/dir'));
+ final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>[], '/some/dir');
expect(project.apkFilesFor(
const AndroidBuildInfo(
BuildInfo.debug,
@@ -224,7 +226,7 @@
).isEmpty, isTrue);
});
test('should provide apks for each ABI and flavored build types', () {
- final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>['free', 'paid'], fs.directory('/some/dir'),fs.directory('/some/dir'));
+ final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>['free', 'paid'], '/some/dir');
expect(project.apkFilesFor(
const AndroidBuildInfo(
BuildInfo(BuildMode.debug, 'free'),
@@ -267,54 +269,187 @@
).isEmpty, isTrue);
});
test('should provide bundle file name for default build types', () {
- final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>[], fs.directory('/some/dir'),fs.directory('/some/dir'));
+ final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>[], '/some/dir');
expect(project.bundleFileFor(BuildInfo.debug), 'app.aab');
expect(project.bundleFileFor(BuildInfo.profile), 'app.aab');
expect(project.bundleFileFor(BuildInfo.release), 'app.aab');
expect(project.bundleFileFor(const BuildInfo(BuildMode.release, 'unknown')), 'app.aab');
});
test('should provide bundle file name for flavored build types', () {
- final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>['free', 'paid'], fs.directory('/some/dir'),fs.directory('/some/dir'));
+ final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>['free', 'paid'], '/some/dir');
expect(project.bundleFileFor(const BuildInfo(BuildMode.debug, 'free')), 'app.aab');
expect(project.bundleFileFor(const BuildInfo(BuildMode.release, 'paid')), 'app.aab');
expect(project.bundleFileFor(const BuildInfo(BuildMode.release, 'unknown')), 'app.aab');
});
test('should provide assemble task name for default build types', () {
- final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>[], fs.directory('/some/dir'),fs.directory('/some/dir'));
+ final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>[], '/some/dir');
expect(project.assembleTaskFor(BuildInfo.debug), 'assembleDebug');
expect(project.assembleTaskFor(BuildInfo.profile), 'assembleProfile');
expect(project.assembleTaskFor(BuildInfo.release), 'assembleRelease');
expect(project.assembleTaskFor(const BuildInfo(BuildMode.release, 'unknown')), isNull);
});
test('should provide assemble task name for flavored build types', () {
- final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>['free', 'paid'], fs.directory('/some/dir'),fs.directory('/some/dir'));
+ final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>['free', 'paid'], '/some/dir');
expect(project.assembleTaskFor(const BuildInfo(BuildMode.debug, 'free')), 'assembleFreeDebug');
expect(project.assembleTaskFor(const BuildInfo(BuildMode.release, 'paid')), 'assemblePaidRelease');
expect(project.assembleTaskFor(const BuildInfo(BuildMode.release, 'unknown')), isNull);
});
test('should respect format of the flavored build types', () {
- final GradleProject project = GradleProject(<String>['debug'], <String>['randomFlavor'], fs.directory('/some/dir'),fs.directory('/some/dir'));
+ final GradleProject project = GradleProject(<String>['debug'], <String>['randomFlavor'], '/some/dir');
expect(project.assembleTaskFor(const BuildInfo(BuildMode.debug, 'randomFlavor')), 'assembleRandomFlavorDebug');
});
test('bundle should provide assemble task name for default build types', () {
- final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>[], fs.directory('/some/dir'),fs.directory('/some/dir'));
+ final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>[], '/some/dir');
expect(project.bundleTaskFor(BuildInfo.debug), 'bundleDebug');
expect(project.bundleTaskFor(BuildInfo.profile), 'bundleProfile');
expect(project.bundleTaskFor(BuildInfo.release), 'bundleRelease');
expect(project.bundleTaskFor(const BuildInfo(BuildMode.release, 'unknown')), isNull);
});
test('bundle should provide assemble task name for flavored build types', () {
- final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>['free', 'paid'], fs.directory('/some/dir'),fs.directory('/some/dir'));
+ final GradleProject project = GradleProject(<String>['debug', 'profile', 'release'], <String>['free', 'paid'], '/some/dir');
expect(project.bundleTaskFor(const BuildInfo(BuildMode.debug, 'free')), 'bundleFreeDebug');
expect(project.bundleTaskFor(const BuildInfo(BuildMode.release, 'paid')), 'bundlePaidRelease');
expect(project.bundleTaskFor(const BuildInfo(BuildMode.release, 'unknown')), isNull);
});
test('bundle should respect format of the flavored build types', () {
- final GradleProject project = GradleProject(<String>['debug'], <String>['randomFlavor'], fs.directory('/some/dir'),fs.directory('/some/dir'));
+ final GradleProject project = GradleProject(<String>['debug'], <String>['randomFlavor'], '/some/dir');
expect(project.bundleTaskFor(const BuildInfo(BuildMode.debug, 'randomFlavor')), 'bundleRandomFlavorDebug');
});
});
+ group('Config files', () {
+ BufferLogger mockLogger;
+ Directory tempDir;
+
+ setUp(() {
+ mockLogger = BufferLogger();
+ tempDir = fs.systemTempDirectory.createTempSync('settings_aar_test.');
+
+ });
+
+ testUsingContext('create settings_aar.gradle when current settings.gradle loads plugins', () {
+ const String currentSettingsGradle = '''
+include ':app'
+
+def flutterProjectRoot = rootProject.projectDir.parentFile.toPath()
+
+def plugins = new Properties()
+def pluginsFile = new File(flutterProjectRoot.toFile(), '.flutter-plugins')
+if (pluginsFile.exists()) {
+ pluginsFile.withReader('UTF-8') { reader -> plugins.load(reader) }
+}
+
+plugins.each { name, path ->
+ def pluginDirectory = flutterProjectRoot.resolve(path).resolve('android').toFile()
+ include ":\$name"
+ project(":\$name").projectDir = pluginDirectory
+}
+''';
+
+ const String settingsAarFile = '''
+include ':app'
+''';
+
+ tempDir.childFile('settings.gradle').writeAsStringSync(currentSettingsGradle);
+
+ final String toolGradlePath = fs.path.join(
+ fs.path.absolute(Cache.flutterRoot),
+ 'packages',
+ 'flutter_tools',
+ 'gradle');
+ fs.directory(toolGradlePath).createSync(recursive: true);
+ fs.file(fs.path.join(toolGradlePath, 'deprecated_settings.gradle'))
+ .writeAsStringSync(currentSettingsGradle);
+
+ fs.file(fs.path.join(toolGradlePath, 'settings_aar.gradle.tmpl'))
+ .writeAsStringSync(settingsAarFile);
+
+ createSettingsAarGradle(tempDir);
+
+ expect(mockLogger.statusText, contains('created successfully'));
+ expect(tempDir.childFile('settings_aar.gradle').existsSync(), isTrue);
+
+ }, overrides: <Type, Generator>{
+ FileSystem: () => MemoryFileSystem(),
+ Logger: () => mockLogger,
+ });
+
+ testUsingContext('create settings_aar.gradle when current settings.gradle doesn\'t load plugins', () {
+ const String currentSettingsGradle = '''
+include ':app'
+''';
+
+ const String settingsAarFile = '''
+include ':app'
+''';
+
+ tempDir.childFile('settings.gradle').writeAsStringSync(currentSettingsGradle);
+
+ final String toolGradlePath = fs.path.join(
+ fs.path.absolute(Cache.flutterRoot),
+ 'packages',
+ 'flutter_tools',
+ 'gradle');
+ fs.directory(toolGradlePath).createSync(recursive: true);
+ fs.file(fs.path.join(toolGradlePath, 'deprecated_settings.gradle'))
+ .writeAsStringSync(currentSettingsGradle);
+
+ fs.file(fs.path.join(toolGradlePath, 'settings_aar.gradle.tmpl'))
+ .writeAsStringSync(settingsAarFile);
+
+ createSettingsAarGradle(tempDir);
+
+ expect(mockLogger.statusText, contains('created successfully'));
+ expect(tempDir.childFile('settings_aar.gradle').existsSync(), isTrue);
+
+ }, overrides: <Type, Generator>{
+ FileSystem: () => MemoryFileSystem(),
+ Logger: () => mockLogger,
+ });
+ });
+
+ group('Undefined task', () {
+ BufferLogger mockLogger;
+
+ setUp(() {
+ mockLogger = BufferLogger();
+ });
+
+ testUsingContext('print undefined build type', () {
+ final GradleProject project = GradleProject(<String>['debug', 'release'],
+ const <String>['free', 'paid'], '/some/dir');
+
+ printUndefinedTask(project, const BuildInfo(BuildMode.profile, 'unknown'));
+ expect(mockLogger.errorText, contains('The Gradle project does not define a task suitable for the requested build'));
+ expect(mockLogger.errorText, contains('Review the android/app/build.gradle file and ensure it defines a profile build type'));
+ }, overrides: <Type, Generator>{
+ Logger: () => mockLogger,
+ });
+
+ testUsingContext('print no flavors', () {
+ final GradleProject project = GradleProject(<String>['debug', 'release'],
+ const <String>[], '/some/dir');
+
+ printUndefinedTask(project, const BuildInfo(BuildMode.debug, 'unknown'));
+ expect(mockLogger.errorText, contains('The Gradle project does not define a task suitable for the requested build'));
+ expect(mockLogger.errorText, contains('The android/app/build.gradle file does not define any custom product flavors'));
+ expect(mockLogger.errorText, contains('You cannot use the --flavor option'));
+ }, overrides: <Type, Generator>{
+ Logger: () => mockLogger,
+ });
+
+ testUsingContext('print flavors', () {
+ final GradleProject project = GradleProject(<String>['debug', 'release'],
+ const <String>['free', 'paid'], '/some/dir');
+
+ printUndefinedTask(project, const BuildInfo(BuildMode.debug, 'unknown'));
+ expect(mockLogger.errorText, contains('The Gradle project does not define a task suitable for the requested build'));
+ expect(mockLogger.errorText, contains('The android/app/build.gradle file defines product flavors: free, paid'));
+ }, overrides: <Type, Generator>{
+ Logger: () => mockLogger,
+ });
+ });
+
group('Gradle local.properties', () {
MockLocalEngineArtifacts mockArtifacts;
MockProcessManager mockProcessManager;
@@ -540,6 +675,52 @@
);
});
});
+
+ group('gradle version', () {
+ test('should be compatible with the Android plugin version', () {
+ // Granular versions.
+ expect(getGradleVersionFor('1.0.0'), '2.3');
+ expect(getGradleVersionFor('1.0.1'), '2.3');
+ expect(getGradleVersionFor('1.0.2'), '2.3');
+ expect(getGradleVersionFor('1.0.4'), '2.3');
+ expect(getGradleVersionFor('1.0.8'), '2.3');
+ expect(getGradleVersionFor('1.1.0'), '2.3');
+ expect(getGradleVersionFor('1.1.2'), '2.3');
+ expect(getGradleVersionFor('1.1.2'), '2.3');
+ expect(getGradleVersionFor('1.1.3'), '2.3');
+ // Version Ranges.
+ expect(getGradleVersionFor('1.2.0'), '2.9');
+ expect(getGradleVersionFor('1.3.1'), '2.9');
+
+ expect(getGradleVersionFor('1.5.0'), '2.2.1');
+
+ expect(getGradleVersionFor('2.0.0'), '2.13');
+ expect(getGradleVersionFor('2.1.2'), '2.13');
+
+ expect(getGradleVersionFor('2.1.3'), '2.14.1');
+ expect(getGradleVersionFor('2.2.3'), '2.14.1');
+
+ expect(getGradleVersionFor('2.3.0'), '3.3');
+
+ expect(getGradleVersionFor('3.0.0'), '4.1');
+
+ expect(getGradleVersionFor('3.1.0'), '4.4');
+
+ expect(getGradleVersionFor('3.2.0'), '4.6');
+ expect(getGradleVersionFor('3.2.1'), '4.6');
+
+ expect(getGradleVersionFor('3.3.0'), '4.10.2');
+ expect(getGradleVersionFor('3.3.2'), '4.10.2');
+
+ expect(getGradleVersionFor('3.4.0'), '5.1.1');
+ expect(getGradleVersionFor('3.5.0'), '5.1.1');
+ });
+
+ test('throws on unsupported versions', () {
+ expect(() => getGradleVersionFor('3.6.0'),
+ throwsA(predicate<Exception>((Exception e) => e is ToolExit)));
+ });
+ });
}
Platform fakePlatform(String name) {
