Overriding beans in Integration tests

For my Spring-Boot app I provide a RestTemplate though a @Configuration file so I can add sensible defaults(ex Timeouts). For my integration tests I would like to mock the RestTemplate as I dont want to connect to external services – I know what responses to expect. I tried providing a different implementation in the integration-test package in the hope that the latter will override the real implementation , but checking the logs it`s the other way around : the real implementation overrides the test one.

How can I make sure the one from the TestConfig is the one used?

This is my config file :

@Configuration
public class RestTemplateProvider {

    private static final int DEFAULT_SERVICE_TIMEOUT = 5_000;

    @Bean
    public RestTemplate restTemplate(){
        return new RestTemplate(buildClientConfigurationFactory());
    }

    private ClientHttpRequestFactory buildClientConfigurationFactory() {
        HttpComponentsClientHttpRequestFactory factory = new HttpComponentsClientHttpRequestFactory();
        factory.setReadTimeout(DEFAULT_SERVICE_TIMEOUT);
        factory.setConnectTimeout(DEFAULT_SERVICE_TIMEOUT);
        return factory;
    }
}

JavaScript
​x
 
@Configurationpublic class RestTemplateProvider {​    private static final int DEFAULT_SERVICE_TIMEOUT = 5_000;​    @Bean    public RestTemplate restTemplate(){        return new RestTemplate(buildClientConfigurationFactory());    }​    private ClientHttpRequestFactory buildClientConfigurationFactory() {        HttpComponentsClientHttpRequestFactory factory = new HttpComponentsClientHttpRequestFactory();        factory.setReadTimeout(DEFAULT_SERVICE_TIMEOUT);        factory.setConnectTimeout(DEFAULT_SERVICE_TIMEOUT);        return factory;    }}​

Integration test:

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = TestConfiguration.class)
@WebAppConfiguration
@ActiveProfiles("it")
public abstract class IntegrationTest {}

JavaScript
 
@RunWith(SpringJUnit4ClassRunner.class)@SpringApplicationConfiguration(classes = TestConfiguration.class)@WebAppConfiguration@ActiveProfiles("it")public abstract class IntegrationTest {}​

TestConfiguration class:

@Configuration
@Import({Application.class, MockRestTemplateConfiguration.class})
public class TestConfiguration {}

JavaScript
 
@Configuration@Import({Application.class, MockRestTemplateConfiguration.class})public class TestConfiguration {}​

And finally MockRestTemplateConfiguration

@Configuration
public class MockRestTemplateConfiguration {

    @Bean
    public RestTemplate restTemplate() {
        return Mockito.mock(RestTemplate.class)
    }
}

JavaScript
 
@Configurationpublic class MockRestTemplateConfiguration {​    @Bean    public RestTemplate restTemplate() {        return Mockito.mock(RestTemplate.class)    }}​

Answer

Since Spring Boot 1.4.x there is an option to use @MockBean annotation to fake Spring beans.

Reaction on comment:

To keep context in cache do not use @DirtiesContext, but use @ContextConfiguration(name = "contextWithFakeBean") and it will create separate context, while it will keep default context in cache. Spring will keep both (or how many contexts you have) in cache.

Our build is this way, where most of the tests are using default non-poluted config, but we have 4-5 tests that are faking beans. Default context is nicely reused

Advertisement

Answer