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 object, including nulls.

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

argForWhich

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

Alias for argThat.

argThat

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

Creates a custom argument matcher. null values will never evaluate to true.

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

Registers a custom ArgumentMatcher. The original Mockito function registers the matcher and returns null, here the required type is returned.

argumentCaptor

inline fun <T : Any> 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>>

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 4 KArgumentCaptors for given types.

argWhere

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

Creates a custom argument matcher. 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.

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: (InvocationOnMock) -> T?): Stubber

doAnswer

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

Sets a generic Answer for the method using a lambda.

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

Sets a generic Answer for the method.

doCallRealMethod

fun doCallRealMethod(): Stubber

doNothing

fun doNothing(): Stubber

doReturn

fun doReturn(value: Any?): Stubber

fun doReturn(toBeReturned: Any?, vararg toBeReturnedNext: Any?): Stubber

doReturn

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

Sets a return value to be returned when the method is called.

fun <T> OngoingStubbing<T>.doReturn(t: T, vararg ts: T): OngoingStubbing<T>

Sets consecutive return values to be returned when the method is called.

doReturnConsecutively

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

Sets consecutive return values to be returned when the method is called.

doSuspendableAnswer

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

doThrow

fun doThrow(vararg toBeThrown: Throwable): Stubber

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

doThrow

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

fun <T> OngoingStubbing<T>.doThrow(t: Throwable, vararg ts: Throwable): OngoingStubbing<T>

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

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

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

fun <T> OngoingStubbing<T>.doThrow(t: KClass<out Throwable>, vararg ts: KClass<out Throwable>): OngoingStubbing<T>

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

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

Object argument that is equal to the given 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

Argument that implements the given class.

isNotNull

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

Not null argument.

isNull

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

null argument.

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, @Incubating useConstructor: UseConstructor? = null, @Incubating outerInstance: Any? = null, @Incubating lenient: Boolean = false): T

Creates a mock for T.

Creates a mock for T, allowing for immediate stubbing.

mockingDetails

fun mockingDetails(toInspect: Any): MockingDetails

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?

Not null argument.

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

Object 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

Object 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

stubbing

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

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.

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

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

Enables stubbing methods. Use it when you want the mock to return particular value when particular method is called.

whenever

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

wheneverBlocking

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

Enables stubbing suspending methods. Use it when you want the mock to return particular value when particular suspending method is called.

wheneverBlocking

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

Alias for when with suspending function

will

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

Alias for BDDMyOngoingStubbing.will

willAnswer

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

Alias for BBDMyOngoingStubbing.willAnswer, accepting a lambda.

willReturn

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

Alias for BBDMyOngoingStubbing.willReturn.

willReturnConsecutively

infix inline fun <T> BDDMockito.BDDMyOngoingStubbing<T>.willReturnConsecutively(ts: 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(value: suspend (InvocationOnMock) -> T?): BDDMockito.BDDMyOngoingStubbing<T>

Alias for BBDMyOngoingStubbing.willAnswer, accepting a suspend lambda.

willThrow

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

Alias for BBDMyOngoingStubbing.willThrow.

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

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

fun <T> BDDMockito.BDDMyOngoingStubbing<T>.willThrow(t: KClass<out Throwable>, vararg ts: 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, @Incubating useConstructor: UseConstructor? = null, @Incubating outerInstance: Any? = null, @Incubating lenient: Boolean = false): MockSettings

Allows mock creation with additional mock settings. See MockSettings.