Jmeter : Rest API load testing using Apache Jmeter

Hello everyone, welcome to our session. Today we will learn how to load test a JSON Rest API using JMeter.

As a QA engineer, you probably incorporate many types of tests into your code checking: unit tests, integration tests, UI tests, functional tests, security tests, and more. Infrequently, load tests might be overlooked in a sprint or release process. After all, if the system is working under functional testing, it’s good to go, right? Wrong.


Why load testing is important?

This testing customarily identifies - 
  • The maximum operating capacity of an application 
  • Determine whether the current infrastructure is adequate to run the application 
  • Sustainability of application with veneration to peak utilizer load 
  • Number of concurrent users that an application can fortify and scalability to sanction more users to access it.
Some astronomically popular sites have suffered solemn downtimes when they get massive traffic volumes. E-commerce websites invest heavily in advertising campaigns, but not in Load Testing to ascertain optimal system performance when that marketing brings in traffic.

How to load test a JSON Rest API using Jmeter?

First, download and install Jmeter

Click on the ‘Apache-JMeter-5.0.zip’ link to download the binary zip file of JMeter.


By default, the file will be downloaded in the Downloads folder. Open the folder, right-click on the zip file and click on Extract Here from the pop-up menu.

Run Jmeter

How to install Apache JMeter in Ubuntu?
Go to the location from where you can run JMeter.  Downloads/apache-jmeter-5.0/bin/ 
Run the following command to run JMeter and open the JMeter dialog box.
$ ./jmeter

How to install Apache JMeter in Windows?
to run JMeter: 
Browse to bin/ folder by double-clicking on it, 
double-click on jmeter.bat to run it,
It should open both a command-line terminal and JMeter’s UI.

The following dialog box will appear after the successful installation of JMeter.


How to load test a JSON Rest API using Jmeter?

We developed a REST API using Spring Boot for our demo purpose. We are going to load test a POST request "localhost:8080/user"

Step 1. Add a Thread Group 

Right Click ->  Add- > Thread Group
Here we defined “Number of Threads = 500”, Ramp-up period, and “Loop Count = 1”. I named the Thread Group “Simple load test demo”.


Step 2. Add an HTTP Request.

 Right Click on REST Example -> Add -> Sampler -> HTTP Request.



Fill in the obligatory values: 
  • Name - the denomination of the current sampler 
  • Protocol - by default this is HTTP, but it can withal be HTTPS or FILE 
  • Server - the IP address or domain name of the server. This field is required 
  • Port - the web server the port listens to. By default: 80 
  • Method - GET, POST, PUT, DELETE, etc. This field is required 
  • Path - The path to the resource. If this requires string parameters in the query, integrate them below in the “Send Parameters With the Request” section 
  • Content encoding - if you are utilizing POST, PUT, PATCH, or FILE, there is a character encoding to be used
In our case, the request is POST.

Step 3. Set a Content-Type header 

Right click on Test Plan -> Add -> Config element -> HTTP Header Manager
Add a “Content-Type” field equal to “application/json”, as shown in the picture below:



Step 4. Add a Listener to see the Request response.

Right Click on REST Example -> Add -> Listener -> View Results Tree 
It will look like this:



And 

Right Click on REST Example -> Add -> Listener -> Aggregate Report
It will look like this:


Now, you can click on the start button to start the test based on the assigned configurations.

View Results Tree


Aggregate Report



See here we tested 500 samples, Error percentage is 51.80%. Means 255 request fails.

Below is our Spring Boot code to build REST  API. While call a POST request to the endpoint '/user' back-end side will generate a random string and preserve that String to H2 in-memory Database. Functionality wise it is working. But there is a chance to regenerate the same random string. Utilizing the  Load test I identified the back-end application load test failed because the same random string engendered.

Spring Boot Rest Controller

This HomeController.java class will export REST API "/user".

package com.knf.dev.controller;
import java.util.ArrayList;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
import com.knf.dev.Entity.User;
import com.knf.dev.reposiory.UserRepository;

@RestController
public class HomeController {
@Autowired
UserRepository repository;

@PostMapping(value = "/user", produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<User> listAllUsers() {
String id = null;
User user = new User();
try {
// Generate random String of given size in Java
String alphaNumericString = "0123456789";
// create StringBuffer size of AlphaNumericString
StringBuilder sb = new StringBuilder(6);
for (int i = 0; i < 3; i++) {

// generate a random number between
// 0 to AlphaNumericString variable length
int index = (int) (alphaNumericString.length() *
Math.random());

// add Character one by one in end of sb
sb.append(alphaNumericString.charAt(index));
}
id = sb.toString();
List<User> userLIst = new ArrayList<>();
userLIst = (List<User>) repository.findAll();
for (User u : userLIst) {

if (u.getId().equalsIgnoreCase(id))

{
User userObj = new User();
userObj.setError("server error");
return new ResponseEntity<User>(userObj,
HttpStatus.INTERNAL_SERVER_ERROR);
}
}
user.setId(id);
repository.save(user);

} catch (Exception e) {
User userObj = new User();
userObj.setError("server error");
return new ResponseEntity<User>(userObj,
HttpStatus.INTERNAL_SERVER_ERROR);
}
return new ResponseEntity<User>(user, HttpStatus.OK);
}
}

Here we are using H2-In-memory Database to save the data.

User.java

package com.knf.dev.entity;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;

@Entity
public class User {
@Id
@Column(unique = true)
private String id;
private String error;
public String getId() {
return id;
}
public String getError() {
return error;
}
public void setError(String error) {
this.error = error;
}
public void setId(String id) {
this.id = id;
}
}

UserRepository.java

package com.knf.dev.reposiory;
import org.springframework.data.repository.CrudRepository;
import org.springframework.stereotype.Repository;
import com.knf.dev.entity.User;

@Repository
public interface UserRepository extends CrudRepository<User, String> {

}

MainApplication.java

package com.knf.dev;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MainApplication {

public static void main(String[] args) {
SpringApplication.run(MainApplication.class, args);
}

}

Maven[pom.xml]

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.1.RELEASE</version>
<relativePath /> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>springboot_restAPIS</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>springboot_restAPIS</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>

Run 
$ mvn spring-boot:run

We have only one REST Service endpoint, ie localhost:8080/user[POST]. 

Here we used the Spring Boot Framework to build REST API. You have n number of Frameworks to build REST Service.


Popular posts from this blog

Learn Java 8 streams with an example - print odd/even numbers from Array and List

Example 1: Java 8 program to print odd numbers from a List   import java.util.Arrays; import java.util.List; import java.util.stream.Collectors; /*Java 8 Program to find Odd Numbers from a List*/ public class DriverClass { public static void main( String [] args) { List < Integer > numbers = Arrays. asList( 1 , 4 , 8 , 40 , 11 , 22 , 33 , 99 ); List < Integer > oddNumbers = numbers.stream(). filter(o -> o % 2 != 0 ). collect(Collectors.toList()); System.out.println(oddNumbers); } } 1. Initialize List using Arrays.asList() method. Java's built-in Arrays.asList() method converts an array into a list. This method takes an array as an argument and returns a List object. 2.  Java List interface provides stream() method which returns a sequential Stream with list of Integer as its source. 3. The Java stream filter(...
Read more

Java Stream API - How to convert List of objects to another List of objects using Java streams?

Image
In this section, we will show you how to convert a List of objects to another List of objects in Java using the Java streams map(). The ‘map’ method maps each element to its corresponding result. Java Stream API   The Java Stream API provides a functional programming approach over the object oriented capabilities of Java. It is used for processing collections of objects. The Stream in Java can be defined as a sequence of elements from a source List, Set or Array. Most of the stream operations return a Stream. This avails engender a chain of stream operations(stream pipe-lining). The streams withal support the aggregate or terminal operations on the elements. for example, finding the sum or maximum element or finding the average etc...Stream operations can either be executed sequentially or parallel. when performed parallelly, it is called a parallel stream.   Stream map() Method   The Java 8 Stream map() is an intermediate operation. It converts Stream<obj1> to Str...
Read more

Registration and Login with Spring Boot + Spring Security + Thymeleaf

Image
In this section, we will learn how to create user registration and login using Spring boot, Spring security, Thymeleaf, JPA, and H2DB. The GitHub repository link is provided at the end of this tutorial. You can download the source code. Technologies used: Spring Boot 2.5.5  Spring Data JPA  Spring Security  Thymeleaf  Maven 3+  Java 17  H2 Database   User Interface User Registration Authentication Failed Authentication success Sign out Final Project Structure: Complete pom.xml: <? xml version ="1.0" encoding ="UTF-8" ?> < project xmlns ="http://maven.apache.org/POM/4.0.0" xmlns: xsi ="http://www.w3.org/2001/XMLSchema-instance" xsi :schemaLocation ="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" > < modelVersion >4.0.0</ modelVersion > < parent > < groupId >org.springframework.boot</ groupId > < artifactId >spring-boot-starter-pare...
Read more

Java, Spring Boot Mini Project - Library Management System - Download

Image
Hello everyone, Hope you are doing well. Here, we provide a Library Management System mini-project for beginners, it's free for download. Maybe you can build more on top of this project and create your own product, that's all about you. The source code download link is provided at the end of this post. 1. Benefit of this project You could cover the following technologies and features by learning and debugging this mini project. Java 17 Java Stream Java Lamda Expressions Java Records Functional programming Object-oriented programming var Keyword in Java Generics in Java Java Switch Spring boot 2.6.4 Spring Security Thymeleaf template engine OpenCSV Spring Data JPA Server Side Pagination H2 Database  Bootstrap HTML CSS and more... 2. Objective Of Spring Boot On Library Management System The main objective of this project is to manage the details of the books, author, category, and publisher. Only Admin/Librarian will manage all these activities. Also, they can export the data in ...
Read more

ReactJS, Spring Boot JWT Authentication Example

Image
In this tutorial, we’ll create a user registration & login example using ReactJS, Spring Boot, Spring Security, and JWT authentication. You could download the source code from our Github repository, the download link is provided at the end of this tutorial. Technologies used Backend Technologies: Java 17 Spring Boot 2.7.0 Spring Security Spring Data JPA JWT H2 Database Frontend Technologies: React 17.0.1 Axios 0.27.2 Redux 4.0.5 Bootstrap 4.5.2 ReactJS - SpringBoot - JWT - Flow Backend Project Directory: Frontend Project Directory: Following is the screenshot of our application - User Registration: User Signin: Profile View: Access Resource: We will build two projects:  1. Backend:   spring-boot-security-jwt 2. Frontend: react-redux-jwt Project 1: spring-boot-security-jwt Pom.xml <?xml version = "1.0" encoding = "UTF-8" ?> <project xmlns = "http://maven.apache.org/POM/4.0.0" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"...
Read more

Top 5 Java ORM tools - 2024

Image
  The term ORM refers to object-relational mapping, which uses objects to adapt programming languages to database systems while allowing them to function with SQL and object-oriented programming ideas. Any kind of database management system that can accomplish object mapping to the table in the virtual system is suitable for the implementation of ORM. Java has a wide variety of ORM tools, some of which are mentioned below: 1. Hibernate Hibernate is a lightweight, open-source, non-invasive Java ORM (Object-Relational Mapping) framework that allows developers to create objects that function independently of database software and create persistence logic in any Java or JavaEE application. It offers an abstraction layer, so developers don't have to bother about implementations; Hibernate handles these tasks internally, such as connecting to databases and creating queries to carry out CRUD operations, among other things. Persistence logic development is done with it. Persistence logic r...
Read more

Java - Blowfish Encryption and decryption Example

Image
Blowfish is an encryption method developed by Bruce Schneier in 1993 as an alternative to the DES encryption method. It is significantly faster than DES and provides good encryption speed, although no effective cryptanalysis technique has been found to date. It is one of the first secure block ciphers that is not protected by any patents and is therefore freely available for anyone to use. This is a symmetric block cipher algorithm. Block size: 64 bits Key size: variable size from 32 to 448 bits number of subsections: 18 [P-array] number of rounds: 16 number of substitution blocks: 4 [each with 512 records of 32 bits each] develop  Example 1: Encryption and decryption using Blowfish import java.io.UnsupportedEncodingException; import java.nio.charset.Charset; import java.security.InvalidKeyException; import java.security.NoSuchAlgorithmException; import java.util.Base64; import javax.crypto.BadPaddingException; import javax.crypto.Cipher; import javax.crypto.IllegalBlockSiz...
Read more

Spring boot video streaming example-HTML5

Image
Hello everyone, Today we will learn how to stream MP4 video using Spring Boot and Spring Web Flux.  The Source code download link is provided at the end of this post. New, Quarkus Practice User Interface   Project Structure: G radle(build.gradle) plugins { id 'org.springframework.boot' version '2.5.4' id 'io.spring.dependency-management' version '1.0.11.RELEASE' id 'java' } group = 'com.knf.demo' version = '0.0.1-SNAPSHOT' sourceCompatibility = '11' repositories { mavenCentral() } dependencies { implementation 'org.springframework.boot:spring-boot-starter-webflux' testImplementation 'org.springframework.boot:spring-boot-starter-test' testImplementation 'io.projectreactor:reactor-test' } test { useJUnitPlatform() } Service (VideoStreamingService.java) package  com.knf.demo.service ; import org.springframework.beans.factory.annotation. Autowired ; import org.springframework...
Read more

Google Cloud Storage + Spring Boot - File Upload, Download, and Delete

Image
In this section, we will learn  how to  create a simple spring boot application to perform different file operations such as upload, download, list, and delete files from the Google Cloud Storage. 1.  A little bit of Background Google Cloud Storage Cloud Storage is a managed service for storing unstructured data. Store any amount of data and retrieve it as often as you like. More Info - click here! Spring Boot Spring Boot makes it easy to create stand-alone, production-grade Spring-based Applications that you can "just run".  More Info - click here! 2. Create a GCP Project First, Sign into the Google console at  https://console.cloud.google.com . You can create a new project by first selecting the project dropdown in the top left and selecting " New Project ". Next, specify your GCP  Project name  and  Project ID . Then  Click on the " CREATE " button. Copy " Project ID " and keep it for future purposes. 3. Create a Google Cloud Storage bucke...
Read more