스프링 DB 2편 - 데이터 접근 활용 기술 (4) - 데이터 접근 기술 - 테스트

 인프런 스프링 DB 2편 - 데이터 접근 활용 기술편을 학습하고 정리한 내용 입니다.

테스트 - 데이터베이스 연동

데이터베이스에 연동하는 테스트에 대해서 알아보자. 데이터 접근 기술은 실제 데이터베이스에 접근해서 데이터를 잘 저장하고 조회할 수 있는지 확인하는 것이 필요하다.

ItemRepositoryTest를 통해서 테스트 진행한다.

테스트 케이스에서 DB에 접근하기 위해 src/test/resources/application.properties를 수정하자.

spring.profiles.active=test  
  
spring.datasource.url=jdbc:h2:tcp://localhost/~/test  
spring.datasource.username=sa  
spring.datasource.password=  
  
logging.level.org.springframework.jdbc=debug

테스트 실행 - 로컬DB

@SpringBootTest  
class ItemRepositoryTest {  
  
    @Autowired  
    ItemRepository itemRepository;  
  
    @AfterEach  
    void afterEach() {  
        //MemoryItemRepository 의 경우 제한적으로 사용  
        if (itemRepository instanceof MemoryItemRepository) {  
            ((MemoryItemRepository) itemRepository).clearStore();  
        }  
    }  
  
    @Test  
    void save() {  
        //given  
        Item item = new Item("itemA", 10000, 10);  
  
        //when  
        Item savedItem = itemRepository.save(item);  
  
        //then  
        Item findItem = itemRepository.findById(item.getId()).get();  
        assertThat(findItem).isEqualTo(savedItem);  
    }  
  
    @Test  
    void updateItem() {  
        //given  
        Item item = new Item("item1", 10000, 10);  
        Item savedItem = itemRepository.save(item);  
        Long itemId = savedItem.getId();  
  
        //when  
        ItemUpdateDto updateParam = new ItemUpdateDto("item2", 20000, 30);  
        itemRepository.update(itemId, updateParam);  
  
        //then  
        Item findItem = itemRepository.findById(itemId).get();  
        assertThat(findItem.getItemName()).isEqualTo(updateParam.getItemName());  
        assertThat(findItem.getPrice()).isEqualTo(updateParam.getPrice());  
        assertThat(findItem.getQuantity()).isEqualTo(updateParam.getQuantity());  
    }  
  
    @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);  
  
        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);  
    }  
}

자 이런 코드이고, @SpringBootTest를 사용했기 때문에

다음과 같이 JdbcTemplateV3Config를 가지게 된다.

실행해보자.

findItems()테스트가 실패했다.

보면 이전 데이터들이 다 쌓여있어서 조회 시 3개를 기대했는데, 너무 많은 데이터가 나와버렸다.

개발 DB와 테스트 DB를 분리할 필요가 있다!

테스트 - 데이터베이스 분리

로컬에서 사용하는 애플리케이션 서버와 테스트에서 같은 데이터베이스를 사용하고 있으니 테스트에서 문제가 발생한다.

이런 문제를 해결하려면 테스트를 다른 환경과 철저하게 분리해야 한다.

가장 간단한 방법은 테스트 전용 데이터베이스를 별도로 운영하는 것이다.

• H2 데이터베이스를 용도에 따라 2가지로 구분하면 된다.
  • jdbc:h2:tcp://localhost/~/test local에서 접근하는 서버 전용 데이터베이스
  • jdbc:h2:tcp://localhost/~/testcase test 케이스에서 사용하는 전용 데이터베이스

데이터베이스 파일 생성 방법

• 데이터베이스 서버를 종료하고 다시 실행한다.

다음과 같이 입력하고 연결

spring.profiles.active=test  
  
spring.datasource.url=jdbc:h2:tcp://localhost/~/testcase  
spring.datasource.username=sa  
spring.datasource.password=  
  
logging.level.org.springframework.jdbc=debug

application.properties도 새로 만들었다.

테이블 생성하기

drop table if exists item CASCADE;  
create table item  
(  
    id        bigint generated by default as identity,  
    item_name varchar(10),  
    price     integer,  
    quantity  integer,  
    primary key (id)  
);

이걸 넣어준다.

이제 테스트를 실행해보자!

findItems()만 단독 실행했을 때 성공했다.

하지만 두번 실행하거나, 다른 테스트를 먼저 실행하면 또 실패한다.

• 처음 테스트를 실행할 때 저장한 데이터가 계속 남아있기 때문에 두번째 테스트에 영향을 준 것이다.

테스트에서 매우 중요한 원칙은 다음과 같다.

• 테스트는 다른 테스트와 격리해야 한다.
• 테스트는 반복해서 실행할 수 있어야 한다.

물론 테스트가 끝날 때 마다 추가한 데이터에 DELETE SQL을 사용해도 되겠지만, 이 방법도 궁극적인 해결책은 아니다. 만약 테스트 과정에서 데이터를 이미 추가했는데, 테스트가 실행되는 도중에 예외가 발생하거나 애플리케이션이 종료되어 버려서 테스트 종료 시점에 DELETE SQL을 호출하지 못할 수 도 있다! 그러면 결국 데이터가 남아있게 된다.

이런 문제를 어떻게 해결할 수 있을까?

테스트 - 데이터 롤백

트랜잭션과 롤백 전략

이때 도움이 되는 것이 바로 트랜잭션이다. 테스트가 끝나고 나서 트랜잭션을 강제로 롤백해버리면 데이터가 깔끔하게 제거된다.

테스트를 하면서 데이터를 이미 저장했는데, 중간에 테스트가 실패해서 롤백을 호출하지 못해도 괜찮다. 트랜잭션을 커밋하지 않았기 때문에 데이터베이스에 해당 데이터가 반영되지 않는다.

이렇게 트랜잭션을 활용하면 테스트가 끝나고 나서 데이터를 깔끔하게 원래 상태로 되돌릴 수 있다.

테스트는 각각의 테스트 실행 전 후로 동작하는 @BeforeEach, @AfterEach라는 편리한 기능을 제공한다.테스트에 트랜잭션과 롤백을 적용하기 위해 다음 코드를 추가하자.

@SpringBootTest  
class ItemRepositoryTest {  
  
    @Autowired  
    ItemRepository itemRepository;  
  
    @Autowired  
    PlatformTransactionManager transactionManager;  
    TransactionStatus status;  
  
    @BeforeEach  
    void beforeEach() {  
        // 트랜잭션 시작  
        status = transactionManager.getTransaction(new DefaultTransactionDefinition());  
    }  
  
    @AfterEach  
    void afterEach() {  
        //MemoryItemRepository 의 경우 제한적으로 사용  
        if (itemRepository instanceof MemoryItemRepository) {  
            ((MemoryItemRepository) itemRepository).clearStore();  
        }  
  
        //트랜잭션 롤백  
        transactionManager.rollback(status);  
    }

	.. 테스트 내용
}

• 트랜잭션 관리자는 PlatformTransactionManager를 주입 받아서 사용하면 된다. 참고로 스프링 부트는 자동으로 적절한 트랜잭션 매니저를 스프링 빈으로 등록해준다.
• @BeforeEach : 각각의 테스트 케이스를 실행하기 직전에 호출된다. 따라서 여기서 트랜잭션을 시작하면 된다. 그러면 각각의 테스트를 트랜잭션 범위 안에서 실행할 수 있다.
  • transactionManager.getTransaction(new DefaultTransactionDefinition())로 트랜잭션을 시작한다.
• @AfterEach : 각각의 테스트 케이스가 완료된 직후에 호출된다. 따라서 여기서 트랜잭션을 롤백하면 된다. 그러면 데이터를 트랜잭션 실행 전 상태로 복구할 수 있다.
  • transactionManager.rollback(status)로 트랜잭션을 롤백한다.

테스트를 실행하기 전에 먼저 테스트에 영향을 주지 않도록 testcase데이터베이스에 접근해서 기존 데이터를 깔끔하게 삭제하자.

• delete from item 이제 모든 테스트를 다 돌려보자.

드디어 성공했다.

여러번 시도해도 성공한다.

데이터도 없다.

그런데 약간 불편하다. 이걸 간단하게 바꿔보자.

테스트 - @Transactional

스프링은 테스트 데이터 초기화를 위해 트랜잭션을 적용하고 롤백하는 방식을 @Transactional애노테이션 하나로 깔끔하게 해결해준다.

이전에 테스트에 트랜잭션과 롤백을 위해 추가했던 코드들을 주석 처리하자. 그리고 @Transactional를 추가하자.

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

자 처음 코드로 돌아가고 @Transactional만 추가됐다.

몇 번 시도해도 다 성공한다.

@Transactional 원리

스프링이 제공하는 @Transactional애노테이션은 로직이 성공적으로 수행되면 커밋하도록 동작한다. 그런데 @Transactional애노테이션을 테스트에서 사용하면 아주 특별하게 동작한다.

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

1. 테스트에 @Transactional애노테이션이 테스트 메서드나 클래스에 있으면 먼저 트랜잭션을 시작한다.
2. 테스트 로직을 실행한다. 테스트가 끝날 때 까지 모든 로직은 트랜잭션 안에서 수행된다.
   • 트랜잭션은 기본적으로 전파되기 때문에, 리포지토리에서 사용하는 JdbcTemplate도 같은 트랜잭션을 사용한다.
3. 테스트 실행 중에 INSERT SQL을 사용해서 item1, item2, item3를 데이터베이스에 저장한다.
   • 물론 테스트가 리포지토리를 호출하고, 리포지토리는 JdbcTemplate을 사용해서 데이터를 저장한다.
4. 검증을 위해서 SELECT SQL로 데이터를 조회한다. 여기서는 앞서 저장한 item1, item2, item3이 조회되었다.
   • SELECT SQL도 같은 트랜잭션을 사용하기 때문에 저장한 데이터를 조회할 수 있다. 다른 트랜잭션에서는 해당 데이터를 확인할 수 없다.
   • 여기서 assertThat()으로 검증이 모두 끝난다.
5. @Transactional이 테스트에 있으면 테스트가 끝날때 트랜잭션을 강제로 롤백한다.
6. 롤백에 의해 앞서 데이터베이스에 저장한 item1, item2, item3의 데이터가 제거된다.

참고
테스트 케이스의 메서드나 클래스에 @Transactional을 직접 붙여서 사용할 때 만 이렇게 동작한다. 그리고 트랜잭션을 테스트에서 시작하기 때문에 서비스, 리포지토리에 있는 @Transactional도 테스트에서 시작한 트랜잭션에 참여한다.

정리

• 테스트가 끝난 후 개발자가 직접 데이터를 삭제하지 않아도 되는 편리함을 제공한다.
• 테스트 실행 중에 데이터를 등록하고 중간에 테스트가 강제로 종료되어도 걱정이 없다. 이 경우 트랜잭션을 커밋하지 않기 때문에, 데이터는 자동으로 롤백된다. (보통 데이터베이스 커넥션이 끊어지면 자동으로 롤백되어 버린다.)
• 트랜잭션 범위 안에서 테스트를 진행하기 때문에 동시에 다른 테스트가 진행되어도 서로 영향을 주지 않는 장점이 있다.
• @Transactional덕분에 아주 편리하게 다음 원칙을 지킬수 있게 되었다.
  • 테스트는 다른 테스트와 격리해야 한다.
  • 테스트는 반복해서 실행할 수 있어야 한다.

강제로 커밋하기 - @Commit

@Transactional을 테스트에서 사용하면 테스트가 끝나면 바로 롤백되기 때문에 테스트 과정에서 저장한 모든 데이터가 사라진다. 당연히 이렇게 되어야 하지만, 정말 가끔은 데이터베이스에 데이터가 잘 보관되었는지 최종 결과를 눈으로 확인하고 싶을 때도 있다. 이럴 때는 다음과 같이 @Commit을 클래스 또는 메서드에 붙이면 테스트 종료후 롤백대신 커밋이 호출된다. 참고로 @Rollback(value = false)를 사용해도 된다.

@Commit 
@Transactional 
@SpringBootTest 
class ItemRepositoryTest {}

테스트 - 임베디드 모드 DB

테스트 케이스를 실행하기 위해서 별도의 데이터베이스를 설치하고, 운영하는 것은 상당히 번잡한 작업이다. 단순히 테스트를 검증할 용도로만 사용하기 때문에 테스트가 끝나면 데이터베이스의 데이터를 모두 삭제해도 된다. 더 나아가서 테스트가 끝나면 데이터베이스 자체를 제거해도 된다.

임베디드 모드

H2 데이터베이스는 자바로 개발되어 있고, JVM안에서 메모리 모드로 동작하는 특별한 기능을 제공한다. 그래서 애플리케이션을 실행할 때 H2 데이터베이스도 해당 JVM 메모리에 포함해서 함께 실행할 수 있다. DB를 애플리케이션에 내장해서 함께 실행한다고 해서 임베디드 모드(Embedded mode)라 한다. 물론 애플리케이션이 종료되면 임베디드 모드로 동작하는 H2 데이터베이스도 함께 종료되고, 데이터도 모두 사라진다. 쉽게 이야기해서 애플리케이션에서 자바 메모리를 함께 사용하는 라이브러리처럼 동작하는 것이다.

이제 H2 데이터베이스를 임베디드 모드로 사용해보자.

임베디드 모드 직접 사용

ItemServiceApplication

@Slf4j  
//@Import(MemoryConfig.class)  
//@Import(JdbcTemplateV1Config.class)  
//@Import(JdbcTemplateV2Config.class)  
@Import(JdbcTemplateV3Config.class)  
@SpringBootApplication(scanBasePackages = "hello.itemservice.web")  
public class ItemServiceApplication {  
  
    public static void main(String[] args) {  
       SpringApplication.run(ItemServiceApplication.class, args);  
    }  
  
    @Bean  
    @Profile("local")  
    public TestDataInit testDataInit(ItemRepository itemRepository) {  
       return new TestDataInit(itemRepository);  
    }  
  
  
    @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;  
    }  
}

ItemServiceApplication에 직접 Bean으로 등록해버렸다.

• @Profile("test")
  • 프로필이 test인 경우에만 데이터소스를 스프링 빈으로 등록한다.
  • 테스트 케이스에서만 이 데이터소스를 스프링 빈으로 등록해서 사용하겠다는 뜻이다.
• dataSource()
  • jdbc:h2:mem:db : 이 부분이 중요하다. 데이터소스를 만들때 이렇게만 적으면 임베디드 모드(메모리 모드)로 동작하는 H2 데이터베이스를 사용할 수 있다.
  • DB_CLOSE_DELAY=-1 : 임베디드 모드에서는 데이터베이스 커넥션 연결이 모두 끊어지면 데이터베이스도 종료되는데, 그것을 방지하는 설정이다.
  • 이 데이터소스를 사용하면 메모리 DB를 사용할 수 있다.

이제 ItemRepositoryTest테스트를 메모리 DB를 통해 실행해보자.

앞에서 설정은 끝났다. 이제 테스트를 실행만 하면 새로 등록한 메모리 DB에 접근하는 데이터소스를 사용하게 된다. 확실하게 하기 위해서 H2 데이터베이스 서버는 잠시 꺼두자

DB는 만들어졌다.

ITEM테이블이 없다.

테스트를 실행하기 전에 테이블을 먼저 생성해주어야 한다. 수동으로 할 수도 있지만 스프링 부트는 이 문제를 해결할 아주 편리한 기능을 제공해준다.

스프링 부트 - 기본 SQL 스크립트를 사용해서 데이터베이스를 초기화하는 기능

메모리 DB는 애플리케이션이 종료될 때 함께 사라지기 때문에, 애플리케이션 실행 시점에 데이터베이스 테이블도 새로 만들어주어야 한다.

JDBC나 JdbcTemplate를 직접 사용해서 테이블을 생성하는 DDL을 호출해도 되지만, 너무 불편하다. 스프링 부트는 SQL 스크립트를 실행해서 애플리케이션 로딩 시점에 데이터베이스를 초기화하는 기능을 제공한다.

src/test/resources/schema.sql

drop table if exists item CASCADE;  
create table item  
(  
    id        bigint generated by default as identity,  
    item_name varchar(10),  
    price     integer,  
    quantity  integer,  
    primary key (id)  
);

이름을 schema.sql로 정확히 하고, 위치도 정확히 해줘야한다.

이제 메모리 모드로 테스트가 통과된 걸 볼 수 있다.

테스트 - 스프링 부트와 임베디드 모드

스프링 부트는 개발자에게 정말 많은 편리함을 제공하는데, 임베디드 데이터베이스에 대한 설정도 기본으로 제공한다.

스프링 부트는 데이터베이스에 대한 별다른 설정이 없으면 임베디드 데이터베이스를 사용한다.

앞서 직접 설정했던 메모리 DB용 데이터소스를 주석처리하자.

@Slf4j  
//@Import(MemoryConfig.class)  
//@Import(JdbcTemplateV1Config.class)  
//@Import(JdbcTemplateV2Config.class)  
@Import(JdbcTemplateV3Config.class)  
@SpringBootApplication(scanBasePackages = "hello.itemservice.web")  
public class ItemServiceApplication {  
  
    public static void main(String[] args) {  
       SpringApplication.run(ItemServiceApplication.class, args);  
    }  
  
    @Bean  
    @Profile("local")  
    public TestDataInit testDataInit(ItemRepository itemRepository) {  
       return new TestDataInit(itemRepository);  
    }  
  
  
//  @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  
#spring.datasource.password=  
  
logging.level.org.springframework.jdbc=debug

spring.datasource.url, spring.datasource.username를 사용하지 않도록 #을 사용해서 주석처리 했다.

이렇게 하면 테스트쪽은 데이터베이스 접근 정보가 하나도 없다.

이렇게 정보가 없으면 임베디드 모드로 작동한다.

테스트도 잘 통과되고, 메모리모드로 잘 동작한걸 볼 수 있다.