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.

MokkeryInstanceScope

interface MokkeryInstanceScope : MokkeryScope

Provides a set of operations available in a Mokkery mock/spy context.

MokkeryMockScope

interface MokkeryMockScope : MokkeryInstanceScope

Provides a set of operations available in a Mokkery mock 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.

MokkerySpyScope

interface MokkerySpyScope : MokkeryInstanceScope

Provides a set of operations available in a Mokkery spy context.

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.

mockMode

val MokkeryMockScope.mockMode: MockMode

Returns MockMode of the mock associated with this scope.

context(aware: MokkeryMockConfigurer.Aware<T>)
var <T : Any> T.mockMode: MockMode

Controls MockMode for this mock.

var MokkeryMockConfigurer.mockMode: MockMode

Controls MockMode for mock currently configured by this configurer.

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.

spiedObject

val MokkerySpyScope.spiedObject: Any

Returns reference spied by the spy associated with this scope.

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.

callSpied

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

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

Calls spied method 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: MokkeryTemplatingScope.() -> T): BlockingAnsweringScope<T>

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

fun <T> every(function: KFunction<T>): BlockingAnsweringScope<T>

Starts defining an answer for a regular function call with any arguments. Returned scope allows defining answer.

everySuspend

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

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

fun <T> everySuspend(function: KFunction<T>): SuspendAnsweringScope<T>

Starts defining an answer for a suspend function call with any arguments. Returned scope allows defining answer.

mock

fun <T : Any> mock(mode: MockMode? = null, block: MokkeryMockConfigurer.Block<T> = { }): T

Provides mock implementation of given type T.

mock

fun <T : Any> MokkerySuiteScope.mock(mode: MockMode? = null, block: MokkeryMockConfigurer.Block<T> = { }): T

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

mockMany

fun <T1 : Any, T2 : Any> mockMany(mode: MockMode? = null, block: MokkeryMockConfigurer.Block<MockMany2<T1, T2>> = { }): MockMany2<T1, T2>

Provides mock implementation of T1 and T2.

fun <T1 : Any, T2 : Any, T3 : Any> mockMany(mode: MockMode? = null, block: MokkeryMockConfigurer.Block<MockMany3<T1, T2, T3>> = { }): MockMany3<T1, T2, T3>

Provides mock implementation of T1, T2 and T3.

fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any> mockMany(mode: MockMode? = null, block: MokkeryMockConfigurer.Block<MockMany4<T1, T2, T3, T4>> = { }): MockMany4<T1, T2, T3, T4>

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

fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any> mockMany(mode: MockMode? = null, block: MokkeryMockConfigurer.Block<MockMany5<T1, T2, T3, T4, T5>> = { }): MockMany5<T1, T2, T3, T4, T5>

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

mockMany

fun <T1 : Any, T2 : Any> MokkerySuiteScope.mockMany(mode: MockMode? = null, block: MokkeryMockConfigurer.Block<MockMany2<T1, T2>> = { }): MockMany2<T1, T2>

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

fun <T1 : Any, T2 : Any, T3 : Any> MokkerySuiteScope.mockMany(mode: MockMode? = null, block: MokkeryMockConfigurer.Block<MockMany3<T1, T2, T3>> = { }): MockMany3<T1, T2, T3>

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

fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any> MokkerySuiteScope.mockMany(mode: MockMode? = null, block: MokkeryMockConfigurer.Block<MockMany4<T1, T2, T3, T4>> = { }): MockMany4<T1, T2, T3, T4>

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

fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any> MokkerySuiteScope.mockMany(mode: MockMode? = null, block: MokkeryMockConfigurer.Block<MockMany5<T1, T2, T3, T4, T5>> = { }): 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.

spiedObject

inline fun <T : Any> MokkerySpyScope.spiedObject(): T

Returns MokkerySpyScope.spiedObject as T.

spy

fun <T : Any> spy(obj: T, block: MokkerySpyConfigurer.Block<T> = { }): T

Returns given obj wrapped with a spying implementation of T.

spy

fun <T : Any> MokkerySuiteScope.spy(obj: T, block: MokkerySpyConfigurer.Block<T> = { }): T

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

verify

fun verify(mode: VerifyMode? = null, block: MokkeryTemplatingScope.() -> Unit)

Asserts that calls sequence defined in block satisfies given mode.

verify

fun MokkerySuiteScope.verify(mode: VerifyMode? = null, block: MokkeryTemplatingScope.() -> 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? = null, block: suspend MokkeryTemplatingScope.() -> Unit)

Just like verify, but allows suspendable function calls.

verifySuspend

fun MokkerySuiteScope.verifySuspend(mode: VerifyMode? = null, block: suspend MokkeryTemplatingScope.() -> Unit)

Just like verify, but allows suspendable function calls.