mockito-kotlin/org.mockito.kotlin

Package-level declarations

Types

class ArgumentCaptorHolder4<out A, out B, out C, out D>(val first: A, val second: B, val third: C, val fourth: D)

class ArgumentCaptorHolder5<out A, out B, out C, out D, out E>(val first: A, val second: B, val third: C, val fourth: D, val fifth: E)

InOrderOnType

class InOrderOnType<T>(t: T) : KInOrder

KArgumentCaptor

class KArgumentCaptor<out T>(clazz: KClass<*>, isMarkedNullable: Boolean = false)

KInOrder

interface KInOrder : InOrder

KInvocationOnMock

class KInvocationOnMock(invocationOnMock: InvocationOnMock) : InvocationOnMock

KStubbing

class KStubbing<out T : Any>(val mock: T)

MockedObject

class MockedObject<T>(singleton: MockedSingleton<T>, static: MockedStatic<T>?) : ScopedMock

Wraps a MockedSingleton and an optional MockedStatic to provide combined mocking of both instance and static methods on Kotlin object declarations.

MockitoKotlinException

class MockitoKotlinException(message: String?, cause: Throwable? = null) : RuntimeException

UseConstructor

class UseConstructor

VerifyScope

class VerifyScope<out T>(val mock: T)

Properties

firstValue

val <T> ArgumentCaptor<T>.firstValue: T

lastValue

val <T> ArgumentCaptor<T>.lastValue: T

secondValue

val <T> ArgumentCaptor<T>.secondValue: T

singleValue

val <T> ArgumentCaptor<T>.singleValue: T

thirdValue

val <T> ArgumentCaptor<T>.thirdValue: T

Functions

after

fun after(millis: Long): VerificationAfterDelay

Allows verifying over a given period. It causes a verify to wait for a specified period of time for a desired interaction rather than failing immediately if has not already happened. May be useful for testing in concurrent conditions.

and

inline fun <T : Any> and(left: T, right: T): T

argument that matches both given argument matchers.

any

inline fun <T : Any> any(): T

Matches any object, excluding nulls.

anyArray

inline fun <T> anyArray(): Array<T>

Matches any array of type T.

anyOrNull

inline fun <T : Any> anyOrNull(): T

Matches anything, including nulls.

anyValueClass

inline fun <T> anyValueClass(): T

Matches any Kotlin value class with the same boxed type by taking its boxed type.

anyVararg

inline fun <T : Any> anyVararg(): T

Matches any vararg argument, including nulls.

fun <T : Any> anyVararg(clazz: KClass<T>): T

argForWhich

inline fun <T : Any> argForWhich(noinline predicate: T.() -> Boolean): T

Matches an argument that is matching the given ArgumentMatcher.

argThat

inline fun <T : Any> argThat(noinline predicate: T.() -> Boolean): T

Matches an argument that is matching the given predicate. null values will never evaluate to true.

inline fun <T : Any> argThat(matcher: ArgumentMatcher<T>): T

Matches an argument that is matching the given ArgumentMatcher.

argumentCaptor

inline fun <T> argumentCaptor(): KArgumentCaptor<T>

Creates a KArgumentCaptor for given type.

inline fun <T : Any> argumentCaptor(f: KArgumentCaptor<T>.() -> Unit): KArgumentCaptor<T>

Creates a KArgumentCaptor for given type, taking in a lambda to allow fast verification.

inline fun <A : Any, B : Any> argumentCaptor(a: KClass<A> = A::class, b: KClass = B::class): Pair<KArgumentCaptor<A>, KArgumentCaptor>

Creates 2 KArgumentCaptors for given types.

inline fun <A : Any, B : Any, C : Any> argumentCaptor(a: KClass<A> = A::class, b: KClass = B::class, c: KClass<C> = C::class): Triple<KArgumentCaptor<A>, KArgumentCaptor, KArgumentCaptor<C>>

Creates 3 KArgumentCaptors for given types.

inline fun <A : Any, B : Any, C : Any, D : Any> argumentCaptor(a: KClass<A> = A::class, b: KClass = B::class, c: KClass<C> = C::class, d: KClass<D> = D::class): ArgumentCaptorHolder4<KArgumentCaptor<A>, KArgumentCaptor, KArgumentCaptor<C>, KArgumentCaptor<D>>

Creates 4 KArgumentCaptors for given types.

inline fun <A : Any, B : Any, C : Any, D : Any, E : Any> argumentCaptor(a: KClass<A> = A::class, b: KClass = B::class, c: KClass<C> = C::class, d: KClass<D> = D::class, e: KClass<E> = E::class): ArgumentCaptorHolder5<KArgumentCaptor<A>, KArgumentCaptor, KArgumentCaptor<C>, KArgumentCaptor<D>, KArgumentCaptor<E>>

Creates 5 KArgumentCaptors for given types.

argWhere

inline fun <T : Any> argWhere(noinline predicate: (T) -> Boolean): T

Matches an argument that is matching the given predicate. null values will never evaluate to true.

aryEq

inline fun <T> aryEq(value: Array<T>): Array<T>

Any array argument that is equal to the given array, i.e. it has to have the same type, length, and each element has to be equal.

fun aryEq(value: BooleanArray): BooleanArray

boolean array argument that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

fun aryEq(value: ByteArray): ByteArray

byte array argument that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

fun aryEq(value: CharArray): CharArray

char array argument that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

fun aryEq(value: DoubleArray): DoubleArray

double array argument that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

fun aryEq(value: FloatArray): FloatArray

float array argument that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

fun aryEq(value: IntArray): IntArray

int array argument that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

fun aryEq(value: LongArray): LongArray

long array argument that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

fun aryEq(value: ShortArray): ShortArray

short array argument that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

atLeast

fun atLeast(numInvocations: Int): VerificationMode

Allows at-least-x verification.

atLeastOnce

fun atLeastOnce(): VerificationMode

Allows at-least-once verification.

atMost

fun atMost(maxNumberOfInvocations: Int): VerificationMode

Allows at-most-x verification.

callRealMethod

fun <T> OngoingStubbing<T>.callRealMethod(): OngoingStubbing<T>

Calls the real method of the spy/mock when the method is called. E.g:

calls

fun calls(wantedNumberOfInvocations: Int): VerificationMode

Allows non-greedy verification in order.

capture

inline fun <T : Any> capture(captor: ArgumentCaptor<T>): T

Alias for ArgumentCaptor.capture.

check

inline fun <T : Any> check(noinline predicate: (T) -> Unit): T

For usage with verification only.

clearInvocations

fun <T> clearInvocations(vararg mocks: T)

Use this method in order to only clear invocations, when stubbing is non-trivial.

cmpEq

inline fun <T : Comparable<T>> cmpEq(value: T): T

comparable argument equals to the given value according to their compareTo method.

description

fun description(description: String): VerificationMode

Adds a description to be printed if verification fails.

doAnswer

fun <T> doAnswer(answer: (KInvocationOnMock) -> T): Stubber

Sets a generic answer, specified with a lambda, to be applied in reverse stubbing.

doAnswer

infix fun <T> OngoingStubbing<T>.doAnswer(answer: (KInvocationOnMock) -> T?): OngoingStubbing<T>

Sets an answer to be applied when the stubbed method/function is being called, specified by a lambda. E.g:

infix fun <T> OngoingStubbing<T>.doAnswer(answer: Answer<*>): OngoingStubbing<T>

Sets a generic answer to be applied when the stubbed method/function is being called. E.g:

doCallRealMethod

fun doCallRealMethod(): Stubber

Sets to call the real implementation of a method in a mock, to be applied in reverse stubbing.

doCallRealMethod

fun <T> OngoingStubbing<T>.doCallRealMethod(): OngoingStubbing<T>

Calls the real method of the spy/mock when the method is called. E.g:

doNothing

fun doNothing(): Stubber

Sets to do nothing, to be applied in reverse stubbing. This comes handy is some rare cases, like:

doReturn

fun doReturn(value: Any?): Stubber

Sets a value to be returned, to be applied in reverse stubbing.

fun doReturn(value: Any?, vararg values: Any?): Stubber

Sets values to be returned on consecutive invocations, to be applied in reverse stubbing.

doReturn

infix fun <T> OngoingStubbing<T>.doReturn(value: T): OngoingStubbing<T>

Sets a value to be returned when the stubbed method/function is being called. E.g:

fun <T> OngoingStubbing<T>.doReturn(value: T, vararg values: T): OngoingStubbing<T>

Sets values to be returned when the stubbed method/function is being called consecutively. E.g:

doReturnConsecutively

infix fun <T> OngoingStubbing<T>.doReturnConsecutively(values: List<T>): OngoingStubbing<T>

fun <T> OngoingStubbing<T>.doReturnConsecutively(value: T, vararg values: T): OngoingStubbing<T>

Sets values to be returned when the stubbed method/function is being called consecutively. E.g:

doSuspendableAnswer

fun <T> doSuspendableAnswer(answer: suspend (KInvocationOnMock) -> T): Stubber

Sets a generic answer, specified with a suspendable lambda, to be applied in reverse stubbing.

doSuspendableAnswer

infix fun <T> OngoingStubbing<T>.doSuspendableAnswer(answer: suspend (KInvocationOnMock) -> T?): OngoingStubbing<T>

Sets an answer to be applied when the stubbed suspendable function is being called, specified by a suspendable lambda. E.g:

doThrow

fun doThrow(throwable: Throwable): Stubber

Sets a throwable to be thrown, to be applied in reverse stubbing.

fun doThrow(throwableType: KClass<out Throwable>): Stubber

Sets a throwable type to be thrown, to be applied in reverse stubbing.

fun doThrow(throwable: Throwable, vararg throwables: Throwable): Stubber

Sets throwables to be thrown on consecutive calls, to be applied in reverse stubbing.

fun doThrow(throwableType: KClass<out Throwable>, vararg throwableTypes: KClass<out Throwable>): Stubber

Sets throwable types to be thrown on consecutive calls, to be applied in reverse stubbing.

doThrow

infix fun <T> OngoingStubbing<T>.doThrow(throwable: Throwable): OngoingStubbing<T>

Sets a throwable to be thrown when the stubbed method/function is being called. E.g:

infix fun <T> OngoingStubbing<T>.doThrow(throwableType: KClass<out Throwable>): OngoingStubbing<T>

Sets a throwable type to be thrown when the stubbed method/function is being called. E.g:

fun <T> OngoingStubbing<T>.doThrow(throwable: Throwable, vararg throwables: Throwable): OngoingStubbing<T>

Sets throwables to be thrown when the stubbed method/function is being called consecutively. E.g:

fun <T> OngoingStubbing<T>.doThrow(throwableType: KClass<out Throwable>, vararg throwableTypes: KClass<out Throwable>): OngoingStubbing<T>

Sets throwable types to be thrown when the stubbed method is called consecutively. E.g:

inline fun <T> eq(value: T): T

Matches an argument that is equal to the given value.

eqValueClass

inline fun <T : Any> eqValueClass(value: T): T

Matches an argument that is equal to the given Kotlin value class value.

find

fun find(regex: Regex): String

String argument that contains a substring that matches the given regular expression.

geq

inline fun <T : Comparable<T>> geq(value: T): T

comparable argument greater than or equal the given value.

given

fun <T> given(methodCall: T): BDDMockito.BDDMyOngoingStubbing<T>

Alias for BDDMockito.given.

fun <T> given(methodCall: () -> T): BDDMockito.BDDMyOngoingStubbing<T>

Alias for BDDMockito.given with a lambda.

givenBlocking

fun <T> givenBlocking(methodCall: suspend CoroutineScope.() -> T): BDDMockito.BDDMyOngoingStubbing<T>

Alias for BDDMockito.given with a suspending lambda

inline fun <T : Comparable<T>> gt(value: T): T

comparable argument greater than the given value.

ignoreStubs

fun ignoreStubs(vararg mocks: Any): Array<out Any>

Ignores stubbed methods of given mocks for the sake of verification.

inOrder

fun inOrder(vararg mocks: Any): KInOrder

Creates KInOrder object that allows verifying mocks in order.

inline fun inOrder(vararg mocks: Any, evaluation: KInOrder.() -> Unit)

Creates KInOrder object that allows verifying mocks in order. Accepts a lambda to allow easy evaluation.

inOrder

inline fun <T> T.inOrder(block: InOrderOnType<T>.() -> Any)

Allows KInOrder verification for a single mocked instance:

isA

inline fun <T : Any> isA(): T

Matches an argument that is instance of the given class.

isNotNull

fun <T : Any> isNotNull(): T?

Matches an argument that is not null.

isNull

fun <T : Any> isNull(): T?

Matches an argument that is null.

leq

inline fun <T : Comparable<T>> leq(value: T): T

comparable argument greater than or equal to the given value.

inline fun <T : Comparable<T>> lt(value: T): T

comparable argument less than the given value.

mock

inline fun <T : Any> ~~mock~~(s: String): T

inline fun <T : Any> ~~mock~~(s: MockSettings): T

inline fun <T : Any> ~~mock~~(a: Answer<Any>): T

inline fun <T : Any> mock(extraInterfaces: Array<out KClass<out Any>>? = null, name: String? = null, spiedInstance: Any? = null, defaultAnswer: Answer<Any>? = null, serializable: Boolean = false, serializableMode: SerializableMode? = null, verboseLogging: Boolean = false, invocationListeners: Array<InvocationListener>? = null, stubOnly: Boolean = false, useConstructor: UseConstructor? = null, outerInstance: Any? = null, lenient: Boolean = false, strictness: Strictness? = if (lenient) Strictness.LENIENT else null): T

Creates a mock for T.

Creates a mock for T, allowing for immediate stubbing.

mockConstruction

inline fun <T> mockConstruction(): MockedConstruction<T>

inline fun <T> mockConstruction(mockInitializer: MockedConstruction.MockInitializer<T>): MockedConstruction<T>

Creates a thread-local mock for constructions of T.

mockExtensionFun

fun mockExtensionFun(function: KFunction<*>): MockedStatic<*>

Creates a thread-local mock for the static methods of the class that contains this top-level extension function.

mockingDetails

fun mockingDetails(toInspect: Any): MockingDetails

mockObject

fun <T : Any> mockObject(instance: T): MockedObject<T>

Creates a thread-local mock for an object or companion object singleton.

fun <T : Any> mockObject(instance: T, stubbing: KStubbing<T>.(T) -> Unit): MockedObject<T>

Creates a thread-local mock for an object or companion object singleton, allowing for immediate stubbing.

mockStatic

inline fun <T> mockStatic(defaultAnswer: Answer<Any>? = null): MockedStatic<T>

Creates a thread-local mock for static methods on T.

never

fun never(): VerificationMode

Alias for times with parameter 0.

not

inline fun <T : Any> not(matcher: T): T

argument that does not match the given argument matcher.

notNull

fun <T : Any> notNull(): T?

Matches an argument that is not null.

nullableArgumentCaptor

inline fun <T : Any> nullableArgumentCaptor(): KArgumentCaptor<T?>

Creates a KArgumentCaptor for given nullable type.

inline fun <T : Any> nullableArgumentCaptor(f: KArgumentCaptor<T?>.() -> Unit): KArgumentCaptor<T?>

Creates a KArgumentCaptor for given nullable type, taking in a lambda to allow fast verification.

only

fun only(): VerificationMode

Allows checking if given method was the only one invoked.

inline fun <T : Any> or(left: T, right: T): T

argument that matches both given argument matchers.

refEq

inline fun <T : Any> refEq(value: T, vararg excludeFields: String): T

Matches an argument that is reflection-equal to the given value with support for excluding selected fields from a class.

reset

fun <T> reset(vararg mocks: T)

same

fun <T> same(value: T): T

Matches an argument that is the same as the given value.

shouldBlocking

fun <T, R> BDDMockito.Then<T>.shouldBlocking(f: suspend T.() -> R): R

Alias for Then.should, with suspending lambda.

spy

inline fun <T : Any> spy(): T

fun <T> spy(value: T): T

Creates a spy of the real object. The spy calls real methods unless they are stubbed.

inline fun <T : Any> spy(stubbing: KStubbing<T>.(T) -> Unit): T

inline fun <T : Any> spy(value: T, stubbing: KStubbing<T>.(T) -> Unit): T

Creates a spy of the real object, allowing for immediate stubbing. The spy calls real methods unless they are stubbed.

stub

inline fun <T : Any> T.stub(stubbing: KStubbing<T>.(T) -> Unit): T

Stub a mock with given stubbing configuration.

stubbing

inline fun <T : Any> stubbing(mock: T, stubbing: KStubbing<T>.(T) -> Unit)

Stub a mock with given stubbing configuration.

suspendFunctionArgumentCaptor

inline fun <T : Function<*>> suspendFunctionArgumentCaptor(): KArgumentCaptor<T>

Creates a KArgumentCaptor for given (suspend function).

then

fun <T> then(mock: T): BDDMockito.Then<T>

Alias for BDDMockito.then.

timeout

fun timeout(millis: Long): VerificationWithTimeout

Allows verifying with timeout. It causes a verify to wait for a specified period of time for a desired interaction rather than fails immediately if has not already happened. May be useful for testing in concurrent conditions.

times

fun times(numInvocations: Int): VerificationMode

Allows verifying exact number of invocations.

validateMockitoUsage

fun validateMockitoUsage()

verify

fun <T> verify(mock: T): T

Verifies certain behavior happened once.

inline fun <T> verify(mock: T, block: VerifyScope<T>.() -> Unit)

Verify multiple calls on mock Supports an easier to read style of

fun <T> verify(mock: T, mode: VerificationMode): T

Verifies certain behavior happened at least once / exact number of times / never.

verify

fun <T> MockedStatic<T>.verify(mode: VerificationMode, verification: MockedStatic.Verification)

Syntax sugar to enable SAM conversion syntax for MockedStatic.verify with a VerificationMode.

verifyBlocking

fun <T> verifyBlocking(mock: T, f: suspend T.() -> Unit)

Verifies certain suspending behavior happened once.

fun <T> verifyBlocking(mock: T, mode: VerificationMode, f: suspend T.() -> Unit)

Verifies certain behavior happened at least once / exact number of times / never.

verifyNoInteractions

fun verifyNoInteractions(vararg mocks: Any)

Checks if any of given mocks has any unverified interaction.

verifyNoMoreInteractions

fun <T> verifyNoMoreInteractions(vararg mocks: T)

Verifies that no interactions happened on given mocks beyond the previously verified interactions.

whenever

fun <T> whenever(methodCall: T): OngoingStubbing<T>

fun <T> whenever(methodCall: suspend () -> T): OngoingStubbing<T>

Enables stubbing methods/function calls. In case of Kotlin function calls, these can be either synchronous or suspendable function calls.

whenever

fun <S, T> MockedStatic<T>.whenever(verification: () -> S): OngoingStubbing<S>

inline fun <T> LenientStubber.whenever(methodCall: T): OngoingStubbing<T>

inline fun <T> LenientStubber.whenever(methodCall: () -> T): OngoingStubbing<T>

fun <T> Stubber.whenever(mock: T): T

Sets the mock to apply the reverse stubbing on.

fun <T> Stubber.whenever(mock: T, methodCall: suspend T.() -> Unit)

Sets the mock and the method call to be stubbed. With this version of whenever you can reverse stub either synchronous or suspendable function calls.

wheneverBlocking

fun <T> ~~wheneverBlocking~~(methodCall: suspend CoroutineScope.() -> T): OngoingStubbing<T>

Enables stubbing methods/function calls. In case of Kotlin function calls, these can be either synchronous or suspendable function calls.

wheneverBlocking

fun <T> Stubber.~~wheneverBlocking~~(mock: T, methodCall: suspend T.() -> Unit)

Sets the mock and the method call to be stubbed. With this version of whenever you can reverse stub either synchronous or suspendable function calls.

will

infix fun <T> BDDMockito.BDDMyOngoingStubbing<T>.will(answer: Answer<T>): BDDMockito.BDDMyOngoingStubbing<T>

Alias for BDDMyOngoingStubbing.will

willAnswer

infix fun <T> BDDMockito.BDDMyOngoingStubbing<T>.willAnswer(answer: (InvocationOnMock) -> T?): BDDMockito.BDDMyOngoingStubbing<T>

Alias for BDDMyOngoingStubbing.willAnswer, accepting a lambda.

willReturn

infix fun <T> BDDMockito.BDDMyOngoingStubbing<T>.willReturn(value: () -> T): BDDMockito.BDDMyOngoingStubbing<T>

Alias for BDDMyOngoingStubbing.willReturn.

willReturnConsecutively

infix fun <T> BDDMockito.BDDMyOngoingStubbing<T>.willReturnConsecutively(values: List<T>): BDDMockito.BDDMyOngoingStubbing<T>

Sets consecutive return values to be returned when the method is called. Same as BDDMyOngoingStubbing.willReturn, but accepts list instead of varargs.

willSuspendableAnswer

infix fun <T> BDDMockito.BDDMyOngoingStubbing<T>.willSuspendableAnswer(answer: suspend (InvocationOnMock) -> T?): BDDMockito.BDDMyOngoingStubbing<T>

Alias for BDDMyOngoingStubbing.willAnswer, accepting a suspend lambda.

willThrow

infix fun <T> BDDMockito.BDDMyOngoingStubbing<T>.willThrow(throwable: () -> Throwable): BDDMockito.BDDMyOngoingStubbing<T>

Alias for BDDMyOngoingStubbing.willThrow.

infix fun <T> BDDMockito.BDDMyOngoingStubbing<T>.willThrow(throwableType: KClass<out Throwable>): BDDMockito.BDDMyOngoingStubbing<T>

Sets a Throwable type to be thrown when the method is called.

fun <T> BDDMockito.BDDMyOngoingStubbing<T>.willThrow(throwableType: KClass<out Throwable>, vararg throwableTypes: KClass<out Throwable>): BDDMockito.BDDMyOngoingStubbing<T>

Sets Throwable classes to be thrown when the method is called.

withSettings

fun withSettings(extraInterfaces: Array<out KClass<out Any>>? = null, name: String? = null, spiedInstance: Any? = null, defaultAnswer: Answer<Any>? = null, serializable: Boolean = false, serializableMode: SerializableMode? = null, verboseLogging: Boolean = false, invocationListeners: Array<InvocationListener>? = null, stubOnly: Boolean = false, useConstructor: UseConstructor? = null, outerInstance: Any? = null, lenient: Boolean = false, strictness: Strictness? = if (lenient) Strictness.LENIENT else null): MockSettings

Allows mock creation with additional mock settings. See MockSettings.