ktor-server-test-host/io.ktor.server.testing/TestApplicationEngine

TestApplicationEngine

class TestApplicationEngine(environment: ApplicationEngineEnvironment, configure: TestApplicationEngine.Configuration.() -> Unit) : BaseApplicationEngine, CoroutineScope

ktor test engine that provides way to simulate application calls to existing application module(s) without actual HTTP connection

Constructors

fun TestApplicationEngine(environment: ApplicationEngineEnvironment = createTestEnvironment(), configure: TestApplicationEngine.Configuration.() -> Unit = {})

Types

Configuration

class Configuration : BaseApplicationEngine.Configuration

Test application engine configuration

Functions

createCall

fun createCall(readResponse: Boolean = false, closeRequest: Boolean = true, setup: TestApplicationRequest.() -> Unit): TestApplicationCall

Creates an instance of test call but doesn't start request processing

handleRequest

fun handleRequest(closeRequest: Boolean = true, setup: TestApplicationRequest.() -> Unit): TestApplicationCall

Make a test request

handleWebSocket

fun handleWebSocket(uri: String, setup: TestApplicationRequest.() -> Unit): TestApplicationCall

Make a test request that setup a websocket session and wait for completion

handleWebSocketConversation

fun handleWebSocketConversation(uri: String, setup: TestApplicationRequest.() -> Unit = {}, callback: suspend TestApplicationCall.(incoming: ReceiveChannel<Frame>, outgoing: SendChannel<Frame>) -> Unit): TestApplicationCall

Make a test request that setup a websocket session and invoke callback function that does conversation with server

hookRequests

fun hookRequests(processRequest: TestApplicationRequest.(setup: TestApplicationRequest.() -> Unit) -> Unit, processResponse: TestApplicationCall.() -> Unit, block: () -> Unit)

Install a hook for test requests

start

open override fun start(wait: Boolean): ApplicationEngine

stop

open override fun stop(gracePeriodMillis: Long, timeoutMillis: Long)

~~open~~ ~~fun~~ ~~stop~~(~~gracePeriod~~: Long, ~~timeout~~: Long, ~~timeUnit~~: TimeUnit)

Properties

application

open val application: Application

callInterceptor

var callInterceptor: PipelineInterceptor<Unit, ApplicationCall>

interceptor for engine calls. can be modified to emulate certain engine behaviour (e.g. error handling)

client

val client: HttpClient

A client instance connected to this test server instance. Only works until engine stop invocation.

coroutineContext

open override val coroutineContext: CoroutineContext

engine

val engine: HttpClientEngine

An instance of client engine user to be used in client.

environment

override val environment: ApplicationEngineEnvironment

pipeline

val pipeline: EnginePipeline

Extensions

cookiesSession

fun TestApplicationEngine.cookiesSession(callback: () -> Unit)

Keep cookies between requests inside the callback.

handleRequest

fun TestApplicationEngine.handleRequest(method: HttpMethod, uri: String, setup: TestApplicationRequest.() -> Unit = {}): TestApplicationCall

Make a test request