Ktor Client のテスト

必要な依存関係: io.ktor:ktor-client-mock

コード例: client-testing-mock

Ktor は、エンドポイントに接続せずに HTTP 呼び出しをシミュレートする MockEngine を提供します。

依存関係の追加

MockEngine を使用する前に、ビルドスクリプトに ktor-client-mock アーティファクトを含める必要があります。

Gradle (Kotlin)Gradle (Groovy)Maven

使い方

クライアント設定の共有

MockEngine を使用してクライアントをテストする方法を見てみましょう。クライアントが次の設定を持っていると仮定します。

• リクエストの作成に CIO エンジンが使用されている。
• 受信した JSON データをデシリアライズするために Json プラグインがインストールされている。

このクライアントをテストするには、その設定を MockEngine を使用するテストクライアントと共有する必要があります。設定を共有するには、エンジンをコンストラクタパラメータとして受け取り、クライアント設定を含むクライアントラッパークラスを作成します。

@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()
}

その後、次のように ApiClient を使用して CIO エンジンで HTTP クライアントを作成し、リクエストを行うことができます。

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

クライアントのテスト

クライアントをテストするには、リクエストパラメータをチェックし、必要なコンテンツ（今回の場合は JSON オブジェクト）でレスポンスを返すハンドラーを備えた MockEngine インスタンスを作成する必要があります。

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

その後、作成した MockEngine を渡して ApiClient を初期化し、必要なアサーションを実行できます。

class ApiClientTest {
    @Test
    fun sampleClientTest() {
        runBlocking {
            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)

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

完全な例はこちらで確認できます: client-testing-mock。