DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
  1. DZone
  2. Testing, Deployment, and Maintenance
  3. Testing, Tools, and Frameworks
  4. Testing the Hibernate Layer With Docker

Testing the Hibernate Layer With Docker

We are all writing unit tests for the service layer but the persistence layer, in contrast, is rarely tested as it is more complicated to test SQL or JPQL... or any other QL’es. Luckily, Docker offers TestContainers.

Kai Winter user avatar by
Kai Winter
·
Jun. 09, 16 · Analysis
Like (4)
Save
Tweet
Share
4.30K Views

Join the DZone community and get the full member experience.

Join For Free

Have you ever felt the need to write unit tests for your persistence layer? We know logic doesn’t belong there, it should just do some CRUD operations and nothing more. But in reality, some kind of logic can be found in most persistence layers. Some use heavy native SQL, some others make use of the Criteria API which is test-worthy because of its complex syntax.

We are all writing unit tests for the service layer but the persistence layer, in contrast, is rarely tested as it is more complicated to test SQL or JPQL... or any other QL’es.

An Example

One example of logic which better be tested is the following. This is a trivial example which may be far more complex in reality. I’ll use this to demonstrate how to test persistence related code.

/**
 * Resets the login count for other users than root and admin.
 */
public void resetLoginCountForUsers() {
   Query query = entityManager.createQuery(
                   "UPDATE User SET loginCount=0 WHERE username NOT IN ('root', 'admin')");
   query.executeUpdate();
}

Previously in Our Toolbox

In the past there were several approaches to test the persistence layer:

  • In memory database like HSQL
    • Pro: clean database on every run
    • Con: different database than in production (Oracle, MySQL, …)
    • Con: doesn’t work when you need stored procedures
  • Local database on the dev machine
    • Pro: same database as production
    • Con: have to take care of deleting previous data
    • Con: possible side effects when database is used for development also
    • Con: have to synchronize settings on dev machines and CI system
  • Dummy database driver which returns pseudo data from CSV files
    • Pro: Lightweight
    • Con: hard to setup for a large domain model, model might be invalid

New Kid on the Block: TestContainers

TestContainers is a Java 8 library that supports JUnit tests, providing lightweight, throwaway instances of common databases, Selenium web browsers, or anything else that can run in a Docker container. [GitHub]

This library starts a Docker container which contains any database you like. Your tests get a connection on that database and you can start inserting your test data per each single unit test.

  • Pro: absolutely reproducible test
  • Pro: same database as in production
  • Pro: configuration is shared above all machines via the docker image
  • Con: a bit slower because of database start (depending on used database)
  • Con: you need a Docker host against which the tests can run. This may either be centralized so all developers are using the same (which is no problem even when starting containers concurrently), or you have a Docker installation on your local machine.

This is how the test looks like. The data model is already inserted (by persistence.xml, see below), the test inserts its test data by DbUnit (line 3), calls the persistence layer method (line 8), and makes the asserts (lines 15-17). The transactions have to be managed by hand (line 7, 9) as we have no container which is doing this for us. To make this more convenient, the transaction management can be wrapped in a method and a lambda function, like: runWithTransaction(() -> userRepository.resetLoginCountForUsers());

@Test
public void testResetLoginCountForUsers() {
   DockerDatabaseTestUtil.insertDbUnitTestdata(
     entityManager, 
     getClass().getResourceAsStream("/testdata.xml));

   entityManager.getTransaction().begin();
   userRepository.resetLoginCountForUsers();
   entityManager.getTransaction().commit();

   User rootUser = userRepository.findByUsername("root");
   User adminUser = userRepository.findByUsername("admin");
   User user = userRepository.findByUsername("user");

   assertEquals(5, rootUser.getLoginCount());
   assertEquals(3, adminUser.getLoginCount());
   assertEquals(0, user.getLoginCount()); // PREVIOUSLY WAS 1
}

Using TestContainers

First the persistence.xml is prepared to use a special driver which comes with the jdbc-module of TestContainers.

<properties>
  <property 
    name="javax.persistence.jdbc.driver"
    value="org.testcontainers.jdbc.ContainerDatabaseDriver"/>
  <property 
    name="javax.persistence.jdbc.url"
    value="jdbc:tc:mysql:5.7://xxx/test?TC_INITSCRIPT=DDL.sql"/>
</properties>

The driver org.testcontainers.jdbc.ContainerDatabaseDriver is registered in the jdbc module. It evaluates the jdbc.url to start the right docker image, in this case, mysql:5.7. The suffix ?TC_INITSCRIPT=DDL.sql initializes the database with the DB model. There are also other ways to initialize the database (see below).

The initialization is triggered by Hibernate with the creation of the EntityManager in the test:

EntityManager em = Persistence.createEntityManagerFactory("TestUnit").createEntityManager();

This will make Hibernate parse the persistence.xml and looking up the jdbc driver which triggers TestContainers to start the MySQL Docker container. (The database’s port is exposed on a random port.) The resulting EntityManager is pointing to the started and initialized Docker container and can be used:

public class UserTest {
   EntityManager entityManager = Persistence.createEntityManagerFactory("TestPU").createEntityManager();

   @Test
   public void testSaveAndLoad() {
      User user = new User();
      user.setUsername("user 1");

      entityManager.getTransaction().begin();
      entityManager.persist(user);
      entityManager.getTransaction().commit();

      User userFromDb = entityManager.find(User.class,user.getId());
      assertEquals(user.getUsername(), userFromDb.getUsername());
   }
}

The complete test class is here: UserTest

The complete test from the beginning which calls the repository is here: UserRepositoryTest

Different Ways to Insert the Data Model and Test Data

There are several ways to get your data model and test data into the database.

  • Like seen before the connection string in the persistence.xml: The property suffix ?TC_INITSCRIPT=DDL.sql initializes the database with the DB model from DDL.sql
  • Execute SQL File(s) from your test, see DockerDatabaseTestUtil.insertSqlFile()
  • Execute single SQL Queries from your test, see DockerDatabaseTestUtil.insertSqlString()
  • Use DbUnit to insert test data from XML files, see DockerDatabaseTestUtil.insertDbUnitTestdata()
  • The model can also be generated by Hibernate by setting the property in the persistence.xml hibernate.hbm2ddl.auto

My favorite is to insert the DDL via the persistence.xml and then let every test case insert it’s own data by DbUnit.

You can find the complete code examples on GitHub.

What’s Next

Was this article useful for you? Please share your thoughts in the comments. Follow my account and you will be notified about my upcoming article on using TestContainers to deploy to a Wildfly server running in a Docker container.

Docker (software) Database unit test Hibernate Test data Data (computing) Data model (GIS) Cons

Published at DZone with permission of Kai Winter. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • The Changing Face of ETL
  • Connecting Your Devs' Work to the Business
  • Cloud-Native Application Networking
  • Kotlin Is More Fun Than Java And This Is a Big Deal

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends: