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

Package-level declarations

Types

ApplicationTestBuilder

class ApplicationTestBuilder : TestApplicationBuilder, ClientProvider

A builder for a test that uses TestApplication.

interface ClientProvider

A client attached to TestApplication.

ExpectedTestException

open class ExpectedTestException(message: String) : Throwable

Exception that is expected to be thrown during test execution. It will not be logged and will not fail the test.

ExternalServicesBuilder

class ExternalServicesBuilder

Registers mocks for external services.

object It

it function receiver object

object On

on function receiver object

TestApplication

class TestApplication : ClientProvider

A configured instance of a test application running locally.

TestApplicationBuilder

open class TestApplicationBuilder

A builder for TestApplication.

TestApplicationCall

class TestApplicationCall(application: Application, readResponse: Boolean = false, closeRequest: Boolean = true, val coroutineContext: CoroutineContext) : BaseApplicationCall, CoroutineScope

A test application call that is used in withTestApplication and handleRequest.

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.

TestApplicationRequest

class TestApplicationRequest(call: TestApplicationCall, closeRequest: Boolean, var method: HttpMethod = HttpMethod.Get, var uri: String = "/", var port: Int? = null, var version: String = "HTTP/1.1") : BaseApplicationRequest, CoroutineScope

A test application request

TestApplicationResponse

class TestApplicationResponse(call: TestApplicationCall, readResponse: Boolean = false) : BaseApplicationResponse, CoroutineScope

A test call response received from a server.

object TestEngine : ApplicationEngineFactory<TestApplicationEngine, TestApplicationEngine.Configuration>

An ApplicationEngineFactory providing a CIO-based ApplicationEngine.

Functions

fun TestApplicationResponse.awaitWebSocket(duration: Duration)

Wait for websocket session completion

fun TestApplicationResponse.contentType(): ContentType

Returns a parsed content type from a test response.

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

Keeps cookies between requests inside the callback.

createTestEnvironment

fun createTestEnvironment(configure: ApplicationEnvironmentBuilder.() -> Unit = {}): ApplicationEnvironment

Creates an engine environment for a test application.

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

Makes a test request.

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

inline fun On.it(description: String, body: It.() -> Unit)

DSL function for a test case assertions

inline fun on(comment: String, body: On.() -> Unit)

DSL for creating a test case

runTestApplication

suspend fun runTestApplication(parentCoroutineContext: CoroutineContext = EmptyCoroutineContext, block: suspend ApplicationTestBuilder.() -> Unit)

fun TestApplicationRequest.setBody(value: ByteArray)

Sets an HTTP request body bytes.

fun TestApplicationRequest.setBody(value: String)

Sets an HTTP request body text content.

fun TestApplicationRequest.setBody(value: Source)

Set HTTP request body from ByteReadPacket

fun TestApplicationRequest.setBody(boundary: String, parts: List<PartData>)

Sets a multipart HTTP request body.

TestApplication

fun TestApplication(block: TestApplicationBuilder.() -> Unit): TestApplication

Creates an instance of TestApplication configured with the builder block. Make sure to call TestApplication.stop after your tests.

testApplication

fun testApplication(block: suspend ApplicationTestBuilder.() -> Unit): TestResult

fun testApplication(parentCoroutineContext: CoroutineContext = EmptyCoroutineContext, block: suspend ApplicationTestBuilder.() -> Unit): TestResult

Creates a test using TestApplication. To test a server Ktor application, do the following:

withApplication

fun <R> ~~withApplication~~(environment: ApplicationEnvironment = createTestEnvironment(), configure: TestApplicationEngine.Configuration.() -> Unit = {}, test: TestApplicationEngine.() -> R): R

Starts a test application engine, passes it to the test function, and stops it.

withTestApplication

fun <R> ~~withTestApplication~~(test: TestApplicationEngine.() -> R): R

fun <R> ~~withTestApplication~~(moduleFunction: Application.() -> Unit, test: TestApplicationEngine.() -> R): R

fun <R> ~~withTestApplication~~(moduleFunction: Application.() -> Unit, configure: TestApplicationEngine.Configuration.() -> Unit = {}, test: TestApplicationEngine.() -> R): R

Starts a test application engine, passes it to the test function, and stops it.