[CP] Add migrator to upgrade gradle version when conflict with Androi…

…d Studio bundled Java version is detected (and 3 others) (#126093) This is a cherry pick of the following four PRs (the first one depends on changes made in the latter three). 1. #125836 2. #124771 3. #123034 4. #123644 For the first PR, Original issue: #122376 Cherry-pick issue: #125693 *If you had to change anything in the [flutter/tests] repo, include a link to the migration guide as per the [breaking change policy].* ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord].  [Contributor Guide]: https://github.com/flutter/flutter/wiki/Tree-hygiene#overview [Tree Hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene [test-exempt]: https://github.com/flutter/flutter/wiki/Tree-hygiene#tests [Flutter Style Guide]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo [Features we expect every widget to implement]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/wiki/Chat --------- Co-authored-by: Reid Baker <reidbaker@google.com> Co-authored-by: Mitchell Goodwin <58190796+MitchellGoodwin@users.noreply.github.com> Co-authored-by: Greg Spencer <gspencergoog@users.noreply.github.com> Co-authored-by: Victoria Ashworth <vashworth@google.com> Co-authored-by: Jackson Gardner <jacksongardner@google.com> Co-authored-by: Rydmike <m.rydstrom@gmail.com> Co-authored-by: keyonghan <54558023+keyonghan@users.noreply.github.com> Co-authored-by: chunhtai <47866232+chunhtai@users.noreply.github.com> Co-authored-by: Taha Tesser <tessertaha@gmail.com> Co-authored-by: Ben Konyi <bkonyi@google.com> Co-authored-by: engine-flutter-autoroll <engine-flutter-autoroll@skia.org> Co-authored-by: hellohuanlin <41930132+hellohuanlin@users.noreply.github.com> Co-authored-by: Danny Tuppeny <danny@tuppeny.com> Co-authored-by: Chris Bracken <chris@bracken.jp> Co-authored-by: Kate Lovett <katelovett@google.com> Co-authored-by: Michael Goderbauer <goderbauer@google.com> Co-authored-by: Elias Yishak <42216813+eliasyishak@users.noreply.github.com> Co-authored-by: Christopher Fujino <fujino@google.com> Co-authored-by: Andrew Kolos <andrewrkolos@gmail.com>
flutter · May 15, 2023 · 7a5f8e9 · 7a5f8e9
1 parent 9fa53ae
commit 7a5f8e9
Show file tree

Hide file tree

Showing 51 changed files with 1,363 additions and 183 deletions.
diff --git a/dev/integration_tests/android_custom_host_app/gradle/wrapper/gradle-wrapper.properties b/dev/integration_tests/android_custom_host_app/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-all.zip
diff --git a/...on_tests/android_embedding_v2_smoke_test/android/gradle/wrapper/gradle-wrapper.properties b/...on_tests/android_embedding_v2_smoke_test/android/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-all.zip
diff --git a/dev/integration_tests/android_host_app_v2_embedding/gradle/wrapper/gradle-wrapper.properties b/dev/integration_tests/android_host_app_v2_embedding/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-all.zip
diff --git a/...egration_tests/android_semantics_testing/android/gradle/wrapper/gradle-wrapper.properties b/...egration_tests/android_semantics_testing/android/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-all.zip
diff --git a/dev/integration_tests/android_views/android/gradle/wrapper/gradle-wrapper.properties b/dev/integration_tests/android_views/android/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-all.zip
diff --git a/dev/integration_tests/external_ui/android/gradle/wrapper/gradle-wrapper.properties b/dev/integration_tests/external_ui/android/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-all.zip
diff --git a/...gration_tests/gradle_deprecated_settings/android/gradle/wrapper/gradle-wrapper.properties b/...gration_tests/gradle_deprecated_settings/android/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-all.zip
diff --git a/dev/integration_tests/hybrid_android_views/android/gradle/wrapper/gradle-wrapper.properties b/dev/integration_tests/hybrid_android_views/android/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-all.zip
diff --git a/...tests/module_host_with_custom_build_v2_embedding/gradle/wrapper/gradle-wrapper.properties b/...tests/module_host_with_custom_build_v2_embedding/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-all.zip
diff --git a/dev/integration_tests/non_nullable/android/gradle/wrapper/gradle-wrapper.properties b/dev/integration_tests/non_nullable/android/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-all.zip
diff --git a/dev/integration_tests/platform_interaction/android/gradle/wrapper/gradle-wrapper.properties b/dev/integration_tests/platform_interaction/android/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-all.zip
diff --git a/dev/integration_tests/release_smoke_test/android/gradle/wrapper/gradle-wrapper.properties b/dev/integration_tests/release_smoke_test/android/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-all.zip
diff --git a/dev/manual_tests/android/gradle/wrapper/gradle-wrapper.properties b/dev/manual_tests/android/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-all.zip
diff --git a/dev/tracing_tests/android/gradle/wrapper/gradle-wrapper.properties b/dev/tracing_tests/android/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-all.zip
diff --git a/packages/flutter_tools/gradle/flutter.gradle b/packages/flutter_tools/gradle/flutter.gradle
@@ -678,6 +678,45 @@ class FlutterPlugin implements Plugin<Project> {
         project.dependencies.add(configuration, dependency, config)
     }
 
+    // Add a task that can be called on flutter projects that prints the java version used in gradle.
+    //
+    // Format of the output of this task can be used in debugging what version of java gradle is using.
+    // Not recomended for use in time sensitive commands like `flutter run` or `flutter build` as
+    // gradle is slower than we want. Particularly in light of https://github.com/flutter/flutter/issues/119196.
+    //
+    private static void addTaskForJavaVersion(Project project) {
+        // Warning: the name of this task is used by other code. Change with caution.
+        project.tasks.register('javaVersion') {
+            description 'Print the current java version used by gradle. '
+                'see: https://docs.gradle.org/current/javadoc/org/gradle/api/JavaVersion.html'
+            doLast {
+                println(JavaVersion.current())
+            }
+        }
+    }
+
+    // Add a task that can be called on flutter projects that prints the available build variants
+    // in gradle.
+    //
+    // This task prints variants in this format:
+    //
+    // BuildVariant: debug
+    // BuildVariant: release
+    // BuildVariant: profile
+    //
+    // Format of the output of this task is used by `AndroidProject.getBuildVariants`.
+    private static void addTaskForPrintBuildVariants(Project project) {
+        // Warning: The name of this task is used by `AndroidProject.getBuildVariants`.
+        project.tasks.register("printBuildVariants") {
+            description "Prints out all build variants for this Android project"
+            doLast {
+                project.android.applicationVariants.all { variant ->
+                    println "BuildVariant: ${variant.name}";
+                }
+            }
+        }
+    }
+
     /**
      * Returns a Flutter build mode suitable for the specified Android buildType.
      *
@@ -850,6 +889,9 @@ class FlutterPlugin implements Plugin<Project> {
         if (project.hasProperty('validate-deferred-components')) {
             validateDeferredComponentsValue = project.property('validate-deferred-components').toBoolean()
         }
+
+        addTaskForJavaVersion(project)
+        addTaskForPrintBuildVariants(project)
         def targetPlatforms = getTargetPlatforms()
         def addFlutterDeps = { variant ->
             if (shouldSplitPerAbi()) {

diff --git a/packages/flutter_tools/lib/src/android/android_builder.dart b/packages/flutter_tools/lib/src/android/android_builder.dart
@@ -39,4 +39,7 @@ abstract class AndroidBuilder {
     bool deferredComponentsEnabled = false,
     bool configOnly = false,
   });
+
+  /// Returns a list of available build variant from the Android project.
+  Future<List<String>> getBuildVariants({required FlutterProject project});
 }
diff --git a/packages/flutter_tools/lib/src/android/android_sdk.dart b/packages/flutter_tools/lib/src/android/android_sdk.dart
@@ -40,7 +40,7 @@ class AndroidSdk {
     reinitialize();
   }
 
-  static const String _javaHomeEnvironmentVariable = 'JAVA_HOME';
+  static const String javaHomeEnvironmentVariable = 'JAVA_HOME';
   static const String _javaExecutable = 'java';
 
   /// The Android SDK root directory.
@@ -462,10 +462,44 @@ class AndroidSdk {
     return versionString.split('_').first;
   }
 
-  /// Finds the java binary that is used for all operations across the tool.
+  /// A value that would be appropriate to use as JAVA_HOME.
   ///
-  /// First try Java bundled with Android Studio, then sniff JAVA_HOME, then fallback to PATH.
+  /// This method considers jdk in the following order:
+  /// * the JDK bundled with Android Studio, if one is found;
+  /// * the JAVA_HOME in the ambient environment, if set;
+  String? get javaHome {
+    return findJavaHome(
+      androidStudio: globals.androidStudio,
+      fileSystem: globals.fs,
+      operatingSystemUtils: globals.os,
+      platform: globals.platform,
+    );
+  }
+
+
+  static String? findJavaHome({
+    required AndroidStudio? androidStudio,
+    required FileSystem fileSystem,
+    required OperatingSystemUtils operatingSystemUtils,
+    required Platform platform,
+  }) {
+    if (androidStudio?.javaPath != null) {
+      globals.printTrace("Using Android Studio's java.");
+      return androidStudio!.javaPath!;
+    }
+
+    final String? javaHomeEnv = platform.environment[javaHomeEnvironmentVariable];
+    if (javaHomeEnv != null) {
+      globals.printTrace('Using JAVA_HOME from environment valuables.');
+      return javaHomeEnv;
+    }
+    return null;
+  }
+
+  /// Finds the java binary that is used for all operations across the tool.
   ///
+  /// This comes from [findJavaHome] if that method returns non-null;
+  /// otherwise, it gets from searching PATH.
   // TODO(andrewkolos): To prevent confusion when debugging Android-related
   // issues (see https://github.com/flutter/flutter/issues/122609 for an example),
   // this logic should be consistently followed by any Java-dependent operation
@@ -479,17 +513,15 @@ class AndroidSdk {
     required OperatingSystemUtils operatingSystemUtils,
     required Platform platform,
   }) {
-    if (androidStudio?.javaPath != null) {
-      globals.printTrace("Using Android Studio's java.");
-      return fileSystem.path.join(androidStudio!.javaPath!, 'bin', 'java');
-    }
+    final String? javaHome = findJavaHome(
+      androidStudio: androidStudio,
+      fileSystem: fileSystem,
+      operatingSystemUtils: operatingSystemUtils,
+      platform: platform,
+    );
 
-    final String? javaHomeEnv =
-        platform.environment[_javaHomeEnvironmentVariable];
-    if (javaHomeEnv != null) {
-      // Trust JAVA_HOME.
-      globals.printTrace('Using JAVA_HOME.');
-      return fileSystem.path.join(javaHomeEnv, 'bin', 'java');
+    if (javaHome != null) {
+      return fileSystem.path.join(javaHome, 'bin', 'java');
     }
 
     // Fallback to PATH based lookup.
@@ -528,8 +560,8 @@ class AndroidSdk {
       );
       if (javaBinary != null && globals.platform.environment['PATH'] != null) {
         _sdkManagerEnv!['PATH'] = globals.fs.path.dirname(javaBinary) +
-                                 globals.os.pathVarSeparator +
-                                 globals.platform.environment['PATH']!;
+                                  globals.os.pathVarSeparator +
+                                  globals.platform.environment['PATH']!;
       }
     }
     return _sdkManagerEnv!;