mokksy/me.kpavlov.mokksy/MokksyServer

MokksyServer

open class MokksyServer(port: Int = 0, host: String = DEFAULT_HOST, configuration: ServerConfiguration, wait: Boolean = false, configurer: (<Error class: unknown class>) -> Unit = {})

Represents an embedded mock server capable of handling various HTTP requests and responses for testing purposes. Provides functionality to configure request specifications for different HTTP methods and manage request matching.

Parameters

port

The port number on which the server will run. Defaults to 0 (randomly assigned port).

configuration

Server configuration options

wait

Determines whether the server startup process should block the current thread. Defaults to false.

configurer

A lambda function for setting custom configurations for the server's application module.

Constructors

MokksyServer

constructor(port: Int = 0, host: String = DEFAULT_HOST, verbose: Boolean = false, configurer: (<Error class: unknown class>) -> Unit = {})

constructor(port: Int = 0, host: String = DEFAULT_HOST, configuration: ServerConfiguration, wait: Boolean = false, configurer: (<Error class: unknown class>) -> Unit = {})

Initializes the server with the specified parameters and starts it.

Functions

checkForUnmatchedRequests

fun checkForUnmatchedRequests()

Checks for any unmatched requests by retrieving all request specifications that have not been matched to incoming requests and verifies that the list of unmatched requests is empty.

delete

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

Configures an HTTP DELETE request specification using the provided block and returns a BuildingStep for further customization. This method serves as a convenience shortcut.

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

Configures an HTTP DELETE request specification using the provided block and returns a BuildingStep instance for further customization. This method uses the HTTP DELETE method to define the request specification within the provided lambda.

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

Executes an HTTP DELETE request with the specified configuration and request type.

findAllUnmatchedRequests

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

Retrieves a list of all request specifications that have not been matched to any incoming requests. A request is considered unmatched if its match count is zero.

get

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

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

Configures HTTP GET request specification using the provided block and returns a BuildingStep for further customization. This method serves as a convenience shortcut.

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

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

Configures an HTTP GET request specification using the provided block and returns a BuildingStep instance for further customization.

head

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

Configures an HTTP HEAD request specification using the provided block and returns a BuildingStep for further customization. This method serves as a convenience shortcut.

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

Configures an HTTP HEAD request specification using the provided block and returns a BuildingStep instance for further customization. This method uses the HTTP HEAD method to define the request specification within the provided lambda.

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

Constructs a HEAD HTTP request with the provided configuration, request type, and specification block.

method

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

Creates a building step for a stub configuration with the specified parameters.

fun method(configuration: StubConfiguration, httpMethod: <Error class: unknown class>, requestType: KClass, block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Creates a RequestSpecification with the specified HTTP method and additional configuration defined by the given block, and returns a new BuildingStep instance for further customization.

options

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

Configures an HTTP HEAD request specification using the provided block and returns a BuildingStep for further customization. This method serves as a convenience shortcut.

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

Configures an HTTP OPTIONS request specification using the provided block and returns a BuildingStep instance for further customization. This method uses the HTTP OPTIONS method to define the request specification within the provided lambda.

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

Configures and executes an HTTP OPTIONS request based on the given parameters.

patch

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

Configures an HTTP PATCH request specification using the provided block and returns a BuildingStep for further customization. This method serves as a convenience shortcut.

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

Configures an HTTP PATCH request specification using the provided block and returns a BuildingStep instance for further customization. This method uses the HTTP PATCH method to define the request specification within the provided lambda.

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

Builds and returns a BuildingStep for a PATCH HTTP request with the provided configuration, request type, and custom request specification block.

port

fun port(): Int

Retrieves the resolved port on which the server is running.

post

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

Configures an HTTP POST request specification using the provided block and returns a BuildingStep for further customization. This method serves as a convenience shortcut.

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

Configures an HTTP POST request specification using the provided block and returns a BuildingStep instance for further customization. This method uses the HTTP POST method to define the request specification within the provided lambda.

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

Sends a POST request using the provided configuration, request type, and block to define the request specification.

put

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

Configures an HTTP PUT request specification using the provided block and returns a BuildingStep for further customization. This method serves as a convenience shortcut.

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

Configures an HTTP PUT request specification using the provided block and returns a BuildingStep instance for further customization. This method uses the HTTP PUT method to define the request specification within the provided lambda.

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

Executes an HTTP PUT request with the provided configuration and request specifications.

resetMatchCounts

fun resetMatchCounts()

Resets the match counts for all mappings in the server. Each mapping's match count is set to zero, effectively clearing any record of previous matches.

shutdown

fun shutdown()

Shuts down the server by stopping its execution.