Test and fix example-gradle-task against latest code (#459)

gabrielfeo · web-flow · commit 9422d1b29a87 · 2025-08-24T03:42:26.000+01:00
Updates the test case that verifies running the example Kotlin **plugin project** (a Gradle task which uses the API, added in #452) against the current library code, i.e. a SNAPSHOT artifact compiled just before the tests and published to Maven local. To fix #404, language version had been downgraded to 1.8. To fully restore compatibility of the latest code, which has since been updated to use Kotlin plugin 2.2.x (with 1.8 language version, but 2.2.x stdlib), stdlib and okhttp are downgraded. This restores compatibility with Gradle 8.11 <= v < 9.0.0. This [build scan][1] demonstrates the compiler version (not language version) incompatibility that is now fixed: ``` e: file:///Users/gfeo/.gradle/caches/modules-2/files-2.1/com.squareup.okhttp3/okhttp-jvm/5.1.0/c17340f19b33c1d28a47b8dc4ae15018aff6dc10/okhttp-jvm-5.1.0.jar!/META-INF/okhttp.kotlin_module Module was compiled with an incompatible version of Kotlin. The binary version of its metadata is 2.2.0, expected version is 2.0.0. e: file:///Users/gfeo/.gradle/caches/modules-2/files-2.1/org.jetbrains.kotlin/kotlin-stdlib/2.2.10/30de6faa127a4a012db8e71bf1b9c0a99b1402b2/kotlin-stdlib-2.2.10.jar!/META-INF/kotlin-stdlib-jdk7.kotlin_module Module was compiled with an incompatible version of Kotlin. The binary version of its metadata is 2.2.0, expected version is 2.0.0. e: file:///Users/gfeo/.gradle/caches/modules-2/files-2.1/org.jetbrains.kotlin/kotlin-stdlib/2.2.10/30de6faa127a4a012db8e71bf1b9c0a99b1402b2/kotlin-stdlib-2.2.10.jar!/META-INF/kotlin-stdlib-jdk8.kotlin_module Module was compiled with an incompatible version of Kotlin. The binary version of its metadata is 2.2.0, expected version is 2.0.0. e: file:///Users/gfeo/.gradle/caches/modules-2/files-2.1/org.jetbrains.kotlin/kotlin-stdlib/2.2.10/30de6faa127a4a012db8e71bf1b9c0a99b1402b2/kotlin-stdlib-2.2.10.jar!/META-INF/kotlin-stdlib.kotlin_module Module was compiled with an incompatible version of Kotlin. The binary version of its metadata is 2.2.0, expected version is 2.0.0. ``` Prevents regressions like #404. Follow-up to #432, #456 and #458 for example-gradle-task. ExampleProjectTest is also refactored to use the init script introduced here. A smoke test verifying that the example is properly forced to use the published `SNAPSHOT` is added to both tests. `buildSrc` is used in `example-gradle-task` because `pluginManagement.repositories.exclusiveContent` set via init script rules don't seem to apply to build dependencies resolved from included builds. [1]: https://scans.gradle.com/s/hxgfny2ssyugo/tests/task/:library:examplesTest/details/com.gabrielfeo.develocity.api.example.gradle.ExampleGradleTaskTest/smokeTest()?focused-execution=1&top-execution=1#L0-L3
diff --git a/build-logic/src/main/kotlin/com/gabrielfeo/examples-test-suite.gradle.kts b/build-logic/src/main/kotlin/com/gabrielfeo/examples-test-suite.gradle.kts
@@ -27,7 +27,7 @@ val examples = fileTree(rootDir) {
     exclude {
         it.isDirectory
             && (it.name == "build" || it.name.startsWith("."))
-            && !it.path.endsWith("build-logic/src/main/kotlin/build")
+            && !it.path.endsWith("buildSrc/src/main/kotlin/build")
     }
 }
 
diff --git a/examples/example-gradle-task/build-logic/settings.gradle.kts b/examples/example-gradle-task/build-logic/settings.gradle.kts
diff --git a/examples/example-gradle-task/buildSrc/build.gradle.kts b/examples/example-gradle-task/buildSrc/build.gradle.kts
@@ -6,3 +6,7 @@ dependencies {
     implementation("com.gabrielfeo:develocity-api-kotlin:2024.3.0")
     implementation("org.apache.commons:commons-math3:3.6.1")
 }
+
+repositories {
+    mavenCentral()
+}
diff --git a/examples/example-gradle-task/buildSrc/settings.gradle.kts b/examples/example-gradle-task/buildSrc/settings.gradle.kts
@@ -0,0 +1 @@
+rootProject.name = "dak-example-gradle-task-build-src"
diff --git a/examples/example-gradle-task/buildSrc/src/main/kotlin/build/logic/DevelocityApiService.kt b/examples/example-gradle-task/buildSrc/src/main/kotlin/build/logic/DevelocityApiService.kt
diff --git a/examples/example-gradle-task/buildSrc/src/main/kotlin/build/logic/PerformanceMetricsTask.kt b/examples/example-gradle-task/buildSrc/src/main/kotlin/build/logic/PerformanceMetricsTask.kt
diff --git a/examples/example-gradle-task/buildSrc/src/main/kotlin/build/logic/performance-metrics-plugin.gradle.kts b/examples/example-gradle-task/buildSrc/src/main/kotlin/build/logic/performance-metrics-plugin.gradle.kts
diff --git a/examples/example-gradle-task/settings.gradle.kts b/examples/example-gradle-task/settings.gradle.kts
@@ -1,5 +1 @@
-pluginManagement {
-    includeBuild("build-logic")
-}
-
 rootProject.name = "dak-example-gradle-task-main-build"
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -1,11 +1,12 @@
 [versions]
 kotlin = "2.2.10"
+kotlin-stdlib = "2.0.0"
 dokka = "2.0.0"
 openapi-generator = "7.14.0"
 jupyter = "0.15.0-594"
 okio = "3.16.0"
 moshi = "1.15.2"
-okhttp = "5.1.0"
+okhttp = "4.12.0"
 retrofit = "3.0.0"
 kotlin-coroutines = "1.10.2"
 kotlin-binary-compatibility-validator = "0.18.1"
@@ -28,6 +29,7 @@ kotlin-jupyter-api = { module = "org.jetbrains.kotlinx:kotlin-jupyter-api", vers
 kotlin-jupyter-testkit = { module = "org.jetbrains.kotlinx:kotlin-jupyter-test-kit", version.ref = "jupyter" }
 kotlin-binary-compatibility-validator-plugin = { module = "org.jetbrains.kotlinx:binary-compatibility-validator", version.ref = "kotlin-binary-compatibility-validator" }
 kotlin-plugin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
+kotlin-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib", version.ref = "kotlin-stdlib" }
 dokka-plugin = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "dokka" }
 openapi-generator-plugin = { module = "org.openapitools:openapi-generator-gradle-plugin", version.ref = "openapi-generator" }
 slf4j-api = { module = "org.slf4j:slf4j-api", version.ref = "slf4j" }
diff --git a/library/build.gradle.kts b/library/build.gradle.kts
@@ -13,6 +13,9 @@ dependencies {
     constraints {
         implementation(libs.okio)
     }
+    // Set fixed version of stdlib for compatibility with the version of Kotlin
+    // embedded in earlier versions of Gradle
+    implementation(libs.kotlin.stdlib)
     api(libs.okhttp)
     implementation(libs.okhttp.logging.interceptor)
     api(libs.retrofit)
@@ -101,6 +104,10 @@ tasks.named("compileKotlin", KotlinCompile::class) {
 }
 
 tasks.withType<Test>().configureEach {
+    systemProperty(
+        "junit.jupiter.tempdir.cleanup.mode.default",
+        System.getProperty("junit.jupiter.tempdir.cleanup.mode.default") ?: "always",
+    )
     environment("DEVELOCITY_API_LOG_LEVEL", "DEBUG")
     providers.environmentVariablesPrefixedBy("DEVELOCITY_API_").get().forEach { (name, value) ->
         inputs.property("${name}.hashCode", value.hashCode())
diff --git a/library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/gradle/ExampleGradleTaskTest.kt b/library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/gradle/ExampleGradleTaskTest.kt
@@ -2,13 +2,18 @@ package com.gabrielfeo.develocity.api.example.gradle
 
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.MethodOrderer.OrderAnnotation
+import org.junit.jupiter.api.Order
+import org.junit.jupiter.api.TestMethodOrder
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.io.TempDir
 import java.nio.file.Path
 import com.gabrielfeo.develocity.api.example.copyFromResources
 import com.gabrielfeo.develocity.api.example.runInShell
 import kotlin.io.path.div
+import java.nio.file.Files
 
+@TestMethodOrder(OrderAnnotation::class)
 class ExampleGradleTaskTest {
 
     @TempDir
@@ -17,9 +22,24 @@ class ExampleGradleTaskTest {
     private val projectDir
         get() = tempDir / "examples/example-gradle-task"
 
+    private val initScriptPath
+        get() = tempDir / ResourceInitScripts.FORCE_SNAPSHOT_LIBRARY
+
     @BeforeEach
     fun setup() {
         copyFromResources("/examples", tempDir)
+        copyFromResources("/${ResourceInitScripts.FORCE_SNAPSHOT_LIBRARY}", tempDir)
+    }
+
+    @Test
+    @Order(1)
+    fun smokeTest() {
+        val dependencies = runBuild(":buildSrc:dependencies --configuration runtimeClasspath")
+        val libraryMatches = dependencies.lines().filter { "develocity-api-kotlin" in it }
+        assertTrue(libraryMatches.isNotEmpty())
+        assertTrue(libraryMatches.all { "-> SNAPSHOT" in it && "FAILED" !in it }) {
+            "Expected forced SNAPSHOT versions, but found [${libraryMatches.joinToString(", ")}]"
+        }
     }
 
     @Test
@@ -30,7 +50,12 @@ class ExampleGradleTaskTest {
     }
 
     private fun runBuild(gradleArgs: String) =
-        runInShell(projectDir, "./gradlew --stacktrace --no-daemon $gradleArgs")
+        runInShell(
+            projectDir,
+            "./gradlew --stacktrace --no-daemon",
+            "-I $initScriptPath",
+            gradleArgs,
+        )
 
     private fun assertPerformanceMetricsOutput(
         output: String,
diff --git a/library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/gradle/ExampleProjectTest.kt b/library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/gradle/ExampleProjectTest.kt
@@ -2,13 +2,17 @@ package com.gabrielfeo.develocity.api.example.gradle
 
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.MethodOrderer.OrderAnnotation
+import org.junit.jupiter.api.Order
+import org.junit.jupiter.api.TestMethodOrder
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.io.TempDir
 import java.nio.file.Path
 import kotlin.io.path.div
 import com.gabrielfeo.develocity.api.example.copyFromResources
 import com.gabrielfeo.develocity.api.example.runInShell
 
+@TestMethodOrder(OrderAnnotation::class)
 class ExampleProjectTest {
 
     @TempDir
@@ -17,35 +21,40 @@ class ExampleProjectTest {
     private val projectDir
         get() = tempDir / "examples/example-project"
 
+    private val initScriptPath
+        get() = tempDir / ResourceInitScripts.FORCE_SNAPSHOT_LIBRARY
+
     @BeforeEach
     fun setup() {
         copyFromResources("/examples", tempDir)
-        forceUseOfMavenLocalSnapshotArtifact(projectDir / "build.gradle.kts")
+        copyFromResources("/${ResourceInitScripts.FORCE_SNAPSHOT_LIBRARY}", tempDir)
+    }
+
+    @Test
+    @Order(1)
+    fun smokeTest() {
+        val dependencies = runBuild("dependencies --configuration runtimeClasspath")
+        val libraryMatches = dependencies.lines().filter { "develocity-api-kotlin" in it }
+        assertTrue(libraryMatches.isNotEmpty())
+        assertTrue(libraryMatches.all { "-> SNAPSHOT" in it && "FAILED" !in it }) {
+            "Expected forced SNAPSHOT versions, but found [${libraryMatches.joinToString(", ")}]"
+        }
     }
 
     @Test
     fun testExampleProject() {
-        val output = runInShell(projectDir, "./gradlew --stacktrace --no-daemon run").trim()
+        val output = runBuild("run")
         val tableRegex = Regex("""(?ms)^[-]+\nMost frequent builds:\n\s*\n(.+\|\s*\d+\s*\n?)+""")
         assertTrue(tableRegex.containsMatchIn(output)) {
             "Expected match for pattern '$tableRegex' in output '$output'"
         }
     }
 
-    private fun forceUseOfMavenLocalSnapshotArtifact(buildGradlePath: Path) {
-        val repositoryDefinition = """
-            repositories {
-                exclusiveContent {
-                    forRepository { mavenLocal() }
-                    filter { includeGroup("com.gabrielfeo") }
-                }
-            }
-        """.trimIndent()
-        val original = buildGradlePath.toFile().readText()
-        val patched = original.replace(
-            Regex("""com.gabrielfeo:develocity-api-kotlin:[^"]+"""),
-            "com.gabrielfeo:develocity-api-kotlin:SNAPSHOT",
-        ) + repositoryDefinition
-        buildGradlePath.toFile().writeText(patched)
-    }
+    private fun runBuild(gradleArgs: String) =
+        runInShell(
+            projectDir,
+            "./gradlew --stacktrace --no-daemon",
+            "-I $initScriptPath",
+            gradleArgs,
+        )
 }
diff --git a/library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/gradle/ResourceInitScripts.kt b/library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/gradle/ResourceInitScripts.kt
@@ -0,0 +1,5 @@
+package com.gabrielfeo.develocity.api.example.gradle
+
+object ResourceInitScripts {
+    const val FORCE_SNAPSHOT_LIBRARY = "force-snapshot-library.init.gradle.kts"
+}
diff --git a/library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/notebook/ScriptsTest.kt b/library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/notebook/ScriptsTest.kt
diff --git a/library/src/examplesTest/resources/force-snapshot-library.init.gradle.kts b/library/src/examplesTest/resources/force-snapshot-library.init.gradle.kts
@@ -0,0 +1,29 @@
+beforeSettings{
+    pluginManagement {
+        repositories {
+            mavenCentral()
+            gradlePluginPortal()
+            exclusiveContent {
+                forRepository { mavenLocal() }
+                filter { includeGroup("com.gabrielfeo") }
+            }
+        }
+    }
+}
+
+beforeProject {
+    repositories {
+        exclusiveContent {
+            forRepository { mavenLocal() }
+            filter { includeGroup("com.gabrielfeo") }
+        }
+    }
+}
+
+afterProject {
+    configurations.all {
+        resolutionStrategy {
+            force("com.gabrielfeo:develocity-api-kotlin:SNAPSHOT")
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ val examples = fileTree(rootDir) {`
`27`	`27`	`exclude {`
`28`	`28`	`it.isDirectory`
`29`	`29`	`&& (it.name == "build" \|\| it.name.startsWith("."))`
`30`		`- && !it.path.endsWith("build-logic/src/main/kotlin/build")`
	`30`	`+ && !it.path.endsWith("buildSrc/src/main/kotlin/build")`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`
Original file line number	Diff line number	Diff line change
`@@ -6,3 +6,7 @@ dependencies {`
`6`	`6`	`implementation("com.gabrielfeo:develocity-api-kotlin:2024.3.0")`
`7`	`7`	`implementation("org.apache.commons:commons-math3:3.6.1")`
`8`	`8`	`}`
	`9`	`+`
	`10`	`+repositories {`
	`11`	`+ mavenCentral()`
	`12`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+rootProject.name = "dak-example-gradle-task-build-src"`