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

ApplicationTestBuilder

class ApplicationTestBuilder : TestApplicationBuilder, ClientProvider

A builder for a test that uses TestApplication.

Constructors

constructor()

Properties

client

open override val client: HttpClient

Returns a client with the default configuration.

Functions

application

fun application(block: Application.() -> Unit)

Adds a module to TestApplication.

createClient

open override fun createClient(block: HttpClientConfig<out HttpClientEngineConfig>.() -> Unit): HttpClient

Creates a client with a custom configuration. For example, to send JSON data in a test POST/PUT request, you can install the ContentNegotiation plugin:

engine

fun engine(block: TestApplicationEngine.Configuration.() -> Unit)

Adds a configuration block for the TestApplicationEngine.

environment

fun environment(block: ApplicationEnvironmentBuilder.() -> Unit)

Builds an environment using block.

externalServices

fun externalServices(block: ExternalServicesBuilder.() -> Unit)

Builds mocks for external services using ExternalServicesBuilder.

install

fun <P : Pipeline<*, PipelineCall>, B : Any, F : Any> install(plugin: Plugin<P, B, F>, configure: B.() -> Unit = {})

Installs a plugin into TestApplication

routing

fun routing(configuration: Route.() -> Unit)

Installs routing into TestApplication

serverConfig

fun serverConfig(block: ServerConfigBuilder.() -> Unit)

Adds a configuration block for the ServerConfig.

startApplication

suspend fun startApplication()

Starts instance of TestApplication. Usually, users do not need to call this method because application will start on the first client call. But it's still useful when you need to test your application lifecycle events.