Ktor Client 測試
必要相依性: io.ktor:ktor-client-mock
程式碼範例: client-testing-mock
Ktor 提供了 MockEngine,可在不連線至端點的情況下模擬 HTTP 呼叫。
新增相依性
在使用 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 的測試用戶端共用。若要共用配置,您可以建立一個用戶端包裝類別,將引擎作為建構函式參數傳入,並包含該用戶端配置。
@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)
}測試用戶端
若要測試用戶端,您需要建立一個 MockEngine 執行個體,並搭配一個能夠檢查請求參數並傳回所需內容(在我們的範例中為 JSON 物件)的處理常式。
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() {
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 或主機名稱)。這能使模擬獨立於呼叫順序:
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。
