test: use mock server for tests using GitHub API (#1972)

krzema12 · web-flow · commit c6ed9f769b17 · 2025-05-17T18:55:48.000+02:00
Part of #1884. Removes a dependency on ktor in the tests of GithubApi module. It's needed because we're going to move away of using GitHub's API directly via ktor, and use a library instead. This change focuses only on refactoring the tests to use another mocking mechanism - instead of using ktor's API, it exposes a real mock HTTP server.
diff --git a/shared-internal/build.gradle.kts b/shared-internal/build.gradle.kts
@@ -31,5 +31,6 @@ dependencies {
     // Here's a ticket to remember to remove this workaround: https://github.com/typesafegithub/github-workflows-kt/issues/1832
     runtimeOnly("org.jetbrains.kotlinx:kotlinx-io-core:0.7.0")
 
-    testImplementation("io.ktor:ktor-client-mock:3.1.3")
+    testImplementation("io.kotest.extensions:kotest-extensions-mockserver:1.3.0")
+    testImplementation("org.slf4j:slf4j-simple:2.0.12")
 }
diff --git a/shared-internal/src/main/kotlin/io/github/typesafegithub/workflows/shared/internal/GithubApi.kt b/shared-internal/src/main/kotlin/io/github/typesafegithub/workflows/shared/internal/GithubApi.kt
@@ -7,8 +7,6 @@ import io.github.oshai.kotlinlogging.KotlinLogging.logger
 import io.github.typesafegithub.workflows.shared.internal.model.Version
 import io.ktor.client.HttpClient
 import io.ktor.client.call.body
-import io.ktor.client.engine.HttpClientEngineFactory
-import io.ktor.client.engine.cio.CIO
 import io.ktor.client.plugins.contentnegotiation.ContentNegotiation
 import io.ktor.client.plugins.logging.LogLevel.ALL
 import io.ktor.client.plugins.logging.Logger
@@ -28,28 +26,25 @@ suspend fun fetchAvailableVersions(
     owner: String,
     name: String,
     githubAuthToken: String?,
-    httpClientEngineFactory: HttpClientEngineFactory<*> = CIO,
+    githubEndpoint: String = "https://api.github.com",
 ): Either<String, List<Version>> =
     either {
-        buildHttpClient(engineFactory = httpClientEngineFactory).use { httpClient ->
+        buildHttpClient().use { httpClient ->
             return listOf(
-                apiTagsUrl(owner = owner, name = name),
-                apiBranchesUrl(owner = owner, name = name),
+                apiTagsUrl(githubEndpoint = githubEndpoint, owner = owner, name = name),
+                apiBranchesUrl(githubEndpoint = githubEndpoint, owner = owner, name = name),
             ).flatMap { url -> fetchGithubRefs(url, githubAuthToken, httpClient).bind() }
-                .versions(githubAuthToken, httpClientEngineFactory)
+                .versions(githubAuthToken)
         }
     }
 
-private fun List<GithubRef>.versions(
-    githubAuthToken: String?,
-    httpClientEngineFactory: HttpClientEngineFactory<*>,
-): Either<String, List<Version>> =
+private fun List<GithubRef>.versions(githubAuthToken: String?): Either<String, List<Version>> =
     either {
         this@versions.map { githubRef ->
             val version = githubRef.ref.substringAfterLast("/")
             Version(version) {
                 val response =
-                    buildHttpClient(engineFactory = httpClientEngineFactory).use { httpClient ->
+                    buildHttpClient().use { httpClient ->
                         httpClient
                             .get(urlString = githubRef.`object`.url) {
                                 if (githubAuthToken != null) {
@@ -89,14 +84,16 @@ private suspend fun fetchGithubRefs(
     }
 
 private fun apiTagsUrl(
+    githubEndpoint: String,
     owner: String,
     name: String,
-): String = "https://api.github.com/repos/$owner/$name/git/matching-refs/tags/v"
+): String = "$githubEndpoint/repos/$owner/$name/git/matching-refs/tags/v"
 
 private fun apiBranchesUrl(
+    githubEndpoint: String,
     owner: String,
     name: String,
-): String = "https://api.github.com/repos/$owner/$name/git/matching-refs/heads/v"
+): String = "$githubEndpoint/repos/$owner/$name/git/matching-refs/heads/v"
 
 @Serializable
 private data class GithubRef(
@@ -125,8 +122,8 @@ private data class Person(
     val date: String,
 )
 
-private fun buildHttpClient(engineFactory: HttpClientEngineFactory<*>) =
-    HttpClient(engineFactory) {
+private fun buildHttpClient() =
+    HttpClient {
         val klogger = logger
         install(Logging) {
             logger =
diff --git a/shared-internal/src/test/kotlin/io/github/typesafegithub/workflows/shared/internal/model/GithubApiTest.kt b/shared-internal/src/test/kotlin/io/github/typesafegithub/workflows/shared/internal/model/GithubApiTest.kt
@@ -3,148 +3,141 @@ package io.github.typesafegithub.workflows.shared.internal.model
 import arrow.core.left
 import arrow.core.right
 import io.github.typesafegithub.workflows.shared.internal.fetchAvailableVersions
+import io.kotest.core.extensions.install
 import io.kotest.core.spec.style.FunSpec
+import io.kotest.extensions.mockserver.MockServerExtension
 import io.kotest.matchers.shouldBe
-import io.ktor.client.engine.HttpClientEngineFactory
-import io.ktor.client.engine.mock.MockEngine
-import io.ktor.client.engine.mock.MockEngineConfig
-import io.ktor.client.engine.mock.respond
-import io.ktor.http.HttpHeaders
-import io.ktor.http.HttpStatusCode
-import io.ktor.http.fullPath
-import io.ktor.http.headersOf
-import io.ktor.utils.io.ByteReadChannel
+import org.mockserver.model.HttpRequest.request
+import org.mockserver.model.HttpResponse.response
 
 class GithubApiTest :
-    FunSpec({
-        test("branches with major versions and tags with other versions") {
-            // Given
-            val tagsResponse =
-                """
-                [
-                    {
-                        "ref":"refs/tags/v1.0.0",
-                        "node_id":"MDM6UmVmMTk3ODE0NjI5OnJlZnMvdGFncy92MQ==",
-                        "url":"https://api.github.com/repos/some-owner/some-name/git/refs/tags/v1",
-                        "object": {
-                            "sha":"544eadc6bf3d226fd7a7a9f0dc5b5bf7ca0675b9",
-                            "type":"tag",
-                            "url":"https://api.github.com/repos/actions/some-name/git/tags/544eadc6bf3d226fd7a7a9f0dc5b5bf7ca0675b9"
-                        }
-                    },
-                    {
-                        "ref":"refs/tags/v1.0.1",
-                        "node_id":"MDM6UmVmMTk3ODE0NjI5OnJlZnMvdGFncy92MQ==",
-                        "url":"https://api.github.com/repos/some-owner/some-name/git/refs/tags/v1.0.1",
-                        "object": {
-                            "sha":"af513c7a016048ae468971c52ed77d9562c7c819",
-                            "type":"tag",
-                            "url":"https://api.github.com/repos/actions/some-name/git/tags/af513c7a016048ae468971c52ed77d9562c7c819"
-                        }
-                    }
-                ]
-                """.trimIndent()
-            val headsResponse =
-                """
-                [
-                    {
-                        "ref":"refs/heads/v1",
-                        "node_id":"MDM6UmVmMTk3ODE0NjI5OnJlZnMvaGVhZHMvdm1qb3NlcGgvc2lsZW50LXJldi1wYXJzZQ==",
-                        "url":"https://api.github.com/repos/some-owner/some-name/git/refs/heads/v1",
-                        "object": {
-                            "sha":"af5130cb8882054eda385840657dcbd1e19ab8f4",
-                            "type":"commit",
-                            "url":"https://api.github.com/repos/some-owner/some-name/git/commits/af5130cb8882054eda385840657dcbd1e19ab8f4"
-                        }
-                    },
-                    {
-                        "ref":"refs/heads/v2",
-                        "node_id":"MDM6UmVmMTk3ODE0NjI5OnJlZnMvaGVhZHMvdm1qb3NlcGgvdG9vbGtpdC13aW5kb3dzLWV4ZWM=",
-                        "url":"https://api.github.com/repos/some-owner/some-name/git/refs/heads/v2",
-                        "object": {
-                            "sha":"c22ccee38a13e34cb01a103c324adb1db665821e",
-                            "type":"commit",
-                            "url":"https://api.github.com/repos/some-owner/some-name/git/commits/c22ccee38a13e34cb01a103c324adb1db665821e"
+    FunSpec(
+        {
+            val mockServer = install(MockServerExtension())
+
+            beforeTest {
+                mockServer.reset()
+            }
+
+            val owner = "some-owner"
+            val name = "some-name"
+
+            test("branches with major versions and tags with other versions") {
+                // Given
+                val tagsResponse =
+                    """
+                    [
+                        {
+                            "ref":"refs/tags/v1.0.0",
+                            "node_id":"MDM6UmVmMTk3ODE0NjI5OnJlZnMvdGFncy92MQ==",
+                            "url":"https://api.github.com/repos/some-owner/some-name/git/refs/tags/v1",
+                            "object": {
+                                "sha":"544eadc6bf3d226fd7a7a9f0dc5b5bf7ca0675b9",
+                                "type":"tag",
+                                "url":"https://api.github.com/repos/actions/some-name/git/tags/544eadc6bf3d226fd7a7a9f0dc5b5bf7ca0675b9"
+                            }
+                        },
+                        {
+                            "ref":"refs/tags/v1.0.1",
+                            "node_id":"MDM6UmVmMTk3ODE0NjI5OnJlZnMvdGFncy92MQ==",
+                            "url":"https://api.github.com/repos/some-owner/some-name/git/refs/tags/v1.0.1",
+                            "object": {
+                                "sha":"af513c7a016048ae468971c52ed77d9562c7c819",
+                                "type":"tag",
+                                "url":"https://api.github.com/repos/actions/some-name/git/tags/af513c7a016048ae468971c52ed77d9562c7c819"
+                            }
                         }
-                    }
-                ]
-                """.trimIndent()
-            val mockEngineFactory =
-                object : HttpClientEngineFactory<MockEngineConfig> {
-                    override fun create(block: MockEngineConfig.() -> Unit) =
-                        MockEngine { request ->
-                            if ("matching-refs/tags" in request.url.fullPath) {
-                                respond(
-                                    // language=json
-                                    content = ByteReadChannel(tagsResponse),
-                                    status = HttpStatusCode.OK,
-                                    headers = headersOf(HttpHeaders.ContentType, "application/json"),
-                                )
-                            } else if ("matching-refs/heads" in request.url.fullPath) {
-                                respond(
-                                    // language=json
-                                    content = ByteReadChannel(headsResponse),
-                                    status = HttpStatusCode.OK,
-                                    headers = headersOf(HttpHeaders.ContentType, "application/json"),
-                                )
-                            } else {
-                                respond(
-                                    content = ByteReadChannel("The mock client wasn't prepared for this request"),
-                                    status = HttpStatusCode.NotFound,
-                                )
+                    ]
+                    """.trimIndent()
+                val headsResponse =
+                    """
+                    [
+                        {
+                            "ref":"refs/heads/v1",
+                            "node_id":"MDM6UmVmMTk3ODE0NjI5OnJlZnMvaGVhZHMvdm1qb3NlcGgvc2lsZW50LXJldi1wYXJzZQ==",
+                            "url":"https://api.github.com/repos/some-owner/some-name/git/refs/heads/v1",
+                            "object": {
+                                "sha":"af5130cb8882054eda385840657dcbd1e19ab8f4",
+                                "type":"commit",
+                                "url":"https://api.github.com/repos/some-owner/some-name/git/commits/af5130cb8882054eda385840657dcbd1e19ab8f4"
+                            }
+                        },
+                        {
+                            "ref":"refs/heads/v2",
+                            "node_id":"MDM6UmVmMTk3ODE0NjI5OnJlZnMvaGVhZHMvdm1qb3NlcGgvdG9vbGtpdC13aW5kb3dzLWV4ZWM=",
+                            "url":"https://api.github.com/repos/some-owner/some-name/git/refs/heads/v2",
+                            "object": {
+                                "sha":"c22ccee38a13e34cb01a103c324adb1db665821e",
+                                "type":"commit",
+                                "url":"https://api.github.com/repos/some-owner/some-name/git/commits/c22ccee38a13e34cb01a103c324adb1db665821e"
                             }
                         }
-                }
+                    ]
+                    """.trimIndent()
+                mockServer
+                    .`when`(request().withPath("/repos/$owner/$name/git/matching-refs/tags/v"))
+                    .respond(
+                        response()
+                            .withStatusCode(200)
+                            .withHeader("Content-Type", "application/json")
+                            .withBody(tagsResponse),
+                    )
+                mockServer
+                    .`when`(request().withPath("/repos/$owner/$name/git/matching-refs/heads/v"))
+                    .respond(
+                        response()
+                            .withStatusCode(200)
+                            .withHeader("Content-Type", "application/json")
+                            .withBody(headsResponse),
+                    )
 
-            // When
-            val versionsOrError =
-                fetchAvailableVersions(
-                    owner = "some-owner",
-                    name = "some-name",
-                    githubAuthToken = "token",
-                    httpClientEngineFactory = mockEngineFactory,
-                )
+                // When
+                val versionsOrError =
+                    fetchAvailableVersions(
+                        owner = owner,
+                        name = name,
+                        githubAuthToken = "token",
+                        githubEndpoint = "http://localhost:${mockServer.port}",
+                    )
 
-            // Then
-            versionsOrError shouldBe
-                listOf(
-                    Version("v1.0.0"),
-                    Version("v1.0.1"),
-                    Version("v1"),
-                    Version("v2"),
-                ).right()
-        }
+                // Then
+                versionsOrError shouldBe
+                    listOf(
+                        Version("v1.0.0"),
+                        Version("v1.0.1"),
+                        Version("v1"),
+                        Version("v2"),
+                    ).right()
+            }
 
-        test("error occurs when fetching branches and tags") {
-            // Given
-            val mockEngineFactory =
-                object : HttpClientEngineFactory<MockEngineConfig> {
-                    override fun create(block: MockEngineConfig.() -> Unit) =
-                        MockEngine { request ->
-                            respond(
-                                // language=json
-                                content = ByteReadChannel("""{"message":  "There was a problem!"}"""),
-                                status = HttpStatusCode.Forbidden,
-                                headers = headersOf(HttpHeaders.ContentType, "application/json"),
-                            )
-                        }
-                }
+            test("error occurs when fetching branches and tags") {
+                // Given
+                mockServer
+                    .`when`(request())
+                    .respond(
+                        response()
+                            .withStatusCode(403)
+                            .withHeader("Content-Type", "application/json")
+                            .withBody("""{"message":  "There was a problem!"}"""),
+                    )
 
-            // When
-            val versionsOrError =
-                fetchAvailableVersions(
-                    owner = "some-owner",
-                    name = "some-name",
-                    githubAuthToken = "token",
-                    httpClientEngineFactory = mockEngineFactory,
-                )
+                // When
+                val versionOrError =
+                    fetchAvailableVersions(
+                        owner = owner,
+                        name = name,
+                        githubAuthToken = "token",
+                        githubEndpoint = "http://localhost:${mockServer.port}",
+                    )
 
-            // Then
-            versionsOrError shouldBe
-                (
-                    "Unexpected response when fetching refs from " +
-                        "https://api.github.com/repos/some-owner/some-name/git/matching-refs/tags/v. " +
-                        "Status: 403 Forbidden, response: {\"message\":  \"There was a problem!\"}"
-                ).left()
-        }
-    })
+                // Then
+                versionOrError shouldBe
+                    (
+                        "Unexpected response when fetching refs from " +
+                            "http://localhost:${mockServer.port}/" +
+                            "repos/some-owner/some-name/git/matching-refs/tags/v. " +
+                            "Status: 403 Forbidden, response: {\"message\":  \"There was a problem!\"}"
+                    ).left()
+            }
+        },
+    )

Original file line number	Diff line number	Diff line change
`@@ -31,5 +31,6 @@ dependencies {`
`31`	`31`	`// Here's a ticket to remember to remove this workaround: https://github.com/typesafegithub/github-workflows-kt/issues/1832`
`32`	`32`	`runtimeOnly("org.jetbrains.kotlinx:kotlinx-io-core:0.7.0")`
`33`	`33`
`34`		`- testImplementation("io.ktor:ktor-client-mock:3.1.3")`
	`34`	`+ testImplementation("io.kotest.extensions:kotest-extensions-mockserver:1.3.0")`
	`35`	`+ testImplementation("org.slf4j:slf4j-simple:2.0.12")`
`35`	`36`	`}`