SpringbootHow-ToBeginner · 4 min read

How to Test Repository in Spring Boot: Simple Guide

To test a repository in Spring Boot, use the @DataJpaTest annotation which configures an in-memory database and repository beans for testing. Write JUnit 5 test methods to save, find, and verify data using the repository interface.

📐

Syntax

Use @DataJpaTest on your test class to enable repository testing with an in-memory database. Inject your repository with @Autowired. Write test methods annotated with @Test to perform CRUD operations and assertions.

@DataJpaTest: Sets up JPA components and an in-memory database for testing.
@Autowired: Injects the repository bean to test.
@Test: Marks a method as a test case.

java

import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import org.springframework.beans.factory.annotation.Autowired;
import org.junit.jupiter.api.Test;

@DataJpaTest
public class YourRepositoryTest {

    @Autowired
    private YourRepository repository;

    @Test
    public void testRepositoryMethod() {
        // Your test code here
    }
}

💻

Example

This example shows how to test a simple UserRepository that saves and finds users by email.

java

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;

import java.util.Optional;

@DataJpaTest
public class UserRepositoryTest {

    @Autowired
    private UserRepository userRepository;

    @Test
    public void testSaveAndFindByEmail() {
        User user = new User();
        user.setName("Alice");
        user.setEmail("alice@example.com");

        userRepository.save(user);

        Optional<User> found = userRepository.findByEmail("alice@example.com");

        assertThat(found).isPresent();
        assertThat(found.get().getName()).isEqualTo("Alice");
    }
}

// User entity
import jakarta.persistence.Entity;
import jakarta.persistence.Id;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private String email;

    // getters and setters
    public Long getId() { return id; }
    public void setId(Long id) { this.id = id; }
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    public String getEmail() { return email; }
    public void setEmail(String email) { this.email = email; }
}

// UserRepository interface
import org.springframework.data.jpa.repository.JpaRepository;
import java.util.Optional;

public interface UserRepository extends JpaRepository<User, Long> {
    Optional<User> findByEmail(String email);
}

Output

Test passed successfully with no errors.

⚠️

Common Pitfalls

Common mistakes when testing Spring Boot repositories include:

Not using @DataJpaTest, which means the test won't configure the in-memory database automatically.
Forgetting to add @Entity on your model class, causing errors when saving.
Not using Optional properly when querying, leading to NullPointerException.
Running tests with the full application context (@SpringBootTest) unnecessarily, which slows tests.

java

/* Wrong: Missing @DataJpaTest, no in-memory DB setup */

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;

public class WrongRepositoryTest {

    @Autowired
    private UserRepository userRepository;

    @Test
    public void testSave() {
        User user = new User();
        user.setName("Bob");
        user.setEmail("bob@example.com");

        userRepository.save(user); // This will fail because no DB is configured
    }
}

/* Right: Use @DataJpaTest for proper setup */

import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import org.springframework.beans.factory.annotation.Autowired;
import org.junit.jupiter.api.Test;

@DataJpaTest
public class RightRepositoryTest {

    @Autowired
    private UserRepository userRepository;

    @Test
    public void testSave() {
        User user = new User();
        user.setName("Bob");
        user.setEmail("bob@example.com");

        userRepository.save(user); // Works fine with in-memory DB
    }
}

📊

Quick Reference

@DataJpaTest: Use to test JPA repositories with an in-memory database.
@Autowired: Inject your repository bean.
JUnit 5: Use @Test for test methods.
Assertions: Use AssertJ or JUnit assertions to verify results.
Entity setup: Ensure your entity classes have @Entity and proper annotations.

✅

Key Takeaways

Use @DataJpaTest to configure an in-memory database and repository beans for testing.

Inject your repository with @Autowired to access its methods in tests.

Write JUnit 5 test methods annotated with @Test to perform repository operations and assertions.

Avoid loading the full application context for repository tests to keep them fast and focused.

Ensure your entity classes are properly annotated with @Entity and have getters/setters.