Spy a service spring having transactional methods

Question

I am trying to write some JUnit tests. In my test class i need to spy a service having transactional methods in the implementation. When i am trying to spy that service, i get this error:

Mockito cannot mock/spy because :
 - final class

If i remove @Transactional from the methods, the spy is working properly. I understand it is a problem because of the service proxy. How can i solve this thing?

My test class:

@RunWith(SpringRunner.class)
@ContextConfiguration(classes = {CreateIfcClusterTaskTest.Config.class})
@DirtiesContext(classMode =
        DirtiesContext.ClassMode.AFTER_EACH_TEST_METHOD)
public class CreateIfcClusterTaskTest {

    static class Config extends SpringTestConfiguration {
        @Bean
        @Primary
        public VirtualControllerService
        virtualControllerService(VirtualControllerService
                                         virtualControllerService) {
            return Mockito.spy(virtualControllerService);
        }
    }
}

My service - VirtualControllerService:

public interface VirtualControllerService {

    JsonHost createVifcHostForWebApi(VirtualController virtualController);

    void stopDocker(DockerClient docker, String joinerIpAddress) throws
            DockerException, InterruptedException;


}

My service impl - VirtualControllerServiceImpl:

@Service
public class VirtualControllerServiceImpl implements
        VirtualControllerService {
    @Override
    @Transactional
    public JsonHost createVifcHostForWebApi(VirtualController
                                                    virtualController) {
        JsonHost jsonHost = new JsonHost();
        jsonHost.setIP(virtualController.getIpAddress());
        jsonHost.setUser(environment.getProperty("VIFC_WEBAPI_USER"));



        jsonHost.setPassword(environment.getProperty("VIFC_WEBAPI_PASSWORD"));


        return jsonHost;
    }

}

sfiss · Accepted Answer · 2019-06-28T11:54:43.747

1

According to this issue I found, one possible workaround is to use

So instead of : spy(proxy) use mock(TestSubject.class, delegatesTo(springProxy)).

In your case (untested by me), that would probably be

return Mockito.mock(VirtualControllerService.class, AdditionalAnswers.delegatesTo(virtualControllerService));

See AdditionalAnswers.delegateTo for more information. Note that you can not stub or verify internal method calls in your spied instance (only the method call to the mock object will be tracked). Use case:

Useful for spies or partial mocks of objects that are difficult to mock or spy using the usual spy API. Possible use cases: Already custom proxied object

edited Jun 28 '19 at 11:54

answered Jun 28 '19 at 08:38

sfiss

2,119
13
19

but i need a spy, not a mock – SEBASTIANNICOLAE BURCHIDRAGOMI Jun 28 '19 at 11:46
The mock delegates to your spied instance, working like a spy? See https://static.javadoc.io/org.mockito/mockito-core/2.2.7/org/mockito/AdditionalAnswers.html#delegatesTo(java.lang.Object) I have updated the answer. – sfiss Jun 28 '19 at 11:52

score 0 · Answer 2 · answered Jun 28 '19 at 08:31

Instead of creating a bean of Service class in your config, you could use @Mock annotation in your Test Class CreateIfcClusterTaskTest to mock the service instance.

It would look something like this:

@RunWith(SpringRunner.class)
@ContextConfiguration(classes = { CreateIfcClusterTaskTest.Config.class })
@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_EACH_TEST_METHOD)
public class CreateIfcClusterTaskTest {

    @Mock
    VirtualControllerService virtualControllerService;
}

And you wiil have to initialize Objects using Mockito's annotations as follow:

@Before
public void setUp() throws Exception {
    MockitoAnnotations.initMocks(this);
}

Hope that helps.

Spy a service spring having transactional methods

2 Answers2