JPA Auditing @createdDate 테스트 코드 작성하기

😎  배경

API를 구현할 때 요구사항에 조건이나 기능에 생성 시간, 수정 시간이 포함되어 있는 경우, 올바른 시간 값을 반환하는지 확인해야 할 필요가 있다.

 

보통 JPA를 사용한다면 생성자/생성 일자/수정자/수정 일자를 간단하게 추가하기 위해 BaseEntity, Audit 기능을 많이 사용할 것이다. 필자가 진행 중인 프로젝트에도 매번 Audit를 활용하고 있다.

 

그런데 테스트 코드를 작성하다 보면 조회 조건이나 결과에 생성/수정 시간 값을 올바르게 적용하고 반환하는지 궁금할 때가 있다. 그럴 때 어떻게 테스트를 해야 할지 고민하다가 해당 포스팅을 작성하게 되었다.

방법

필자가 찾아본 방법 중 사용하기 가장 괜찮은 방법은 2가지 방법이었다.

 

첫 번째는 DateTimeProvider Mocking을 통해서 시간 값을 Mocking 하는 방법이다.

두 번째는 JdbcTemplate을 이용해서 시간 값을 조작하는 방법이다.

1. Mocking 

@SpringBootTest
@Transactional
public class AuditTest {

    @Autowired
    ShibaHolicRepository shibaHolicRepository;

    @MockBean
    private DateTimeProvider dateTimeProvider;

    @SpyBean
    private AuditingHandler handler;

    @BeforeEach
    void setUp() throws Exception {
        MockitoAnnotations.openMocks(this);
        handler.setDateTimeProvider(dateTimeProvider);
    }

    @Test
    void auditingTest() {
        // given
        LocalDateTime testTime = LocalDateTime.of(2023,10,30,0,0,0);
        when(dateTimeProvider.getNow()).thenReturn(Optional.of(testTime));

        ShibaHolic shibaHolic1 = ShibaHolic.builder()
                .name("시바홀릭1")
                .age(10L)
                .build();
        shibaHolicRepository.save(shibaHolic1);

        ShibaHolic shibaHolic2 = ShibaHolic.builder()
                .name("시바홀릭2")
                .age(20L)
                .build();
        shibaHolicRepository.save(shibaHolic2);

        // when
        List<ShibaHolic> result = shibaHolicRepository.findAll();

        // then
        assertThat(result).hasSize(2)
                .extracting("createdAt")
                .containsOnly(testTime);
    }
}

 

해당 방식은 DateTimeProvider를 Mocking 하고 AuditingHandler에 등록해서 사용한다.

 

    @Test
    void auditingTest() {
        // given
        LocalDateTime testTime = LocalDateTime.of(2023,10,30,0,0,0);
        when(dateTimeProvider.getNow()).thenReturn(Optional.of(testTime));

        ShibaHolic shibaHolic1 = ShibaHolic.builder()
                .name("시바홀릭1")
                .age(10L)
                .build();
        shibaHolicRepository.save(shibaHolic1);

        LocalDateTime testTime2 = LocalDateTime.of(2023,10,31,0,0,0);
        when(dateTimeProvider.getNow()).thenReturn(Optional.of(testTime2));

        ShibaHolic shibaHolic2 = ShibaHolic.builder()
                .name("시바홀릭2")
                .age(20L)
                .build();
        shibaHolicRepository.save(shibaHolic2);

        // when
        List<ShibaHolic> result = shibaHolicRepository.findAll();

        // then
        assertThat(result).hasSize(2)
                .extracting("createdAt")
                .contains(testTime, testTime2);
    }

 

만약 등록하는 엔티티에 따라서 시간 차이를 주고 싶다면, Repository save()를 호출하기 전에 when() 절을 한 번 더 선언해서 다른 시간을 추가하면 된다.

2. JdbcTemplate

@SpringBootTest
@Transactional
public class AuditTest2 {

    @Autowired
    ShibaHolicRepository shibaHolicRepository;

    @Autowired
    JdbcTemplate jdbcTemplate;

    @Autowired
    EntityManager entityManager;

    @Test
    void auditingTest() {
        // given
        ShibaHolic shibaHolic1 = ShibaHolic.builder()
                .name("시바홀릭1")
                .age(10L)
                .build();
        ShibaHolic savedShibaHolic1 = shibaHolicRepository.save(shibaHolic1);

        // 10월 29일
        String sql = "update tb_shiba_holic set created_at = DATE_SUB('2023-10-30 00:00:00', INTERVAL 1 DAY) where id = " + savedShibaHolic1.getId() + " ";
        jdbcTemplate.execute(sql);

        ShibaHolic shibaHolic2 = ShibaHolic.builder()
                .name("시바홀릭2")
                .age(20L)
                .build();
        ShibaHolic savedShibaHolic2 = shibaHolicRepository.save(shibaHolic2);
        // 10월 31일
        String sql2 = "update tb_shiba_holic set created_at = DATE_ADD('2023-10-30 00:00:00', INTERVAL 1 DAY) where id = " + savedShibaHolic2.getId() + " ";
        jdbcTemplate.execute(sql2);

        entityManager.flush();
        entityManager.clear();

        // when
        List<ShibaHolic> result = shibaHolicRepository.findAll();

        // then
        assertThat(result).hasSize(2)
                .extracting("createdAt")
                .contains(LocalDateTime.of(2023,10,29,0,0,0),
                        LocalDateTime.of(2023,10,31,0,0,0));
    }
}

 

해당 방식은 jdbcTemplate을 사용해서 직접 SQL 문을 작성해서 시간을 변경하는 방법이다.

 

그런데 해당 방법은 그냥 엔티티에서 시간을 업데이트하면 되지 않을까?라는 고민이 들게 한다.

 

 

보통 BaseEntity는 updatable=false 조건을 추가하는 게 일반적이기 때문에 업데이트를 하기 위해서는 해당 옵션을 풀어야 한다. 과연 테스트를 위해서 이러한 제약 조건 해제까지 해야 할까? 판단하는 건 개발자의 몫이다.

장/단점

필자는 각 방식에 장/단점이 있다고 생각한다.

 

Mocking 방식은 데이터베이스와 통신 과정이 없으므로 속도가 빠르고, SQL문 작성 없이 내가 필요한 시간으로 쉽게 조작할 수 있어서 편리하다는 장점이 있다.

 

하지만, 만약 상위(부모) 테스트 클래스에서 BaseEntity를 사용하는 다른 경우가 있다면 사용이 불가능하다는 단점이 있다.

(별도로 분리한다면 스프링 컨텍스트가 1개 더 띄워지기 때문에, 전체 테스트에서는 시간적 손해를 볼 수 있다.)

 

JdbcTemplate 방식은 데이터베이스 값을 직접 조작하기 때문에 별도 Mocking 작업이 필요 없고, 상위(부모) 테스트 코드를 그대로 사용할 수 있다는 장점이 있다.

 

하지만, 테스트 코드에서 사용하는 데이터베이스 플랫폼에 맞게 Update SQL문을 작성해야 하고, 만약 데이터베이스를 변경한다면 테스트 코드가 쉽게 깨질 수 있다는 단점이 있다.

결론

어떤 경우에 어떻게 쓰면 좋을까?

 

필자는 Auditing을 검증하는 과정이 테스트 코드에 많이 사용되거나, 단위 테스트로 사용되거나, 상위 테스트 코드와 분리되어 있는 방식이라면 Mocking 방식 사용을 추천하고 싶다.

 

하지만 몇 번 검증이 필요하지 않은 일부 케이스에만 사용한다면 JdbcTemplate 사용을 추천하고 싶다.

 

각 애플리케이션 테스트 개발 환경에 알맞은 방법을 선택해서 사용해 보면 좋을 것 같다.

REFERENCE

https://mariadb.com/kb/en/date_add/

https://mariadb.com/kb/en/date_sub/

https://mkyong.com/spring-boot/mocking-spring-data-datetimeprovider/

https://stackoverflow.com/questions/42374387/how-to-set-createddate-in-the-past-for-testing