Mokksy/dev.mokksy.mokksy/MokksyServer

MokksyServer

open class MokksyServer @JvmOverloads constructor(host: String = DEFAULT_HOST, port: Int = 0, configuration: ServerConfiguration, configurer: ApplicationConfigurer = {})(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().apply { 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: ApplicationConfigurer = {})

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: ApplicationConfigurer = {})

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

Functions

awaitStarted

suspend fun awaitStarted()

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 stub for an HTTP DELETE request with a string request body.

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

Registers a stub for an HTTP DELETE request with the specified configuration and request type.

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

Defines a stub for an HTTP DELETE request with the specified request type and configuration block.

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 stub for an HTTP GET request with a string body using the provided configuration block.

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

Defines a stub for an HTTP GET request with the specified configuration and request specification builder.

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

Registers a stub for an HTTP GET request with the specified configuration and request type.

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

Defines a stub for an HTTP GET request with the specified request type and configuration block.

head

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

Defines a stub for an HTTP HEAD request with a string request body.

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

Defines a stub for a HEAD HTTP request with the specified configuration and request type.

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

Defines a stub for an HTTP HEAD request with the specified request type and configuration block.

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.

options

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

Defines an HTTP OPTIONS request stub with a string request body using the provided configuration block.

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

Defines a stub for an HTTP OPTIONS request with the specified configuration and request type.

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

Defines a stub for an HTTP OPTIONS request with the specified request type and configuration block.

patch

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

Defines a PATCH request stub with a string request body using the provided configuration block.

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

Registers a stub for an HTTP PATCH request with the specified configuration and request type.

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

Defines a stub for an HTTP PATCH request with the specified request type and configuration block.

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 stub for an HTTP POST request with a string request body.

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

Defines a POST request stub with the specified configuration and request type.

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

Defines a stub for an HTTP POST request with the specified request type and configuration block.

put

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

Defines a stub for an HTTP PUT request with a string request body.

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

Defines a stub for an HTTP PUT request with the specified configuration and request type.

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

Defines a stub for an HTTP PUT request with the specified request type and configuration block.

resetMatchCounts

fun resetMatchCounts()

Resets the match count of all registered stubs to zero and clears the request journal.

shutdown

@JvmOverloads

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

Stops the Mokksy server, blocking until shutdown is complete.

fun Mokksy.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 Mokksy.start()

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

fun Mokksy.start(dispatcher: CoroutineDispatcher)

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

startSuspend

suspend fun startSuspend(wait: Boolean = false)

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.