MockKDsl

DSL entry points.

Functions

fun internalCheckUnnecessaryStub(mocks: Array<out Any>)

Checks if all recorded calls are necessary.

inline fun internalClearAllMocks(answers: Boolean = true, recordedCalls: Boolean = true, childMocks: Boolean = true, regularMocks: Boolean = true, objectMocks: Boolean = true, staticMocks: Boolean = true, constructorMocks: Boolean = true, verificationMarks: Boolean = true, exclusionRules: Boolean = true)

internalClearConstructorMockk

inline fun internalClearConstructorMockk(classes: Array<out KClass<*>>, answers: Boolean = true, recordedCalls: Boolean = true, childMocks: Boolean = true, verificationMarks: Boolean = true, exclusionRules: Boolean = true)

Clear constructor mocks.

internalClearMocks

inline fun internalClearMocks(firstMock: Any, mocks: Array<out Any>, answers: Boolean = true, recordedCalls: Boolean = true, childMocks: Boolean = true, verificationMarks: Boolean = true, exclusionRules: Boolean = true)

Resets information associated with mock

internalClearObjectMockk

inline fun internalClearObjectMockk(objects: Array<out Any>, answers: Boolean = true, recordedCalls: Boolean = true, childMocks: Boolean = true, verificationMarks: Boolean = true, exclusionRules: Boolean = true)

Clear object mocks.

internalClearStaticMockk

inline fun internalClearStaticMockk(classes: Array<out KClass<*>>, answers: Boolean = true, recordedCalls: Boolean = true, childMocks: Boolean = true, verificationMarks: Boolean = true, exclusionRules: Boolean = true)

Clear static mocks.

internalCoEvery

fun <T> internalCoEvery(stubBlock: suspend MockKMatcherScope.() -> T): MockKStubScope<T, T>

Starts a block of stubbing for coroutines. Part of DSL.

internalCoExcludeRecords

fun internalCoExcludeRecords(current: Boolean = true, excludeBlock: suspend MockKMatcherScope.() -> Unit)

Exclude calls from recording for a suspend block

internalConfirmVerified

fun internalConfirmVerified(mocks: Array<out Any>)

Checks if all recorded calls were verified.

internalConstructorMockk

inline fun <T : Any> internalConstructorMockk(recordPrivateCalls: Boolean = false, localToThread: Boolean = false): MockKConstructorScope<T>

Declares constructor mockk. Deprecated

internalCoVerify

fun internalCoVerify(ordering: Ordering = Ordering.UNORDERED, inverse: Boolean = false, atLeast: Int = 1, atMost: Int = Int.MAX_VALUE, exactly: Int = -1, timeout: Long = 0, verifyBlock: suspend MockKVerificationScope.() -> Unit)

Verify for coroutines

internalCoVerifyAll

fun internalCoVerifyAll(inverse: Boolean = false, verifyBlock: suspend MockKVerificationScope.() -> Unit)

Shortcut for all calls verification

internalCoVerifyOrder

fun internalCoVerifyOrder(inverse: Boolean = false, verifyBlock: suspend MockKVerificationScope.() -> Unit)

Shortcut for ordered calls verification

internalCoVerifySequence

fun internalCoVerifySequence(inverse: Boolean = false, verifyBlock: suspend MockKVerificationScope.() -> Unit)

Shortcut for sequence calls verification

internalEvery

fun <T> internalEvery(stubBlock: MockKMatcherScope.() -> T): MockKStubScope<T, T>

Starts a block of stubbing. Part of DSL.

internalExcludeRecords

fun internalExcludeRecords(current: Boolean = true, excludeBlock: MockKMatcherScope.() -> Unit)

Exclude calls from recording

internalInitAnnotatedMocks

inline fun internalInitAnnotatedMocks(targets: List<Any>, overrideRecordPrivateCalls: Boolean = false, relaxUnitFun: Boolean = false, relaxed: Boolean = false)

Initializes

internalIsMockKMock

fun internalIsMockKMock(mock: Any, regular: Boolean = true, spy: Boolean = false, objectMock: Boolean = false, staticMock: Boolean = false, constructorMock: Boolean = false): Boolean

internalMockk

inline fun <T : Any> internalMockk(name: String? = null, relaxed: Boolean = false, moreInterfaces: Array<out KClass<*>>, relaxUnitFun: Boolean = false, block: T.() -> Unit = {}): T

Builds a new mock for specified class

internalMockkClass

inline fun <T : Any> internalMockkClass(type: KClass<T>, name: String?, relaxed: Boolean, moreInterfaces: Array<out KClass<*>>, relaxUnitFun: Boolean = false, block: T.() -> Unit): T

Builds a mock for a class. Deprecated

internalMockkConstructor

inline fun internalMockkConstructor(classes: Array<out KClass<*>>, recordPrivateCalls: Boolean = false, localToThread: Boolean = true)

Constructor mockk

internalMockkObject

inline fun internalMockkObject(objects: Array<out Any>, recordPrivateCalls: Boolean = false)

Object mockk

internalMockkStatic

inline fun internalMockkStatic(classes: Array<out KClass<*>>)

Static mockk

internalObjectMockk

inline fun internalObjectMockk(objs: Array<out Any>, recordPrivateCalls: Boolean = false): MockKObjectScope

Declares object mockk. Deprecated

internalRegisterInstanceFactory

inline fun <T : Any> internalRegisterInstanceFactory(noinline instanceFactory: () -> T): Deregisterable

Registers instance factory and returns object able to do deregistration.

internalSlot

inline fun <T> internalSlot(): CapturingSlot<T>

Creates new capturing slot

internalSpyk

inline fun <T : Any> internalSpyk(name: String? = null, moreInterfaces: Array<out KClass<*>>, recordPrivateCalls: Boolean = false, block: T.() -> Unit = {}): T

Builds a new spy for specified class. Copies fields from provided object

inline fun <T : Any> internalSpyk(objToCopy: T, name: String? = null, moreInterfaces: Array<out KClass<*>>, recordPrivateCalls: Boolean = false, block: T.() -> Unit = {}): T

Builds a new spy for specified class. Initializes object via default constructor.

internalStaticMockk

inline fun <T : Any> internalStaticMockk(): MockKStaticScope

inline fun internalStaticMockk(kClass: Array<KClass<*>>): MockKStaticScope

Declares static mockk. Deprecated

internalUnmockkAll

inline fun internalUnmockkAll()

Unmockk everything

internalUnmockkConstructor

inline fun internalUnmockkConstructor(classes: Array<out KClass<*>>)

Cancel constructor mocks.

internalUnmockkObject

inline fun internalUnmockkObject(objects: Array<out Any>)

Cancel object mocks.

internalUnmockkStatic

inline fun internalUnmockkStatic(classes: Array<out KClass<*>>)

Cancel static mocks.

internalVerify

fun internalVerify(ordering: Ordering = Ordering.UNORDERED, inverse: Boolean = false, atLeast: Int = 1, atMost: Int = Int.MAX_VALUE, exactly: Int = -1, timeout: Long = 0, verifyBlock: MockKVerificationScope.() -> Unit)

Verifies calls happened in the past. Part of DSL

internalVerifyAll

fun internalVerifyAll(inverse: Boolean = false, verifyBlock: MockKVerificationScope.() -> Unit)

Shortcut for all calls verification

internalVerifyOrder

fun internalVerifyOrder(inverse: Boolean = false, verifyBlock: MockKVerificationScope.() -> Unit)

Shortcut for ordered calls verification

internalVerifySequence

fun internalVerifySequence(inverse: Boolean = false, verifyBlock: MockKVerificationScope.() -> Unit)

Shortcut for sequence calls verification

internalWithInstanceFactory

inline fun <T : Any, R> internalWithInstanceFactory(noinline instanceFactory: () -> T, block: () -> R): R

Executes block of code with registering and unregistering instance factory.