io.ktor.server.testing

Class TestApplicationEngine

io.ktor.server.testing.TestApplicationEngine

public class TestApplicationEngine

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestApplicationEngine.Configuration Test application engine configuration

Constructor Summary

Constructors

Constructor and Description
TestApplicationEngine(io.ktor.server.engine.ApplicationEngineEnvironment environment, kotlin.jvm.functions.Function1<? super io.ktor.server.testing.TestApplicationEngine.Configuration,kotlin.Unit> configure) ktor test engine that provides way to simulate application calls to existing application module(s) without actual HTTP connection
TestApplicationEngine() ktor test engine that provides way to simulate application calls to existing application module(s) without actual HTTP connection

Method Summary

Modifier and Type	Method and Description
TestApplicationCall	createCall(boolean readResponse, kotlin.jvm.functions.Function1<? super io.ktor.server.testing.TestApplicationRequest,kotlin.Unit> setup) Creates an instance of test call but doesn't start request processing
NonExistentClass	getCoroutineContext()
TestApplicationCall	handleRequest(kotlin.jvm.functions.Function1<? super io.ktor.server.testing.TestApplicationRequest,kotlin.Unit> setup) Make a test request
TestApplicationCall	handleWebSocket(java.lang.String uri, kotlin.jvm.functions.Function1<? super io.ktor.server.testing.TestApplicationRequest,kotlin.Unit> setup) Make a test request that setup a websocket session and wait for completion
TestApplicationCall	handleWebSocketConversation(java.lang.String uri, kotlin.jvm.functions.Function1<? super io.ktor.server.testing.TestApplicationRequest,kotlin.Unit> setup, kotlin.jvm.functions.Function4<? super io.ktor.server.testing.TestApplicationCall,? super kotlinx.coroutines.channels.ReceiveChannel<? extends io.ktor.http.cio.websocket.Frame>,? super kotlinx.coroutines.channels.SendChannel<? super io.ktor.http.cio.websocket.Frame>,? super kotlin.coroutines.experimental.Continuation<? super kotlin.Unit>,? extends java.lang.Object> callback) Make a test request that setup a websocket session and invoke callback function that does conversation with server
void	hookRequests(kotlin.jvm.functions.Function2<? super io.ktor.server.testing.TestApplicationRequest,? super kotlin.jvm.functions.Function1<? super io.ktor.server.testing.TestApplicationRequest,kotlin.Unit>,kotlin.Unit> processRequest, kotlin.jvm.functions.Function1<? super io.ktor.server.testing.TestApplicationCall,kotlin.Unit> processResponse, kotlin.jvm.functions.Function0<kotlin.Unit> block) Install a hook for test requests
io.ktor.server.engine.ApplicationEngine	start(boolean wait)
void	stop(long gracePeriod, long timeout, java.util.concurrent.TimeUnit timeUnit)

Constructor Detail

TestApplicationEngine

public TestApplicationEngine(io.ktor.server.engine.ApplicationEngineEnvironment environment,
                             kotlin.jvm.functions.Function1<? super io.ktor.server.testing.TestApplicationEngine.Configuration,kotlin.Unit> configure)

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

TestApplicationEngine

public TestApplicationEngine()

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

Method Detail

getCoroutineContext

public NonExistentClass getCoroutineContext()

start

public io.ktor.server.engine.ApplicationEngine start(boolean wait)

stop

public void stop(long gracePeriod,
                 long timeout,
                 java.util.concurrent.TimeUnit timeUnit)

hookRequests

public void hookRequests(kotlin.jvm.functions.Function2<? super io.ktor.server.testing.TestApplicationRequest,? super kotlin.jvm.functions.Function1<? super io.ktor.server.testing.TestApplicationRequest,kotlin.Unit>,kotlin.Unit> processRequest,
                         kotlin.jvm.functions.Function1<? super io.ktor.server.testing.TestApplicationCall,kotlin.Unit> processResponse,
                         kotlin.jvm.functions.Function0<kotlin.Unit> block)

Install a hook for test requests

handleRequest

public TestApplicationCall handleRequest(kotlin.jvm.functions.Function1<? super io.ktor.server.testing.TestApplicationRequest,kotlin.Unit> setup)

Make a test request

handleWebSocket

public TestApplicationCall handleWebSocket(java.lang.String uri,
                                           kotlin.jvm.functions.Function1<? super io.ktor.server.testing.TestApplicationRequest,kotlin.Unit> setup)

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

handleWebSocketConversation

public TestApplicationCall handleWebSocketConversation(java.lang.String uri,
                                                       kotlin.jvm.functions.Function1<? super io.ktor.server.testing.TestApplicationRequest,kotlin.Unit> setup,
                                                       kotlin.jvm.functions.Function4<? super io.ktor.server.testing.TestApplicationCall,? super kotlinx.coroutines.channels.ReceiveChannel<? extends io.ktor.http.cio.websocket.Frame>,? super kotlinx.coroutines.channels.SendChannel<? super io.ktor.http.cio.websocket.Frame>,? super kotlin.coroutines.experimental.Continuation<? super kotlin.Unit>,? extends java.lang.Object> callback)

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

createCall

public TestApplicationCall createCall(boolean readResponse,
                                      kotlin.jvm.functions.Function1<? super io.ktor.server.testing.TestApplicationRequest,kotlin.Unit> setup)

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