Missing documentation on how to migrate from `@SpyBean` to `@MockitoSpyBean` with Cucumber

[g4iner]

There is a documentation on how to use @MockitoSpyBean, but the problem is how to use it properly with Kotlin. There are only examples with Java.

Before Spring Boot 3.4, I was able to create and use mock with @SpyBean like this:

@Configuration
@SpyBeans(
    SpyBean(SomeProvider::class),
    SpyBean(SecondProvider::class)
)
class TestConfiguration

class TestSteps(
    private val someProvider: SomeProvider,
) {
    @Before
    fun before() {
        doReturn("value").whenever(someProvider).getSomeValue(any())
    }

Now that these annotations are deprecated, I want to migrate them to @MockitoSpyBean.

Should that look like the following?

@Configuration
@MockitoSpyBeans(
   MockitoSpyBean(types = [SomeProvider::class]),
   MockitoSpyBean(types = [SecondProvider::class])
)
class TestConfiguration

class TestSteps(
    private val someProvider: SomeProvider,
) {
    @Before
    fun before() {
        doReturn("value").whenever(someProvider).getSomeValue(any())
    }

With above code the mocks aren't working anymore because of this error:

org.mockito.exceptions.misusing.NotAMockException: 
Argument passed to when() is not a mock!
Example of correct stubbing:
    doThrow(new RuntimeException()).when(mock).someMethod();

Tried this and other solutions like creating mocks in fields inside TestSteps, but nothing worked.

Could you provide documentation on how to migrate the code?

[sbrannen]

@MockitoSpyBean is not supported on a @Configuration class (see #33934).

---

What happens if you try the following?

@Configuration
class TestConfiguration {
    // ...
}

@SpringJUnitConfig(TestConfiguration::class)
@TestConstructor(autowireMode = AutowireMode.ALL)
@MockitoSpyBean(types = [SomeProvider::class, SecondProvider::class])
class TestSteps(
    private val someProvider: SomeProvider
) {

    @BeforeEach
    fun before() {
        doReturn("value").whenever(someProvider).getSomeValue(any())
    }

Also, have you read the Kotlin Testing sections of the reference documentation?

[g4iner]

Unfortunately I'm using Cucumber for my tests instead of JUnit, so this documentation section doesn't provide adequate information.

I added this part and removed TestConfiguration (because this class was only used to create SpyBeans):

@TestConstructor(autowireMode = AutowireMode.ALL)
@MockitoSpyBean(types = [SomeProvider::class, SecondProvider::class])
class TestSteps(
    private val someProvider: SomeProvider
) {

but the problem still exists, maybe because of the use of Cucumber? I have some standard configuration for that in addition to above TestSteps:

@RunWith(Cucumber::class)
class CucumberTest

@CucumberContextConfiguration
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class SpringIntegrationTest

Is it possible to configure this properly with Cucumber instead of JUnit?

[sbrannen]

What happens if you move the @MockitoSpyBean declaration to the test class as follows?

@CucumberContextConfiguration
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@MockitoSpyBean(types = [SomeProvider::class, SecondProvider::class])
class SpringIntegrationTest

If that doesn't work for you, I would recommend that you read the Cucumber Spring documentation, ask for assistance on Stack Overflow, or start a discussion in the Cucumber GitHub repository.

Perhaps @mpkorstanje can assist you.

Since this appears to be either a configuration problem or an issue with Cucumber, I am closing this; however, if you determine that there is a bug within the Spring Framework, feel to provide a sample application which demonstrates the bug, and we will look into it.

[g4iner]

Thanks, this code works:

@CucumberContextConfiguration
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@MockitoSpyBean(types = [SomeProvider::class, SecondProvider::class])
class SpringIntegrationTest

I can't separate these mocks/spies into configuration classes, but this solution is fine :)