ktor-client-mock / io.ktor.client.engine.mock / MockEngine

MockEngine

class MockEngine : HttpClientEngineBase

HttpClientEngine for writing tests without network.

Types

Companion

companion object Companion : HttpClientEngineFactory<MockEngineConfig>

Constructors

<init>

MockEngine(config: MockEngineConfig)

HttpClientEngine for writing tests without network.

Properties

config

val config: MockEngineConfig

dispatcher

val dispatcher: CoroutineDispatcher

requestHistory

val requestHistory: List<HttpRequestData>

History of executed requests.

responseHistory

val responseHistory: List<HttpResponseData>

History of sent responses.

supportedCapabilities

val supportedCapabilities: Set<HttpTimeout.Feature>

Functions

close

fun close(): Unit

execute

suspend fun execute(data: HttpRequestData): HttpResponseData

Companion Object Functions

create

fun create(block: MockEngineConfig.() -> Unit): HttpClientEngine

invoke

operator fun invoke(handler: suspend MockRequestHandleScope.(HttpRequestData) -> HttpResponseData): MockEngine

Create MockEngine instance with single request handler.