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

TestApplicationEngine

class TestApplicationEngine(environment: ApplicationEnvironment = createTestEnvironment(), monitor: Events, developmentMode: Boolean = true, applicationProvider: () -> Application, configuration: TestApplicationEngine.Configuration) : BaseApplicationEngine, CoroutineScope

A test engine that provides a way to simulate application calls to the existing application module(s) without actual HTTP connection.

Constructors

constructor(environment: ApplicationEnvironment = createTestEnvironment(), monitor: Events, developmentMode: Boolean = true, applicationProvider: () -> Application, configuration: TestApplicationEngine.Configuration)

Types

Configuration

class Configuration : BaseApplicationEngine.Configuration

An engine configuration for a test application.

Properties

application

val application: Application

callInterceptor

var callInterceptor: PipelineInterceptor<Unit, PipelineCall>

client

val client: HttpClient

coroutineContext

open override val coroutineContext: CoroutineContext

engine

val engine: HttpClientEngine

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

environment

override val environment: ApplicationEnvironment

pipeline

val pipeline: EnginePipeline

Functions

cookiesSession

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

Keeps cookies between requests inside the callback.

createCall

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

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

handleRequest

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

Makes a test request.

handleRequest

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

Makes a test request.

handleWebSocket

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

Makes a test request that sets up a websocket session and waits for completion.

handleWebSocketConversation

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

Makes a test request that sets up a WebSocket session and invokes the callback function that handles conversation with the server

hookRequests

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

Installs a hook for test requests.

resolvedConnectors

open suspend override fun resolvedConnectors(): List<EngineConnectorConfig>

start

open override fun start(wait: Boolean): ApplicationEngine

stop

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