• Reid Baker's avatar
    Add Java-Gradle-AGP validation to flutter analyze (#123916) · 2383400f
    Reid Baker authored
    https://github.com/flutter/flutter/issues/123917
    
    Doc covering a broad set of issues related to android studio updating. 
    
    https://docs.google.com/document/d/1hTXkjbUrBnXgu8NQsth1c3aEqo77rWoEj8CcsQ39wwQ/edit?pli=1#
    
    Specifically this pr: 
    - Adds new functions to find a projects AGP, Gradle and java versions,
    and tests.
    - Adds new functions that take versions and parse if the versions are
    compatible with each other, and tests.
    - Adds validator for `flutter analyze --suggestions` that evaluates the
    java/gradle/agp versions and checks if they are compatible, and
    integration test.
    - Updates the version of gradle used by
    dev/integration_tests/flutter_gallery/ to the minimum supported by java
    18 so that the integration tests pass (It is unknown why the java
    version is 18.9 instead of 11)
    - Moves `isWithinVersionRange` to version.dart, and tests. 
    - Adds FakeAndroidStudio to fakes to be used in multiple tests but does
    not remove existing copies.
    
    Metrics will be included as part of the definition of done for this bug
    but not as part of this cl. It is already too big.
    
    Known work still left in this pr: 
    * Understand why analyze integration tests are failing. 
    
    
    Example output if Java and gradle are not compatible: 
    ```
    ┌───────────────────────────────────────────────────────────────────┐
    │ General Info                                                      │
    │ [✓] App Name: espresso_example                                    │
    │ [✓] Supported Platforms: android                                  │
    │ [✓] Is Flutter Package: yes                                       │
    │ [✓] Uses Material Design: yes                                     │
    │ [✓] Is Plugin: no                                                 │
    │ [✗] Java/Gradle/Android Gradle Plugin:                            │
    │                                                                   │
    │ Incompatible Java/Gradle versions.                                │
    │                                                                   │
    │ Java Version: 17.0.6, Gradle Version: 7.0.2                       │
    │                                                                   │
    │ See the link below for more information.                          │
    │ https://docs.gradle.org/current/userguide/compatibility.html#java │
    │                                                                   │
    └───────────────────────────────────────────────────────────────────┘
    ```
    Example output if Gradle and AGP are not compatible
    ```
    ┌─────────────────────────────────────────────────────────────────────────────┐
    │ General Info                                                                │
    │ [✓] App Name: espresso_example                                              │
    │ [✓] Supported Platforms: android                                            │
    │ [✓] Is Flutter Package: yes                                                 │
    │ [✓] Uses Material Design: yes                                               │
    │ [✓] Is Plugin: no                                                           │
    │ [✗] Java/Gradle/Android Gradle Plugin: Incompatible Gradle/AGP versions.    │
    │                                                                             │
    │ Gradle Version: 7.0.2, AGP Version: 7.4.2                                   │
    │                                                                             │
    │ Update gradle to at least "7.5".                                            │
    │ See the link below for more information:                                    │
    │ https://developer.android.com/studio/releases/gradle-plugin#updating-gradle │
    │                                                                             │
    │ Incompatible Java/Gradle versions.                                          │
    │                                                                             │
    │ Java Version: 17.0.6, Gradle Version: 7.0.2                                 │
    │                                                                             │
    │ See the link below for more information:                                    │
    │ https://docs.gradle.org/current/userguide/compatibility.html#java           │
    │                                                                             │
    └─────────────────────────────────────────────────────────────────────────────┘
    ```
    Example output if Java/Gradle/Agp are not compatible. 
    ```
    
    ┌─────────────────────────────────────────────────────────────────────────────┐
    │ General Info                                                                │
    │ [✓] App Name: espresso_example                                              │
    │ [✓] Supported Platforms: android                                            │
    │ [✓] Is Flutter Package: yes                                                 │
    │ [✓] Uses Material Design: yes                                               │
    │ [✓] Is Plugin: no                                                           │
    │ [✗] Java/Gradle/Android Gradle Plugin: Incompatible Gradle/AGP versions.    │
    │                                                                             │
    │ Gradle Version: 7.0.2, AGP Version: 7.4.2                                   │
    │                                                                             │
    │ Update gradle to at least "7.5".                                            │
    │ See the link below for more information:                                    │
    │ https://developer.android.com/studio/releases/gradle-plugin#updating-gradle │
    │                                                                             │
    │ Incompatible Java/Gradle versions.                                          │
    │                                                                             │
    │ Java Version: 17.0.6, Gradle Version: 7.0.2                                 │
    │                                                                             │
    │ See the link below for more information:                                    │
    │ https://docs.gradle.org/current/userguide/compatibility.html#java           │
    │                                                                             │
    └─────────────────────────────────────────────────────────────────────────────┘
    ```
    
    Commit messages
    - Add function to gradle_utils.dart that gets the gradle version from
    wrapper or system and add a test for each situation
    - Add method to get agp version, add method to validate agp against
    gradle version, update documentation, add tests for agp validation.
    - Update dart doc for validateGradleAndAgp to describe where the info
    came from and corner case behavior, create function to validate java and
    gradle and hardcode return to false
    - Fill out and test java gradle compatibility function in gradle_utils
    - Hook up java gradle evaluateion to hasValidJavaGradleAgpVersions with
    hardcoded java version
    - Add java --version output parsing and tests
    - Add getJavaBinary test
    - Update comment in android_sdk for mac behavior with java_home -v
    
    ## 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].
    - [ ] All existing and new tests are passing.
    2383400f
project_test.dart 64.5 KB