Ktor Client에서 테스트하기
필수 의존성: io.ktor:ktor-client-mock
코드 예제: client-testing-mock
Ktor는 엔드포인트에 연결하지 않고 HTTP 호출을 시뮬레이션하는 MockEngine을 제공합니다.
의존성 추가
MockEngine을 사용하기 전에 빌드 스크립트에 ktor-client-mock 아티팩트를 포함해야 합니다.
testImplementation("io.ktor:ktor-client-mock:$ktor_version")testImplementation "io.ktor:ktor-client-mock:$ktor_version"<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-client-mock-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>사용법
클라이언트 설정 공유
MockEngine을 사용하여 클라이언트를 테스트하는 방법을 살펴보겠습니다. 클라이언트에 다음과 같은 설정이 되어 있다고 가정해 보겠습니다.
이 클라이언트를 테스트하려면 해당 설정을 MockEngine을 사용하는 테스트 클라이언트와 공유해야 합니다. 설정을 공유하려면 생성자 파라미터로 엔진을 전달받고 클라이언트 설정을 포함하는 클라이언트 래퍼(wrapper) 클래스를 생성하면 됩니다.
@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 클라이언트를 생성하고 요청을 보낼 수 있습니다.
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를 초기화하고 필요한 단언(assertion)을 수행할 수 있습니다.
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 또는 호스트 기준)하세요. 이렇게 하면 모의 객체(mock)가 호출 순서와 무관하게 유지됩니다.
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로 설정하여 각 핸들러가 한 번씩만 사용되도록 합니다.
val mockEngine = MockEngine.config {
reuseHandlers = false
addHandler { respondOk("step-1") }
addHandler { respondOk("step-2") }
}기본적으로 reuseHandlers 프로퍼티는 true로 설정되어 있으며, 핸들러가 순환하여 재사용됩니다.
reuseHandlers 프로퍼티를 false로 설정하면 핸들러는 한 번만 사용됩니다. 모든 핸들러가 사용된 후 다음 요청이 들어오면 오류를 발생시켜 거부합니다.
클라이언트를 먼저 빌드하고 나중에 응답을 큐에 추가하는 테스트의 경우, MockEngine.Queue를 사용하세요.
val engine = MockEngine.Queue()
val client = HttpClient(engine)
engine += { respondOk("first") }
engine += { respondOk("second") }전체 예제는 여기에서 확인할 수 있습니다: client-testing-mock.
