apollo-mockserver/com.apollographql.apollo3.mockserver/MockServer

MockServer

interface MockServer : Closeable

A server for testing Kotlin Multiplatform applications using HTTP and WebSockets.

A MockServer binds to localhost and allows to enqueue predefined responses using enqueue, enqueueString, enqueueMultipart and enqueueWebSocket

MockServer is very simple and should not be used for production applications. HTTPS is a non-goal as well as performance. Also, MockServer makes no attempt at flow control:

data is read as fast as possible from the network and buffered until takeRequest or awaitAnyRequest is called.
queued responses from enqueue are buffered until they can be transmitted to the network. If you're using MockServer to handle large payloads, it will use a lot of memory.

Types

interface Listener

Functions

assertNoRequest

fun MockServer.assertNoRequest()

awaitAnyRequest

abstract suspend fun awaitAnyRequest(timeout: Duration = 1.seconds): MockRequestBase

Wait for a request and return it.

suspend fun MockServer.awaitRequest(timeout: Duration = 30.seconds): MockRequest

awaitWebSocketRequest

@ApolloExperimental

suspend fun MockServer.awaitWebSocketRequest(timeout: Duration = 30.seconds): WebsocketMockRequest

abstract override fun close()

Closes the server.

abstract fun enqueue(mockResponse: MockResponse)

Enqueue a response.

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

fun MockServer.~~enqueue~~(string: String = "", delayMs: Long = 0, statusCode: Int = 200)

fun MockServer.enqueueError(statusCode: Int)

enqueueGraphQLString

fun MockServer.enqueueGraphQLString(string: String, delayMs: Long = 0)

enqueueMultipart

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

fun MockServer.~~enqueueMultipart~~(parts: List<String>): Nothing

@ApolloExperimental

fun MockServer.enqueueMultipart(partsContentType: String, headers: Map<String, String> = emptyMap(), boundary: String = "-"): MultipartBody

fun MockServer.enqueueString(string: String = "", delayMs: Long = 0, statusCode: Int = 200, contentType: String = "text/plain")

enqueueWebSocket

@ApolloExperimental

fun MockServer.enqueueWebSocket(statusCode: Int = 101, headers: Map<String, String> = emptyMap(), keepAlive: Boolean = true): WebSocketBody

abstract suspend fun port(): Int

Returns the port used by this server.

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

open suspend fun ~~stop~~()

abstract fun takeRequest(): MockRequest

Return a request from the recorded requests or throw if no request has been received.

abstract suspend fun url(): String

Returns the url for this server in the form "http://ip:port/".