Skip to content

Commit d8f869e

Browse files
Address review: share task registration stubs in FlutterPluginTest
Add stubTaskRegistration, captureTaskConfiguration and setCommandLineTasks, and use them in the add-to-app onVariants tests.
1 parent 2efbd34 commit d8f869e

1 file changed

Lines changed: 39 additions & 37 deletions

File tree

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

Lines changed: 39 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -226,26 +226,18 @@ class FlutterPluginTest {
226226
) {
227227
val env = setupTestProjectEnvironment(tempDir)
228228
val project = env.project
229-
val mockCompileTaskProvider = mockk<TaskProvider<FlutterTask>>(relaxed = true)
230-
every {
231-
project.tasks.register("compileFlutterBuildDebug", FlutterTask::class.java, any())
232-
} returns mockCompileTaskProvider
229+
val compileTaskProvider = project.stubTaskRegistration<FlutterTask>("compileFlutterBuildDebug")
233230
val compileOutputSlot = slot<Transformer<File, FlutterTask>>()
234231
val compileOutput = mockk<Provider<File>>()
235-
every { mockCompileTaskProvider.map(capture(compileOutputSlot)) } returns compileOutput
232+
every { compileTaskProvider.map(capture(compileOutputSlot)) } returns compileOutput
236233
val compileOutputDir = mockk<Provider<Directory>>()
237234
every { project.layout.dir(compileOutput) } returns compileOutputDir
238-
val jniLibsActionSlot = slot<Action<CopyFlutterJniLibsTask>>()
239-
every {
240-
project.tasks.register("copyJniLibsflutterBuildDebug", CopyFlutterJniLibsTask::class.java, capture(jniLibsActionSlot))
241-
} returns mockk(relaxed = true)
235+
val configureJniLibsTask = project.captureTaskConfiguration<CopyFlutterJniLibsTask>("copyJniLibsflutterBuildDebug")
242236

243-
val onVariant = applyPluginCapturingVariantCallback(env)
244-
onVariant(mockApplicationVariant())
245-
val mockJniLibsTask = mockk<CopyFlutterJniLibsTask>(relaxed = true)
246-
jniLibsActionSlot.captured.execute(mockJniLibsTask)
237+
applyPluginCapturingVariantCallback(env)(mockApplicationVariant())
238+
val jniLibsTask = configureJniLibsTask()
247239

248-
verify { mockJniLibsTask.intermediateDir.set(compileOutputDir) }
240+
verify { jniLibsTask.intermediateDir.set(compileOutputDir) }
249241
val compileTask = mockk<FlutterTask>()
250242
val outputDirectory = File("build/intermediates/flutter/debug")
251243
every { compileTask.outputDirectory } returns outputDirectory
@@ -263,25 +255,20 @@ class FlutterPluginTest {
263255
val env = setupTestProjectEnvironment(tempDir)
264256
val project = env.project
265257
// A host task, whose name matches none of the module's variant names.
266-
every { project.gradle.startParameter.taskNames } returns listOf(":app:assembleDemoStaging")
267-
val mockCopyAssetsTaskProvider = mockk<TaskProvider<CopyFlutterAssetsTask>>(relaxed = true)
268-
every {
269-
project.tasks.register("copyFlutterAssetsDebug", CopyFlutterAssetsTask::class.java, any())
270-
} returns mockCopyAssetsTaskProvider
271-
val mockCopyJniLibsTaskProvider = mockk<TaskProvider<CopyFlutterJniLibsTask>>(relaxed = true)
272-
every {
273-
project.tasks.register("copyJniLibsflutterBuildDebug", CopyFlutterJniLibsTask::class.java, any())
274-
} returns mockCopyJniLibsTaskProvider
258+
project.setCommandLineTasks(":app:assembleDemoStaging")
259+
val copyAssetsTaskProvider = project.stubTaskRegistration<CopyFlutterAssetsTask>("copyFlutterAssetsDebug")
260+
val copyJniLibsTaskProvider = project.stubTaskRegistration<CopyFlutterJniLibsTask>("copyJniLibsflutterBuildDebug")
275261
val assetsSource = mockk<SourceDirectories.Layered>(relaxed = true)
276262
val jniLibsSource = mockk<SourceDirectories.Layered>(relaxed = true)
277263

278-
val onVariant = applyPluginToModuleCapturingVariantCallback(env)
279-
onVariant(mockLibraryVariant(assetsSource = assetsSource, jniLibsSource = jniLibsSource))
264+
applyPluginToModuleCapturingVariantCallback(env)(
265+
mockLibraryVariant(assetsSource = assetsSource, jniLibsSource = jniLibsSource)
266+
)
280267

281268
val taskContainer = project.tasks
282269
verify { taskContainer.register("compileFlutterBuildDebug", FlutterTask::class.java, any()) }
283-
verify { assetsSource.addGeneratedSourceDirectory(mockCopyAssetsTaskProvider, CopyFlutterAssetsTask::destinationDir) }
284-
verify { jniLibsSource.addGeneratedSourceDirectory(mockCopyJniLibsTaskProvider, CopyFlutterJniLibsTask::destinationDir) }
270+
verify { assetsSource.addGeneratedSourceDirectory(copyAssetsTaskProvider, CopyFlutterAssetsTask::destinationDir) }
271+
verify { jniLibsSource.addGeneratedSourceDirectory(copyJniLibsTaskProvider, CopyFlutterJniLibsTask::destinationDir) }
285272
verify(exactly = 0) { taskContainer.register(any(), CopyFlutterApksTask::class.java, any()) }
286273
verify(exactly = 0) { taskContainer.configureEach(any<Action<in Task>>()) }
287274
}
@@ -291,14 +278,9 @@ class FlutterPluginTest {
291278
@TempDir tempDir: Path
292279
) {
293280
val env = setupTestProjectEnvironment(tempDir)
294-
val project = env.project
295-
val compileActionSlots =
281+
val configureCompileTasks =
296282
listOf("Debug", "Profile", "Release").associateWith { variantName ->
297-
val actionSlot = slot<Action<FlutterTask>>()
298-
every {
299-
project.tasks.register("compileFlutterBuild$variantName", FlutterTask::class.java, capture(actionSlot))
300-
} returns mockk(relaxed = true)
301-
actionSlot
283+
env.project.captureTaskConfiguration<FlutterTask>("compileFlutterBuild$variantName")
302284
}
303285

304286
val onVariant = applyPluginToModuleCapturingVariantCallback(env)
@@ -308,9 +290,8 @@ class FlutterPluginTest {
308290
onVariant(mockLibraryVariant(name = "release", buildType = "release", debuggable = false))
309291

310292
val buildModes =
311-
compileActionSlots.mapValues { (_, actionSlot) ->
312-
val task = mockk<FlutterTask>(relaxed = true)
313-
actionSlot.captured.execute(task)
293+
configureCompileTasks.mapValues { (_, configureCompileTask) ->
294+
val task = configureCompileTask()
314295
val buildModeSlot = slot<String>()
315296
verify { task.buildMode = capture(buildModeSlot) }
316297
buildModeSlot.captured
@@ -711,6 +692,27 @@ class FlutterPluginTest {
711692
val versionCode: Property<Int>
712693
)
713694

695+
/** Stubs registering task [name] to return a relaxed provider, which is returned. */
696+
private inline fun <reified T : Task> Project.stubTaskRegistration(name: String): TaskProvider<T> {
697+
val provider = mockk<TaskProvider<T>>(relaxed = true)
698+
every { tasks.register(name, T::class.java, any()) } returns provider
699+
return provider
700+
}
701+
702+
/**
703+
* Captures the configuration action registered for task [name]. The returned function runs
704+
* that action on a relaxed mock task and returns the task, for verifying what it set.
705+
*/
706+
private inline fun <reified T : Task> Project.captureTaskConfiguration(name: String): () -> T {
707+
val action = slot<Action<T>>()
708+
every { tasks.register(name, T::class.java, capture(action)) } returns mockk(relaxed = true)
709+
return { mockk<T>(relaxed = true).also { action.captured.execute(it) } }
710+
}
711+
712+
private fun Project.setCommandLineTasks(vararg taskNames: String) {
713+
every { gradle.startParameter.taskNames } returns taskNames.toList()
714+
}
715+
714716
/**
715717
* A [VariantOutput] with an ABI filter for [abi] (none if null). Only `set` is stubbed on its
716718
* versionCode, so any read fails the test, as AGP's strict mode would.

0 commit comments

Comments
 (0)