Skip to content

Commit 2deea74

Browse files
mboetgerreidbaker
andauthored
forceNdkDownload should skip configuring cmake when ndk-build is used (flutter#187201)
Fixes: flutter#175968 ## Pre-launch Checklist - [X] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [X] I read the [AI contribution guidelines] and understand my responsibilities, or I am not using AI tools. - [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. --------- Co-authored-by: Reid Baker <[email protected]>
1 parent c3f6236 commit 2deea74

2 files changed

Lines changed: 87 additions & 2 deletions

File tree

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -795,8 +795,10 @@ object FlutterPluginUtils {
795795

796796
// If the project is already configuring a native build, we don't need to do anything.
797797
val gradleProjectAndroidExtension = getLegacyAndroidExtension(gradleProject)
798+
val externalNativeBuild = gradleProjectAndroidExtension.externalNativeBuild
798799
val forcingNotRequired: Boolean =
799-
gradleProjectAndroidExtension.externalNativeBuild.cmake.path != null
800+
externalNativeBuild?.cmake?.path != null ||
801+
externalNativeBuild?.ndkBuild?.path != null
800802
if (forcingNotRequired) {
801803
return
802804
}

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

Lines changed: 84 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1875,16 +1875,23 @@ class FlutterPluginUtilsTest {
18751875
fakeCmakeFile.createNewFile()
18761876
val project = mockk<Project>()
18771877
val mockCmakeOptions = mockk<CmakeOptions>()
1878+
val mockNdkBuildOptions = mockk<com.android.build.gradle.internal.dsl.NdkBuildOptions>()
18781879
val mockDefaultConfig = mockk<DefaultConfig>()
18791880
every { project.extensions.findByType(ApplicationExtension::class.java) } returns null
18801881
every {
18811882
project.extensions
18821883
.findByType(BaseExtension::class.java)!!
18831884
.externalNativeBuild.cmake
18841885
} returns mockCmakeOptions
1886+
every {
1887+
project.extensions
1888+
.findByType(BaseExtension::class.java)!!
1889+
.externalNativeBuild.ndkBuild
1890+
} returns mockNdkBuildOptions
18851891
every { project.extensions.findByType(BaseExtension::class.java)!!.defaultConfig } returns mockDefaultConfig
18861892

18871893
every { mockCmakeOptions.path } returns fakeCmakeFile
1894+
every { mockNdkBuildOptions.path } returns null
18881895

18891896
FlutterPluginUtils.forceNdkDownload(project, "ignored")
18901897

@@ -1896,6 +1903,44 @@ class FlutterPluginUtilsTest {
18961903
}
18971904

18981905
@Test
1906+
fun `forceNdkDownload skips projects which are already configuring an ndk-build`(
1907+
@TempDir tempDir: Path
1908+
) {
1909+
val fakeAndroidMkFile = tempDir.resolve("Android.mk").toFile()
1910+
fakeAndroidMkFile.createNewFile()
1911+
val project = mockk<Project>()
1912+
val mockCmakeOptions = mockk<CmakeOptions>()
1913+
val mockNdkBuildOptions = mockk<com.android.build.gradle.internal.dsl.NdkBuildOptions>()
1914+
val mockDefaultConfig = mockk<DefaultConfig>()
1915+
every { project.extensions.findByType(ApplicationExtension::class.java) } returns null
1916+
every {
1917+
project.extensions
1918+
.findByType(BaseExtension::class.java)!!
1919+
.externalNativeBuild.cmake
1920+
} returns mockCmakeOptions
1921+
every {
1922+
project.extensions
1923+
.findByType(BaseExtension::class.java)!!
1924+
.externalNativeBuild.ndkBuild
1925+
} returns mockNdkBuildOptions
1926+
every { project.extensions.findByType(BaseExtension::class.java)!!.defaultConfig } returns mockDefaultConfig
1927+
1928+
every { mockCmakeOptions.path } returns null
1929+
every { mockNdkBuildOptions.path } returns fakeAndroidMkFile
1930+
1931+
FlutterPluginUtils.forceNdkDownload(project, "ignored")
1932+
1933+
verify(exactly = 1) {
1934+
mockCmakeOptions.path
1935+
}
1936+
verify(exactly = 1) {
1937+
mockNdkBuildOptions.path
1938+
}
1939+
verify(exactly = 0) { mockCmakeOptions.path(any()) }
1940+
verify(exactly = 0) { mockCmakeOptions.buildStagingDirectory(any()) }
1941+
verify { mockDefaultConfig wasNot called }
1942+
}
1943+
18991944
fun `forceNdkDownload installs a missing ndk when tool properties are provided`(
19001945
@TempDir tempDir: Path
19011946
) {
@@ -1906,10 +1951,13 @@ class FlutterPluginUtilsTest {
19061951
val mockExecResult = mockk<ExecResult>()
19071952
val mockExecOperations = mockk<ExecOperations>()
19081953
val mockCmakeOptions = mockk<CmakeOptions>()
1954+
val mockNdkBuildOptions = mockk<com.android.build.gradle.internal.dsl.NdkBuildOptions>()
19091955
val mockDefaultConfig = mockk<DefaultConfig>()
19101956
val mockBaseExtension = mockk<BaseExtension>()
19111957
every { project.extensions.findByType(BaseExtension::class.java) } returns mockBaseExtension
19121958
every { mockBaseExtension.externalNativeBuild.cmake } returns mockCmakeOptions
1959+
every { mockBaseExtension.externalNativeBuild.ndkBuild } returns mockNdkBuildOptions
1960+
every { mockNdkBuildOptions.path } returns null
19131961
every { mockBaseExtension.defaultConfig } returns mockDefaultConfig
19141962
every { mockBaseExtension.ndkVersion } returns "29.0.13846066"
19151963
every { mockCmakeOptions.path } returns null
@@ -1954,10 +2002,13 @@ class FlutterPluginUtilsTest {
19542002
val project = mockk<Project>()
19552003
val finalizeDslSlot = captureFinalizeDslAction(project)
19562004
val mockCmakeOptions = mockk<CmakeOptions>()
2005+
val mockNdkBuildOptions = mockk<com.android.build.gradle.internal.dsl.NdkBuildOptions>()
19572006
val mockDefaultConfig = mockk<DefaultConfig>()
19582007
val mockBaseExtension = mockk<BaseExtension>()
19592008
every { project.extensions.findByType(BaseExtension::class.java) } returns mockBaseExtension
19602009
every { mockBaseExtension.externalNativeBuild.cmake } returns mockCmakeOptions
2010+
every { mockBaseExtension.externalNativeBuild.ndkBuild } returns mockNdkBuildOptions
2011+
every { mockNdkBuildOptions.path } returns null
19612012
every { mockBaseExtension.defaultConfig } returns mockDefaultConfig
19622013
every { mockBaseExtension.ndkVersion } returns "29.0.13846066"
19632014
every { mockCmakeOptions.path } returns null
@@ -1981,6 +2032,7 @@ class FlutterPluginUtilsTest {
19812032
val project = mockk<Project>()
19822033
val finalizeDslSlot = captureFinalizeDslAction(project)
19832034
val mockCmakeOptions = mockk<CmakeOptions>()
2035+
val mockNdkBuildOptions = mockk<com.android.build.gradle.internal.dsl.NdkBuildOptions>()
19842036
val mockDefaultConfig = mockk<DefaultConfig>()
19852037
val mockDirectoryProperty = mockk<DirectoryProperty>()
19862038
val mockDirectory = mockk<Directory>()
@@ -1989,6 +2041,8 @@ class FlutterPluginUtilsTest {
19892041
every { project.extensions.findByType(ApplicationExtension::class.java) } returns null
19902042
every { project.extensions.findByType(BaseExtension::class.java) } returns mockBaseExtension
19912043
every { mockBaseExtension.externalNativeBuild.cmake } returns mockCmakeOptions
2044+
every { mockBaseExtension.externalNativeBuild.ndkBuild } returns mockNdkBuildOptions
2045+
every { mockNdkBuildOptions.path } returns null
19922046
every { mockBaseExtension.defaultConfig } returns mockDefaultConfig
19932047
every { mockBaseExtension.ndkVersion } returns "29.0.13846066"
19942048
every { mockCmakeOptions.path } answers { cmakePath }
@@ -2032,11 +2086,14 @@ class FlutterPluginUtilsTest {
20322086
val mockExecResult = mockk<ExecResult>()
20332087
val mockExecOperations = mockk<ExecOperations>()
20342088
val mockCmakeOptions = mockk<CmakeOptions>()
2089+
val mockNdkBuildOptions = mockk<com.android.build.gradle.internal.dsl.NdkBuildOptions>()
20352090
val mockDefaultConfig = mockk<DefaultConfig>()
20362091
val mockBaseExtension = mockk<BaseExtension>()
20372092
var configuredNdkVersion = "26.3.11579264"
20382093
every { project.extensions.findByType(BaseExtension::class.java) } returns mockBaseExtension
20392094
every { mockBaseExtension.externalNativeBuild.cmake } returns mockCmakeOptions
2095+
every { mockBaseExtension.externalNativeBuild.ndkBuild } returns mockNdkBuildOptions
2096+
every { mockNdkBuildOptions.path } returns null
20402097
every { mockBaseExtension.defaultConfig } returns mockDefaultConfig
20412098
every { mockBaseExtension.ndkVersion } answers { configuredNdkVersion }
20422099
every { mockCmakeOptions.path } returns null
@@ -2090,6 +2147,7 @@ class FlutterPluginUtilsTest {
20902147
val mockExecResult = mockk<ExecResult>()
20912148
val mockExecOperations = mockk<ExecOperations>()
20922149
val mockCmakeOptions = mockk<CmakeOptions>()
2150+
val mockNdkBuildOptions = mockk<com.android.build.gradle.internal.dsl.NdkBuildOptions>()
20932151
val mockDefaultConfig = mockk<DefaultConfig>()
20942152
val mockBaseExtension = mockk<BaseExtension>()
20952153
val mockApplicationExtension = mockk<ApplicationExtension>()
@@ -2099,6 +2157,8 @@ class FlutterPluginUtilsTest {
20992157
project.extensions.findByType(ApplicationExtension::class.java)
21002158
} returns mockApplicationExtension
21012159
every { mockBaseExtension.externalNativeBuild.cmake } returns mockCmakeOptions
2160+
every { mockBaseExtension.externalNativeBuild.ndkBuild } returns mockNdkBuildOptions
2161+
every { mockNdkBuildOptions.path } returns null
21022162
every { mockBaseExtension.defaultConfig } returns mockDefaultConfig
21032163
every { mockBaseExtension.ndkVersion } answers {
21042164
throw AssertionError(
@@ -2150,11 +2210,14 @@ class FlutterPluginUtilsTest {
21502210
val project = mockk<Project>()
21512211
val finalizeDslSlot = captureFinalizeDslAction(project)
21522212
val mockCmakeOptions = mockk<CmakeOptions>()
2213+
val mockNdkBuildOptions = mockk<com.android.build.gradle.internal.dsl.NdkBuildOptions>()
21532214
val mockDefaultConfig = mockk<DefaultConfig>()
21542215
val mockBaseExtension = mockk<BaseExtension>()
21552216
every { project.extensions.findByType(ApplicationExtension::class.java) } returns null
21562217
every { project.extensions.findByType(BaseExtension::class.java) } returns mockBaseExtension
21572218
every { mockBaseExtension.externalNativeBuild.cmake } returns mockCmakeOptions
2219+
every { mockBaseExtension.externalNativeBuild.ndkBuild } returns mockNdkBuildOptions
2220+
every { mockNdkBuildOptions.path } returns null
21582221
every { mockBaseExtension.defaultConfig } returns mockDefaultConfig
21592222
every { mockBaseExtension.ndkVersion } returns "29.0.13846066"
21602223
every { mockCmakeOptions.path } returns null
@@ -2175,12 +2238,15 @@ class FlutterPluginUtilsTest {
21752238
val project = mockk<Project>()
21762239
val finalizeDslSlot = captureFinalizeDslAction(project)
21772240
val mockCmakeOptions = mockk<CmakeOptions>()
2241+
val mockNdkBuildOptions = mockk<com.android.build.gradle.internal.dsl.NdkBuildOptions>()
21782242
val mockDefaultConfig = mockk<DefaultConfig>()
21792243
val mockBaseExtension = mockk<BaseExtension>()
21802244
val mockApplicationExtension = mockk<ApplicationExtension>()
21812245
every { project.extensions.findByType(BaseExtension::class.java) } returns mockBaseExtension
21822246
every { project.extensions.findByType(ApplicationExtension::class.java) } returns mockApplicationExtension
21832247
every { mockBaseExtension.externalNativeBuild.cmake } returns mockCmakeOptions
2248+
every { mockBaseExtension.externalNativeBuild.ndkBuild } returns mockNdkBuildOptions
2249+
every { mockNdkBuildOptions.path } returns null
21842250
every { mockBaseExtension.defaultConfig } returns mockDefaultConfig
21852251
every { mockBaseExtension.ndkVersion } answers {
21862252
throw AssertionError("legacy ndkVersion should not be read when ApplicationExtension is available")
@@ -2208,10 +2274,13 @@ class FlutterPluginUtilsTest {
22082274
val mockExecResult = mockk<ExecResult>()
22092275
val mockExecOperations = mockk<ExecOperations>()
22102276
val mockCmakeOptions = mockk<CmakeOptions>()
2277+
val mockNdkBuildOptions = mockk<com.android.build.gradle.internal.dsl.NdkBuildOptions>()
22112278
val mockDefaultConfig = mockk<DefaultConfig>()
22122279
val mockBaseExtension = mockk<BaseExtension>()
22132280
every { project.extensions.findByType(BaseExtension::class.java) } returns mockBaseExtension
22142281
every { mockBaseExtension.externalNativeBuild.cmake } returns mockCmakeOptions
2282+
every { mockBaseExtension.externalNativeBuild.ndkBuild } returns mockNdkBuildOptions
2283+
every { mockNdkBuildOptions.path } returns null
22152284
every { mockBaseExtension.defaultConfig } returns mockDefaultConfig
22162285
every { mockBaseExtension.ndkVersion } returns "29.0.13846066"
22172286
every { mockCmakeOptions.path } returns null
@@ -2262,13 +2331,16 @@ class FlutterPluginUtilsTest {
22622331
val project = mockk<Project>()
22632332
val finalizeDslSlot = captureFinalizeDslAction(project)
22642333
val mockCmakeOptions = mockk<CmakeOptions>()
2334+
val mockNdkBuildOptions = mockk<com.android.build.gradle.internal.dsl.NdkBuildOptions>()
22652335
val mockDefaultConfig = mockk<DefaultConfig>()
22662336
val mockDirectoryProperty = mockk<DirectoryProperty>()
22672337
val mockDirectory = mockk<Directory>()
22682338
val mockBaseExtension = mockk<BaseExtension>()
22692339
every { project.extensions.findByType(ApplicationExtension::class.java) } returns null
22702340
every { project.extensions.findByType(BaseExtension::class.java) } returns mockBaseExtension
22712341
every { mockBaseExtension.externalNativeBuild.cmake } returns mockCmakeOptions
2342+
every { mockBaseExtension.externalNativeBuild.ndkBuild } returns mockNdkBuildOptions
2343+
every { mockNdkBuildOptions.path } returns null
22722344
every { mockBaseExtension.defaultConfig } returns mockDefaultConfig
22732345
every { mockBaseExtension.ndkVersion } returns "29.0.13846066"
22742346
every { mockCmakeOptions.path } returns null
@@ -2310,13 +2382,16 @@ class FlutterPluginUtilsTest {
23102382
val project = mockk<Project>()
23112383
val finalizeDslSlot = captureFinalizeDslAction(project)
23122384
val mockCmakeOptions = mockk<CmakeOptions>()
2385+
val mockNdkBuildOptions = mockk<com.android.build.gradle.internal.dsl.NdkBuildOptions>()
23132386
val mockDefaultConfig = mockk<DefaultConfig>()
23142387
val mockDirectoryProperty = mockk<DirectoryProperty>()
23152388
val mockDirectory = mockk<Directory>()
23162389
val mockBaseExtension = mockk<BaseExtension>()
23172390
every { project.extensions.findByType(ApplicationExtension::class.java) } returns null
23182391
every { project.extensions.findByType(BaseExtension::class.java) } returns mockBaseExtension
23192392
every { mockBaseExtension.externalNativeBuild.cmake } returns mockCmakeOptions
2393+
every { mockBaseExtension.externalNativeBuild.ndkBuild } returns mockNdkBuildOptions
2394+
every { mockNdkBuildOptions.path } returns null
23202395
every { mockBaseExtension.defaultConfig } returns mockDefaultConfig
23212396
every { mockBaseExtension.ndkVersion } returns "29.0.13846066"
23222397
every { mockCmakeOptions.path } returns null
@@ -2358,6 +2433,7 @@ class FlutterPluginUtilsTest {
23582433
fun `forceNdkDownload sets externalNativeBuild properties`() {
23592434
val project = mockk<Project>()
23602435
val mockCmakeOptions = mockk<CmakeOptions>()
2436+
val mockNdkBuildOptions = mockk<com.android.build.gradle.internal.dsl.NdkBuildOptions>()
23612437
val mockDefaultConfig = mockk<DefaultConfig>()
23622438
val mockDirectoryProperty = mockk<DirectoryProperty>()
23632439
val mockDirectory = mockk<Directory>()
@@ -2370,17 +2446,24 @@ class FlutterPluginUtilsTest {
23702446
.findByType(BaseExtension::class.java)!!
23712447
.externalNativeBuild.cmake
23722448
} returns mockCmakeOptions
2449+
every {
2450+
project.extensions
2451+
.findByType(BaseExtension::class.java)!!
2452+
.externalNativeBuild.ndkBuild
2453+
} returns mockNdkBuildOptions
23732454
every { project.extensions.findByType(BaseExtension::class.java)!!.defaultConfig } returns mockDefaultConfig
23742455

23752456
val basePath = "/base/path"
23762457
val fakeBuildPath = "/randomapp/build/app/"
23772458
every { mockCmakeOptions.path } returns null
2459+
every { mockNdkBuildOptions.path } returns null
23782460
every { mockCmakeOptions.path(any()) } returns Unit
23792461
every { mockCmakeOptions.buildStagingDirectory(any()) } returns Unit
23802462
every { project.layout.buildDirectory } returns mockDirectoryProperty
23812463
every { mockDirectoryProperty.dir(any<String>()) } returns mockDirectoryProperty
23822464
every { mockDirectoryProperty.get() } returns mockDirectory
2383-
every { mockDirectory.asFile.path } returns fakeBuildPath
2465+
val realFile = File(fakeBuildPath)
2466+
every { mockDirectory.asFile } returns realFile
23842467

23852468
val mockBuildType = mockk<com.android.build.gradle.internal.dsl.BuildType>()
23862469
every {

0 commit comments

Comments
 (0)