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:

@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

dsrini.open said…
How did you setup the contextconfig, the other files. Is it through spring beans xml file ? Can you show that configs ?
StackHolder said…
Spring configuration is done by normal @Configuration classes and there is nothing specific related to tests
pbetkier said…
Helpful post, integrating Spring, Spock and Springockito can be tricky.

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?
StackHolder said…
IMHO as long as Spock doesn't support meta-annotations there is no better solution for that
Karol Kuc said…
Why not just
@Bean
ConfigurationService mockedConfiguratinService(){
ConfigurationService cs = Mock()
cs.getClientConfig(CLIENT_ID)>>DataFixtures.clientConfig()
cs
}
in a configuration class?
StackHolder said…
The problem with Spock mocks is that when you want to verify them it needs to be in the same line as setup. But I currently use constructions you've posted with Mockito, however the initialization is done in the particular test, because I don't like to keep mocking separately from test. That causes the problem that you have to remember what is a mock and what is not. It's easy when you're mocking whole layers (as described here: http://www.kubrynski.com/2015/11/smart-package-structure-to-improve.html)
Unknown said…
Hello Jakub,
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
suvathi said…
Such an awesome article, these many days, doubts in multiple concepts were bothering me, I started searching through books and net, but doubt was not cleared, thank you so much for providing this article, helped me a lot
software testing training in chennai
John Loomer said…
Forex Signals, MT4 and MT5 Indicators, Strategies, Expert Advisors, Forex News, Technical Analysis and Trade Updates in the FOREX IN WORLD

Forex Signals Forex Strategies Forex Indicators Forex News Forex World
power said…
To begin, if you have not installed the Python interpreter on your system, now is the time. To make that step easier, install the latest Python distribution using packages compatible with your Linux distribution. rpm, deb and tgz are also available on your Linux CD-ROM or on-line. unindent does not match any outer indentation level
Mike Johnson said…
I wish you good luck in your project, I like it, so I decided to help you. I have many followers in twitter, so I share this article there and buy twitter likes from this site https://soclikes.com/
When you think Indonesia, you probably picture its Labuan Bajo, and sunny beaches in Canggu. Yet, many people don’t realize that Indonesia is also a great place to start a business. According to International Labour Organization, there are about 700 thousand small businesses in Indonesia in 2018, which 57 million are small and medium sized enterprises Start Business in Indonesia

But what makes Indonesia so great? Major cities like Jakarta, Bandung, Yogyakarta, and Surabaya, an impressive university system, and low taxes means the Sunshine country is ripe with opportunity for savvy business owners. Keep reading to learn more about why Indonesia could be the perfect spot to start your new business!
ji jhon 88 said…
The major reason for phenomenal grown of IT in Hyderabad has been the development of infrastructure collectively called as HITEC City, which encouraged many IT companies to set up operations in the city. Salesforce Training in Hyderabad
aaronnssd said…
You've supplied us with an interesting article. This is a fantastic resource for expanding your understanding of the subject Software testing Service Provider Noida Uttar Pradesh. Thank you very much.
Gorish dua said…
Thanks for sharing.
We at Antino Labs believe in redefining and refining our model to suit the industry's requirements. Antino Labs' several years of experience in the market has let us register our global presence. Antino Labs' has the vision to become the world's most trusted partner for digital transformation and we aim to become a brand that defines innovation and the latest technology. We offer clients a one-stop solution for all their interests regarding IT consulting services in Gurgaon and UI/UX design services in Gurgaon.
토토사이트 said…
I've been searching for hours on this topic and finally found your post. 바카라사이트, I have read your post and I am very impressed. We prefer your opinion and will visit this site frequently to refer to your opinion. When would you like to visit my site?


Gorish dua said…
We at Antino Labs believe in redefining and refining our model to suit the industry's requirements. Antino Labs' several years of experience in the market has let us register our global presence. Antino Labs' has the vision to become the world's most trusted partner for digital transformation and we aim to become a brand that defines innovation and the latest technology. We offer clients a one-stop solution for all their interests regarding Application building and Web development.
Web Development Services in Gurgaon
Enga Doctor said…
Thanks for posting. Useful information.

Introducing a new application named Engadoctor. Especially design with newly emerging technology for Online Doctor Consultation & Book Online Doctor Appointment.

Popular posts from this blog

Understanding Spring Web Initialization

Overview of the circuit breaker in Hystrix

Do we really still need a 32-bit JVM?