mokkery-runtime/dev.mokkery

Package-level declarations

Types

MockMany2

interface MockMany2<T1 : Any, T2 : Any>

Marker interface for mock of T1 and T2.

MockMany3

interface MockMany3<T1 : Any, T2 : Any, T3 : Any> : MockMany2<T1, T2>

Marker interface for mock of T1, T2 and T3.

MockMany4

interface MockMany4<T1 : Any, T2 : Any, T3 : Any, T4 : Any> : MockMany3<T1, T2, T3>

Marker interface for mock of T1, T2, T3 and T4.

MockMany5

interface MockMany5<T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any> : MockMany4<T1, T2, T3, T4>

Marker interface for mock of T1, T2, T3, T4 and T5.

MokkeryBlockingCallScope

interface MokkeryBlockingCallScope : MokkeryCallScope

Provides a set of operations available in non-suspendable mocked function context.

MokkeryCallScope

interface MokkeryCallScope : MokkeryScope

Provides a set of operations available in any mocked function context.

MokkeryScope

interface MokkeryScope

Base interface for all scopes that are based on MokkeryContext. Provides a set of operations that are available in all contexts.

MokkerySuiteScope

interface MokkerySuiteScope : MokkeryScope

A scope for a test suite that uses Mokkery mocks. It enables automation and strict exhaustiveness checks.

MokkerySuspendCallScope

interface MokkerySuspendCallScope : MokkeryCallScope

Provides a set of operations available in suspendable mocked function context.

Properties

call

val MokkeryCallScope.call: FunctionCall

Returns current call.

mocks

val MokkerySuiteScope.mocks: List<Any>

Returns all mocks from this MokkerySuiteScope.

self

val MokkeryCallScope.self: Any

Equivalent of this in the scope of currently called function.

supers

val MokkeryCallScope.supers: Map<KClass<*>, Function<Any?>>

Returns a map of available super calls for currently called function.

val <T1 : Any> MockMany2<T1, *>.t1: T1

Casts this as T1.

val <T2 : Any> MockMany2<*, T2>.t2: T2

Casts this as T2.

val <T3 : Any> MockMany3<*, *, T3>.t3: T3

Casts this as T3.

val <T4 : Any> MockMany4<*, *, *, T4>.t4: T4

Casts this as T4.

val <T5 : Any> MockMany5<*, *, *, *, T5>.t5: T5

Casts this as T5.

Functions

callOriginal

fun MokkeryBlockingCallScope.callOriginal(args: List<Any?>): Any?

suspend fun MokkerySuspendCallScope.callOriginal(args: List<Any?>): Any?

Calls original method implementation with given args.

callSuper

fun MokkeryBlockingCallScope.callSuper(superType: KClass<*>, args: List<Any?>): Any?

suspend fun MokkerySuspendCallScope.callSuper(superType: KClass<*>, args: List<Any?>): Any?

Calls super method of superType with given args

every

fun <T> every(block: ArgMatchersScope.() -> T): BlockingAnsweringScope<T>

Starts defining an answer for a single function call specified by block. Returned scope allows defining answer.

everySuspend

fun <T> everySuspend(block: suspend ArgMatchersScope.() -> T): SuspendAnsweringScope<T>

Just like every, but allows suspendable function call.

mock

inline fun <T : Any> mock(mode: MockMode = MokkeryCompilerDefaults.mockMode, block: T.() -> Unit = { }): T

Provides mock implementation of given type T.

mock

inline fun <T : Any> MokkerySuiteScope.mock(mode: MockMode = MokkeryCompilerDefaults.mockMode, block: T.() -> Unit = { }): T

Provides mock implementation of given type T. It is a child of given MokkerySuiteScope.

mockMany

inline fun <T1 : Any, T2 : Any> mockMany( mode: MockMode = MokkeryCompilerDefaults.mockMode, block: MockMany2<T1, T2>.() -> Unit = { }): MockMany2<T1, T2>

Provides mock implementation of T1 and T2.

inline fun <T1 : Any, T2 : Any, T3 : Any> mockMany( mode: MockMode = MokkeryCompilerDefaults.mockMode, block: MockMany3<T1, T2, T3>.() -> Unit = { }): MockMany3<T1, T2, T3>

Provides mock implementation of T1, T2 and T3.

inline fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any> mockMany( mode: MockMode = MokkeryCompilerDefaults.mockMode, block: MockMany4<T1, T2, T3, T4>.() -> Unit = { }): MockMany4<T1, T2, T3, T4>

Provides mock implementation of T1, T2, T3 and T4.

inline fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any> mockMany( mode: MockMode = MokkeryCompilerDefaults.mockMode, block: MockMany5<T1, T2, T3, T4, T5>.() -> Unit = { }): MockMany5<T1, T2, T3, T4, T5>

Provides mock implementation of T1, T2, T3, T4 and T5.

mockMany

inline fun <T1 : Any, T2 : Any> MokkerySuiteScope.mockMany( mode: MockMode = MokkeryCompilerDefaults.mockMode, block: MockMany2<T1, T2>.() -> Unit = { }): MockMany2<T1, T2>

Provides mock implementation of T1 and T2. It is a child of given MokkerySuiteScope.

inline fun <T1 : Any, T2 : Any, T3 : Any> MokkerySuiteScope.mockMany( mode: MockMode = MokkeryCompilerDefaults.mockMode, block: MockMany3<T1, T2, T3>.() -> Unit = { }): MockMany3<T1, T2, T3>

Provides mock implementation of T1, T2 and T3. It is a child of given MokkerySuiteScope.

inline fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any> MokkerySuiteScope.mockMany( mode: MockMode = MokkeryCompilerDefaults.mockMode, block: MockMany4<T1, T2, T3, T4>.() -> Unit = { }): MockMany4<T1, T2, T3, T4>

Provides mock implementation of T1, T2, T3 and T4. It is a child of given MokkerySuiteScope.

inline fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any> MokkerySuiteScope.mockMany( mode: MockMode = MokkeryCompilerDefaults.mockMode, block: MockMany5<T1, T2, T3, T4, T5>.() -> Unit = { }): MockMany5<T1, T2, T3, T4, T5>

Provides mock implementation of T1, T2, T3, T4 and T5. It is a child of given MokkerySuiteScope.

MokkerySuiteScope

fun MokkerySuiteScope(context: MokkeryContext = MokkeryContext.Empty): MokkerySuiteScope

Creates MokkerySuiteScope instance with given extra context.

resetAnswers

fun resetAnswers(vararg mocks: Any)

Removes all answers configured for given mocks.

resetCalls

fun resetCalls(vararg mocks: Any)

Clears call history for all given mocks.

self

inline fun <T> MokkeryCallScope.self(): T

Returns MokkeryCallScope.self as T.

spy

inline fun <T : Any> spy(obj: T, block: T.() -> Unit = { }): T

Returns given obj wrapped with a spying implementation of T.

spy

inline fun <T : Any> MokkerySuiteScope.spy(obj: T, block: T.() -> Unit = { }): T

Returns given obj wrapped with a spying implementation of T. It is a child of given MokkerySuiteScope.

toFunctionScope

fun MokkeryCallScope.~~toFunctionScope~~(): FunctionScope

Creates dev.mokkery.answering.FunctionScope from this MokkeryCallScope

verify

fun verify(mode: VerifyMode = MokkeryCompilerDefaults.verifyMode, block: ArgMatchersScope.() -> Unit)

Asserts that calls sequence defined in block satisfies given mode.

verify

fun MokkerySuiteScope.verify(mode: VerifyMode = MokkeryCompilerDefaults.verifyMode, block: ArgMatchersScope.() -> Unit)

Asserts that calls sequence defined in block satisfies given mode.

verifyNoMoreCalls

fun verifyNoMoreCalls(vararg mocks: Any)

Asserts that all given mocks have all their registered calls verified with verify or verifySuspend.

verifyNoMoreCalls

fun MokkerySuiteScope.verifyNoMoreCalls()

Asserts that all mocks from given MokkerySuiteScope have no unverified calls.

verifySuspend

fun verifySuspend(mode: VerifyMode = MokkeryCompilerDefaults.verifyMode, block: suspend ArgMatchersScope.() -> Unit)

Just like verify, but allows suspendable function calls.

verifySuspend

fun MokkerySuiteScope.verifySuspend(mode: VerifyMode = MokkeryCompilerDefaults.verifyMode, block: suspend ArgMatchersScope.() -> Unit)

Just like verify, but allows suspendable function calls.