Skip to content

Ktor Client でのテスト ​

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

コード例: client-testing-mock

Ktor は、エンドポイントに実際に接続することなく HTTP 呼び出しをシミュレートする MockEngine を提供します。

依存関係の追加 ​

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

その後、CIO エンジンを備えた HTTP クライアントを作成してリクエストを実行するために、ApiClient を次のように使用できます。

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

クライアントのテスト ​

クライアントをテストするには、リクエストパラメータをチェックし、必要なコンテンツ(今回の例では JSON オブジェクト)で応答できるハンドラーを持つ MockEngine インスタンスを作成する必要があります。

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 やホスト名による分岐)。これにより、モックを呼び出し順序に依存しない状態に保つことができます。

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