apollo-testing-support/com.apollographql.apollo3.testing

Package-level declarations

Types

abstract class FooOperation(operationType: String) : Operation<FooOperation.Data>

Base class for test queries. Note we can't make FooOperation extend both Query and Subscription because that confuses ApolloClient when deciding whant NetworkTransport to use.

FooQuery

@ApolloExperimental

class FooQuery : FooOperation, Query<FooOperation.Data>

FooQuery is a query for tests that doesn't require codegen.

FooSubscription

@ApolloExperimental

class FooSubscription : FooOperation, Subscription<FooOperation.Data>

FooSubscription is a query for tests that doesn't require codegen.

MapTestNetworkTransport

@ApolloExperimental

class MapTestNetworkTransport : NetworkTransport

MockServerTest

@ApolloExperimental

class MockServerTest(val mockServer: MockServer, val apolloClient: ApolloClient, val scope: CoroutineScope)

MockServerWebSocketTest

@ApolloExperimental

class MockServerWebSocketTest(val apolloClient: ApolloClient, mockServer: MockServer, val coroutineScope: CoroutineScope)

QueueTestNetworkTransport

@ApolloExperimental

class QueueTestNetworkTransport : NetworkTransport

Properties

HostFileSystem

@ApolloExperimental

expect val HostFileSystem: FileSystem

The host filesystem

@ApolloExperimental

actual val HostFileSystem: FileSystem

The host filesystem

actual val HostFileSystem: FileSystem

@ApolloExperimental

actual val HostFileSystem: FileSystem

The host filesystem

testsPath

actual val testsPath: String

@ApolloExperimental

expect val testsPath: String

The path to the "tests" directory. This assumes all tests are run from a predictable place relative to "tests" We need this for JS tests where the CWD is not properly set at the beginning of tests

actual val testsPath: String

@ApolloExperimental

actual val testsPath: String

The path to the "tests" directory. This assumes all tests are run from a predictable place relative to "tests" We need this for JS tests where the CWD is not properly set at the beginning of tests

Functions

assertNoElement

@ApolloExperimental

suspend fun <T> Channel<T>.assertNoElement(timeoutMillis: Long = 300)

awaitComplete

@ApolloExperimental

suspend fun WebsocketMockRequest.awaitComplete(timeout: Duration = 1.seconds)

Extracts the operationId from a graphql-ws message, ignores "complete messages"

awaitElement

@ApolloExperimental

suspend fun <T> Channel<T>.awaitElement(timeoutMillis: Long = 30000): T

awaitSubscribe

@ApolloExperimental

suspend fun WebsocketMockRequest.awaitSubscribe(timeout: Duration = 1.seconds, messagesToIgnore: Set<String> = emptySet()): String

Extracts the operationId from a graphql-ws message

checkFile

fun checkFile(actualText: String, path: String)

Checks that actualText matches the contents of the file at path

connectionAckMessage

@ApolloExperimental

fun connectionAckMessage(): WebSocketMessage

cwd

fun cwd(): String

enqueue

fun <D : Operation.Data> MockServer.enqueue(operation: Operation<D>, data: D, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty, delayMs: Long = 0)

enqueueData

fun MockServer.enqueueData(data: Operation.Data, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty, delayMillis: Long = 0, statusCode: Int = 200)

fun MockServer.enqueueData(data: Map<String, Any?>, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty, delayMillis: Long = 0, statusCode: Int = 200)

enqueueTestNetworkError

@ApolloExperimental

fun ApolloClient.enqueueTestNetworkError()

enqueueTestResponse

@ApolloExperimental