[JAVA] Use DBUnit for Spring Boot test

Abstract

Use dbunit to test your Spring Boot project.

environment

• Java SE 8 (jdk-8u181)
• Spring Boot 2.1.1
• Spring-test-batch 1.3.0
• dbunit 2.6.0

Premise

Test target

• person

I created the following Mapper with MyBatis for the table.

@Mapper
public interface PersonMapper {

	@Select("SELECT * FROM person WHERE person_id = #{personId}")
	public Person selectById(int personId);

	@Insert("INSERT INTO person(person_id, person_name, birth_date, birth_place) VALUES (#{person_id}, #{person_name}, #{birth_date}, #{birth_place})")
	public void insert(Person person);
}

Detailed procedure

Add dependency

Add spring-test-dbunit and dbunit to the dependencies.

• It is assumed that the main code and the library for JUnit to operate are also included in the dependency.

pom.xml

<dependency>
  <groupId>com.github.springtestdbunit</groupId>
  <artifactId>spring-test-dbunit</artifactId>
  <version>1.3.0</version>
  <scope>test</scope>
</dependency>
<dependency>
  <groupId>org.dbunit</groupId>
  <artifactId>dbunit</artifactId>
  <version>2.6.0</version>
  <scope>test</scope>
</dependency>

Prerequisite data input

Describe the data in the DB before executing the test (before executing the test method).

Basic pattern

__ * In the following cases, the data used for the test will be committed __ (The rollback case will be described later)

Input data description

• Create a table name tag in the dataset tag and describe the data value to input the column name to the attribute value in the attribute name.
• When inputting multiple lines of data, create tags for the number of lines.
• Do not describe the column to be null as an attribute. * It is not necessary to write all columns at the beginning.
• __ An empty string cannot be entered by default. __ (The case of inserting an empty string will be described later)
• By default, all rows of tables appearing in xml are deleted and then INSERT is executed to input data.
• __ No operation is performed on the table that is not described __

Pattern A.xml

<?xml version="1.0" encoding="UTF-8"?>
<dataset>
	<person person_id="1" person_name="Suzaki" birth_date="1986-12-25" />
	<person person_id="2" person_name="Nishi"                          birth_place="Hyogo prefecture" />
	<person person_id="3"                      birth_date="1994-02-22" birth_place="Tokyo" />
</dataset>

• This time, create a dbunit directory under src / test / resources and create it as pattern A.xml under it.

Test class creation

// (1)
@RunWith(SpringRunner.class)
@SpringBootTest
@TestExecutionListeners({
	DependencyInjectionTestExecutionListener.class,
	DbUnitTestExecutionListener.class
})
public class PersonMapperTest {

	@Autowired // (2)
	PersonMapper mapper;

	@Test
	@DatabaseSetup("/dbunit/Pattern A.xml") // (3)
	public void test() {
		//Write test code
	}
}

Execution result

# SELECT * FROM person;
person_id | person_name | birth_date | birth_place
-----------+-------------+------------+-------------
        1 | Suzaki      | 1986-12-25 |
        2 | Nishi       |            |Hyogo prefecture
        3 |             | 1994-02-22 |Tokyo
(3 lines)

Blank input pattern

Input data description

If you write one line of tags without attributes as shown below, only DELETE will be executed and the table will be empty.

Pattern B.xml

<?xml version="1.0" encoding="UTF-8"?>
<dataset>
	<person />
</dataset>

Execution result

# SELECT * FROM person;
 person_id | person_name | birth_date | birth_place
-----------+-------------+------------+-------------
(0 line)

Empty string input pattern

Input data description

• Empty the attribute value with the column that inputs the empty string as the attribute name

Pattern C.xml

<?xml version="1.0" encoding="UTF-8"?>
<dataset>
	<person person_id="4" person_name="" birth_date="1991-12-25" birth_place="Hyogo prefecture" />
</dataset>

If the above xml is read only with the basic pattern test code, the following exception will occur. java.lang.IllegalArgumentException: table.column=person.person_name value is empty but must contain a value (to disable this feature check, set DatabaseConfig.FEATURE_ALLOW_EMPTY_FIELDS to true)

Additional code

Add the following configuration to the path read when running the test.

@Configuration
public class DatasourceConfig {

	// (1)
	@Bean
	public DatabaseConfigBean dbUnitDatabaseConfig() {
		DatabaseConfigBean bean = new DatabaseConfigBean();

		bean.setAllowEmptyFields(true); // (2)

		return bean;
	}

	// (3)
	@Bean
	public DatabaseDataSourceConnectionFactoryBean dbUnitDatabaseConnection(
			DatabaseConfigBean dbUnitDatabaseConfig,
			DataSource dataSource
	) {
		DatabaseDataSourceConnectionFactoryBean bean = new DatabaseDataSourceConnectionFactoryBean(dataSource);
		bean.setDatabaseConfig(dbUnitDatabaseConfig);
		return bean;
	}
}

Execution result

# SELECT * FROM person;
person_id | person_name | birth_date | birth_place
-----------+-------------+------------+-------------
        4 |             | 1991-12-25 |Hyogo prefecture
(1 line)

@Test
@DatabaseSetup("/dbunit/Pattern C.xml")
public void test() {
  Person actual = mapper.selectById(4);
  assertThat(actual.getPerson_name()).isEqualTo(""); // ->success
}

Pattern to return data after testing

Test class creation

Add listeners and annotations to the base pattern.

@RunWith(SpringRunner.class)
@SpringBootTest
@TestExecutionListeners({
	DependencyInjectionTestExecutionListener.class,
	TransactionalTestExecutionListener.class, // (1)
	DbUnitTestExecutionListener.class
})
@Transactional //(2)
public class PersonMapperTest3 {
  ...
}

You can also add @Transactional to the method.

@Test
@Transactional
@DatabaseSetup("/dbunit/Pattern A.xml")
public void test() {
  ...
}

Avoid warning text

When executed with the above pattern, the following log is output at the WARN level. Potential problem found: The configured data type factory 'class org.dbunit.dataset.datatype.DefaultDataTypeFactory' might cause problems with the current database 'PostgreSQL' (e.g. some datatypes may not be supported properly). In rare cases you might see this message because the list of supported database products is incomplete (list=[derby]). If so please request a java-class update via the forums.If you are using your own IDataTypeFactory extending DefaultDataTypeFactory, ensure that you override getValidDbProducts() to specify the supported database products.

Since the log says that DataTypeFactory is not specified, add the following description to the configuration class used in the empty string input pattern.

@Bean
public DatabaseConfigBean dbUnitDatabaseConfig() {
  DatabaseConfigBean bean = new DatabaseConfigBean();

  bean.setAllowEmptyFields(true);
  bean.setDatatypeFactory(new PostgresqlDataTypeFactory()); // (1)

  return bean;
}

Assumed data definition

Basic pattern

Assumed data description

Describe in the same format as the prerequisite data. When null or empty string is assumed, it is the same as the prerequisite data input.

Pattern D.xml

<?xml version="1.0" encoding="UTF-8"?>
<dataset>
	<person person_id="1" person_name="Suzaki" birth_date="1986-12-25" />
	<person person_id="2" person_name="Nishi"                          birth_place="Hyogo prefecture" />
	<person person_id="3"                      birth_date="1994-02-22" birth_place="" />
</dataset>

Assumed result 1.xml

<?xml version="1.0" encoding="UTF-8"?>
<dataset>
	<person person_id="1" person_name="Suzaki" birth_date="1986-12-25" />
	<person person_id="2" person_name="Nishi"                          birth_place="Hyogo prefecture" />
	<person person_id="3"                      birth_date="1994-02-22" birth_place="" />
	<person person_id="11" person_name="Uesaka" birth_date="1991-12-19" birth_place="Kanagawa Prefecture" />
</dataset>

Test method creation

@Test
@DatabaseSetup("/dbunit/Pattern D.xml")
@ExpectedDatabase(
	value="/dbunit/Assumed result 1.xml",
	assertionMode=DatabaseAssertionMode.NON_STRICT
) // (1)
public void test() {
	Person param = new Person();
	param.setPerson_id(11);
	param.setPerson_name("Uesaka");
	param.setBirth_date(new Date(91, 11, 19));
	param.setBirth_place("Kanagawa Prefecture");

	mapper.insert(param);
}

Reference site

SpringBoot 45.Testing Spring Framework Unit test implementation method 1-3. Repository test (Junit4, spring-test, DBUnit) │ ヰ Sword toy box How to set default properties in spring dataset DatabaseConfig - Stack Overflow