test-utils-base/com.splendo.kaluga.test.base.mock

Package-level declarations

Types

sealed class BaseMethodMock<M : ParametersSpec.Matchers, C : ParametersSpec.MatchersOrCaptor<M>, V : ParametersSpec.Values, W : ParametersSpec<M, C, V>, R, A : BaseAnswer<V, R>, S : BaseMethodMock.Stub<M, V, R, A>>

Class for mocking a method that takes parameters described by W and can be stubbed to S

MethodMock

class MethodMock<M : ParametersSpec.Matchers, C : ParametersSpec.MatchersOrCaptor<M>, V : ParametersSpec.Values, W : ParametersSpec<M, C, V>, R>(parametersSpec: W) : BaseMethodMock<M, C, V, W, R, Answer<V, R>, MethodMock.Stub<M, V, R>>

A BaseMethodMock for non-suspending methods.

PairParametersMock

typealias PairParametersMock<ValueOne, ValueTwo, Result> = MethodMock<PairParameters.Matchers<ValueOne, ValueTwo>, PairParameters.MatchersOrCaptor<ValueOne, ValueTwo>, PairParameters.Values<ValueOne, ValueTwo>, PairParameters<ValueOne, ValueTwo>, Result>

QuadrupleParametersMock

QuintupleParametersMock

SingleParametersMock

typealias SingleParametersMock<ValueOne, Result> = MethodMock<SingleParameters.Matchers<ValueOne>, SingleParameters.MatchersOrCaptor<ValueOne>, SingleParameters.Values<ValueOne>, SingleParameters<ValueOne>, Result>

SuspendMethodMock

class SuspendMethodMock<M : ParametersSpec.Matchers, C : ParametersSpec.MatchersOrCaptor<M>, V : ParametersSpec.Values, W : ParametersSpec<M, C, V>, R>(parametersSpec: W) : BaseMethodMock<M, C, V, W, R, SuspendedAnswer<V, R>, SuspendMethodMock.Stub<M, V, R>>

A BaseMethodMock for suspending methods.

SuspendPairParametersMock

typealias SuspendPairParametersMock<ValueOne, ValueTwo, Result> = SuspendMethodMock<PairParameters.Matchers<ValueOne, ValueTwo>, PairParameters.MatchersOrCaptor<ValueOne, ValueTwo>, PairParameters.Values<ValueOne, ValueTwo>, PairParameters<ValueOne, ValueTwo>, Result>

SuspendSingleParametersMock

typealias SuspendSingleParametersMock<ValueOne, Result> = SuspendMethodMock<SingleParameters.Matchers<ValueOne>, SingleParameters.MatchersOrCaptor<ValueOne>, SingleParameters.Values<ValueOne>, SingleParameters<ValueOne>, Result>

SuspendTripleParametersMock

SuspendVoidParametersMock

typealias SuspendVoidParametersMock<Result> = SuspendMethodMock<VoidParameters.Matchers, VoidParameters.MatchersOrCaptor, VoidParameters.Values, VoidParameters, Result>

TripleParametersMock

VoidParametersMock

typealias VoidParametersMock<Result> = MethodMock<VoidParameters.Matchers, VoidParameters.MatchersOrCaptor, VoidParameters.Values, VoidParameters, Result>

Functions

call

fun <Result> MethodMock<VoidParameters.Matchers, VoidParameters.MatchersOrCaptor, VoidParameters.Values, VoidParameters, Result>.call(): Result

Calls a MethodMock without any parameters

suspend fun <Result> SuspendMethodMock<VoidParameters.Matchers, VoidParameters.MatchersOrCaptor, VoidParameters.Values, VoidParameters, Result>.call(): Result

Calls a SuspendMethodMock without any parameters

fun <Value, Result> MethodMock<SingleParameters.Matchers<Value>, SingleParameters.MatchersOrCaptor<Value>, SingleParameters.Values<Value>, SingleParameters<Value>, Result>.call(value: Value): Result

Calls a MethodMock with one parameter

suspend fun <Value, Result> SuspendMethodMock<SingleParameters.Matchers<Value>, SingleParameters.MatchersOrCaptor<Value>, SingleParameters.Values<Value>, SingleParameters<Value>, Result>.call(value: Value): Result

Calls a SuspendMethodMock with one parameter

fun <T0, T1, Result> MethodMock<PairParameters.Matchers<T0, T1>, PairParameters.MatchersOrCaptor<T0, T1>, PairParameters.Values<T0, T1>, PairParameters<T0, T1>, Result>.call(first: T0, second: T1): Result

Calls a MethodMock with two parameters

suspend fun <T0, T1, Result> SuspendMethodMock<PairParameters.Matchers<T0, T1>, PairParameters.MatchersOrCaptor<T0, T1>, PairParameters.Values<T0, T1>, PairParameters<T0, T1>, Result>.call(first: T0, second: T1): Result

Calls a SuspendMethodMock with two parameters

fun <T0, T1, T2, Result> MethodMock<TripleParameters.Matchers<T0, T1, T2>, TripleParameters.MatchersOrCaptor<T0, T1, T2>, TripleParameters.Values<T0, T1, T2>, TripleParameters<T0, T1, T2>, Result>.call(first: T0, second: T1, third: T2): Result

Calls a MethodMock with three parameters

suspend fun <T0, T1, T2, Result> SuspendMethodMock<TripleParameters.Matchers<T0, T1, T2>, TripleParameters.MatchersOrCaptor<T0, T1, T2>, TripleParameters.Values<T0, T1, T2>, TripleParameters<T0, T1, T2>, Result>.call(first: T0, second: T1, third: T2): Result

Calls a SuspendMethodMock with three parameters

fun <T0, T1, T2, T3, Result> MethodMock<QuadrupleParameters.Matchers<T0, T1, T2, T3>, QuadrupleParameters.MatchersOrCaptor<T0, T1, T2, T3>, QuadrupleParameters.Values<T0, T1, T2, T3>, QuadrupleParameters<T0, T1, T2, T3>, Result>.call(first: T0, second: T1, third: T2, fourth: T3): Result

Calls a MethodMock with four parameters

suspend fun <T0, T1, T2, T3, Result> SuspendMethodMock<QuadrupleParameters.Matchers<T0, T1, T2, T3>, QuadrupleParameters.MatchersOrCaptor<T0, T1, T2, T3>, QuadrupleParameters.Values<T0, T1, T2, T3>, QuadrupleParameters<T0, T1, T2, T3>, Result>.call(first: T0, second: T1, third: T2, fourth: T3): Result

Calls a SuspendMethodMock with four parameters

fun <T0, T1, T2, T3, T4, Result> MethodMock<QuintupleParameters.Matchers<T0, T1, T2, T3, T4>, QuintupleParameters.MatchersOrCaptor<T0, T1, T2, T3, T4>, QuintupleParameters.Values<T0, T1, T2, T3, T4>, QuintupleParameters<T0, T1, T2, T3, T4>, Result>.call(first: T0, second: T1, third: T2, fourth: T3, fifth: T4): Result

Calls a MethodMock with five parameters

suspend fun <T0, T1, T2, T3, T4, Result> SuspendMethodMock<QuintupleParameters.Matchers<T0, T1, T2, T3, T4>, QuintupleParameters.MatchersOrCaptor<T0, T1, T2, T3, T4>, QuintupleParameters.Values<T0, T1, T2, T3, T4>, QuintupleParameters<T0, T1, T2, T3, T4>, Result>.call(first: T0, second: T1, third: T2, fourth: T3, fifth: T4): Result

Calls a SuspendMethodMock with five parameters

doReturn

fun <M : ParametersSpec.Matchers, V : ParametersSpec.Values, A : BaseAnswer<V, Unit>, Stub : BaseMethodMock.Stub<M, V, Unit, A>> Stub.doReturn()

Sets the answer of a BaseMethodMock.Stub that returns Unit to simply return Unit.

Generates a stub for a BaseMethodMock without and parameters

fun <Value, Result, Answer : BaseAnswer<SingleParameters.Values<Value>, Result>, Stub : BaseMethodMock.Stub<SingleParameters.Matchers<Value>, SingleParameters.Values<Value>, Result, Answer>> BaseMethodMock<SingleParameters.Matchers<Value>, SingleParameters.MatchersOrCaptor<Value>, SingleParameters.Values<Value>, SingleParameters<Value>, Result, Answer, Stub>.on(value: ParameterMatcher<Value> = ParameterMatcher.any()): Stub

Generates a stub for a BaseMethodMock with one parameter

fun <T0, T1, Result, Answer : BaseAnswer<PairParameters.Values<T0, T1>, Result>, Stub : BaseMethodMock.Stub<PairParameters.Matchers<T0, T1>, PairParameters.Values<T0, T1>, Result, Answer>> BaseMethodMock<PairParameters.Matchers<T0, T1>, PairParameters.MatchersOrCaptor<T0, T1>, PairParameters.Values<T0, T1>, PairParameters<T0, T1>, Result, Answer, Stub>.on(first: ParameterMatcher<T0> = ParameterMatcher.any(), second: ParameterMatcher<T1> = ParameterMatcher.any()): Stub

Generates a stub for a BaseMethodMock with two parameters

fun <T0, T1, T2, Result, Answer : BaseAnswer<TripleParameters.Values<T0, T1, T2>, Result>, Stub : BaseMethodMock.Stub<TripleParameters.Matchers<T0, T1, T2>, TripleParameters.Values<T0, T1, T2>, Result, Answer>> BaseMethodMock<TripleParameters.Matchers<T0, T1, T2>, TripleParameters.MatchersOrCaptor<T0, T1, T2>, TripleParameters.Values<T0, T1, T2>, TripleParameters<T0, T1, T2>, Result, Answer, Stub>.on(first: ParameterMatcher<T0> = ParameterMatcher.any(), second: ParameterMatcher<T1> = ParameterMatcher.any(), third: ParameterMatcher<T2> = ParameterMatcher.any()): Stub

Generates a stub for a BaseMethodMock with three parameters

fun <T0, T1, T2, T3, Result, Answer : BaseAnswer<QuadrupleParameters.Values<T0, T1, T2, T3>, Result>, Stub : BaseMethodMock.Stub<QuadrupleParameters.Matchers<T0, T1, T2, T3>, QuadrupleParameters.Values<T0, T1, T2, T3>, Result, Answer>> BaseMethodMock<QuadrupleParameters.Matchers<T0, T1, T2, T3>, QuadrupleParameters.MatchersOrCaptor<T0, T1, T2, T3>, QuadrupleParameters.Values<T0, T1, T2, T3>, QuadrupleParameters<T0, T1, T2, T3>, Result, Answer, Stub>.on(first: ParameterMatcher<T0> = ParameterMatcher.any(), second: ParameterMatcher<T1> = ParameterMatcher.any(), third: ParameterMatcher<T2> = ParameterMatcher.any(), fourth: ParameterMatcher<T3> = ParameterMatcher.any()): Stub

Generates a stub for a BaseMethodMock with four parameters

fun <T0, T1, T2, T3, T4, Result, Answer : BaseAnswer<QuintupleParameters.Values<T0, T1, T2, T3, T4>, Result>, Stub : BaseMethodMock.Stub<QuintupleParameters.Matchers<T0, T1, T2, T3, T4>, QuintupleParameters.Values<T0, T1, T2, T3, T4>, Result, Answer>> BaseMethodMock<QuintupleParameters.Matchers<T0, T1, T2, T3, T4>, QuintupleParameters.MatchersOrCaptor<T0, T1, T2, T3, T4>, QuintupleParameters.Values<T0, T1, T2, T3, T4>, QuintupleParameters<T0, T1, T2, T3, T4>, Result, Answer, Stub>.on(first: ParameterMatcher<T0> = ParameterMatcher.any(), second: ParameterMatcher<T1> = ParameterMatcher.any(), third: ParameterMatcher<T2> = ParameterMatcher.any(), fourth: ParameterMatcher<T3> = ParameterMatcher.any(), fifth: ParameterMatcher<T4> = ParameterMatcher.any()): Stub

Generates a stub for a BaseMethodMock with five parameters

pairParametersMock

fun <ValueOne, ValueTwo, Result> pairParametersMock(): MethodMock<PairParameters.Matchers<ValueOne, ValueTwo>, PairParameters.MatchersOrCaptor<ValueOne, ValueTwo>, PairParameters.Values<ValueOne, ValueTwo>, PairParameters<ValueOne, ValueTwo>, Result>

quadrupleParametersMock

singleParametersMock

fun <ValueOne, Result> singleParametersMock(): MethodMock<SingleParameters.Matchers<ValueOne>, SingleParameters.MatchersOrCaptor<ValueOne>, SingleParameters.Values<ValueOne>, SingleParameters<ValueOne>, Result>

suspendPairParametersMock

fun <ValueOne, ValueTwo, Result> suspendPairParametersMock(): SuspendMethodMock<PairParameters.Matchers<ValueOne, ValueTwo>, PairParameters.MatchersOrCaptor<ValueOne, ValueTwo>, PairParameters.Values<ValueOne, ValueTwo>, PairParameters<ValueOne, ValueTwo>, Result>

suspendSingleParametersMock

fun <ValueOne, Result> suspendSingleParametersMock(): SuspendMethodMock<SingleParameters.Matchers<ValueOne>, SingleParameters.MatchersOrCaptor<ValueOne>, SingleParameters.Values<ValueOne>, SingleParameters<ValueOne>, Result>

suspendTripleParametersMock

suspendVoidParametersMock

fun <Result> suspendVoidParametersMock(): SuspendMethodMock<VoidParameters.Matchers, VoidParameters.MatchersOrCaptor, VoidParameters.Values, VoidParameters, Result>

tripleParametersMock

verify

Verifies that a BaseMethodMock without parameters has been called

fun <Value, Result, Answer : BaseAnswer<SingleParameters.Values<Value>, Result>, Stub : BaseMethodMock.Stub<SingleParameters.Matchers<Value>, SingleParameters.Values<Value>, Result, Answer>> BaseMethodMock<SingleParameters.Matchers<Value>, SingleParameters.MatchersOrCaptor<Value>, SingleParameters.Values<Value>, SingleParameters<Value>, Result, Answer, Stub>.verify(value: ParameterMatcherOrCaptor<Value> = ParameterMatcher.any(), rule: VerificationRule)

fun <Value, Result, Answer : BaseAnswer<SingleParameters.Values<Value>, Result>, Stub : BaseMethodMock.Stub<SingleParameters.Matchers<Value>, SingleParameters.Values<Value>, Result, Answer>> BaseMethodMock<SingleParameters.Matchers<Value>, SingleParameters.MatchersOrCaptor<Value>, SingleParameters.Values<Value>, SingleParameters<Value>, Result, Answer, Stub>.verify(value: ParameterMatcherOrCaptor<Value> = ParameterMatcher.any(), times: Int = 1)

Verifies that a BaseMethodMock with one parameters has been called with a ParameterMatcherOrCaptor

fun <T0, T1, Result, Answer : BaseAnswer<PairParameters.Values<T0, T1>, Result>, Stub : BaseMethodMock.Stub<PairParameters.Matchers<T0, T1>, PairParameters.Values<T0, T1>, Result, Answer>> BaseMethodMock<PairParameters.Matchers<T0, T1>, PairParameters.MatchersOrCaptor<T0, T1>, PairParameters.Values<T0, T1>, PairParameters<T0, T1>, Result, Answer, Stub>.verify(first: ParameterMatcherOrCaptor<T0> = ParameterMatcher.any(), second: ParameterMatcherOrCaptor<T1> = ParameterMatcher.any(), rule: VerificationRule)

fun <T0, T1, Result, Answer : BaseAnswer<PairParameters.Values<T0, T1>, Result>, Stub : BaseMethodMock.Stub<PairParameters.Matchers<T0, T1>, PairParameters.Values<T0, T1>, Result, Answer>> BaseMethodMock<PairParameters.Matchers<T0, T1>, PairParameters.MatchersOrCaptor<T0, T1>, PairParameters.Values<T0, T1>, PairParameters<T0, T1>, Result, Answer, Stub>.verify(first: ParameterMatcherOrCaptor<T0> = ParameterMatcher.any(), second: ParameterMatcherOrCaptor<T1> = ParameterMatcher.any(), times: Int = 1)

Verifies that a BaseMethodMock with two parameters has been called with all parameters matching their respective ParameterMatcherOrCaptor

fun <T0, T1, T2, Result, Answer : BaseAnswer<TripleParameters.Values<T0, T1, T2>, Result>, Stub : BaseMethodMock.Stub<TripleParameters.Matchers<T0, T1, T2>, TripleParameters.Values<T0, T1, T2>, Result, Answer>> BaseMethodMock<TripleParameters.Matchers<T0, T1, T2>, TripleParameters.MatchersOrCaptor<T0, T1, T2>, TripleParameters.Values<T0, T1, T2>, TripleParameters<T0, T1, T2>, Result, Answer, Stub>.verify(first: ParameterMatcherOrCaptor<T0> = ParameterMatcher.any(), second: ParameterMatcherOrCaptor<T1> = ParameterMatcher.any(), third: ParameterMatcherOrCaptor<T2> = ParameterMatcher.any(), rule: VerificationRule)

fun <T0, T1, T2, Result, Answer : BaseAnswer<TripleParameters.Values<T0, T1, T2>, Result>, Stub : BaseMethodMock.Stub<TripleParameters.Matchers<T0, T1, T2>, TripleParameters.Values<T0, T1, T2>, Result, Answer>> BaseMethodMock<TripleParameters.Matchers<T0, T1, T2>, TripleParameters.MatchersOrCaptor<T0, T1, T2>, TripleParameters.Values<T0, T1, T2>, TripleParameters<T0, T1, T2>, Result, Answer, Stub>.verify(first: ParameterMatcherOrCaptor<T0> = ParameterMatcher.any(), second: ParameterMatcherOrCaptor<T1> = ParameterMatcher.any(), third: ParameterMatcherOrCaptor<T2> = ParameterMatcher.any(), times: Int = 1)

Verifies that a BaseMethodMock with three parameters has been called with all parameters matching their respective ParameterMatcherOrCaptor

fun <T0, T1, T2, T3, Result, Answer : BaseAnswer<QuadrupleParameters.Values<T0, T1, T2, T3>, Result>, Stub : BaseMethodMock.Stub<QuadrupleParameters.Matchers<T0, T1, T2, T3>, QuadrupleParameters.Values<T0, T1, T2, T3>, Result, Answer>> BaseMethodMock<QuadrupleParameters.Matchers<T0, T1, T2, T3>, QuadrupleParameters.MatchersOrCaptor<T0, T1, T2, T3>, QuadrupleParameters.Values<T0, T1, T2, T3>, QuadrupleParameters<T0, T1, T2, T3>, Result, Answer, Stub>.verify(first: ParameterMatcherOrCaptor<T0> = ParameterMatcher.any(), second: ParameterMatcherOrCaptor<T1> = ParameterMatcher.any(), third: ParameterMatcherOrCaptor<T2> = ParameterMatcher.any(), fourth: ParameterMatcherOrCaptor<T3> = ParameterMatcher.any(), rule: VerificationRule)

fun <T0, T1, T2, T3, Result, Answer : BaseAnswer<QuadrupleParameters.Values<T0, T1, T2, T3>, Result>, Stub : BaseMethodMock.Stub<QuadrupleParameters.Matchers<T0, T1, T2, T3>, QuadrupleParameters.Values<T0, T1, T2, T3>, Result, Answer>> BaseMethodMock<QuadrupleParameters.Matchers<T0, T1, T2, T3>, QuadrupleParameters.MatchersOrCaptor<T0, T1, T2, T3>, QuadrupleParameters.Values<T0, T1, T2, T3>, QuadrupleParameters<T0, T1, T2, T3>, Result, Answer, Stub>.verify(first: ParameterMatcherOrCaptor<T0> = ParameterMatcher.any(), second: ParameterMatcherOrCaptor<T1> = ParameterMatcher.any(), third: ParameterMatcherOrCaptor<T2> = ParameterMatcher.any(), fourth: ParameterMatcherOrCaptor<T3> = ParameterMatcher.any(), times: Int = 1)

Verifies that a BaseMethodMock with four parameters has been called with all parameters matching their respective ParameterMatcherOrCaptor

fun <T0, T1, T2, T3, T4, Result, Answer : BaseAnswer<QuintupleParameters.Values<T0, T1, T2, T3, T4>, Result>, Stub : BaseMethodMock.Stub<QuintupleParameters.Matchers<T0, T1, T2, T3, T4>, QuintupleParameters.Values<T0, T1, T2, T3, T4>, Result, Answer>> BaseMethodMock<QuintupleParameters.Matchers<T0, T1, T2, T3, T4>, QuintupleParameters.MatchersOrCaptor<T0, T1, T2, T3, T4>, QuintupleParameters.Values<T0, T1, T2, T3, T4>, QuintupleParameters<T0, T1, T2, T3, T4>, Result, Answer, Stub>.verify(first: ParameterMatcherOrCaptor<T0> = ParameterMatcher.any(), second: ParameterMatcherOrCaptor<T1> = ParameterMatcher.any(), third: ParameterMatcherOrCaptor<T2> = ParameterMatcher.any(), fourth: ParameterMatcherOrCaptor<T3> = ParameterMatcher.any(), fifth: ParameterMatcherOrCaptor<T4> = ParameterMatcher.any(), rule: VerificationRule)

fun <T0, T1, T2, T3, T4, Result, Answer : BaseAnswer<QuintupleParameters.Values<T0, T1, T2, T3, T4>, Result>, Stub : BaseMethodMock.Stub<QuintupleParameters.Matchers<T0, T1, T2, T3, T4>, QuintupleParameters.Values<T0, T1, T2, T3, T4>, Result, Answer>> BaseMethodMock<QuintupleParameters.Matchers<T0, T1, T2, T3, T4>, QuintupleParameters.MatchersOrCaptor<T0, T1, T2, T3, T4>, QuintupleParameters.Values<T0, T1, T2, T3, T4>, QuintupleParameters<T0, T1, T2, T3, T4>, Result, Answer, Stub>.verify(first: ParameterMatcherOrCaptor<T0> = ParameterMatcher.any(), second: ParameterMatcherOrCaptor<T1> = ParameterMatcher.any(), third: ParameterMatcherOrCaptor<T2> = ParameterMatcher.any(), fourth: ParameterMatcherOrCaptor<T3> = ParameterMatcher.any(), fifth: ParameterMatcherOrCaptor<T4> = ParameterMatcher.any(), times: Int = 1)

Verifies that a BaseMethodMock with five parameters has been called with all parameters matching their respective ParameterMatcherOrCaptor

voidParametersMock

fun <Result> voidParametersMock(): MethodMock<VoidParameters.Matchers, VoidParameters.MatchersOrCaptor, VoidParameters.Values, VoidParameters, Result>