commonMain.io.mockk.Answers.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mockk-dsl-jvm Show documentation

Java MockK DSL providing API for MockK implementation

There is a newer version: 1.13.13

package io.mockk

import kotlin.coroutines.Continuation
import kotlin.math.min

/**
 * Returns one constant reply
 */
data class ConstantAnswer(val constantValue: T) : Answer {
    override fun answer(call: Call) = constantValue

    override fun toString(): String = "const($constantValue)"
}

/**
 * Delegates reply to the lambda function
 */
data class FunctionAnswer(val answerFunc: (Call) -> T) : Answer {
    override fun answer(call: Call): T = answerFunc(call)

    override fun toString(): String = "answer()"
}

/**
 * Delegates reply to the lambda suspendable function
 */
data class CoFunctionAnswer(val answerFunc: suspend (Call) -> T) : Answer {

    override fun answer(call: Call): T {
        val lastParam = call.invocation.args.lastOrNull()
        return if (lastParam is Continuation<*>)
            InternalPlatformDsl.coroutineCall {
                answerFunc(call)
            }.callWithContinuation(lastParam)
        else
            InternalPlatformDsl.runCoroutine {
                answerFunc(call)
            }
    }

    override suspend fun coAnswer(call: Call) = answerFunc(call)

    override fun toString(): String = "coAnswer()"

    companion object
}

/**
 * Required to signalize many answers available
 */
interface ManyAnswerable : Answer {
    val hasMore: Boolean

    val flatAnswers: List>
}

/**
 * Returns many different replies, each time moving the next list element.
 * Stops at the end.
 */
data class ManyAnswersAnswer(val answers: List>) : ManyAnswerable {

    override val flatAnswers = answers.flatMap {
        when (it) {
            is ManyAnswerable -> it.flatAnswers
            else -> listOf(it)
        }
    }

    private var pos = InternalPlatformDsl.counter()

    override val hasMore: Boolean
        get() = pos.value < flatAnswers.size

    override fun answer(call: Call): T {
        if (flatAnswers.isEmpty()) {
            throw MockKException("In many answers answer no answer available")
        }
        val pos = min(pos.increment(), (flatAnswers.size - 1).toLong()).toInt()
        return flatAnswers[pos].answer(call)
    }
}

/**
 * Throws exception instead of function reply
 */
data class ThrowingAnswer(val ex: Throwable) : Answer {
    override fun answer(call: Call): Nothing {
        throw ex
    }
}