Skip to content

在 Ktor Client 中进行测试 ​

必需依赖项:io.ktor:ktor-client-mock

代码示例: client-testing-mock

Ktor 提供了 MockEngine,可在不连接端点的情况下模拟 HTTP 调用。

添加依赖项 ​

在使用 MockEngine 之前,您需要在构建脚本中包含 ktor-client-mock 工件。

kotlin
testImplementation("io.ktor:ktor-client-mock:$ktor_version")
groovy
testImplementation "io.ktor:ktor-client-mock:$ktor_version"
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-client-mock-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

用法 ​

共享客户端配置 ​

我们来看看如何使用 MockEngine 来测试客户端。假设客户端具有以下配置:

  • 使用 CIO 引擎 发送请求。
  • 安装了 Json 插件以反序列化传入的 JSON 数据。

要测试此客户端,需要将其配置与使用 MockEngine 的测试客户端共享。要共享配置,您可以创建一个客户端包装类,该类将引擎作为构造函数形参并包含客户端配置。

kotlin
@Serializable
data class IpResponse(val ip: String)
class ApiClient(engine: HttpClientEngine) {
    private val httpClient = HttpClient(engine) {
        install(ContentNegotiation) {
            json()
        }
    }

    suspend fun getIp(): IpResponse = httpClient.get("https://api.ipify.org/?format=json").body()

    suspend fun getUser(): String = httpClient.get("https://api.example.com/user").body()

    suspend fun getOrders(): String = httpClient.get("https://api.example.com/orders").body()
}

然后,您可以按如下方式使用 ApiClient,以通过 CIO 引擎创建 HTTP 客户端并发起请求。

kotlin
fun main() {
    runBlocking {
        val client = ApiClient(CIO.create())
        val response = client.getIp()
        println(response.ip)
    }

测试客户端 ​

要测试客户端,您需要创建一个带有处理程序的 MockEngine 实例,该处理程序可以检查请求形参并返回所需内容(在我们的示例中为一个 JSON 对象)。

kotlin
val mockEngine = MockEngine { request ->
    respond(
        content = ByteReadChannel("""{"ip":"127.0.0.1"}"""),
        status = HttpStatusCode.OK,
        headers = headersOf(HttpHeaders.ContentType, "application/json")
    )
}

然后,您可以传入创建的 MockEngine 来初始化 ApiClient 并进行必要的断言。

kotlin
class ApiClientTest {
    @Test
    fun sampleClientTest() {
        runTest {
            val mockEngine = MockEngine { request ->
                respond(
                    content = ByteReadChannel("""{"ip":"127.0.0.1"}"""),
                    status = HttpStatusCode.OK,
                    headers = headersOf(HttpHeaders.ContentType, "application/json")
                )
            }
            val apiClient = ApiClient(mockEngine)

            assertEquals("127.0.0.1", apiClient.getIp().ip)
        }
    }

模拟多个端点 ​

当客户端调用多个 URL 时,请使用单个可重用的处理程序并根据请求进行分支(例如 request.url.encodedPath 或 host)。这可以使模拟独立于调用顺序:

kotlin
val mockEngine = MockEngine { request ->
    when (request.url.encodedPath) {
        "/user" -> respondOk("user-1")
        "/orders" -> respondOk("order-1,order-2")
        else -> error("Unhandled ${request.url}")
    }
}

在 else 分支中针对未预期的 URL 抛出错误,以确保测试不会静默接受缺失的模拟。 当不同主机使用相同的路径时,您还可以匹配 request.url.host。

模拟调用链 ​

要按固定顺序为连续调用返回不同的响应,可以使用 addHandler() 函数注册多个处理程序,并将 reuseHandlers 属性设置为 false 以使每个处理程序仅使用一次:

kotlin
val mockEngine = MockEngine.config {
    reuseHandlers = false
    addHandler { respondOk("step-1") }
    addHandler { respondOk("step-2") }
}

默认情况下,reuseHandlers 属性设置为 true,处理程序会在循环中重复使用。

当 reuseHandlers 属性设置为 false 时,处理程序仅使用一次。如果所有处理程序都已使用完毕,则下一个请求将通过抛出错误被拒绝。

对于先构建客户端、后将响应排入队列的测试,请使用 MockEngine.Queue:

kotlin
            val engine = MockEngine.Queue()
            val client = HttpClient(engine)

            engine += { respondOk("first") }
            engine += { respondOk("second") }

您可以在此处找到完整的示例:client-testing-mock。