DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Please enter at least three characters to search
Refcards Trend Reports
Events Video Library
Refcards
Trend Reports

Events

View Events Video Library

Zones

Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks

Because the DevOps movement has redefined engineering responsibilities, SREs now have to become stewards of observability strategy.

Apache Cassandra combines the benefits of major NoSQL databases to support data management needs not covered by traditional RDBMS vendors.

The software you build is only as secure as the code that powers it. Learn how malicious code creeps into your software supply chain.

Generative AI has transformed nearly every industry. How can you leverage GenAI to improve your productivity and efficiency?

Related

  • Spring Boot: Test Restful Web Service Using Curl Client
  • Spring Boot - How To Use Native SQL Queries | Restful Web Services
  • Update User Details in API Test Client Using REST Assured [Video]
  • Create User API Test Client With REST Assured [Video]

Trending

  • Monolith: The Good, The Bad and The Ugly
  • Build a Simple REST API Using Python Flask and SQLite (With Tests)
  • How to Create a Successful API Ecosystem
  • Event-Driven Microservices: How Kafka and RabbitMQ Power Scalable Systems
  1. DZone
  2. Software Design and Architecture
  3. Integration
  4. Testing the Client Side of RESTful Services (Without Using Mocks)

Testing the Client Side of RESTful Services (Without Using Mocks)

By 
Alex Soto user avatar
Alex Soto
·
Sep. 29, 12 · Interview
Likes (0)
Comment
Save
Tweet
Share
15.5K Views

Join the DZone community and get the full member experience.

Join For Free

People tell me A and B, They tell me how I have to see, Things that I have seen already clear, So they push me then from side to side (I Want Out - Helloween)

Developing an application that uses
RESTful web API may imply developing server and client side. Writing integration tests for the server side can be as easy as using Arquillian to start up server and REST-assured to test that the services works as expected. The problem is how to test the client side. In this post, we are going to see how to test the client side apart from using mocks.

As a brief description, to test the client side, what we need is a local server which can return recorded JSON responses. The rest-client-driver is a library which simulates a RESTful service. You can set expectations on the HTTP requests you want to receive during a test. So it is exactly what we need for our java client side. Note that this project is really helpful to write tests when we are developing RESTful web clients for connecting to services developed by third parties like Flickr Rest API, Jira Rest API, Github ...

First thing to do is adding rest-client-driver dependency:
<dependency>
    <groupId>com.github.rest-driver</groupId>
    <artifactId>rest-client-driver</artifactId>
    <version>1.1.27</version>
    <scope>test</scope>
</dependency>

 Next step we are going to create a very simple Jersey application which simply invokes a get method to required URI.
public class GithubClient {

private static final int HTTP_STATUS_CODE_OK = 200;

private String githubBaseUri;

public GithubClient(String githubBaseUri) {
this.githubBaseUri = githubBaseUri;
}

public String invokeGetMethod(String resourceName) {

Client client = Client.create();
WebResource webResource = client.resource(githubBaseUri+resourceName);
ClientResponse response = webResource.type("application/json")
.accept("application/json").get(ClientResponse.class);
int statusCode = response.getStatus();

if(statusCode != HTTP_STATUS_CODE_OK) {
throw new IllegalStateException("Error code "+statusCode);
}

return response.getEntity(String.class);
}

}

And now we want to test that invokeGetMethod really gets the required resource. Let's suppose that this method in production code will be responsible of getting all issues name from a project registered on github.

Now we can start to write the test:
@Rule
public ClientDriverRule driver = new ClientDriverRule();

@Test
public void issues_from_project_should_be_retrieved() {

driver.addExpectation(
onRequestTo("/repos/lordofthejars/nosqlunit/issues").
withMethod(Method.GET), giveResponse(GET_RESPONSE));

GithubClient githubClient = new GithubClient(driver.getBaseUrl());

String issues = githubClient.invokeGetMethod("/repos/lordofthejars/nosqlunit/issues");
assertThat(issues, is(GET_RESPONSE));	

}

  • We use ClientDriverRule  @Rule annotation to add the client-driver to a test.
  • And then using methods provided by RestClientDriver class, expectations are recorded.
  • See how we are setting the base URL using driver.getBaseUrl()
With rest-client-driver we can also record http status response using giveEmptyResponse method:
@Test(expected=IllegalStateException.class)
public void http_errors_should_throw_an_exception() {

driver.addExpectation(
onRequestTo("/repos/lordofthejars/nosqlunit/issues")
.withMethod(Method.GET), giveEmptyResponse().withStatus(401));

GithubClient githubClient = new GithubClient(driver.getBaseUrl());
githubClient.invokeGetMethod("/repos/lordofthejars/nosqlunit/issues");

}

And obviously we can record a put action:
Note that in this example, we are setting that our request should contain given message body to response a 204 status code.

This is a very simple example, but keep in mind that also works with libraries like gson or jackson. Also rest-driver project comes with a module that can be used to assert server responses (like REST-assured project) but this topic will be addressed into another post.

I wish you have found this post useful.

We keep learning,
Alex.
 
 
 
 
 
 
Web Service REST Web Protocols Testing

Published at DZone with permission of Alex Soto, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

Related

  • Spring Boot: Test Restful Web Service Using Curl Client
  • Spring Boot - How To Use Native SQL Queries | Restful Web Services
  • Update User Details in API Test Client Using REST Assured [Video]
  • Create User API Test Client With REST Assured [Video]

Partner Resources

×

Comments
Oops! Something Went Wrong

The likes didn't load as expected. Please refresh the page and try again.

ABOUT US

  • About DZone
  • Support and feedback
  • Community research
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Core Program
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 3343 Perimeter Hill Drive
  • Suite 100
  • Nashville, TN 37211
  • support@dzone.com

Let's be friends:

Likes
There are no likes...yet! 👀
Be the first to like this post!
It looks like you're not logged in.
Sign in to see who liked this post!