@DataJpaTest for repository testing in Spring Boot - Mini Project: Build & Apply

@DataJpaTest for Repository Testing in Spring Boot

📖 Scenario: You are building a simple Spring Boot application that manages books in a library. You want to test the data access layer to ensure it correctly saves and retrieves book records from the database.

🎯 Goal: Create a Spring Boot test class using @DataJpaTest to test the BookRepository. You will set up the entity, repository, and write a test to save and find a book.

📋 What You'll Learn

Create a Book entity with id, title, and author fields

Create a BookRepository interface extending JpaRepository

Create a test class annotated with @DataJpaTest

Write a test method to save a Book and verify it can be found by title

💡 Why This Matters

🌍 Real World

Testing the data access layer in Spring Boot applications ensures that database operations work correctly before deploying to production.

💼 Career

Repository testing with @DataJpaTest is a common task for backend developers working with Spring Boot and JPA, improving code quality and reliability.

1

Create the Book entity

Create a Book entity class in Java with fields Long id, String title, and String author. Use @Entity and @Id annotations. Use @GeneratedValue(strategy = GenerationType.IDENTITY) for the id field.

Spring Boot

// Create the Book entity class with id, title, and author fields
// Use @Entity, @Id, and @GeneratedValue annotations

Hint

Remember to import jakarta.persistence.Entity, Id, and GeneratedValue. Use the GenerationType.IDENTITY strategy for the primary key.

2

Create the BookRepository interface

Create an interface called BookRepository that extends JpaRepository<Book, Long>. This will allow basic CRUD operations on Book entities.

Spring Boot

import org.springframework.data.jpa.repository.JpaRepository;

// Create BookRepository interface extending JpaRepository

Hint

Import org.springframework.data.jpa.repository.JpaRepository and extend it with Book and Long as type parameters.

3

Create the test class with @DataJpaTest

Create a test class called BookRepositoryTest annotated with @DataJpaTest. Inject the BookRepository using @Autowired. Write a test method called testSaveAndFindByTitle that saves a Book with title "Spring Boot Guide" and author "John Doe", then finds it by title using findAll() and asserts the book is found.

Spring Boot

import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import org.springframework.beans.factory.annotation.Autowired;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;

@DataJpaTest
public class BookRepositoryTest {

    @Autowired
    private BookRepository bookRepository;

    // Write testSaveAndFindByTitle method here
}

Hint

Use @DataJpaTest on the test class and @Autowired to inject BookRepository. Use AssertJ's assertThat to check the saved book's title.

4

Complete the test with proper imports and annotations

Add the necessary imports for @Test, @DataJpaTest, @Autowired, and AssertJ assertions. Ensure the test class and methods are public and properly annotated to run with Spring Boot's test support.

Spring Boot

// Add any missing imports or annotations to complete the test class
// Ensure the test class and methods are public

Hint

Check that all necessary imports are present and the test class and method are declared public. This ensures Spring Boot can run the test properly.

Practice

1. What is the main purpose of using @DataJpaTest in Spring Boot?

easy

A. To test JPA repositories with an in-memory database setup

B. To test the entire Spring Boot application including web layer

C. To configure security settings for the application

D. To run integration tests with external APIs

Solution

1. Step 1: Understand the role of @DataJpaTest

   @DataJpaTest is designed to test only the JPA repository layer, not the full application.

2. Step 2: Recognize the default setup

   It sets up an in-memory database automatically to test repository methods quickly and in isolation.

3. Final Answer:

   To test JPA repositories with an in-memory database setup -> Option A

4. Quick Check:

   @DataJpaTest = repository testing with in-memory DB [OK]

Hint: Remember @DataJpaTest focuses only on JPA repositories [OK]

Common Mistakes:

• Thinking it tests the full application context
• Confusing it with @SpringBootTest
• Assuming it configures web or security layers

2. Which of the following is the correct way to annotate a test class to use @DataJpaTest?

easy

A. @RepositoryTest
public class MyRepositoryTest {}

B. @SpringBootTest
public class MyRepositoryTest {}

C. @DataJpaTest
public class MyRepositoryTest {}

D. @EnableJpaRepositories
public class MyRepositoryTest {}

Solution

1. Step 1: Identify the correct annotation for JPA repository testing

   @DataJpaTest is the dedicated annotation for testing JPA repositories.

2. Step 2: Check the syntax usage

   The annotation is placed directly above the test class declaration as shown in @DataJpaTest public class MyRepositoryTest {}.

3. Final Answer:

   @DataJpaTest public class MyRepositoryTest {} -> Option C

4. Quick Check:

   Correct annotation usage = @DataJpaTest public class MyRepositoryTest {} [OK]

Hint: Use @DataJpaTest directly on the test class [OK]

Common Mistakes:

• Using @SpringBootTest instead of @DataJpaTest
• Using non-existent @RepositoryTest annotation
• Confusing configuration annotations with test annotations

3. Given the following repository test code using @DataJpaTest, what will be the output of System.out.println(users.size())?

@DataJpaTest
public class UserRepositoryTest {
  @Autowired
  private UserRepository userRepository;

  @Test
  void testSaveAndFind() {
    User user = new User(null, "Alice");
    userRepository.save(user);
    List<User> users = userRepository.findAll();
    System.out.println(users.size());
  }
}

medium

A. 1

B. 0

C. NullPointerException

D. Compilation error

Solution

1. Step 1: Analyze the test method behavior

   The test saves one User entity to the repository, then fetches all users.

2. Step 2: Understand @DataJpaTest behavior

   @DataJpaTest uses an in-memory database, so the saved user is stored and retrievable within the test.

3. Final Answer:

   1 -> Option A

4. Quick Check:

   Saved one user, findAll returns list size 1 [OK]

Hint: Saved entities appear in findAll during @DataJpaTest [OK]

Common Mistakes:

• Assuming the database is empty after save
• Expecting NullPointerException due to missing ID
• Confusing @DataJpaTest with no database setup

4. You wrote a test with @DataJpaTest but it fails with a BeanCreationException related to missing DataSource. What is the most likely cause?

medium

A. You did not annotate the test class with @SpringBootTest

B. You forgot to include an in-memory database dependency like H2

C. You used @DataJpaTest on a non-repository class

D. You did not add @Autowired to the repository field

Solution

1. Step 1: Understand the error cause

   BeanCreationException for DataSource usually means Spring cannot find a database connection.

2. Step 2: Check dependencies for @DataJpaTest

   @DataJpaTest uses an in-memory database by default, but you must include a dependency like H2 in your project.

3. Final Answer:

   You forgot to include an in-memory database dependency like H2 -> Option B

4. Quick Check:

   Missing DB dependency causes DataSource error [OK]

Hint: Add H2 dependency for @DataJpaTest to create DataSource [OK]

Common Mistakes:

• Confusing @DataJpaTest with @SpringBootTest requirement
• Ignoring missing database dependencies
• Assuming @Autowired omission causes DataSource error

5. You want to test a repository method that uses a custom query with @Query annotation. How can you ensure @DataJpaTest loads this method correctly and your test verifies it?

hard

A. Add @EnableJpaRepositories to the test class to enable custom queries

B. Use @SpringBootTest instead because @DataJpaTest does not support custom queries

C. Manually configure the EntityManager in the test to run the query

D. Write a test method in a @DataJpaTest class that calls the custom query method and asserts the result

Solution

1. Step 1: Understand @DataJpaTest capabilities

   @DataJpaTest loads repository beans including custom query methods annotated with @Query.

2. Step 2: Write a test method to call and assert the custom query

   Simply call the repository method in your test and check the returned data matches expectations.

3. Final Answer:

   Write a test method in a @DataJpaTest class that calls the custom query method and asserts the result -> Option D

4. Quick Check:

   @DataJpaTest supports custom queries; test them directly [OK]

Hint: Test custom queries directly in @DataJpaTest methods [OK]

Common Mistakes:

• Thinking @DataJpaTest cannot run custom queries
• Overcomplicating with manual EntityManager setup
• Adding unnecessary annotations like @EnableJpaRepositories