Spring Boot (1) MybatisTest를 통한 Mapper 단위 테스트

Study/Spring Boot

Spring Boot (1) MybatisTest를 통한 Mapper 단위 테스트

Nullsector_1 2021. 5. 12. 18:51

개발 환경 : JAVA 1.8 / Spring Boot 2.4.1 / Gradle 6.7.1 / MySql

IDE : IntelliJ 20.3.3

Dependency : mybatis-spring-boot-starter-test 2.1.3

* 해당 포스팅은 공식문서를 참조하여 작성했습니다.

mybatis Test 공식문서 링크

1. 필요한 의존 추가

1.1 Mybatis Test 추가

mybatis-test

// Gradle의 경우
dependencies {
    testCompile("org.mybatis.spring.boot:mybatis-spring-boot-starter-test:2.1.3")
}

// Maven의 경우
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter-test</artifactId>
    <version>2.1.3</version>
    <scope>test</scope>
</dependency>

1.2 필요한 설정 추가 ( application.yml )

application.yml

		# 생략 #

datasource:
    username: #####
    password: #####
    driver-class-name: com.mysql.cj.jdbc.Driver # mysql 이외 각각 사용하는 DB Driver 설정
    url: #####
    
    hikari: # 해당 설정은 jdbc connection 이외 다른 connectio Pool 사용 시 설정
            # 여기선 hikariCP를 사용
            # hikariCP 설정내용은 생략
            

mybatis:

    # mapper.xml 파일이 위치할 패키지 경로를 입력
    mapper-location: classpath:/mapper/**/*.xml 
    
    # 커스텀 config 사용 시 입력
    config-location: classpath:/mybatis-config.xml
    
		# 생략 #

2. 테스트 할 Mapper Interface, Mapper.xml 작성

OrderMapper.java

package com.mapper;


import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Select;

// @Mapper 어노테이션을 통한 mapper 등록
@Mapper
public interface OrderMapper {

	// @Select, @insert 등의 어노테이션으로 xml 작성 없이 간단한 쿼리문을 날릴 수 있음.
	// @Select("Select * from orderbook where seq = #{seq}")
	OrderVO getOrder(@Param("seq") String seq);


}

OrderMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper   PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="com.xxx.OrderMapper">

    <select id="getTest" resultType="OrderVO">
        Select *
        from orderbook
        where seq = #{seq}
    </select>


</mapper>

3. 테스트 클래스 작성 및 테스트

3.1 테스트 클래스 작성

OrderTest.java

package com.xxx.orders

import com.xxx.OrderMapper;
import com.xxx.OrderVO;

import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

import org.mybatis.spring.boot.test.autoconfigure.MybatisTest;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;

import static org.assertj.core.api.Assertions.assertThat;

// JUnit5 사용 시 작성, MybatisTest 2.0.1버전 이상에서 생략 가능
// @ExtendWith(SpringExtension.class)
// JUnit4 사용 시 작성
// @RunWith(SpringRunner.class)

// @MybatisTest 어노테이션 추가
@MybatisTest

// 실 데이터베이스에 연결 시 필요한 어노테이션
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
public class OrderTest {

    @Autowired
    private OrderMapper orderMapper;

    @Test
    @DisplayName("Order Mapper Test")
    public void mybatis_Mapper_XML_테스트() throws Exception {

        // given
        String seq = "1";

        // when
        OrderVO vo = orderMapper.getOrder(seq);

        // then
        assertThat(vo.getSeq).isEqualTo("1");

    }


}