Fix Gradle Configuration Cache support.

TadeasKriz · TadeasKriz · commit 56bcf38c1225 · 2024-04-16T19:36:38.000-04:00
# Conflicts:
#	SKIE/skie-gradle/plugin/src/main/kotlin/co/touchlab/skie/plugin/configuration/CreateSkieConfigurationTask.kt
diff --git a/SKIE/skie-gradle/plugin/src/main/kotlin/co/touchlab/skie/plugin/configuration/CreateSkieConfigurationTask.kt b/SKIE/skie-gradle/plugin/src/main/kotlin/co/touchlab/skie/plugin/configuration/CreateSkieConfigurationTask.kt
@@ -45,8 +45,9 @@ internal abstract class CreateSkieConfigurationTask : DefaultTask() {
 
         fun registerTask(target: SkieTarget) {
             val createConfiguration = target.registerSkieTargetBasedTask<CreateSkieConfigurationTask>("createConfiguration") {
+                val skieExtension = project.skieExtension
                 configurationFile.set(target.skieBuildDirectory.skieConfiguration)
-                configuration.set(project.provider { project.skieExtension.buildConfiguration() })
+                configuration.set(project.provider { skieExtension.buildConfiguration() })
 
                 dependsOn(target.createSkieBuildDirectoryTask)
             }
diff --git a/SKIE/skie-gradle/plugin/src/main/kotlin/co/touchlab/skie/plugin/fatframework/FatFrameworkConfigurator.kt b/SKIE/skie-gradle/plugin/src/main/kotlin/co/touchlab/skie/plugin/fatframework/FatFrameworkConfigurator.kt
@@ -6,19 +6,17 @@ import org.gradle.api.Project
 import org.jetbrains.kotlin.gradle.tasks.FatFrameworkTask
 import org.jetbrains.kotlin.gradle.tasks.FrameworkLayout
 import org.jetbrains.kotlin.konan.target.Architecture
-import org.jetbrains.kotlin.konan.target.Family
 import java.io.File
 
 internal object FatFrameworkConfigurator {
-
     fun configureSkieForFatFrameworks(project: Project) {
-        project.fixFatFrameworkNameForCocoaPodsPlugin()
-        project.configureFatFrameworkPatching()
+        fixFatFrameworkNameForCocoaPodsPlugin(project)
+        configureFatFrameworkPatching(project)
     }
 
-    private fun Project.fixFatFrameworkNameForCocoaPodsPlugin() {
-        pluginManager.withPlugin("kotlin-native-cocoapods") {
-            tasks.withType<FatFrameworkTask>().matching { it.name == "fatFramework" }.configureEach {
+    private fun fixFatFrameworkNameForCocoaPodsPlugin(project: Project) {
+        project.pluginManager.withPlugin("kotlin-native-cocoapods") {
+            project.tasks.withType<FatFrameworkTask>().matching { it.name == "fatFramework" }.configureEach {
                 // Unfortunately has to be done in `doFirst` to make sure the task is already configured by the plugin when we run our code
                 doFirstOptimized {
                     val commonFrameworkName = frameworks.map { it.name }.distinct().singleOrNull() ?: return@doFirstOptimized
@@ -28,8 +26,9 @@ internal object FatFrameworkConfigurator {
         }
     }
 
-    private fun Project.configureFatFrameworkPatching() {
-        tasks.withType<FatFrameworkTask>().configureEach {
+    private fun configureFatFrameworkPatching(project: Project) {
+        val injectedFileSystemOperations = project.objects.newInstance<InjectedFileSystemOperations>()
+        project.tasks.withType<FatFrameworkTask>().configureEach {
             doLastOptimized {
                 // There shouldn't be any real difference between the frameworks except for architecture, so we consider the first one "primary"
                 val primaryFramework = frameworks.first()
@@ -38,7 +37,7 @@ internal object FatFrameworkConfigurator {
                     isMacosFramework = primaryFramework.files.isMacosFramework,
                 )
 
-                // FatFramewrokTask writes its own
+                // FatFrameworkTask writes its own
                 target.moduleFile.writeText(
                     primaryFramework.files.moduleFile.readText()
                 )
@@ -74,12 +73,12 @@ internal object FatFrameworkConfigurator {
                 target.swiftModuleDir.mkdirs()
 
                 frameworksByArchs.toList().forEach { (_, framework) ->
-                    project.copy {
+                    injectedFileSystemOperations.fileSystemOperations.copy {
                         from(framework.files.apiNotes)
                         into(target.headerDir)
                     }
                     framework.files.swiftModuleFiles(framework.darwinTarget.targetTriple).forEach { swiftmoduleFile ->
-                        project.copy {
+                        injectedFileSystemOperations.fileSystemOperations.copy {
                             from(swiftmoduleFile)
                             into(target.swiftModuleDir)
                         }
diff --git a/SKIE/skie-gradle/plugin/src/main/kotlin/co/touchlab/skie/plugin/util/DarwinTarget.kt b/SKIE/skie-gradle/plugin/src/main/kotlin/co/touchlab/skie/plugin/util/DarwinTarget.kt
@@ -33,12 +33,13 @@ internal data class DarwinTarget(
             DarwinTarget(KonanTarget.TVOS_SIMULATOR_ARM64, "arm64-apple-tvos-simulator", "appletvsimulator"),
             DarwinTarget(KonanTarget.MACOS_X64, "x86_64-apple-macos", "macosx"),
             DarwinTarget(KonanTarget.MACOS_ARM64, "arm64-apple-macos", "macosx"),
-        ).associateBy { it.konanTarget }
+        ).associateBy { it.konanTarget.name }
     }
 }
 
 internal val FrameworkDescriptor.darwinTarget: DarwinTarget
     get() = target.darwinTarget
 
 internal val KonanTarget.darwinTarget: DarwinTarget
-    get() = DarwinTarget.allTargets[this] ?: error("Unknown konan target: $this")
+    // We can't use `KotlinTarget` directly as the instance can differ when Gradle Configuration Cache is used
+    get() = DarwinTarget.allTargets[name] ?: error("Unknown konan target: $this")
diff --git a/SKIE/skie-gradle/plugin/src/main/kotlin/co/touchlab/skie/plugin/util/InjectedFileSystemOperations.kt b/SKIE/skie-gradle/plugin/src/main/kotlin/co/touchlab/skie/plugin/util/InjectedFileSystemOperations.kt
@@ -0,0 +1,9 @@
+package co.touchlab.skie.plugin.util
+
+import org.gradle.api.file.FileSystemOperations
+import javax.inject.Inject
+
+interface InjectedFileSystemOperations {
+    @get:Inject
+    val fileSystemOperations: FileSystemOperations
+}
diff --git a/test-runner/.run/Test Gradle Configuration Cache.run.xml b/test-runner/.run/Test Gradle Configuration Cache.run.xml
@@ -0,0 +1,26 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Test Gradle Configuration Cache" type="GradleRunConfiguration" factoryName="Gradle">
+    <ExternalSystemSettings>
+      <option name="executionName" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$" />
+      <option name="externalSystemIdString" value="GRADLE" />
+      <option name="scriptParameters" value="-Pmatrix.linkModes=static,dynamic -Pmatrix.targets=macosArm64 -PtestLevel=smoke -Pmatrix.configurations=debug -PtestType=gradle" />
+      <option name="taskDescriptions">
+        <list />
+      </option>
+      <option name="taskNames">
+        <list>
+          <option value=":test" />
+          <option value="--tests" />
+          <option value="&quot;co.touchlab.skie.test.suite.gradle.configurationcache.GradleConfigurationCacheTests&quot;" />
+        </list>
+      </option>
+      <option name="vmOptions" />
+    </ExternalSystemSettings>
+    <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
+    <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
+    <DebugAllEnabled>false</DebugAllEnabled>
+    <RunAsTest>false</RunAsTest>
+    <method v="2" />
+  </configuration>
+</component>
diff --git a/test-runner/src/test/kotlin/co/touchlab/skie/test/suite/gradle/configurationcache/GradleConfigurationCacheTests.kt b/test-runner/src/test/kotlin/co/touchlab/skie/test/suite/gradle/configurationcache/GradleConfigurationCacheTests.kt
@@ -6,6 +6,7 @@ import co.touchlab.skie.test.annotation.filter.Smoke
 import co.touchlab.skie.test.annotation.type.GradleTests
 import co.touchlab.skie.test.base.BaseGradleTests
 import co.touchlab.skie.test.runner.BuildConfiguration
+import co.touchlab.skie.test.template.Templates
 import co.touchlab.skie.test.util.KotlinTarget
 import co.touchlab.skie.test.util.KotlinVersion
 import co.touchlab.skie.test.util.LinkMode
@@ -21,9 +22,9 @@ import kotlin.test.assertEquals
 class GradleConfigurationCacheTests: BaseGradleTests() {
 
     // We don't need to run the whole build to check configuration cache
-    private val gradleArguments = arrayOf("dependencies")
+    private val gradleArguments = arrayOf("assemble")
     private val assertGradleResult = { result: BuildResult ->
-        assertEquals(TaskOutcome.SUCCESS, result.task(":dependencies")?.outcome)
+        assertEquals(TaskOutcome.SUCCESS, result.task(":assemble")?.outcome)
     }
 
     @MatrixTest
@@ -36,6 +37,8 @@ class GradleConfigurationCacheTests: BaseGradleTests() {
             }
         }
 
+        copyToCommonMain(Templates.basic)
+
         runGradle(
             arguments = gradleArguments,
             assertResult = assertGradleResult,
@@ -60,6 +63,8 @@ class GradleConfigurationCacheTests: BaseGradleTests() {
             }
         }
 
+        copyToCommonMain(Templates.basic)
+
         runGradle(
             arguments = gradleArguments,
             assertResult = assertGradleResult,
@@ -89,6 +94,8 @@ class GradleConfigurationCacheTests: BaseGradleTests() {
             }
         }
 
+        copyToCommonMain(Templates.basic)
+
         runGradle(
             arguments = gradleArguments,
             assertResult = assertGradleResult,
@@ -116,6 +123,8 @@ class GradleConfigurationCacheTests: BaseGradleTests() {
             }
         }
 
+        copyToCommonMain(Templates.basic)
+
         runGradle(
             arguments = gradleArguments,
             assertResult = assertGradleResult,

Original file line number	Diff line number	Diff line change
`@@ -45,8 +45,9 @@ internal abstract class CreateSkieConfigurationTask : DefaultTask() {`
`45`	`45`
`46`	`46`	`fun registerTask(target: SkieTarget) {`
`47`	`47`	`val createConfiguration = target.registerSkieTargetBasedTask<CreateSkieConfigurationTask>("createConfiguration") {`
	`48`	`+ val skieExtension = project.skieExtension`
`48`	`49`	`configurationFile.set(target.skieBuildDirectory.skieConfiguration)`
`49`		`- configuration.set(project.provider { project.skieExtension.buildConfiguration() })`
	`50`	`+ configuration.set(project.provider { skieExtension.buildConfiguration() })`
`50`	`51`
`51`	`52`	`dependsOn(target.createSkieBuildDirectoryTask)`
`52`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,12 +33,13 @@ internal data class DarwinTarget(`
`33`	`33`	`DarwinTarget(KonanTarget.TVOS_SIMULATOR_ARM64, "arm64-apple-tvos-simulator", "appletvsimulator"),`
`34`	`34`	`DarwinTarget(KonanTarget.MACOS_X64, "x86_64-apple-macos", "macosx"),`
`35`	`35`	`DarwinTarget(KonanTarget.MACOS_ARM64, "arm64-apple-macos", "macosx"),`
`36`		`- ).associateBy { it.konanTarget }`
	`36`	`+ ).associateBy { it.konanTarget.name }`
`37`	`37`	`}`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`internal val FrameworkDescriptor.darwinTarget: DarwinTarget`
`41`	`41`	`get() = target.darwinTarget`
`42`	`42`
`43`	`43`	`internal val KonanTarget.darwinTarget: DarwinTarget`
`44`		`- get() = DarwinTarget.allTargets[this] ?: error("Unknown konan target: $this")`
	`44`	+ // We can't use `KotlinTarget` directly as the instance can differ when Gradle Configuration Cache is used
	`45`	`+ get() = DarwinTarget.allTargets[name] ?: error("Unknown konan target: $this")`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ import co.touchlab.skie.test.annotation.filter.Smoke`
`6`	`6`	`import co.touchlab.skie.test.annotation.type.GradleTests`
`7`	`7`	`import co.touchlab.skie.test.base.BaseGradleTests`
`8`	`8`	`import co.touchlab.skie.test.runner.BuildConfiguration`
	`9`	`+import co.touchlab.skie.test.template.Templates`
`9`	`10`	`import co.touchlab.skie.test.util.KotlinTarget`
`10`	`11`	`import co.touchlab.skie.test.util.KotlinVersion`
`11`	`12`	`import co.touchlab.skie.test.util.LinkMode`
`@@ -21,9 +22,9 @@ import kotlin.test.assertEquals`
`21`	`22`	`class GradleConfigurationCacheTests: BaseGradleTests() {`
`22`	`23`
`23`	`24`	`// We don't need to run the whole build to check configuration cache`
`24`		`- private val gradleArguments = arrayOf("dependencies")`
	`25`	`+ private val gradleArguments = arrayOf("assemble")`
`25`	`26`	`private val assertGradleResult = { result: BuildResult ->`
`26`		`- assertEquals(TaskOutcome.SUCCESS, result.task(":dependencies")?.outcome)`
	`27`	`+ assertEquals(TaskOutcome.SUCCESS, result.task(":assemble")?.outcome)`
`27`	`28`	`}`
`28`	`29`
`29`	`30`	`@MatrixTest`
`@@ -36,6 +37,8 @@ class GradleConfigurationCacheTests: BaseGradleTests() {`
`36`	`37`	`}`
`37`	`38`	`}`
`38`	`39`
	`40`	`+ copyToCommonMain(Templates.basic)`
	`41`	`+`
`39`	`42`	`runGradle(`
`40`	`43`	`arguments = gradleArguments,`
`41`	`44`	`assertResult = assertGradleResult,`
`@@ -60,6 +63,8 @@ class GradleConfigurationCacheTests: BaseGradleTests() {`
`60`	`63`	`}`
`61`	`64`	`}`
`62`	`65`
	`66`	`+ copyToCommonMain(Templates.basic)`
	`67`	`+`
`63`	`68`	`runGradle(`
`64`	`69`	`arguments = gradleArguments,`
`65`	`70`	`assertResult = assertGradleResult,`
`@@ -89,6 +94,8 @@ class GradleConfigurationCacheTests: BaseGradleTests() {`
`89`	`94`	`}`
`90`	`95`	`}`
`91`	`96`
	`97`	`+ copyToCommonMain(Templates.basic)`
	`98`	`+`
`92`	`99`	`runGradle(`
`93`	`100`	`arguments = gradleArguments,`
`94`	`101`	`assertResult = assertGradleResult,`
`@@ -116,6 +123,8 @@ class GradleConfigurationCacheTests: BaseGradleTests() {`
`116`	`123`	`}`
`117`	`124`	`}`
`118`	`125`
	`126`	`+ copyToCommonMain(Templates.basic)`
	`127`	`+`
`119`	`128`	`runGradle(`
`120`	`129`	`arguments = gradleArguments,`
`121`	`130`	`assertResult = assertGradleResult,`