Mokksy/dev.mokksy.mokksy/MokksyServer

MokksyServer

class MokksyServer @JvmOverloads constructor(host: String = DEFAULT_HOST, port: Int = 0, val configuration: ServerConfiguration, configurer: Application.() -> Unit = {}) : MokksyHandler(source)

An embedded mock HTTP server for testing. Registers stubs for any HTTP method and verifies request expectations after the test.

Call start() (on JVM) or startSuspend to begin processing requests after construction.

Example:

val mokksy = Mokksy().start()

mokksy.get {
    path("/ping")
} respondsWith {
    body = """{"response":"Pong"}"""
}

Author

Konstantin Pavlov

Parameters

host

The host to bind to. Defaults to 127.0.0.1.

port

The port to bind to. Defaults to 0 (randomly assigned).

configuration

ServerConfiguration options.

configurer

Additional Ktor Application configuration applied after the default routing setup.

Constructors

MokksyServer

@JvmOverloads

constructor(host: String = DEFAULT_HOST, port: Int = 0, configuration: ServerConfiguration, configurer: Application.() -> Unit = {})

Creates a MokksyServer instance. Call start() (on JVM) or startSuspend to begin processing requests.

@JvmOverloads

constructor(host: String = DEFAULT_HOST, port: Int = 0, verbose: Boolean = false, configurer: Application.() -> Unit = {})

Creates a MokksyServer instance using a verbose flag instead of a full ServerConfiguration. Call start() (on JVM) or startSuspend to begin processing requests.

Properties

configuration

open override val configuration: ServerConfiguration

Functions

awaitStarted

suspend fun awaitStarted(): MokksyServer

Suspends until the server has fully started and the port is bound.

baseUrl

fun baseUrl(): String

Constructs and returns the base URL for the server.

delete

fun delete(block: RequestSpecificationBuilder<String>.() -> Unit): BuildingStep<String>

Defines a DELETE stub with a String request body.

fun delete(configuration: StubConfiguration, block: RequestSpecificationBuilder<String>.() -> Unit): BuildingStep<String>

Defines a DELETE stub with a String request body and a full StubConfiguration.

fun delete(configuration: StubConfiguration, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Defines a DELETE stub that matches a typed request body of type P using a full StubConfiguration.

fun delete(name: String? = null, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Defines a DELETE stub that matches a typed request body of type P.

delete

inline fun MokksyServer.delete(configuration: StubConfiguration, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.delete with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.delete(name: String? = null, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.delete with an optional stub name. Infers P from the call site.

findAllMatchedRequests

fun findAllMatchedRequests(): List<RecordedRequest>

Returns all HTTP requests that were successfully matched by a stub. Only populated when ServerConfiguration.journalMode is JournalMode.FULL.

findAllUnexpectedRequests

fun findAllUnexpectedRequests(): List<RecordedRequest>

Returns all HTTP requests that arrived at the server but were not matched by any stub.

findAllUnmatchedRequests

fun ~~findAllUnmatchedRequests~~(): List<RecordedRequest>

Returns all HTTP requests that arrived at the server but were not matched by any stub.

findAllUnmatchedStubs

fun findAllUnmatchedStubs(): List<RequestSpecification<*>>

Returns all stub specifications that have not been matched by any incoming request.

get

fun get(block: RequestSpecificationBuilder<String>.() -> Unit): BuildingStep<String>

Defines a GET stub with a String request body.

fun get(configuration: StubConfiguration, block: RequestSpecificationBuilder<String>.() -> Unit): BuildingStep<String>

Defines a GET stub with a String request body and a full StubConfiguration.

fun get(configuration: StubConfiguration, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Defines a GET stub that matches a typed request body of type P using a full StubConfiguration.

fun get(name: String? = null, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Defines a GET stub that matches a typed request body of type P.

get

inline fun MokksyServer.get(configuration: StubConfiguration, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.get with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.get(name: String? = null, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.get with an optional stub name. Infers P from the call site.

handle

open suspend override fun handle(context: RoutingContext)

Dispatches an incoming request to the appropriate stub and writes the response.

head

fun head(block: RequestSpecificationBuilder<String>.() -> Unit): BuildingStep<String>

Defines a HEAD stub with a String request body.

fun head(configuration: StubConfiguration, block: RequestSpecificationBuilder<String>.() -> Unit): BuildingStep<String>

Defines a HEAD stub with a String request body and a full StubConfiguration.

fun head(configuration: StubConfiguration, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Defines a HEAD stub that matches a typed request body of type P using a full StubConfiguration.

fun head(name: String? = null, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Defines a HEAD stub that matches a typed request body of type P.

head

inline fun MokksyServer.head(configuration: StubConfiguration, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.head with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.head(name: String? = null, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.head with an optional stub name. Infers P from the call site.

method

fun method(configuration: StubConfiguration, httpMethod: HttpMethod, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Creates a RequestSpecification for the given HTTP method and request type, and returns a BuildingStep for further stub configuration.

fun method(name: String? = null, httpMethod: HttpMethod, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Defines a stubbed HTTP RequestSpecification for the given method and request type, optionally naming the stub.

method

inline fun MokksyServer.method(configuration: StubConfiguration, httpMethod: HttpMethod, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.method with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.method(name: String? = null, httpMethod: HttpMethod, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.method with an optional stub name. Infers P from the call site.

options

fun options(block: RequestSpecificationBuilder<String>.() -> Unit): BuildingStep<String>

Defines an OPTIONS stub with a String request body.

fun options(configuration: StubConfiguration, block: RequestSpecificationBuilder<String>.() -> Unit): BuildingStep<String>

Defines an OPTIONS stub with a String request body and a full StubConfiguration.

fun options(configuration: StubConfiguration, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Defines an OPTIONS stub that matches a typed request body of type P using a full StubConfiguration.

fun options(name: String? = null, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Defines an OPTIONS stub that matches a typed request body of type P.

options

inline fun MokksyServer.options(configuration: StubConfiguration, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.options with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.options(name: String? = null, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.options with an optional stub name. Infers P from the call site.

patch

fun patch(block: RequestSpecificationBuilder<String>.() -> Unit): BuildingStep<String>

Defines a PATCH stub with a String request body.

fun patch(configuration: StubConfiguration, block: RequestSpecificationBuilder<String>.() -> Unit): BuildingStep<String>

Defines a PATCH stub with a String request body and a full StubConfiguration.

fun patch(configuration: StubConfiguration, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Defines a PATCH stub that matches a typed request body of type P using a full StubConfiguration.

fun patch(name: String? = null, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Defines a PATCH stub that matches a typed request body of type P.

patch

inline fun MokksyServer.patch(configuration: StubConfiguration, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.patch with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.patch(name: String? = null, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.patch with an optional stub name. Infers P from the call site.

port

fun port(): Int

Returns the actual port number the server is bound to after startup.

post

fun post(block: RequestSpecificationBuilder<String>.() -> Unit): BuildingStep<String>

Defines a POST stub with a String request body.

fun post(configuration: StubConfiguration, block: RequestSpecificationBuilder<String>.() -> Unit): BuildingStep<String>

Defines a POST stub with a String request body and a full StubConfiguration.

fun post(configuration: StubConfiguration, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Defines a POST stub that matches a typed request body of type P using a full StubConfiguration.

fun post(name: String? = null, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Defines a POST stub that matches a typed request body of type P.

post

inline fun MokksyServer.post(configuration: StubConfiguration, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.post with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.post(name: String? = null, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.post with an optional stub name. Infers P from the call site.

put

fun put(block: RequestSpecificationBuilder<String>.() -> Unit): BuildingStep<String>

Defines a PUT stub with a String request body.

fun put(configuration: StubConfiguration, block: RequestSpecificationBuilder<String>.() -> Unit): BuildingStep<String>

Defines a PUT stub with a String request body and a full StubConfiguration.

fun put(configuration: StubConfiguration, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Defines a PUT stub that matches a typed request body of type P using a full StubConfiguration.

fun put(name: String? = null, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Defines a PUT stub that matches a typed request body of type P.

put

inline fun MokksyServer.put(configuration: StubConfiguration, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.put with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.put(name: String? = null, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.put with an optional stub name. Infers P from the call site.

resetMatchCounts

fun ~~resetMatchCounts~~()

Resets the match state of all currently registered stubs to unmatched, and clears the request journal.

resetMatchState

fun resetMatchState()

Resets the match state of all currently registered stubs to unmatched, and clears the request journal.

shutdown

@JvmOverloads

fun MokksyServer.shutdown(gracePeriodMillis: Long = 500, timeoutMillis: Long = 1000)

Stops the Mokksy server, blocking until shutdown is complete.

fun MokksyServer.shutdown(gracePeriodMillis: Long = 500, timeoutMillis: Long = 1000, dispatcher: CoroutineDispatcher)

Stops the Mokksy server on the given dispatcher, blocking until shutdown is complete.

shutdownSuspend

suspend fun shutdownSuspend(gracePeriodMillis: Long = 500, timeoutMillis: Long = 1000)

Stops the embedded server and releases its resources with the specified grace period and timeout.

start

fun MokksyServer.start(): MokksyServer

Starts the Mokksy server and blocks until the port is bound and ready to accept requests.

fun MokksyServer.start(dispatcher: CoroutineDispatcher): MokksyServer

Starts the Mokksy server on the given dispatcher, blocking until the port is bound.

startSuspend

suspend fun startSuspend(wait: Boolean = false): MokksyServer

Initiates the server to begin processing requests asynchronously.

verifyNoUnexpectedRequests

fun verifyNoUnexpectedRequests()

Verifies that every request received by the server was matched by a stub.

verifyNoUnmatchedStubs

fun verifyNoUnmatchedStubs()

Verifies that all registered stubs have been matched at least once.