데이터 접근 기술 - 테스트

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

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

 

지금부터 테스트를 실행할 때 실제 데이터베이스를 연동해서 진행해보자.

앞서 개발한 ItemRepositoryTest를 통해서 테스트를 진행할 것이다.

 

테스트를 실행하기 전에 먼저 지금까지 설정한 application.properties를 확인해보자.

 

main - application.properties

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

#jdbcTemplate sql log
logging.level.org.springframework.jdbc=debug

 

test - application.properties

 

spring.profiles.active=test

#jdbcTemplate sql log
logging.level.org.springframework.jdbc=debug

 

테스트케이스는 src/test에 있기 때문에, 실행하면 src/test에 있는 application.properties 파일이 우선 순위를 가지고 실행된다. 그런데 문제는 테스트용 설정에는 spring.datasource.url과 같은 데이터베이스 연결 설정이 없다는 점이다.

 

테스트 케이스에서도 데이터베이스에 접속할 수 있게 test의 application.properties를 다음과 같이 수정하자.

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

#jdbcTemplate sql log
logging.level.org.springframework.jdbc=debug

 

 

테스트 실행 - 로컬DB

ItemRepositoryTest 테스트 코드를 확인해보자.

@SpringBootTest
class ItemRepositoryTest {}

- ItemRepositoryTest는 @SpringBootTest를 사용한다. @SpringBootTest는 @SpringBootApplication를 찾아서 설정으로 사용한다.

 

//@Import(MemoryConfig.class)
//@Import(JdbcTemplateV1Config.class)
//@Import(JdbcTemplateV2Config.class)
@Import(JdbcTemplateV3Config.class)
@SpringBootApplication(scanBasePackages = "hello.itemservice.web")
public class ItemServiceApplication {}

- @SpringBootApplication 설정이 과거에는 MemoryConfig.class를 사용하다가 이제는 JdbcTemplateV3Config.class를 사용하도록 변경되었다. 따라서 테스트로 JdbcTemplate을 통해 실제 데이터베이스를 호출하게 된다.

- MemoryItemRepository -> JdbcTemplateItemRepositoryV3

 

테스트를 실행해보면 다음과 같은 결과를 받을 수 있다.

- updateItem() : 성공

- save() : 성공

- findItems() : 실패

 

findItems()는 다음과 같은 오류를 내면서 실패하였다.

java.lang.AssertionError: 
Expecting actual:
  [Item(id=1, itemName=itemA, price=10000, quantity=10),
    Item(id=2, itemName=itemB, price=20000, quantity=20),
    Item(id=3, itemName=itemC, price=30000, quantity=30),

@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);

findItems()는 상품 3개를 저장하고, 조회하는 로직이다.

하지만 이전에 테스트를 돌리고, 직접 사용해보며 저장된 아이템이 있기 때문에 기대보다 더 많은 데이터가 조회되어 실패하였다.

 

실패 원인

왜 이런 문제가 발생하는 것일까?

테스트를 실행할 때 TestDataInit이 실행되는 것은 아닐까? 이 문제는 아니다. TestDataInit은 프로필이 local일때만 동작하는데, 테스트 케이스를 실행할 때는 프로필이 spring.profiles.active=test이기 때문에 초기화 데이터가 추가되지는 않는다.

 

문제는 H2 데이터베이스가 이미 과거에 서버를 실행하면서 저장했던 데이터가 보관되어있기 때문이다. 이 데이터가 현재 테스트에 영향을 준다.

 

 

 

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

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

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

 

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

- H2 데이터베이스를 용도에 따라 2가지로 구분하면 된다.

    - jdbc:h2:tcp://localhost/~/test : local에서 접근하는 서버 전용 데이터베이스

    - jdbc:h2:tcp://localhost/~/testcase : test케이스에서 사용하는 전용 데이터베이스

 

 

데이터베이스를 분리하여 만든 후 item 테이블을 생성하자.

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)
);

 

또한 test의 application.properties를 변경해주도록 한다.

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

#jdbcTemplate sql log
logging.level.org.springframework.jdbc=debug

 

이제 테스트를 다시 실행해보자. 일단 findItems() 테스트만 단독으로 실행해보면 성공하는 것을 확인할 수 있다.

하지만 다시 findItems()를 실행하면 테스트에 실패한다.

 

- 두번째 테스트가 실패하는 이유는 testcase 데이터베이스에 접속해서 item테이블의 데이터를 확인하면 알 수 있다.

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

- 이 문제는 save()같은 다른 테스트가 먼저 실행되고 나서 findItems()를 실행할 때도 나타난다. 다른 테스트에서 이미 데이터를 추가했기 때문이다. 결과적으로 테스트 데이터가 오염된 것이다.

- 이 문제를 해결하려면 각각의 테스트가 끝날때마다 해당 테스트에서 추가한 데이터를 삭제해야 한다. 그래야 다른 테스트에 영향을 주지 않는다.

 

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

- 테스트는 다른 테스트와 격리해야 한다.

- 테스트는 반복해서 실행할 수 있어야 한다.

 

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

이 문제를 데이터 롤백으로 해결한다.

 

 

 

테스트 - 데이터 롤백

트랜잭션과 롤백 전략

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

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

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

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

 

예를 들어서 다음 순서와 같이 각각의 테스트 실행 직전에 트랜잭션을 시작하고, 각각의 테스트 실행 직후에 트랜잭션을 롤백해야 한다. 그래야 다음 테스트에 데이터로 인한 영향을 주지 않는다.

 

1. 트랜잭션 시작

2. 테스트 A 실행

3. 트랜잭션 롤백

 

4. 트랜잭션 시작

5. 테스트 B 실행

6. 트랜잭션 롤백

 

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

@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.rllback(status)로 트랜잭션을 롤백한다.

 

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

 

모든 ITEM 데이터 삭제

delete from item

 

그리고 다음 쿼리를 실행해서 데이터가 모두 삭제되었는지 확인하자.

SELECT * FROM ITEM

 

ItemRepositoryTest 실행

이제 ItemRepositoryTest의 테스트를 모두 실행해보자. 여러번 반복해서 실행해도 테스트가 성공하는 것을 확인할 수 있다.

 

 

 

테스트 - @Transactional

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

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

 

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);*/
    }

 

ItemRepositoryTest 테스트 코드에 스프링이 제공하는 @Transactional를 추가하자.

org.springframework.transaction.annotation.Transactional

@Transactional
@SpringBootTest
class ItemRepositoryTest {

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

 

이제 ItemRepositoryTest의 테스트를 모두 실행해보자. 여러번 반복해서 실행해도 테스트가 성공하는 것을 확인할 수 있다.

 

 

@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을 테스트에서 사용하면 테스트가 끝나고 바로 롤백되기 때문에 테스트 과정에서 저장한 모든 데이터가 사라진다. 당연하게 이렇게 되어야 하지만, 가끔 DB에 데이터가 잘 보관되었는지 최종 결과를 눈으로 확인하고 싶을때도 있다.

이럴때는 다음과 같이 @Commit을 클래스 또는 메서드에 붙이면 테스트 종료후 롤백대신 커밋이 호출된다. 참고로 @Rollback(value=false)를 사용해도 된다.

 

 

 

테스트 - 임베디드 모드 DB

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

 

임베디드 모드

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

 

 

임베디드 모드 직접 사용

@Slf4j
@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;
    }
}

- @Profile("test")

    - 프로필이 test인 경우에만 데이터소스를 스프링 빈으로 등록한다.

    - 테스트 케이스에서만 이 데이터소스를 스프링 빈으로 등록해서 사용한다.

- dataSource()

    - jdbc:h2:mem:db : 이 부분이 중요하다. 데이터소스를 만들 때 이렇게만 적으면 임베디드 모드(메모리 모드)로 동작하는 H2 데이터베이스를 사용할 수 있다.

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

    - 이 데이터소스를 사용하면 메모리 DB를 사용할 수 있다.

 

실행

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

앞에서 설정은 끝났다. 이제 테스트를 실행만 하면 새로 등록한 메모리 DB에 접근하는 데이터소스를 사용하게 된다.

확실하게 하기 위해 H2 DB의 서버를 내리자.

 

-> 생각해보면 테스트를 실행하기 이전에 테이블이 필요하다. 수동으로 만들수도 있지만, 스프링 부트는 이 문제를 해결할 아주 편리한 기능을 제공한다.

 

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

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

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

 

다음 파일을 생성하자.

위치가 src/test이다. 이 부분을 주의해야 한다. 파일 이름도 정확해야 한다.

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)
);

 

ItemRepositoryTest를 실행해보면 테스트가 정상 수행되는 것을 확인할 수 있다.

 

 

 

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

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

 

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

/*@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;
}*/

 

그리고 테스트에서 데이터베이스에 접근하는 설정 정보도 주석처리하자.

test - application.properties

src/test/resources/application.properties

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

#jdbcTemplate sql log
logging.level.org.springframework.jdbc=debug

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

 

이렇게 하면 데이터베이스에 접근하는 모든 설정 정보가 사라지게 된다.

별 다른 정보가 없으면 스프링 부트는 임베디드 모드로 접근하는 데이터소스(dataSource)를 만들어 제공한다. 앞서 우리가 직접 만든 데이터소스와 비슷하다 생각하면 된다.

 

--> ItemRepositoryTest를 실행해보면 테스트가 정상 수행되는 것을 확인할 수 있다.

 

참고로 로그를 보면 다음 부분을 확인할 수 있는데, jdbc:h2:mem 뒤에 임의의 데이터베이스 이름이 들어가있다. 이것은 혹시라도 여러 데이터소스가 사용될 때 같은 데이터베이스를 사용하면서 발생하는 충돌을 방지하기 위해 스프링 부트가 임의의 이름을 부여한 것이다.

conn0: url=jdbc:h2:mem:e5cb857b-a99f-46ef-bdb4-03e95ec2dc29 user=SA

 

임베디드 데이터베이스 이름을 스프링 부트가 기본으로 제공하는 jdbc:h2:memb:testdb로 고정하고 싶으면, application.properties에 다음 설정을 추가하면 된다.

spring.datasource.generate-unique-name=false