📘 Premium Read: Access my best content on Medium member-only articles — deep dives into Java, Spring Boot, Microservices, backend architecture, interview preparation, career advice, and industry-standard best practices.
🎓 Top 15 Udemy Courses (80-90% Discount): My Udemy Courses - Ramesh Fadatare — All my Udemy courses are real-time and project oriented courses.
▶️ Subscribe to My YouTube Channel (176K+ subscribers): Java Guides on YouTube
▶️ For AI, ChatGPT, Web, Tech, and Generative AI, subscribe to another channel: Ramesh Fadatare on YouTube
In this tutorial, we will learn how to test repository or DAO layer using Spring boot provided
@DataJpaTest annotation.
We will write a JUnit 5 test case for CRUD operations - Create, Read, Update and Delete.
YouTube Video
@DataJpaTest Annotation Overview
The Spring boot provides
@DataJpaTest annotation. This annotation will disable full auto-configuration and instead apply only configuration relevant to JPA tests. By default, it will use an embedded, in-memory H2 database instead of the one declared in the configuration file, for faster test running time as compared to disk file database.
The
@DataJpaTest annotation doesn’t load other Spring beans (@Component, @Controller, @Service, and annotated beans) into
ApplicationContext.
We will create Spring Boot project from scratch using Spring data JPA ( Hibernate) and H2 database.
1. Create Spring Boot Project
Use the below details in the Spring boot creation:
Project Name: spring-data-data-testing
Project Type: Maven
Choose dependencies: Spring Data JPA, H2 database, Lombok, Spring Boot Dev Tools
Package name: net.javaguides.springboot
2. Maven Dependencies
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <scope>runtime</scope> <optional>true</optional> </dependency> <dependency> <groupId>com.h2database</groupId> <artifactId>h2</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency>
3. Create JPA Entity
Let's create an entity package inside a base package "net.javaguides.springboot". Within the entity package, create a Employee class with the following content:
package net.javaguides.springboot; import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Data; import lombok.NoArgsConstructor; import jakarta.persistence.*; @Data @AllArgsConstructor @NoArgsConstructor @Builder @Entity @Table(name = "employees") public class Employee { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private long id; @Column(name = "first_name", nullable = false) private String firstName; @Column(name = "last_name", nullable = false) private String lastName; @Column(name = "email", nullable = false) private String email; }
The annotations used are:
@Data: This annotation is from the Lombok library and is used to automatically generate getters and setters for all fields in the class, as well as implementations of toString(), equals(), and hashCode(). This reduces the amount of boilerplate code that needs to be written.
@AllArgsConstructor: This annotation is also from Lombok and generates a constructor that takes all of the fields in the class as arguments.
@NoArgsConstructor: This annotation is also from Lombok and generates a no-argument constructor.
@Builder: This annotation is also from Lombok and generates a builder pattern for the class, which provides a convenient way to create instances of the class with default or optional values for some fields.
@Entity: This annotation is from the Java Persistence API (JPA) and marks the class as an entity that can be persisted to a database.
@Table(name = "employees"): This annotation specifies the name of the table that corresponds to this entity in the database.
4. Create Spring Data JPA Repository
The next thing we’re gonna do is create a repository to access a User’s data from the database.
The JpaRepository interface defines methods for all the CRUD operations on the entity, and a default implementation of the JpaRepository called SimpleJpaRepository.
Let's create a repository package inside a base package "net.javaguides.springdatarest". Within the repository package, create a EmployeeRepository interface with the following content:
package net.javaguides.springboot; import org.springframework.data.jpa.repository.JpaRepository; import java.util.Optional; public interface EmployeeRepository extends JpaRepository<Employee, Long> { Optional<Employee> findByEmail(String email); }
5. CRUD JUnit Tests for Spring Data JPA Repository
Spring Boot provides the @DataJpaTest annotation to test the persistence layer components that will autoconfigure in-memory embedded databases and scan for @Entity classes and Spring Data JPA repositories. The @DataJpaTest annotation doesn’t load other Spring beans (@Components, @Controller, @Service, and annotated beans) into ApplicationContext.
We need to specify the execution order because JUnit doesn’t run test methods in the order they appear in the code. So we need to use the
@TestMethodOrder and
@Order annotations to execute test cases in ascending order.
Head over to test package. Let's create a repository package inside a base package "test.net.javaguides.springboot". Within the repository package, create a EmployeeRepositoryTest class with the following content:
package net.javaguides.springboot; import org.assertj.core.api.Assertions; import org.junit.jupiter.api.MethodOrderer; import org.junit.jupiter.api.Order; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.TestMethodOrder; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest; import org.springframework.boot.test.autoconfigure.orm.jpa.TestEntityManager; import org.springframework.jdbc.core.JdbcTemplate; import org.springframework.test.annotation.Rollback; import javax.sql.DataSource; import java.util.List; import java.util.Optional; @DataJpaTest @TestMethodOrder(MethodOrderer.OrderAnnotation.class) public class EmployeeRepositoryTests { @Autowired private EmployeeRepository employeeRepository; // JUnit test for saveEmployee @Test @Order(1) @Rollback(value = false) public void saveEmployeeTest(){ Employee employee = Employee.builder() .firstName("Ramesh") .lastName("Fadatare") .email("ramesh@gmail.com") .build(); employeeRepository.save(employee); Assertions.assertThat(employee.getId()).isGreaterThan(0); } @Test @Order(2) public void getEmployeeTest(){ Employee employee = employeeRepository.findById(1L).get(); Assertions.assertThat(employee.getId()).isEqualTo(1L); } @Test @Order(3) public void getListOfEmployeesTest(){ List<Employee> employees = employeeRepository.findAll(); Assertions.assertThat(employees.size()).isGreaterThan(0); } @Test @Order(4) @Rollback(value = false) public void updateEmployeeTest(){ Employee employee = employeeRepository.findById(1L).get(); employee.setEmail("ram@gmail.com"); Employee employeeUpdated = employeeRepository.save(employee); Assertions.assertThat(employeeUpdated.getEmail()).isEqualTo("ram@gmail.com"); } @Test @Order(5) @Rollback(value = false) public void deleteEmployeeTest(){ Employee employee = employeeRepository.findById(1L).get(); employeeRepository.delete(employee); //employeeRepository.deleteById(1L); Employee employee1 = null; Optional<Employee> optionalEmployee = employeeRepository.findByEmail("ram@gmail.com"); if(optionalEmployee.isPresent()){ employee1 = optionalEmployee.get(); } Assertions.assertThat(employee1).isNull(); } }
Let's understand above JUnit test cases one by one.
JUnit test for saveEmployee:
// JUnit test for saveEmployee @Test @Order(1) @Rollback(value = false) public void saveEmployeeTest(){ Employee employee = Employee.builder() .firstName("Ramesh") .lastName("Fadatare") .email("ramesh@gmail.com") .build(); employeeRepository.save(employee); Assertions.assertThat(employee.getId()).isGreaterThan(0); }
Note that we have used
@Rollback(false) to disable roll back to the data will be committed to the database and available for the next test methods which will run separately.
We have also used
assertThat() method from AssertJ library for more readability than using JUnit’s assertion methods.
JUnit test for getEmployee:
We write a test to retrieve employee by it's Id and test the same with id 1:
@Test @Order(2) public void getEmployeeTest(){ Employee employee = employeeRepository.findById(1L).get(); Assertions.assertThat(employee.getId()).isEqualTo(1L); }
We have also used assertThat() method from AssertJ library for more readability than using JUnit’s assertion methods.
JUnit test for getListOfEmployees:
We write a test method to retrieve list of employees from database and test it's size:
@Test @Order(3) public void getListOfEmployeesTest(){ List<Employee> employees = employeeRepository.findAll(); Assertions.assertThat(employees.size()).isGreaterThan(0); }
We have also used assertThat() method from AssertJ library for more readability than using JUnit’s assertion methods.
JUnit test for updateEmployee:
We write a JUnit test method to test update employee operation:
@Test @Order(4) @Rollback(value = false) public void updateEmployeeTest(){ Employee employee = employeeRepository.findById(1L).get(); employee.setEmail("ram@gmail.com"); Employee employeeUpdated = employeeRepository.save(employee); Assertions.assertThat(employeeUpdated.getEmail()).isEqualTo("ram@gmail.com"); }
Note that we have used
@Rollback(false) to disable roll back to the data will be committed to the database and available for the next test methods which will run separately.
We have also used assertThat() method from AssertJ library for more readability than using JUnit’s assertion methods.
JUnit test for deleteEmployee:
We write a JUnit test method to test delete employee operation:
@Test @Order(5) @Rollback(value = false) public void deleteEmployeeTest(){ Employee employee = employeeRepository.findById(1L).get(); employeeRepository.delete(employee); //employeeRepository.deleteById(1L); Employee employee1 = null; Optional<Employee> optionalEmployee = employeeRepository.findByEmail("ram@gmail.com"); if(optionalEmployee.isPresent()){ employee1 = optionalEmployee.get(); } Assertions.assertThat(employee1).isNull(); }
Here the output of the CRUD JUnit tests:
← Back to All Spring Data JPA Tutorials Related Spring Boot and Microservices Tutorials/Guides:
The Hidden Magic of Spring Boot: Secrets Every Developer Should Know What Happens When You Hit a Spring Boot REST API Endpoint (Behind the Scenes) Spring Boot Exception Handling Build CRUD REST API with Spring Boot, Spring Data JPA, Hibernate, and MySQL Spring Boot DELETE REST API: @DeleteMapping Annotation Spring Boot PUT REST API — @PutMapping Annotation Spring Boot POST REST API Spring Boot GET REST API — @GetMapping Annotation Spring Boot REST API with Request Param | Spring Boot Course Spring Boot REST API with Path Variable — @PathVariable Chapter 13: Understanding @SpringBootApplication Annotation | Spring Boot Course Chapter 5: Create Spring Boot Project and Build Hello World REST API | Spring Boot Course 10 Real-World Spring Boot Architecture Tips Every Developer Should Follow Top 10 Spring Boot Tricks Every Java Developer Should Know Debugging Spring Dependency Injection Issues - Very Important Common Code Smells in Spring Applications — How to Fix Them Spring Boot + OpenAI ChatGPT API Integration Tutorial Spring Boot Course -> New Series on Medium ❤️ Spring Boot Microservices with RabbitMQ Example React JS + Spring Boot Microservices Dockerizing a Spring Boot Application How to Change the Default Port in Spring Boot How to Change Context Path in Spring Boot Top 10 Spring Boot REST API Mistakes and How to Avoid Them (2025 Update) Spring Boot REST API Best Practices Spring Boot Security Database Authentication Example Tutorial Spring Boot Security Form-Based Authentication Spring Boot Security In-Memory Authentication What is Spring Boot Really All About? Why Spring Boot over Spring? Top 10 Spring Boot Key Features That You Should Know Spring vs Spring Boot Setting Up the Development Environment for Spring Boot Spring Boot Auto-Configuration: A Quick Guide Spring Boot Starters Quick Guide to Spring Boot Parent Starter Spring Boot Embedded Servers Spring Boot Thymeleaf Hello World Example Chapter 10: Spring Boot DevTools | Spring Boot Course Chapter 13: Spring Boot REST API That Returns JSON | Spring Boot Course Spring Boot REST API That Returns List of Java Objects in JSON Format Top 10 Spring Boot Mistakes and How to Avoid Them Advanced Spring Boot Concepts that Every Java Developer Should Know What Are Microservices in Spring Boot? Integrating React Frontend with Spring Boot ChatGPT API (Step-by-Step Guide) Build a Chatbot Using Spring Boot, React JS, and ChatGPT API Top 10 Mistakes in Spring Boot Microservices and How to Avoid Them (With Examples) Spring Boot Security Best Practices: Protecting Your Application from Attacks 🔄 Dependency Injection in Spring (Explained with Coding Examples) ⚙️ How Spring Container Works Behind the Scenes How Spring Container Works Behind the Scenes (Spring Container Secrets Revealed!) Spring @Component vs @Bean vs @Service vs @Repository Explained How Component Scanning Works Behind the Scenes in Spring How Spring Autowiring Works Internally Top 20 Spring Boot Best Practices for Java Developers Build Spring Boot React Full Stack Project — Todo App [2025 Update] Spring vs Spring MVC vs Spring Boot Spring Boot Best Practices: Use DTOs Instead of Entities in API Responses Spring Boot DTO Tutorial (Using Java record) – Complete CRUD REST API Implementation Spring Boot Architecture: Controller, Service, Repository, Database and Architecture Flow Java Stream filter() Method with Real-World Examples Spring Boot Auto Configuration Explained | How It Works Spring Boot Profiles: How to Manage Environment-Based Configurations Create a Custom Spring Boot Starter | Step-by-Step Guide Spring Boot Starter Modules Explained | Auto-Configuration Guide Deploy Spring Boot Applications with Profile-Based Settings | Step-by-Step Guide Spring Boot Performance Tuning: 10 Best Practices for High Performance Spring Boot @ComponentScan Annotation | Customizing Component Scanning Difference Between @RestController and @RequestMapping in Spring Boot Spring Boot @Cacheable Annotation – Improve Performance with Caching Spring Boot Redis Cache — @Cacheable Complete Guide When to Use @Service, @Repository, @Controller, and @Component Annotations in Spring Boot Why, When, and How to Use @Bean Annotation in Spring Boot App Java Spring Boot vs. Go (Golang) for Backend Development in 2025 Is Autowired Annotation Deprecated in Spring Boot? Everything You Need to Know 🚫 Stop Making These Common Mistakes in Spring Boot Projects Top 10 Mind-Blowing Spring Boot Tricks for Beginners Why Choose Spring Boot Over Spring Framework? | Key Differences and Benefits How to Run a Spring Boot Application | 5 Easy Ways for Developers What is AutoConfiguration in Spring Boot? | Explained with Example Customize Default Configuration in Spring Boot | 5 Proven Ways Chapter 12: Understanding SpringApplication.run() Method Internals | Spring Boot Course What is CommandLineRunner in Spring Boot? How to Create Custom Bean Validation in Spring Boot Can You Build a Non-Web Application with Spring Boot? How to Disable Auto-Configuration in Spring Boot (Step-by-Step Guide) Top 25 Spring Boot Interview Questions and Answers for Beginners How to Use Java Records with Spring Boot Spring Boot Constructor Injection Explained with Step-by-Step Example 🚫 Stop Using @Transactional Everywhere: Understand When You Actually Need It 🚫 Stop Writing Fat Controllers: Follow the Controller-Service-Repository Pattern 🚫 Stop Using Field Injection in Spring Boot: Use Constructor Injection 🚫 Stop Sharing Databases Between Microservices: Use Database Per Service Pattern 10 Java Microservices Best Practices Every Developer Should Follow How to Choose the Right Java Microservices Communication Style (Sync vs Async) How to Implement Event-Driven Communication in Java Microservices (Step-by-Step Guide with Kafka) Stop Building Tight-Coupled Microservices: Aim for Loose Coupling Spring Boot Microservices E-Commerce Project: Step-by-Step Guide Spring Boot Microservices with RabbitMQ Example React JS + Spring Boot Microservices The Ultimate Microservices Roadmap for Beginners: Building Modern Scalable Systems What Are Microservices in Spring Boot? Top 5 Message Brokers Every Developer Should Know Top 10 Spring Cloud Microservices Best Practices [Removed Deprecated Features] Best Tools for Microservices Development in 2025 How to Break a Monolithic Application into Microservices (E-Commerce Use Case) Monoliths Aren’t Dead — Microservices Are Just Overused When to Break a Monolith: A Developer’s Checklist 👑 Java Is Still the King of Microservices — And Here’s the Proof 5 Microservices Design Patterns You Must Know in 2025 Bulkhead Pattern in Microservices — Improve Resilience and Fault Isolation Strangler Fig Pattern in Microservices — Migrate Monolith to Microservices Event Sourcing Pattern in Microservices (With Real-World Example) Circuit Breaker Pattern in Microservices using Spring Boot 3, WebClient and Resilience4j CQRS Pattern in Microservices Aggregator Design Pattern in Microservices — A Complete Guide Database Per Service Pattern in Microservices API Gateway Pattern in Microservices — A Complete Guide Saga Pattern in Microservices: A Step-by-Step Guide Microservices Are a Mess Without These Java Design Patterns️ Java Microservices Interview Questions and Answers for Freshers Top Microservices Interview Questions and Answers for Experienced Professionals Top 10 Microservices Design Pattern Interview Questions and Answers Top Microservices Tricky Interview Questions You Should Know (With Answers) Microservices Best Practices: Building Scalable and Resilient Systems Why Microservices Are the Future of Software Architecture Microservices with Spring Cloud: Simplify Your Architecture Spring Boot and Microservices Roadmap for Beginners [2025 Update] Best Programming Language for Microservices Project Development in 2025 My 50+ Must-Read Microservices Tutorials, Articles and Guides on the Medium Platform
sir, please write test cases for controller layer for crud operations. please.
ReplyDelete