2.8.0

mokkery-runtime/dev.mokkery.answering/Answer

Answer

@DelicateMokkeryApi

interface Answer<out T>(source)

An answer for a function call.

call with MokkeryBlockingCallScope is invoked on blocking function call.
call with MokkerySuspendCallScope is invoked on suspending function call.

Tips for providing correct implementation:

If you want to provide the same implementation for both blocking and suspending call, implement Answer.Unified instead.
If you want your answer to support only blocking or suspending calls, implement Answer.Blocking or Answer.Suspending.
Implement pure Answer if you want implement both methods separately.
Answers should not be used directly. It's a good practice to provide extension based API.

Check existing answers implementations for samples.

Migrations from FunctionScope to MokkeryCallScope:

If your answer overrides both call and callSuspend with FunctionScope, migrate to call with MokkeryBlockingCallScope and call with MokkerySuspendCallScope.
If your answer overrides only call with FunctionScope, it means that it was possible to call this answer in both blocking and suspending context. In this case you need to change the base type from Answer to Answer.Unified. Now, override call with MokkeryCallScope.
If your answer overrides Answer.Suspending simply migrate from callSuspend to call with MokkerySuspendCallScope.

FunctionScope API mappings to MokkeryCallScope API:

FunctionScope member function	MokkeryCallScope extensions
FunctionScope.returnType	MokkeryCallScope.call ->dev.mokkery.context.FunctionCall.function ->dev.mokkery.context.Function.returnType
FunctionScope.args	MokkeryCallScope.call ->dev.mokkery.context.FunctionCall.argValues
FunctionScope.arg	MokkeryCallScope.call ->dev.mokkery.context.FunctionCall.argValue
FunctionScope.supers	MokkeryCallScope.supers
FunctionScope.self	MokkeryCallScope.self
FunctionScope.callOriginal	callOriginal
FunctionScope.callSuspendOriginal	callOriginal
FunctionScope.callSuper	callSuper
FunctionScope.callSuspendSuper	callSuper

Inheritors

Types

object Autofill : Answer.Unified<Any?>

Used whenever there is no defined answer for a call to mock that is in dev.mokkery.MockMode.autofill. Refer to AutofillProvider.forMockMode to read more about returned values.

class Block<T>(val block: BlockingCallDefinitionScope<T>.(CallArgs) -> T) : Answer.Blocking<T>

Calls block on call and callSuspend.

interface Blocking<T> : Answer<T>

Convenience interface for blocking only answers. By default, it throws runtime exception on suspending call.

class BlockSuspend<T>(val block: suspend SuspendCallDefinitionScope<T>.(CallArgs) -> T) : Answer.Suspending<T>

Just like Block but for suspending functions.

class Const<T>(val value: T) : Answer.Unified<T>

Returns value on call and callSuspend.

interface Sequential<T> : Answer<T>

Interface for every answer that have to be called in repeat when specified in sequentially.

SequentialByIterator

class SequentialByIterator<T>(val iterator: Iterator<Answer<T>>) : Answer.Sequential<T>

Returns results of answers from iterator until empty. It supports nested Sequential answers and calls them until they are empty.

interface Suspending<T> : Answer<T>

Convenience interface for suspend only answers. By default, it throws runtime exception on blocking call.

class Throws(val throwable: Throwable) : Answer.Unified<Nothing>

Throws throwable on call and callSuspend

interface Unified<T> : Answer<T>

Convenience interface for answers with identical implementation for both blocking and suspending call.

Functions

open fun call(scope: MokkeryBlockingCallScope): T

Provides a return value for a blocking function call with given scope.

open suspend fun call(scope: MokkerySuspendCallScope): T

Provides a return value for a suspend function call with given scope.

open fun ~~call~~(scope: FunctionScope): T

DEPRECATED: Use call with MokkeryBlockingCallScope instead!

open suspend fun ~~callSuspend~~(scope: FunctionScope): T

DEPRECATED: Use call with MokkerySuspendCallScope instead!

open fun description(): String

Returns human-readable answer description. By default, it returns answers $this. It's used for debugging purposes.