Thursday, February 13, 2014

Testing your RESTful services with Groovy, Spock and HTTPBuilder

I like to test the HTTP portion of the RESTful web services I build in isolation. This is because, in the languages I use (Java, Scala), most of the code responsible for taking in HTTP requests and parsing them is very framework specific and simply delegates the actual logic to another part of my application. Ideally I can launch this part of my application in the same way as it is launched in production but with the rest of the application stubbed out.

Recently I've been using Groovy/Spock for these integration tests, here's how for a really simple web service. In this example it's been built with Spring Boot.

Let's not go into the details of how Spring boot work but it is essentially the same application as in Spring's guide.

The web application has a single path: /exampleendpoint which takes in a single query param: input and returns a JSON object with a single field payload with the value: Something really important: with the input appended.

I want to test that the web service takes in HTTP, takes the query parameter out and builds the JSON correctly. With Groovy/Spock/HTTPBuilder here's how it looks:

Let's look at what is going on here:
  • In the setup phase we create a RESTClient
  • In the exercising phase we make a call out to the web application.
  • In the verification phase we check that the response code is 200, the content type is "application/json" and the body is JSON with a single payload field that contains "Something really important: Get a hair cut"
Benefits over writing this in Groovy/Spock over say just using Java/JUnit:
  • The HTTP libraries are easier to use with less code
  • The assertions are more expressive
  • More magic, for instance the second with() block works on a Groovy map that has automagically created
The above example doesn't deal with how to start and stop the web service under test, I left that out as it is very web framework specific. 

What do you need in your build to get this setup? I used Gradle for this example so it is probably easier to just check out the build.gradle, a lot of it can be ignored as it is related to Spring Boot rather than Spock. Here are the important bits:

The plugins:

And the dependencies:

The entire project is here. Happy testing.

18 comments:

Wizard Infoways said...

Thanks for sharing the information.

For more info : Mobile Apps Solutions

DAMROX said...

This is really helpful. Thanks

Christopher Batey said...

No problem!

Aniket Shirawadekar said...
This comment has been removed by the author.
Unknown said...

I agree that this is helpful. Unfortunately the project 404s in Github. Did that project contain additional examples? I'd be interested in seeing more. Thanks!

keerthi shekar said...

Great Work. This post is worth everyone’s attention. web design company in chennai

Shreeja K said...

Informative article, just what I was looking for.seo services chennai

Winwebsolutionz said...

Can truly relate and retain this outstanding post. Very well written. web design company Chennai

Suba said...

Testing makes your customer to get full satisfaction on your service since it found out all the bugs and errors and rectify it. Selenium is the best tool ever to test web-based applications. Thank you for your information.

Regards:
Selenium Training in Chennai | Selenium Training

Mathi said...

It is very useful information. It will help to improve my knowledge in Selenium. Thank you for sharing this awesome site.
Selenium training Chennai | Selenium testing training in Chennai | Best selenium training in Chennai | Selenium classes in Chennai

Kingsly David said...

Nice Blog, Thanks for sharing this valuable one. This very useful for me and gain more information. Regards,
Selenium Training in Chennai

Anexas Europe said...

I think this is the best article today about the future technology. Thanks for taking your own time to discuss this topic, I feel happy about that curiosity has increased to learn more about this topic. Artificial Intelligence Training in Bangalore. Keep sharing your information regularly for my future reference.

Sunshine Eco Cleaning said...

Thanks for sharing informative post. Looking for best cleaning companies Sunshine Coast? We are the professional cleaners offering bond cleaning & other cleaning service at affordable price.

Sprint-Driving-School said...

Great information… Domestic oven detailers are premium over cleaners in Melbourne offering affordable oven & BBQ cleaning by trained professionals.

christopher said...

medicare lcd
medicare denial codes
medicare id format
medicare part c
medicare card images
medicare advantage plan
medicare provider phone number
medicare definition
medicare lcd guidelines

Kayal m said...

You did very great work by adding some good information here. I received some ideas here and Thank you...

Tableau Training in Chennai
Tableau Course in Chennai
Power BI Training in Chennai
Job Openings in Chennai
Pega Training in Chennai
Linux Training in Chennai
Placement Training in Chennai
Soft Skills Training in Chennai
Appium Training in Chennai
Tableau Training in Velachery
Tableau Training in OMR

gokul said...

Thank you for this informative blog
Top 5 Data science training in chennai
Data science training in chennai
Data science training in velachery
Data science training in OMR
Best Data science training in chennai
Data science training course content
Data science certification in chennai
Data science courses in chennai
Data science training institute in chennai
Data science online course
Data science with python training in chennai
Data science with R training in chennai

balamurugan said...

Thanks for updating this information. Good job.
German Classes in Chennai
best german classes in chennai
french courses in chennai
pearson vue
Blockchain Training in Chennai
Ionic Training in Chennai 
spanish institute in chennai
content writing training in chennai
German Classes in Anna Nagar
German Classes in Tambaram