Isolate test and integrationTest from server and env (#492)

gabrielfeo · web-flow · commit 035d2729a0cd · 2025-09-13T16:42:58.000Z
`test` should contain strictly unit tests, which should not be sensitive
to environment variables. Integration tests should test integration
between classes, without a dependency on a real Develocity server or
environment variables.

Change `integrationTest` cases that rely on a response to use
mockwebserver and ensure both test suites run with no environment
variables set. Also refactor test fixtures configuration to a separate
plugin and include them for `examplesTest`, whose `Resources.kt` is now
moved to `testFixtures`.
diff --git a/build-logic/src/main/kotlin/com/gabrielfeo/integration-test-suite.gradle.kts b/build-logic/src/main/kotlin/com/gabrielfeo/integration-test-suite.gradle.kts
@@ -13,26 +13,14 @@ testing {
     }
 }
 
-tasks.named("check") {
-    dependsOn("integrationTest")
-}
-
 kotlin {
     target {
         val main by compilations.getting
         val integrationTest by compilations.getting
-        val test by compilations.getting
-        val testFixtures by compilations.getting
-        test.associateWith(main)
-        test.associateWith(testFixtures)
         integrationTest.associateWith(main)
-        integrationTest.associateWith(testFixtures)
-        testFixtures.associateWith(main)
     }
 }
 
-// TODO Unapply test-fixtures and delete the source set, since we're not publishing it?
-components.named<AdhocComponentWithVariants>("java") {
-    withVariantsFromConfiguration(configurations["testFixturesApiElements"]) { skip() }
-    withVariantsFromConfiguration(configurations["testFixturesRuntimeElements"]) { skip() }
+tasks.named("check") {
+    dependsOn("integrationTest")
 }
diff --git a/build-logic/src/main/kotlin/com/gabrielfeo/test-fixtures.gradle.kts b/build-logic/src/main/kotlin/com/gabrielfeo/test-fixtures.gradle.kts
@@ -0,0 +1,22 @@
+package com.gabrielfeo
+
+plugins {
+    id("org.jetbrains.kotlin.jvm")
+    `java-test-fixtures`
+}
+
+kotlin {
+    target {
+        val main by compilations.getting
+        val testFixtures by compilations.getting
+        testFixtures.associateWith(main)
+        compilations.named { it.endsWith("test", ignoreCase = true) }.configureEach {
+            associateWith(testFixtures)
+        }
+    }
+}
+
+components.named<AdhocComponentWithVariants>("java") {
+    withVariantsFromConfiguration(configurations["testFixturesApiElements"]) { skip() }
+    withVariantsFromConfiguration(configurations["testFixturesRuntimeElements"]) { skip() }
+}
diff --git a/library/build.gradle.kts b/library/build.gradle.kts
@@ -7,6 +7,7 @@ plugins {
     id("com.gabrielfeo.develocity-api-code-generation")
     id("com.gabrielfeo.integration-test-suite")
     id("com.gabrielfeo.examples-test-suite")
+    id("com.gabrielfeo.test-fixtures")
 }
 
 // Order matters as this library is used as a Kotlin Jupyter kernel dependency (see #440)
@@ -37,6 +38,7 @@ dependencies {
     integrationTestImplementation(libs.kotlin.jupyter.testkit)
     integrationTestImplementation(libs.logback.core)
     integrationTestImplementation(libs.logback.classic)
+    integrationTestImplementation(libs.okhttp.mockwebserver)
 }
 
 val libraryPom = Action<MavenPom> {
@@ -119,9 +121,14 @@ tasks.withType<Test>().configureEach {
         "junit.jupiter.tempdir.cleanup.mode.default",
         System.getProperty("junit.jupiter.tempdir.cleanup.mode.default") ?: "always",
     )
-    providers.environmentVariablesPrefixedBy("DEVELOCITY_API_").get().forEach { (name, value) ->
-        inputs.property("${name}.hashCode", value.hashCode())
-    }
+}
+
+tasks.named<Test>("test") {
+    environment = emptyMap()
+}
+
+tasks.named<Test>("integrationTest") {
+    environment = emptyMap()
 }
 
 val publishUnsignedSnapshotDevelocityApiKotlinPublicationToMavenLocal by tasks.getting
@@ -130,4 +137,7 @@ tasks.named<Test>("examplesTest") {
     inputs.files(files(publishUnsignedSnapshotDevelocityApiKotlinPublicationToMavenLocal))
         .withPropertyName("snapshotPublicationArtifacts")
         .withNormalizer(ClasspathNormalizer::class)
+    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
@@ -9,8 +9,8 @@ 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.copyFromResources
 import com.gabrielfeo.develocity.api.example.BuildStartTime
-import com.gabrielfeo.develocity.api.example.copyFromResources
 import com.gabrielfeo.develocity.api.example.runInShell
 import kotlin.io.path.div
 
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
@@ -10,7 +10,7 @@ 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.copyFromResources
 import com.gabrielfeo.develocity.api.example.runInShell
 
 @TestMethodOrder(OrderAnnotation::class)
diff --git a/library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/notebook/Jupyter.kt b/library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/notebook/Jupyter.kt
@@ -1,7 +1,7 @@
 package com.gabrielfeo.develocity.api.example.notebook
 
+import com.gabrielfeo.develocity.api.copyFromResources
 import com.gabrielfeo.develocity.api.example.OutputStreams
-import com.gabrielfeo.develocity.api.example.copyFromResources
 import com.gabrielfeo.develocity.api.example.runInShell
 import java.nio.file.Path
 import kotlin.io.path.div
diff --git a/library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/notebook/NotebooksTest.kt b/library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/notebook/NotebooksTest.kt
@@ -1,8 +1,8 @@
 package com.gabrielfeo.develocity.api.example.notebook
 
+import com.gabrielfeo.develocity.api.copyFromResources
 import com.gabrielfeo.develocity.api.example.JsonAdapter
 import com.gabrielfeo.develocity.api.example.Queries
-import com.gabrielfeo.develocity.api.example.copyFromResources
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
diff --git a/library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/script/ScriptsTest.kt b/library/src/examplesTest/kotlin/com/gabrielfeo/develocity/api/example/script/ScriptsTest.kt
@@ -1,7 +1,7 @@
 package com.gabrielfeo.develocity.api.example.script
 
+import com.gabrielfeo.develocity.api.copyFromResources
 import com.gabrielfeo.develocity.api.example.Queries
-import com.gabrielfeo.develocity.api.example.copyFromResources
 import com.gabrielfeo.develocity.api.example.runInShell
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.BeforeEach
diff --git a/library/src/integrationTest/kotlin/com/gabrielfeo/develocity/api/DevelocityApiIntegrationTest.kt b/library/src/integrationTest/kotlin/com/gabrielfeo/develocity/api/DevelocityApiIntegrationTest.kt
@@ -3,6 +3,8 @@ package com.gabrielfeo.develocity.api
 import com.gabrielfeo.develocity.api.internal.*
 import com.google.common.reflect.ClassPath
 import kotlinx.coroutines.test.runTest
+import okhttp3.mockwebserver.MockResponse
+import okhttp3.mockwebserver.MockWebServer
 import org.junit.jupiter.api.assertDoesNotThrow
 import java.net.URI
 import kotlin.reflect.KVisibility.PUBLIC
@@ -13,30 +15,63 @@ import kotlin.test.*
 @OptIn(ExperimentalStdlibApi::class)
 class DevelocityApiIntegrationTest {
 
-    @Test
-    fun canFetchBuildsWithDefaultConfig() = runTest {
-        env = RealEnv
-        val api = DevelocityApi.newInstance(
-            config = Config(
-                cacheConfig = Config.CacheConfig(cacheEnabled = false)
-            )
+    private lateinit var mockWebServer: MockWebServer
+    private lateinit var mockWebServerEnv: Env
+    private val emptyEnv: Env = FakeEnv()
+
+    @BeforeTest
+    fun setUp() {
+        mockWebServer = MockWebServer().apply { start() }
+        mockWebServerEnv = FakeEnv(
+            "DEVELOCITY_URL" to mockWebServer.url("/").toString(),
+            "DEVELOCITY_ACCESS_KEY" to "${mockWebServer.url("/").host}=foo",
+            "DEVELOCITY_CACHE_ENABLED" to "false",
         )
-        val builds = api.buildsApi.getBuilds(
-            since = 0,
-            maxBuilds = 5,
-            query = """buildStartTime>-7d""",
+    }
+
+    @AfterTest
+    fun tearDown() {
+        mockWebServer.shutdown()
+    }
+
+    @Test
+    fun canFetchBuildsWithEnvVarConfigAndEmptyBuildsResponse() = runTest {
+        env = mockWebServerEnv
+        mockWebServer.enqueue(MockResponse().setBody("[]"))
+        val api = DevelocityApi.newInstance()
+        val builds = api.buildsApi.getBuilds(fromInstant = 0)
+        assertEquals(0, builds.size)
+        api.shutdown()
+    }
+
+    @Test
+    fun canFetchBuildsWithEnvVarConfigAndNonEmptyBuildsResponse() = runTest {
+        val response = requireResource("/response/api/builds/5-builds.json").readText()
+        mockWebServer.enqueue(MockResponse().setBody(response))
+        env = mockWebServerEnv
+        val api = DevelocityApi.newInstance()
+        val builds = api.buildsApi.getBuilds(fromInstant = 0)
+        assertContentEquals(
+            listOf(
+                "67b3o5ld6iwc2",
+                "e2bajrtqpe4bi",
+                "rb5bbp6hxpcto",
+                "gur3efx4fnqsc",
+                "tw3yw5fhovwtq",
+            ),
+            builds.map { it.id },
         )
-        assertEquals(5, builds.size)
         api.shutdown()
     }
 
     @Test
-    fun canBuildNewInstanceWithPureCodeConfiguration() = runTest {
-        env = FakeEnv()
+    fun canFetchBuildsWithCodeConfig() = runTest {
+        env = emptyEnv
+        mockWebServer.enqueue(MockResponse().setBody("[]"))
         assertDoesNotThrow {
             val config = Config(
-                server = URI("https://example.com/"),
-                accessKey = { "example.com=example-token" }
+                server = mockWebServer.url("/").toUri(),
+                accessKey = { "${mockWebServer.url("/").host}=foo" },
             )
             DevelocityApi.newInstance(config)
         }
diff --git a/library/src/integrationTest/kotlin/com/gabrielfeo/develocity/api/LoggingIntegrationTest.kt b/library/src/integrationTest/kotlin/com/gabrielfeo/develocity/api/LoggingIntegrationTest.kt
@@ -47,9 +47,14 @@ class LoggingIntegrationTest {
             })
         }
         recorder.start()
-        env = RealEnv
+        val mockWebServer = okhttp3.mockwebserver.MockWebServer()
+        mockWebServer.enqueue(okhttp3.mockwebserver.MockResponse().setBody("[]"))
+        mockWebServer.start()
+        env = FakeEnv()
         api = DevelocityApi.newInstance(
             config = Config(
+                server = mockWebServer.url("/").toUri(),
+                accessKey = { "${mockWebServer.url("/").host}=foo" },
                 cacheConfig = Config.CacheConfig(
                     cacheEnabled = true,
                     cacheDir = tempDir,
diff --git a/library/src/integrationTest/kotlin/com/gabrielfeo/develocity/api/SmokeTest.kt b/library/src/integrationTest/kotlin/com/gabrielfeo/develocity/api/SmokeTest.kt
@@ -0,0 +1,14 @@
+package com.gabrielfeo.develocity.api
+
+import com.gabrielfeo.develocity.api.internal.RealEnv
+import com.gabrielfeo.develocity.api.internal.asMap
+import kotlin.test.Test
+import kotlin.test.assertTrue
+
+class SmokeTest {
+
+    @Test
+    fun testSuiteNotSensitiveToEnvironment() {
+        assertTrue(RealEnv.asMap().isEmpty())
+    }
+}
diff --git a/library/src/integrationTest/kotlin/com/gabrielfeo/develocity/api/extension/BuildsApiExtensionsIntegrationTest.kt b/library/src/integrationTest/kotlin/com/gabrielfeo/develocity/api/extension/BuildsApiExtensionsIntegrationTest.kt
@@ -10,20 +10,28 @@ import okhttp3.Request
 import org.junit.jupiter.api.*
 import org.junit.jupiter.api.Assertions.*
 import kotlin.test.AfterTest
+import kotlin.test.BeforeTest
 import kotlin.time.Duration.Companion.minutes
 
 class BuildsApiExtensionsIntegrationTest {
 
-    init {
-        env = RealEnv
-    }
-
     private val recorder = RequestRecorder()
-    private val api = buildApi(recorder)
+    private lateinit var api: DevelocityApi
+    private lateinit var mockWebServer: okhttp3.mockwebserver.MockWebServer
 
-    @AfterTest
+    @BeforeTest
     fun setup() {
+        mockWebServer = okhttp3.mockwebserver.MockWebServer()
+        mockWebServer.enqueue(okhttp3.mockwebserver.MockResponse().setBody("[]"))
+        mockWebServer.start()
+        env = FakeEnv()
+        api = buildApi(recorder)
+    }
+
+    @AfterTest
+    fun teardown() {
         api.shutdown()
+        mockWebServer.shutdown()
     }
 
     @Test
@@ -73,6 +81,8 @@ class BuildsApiExtensionsIntegrationTest {
     private fun buildApi(recorder: RequestRecorder) =
         DevelocityApi.newInstance(
             config = Config(
+                server = mockWebServer.url("/").toUri(),
+                accessKey = { "${mockWebServer.url("/").host}=foo" },
                 clientBuilder = recorder.clientBuilder(),
                 cacheConfig = Config.CacheConfig(cacheEnabled = false),
             )
diff --git a/library/src/integrationTest/kotlin/com/gabrielfeo/develocity/api/internal/jupyter/DevelocityApiJupyterIntegrationTest.kt b/library/src/integrationTest/kotlin/com/gabrielfeo/develocity/api/internal/jupyter/DevelocityApiJupyterIntegrationTest.kt
@@ -25,17 +25,25 @@ class DevelocityApiJupyterIntegrationTest : JupyterReplTestCase() {
 
     @Test
     fun `Given default clientBuilder, re-uses OkHttpClient resources`() {
-        execSuccess("val api = DevelocityApi.newInstance()")
-        execSuccess("val api2 = DevelocityApi.newInstance()")
+        val config = """Config(server = java.net.URI("https://foo.com"), accessKey = { "foo.com=bar" })"""
+        execSuccess("""val api = DevelocityApi.newInstance($config)""")
+        execSuccess("""val api2 = DevelocityApi.newInstance($config)""")
         val connectionPool1 = execRendered("api.config.clientBuilder.build().connectionPool.hashCode()")
         val connectionPool2 = execRendered("api2.config.clientBuilder.build().connectionPool.hashCode()")
         assertEquals(connectionPool1, connectionPool2)
     }
 
     @Test
     fun `Given custom clientBuilder set, does not re-use OkHttpClient resources`() {
-        execSuccess("val api = DevelocityApi.newInstance(Config(clientBuilder = okhttp3.OkHttpClient.Builder()))")
-        execSuccess("val api2 = DevelocityApi.newInstance(Config(clientBuilder = okhttp3.OkHttpClient.Builder()))")
+        val config = """
+            Config(
+                server = java.net.URI("https://foo.com"),
+                accessKey = { "foo.com=bar" },
+                clientBuilder = okhttp3.OkHttpClient.Builder(),
+            )
+        """.trimIndent()
+        execSuccess("val api = DevelocityApi.newInstance($config)")
+        execSuccess("val api2 = DevelocityApi.newInstance($config)")
         val connectionPool1 = execRendered("api.config.clientBuilder.build().connectionPool.hashCode()")
         val connectionPool2 = execRendered("api2.config.clientBuilder.build().connectionPool.hashCode()")
         assertNotEquals(connectionPool1, connectionPool2)
diff --git a/library/src/integrationTest/resources/response/api/builds/5-builds.json b/library/src/integrationTest/resources/response/api/builds/5-builds.json
@@ -0,0 +1,37 @@
+[
+  {
+    "id": "67b3o5ld6iwc2",
+    "availableAt": 1754424892386,
+    "buildToolType": "gradle",
+    "buildToolVersion": "9.0.0",
+    "buildAgentVersion": "4.1"
+  },
+  {
+    "id": "e2bajrtqpe4bi",
+    "availableAt": 1754425137741,
+    "buildToolType": "gradle",
+    "buildToolVersion": "9.0.0",
+    "buildAgentVersion": "4.1"
+  },
+  {
+    "id": "rb5bbp6hxpcto",
+    "availableAt": 1754425141088,
+    "buildToolType": "gradle",
+    "buildToolVersion": "9.0.0",
+    "buildAgentVersion": "4.1"
+  },
+  {
+    "id": "gur3efx4fnqsc",
+    "availableAt": 1757168772917,
+    "buildToolType": "gradle",
+    "buildToolVersion": "8.14.3",
+    "buildAgentVersion": "4.1.1"
+  },
+  {
+    "id": "tw3yw5fhovwtq",
+    "availableAt": 1757168910932,
+    "buildToolType": "gradle",
+    "buildToolVersion": "8.14.3",
+    "buildAgentVersion": "4.1.1"
+  }
+]
diff --git a/library/src/main/kotlin/com/gabrielfeo/develocity/api/internal/Env.kt b/library/src/main/kotlin/com/gabrielfeo/develocity/api/internal/Env.kt
@@ -9,3 +9,6 @@ internal interface Env {
 internal object RealEnv : Env {
     override fun get(name: String): String? = System.getenv(name)
 }
+
+@Suppress("UnusedReceiverParameter")
+internal fun RealEnv.asMap(): Map<String, String> = System.getenv()
diff --git a/library/src/testFixtures/kotlin/com/gabrielfeo/develocity/api/Resources.kt b/library/src/testFixtures/kotlin/com/gabrielfeo/develocity/api/Resources.kt

Original file line number	Diff line number	Diff line change
`@@ -13,26 +13,14 @@ testing {`
`13`	`13`	`}`
`14`	`14`	`}`
`15`	`15`
`16`		`-tasks.named("check") {`
`17`		`- dependsOn("integrationTest")`
`18`		`-}`
`19`		`-`
`20`	`16`	`kotlin {`
`21`	`17`	`target {`
`22`	`18`	`val main by compilations.getting`
`23`	`19`	`val integrationTest by compilations.getting`
`24`		`- val test by compilations.getting`
`25`		`- val testFixtures by compilations.getting`
`26`		`- test.associateWith(main)`
`27`		`- test.associateWith(testFixtures)`
`28`	`20`	`integrationTest.associateWith(main)`
`29`		`- integrationTest.associateWith(testFixtures)`
`30`		`- testFixtures.associateWith(main)`
`31`	`21`	`}`
`32`	`22`	`}`
`33`	`23`
`34`		`-// TODO Unapply test-fixtures and delete the source set, since we're not publishing it?`
`35`		`-components.named<AdhocComponentWithVariants>("java") {`
`36`		`- withVariantsFromConfiguration(configurations["testFixturesApiElements"]) { skip() }`
`37`		`- withVariantsFromConfiguration(configurations["testFixturesRuntimeElements"]) { skip() }`
	`24`	`+tasks.named("check") {`
	`25`	`+ dependsOn("integrationTest")`
`38`	`26`	`}`