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.

BaseTest

expect abstract class BaseTest

actual abstract class BaseTest

ClientProvider

interface ClientProvider

A client attached to TestApplication.

EngineTestBase

expect abstract class EngineTestBase<TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration>(applicationEngineFactory: ApplicationEngineFactory<TEngine, TConfiguration>) : BaseTest, CoroutineScope

actual abstract class EngineTestBase<TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration>(val applicationEngineFactory: ApplicationEngineFactory<TEngine, TConfiguration>) : BaseTest, CoroutineScope

ExternalServicesBuilder

class ExternalServicesBuilder

Registers mocks for external services.

HighLoadHttpGenerator

class HighLoadHttpGenerator(val host: String, port: Int, val numberOfConnections: Int, val queueSize: Int, val highPressure: Boolean, builder: RequestResponseBuilder.() -> Unit)

This HTTP generator produces huge amount of requests however it doesn't validate responses and doesn't measure any time characteristics.

object It

it function receiver object

object On

on function receiver object

StressSuiteRunner

class StressSuiteRunner(klass: Class<*>) : Runner, Filterable, Sortable

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: ApplicationEngineEnvironment = createTestEnvironment(), configure: TestApplicationEngine.Configuration.() -> Unit = {}) : 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, method: HttpMethod = HttpMethod.Get, uri: String = "/", port: Int? = null, 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.

TestEngine

object TestEngine : ApplicationEngineFactory<TestApplicationEngine, TestApplicationEngine.Configuration>

An ApplicationEngineFactory providing a CIO-based ApplicationEngine.

Functions

awaitWebSocket

fun TestApplicationResponse.awaitWebSocket(duration: Duration)

Wait for websocket session completion

contentType

fun TestApplicationResponse.contentType(): ContentType

Returns a parsed content type from a test response.

cookiesSession

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

Keeps cookies between requests inside the callback.

createTestEnvironment

fun createTestEnvironment(configure: ApplicationEngineEnvironmentBuilder.() -> Unit = {}): ApplicationEngineEnvironment

Creates an engine environment for a test application.

handleRequest

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

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

DSL for creating a test case

setBody

fun TestApplicationRequest.setBody(value: ByteReadPacket)

Set HTTP request body from ByteReadPacket

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(boundary: String, parts: List<PartData>)

Sets a multipart HTTP request body.

TestApplication

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

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

withApplication

fun <R> ~~withApplication~~(environment: ApplicationEngineEnvironment = 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.