Skip to main content

REST-Assured framework overview

In modern software development, REST services becomes most popular choice for implementing distributed and scalable web application. They are light and easy to maintain, which results in faster and more effective implementation and system integration.

I recommend you also my other posts about REST-Assured and building microservice’s test automation frameworks:
  • REST-Assured: going deeper
  • Building microservices testing framework

With the increase popularity of RESTful services, there is a need for fast and lightweight tool for REST webservices testing automation. One of the most popular choice is Rest-Assured framework from Jayway. It introduces simplicity of testing web services from dynamic languages like groovy or ruby to java. In this post we will get our hands dirty and write automatic test in Rest-Assured framework.

In order to create complete implementation of automated tests in Rest-Assured framework, we need to write our code against some example API. We’ll use standalone Wiremock mock server, which we had created in previous article (full API documentation with setup tutorial can be found here) or you can just clone working project from my github. Endpoints specifications of API that we will test look as follows:

First method:

  • request:


  • response:


Second method:

  • request:


  • response:


Setting up 

First thing which we have to do is of course to add Rest-Assured dependencies to our project. If you are using gradle, add this dependency to your TestCompile scope:

testCompile 'io.rest-assured:rest-assured:3.0.6'

and the same for Maven users:

<dependency>
    <groupId>io.rest-assured</groupId>
    <artifactId>rest-assured</artifactId>
    <version>3.0.6</version>
    <scope>test</scope>
</dependency>

You can also add libraries to your classpath manually. After refreshing or rebuilding our project we are able to use Rest-Assured. The last thing is to use static import in our test class:

import static io.restassured.RestAssured.*;

Writing tests 

Rest-Assured is using given/when/then notation. In Given section we declare things like content type or request body. In When section we provide HTTP method and endpoint. In Then section we declare response verification. The method hitting our first API method looks as follows:


Every section in method body corresponds to our mock declaration. We are making GET request on /user/{userID} endpoint, and then we check if response contains id, login and www elements, and if the response status is 200. After declaring getUserData method, we can write test method (RestService is a class that contains getUserData method):


Second endpoint in our mock provide POST method. Request body should be declared in Given section, and the rest looks similarly:


…and the test methods that calls method above:


Extras 

Although that main test flow in Rest-Assured is pretty straightforward, framework equips us with many useful features. One of my favourite is log method. Below is an example of using built-in logger in rest-assured method. No magic here, just call log().all() method:


Another important feature is HTTPS Validation. If you have some HTTPS issues, and your test flow doesn’t check any security cases, you can simply call:

RestAssured.useRelaxedHTTPSValidation();

One of the most obvious use case would be extracting values. With Rest-Assured 2.0 it couldn’t be easier. Here’s an example of extracting login value from getUserData() method response:


Those are just few examples. Rest-Assured exposes rich API, that makes your test development easy and effective.

Continue reading 

If you want to continue reading and expand your knowledge in area of REST and microservices, I recommend you these books:
  • Building Microservices – one of the most important books for me, everything you want to know about microservices is here
  • Java For Testers: Learn Java fundamentals fast – test automation does not require complex programming knowledge. Learn fundamentals of Java for test automation. From tester to testers!
  • RESTful Web APIs – another great book about REST architecture. Lots of practical knowledge about designing and consuming RESTful APIs


Summary 

When it comes to test RESTful architecture in Java, Rest-Assured should be your first-choice framework. Test development is easy and efficient. You can learn more about framework in official documentation or go through excellent examples in official jayway github. Complete project from this post is avabile for download from here.

Popular posts from this blog

Notes after TestingCup 2018

On May 28-29th I attended TestingCup conference in Łódź. Having quite unique perspective: this was my second year in row as a Speaker at this conference I want to share some thoughts on the event. Dust has settled, lets go! 



Championship Originally TestingCup is a software testing championship. Wait, what? Yes, the formula is unique: teams and individuals from all around Poland are competing in finding the most bugs and defects in specially prepared application - Mr. Buggy. I don’t have specific data, but since this year’s conference was all english I guess competitors were not only from Poland. As a spectator, I must say that the whole competition looked very professional. There were team shirts and names, podium and trophies (gold cup and cash). 
Some cons? Testing championship is held at the first day of the conference. So this is already a conference, but if you’re not taking part in the championship… there’s not much to do, since all the talks are in the next day. Organizers are aw…

Building microservices testing framework

RESTful services and microservice architecture in general are big trends in the industry right now. I’ve noticed it also from this blog’s traffic analytics, where topics related with REST testing get the highest interest. Therefore I’ve decided to create some kind of example framework for RESTful APIs functional testing. Project is based on REST-Assured as a services client, Spock as a testing framework, Groovy and Gradle. You can clone full repository from my github. Tests are run against Wiremock API described in this post. Please consider this project as a kind of bootstrap, since it’s an example, not full-blown test framework. Ok, so as Linus said – talk is cheap, show me the code!
Dependencies Usually, first thing for me after importing new project is opening build.gradle (or pom.xml, in case of maven). In our example, the most important dependencies are REST-Assured and Spock. We’ve also Jackson, for serializing objects, Logback for our logs and snakeyaml for reading .yaml files,…