Spring integration testing with Spock
I'm currently working on a project where we use Spring Framework 4.0 and Spock for testing. Unit testing in Spock is really great, but there are some lacks in integration testing - especially in mocking Spring beans. Our requirement is to start up Spring context but with particular bean replaced with mock.
The easiest part we had do implement is just regular Spring test specification:
The problem here is that getAuthToken method have to find this client configuration (including for example some keys data). It's done by invoking configurationService.getClientConfig(CLIENT_ID) method. So the best option here is to mock this invocation and return some predefined fixture.
What comes on my mind in that moment is Springockito project. Due to JavaConfig is our application springockito-annotations module have to be used. After adding proper dependency you just need to add "loader = SpringockitoAnnotatedContextLoader" into @ContextConfiguration.
And last but not least part - setting up mock. After many tries it was impossible for me to drive Spock mocking framework to do that, so I come back to old-school Mockito. Finally my test class looks as follows:
And that leads our test to working properly :)
The easiest part we had do implement is just regular Spring test specification:
@ContextConfiguration(
classes = [GatewayConfig, PaymentServiceConfig])
class PaymentServiceSpecIT extends Specification {
final String CLIENT_ID = "54321"
@Inject
PaymentService paymentService
def "Should return auth token"() {
when:
def token = paymentService.getAuthToken(CLIENT_ID)
then:
token
}
}
The problem here is that getAuthToken method have to find this client configuration (including for example some keys data). It's done by invoking configurationService.getClientConfig(CLIENT_ID) method. So the best option here is to mock this invocation and return some predefined fixture.
What comes on my mind in that moment is Springockito project. Due to JavaConfig is our application springockito-annotations module have to be used. After adding proper dependency you just need to add "loader = SpringockitoAnnotatedContextLoader" into @ContextConfiguration.
And last but not least part - setting up mock. After many tries it was impossible for me to drive Spock mocking framework to do that, so I come back to old-school Mockito. Finally my test class looks as follows:
@ContextConfiguration(
classes = [GatewayConfig, PaymentServiceConfig],
loader = SpringockitoAnnotatedContextLoader)
class PaymentServiceSpecIT extends Specification {
final String CLIENT_ID = "54321"
@Inject
PaymentService paymentService
@Inject
@ReplaceWithMock
ConfigurationService configService
def "Should return auth token"() {
given:
given(configService.getClientConfig(CLIENT_ID))
.willReturn(DataFixtures.clientConfig())
when:
def token = paymentService.getAuthToken(CLIENT_ID)
then:
token
}
}
And that leads our test to working properly :)
Comments
It's worth noting that there is a pitfall when integrating Spock and Spring Boot with implicit property sources (application.properties etc.). In order to get them loaded in the first example (without Springockito), we should additionally specify "loader = SpringApplicationContextLoader" in @ContextConfiguration. In the second example, with Springockito, we cannot do that since we need a SpringockitoAnnotatedContextLoader, but adding "initializers = ConfigFileApplicationContextInitializer" to @ContextConfiguration solves the problem.
Alternatively, we could define our property sources explicitly in our JavaConfig e.g. using @PropertySource("application.properties") and leave @ContextConfigurations as presented.
Do you have a better suggestion on how to overcome this pitfall?
@Bean
ConfigurationService mockedConfiguratinService(){
ConfigurationService cs = Mock()
cs.getClientConfig(CLIENT_ID)>>DataFixtures.clientConfig()
cs
}
in a configuration class?
The Article on Spring integration testing with Spock is amazing give detail information about it .Thanks for Sharing the information about Integration Testing.
Software Testing Company