Install Docker

To use the dbUnit Docker database images, install Docker and follow the running tests instructions.

brew cask install docker

Start Databases

All instructions assume current directory is (path to)/dbunit-docker

docker-compose up -d

docker-compose down

docker-compose down

DB2

TODO

MySQL

1. Install MySQL database. This can be on your local machine, or you can use any MySQL database you have access to.
2. Create a "dbunit" user and database, for example with these commands:

   mysql -uroot -p <<EOF
   # (enter database root password)
   CREATE DATABASE dbunit;
   GRANT ALL ON dbunit.* TO dbunit@localhost IDENTIFIED BY "dbunit";
   EOF
   

   • These values are the defaults configured in the project. For different values, override the properties.
   • To connect to a remote database, specify the client host name.
   • May also need to adjust the MySQL configuration to permit remote connection.

Oracle 11g

1. Install Oracle database. This can be on your local machine, or you can use any Oracle database you have access to.
2. Create a "dbunit" user with password "dbunit".
   • These values are the defaults configured in the project. For different values, override the properties.

PostgreSQL

1. Install PostgreSQL database. This can be on your local machine, or you can use any PostgreSQL database you have access to.
2. Create a "dbunit" user and database, for example with these commands:

   sudo -u postgres psql <<EOF
   CREATE USER dbunit WITH PASSWORD 'dbunit';
   CREATE DATABASE dbunit OWNER dbunit;
   
   \q
   EOF
   

   • These values are the defaults configured in the project. For different values, override the properties.

SQLServer

TODO

Maven Profiles

Maven profiles control which database configuration is in use for a particular test run. The profiles are named for the database (see specific database sections below). List all profiles using this command:

mvn help:all-profiles

The default profile (when not specifying a profile) runs the tests using an HSQLDB in-memory database.

For example, to run the tests using the DbUnit Oracle10DataTypeFactory and the Oracle 8 JDBC driver, use this command:

mvn verify -Poracle10-ojdbc8

Note: The integration tests are run using the Maven failsafe-plugin.

Clean Build

It's important to occasionally run a clean build to ensure no problems are hidden by existing compiled classes or resource files. Simply run the Maven clean goal:

mvn clean

Optionally Skip Unit Tests When Running Integration Tests

To skip running the unit tests with the integration tests, specify the "it-config" profile in addition to the database-named profile. While we typically run all tests, it's useful to save the unit tests run time when focusing on one or more integration tests.

For example, this runs the unit tests and the integration tests with Apache Derby:

mvn -Pderby verify

and this skips the unit tests and runs the integration tests with Apache Derby:

mvn -Pit-config,derby verify

Maven Commands

Eclipse / Maven Integration

The m2e plugin has an "Active Maven Profile" setting in a project's properties which activates the specified profile(s) during builds. Access it from the project's context menu:

(project context menu) -> Properties -> Maven -> Active Maven Profiles

Enter the Maven profile name(s) to always run, including the integration test profiles such as "derby".

Using dbunit.properties File

"dbunit.properties" is useful for environments which make it difficult if not impossible to use Maven's profiles. For instance, directly running JUnit tests within IDEs typically don't use Maven and therefore are not using Maven's profiles (which set the the database configuration) and tests fail.

dbunit.properties contains the properties a profile sets. It is an optional file and is not provided by DbUnit; one must create it under src/test/resources.

Following is an example content of dbunit.properties that works for activating the profile h2:

dbunit.profile=h2
dbunit.profile.driverClass=org.h2.Driver
dbunit.profile.url=jdbc:h2:target/h2/test
dbunit.profile.schema=PUBLIC
dbunit.profile.user=sa
dbunit.profile.password=
dbunit.profile.ddl=h2.sql
dbunit.profile.unsupportedFeatures=BLOB,CLOB,SCROLLABLE_RESULTSET,INSERT_IDENTITY,TRUNCATE_TABLE,SDO_GEOMETRY,XML_TYPE
dbunit.profile.multiLineSupport=true

The directory src/test/resources has the properties files for each supported database (the Maven profiles use them for configuring the tests accordingly). They are convenient for simply copying the desired one to dbunit.properties.