Skip to content

Commit dd2d0ff

Browse files
authored
Custom KGP task and migration to AGP api for geting kgp version (#182788)
Create a unified `PrintTask` that uses a standard Gradle `Property<String>` to lazily hold and print a message. Modify `javaVersion`, `kgpVersion`, and `printBuildVariants` to use this new unified task. Modify existing tests in `FlutterPluginTest` and `FlutterPluginUtilsTest` to mock the newly required task registration and provide data. Add new unit tests in `PrintTaskTest.kt` to cover the `PrintTask` behavior under both simple string and lazy mapped provider usages. KgpVersion is migrated to use the *internal* AGP api for getting kgp version. Related to #180137 Format command that can be run from package_tools/gradle on only files that are staged for commit. `ktlint --editorconfig=../../../dev/bots/test/analyze-test-input/.editorconfig --baseline=../../../dev/bots/test/analyze-test-input/ktlint-baseline.xml $(git diff --name-only --cached| grep \.kt | sed 's/packages\/flutter_tools\/gradle\///g') --format` ## 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] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing.
1 parent e58da08 commit dd2d0ff

11 files changed

Lines changed: 179 additions & 55 deletions

File tree

‎packages/flutter_tools/gradle/build.gradle.kts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ tasks.withType<JavaCompile> {
4141
tasks.test {
4242
useJUnitPlatform()
4343
}
44+
4445
// https://stackoverflow.com/questions/55456176/unresolved-reference-compilekotlin-in-build-gradle-kts
4546
tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
4647
compilerOptions {

‎packages/flutter_tools/gradle/src/main/kotlin/FlutterPluginUtils.kt‎

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@ import com.android.build.gradle.BaseExtension
1212
import com.android.builder.model.BuildType
1313
import com.flutter.gradle.plugins.PluginHandler
1414
import com.flutter.gradle.tasks.DeepLinkJsonFromManifestTask
15+
import com.flutter.gradle.tasks.PrintTask
1516
import com.flutter.gradle.tasks.ValidateCompileSdkVersionTask
1617
import groovy.lang.Closure
1718
import org.gradle.api.GradleException
1819
import org.gradle.api.Project
1920
import org.gradle.api.Task
2021
import org.gradle.api.UnknownTaskException
2122
import org.gradle.api.logging.Logger
23+
import org.gradle.kotlin.dsl.register
2224
import java.io.File
2325
import java.nio.charset.StandardCharsets
2426
import java.util.Properties
@@ -796,12 +798,10 @@ object FlutterPluginUtils {
796798
@JvmStatic
797799
@JvmName("addTaskForJavaVersion")
798800
internal fun addTaskForJavaVersion(project: Project) {
799-
project.tasks.register("javaVersion") {
801+
project.tasks.register("javaVersion", PrintTask::class.java) {
800802
description = "Print the current java version used by gradle. see: " +
801803
"https://docs.gradle.org/current/javadoc/org/gradle/api/JavaVersion.html"
802-
doLast {
803-
println(VersionFetcher.getJavaVersion())
804-
}
804+
message.set(VersionFetcher.getJavaVersion().toString())
805805
}
806806
}
807807

@@ -815,11 +815,10 @@ object FlutterPluginUtils {
815815
@JvmStatic
816816
@JvmName("addTaskForKGPVersion")
817817
internal fun addTaskForKGPVersion(project: Project) {
818-
project.tasks.register("kgpVersion") {
818+
project.tasks.register("kgpVersion", PrintTask::class.java) {
819819
description = "Print the current kgp version used by the project."
820-
doLast {
821-
println("KGP Version: " + VersionFetcher.getKGPVersion(project).toString())
822-
}
820+
val version = VersionFetcher.getKGPVersion(project)?.toString() ?: "null"
821+
message.set("KGP Version: $version")
823822
}
824823
}
825824

@@ -837,19 +836,16 @@ object FlutterPluginUtils {
837836
@JvmName("addTaskForPrintBuildVariants")
838837
internal fun addTaskForPrintBuildVariants(project: Project) {
839838
val androidComponents = project.extensions.getByType(AndroidComponentsExtension::class.java)
840-
val variantNames = project.objects.listProperty(String::class.java)
839+
val variantsList = project.objects.listProperty(String::class.java)
841840

841+
// Collect variant names during configuration phase to avoid lifecycle violations
842842
androidComponents.onVariants { variant ->
843-
variantNames.add(variant.name)
843+
variantsList.add(variant.name)
844844
}
845845

846-
project.tasks.register("printBuildVariants") {
846+
project.tasks.register("printBuildVariants", PrintTask::class.java) {
847847
description = "Prints out all build variants for this Android project"
848-
doLast {
849-
variantNames.get().forEach { name ->
850-
println("BuildVariant: $name")
851-
}
852-
}
848+
message.set(variantsList.map { list -> list.joinToString("\n") { name -> "BuildVariant: $name" } })
853849
}
854850
}
855851

‎packages/flutter_tools/gradle/src/main/kotlin/VersionFetcher.kt‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ package com.flutter.gradle
66

77
import com.android.build.api.AndroidPluginVersion
88
import com.android.build.api.variant.AndroidComponentsExtension
9+
import com.android.build.gradle.internal.utils.getKotlinAndroidPluginVersion
910
import org.gradle.api.JavaVersion
1011
import org.gradle.api.Project
1112
import org.jetbrains.kotlin.gradle.plugin.KotlinAndroidPluginWrapper
@@ -44,9 +45,16 @@ internal object VersionFetcher {
4445
* Returns the version of the Kotlin Gradle plugin.
4546
*/
4647
internal fun getKGPVersion(project: Project): Version? {
47-
// TODO(gmackall): AGP has a getKotlinAndroidPluginVersion(), and KGP has a
48-
// getKotlinPluginVersion(). Consider replacing this implementation with one of
49-
// those.
48+
// AGP and Kgp have methods for getting kotlin version.
49+
// AGP's method is internal, we try to use it anyway.
50+
// KGP's version in org.jetbrains.kotlin.gradle.plugin.DefaultKotlinBasePlugin is not
51+
// available when this method is called.
52+
// When testing call `setAgpKotlinVersionToNull(project)`.
53+
val agpDefinedKgpVersion = getKotlinAndroidPluginVersion(project)
54+
if (agpDefinedKgpVersion != null && agpDefinedKgpVersion != "unknown") {
55+
return Version.fromString(agpDefinedKgpVersion)
56+
}
57+
5058
val kotlinVersionProperty = "kotlin_version"
5159
val firstKotlinVersionFieldName = "pluginVersion"
5260
val secondKotlinVersionFieldName = "kotlinPluginVersion"
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Copyright 2014 The Flutter Authors. All rights reserved.
2+
// Use of this source code is governed by a BSD-style license that can be
3+
// found in the LICENSE file.
4+
5+
package com.flutter.gradle.tasks
6+
7+
import org.gradle.api.DefaultTask
8+
import org.gradle.api.provider.Property
9+
import org.gradle.api.tasks.Input
10+
import org.gradle.api.tasks.TaskAction
11+
12+
/** Prints a message computed lazily, before the task action runs. */
13+
abstract class PrintTask : DefaultTask() {
14+
@get:Input
15+
abstract val message: Property<String>
16+
17+
@TaskAction
18+
fun run() = println(message.get())
19+
}

‎packages/flutter_tools/gradle/src/test/kotlin/DependencyVersionCheckerTest.kt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ import com.flutter.gradle.DependencyVersionChecker.warnAGPVersion
3030
import com.flutter.gradle.DependencyVersionChecker.warnGradleVersion
3131
import com.flutter.gradle.DependencyVersionChecker.warnKGPVersion
3232
import com.flutter.gradle.DependencyVersionChecker.warnMinSdkVersion
33+
import com.flutter.gradle.testing.setAgpKotlinVersionToNull
3334
import io.mockk.every
3435
import io.mockk.mockk
3536
import io.mockk.mockkStatic
@@ -500,6 +501,7 @@ private object MockProjectFactory {
500501
}
501502
return@answers Unit
502503
}
504+
setAgpKotlinVersionToNull(mockProject)
503505

504506
return mockProject
505507
}

‎packages/flutter_tools/gradle/src/test/kotlin/FlutterPluginTest.kt‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import com.android.build.gradle.internal.core.InternalBaseVariant
1313
import com.android.build.gradle.tasks.MergeSourceSetFolders
1414
import com.android.build.gradle.tasks.ProcessAndroidResources
1515
import com.flutter.gradle.tasks.FlutterTask
16+
import com.flutter.gradle.tasks.PrintTask
1617
import io.mockk.every
1718
import io.mockk.mockk
1819
import io.mockk.mockkObject
@@ -31,6 +32,7 @@ import org.junit.jupiter.api.io.TempDir
3132
import java.nio.file.Path
3233
import kotlin.io.path.writeText
3334
import kotlin.test.Test
35+
import kotlin.test.assertContains
3436

3537
class FlutterPluginTest {
3638
@Test
@@ -120,8 +122,14 @@ class FlutterPluginTest {
120122
flutterPlugin.apply(project)
121123

122124
verify { project.tasks.register("generateLockfiles", any()) }
123-
verify { project.tasks.register("javaVersion", any()) }
124-
verify { project.tasks.register("printBuildVariants", any()) }
125+
val registeredPrintTasks = mutableListOf<String>()
126+
verify {
127+
project.tasks.register(capture(registeredPrintTasks), PrintTask::class.java, any())
128+
}
129+
130+
assertContains(registeredPrintTasks, "javaVersion")
131+
assertContains(registeredPrintTasks, "kgpVersion")
132+
assertContains(registeredPrintTasks, "printBuildVariants")
125133
}
126134

127135
@Test

‎packages/flutter_tools/gradle/src/test/kotlin/FlutterPluginUtilsTest.kt‎

Lines changed: 41 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ import com.flutter.gradle.FlutterPluginUtils.BUILT_IN_KOTLIN_DOCS_FOR_PLUGINS
1818
import com.flutter.gradle.FlutterPluginUtils.BUILT_IN_KOTLIN_DOCS_TO_REPORT_UNMIGRATED_PLUGINS
1919
import com.flutter.gradle.FlutterPluginUtils.detectApplyingKotlinGradlePlugin
2020
import com.flutter.gradle.plugins.PluginHandler
21+
import com.flutter.gradle.tasks.PrintTask
2122
import io.mockk.called
2223
import io.mockk.every
2324
import io.mockk.mockk
@@ -34,8 +35,8 @@ import org.gradle.api.file.DirectoryProperty
3435
import org.gradle.api.invocation.Gradle
3536
import org.gradle.api.logging.Logger
3637
import org.gradle.api.plugins.PluginManager
37-
import org.gradle.internal.impldep.junit.framework.TestCase.assertFalse
38-
import org.gradle.internal.impldep.junit.framework.TestCase.assertTrue
38+
import org.gradle.api.tasks.TaskContainer
39+
import org.gradle.api.tasks.TaskProvider
3940
import org.jetbrains.kotlin.gradle.plugin.extraProperties
4041
import org.junit.jupiter.api.Nested
4142
import org.junit.jupiter.api.assertThrows
@@ -47,6 +48,7 @@ import kotlin.test.Test
4748
import kotlin.test.assertContains
4849
import kotlin.test.assertEquals
4950
import kotlin.test.assertFalse
51+
import kotlin.test.assertTrue
5052

5153
class FlutterPluginUtilsTest {
5254
companion object {
@@ -1784,40 +1786,46 @@ class FlutterPluginUtilsTest {
17841786
}
17851787
}
17861788

1787-
// addTaskForJavaVersion
17881789
@Test
17891790
fun `addTaskForJavaVersion adds task for Java version`() {
17901791
val project = mockk<Project>()
1791-
every { project.tasks.register(any(), any<Action<Task>>()) } returns mockk()
1792-
val captureSlot = slot<Action<Task>>()
1792+
every { project.tasks.register(any(), eq(PrintTask::class.java), any()) } returns mockk()
1793+
val captureSlot = slot<Action<PrintTask>>()
1794+
17931795
FlutterPluginUtils.addTaskForJavaVersion(project)
1794-
verify { project.tasks.register("javaVersion", capture(captureSlot)) }
1796+
verify { project.tasks.register("javaVersion", eq(PrintTask::class.java), capture(captureSlot)) }
1797+
1798+
val mockPrintTask = mockk<PrintTask>(relaxed = true)
1799+
captureSlot.captured.execute(mockPrintTask)
17951800

1796-
val mockTask = mockk<Task>()
1797-
every { mockTask.description = any() } returns Unit
1798-
every { mockTask.doLast(any<Action<Task>>()) } returns mockk()
1799-
captureSlot.captured.execute(mockTask)
18001801
verify {
1801-
mockTask.description = "Print the current java version used by gradle. see: " +
1802+
mockPrintTask.description = "Print the current java version used by gradle. see: " +
18021803
"https://docs.gradle.org/current/javadoc/org/gradle/api/JavaVersion.html"
18031804
}
18041805
}
18051806

18061807
// addTaskForKGPVersion
18071808
@Test
18081809
fun `addTaskForKGPVersion adds task for KGP version`() {
1809-
val project = mockk<Project>()
1810-
every { project.tasks.register(any(), any<Action<Task>>()) } returns mockk()
1811-
val captureSlot = slot<Action<Task>>()
1812-
FlutterPluginUtils.addTaskForKGPVersion(project)
1813-
verify { project.tasks.register("kgpVersion", capture(captureSlot)) }
1814-
1815-
val mockTask = mockk<Task>()
1816-
every { mockTask.description = any() } returns Unit
1817-
every { mockTask.doLast(any<Action<Task>>()) } returns mockk()
1818-
captureSlot.captured.execute(mockTask)
1819-
verify {
1820-
mockTask.description = "Print the current kgp version used by the project."
1810+
val project = mockk<Project>(relaxed = true)
1811+
every { project.tasks.register(any(), eq(PrintTask::class.java), any()) } returns mockk()
1812+
val captureSlot = slot<Action<PrintTask>>()
1813+
1814+
mockkObject(VersionFetcher)
1815+
every { VersionFetcher.getKGPVersion(project) } returns Version(2, 2, 0)
1816+
1817+
try {
1818+
FlutterPluginUtils.addTaskForKGPVersion(project)
1819+
verify { project.tasks.register("kgpVersion", eq(PrintTask::class.java), capture(captureSlot)) }
1820+
1821+
val mockPrintTask = mockk<PrintTask>(relaxed = true)
1822+
captureSlot.captured.execute(mockPrintTask)
1823+
1824+
verify {
1825+
mockPrintTask.description = "Print the current kgp version used by the project."
1826+
}
1827+
} finally {
1828+
io.mockk.unmockkObject(VersionFetcher)
18211829
}
18221830
}
18231831

@@ -1826,23 +1834,23 @@ class FlutterPluginUtilsTest {
18261834
fun `addTaskForPrintBuildVariants adds task for printing build variants`() {
18271835
val project = mockk<Project>()
18281836
val androidComponents = mockk<AndroidComponentsExtension<*, *, *>>(relaxed = true)
1829-
val listProperty = mockk<org.gradle.api.provider.ListProperty<String>>()
1837+
val listProperty = mockk<org.gradle.api.provider.ListProperty<String>>(relaxed = true)
1838+
1839+
every { project.extensions } returns mockk()
18301840
every { project.extensions.getByType(AndroidComponentsExtension::class.java) } returns androidComponents
18311841
every { project.objects.listProperty(String::class.java) } returns listProperty
1832-
every { project.tasks.register(any(), any<Action<Task>>()) } returns mockk()
1833-
val captureSlot = slot<Action<Task>>()
1842+
every { project.tasks.register(any(), eq(PrintTask::class.java), any()) } returns mockk()
18341843

1835-
FlutterPluginUtils.addTaskForPrintBuildVariants(project)
1844+
val captureSlot = slot<Action<PrintTask>>()
18361845

1837-
verify { project.tasks.register("printBuildVariants", capture(captureSlot)) }
1838-
val mockTask = mockk<Task>()
1839-
every { mockTask.description = any() } returns Unit
1840-
every { mockTask.doLast(any<Action<Task>>()) } returns mockk()
1846+
FlutterPluginUtils.addTaskForPrintBuildVariants(project)
1847+
verify { project.tasks.register("printBuildVariants", eq(PrintTask::class.java), capture(captureSlot)) }
18411848

1842-
captureSlot.captured.execute(mockTask)
1849+
val mockPrintTask = mockk<PrintTask>(relaxed = true)
1850+
captureSlot.captured.execute(mockPrintTask)
18431851

18441852
verify {
1845-
mockTask.description = "Prints out all build variants for this Android project"
1853+
mockPrintTask.description = "Prints out all build variants for this Android project"
18461854
}
18471855
}
18481856
}

‎packages/flutter_tools/gradle/src/test/kotlin/VersionFetcherTest.kt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ package com.flutter.gradle
66

77
import com.android.build.api.AndroidPluginVersion
88
import com.android.build.api.variant.AndroidComponentsExtension
9+
import com.flutter.gradle.testing.setAgpKotlinVersionToNull
910
import io.mockk.every
1011
import io.mockk.mockk
1112
import org.gradle.api.Project
@@ -46,6 +47,7 @@ class VersionFetcherTest {
4647
fun `getKGPVersion returns version when kotlin_version is set`() {
4748
val kgpVersion = Version(1, 9, 20)
4849
val project = mockk<Project>()
50+
setAgpKotlinVersionToNull(project)
4951
every { project.hasProperty(eq("kotlin_version")) } returns true
5052
every { project.properties["kotlin_version"] } returns kgpVersion.toString()
5153
val result = VersionFetcher.getKGPVersion(project)
@@ -56,6 +58,7 @@ class VersionFetcherTest {
5658
fun `getKGPVersion returns version from KotlinAndroidPluginWrapper`() {
5759
val kgpVersion = Version(1, 9, 20)
5860
val project = mockk<Project>()
61+
setAgpKotlinVersionToNull(project)
5962
every { project.hasProperty(eq("kotlin_version")) } returns false
6063
every { project.plugins.findPlugin(KotlinAndroidPluginWrapper::class.java) } returns
6164
mockk<KotlinAndroidPluginWrapper> {
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
// Copyright 2014 The Flutter Authors. All rights reserved.
2+
// Use of this source code is governed by a BSD-style license that can be
3+
// found in the LICENSE file.
4+
5+
package com.flutter.gradle.tasks
6+
7+
import org.gradle.api.Project
8+
import org.gradle.testfixtures.ProjectBuilder
9+
import org.junit.jupiter.api.AfterEach
10+
import org.junit.jupiter.api.BeforeEach
11+
import org.junit.jupiter.api.Test
12+
import java.io.ByteArrayOutputStream
13+
import java.io.PrintStream
14+
import kotlin.test.assertEquals
15+
16+
class PrintTaskTest {
17+
private val standardOut = System.out
18+
private val outputStreamCaptor = ByteArrayOutputStream()
19+
private lateinit var project: Project
20+
21+
@BeforeEach
22+
fun setUp() {
23+
System.setOut(PrintStream(outputStreamCaptor))
24+
project = ProjectBuilder.builder().build()
25+
}
26+
27+
@AfterEach
28+
fun tearDown() {
29+
System.setOut(standardOut)
30+
}
31+
32+
@Test
33+
fun `PrintTask prints simple string value`() {
34+
val task = project.tasks.create("printJavaVersion", PrintTask::class.java)
35+
task.message.set("17.0.1")
36+
37+
task.run()
38+
39+
assertEquals("17.0.1", outputStreamCaptor.toString().trim())
40+
}
41+
42+
@Test
43+
fun `PrintTask prints mapped list property like build variants`() {
44+
val task = project.tasks.create("printVariants", PrintTask::class.java)
45+
val variantsList = project.objects.listProperty(String::class.java)
46+
variantsList.add("debug")
47+
variantsList.add("release")
48+
49+
task.message.set(
50+
variantsList.map { list -> list.joinToString("\n") { name -> "BuildVariant: $name" } }
51+
)
52+
53+
task.run()
54+
55+
assertEquals("BuildVariant: debug\nBuildVariant: release", outputStreamCaptor.toString().trim())
56+
}
57+
}

0 commit comments

Comments
 (0)