TestCode에 데이터베이스 서버 연동

애플리케이션 서버에서 사용하는 데이터베이스 서버와 테스트에서 사용하는 데이터베이스 서버가 동일하면 테스트에 영향을 끼칠 수 있습니다.

 

예를들면 애플리케이션 서버에서 사용하는 데이터베이스 서버에 Item 테이블에 몇 개의 데이터가 존재한다고 할 때, 

테스트에서 이 데이터베이스를 가지고 검색 메소드 findItems()를 실행했을 때, 기존의 데이터들로 인해 테스트에 실패하게 됩니다.

@Test
void findItems() {
    //given
    Item item1 = new Item("itemA-1", 10000, 10);
    Item item2 = new Item("itemA-2", 20000, 20);
    Item item3 = new Item("itemB-1", 30000, 30);

    log.info("repository={}", itemRepository.getClass());
    itemRepository.save(item1);
    itemRepository.save(item2);
    itemRepository.save(item3);

    //둘 다 없음 검증
    test(null, null, item1, item2, item3);
    test("", null, item1, item2, item3);

    //itemName 검증
    test("itemA", null, item1, item2);
    test("temA", null, item1, item2);
    test("itemB", null, item3);

    //maxPrice 검증
    test(null, 10000, item1);

    //둘 다 있음 검증
    test("itemA", 10000, item1);
}

void test(String itemName, Integer maxPrice, Item... items) {
    List<Item> result = itemRepository.findAll(new ItemSearchCond(itemName, maxPrice));
    assertThat(result).containsExactly(items);
}

 따라서 이런 문제를 해결하기 위해서는 테스트를 다른 환경과 철저하게 분리해야 합니다.

가장 간단하게는 테스트 전용 데이터베이스를 별도로 운영하는 방법이 있습니다.

• jdbc:h2:tcp://localhost/~/test : 애플리케이션 서버에서 사용하는 데이터베이스 서버 (local)
• jdbc:h2:tcp://localhost/~/testcase : 테스트에서 사용하는 전용 데이터베이스 서버 (test)

src/main/resources/application.properties 

spring.profiles.active=local
spring.datasource.url=jdbc:h2:tcp://localhost/~/test
spring.datasource.username=sa

src/test/resources/application.properties

spring.profiles.active=test
  spring.datasource.url=jdbc:h2:tcp://localhost/~/testcase
  spring.datasource.username=sa

 

테스트와 애플리케이션에서 사용하는 데이터베이스르 분리해보았습니다. 하지만 끝이 아닙니다.

테스트가 끝나면 테스트에서 생성한 데이터들을 삭제 해주어야 다음 테스트에 영향을 끼치지 않습니다.

어떻게 해야 할까요?

---

Solution1. 트랜잭션과 롤백 전략 

이 때 도움이 되는 것이 바로 트랜잭션입니다.

테스트가 끝나고 난 후 트랜잭션을 강제로 롤백해버리면 데이터가 깔끔하게 지워집니다.

만약 테스트 실행도중 중간에 테스트가 실패해서 롤백을 호출하지 못해도 트랜잭션 모드로 전환했기 때문에 커밋하지 않은 이상 데이터베이스에 반영되지 않습니다. 

 

테스트가 실행하기 전 이렇게 @BeforeEach로 트랜잭션을 시작해주고,

@Slf4j
@SpringBootTest
class ItemRepositoryTest {
    @Autowired
    ItemRepository itemRepository;

    @Autowired
    PlatformTransactionManager transactionManager;

    TransactionStatus status;

    @BeforeEach
    void init()
    {
        status = transactionManager.getTransaction(new DefaultTransactionDefinition());
    }

테스트가 끝나면 이렇게 @AfterEach로 롤백해주면 됩니다.

@AfterEach
void afterEach() {
    //MemoryItemRepository 의 경우 제한적으로 사용
    if (itemRepository instanceof MemoryItemRepository) {
        ((MemoryItemRepository) itemRepository).clearStore();
    }

    transactionManager.rollback(status);
}

참고로 트랜잭션 매니저는 스프링 부트가 application.properties에 등록된 정보를 통해 DataSource와 더불어 자동으로 생성되기 때문에 별도로 등록하지 않아도 작동합니다.

---

Solution2. @Transactional

 트랜잭션 매니저를 사용하지 않으면서, 트랜잭션을 적용하는 방법이 있었습니다. 바로 AOP @Transactional 방식이죠.

테스트 코드에도 마찬가지로 @Transactional을 적용할 수 있습니다. 

@Transactional
@Slf4j
@SpringBootTest
class ItemRepositoryTest {
    @Autowired
    ItemRepository itemRepository;

//    @Autowired
//    PlatformTransactionManager transactionManager;
//
//    TransactionStatus status;
//
//    @BeforeEach
//    void init()
//    {
//        status = transactionManager.getTransaction(new DefaultTransactionDefinition());
//    }

    @AfterEach
    void afterEach() {
        //MemoryItemRepository 의 경우 제한적으로 사용
        if (itemRepository instanceof MemoryItemRepository) {
            ((MemoryItemRepository) itemRepository).clearStore();
        }

//        transactionManager.rollback(status);
    }

 @Transactional을 테스트에서 사용하면 조금 특별하게 동작합니다.

 

@Transactional이 적용된 테스트 동작 방식 

TestCode에 @Transactional을 적용했을 때 동작 방식

@Transactional이 테스트에 있으면 스프링은 테스트를 트랜잭션 안에서 실행하고, 테스트가 끝나면 자동으로 롤백을 시켜버립니다!

따라서 테스트가 끝난 후 개발자는 따로 직접 데이터를 삭제하지 않아도 됩니다.

 

Q. 만약 테스트 코드의 테스트 실행 단계에서 서비스나 리포지토리를 호출해서 사용하는데 서비스나 리포지토리 계층에 @Transactional이 붙어있으면 어떻게 처리되는가? 

A. 서비스나 리포지토리 계층의 트랜잭션도 테스트에서 시작한 트랜잭션에 참여하게 되어, 테스트의 실행부터 끝까지 내부 코드가 같은 트랜잭션을 사용합니다. 

Q. 테스트가 잘 작동했는지 데이터베이스에서 확인하고 싶어 커밋하고 싶은 경우에는 어떻게 하면 되는가?

A. 테스트 메소드위에 @Commit이나 , @Rollback(false)로 어노테이션을 붙혀주면 롤백하지 않고 트랜잭션이 커밋됩니다.

---

Solution3. 임베디드 모드 DB

테스트 케이스를 실행하기 위해서 별도의 데이터베이스를 설치하고, 운영하는 것은 상당히 번잡한 작업입니다.

 단순히 테스트를 검증할 용도로만 사용하기 때문에 테스트가 끝나면 데이터베이스의 데이터를 모두 삭제해도 된다. 더 나아가서 테스트가 끝나면 데이터베이스 자체를 제거해도 됩니다. 이럴 때 임베디드 모드를 사용할 수 있습니다.

임베디드 모드는 별도의 데이터베이스를 설치하지 않고, 사용하고 싶은 데이터베이스 서버를 JVM 안에서 메모리 모드로 동작하게 하는 방식입니다. 우리가 지금까지 사용한 H2 DB는 자바로 개발되어 있고, JVM 안에서 메모리 모드로 동작할 수 있도록 지원합니다.

DB를 애플리케이션에 내장해서 함께 실행한다고 해서 임베디드 모드라고 합니다.

 

임베디드 모드 직접 사용하기

 

애플리케이션 실행 코드에 DataSource를 수동으로 메모리모드로 빈 등록 

@Bean
@Profile("test")
public DataSource dataSource()
{
   log.info("메모리 데이터베이스 초기화");
   DriverManagerDataSource dataSource = new DriverManagerDataSource();
   dataSource.setDriverClassName("org.h2.Driver");
   dataSource.setUrl("jdbc:h2:mem:db;DB_CLOSE_DELAY=-1");
   dataSource.setUsername("sa");
   dataSource.setPassword("");
   return dataSource;
}

• @Profile("test") : 프로필이 test인 경우에만 적용. 즉 테스트 코드에만 적용하겠다는 의미
• DataSource 등록할 때 jdbc:h2:mem:db 로 작성하면 임베디드 모드(메모리 모드)로 동작하는 H2 데이터베이스를 사용할 수 있습니다.

• DB_CLOSE_DELAY=-1 : 임베디드 모드에서는 데이터베이스 커넥션이 연결이 모두 끊어지면 데이터베이스도 종료되는 데 -1로 설정하면 이것을 방지할 수 있습니다.

 

사실 스프링부트는 임베디드 데이터베이스에 대한 설정도 기본으로 제공하는 덕분에

//  @Bean
// @Profile("test")
// public DataSource dataSource()
// {
//    log.info("메모리 데이터베이스 초기화");
//    DriverManagerDataSource dataSource = new DriverManagerDataSource();
//    dataSource.setDriverClassName("org.h2.Driver");
//    dataSource.setUrl("jdbc:h2:mem:db;DB_CLOSE_DELAY=-1");
//    dataSource.setUsername("sa");
//    dataSource.setPassword("");
//    return dataSource;
// }

spring.profiles.active=test
#spring.datasource.url=jdbc:h2:tcp://localhost/~/testcase
#spring.datasource.username=sa

 이렇게 데이터베이스에 접근하는 모든 설정정보를 지우게 되면 스프링 부트는 자동으로 임베디드 모드로 접근하는 데이터소스를 만들어서 제공합니다.

---

<정리>

이렇게 테스트코드에서 데이터베이스 서버에 접근할 때 생길 수 있는 문제 ( 데이터베이스의 데이터가 유지되어 테스트에 영향을 끼치는 문제)를 통해 해결해보았습니다.

• 첫 번째, 애플리케이션 서버와 테스트 서버의 데이터베이스 분리.
• 두 번째, 트랜잭션을 이용해 테스트가 끝나면 테스트 서버의 데이터베이스 롤백
• 세 번째, TestCode에서 특별하게 동작하는 @Transactional을 이용한 테스트 후 데이터베이스의 데이터 롤백
• 네 번째, 임베디드 모드를 통해 테스트 후 데이터베이스 제거.

---

<참고자료>

스프링 DB 2편 - 데이터 접근 활용 기술 - 인프런 | 강의