Test Your Spring Boot JPA Persistence Layer With @DataJpaTest

Last Updated:  October 14, 2021 | Published: November 24, 2020

Similar to testing our web layer in isolation with @WebMvcTest, Spring Boot provides a convenient way to test our Spring Boot JPA persistence layer: @DataJpaTest. While the default configuration expects an embedded database, this article demonstrates how to test any Spring Data JPA repository in isolation with Testcontainers and Flyway. The sample application uses Spring Boot 2.4, Java 15, and a PostgreSQL database.

What Should We Test For Our Spring Boot JPA Persistence Layer?

With Spring Data JPA we can create interfaces for each of our entity classes that extend the JpaRepository interface.

Such repositories already provide a set of methods to retrieve, store and delete our JPA entities like .findAll(), .save(), .delete(Order order).

Spring Data also has the concept of derived queries where the actual SQL query is derived from the method name:

These methods are validated on startup, and if we refer to an unknown column of our entity or don't follow the naming convention, our application won't start. Testing these derived queries and the default methods of the JpaRepository doesn't add many benefits. With such tests, we would rather test the Spring Data framework, which we want to avoid and focus on our application.

Next, what about testing the entity mapping? Should we make sure that our JPA entity model maps to our database schema?

To validate that the mapping is correct, we can rely on a feature of Hibernate that validates the schema on application startup:

This ensures that for our JPA entities a corresponding database table exists, all columns are present, and they have the correct column type. There are still scenarios that this validation does not cover, e.g. constraints like unique or custom checks.

Hence I wouldn't explicitly focus on testing this but ensure that all entities are implicitly covered with an integration test that reads from the database and not only from the first-level cache. The TestEntityManager can help here.

So what to focus on when testing our JPA persistence layer? We should focus on non-trivial queries that we handcraft.

A good example might be the following native query that makes use of PostgreSQL's JSON support:

PS: Wondering how we can create this multi-line string without concatenation? That's the new Java text block feature that is GA since Java 15.

Our Order entity class uses Vlad Mihaleca's hibernate-types project to map PostgreSQL's JSNOB column type to a Java String.

How to Test the Spring Boot JPA Persistence Layer

Knowing what to test brings us to the topic of how to test it.

We could write a unit test. As the Spring Data JPA repositories are interfaces there is not much to verify and test. We need to test these repositories in action. Starting the whole Spring application context for this would be overkill. Spring Boot provides a test annotation that allows us  to start a sliced Spring Context with only relevant JPA components: @DataJpaTest.

By default, this would start an in-memory database like H2 or Derby. As long as our project doesn't use an in-memory database, starting one for our tests is counterproductive. Our Flyway migration scripts might use database-specific features that are not compatible with the in-memory database.

Maintaining a second set of DDL migration scripts for the in-memory database is a non-negligible effort.  In the pre-container times, using an in-memory database might have been the easiest solution as you would otherwise have to install or provide a test database for every developer.

With the rise of Docker, we are now able to start any containerized software on-demand with ease. This includes databases. Testcontainers makes it convenient to start any Docker container of choice for testing purposes. I'm not going to explain Testcontainers in detail here, as there are already several articles available on this blog:

  1. Write Spring Boot Integration Tests with Testcontainers (JUnit 4 & 5)
  2. Reuse Containers with Testcontainers for Fast Integration Tests
  3. Testing Spring Boot Applications with Kotlin and Testcontainers

Create the Database Schema for Our @DataJpaTest

An empty database container doesn't help us much with our test case. We need a solution to create our database tables prior to the test execution.

When working with @DataJpaTest and an embedded database we can achieve this with Hibernate's ddl-auto feature set to create-drop. This ensures to first create the database schema based on our Java entity definitions and then drops it afterward.

While this works and might feel convenient (we don't have to write any SQL), we should rather stick to our hand-crafted Flyway migration scripts. Otherwise, there might be a difference between our database schema during the test and production.

Remember: We want to be as close as possible to our production setup when testing our application.

The migration script for our examples contains a single DDL statement:

When starting our sliced Spring context for our test, Flyway will first execute our migration scripts whenever our test is working with a fresh and empty database.

Preloading Data for the Test

Having the database tables created, we now have multiple options to populate data: during the test, using the @Sql annotation, as part of JUnit's @BeforeEach lifecycle or using a custom Docker image.

Let's start with the simplest approach. Every test prepares the data that it needs for verifying a specific method. As the Spring Test Context contains all our Spring Data JPA repositories, we can inject the repository of our choice and save our entities:

Next comes the @Sql annotation. With this annotation new can execute any SQL script prior to test execution. We can place our init scripts inside src/test/resources. It's not necessary to put them on the classpath as we can also reference e.g. a file on disk or an HTTP resource (basically anything that can be resolved by Spring's ResouceUtils class):

If all your test cases (in the same test class) share the same data setup,  we can use JUnit Jupiter's @BeforeEach to initialize our tables with data.

We can also create a custom database image that already contains our database with a preset of data. This can also mirror the size of production. For bigger projects we save a lot of time with this approach as Flyway doesn't have to migrate any script. The only downside of this approach is to maintain and keep this test image up-to-date.

Writing the Test for Our Spring Boot Data JPA Repository

Putting it all together, we can now write our test to verify our Spring Boot JPA persistence layer with @DataJpaTest.

As we use Testcontainers to start a PostgreSQL database, we can override the auto-configuration to not use an embedded database:

As Testcontainers maps the PostgreSQL port to a random ephemeral port, we can't hardcode the JDBC URL. In the example above we are using @DynamicPropertySource to set all required datasource attributes in a dynamic fashion based on the started container.

We can even write a shorter test with less setup ceremony using Testcontainers JDBC support feature:

Note the tc keyword after jdbc for the data source URL. The 12 indicates the PostgreSQL version. With this modification, Testcontainers will start the dockerized PostgreSQL for our test class in the background.

If you want to further optimize this setup when running multiple tests for your persistence layer, you can reuse already started containers with Testcontainers.

Cleanup of the Database

The @DataJpaTest meta-annotation contains the @Transactional annotation. This ensures our test execution is wrapped with a transaction that gets rolled-back after the test. This happens for both successful test cases as well as failures.

Hence, there is nothing we have to clean up of our tests and every test starts with empty tables (except we initialize data with our migration scripts).

The source code for this @DataJpaTest example is available on GitHub.

Have fun testing your Spring Boot JPA persistence layer with @DataJpaTest,

Philip

{"email":"Email address invalid","url":"Website address invalid","required":"Required field missing"}

Join Our Mailing List To Get 3x Free Cheat Sheets

Free Java Cheat Sheets
>