EngineTestSuite

abstract class EngineTestSuite<TEngine : ApplicationEngine, TConfiguration : Configuration> : 
    EngineTestBase<TEngine, TConfiguration>

Constructors

<init>

EngineTestSuite(
    hostFactory: ApplicationEngineFactory<TEngine, TConfiguration>)

Inherited Properties

applicationEngineFactory

val applicationEngineFactory: ApplicationEngineFactory<TEngine, TConfiguration>

callGroupSize

var callGroupSize: Int

coroutineContext

open val coroutineContext: <ERROR CLASS>

enableHttp2

var enableHttp2: Boolean

enableSsl

var enableSsl: Boolean

exceptions

val exceptions: ArrayList<Throwable>

isUnderDebugger

val isUnderDebugger: Boolean

port

var port: Int

server

var server: TEngine?

socketReadTimeout

val socketReadTimeout: Int

sslPort

var sslPort: Int

test

val test: TestName

testDispatcher

val testDispatcher: ExecutorCoroutineDispatcher

testLog

val testLog: Logger

timeout

open val timeout: Long

timeoutRule

val timeoutRule: CoroutinesTimeout

Functions

test404

fun test404(): Unit

testApplicationScopeCancellation

fun testApplicationScopeCancellation(): Unit

testBigFile

fun testBigFile(): Unit

testBigFileHttpUrlConnection

fun testBigFileHttpUrlConnection(): Unit

testBinary

fun testBinary(): Unit

testBlockingConcurrency

fun testBlockingConcurrency(): Unit

testBlockingDeadlock

open fun testBlockingDeadlock(): Unit

testChunked

open fun testChunked(): Unit

testChunkedWrongLength

open fun testChunkedWrongLength(): Unit

testClosedConnection

fun testClosedConnection(): Unit

testCompressionWriteToLarge

fun testCompressionWriteToLarge(): Unit

testConnectionReset

fun testConnectionReset(): Unit

testCookie

fun testCookie(): Unit

testEchoBlocking

fun testEchoBlocking(): Unit

testEmbeddedServerCancellation

fun testEmbeddedServerCancellation(): Unit

testFormUrlEncoded

fun testFormUrlEncoded(): Unit

testHeadRequest

fun testHeadRequest(): Unit

testHeader

fun testHeader(): Unit

testIgnorePostContent

fun testIgnorePostContent(): Unit

testJarFileContent

fun testJarFileContent(): Unit

testLocalFileContent

fun testLocalFileContent(): Unit

testLocalFileContentRange

fun testLocalFileContentRange(): Unit

testLocalFileContentRangeWithCompression

fun testLocalFileContentRangeWithCompression(): Unit

testLocalFileContentWithCompression

fun testLocalFileContentWithCompression(): Unit

testLoggerOnError

fun testLoggerOnError(): Unit

testMultipartFileUpload

fun testMultipartFileUpload(): Unit

testMultipartFileUploadLarge

fun testMultipartFileUploadLarge(): Unit

testPathComponentsDecoding

fun testPathComponentsDecoding(): Unit

testProxyHeaders

fun testProxyHeaders(): Unit

testReceiveInputStream

fun testReceiveInputStream(): Unit

testRedirect

fun testRedirect(): Unit

testRedirectFromInterceptor

fun testRedirectFromInterceptor(): Unit

testRepeatRequest

fun testRepeatRequest(): Unit

testRequestBodyAsyncEcho

fun testRequestBodyAsyncEcho(): Unit

testRequestContentFormData

fun testRequestContentFormData(): Unit

testRequestContentInputStream

fun testRequestContentInputStream(): Unit

testRequestContentString

fun testRequestContentString(): Unit

testRequestParameters

fun testRequestParameters(): Unit

testRequestParts

fun testRequestParts(): Unit

testRequestTwiceInOneBufferWithKeepAlive

fun testRequestTwiceInOneBufferWithKeepAlive(): Unit

testRequestTwiceNoKeepAlive

fun testRequestTwiceNoKeepAlive(): Unit

testRequestTwiceWithKeepAlive

fun testRequestTwiceWithKeepAlive(): Unit

testSendTextWithContentType

fun testSendTextWithContentType(): Unit

testServerPush

fun testServerPush(): Unit

testStaticServe

fun testStaticServe(): Unit

testStaticServeFromDir

fun testStaticServeFromDir(): Unit

testStatusCodeDirect

fun testStatusCodeDirect(): Unit

testStatusCodeViaResponseObject

fun testStatusCodeViaResponseObject(): Unit

testStatusPages404

fun testStatusPages404(): Unit

testStream

fun testStream(): Unit

testStreamNoFlush

fun testStreamNoFlush(): Unit

testStreamingContentWithCompression

fun testStreamingContentWithCompression(): Unit

testTextContent

fun testTextContent(): Unit

testURIContent

fun testURIContent(): Unit

testURIContentLocalFile

fun testURIContentLocalFile(): Unit

testUpgrade

open fun testUpgrade(): Unit

Inherited Functions

configure

open fun configure(configuration: TConfiguration): Unit

createAndStartServer

fun createAndStartServer(
    log: Logger? = null,
    parent: <ERROR CLASS> = EmptyCoroutineContext,
    routingConfigurer: Routing.() -> Unit
): TEngine

createServer

open fun createServer(
    log: Logger?,
    parent: <ERROR CLASS> = EmptyCoroutineContext,
    module: Application.() -> Unit
): TEngine

features

open fun features(
    application: Application,
    routingConfigurer: Routing.() -> Unit
): Unit

findFreePort

fun findFreePort(): Int

setUpBase

fun setUpBase(): Unit

socket

fun socket(block: Socket.() -> Unit): Unit

tearDownBase

fun tearDownBase(): Unit

withUrl

fun withUrl(
    path: String,
    builder: suspend HttpRequestBuilder.() -> Unit = {},
    block: suspend HttpResponse.(Int) -> Unit
): Unit

Companion Object Properties

classesDir

const val classesDir: String

coreClassesDir

const val coreClassesDir: String

Extension Functions

decodeChunked

fun CoroutineScope.decodeChunked(
    input: ByteReadChannel
): DecoderJob

Start a chunked stream decoder coroutine

embeddedServer

fun <TEngine : ApplicationEngine, TConfiguration : Configuration> CoroutineScope.embeddedServer(
    factory: ApplicationEngineFactory<TEngine, TConfiguration>,
    port: Int = 80,
    host: String = "0.0.0.0",
    watchPaths: List<String> = emptyList(),
    parentCoroutineContext: <ERROR CLASS> = EmptyCoroutineContext,
    configure: TConfiguration.() -> Unit = {},
    module: Application.() -> Unit
): TEngine

Creates an embedded server with the given factory, listening on host:port

httpServer

fun CoroutineScope.httpServer(
    settings: HttpServerSettings,
    handler: HttpRequestHandler
): HttpServer

Start an http server with settings invoking handler for every request

parseMultipart

fun CoroutineScope.parseMultipart(
    input: ByteReadChannel,
    headers: HttpHeadersMap
): ReceiveChannel<MultipartEvent>
fun CoroutineScope.parseMultipart(
    input: ByteReadChannel,
    contentType: CharSequence,
    contentLength: Long?
): ReceiveChannel<MultipartEvent>
fun CoroutineScope.parseMultipart(
    boundaryPrefixed: ByteBuffer,
    input: ByteReadChannel,
    totalLength: Long?
): ReceiveChannel<MultipartEvent>

Starts a multipart parser coroutine producing multipart events

pinger

fun CoroutineScope.pinger(
    outgoing: SendChannel<Frame>,
    period: Duration,
    timeout: Duration,
    pool: ObjectPool<ByteBuffer> = KtorDefaultPool
): SendChannel<Pong>

Launch pinger coroutine on CoroutineScope that is sending ping every specified period to outgoing channel, waiting for and verifying client’s pong frames. It is also handling timeout and sending timeout close frame

fun CoroutineScope.pinger(
    outgoing: SendChannel<Frame>,
    periodMillis: Long,
    timeoutMillis: Long,
    pool: ObjectPool<ByteBuffer> = KtorDefaultPool
): SendChannel<Pong>

Launch pinger coroutine on CoroutineScope that is sending ping every specified periodMillis to outgoing channel, waiting for and verifying client’s pong frames. It is also handling timeoutMillis and sending timeout close frame

ponger

fun CoroutineScope.ponger(
    outgoing: SendChannel<Pong>,
    pool: ObjectPool<ByteBuffer> = KtorDefaultPool
): SendChannel<Ping>

Launch a ponger actor job on the CoroutineScope sending pongs to outgoing channel. It is acting for every client’s ping frame and replying with corresponding pong

startConnectionPipeline

fun CoroutineScope.startConnectionPipeline(
    input: ByteReadChannel,
    output: ByteWriteChannel,
    timeout: WeakTimeoutQueue,
    handler: HttpRequestHandler
): Job

Start connection HTTP pipeline invoking handler for every request. Note that handler could be invoked multiple times concurrently due to HTTP pipeline nature

writeMultipleRanges

fun CoroutineScope.writeMultipleRanges(
    channelProducer: (LongRange) -> ByteReadChannel,
    ranges: List<LongRange>,
    fullLength: Long?,
    boundary: String,
    contentType: String
): ByteReadChannel

Start multirange response writer coroutine