mockk/io.mockk.junit5/MockKExtension

MockKExtension

class MockKExtension : TestInstancePostProcessor, ParameterResolver, AfterEachCallback, AfterAllCallback

MockK JUnit5 extension.

Parameters can use MockK and RelaxedMockK. Class properties can use MockK, RelaxedMockK and SpyK.

unmockkAll will be called after each test function execution if the test lifecycle is set to TestInstance.Lifecycle.PER_METHOD (JUnit 5 default), or after all test functions in the test class have been executed if the test lifecycle is set to TestInstance.Lifecycle.PER_CLASS. unmockkAll will not be called if the KeepMocks annotation is present or if the mockk.junit.extension.keepmocks Gradle property is set to true.

Usage: declare @ExtendWith(MockKExtension::class) on a test class.

Alternatively –Djunit.extensions.autodetection.enabled=true may be placed on a command line.

Constructors

constructor()

Types

CheckUnnecessaryStub

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class CheckUnnecessaryStub

object Companion

ConfirmVerification

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class ConfirmVerification

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class KeepMocks

Prevent calling unmockkAll after each test execution

RequireParallelTesting

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class RequireParallelTesting

Require parallel testing by disabling the clearAllMocks call after each test execution; it is not thread-safe.

Functions

open override fun afterAll(context: ExtensionContext)

open override fun afterEach(context: ExtensionContext)

postProcessTestInstance

open override fun postProcessTestInstance(testInstance: Any, context: ExtensionContext)

resolveParameter

open override fun resolveParameter(parameterContext: ParameterContext, extensionContext: ExtensionContext): Any?

supportsParameter

open override fun supportsParameter(parameterContext: ParameterContext, extensionContext: ExtensionContext): Boolean