firka/flutter
3
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix Gradle warning in a freshly flutter createed Android project (#122290)

Browse Source 
Fix Gradle warning in a freshly `flutter create`ed Android project
This commit is contained in:
Bartek Pacia
2023-03-22 00:41:49 +01:00
committed by GitHub
parent 47dd992266
commit c40dd27681
44 changed files with 192 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
dev/benchmarks/complex_layout/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/benchmarks/macrobenchmarks/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/benchmarks/microbenchmarks/android/build.gradle
View File

@@ -45,6 +45,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

4
dev/benchmarks/multiple_flutters/android/build.gradle
View File

@@ -25,6 +25,6 @@ allprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}
}

2
dev/benchmarks/platform_views_layout/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/benchmarks/platform_views_layout_hybrid_composition/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/benchmarks/test_apps/stocks/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/abstract_method_smoke_test/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/android_custom_host_app/build.gradle
View File

@@ -19,6 +19,6 @@ allprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/android_embedding_v2_smoke_test/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/android_host_app_v2_embedding/build.gradle
View File

@@ -19,6 +19,6 @@ allprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/android_semantics_testing/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/android_views/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/channels/android/build.gradle
View File

@@ -30,6 +30,6 @@ subprojects {
project.evaluationDependsOn(':app')
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/deferred_components_test/android/build.gradle
View File

@@ -45,6 +45,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/external_ui/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/flavors/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/flutter_gallery/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/gradle_deprecated_settings/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/hybrid_android_views/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/module_host_with_custom_build_v2_embedding/build.gradle
View File

@@ -19,6 +19,6 @@ allprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/non_nullable/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/platform_interaction/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/release_smoke_test/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/spell_check/android/build.gradle
View File

@@ -30,6 +30,6 @@ subprojects {
project.evaluationDependsOn(':app')
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/integration_tests/ui/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/manual_tests/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
dev/tools/bin/generate_gradle_lockfiles.dart
View File

@@ -181,7 +181,7 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}
''';

2
dev/tracing_tests/android/build.gradle
View File

@@ -30,6 +30,6 @@ subprojects {
project.evaluationDependsOn(':app')
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
examples/api/android/build.gradle
View File

@@ -28,6 +28,6 @@ subprojects {
project.evaluationDependsOn(':app')
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
examples/flutter_view/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
examples/hello_world/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
examples/image_list/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
examples/layers/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
examples/platform_channel/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
examples/platform_view/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

10
packages/flutter_tools/lib/src/android/gradle.dart
View File

@@ -19,6 +19,7 @@ import '../base/logger.dart';
import '../base/net.dart';
import '../base/platform.dart';
import '../base/process.dart';
import '../base/project_migrator.dart';
import '../base/terminal.dart';
import '../base/utils.dart';
import '../build_info.dart';
@@ -31,6 +32,7 @@ import 'android_builder.dart';
import 'android_studio.dart';
import 'gradle_errors.dart';
import 'gradle_utils.dart';
import 'migrations/top_level_gradle_build_file_migration.dart';
import 'multidex.dart';
/// The directory where the APK artifact is generated.
@@ -235,11 +237,17 @@ class AndroidGradleBuilder implements AndroidBuilder {
int retry = 0,
@visibleForTesting int? maxRetries,
}) async {
if (!project.android.isSupportedVersion) {
_exitWithUnsupportedProjectMessage(_usage, _logger.terminal);
}
final List<ProjectMigrator> migrators = <ProjectMigrator>[
TopLevelGradleBuildFileMigration(project.android, _logger),
];
final ProjectMigration migration = ProjectMigration(migrators);
migration.run();
final bool usesAndroidX = isAppUsingAndroidX(project.android.hostAppGradleRoot);
if (usesAndroidX) {
BuildEvent('app-using-android-x', type: 'gradle', flutterUsage: _usage).send();

53
packages/flutter_tools/lib/src/android/migrations/top_level_gradle_build_file_migration.dart Normal file
View File

@@ -0,0 +1,53 @@
// Copyright 2014 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 '../../base/file_system.dart';
import '../../base/project_migrator.dart';
import '../../project.dart';
const String _eagerCleanTaskDeclaration = '''
task clean(type: Delete) {
delete rootProject.buildDir
}
''';
const String _lazyCleanTaskDeclaration = '''
tasks.register("clean", Delete) {
delete rootProject.buildDir
}
''';
/// Migrate the Gradle "clean" task to use modern, lazy declaration style.
class TopLevelGradleBuildFileMigration extends ProjectMigrator {
TopLevelGradleBuildFileMigration(
AndroidProject project,
super.logger,
) : _topLevelGradleBuildFile = project.hostAppGradleRoot.childFile('build.gradle');
final File _topLevelGradleBuildFile;
@override
void migrate() {
if (!_topLevelGradleBuildFile.existsSync()) {
logger.printTrace('Top-level Gradle build file not found, skipping migration of task "clean".');
return;
}
processFileLines(_topLevelGradleBuildFile);
}
@override
String migrateFileContents(String fileContents) {
final String newContents = fileContents.replaceAll(
_eagerCleanTaskDeclaration,
_lazyCleanTaskDeclaration,
);
if (newContents != fileContents) {
logger.printTrace('Migrating "clean" Gradle task to lazy declaration style.');
}
return newContents;
}
}

2
packages/flutter_tools/templates/app_shared/android-java.tmpl/build.gradle.tmpl
View File

@@ -26,6 +26,6 @@ subprojects {
project.evaluationDependsOn(':app')
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

2
packages/flutter_tools/templates/app_shared/android-kotlin.tmpl/build.gradle.tmpl
View File

@@ -26,6 +26,6 @@ subprojects {
project.evaluationDependsOn(':app')
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}

88
packages/flutter_tools/test/general.shard/android/android_project_migration_test.dart Normal file
View File

@@ -0,0 +1,88 @@
// Copyright 2014 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:file/file.dart';
import 'package:file/memory.dart';
import 'package:flutter_tools/src/android/migrations/top_level_gradle_build_file_migration.dart';
import 'package:flutter_tools/src/base/logger.dart';
import 'package:flutter_tools/src/project.dart';
import 'package:test/fake.dart';
import '../../src/common.dart';
import '../../src/context.dart';
void main() {
group('Android migration', () {
group('migrate the Gradle "clean" task to lazy declaration', () {
late MemoryFileSystem memoryFileSystem;
late BufferLogger bufferLogger;
late FakeAndroidProject project;
late File topLevelGradleBuildFile;
setUp(() {
memoryFileSystem = MemoryFileSystem.test();
bufferLogger = BufferLogger.test();
project = FakeAndroidProject(
root: memoryFileSystem.currentDirectory.childDirectory('android')..createSync(),
);
topLevelGradleBuildFile = project.hostAppGradleRoot.childFile('build.gradle');
});
testUsingContext('skipped if files are missing', () {
final TopLevelGradleBuildFileMigration androidProjectMigration = TopLevelGradleBuildFileMigration(
project,
bufferLogger,
);
androidProjectMigration.migrate();
expect(topLevelGradleBuildFile.existsSync(), isFalse);
expect(bufferLogger.traceText, contains('Top-level Gradle build file not found, skipping migration of task "clean".'));
});
testUsingContext('skipped if nothing to upgrade', () {
topLevelGradleBuildFile.writeAsStringSync('''
tasks.register("clean", Delete) {
delete rootProject.buildDir
}
''');
final TopLevelGradleBuildFileMigration androidProjectMigration = TopLevelGradleBuildFileMigration(
project,
bufferLogger,
);
final DateTime previousLastModified = topLevelGradleBuildFile.lastModifiedSync();
androidProjectMigration.migrate();
expect(topLevelGradleBuildFile.lastModifiedSync(), previousLastModified);
});
testUsingContext('top-level build.gradle is migrated', () {
topLevelGradleBuildFile.writeAsStringSync('''
task clean(type: Delete) {
delete rootProject.buildDir
}
''');
final TopLevelGradleBuildFileMigration androidProjectMigration = TopLevelGradleBuildFileMigration(
project,
bufferLogger,
);
androidProjectMigration.migrate();
expect(bufferLogger.traceText, contains('Migrating "clean" Gradle task to lazy declaration style.'));
expect(topLevelGradleBuildFile.readAsStringSync(), equals('''
tasks.register("clean", Delete) {
delete rootProject.buildDir
}
'''));
});
});
});
}
class FakeAndroidProject extends Fake implements AndroidProject {
FakeAndroidProject({required Directory root}) : hostAppGradleRoot = root;
@override
Directory hostAppGradleRoot;
}

2
packages/flutter_tools/test/integration.shard/test_data/deferred_components_project.dart
View File

@@ -134,7 +134,7 @@ class BasicDeferredComponentsConfig extends DeferredComponentsConfig {
project.evaluationDependsOn(':app')
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}
''';

2
packages/flutter_tools/test/integration.shard/test_data/multidex_project.dart
View File

@@ -110,7 +110,7 @@ class MultidexProject extends Project {
project.evaluationDependsOn(':app')
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}
''';

2
packages/integration_test/example/android/build.gradle
View File

@@ -46,6 +46,6 @@ subprojects {
}
}
task clean(type: Delete) {
tasks.register("clean", Delete) {
delete rootProject.buildDir
}