📌 [MarketBridge] 04. 개발일지 - @CreatedDate 테스트하기

📖 @CreatedDate, @LastModifiedDate은 테스트를 어떻게 해야할까?

@CreatedDate, @LastModifiedDate은 JPA에서 처리해주는 녀석들이라서 테스트 작성시 어떻게 테스트해야 할까 고민이 많았다. (현재 @CreatedDate, @LastModifiedDate는 BaseEntity에 존재하며, 테스트할 떠오르지 않았다..)

`public static OrderCancelReturnDetailResponseDto of(Order order, List<OrderDetail> orderDetails, String memberShip) {
        return OrderCancelReturnDetailResponseDto.builder()
        
                .orderDate(order.getCreatedAt())
                .cancelDate(order.getUpdatedAt())
                
                .orderNo(order.getOrderNo())
                .cancelReason(orderDetails.get(0).getReason())
                .productListResponseDtos(
                        orderDetails.stream()
                                .map(ProductListResponseDto::of)
                                .toList()
                )
                .cancelRefundInfoResponseDto(
                        CancelRefundInfoResponseDto.of(orderDetails, memberShip)
                )
                .build();
    }

이런 코드는 테스트 코드를 작성 할 때 Date에 대한 테스트는 거의 불가능에 가깝다. Mockito, Mockbean등을 통해 처리를 해주면 될테지만 이러한 방법들을 최대한 지양하는 입장에서 어떻게 해야할지 고민이 생겼다.

시간에 대한 것을 외부에서 제공받는 구조로 바꿔야 한다고 생각했다.

✏️ 리팩토링 1

public static OrderCancelReturnDetailResponseDto of(Order order, List<OrderDetail> orderDetails, String memberShip, LocalDateTime createTime, LocalDateTime updateTime) {
        return OrderCancelReturnDetailResponseDto.builder()
        
                .orderDate(createTime)
                .cancelDate(updateTime)
                
                .orderNo(order.getOrderNo())
                .cancelReason(orderDetails.get(0).getReason())
                .productListResponseDtos(
                        orderDetails.stream()
                                .map(ProductListResponseDto::of)
                                .toList()
                )
                .cancelRefundInfoResponseDto(
                        CancelRefundInfoResponseDto.of(orderDetails, memberShip)
                )
                .build();
    }

이렇게 하면 테스트가 어느정도 가능해질 것으로 생각되지만 보기 좋지 않았다.

✏️ 리팩토링 2

public static OrderCancelReturnDetailResponseDto of(Order order, List<OrderDetail> orderDetails, String memberShip, DateTimeHolder dateTimeHolder) {
        return OrderCancelReturnDetailResponseDto.builder()
        
                .orderDate(dateTimeHolder.getCreateTime(order))
                .cancelDate(dateTimeHolder.getUpdateTime(order))
                
                .orderNo(order.getOrderNo())
                .cancelReason(orderDetails.get(0).getReason())
                .productListResponseDtos(
                        orderDetails.stream()
                                .map(ProductListResponseDto::of)
                                .toList()
                )
                .cancelRefundInfoResponseDto(
                        CancelRefundInfoResponseDto.of(orderDetails, memberShip)
                )
                .build();
    }

파라미터를 추상화하는 객체를 만들어야 좋은 구조로 갈 수 있다는 생각을 하게됐다.

좀 더 자세히 DateTimeHolder를 보면

public interface DateTimeHolder {

    LocalDateTime getTimeNow();

    LocalDateTime getCreateTime(BaseEntity entity);

    LocalDateTime getUpdateTime(BaseEntity entity);

    LocalDateTime getDeleteTime(BaseEntity entity);
}

@Component
public class SystemDataTimeHolder implements DateTimeHolder {

    @Override
    public LocalDateTime getTimeNow() {
        return LocalDateTime.now();
    }

    @Override
    public LocalDateTime getCreateTime(BaseEntity entity) {
        return entity.getCreatedAt();
    }

    @Override
    public LocalDateTime getUpdateTime(BaseEntity entity) {
        return entity.getUpdatedAt();
    }

    @Override
    public LocalDateTime getDeleteTime(BaseEntity entity) {
        return entity.getDeletedAt();
    }
}

다음과 같이 구성하여 Service에서 주입받아 사용할 수 있게 하였다.

이 결과 테스트를 작성하는데 좋은 구조로 바뀌게 되었다.
테스트를 작성하기 전 DateTimeHolder를 mocking한 테스트용 객체가 필요로 한다.

public class TestDateTimeHolder implements DateTimeHolder {

    private LocalDateTime now;
    private LocalDateTime createTime;
    private LocalDateTime updateTime;
    private LocalDateTime deleteTime;

    @Builder
    private TestDateTimeHolder(LocalDateTime now, LocalDateTime createTime, LocalDateTime updateTime, LocalDateTime deleteTime) {
        this.now = now;
        this.createTime = createTime;
        this.updateTime = updateTime;
        this.deleteTime = deleteTime;
    }

    @Override
    public LocalDateTime getTimeNow() {
        return now;
    }

    @Override
    public LocalDateTime getCreateTime(BaseEntity entity) {
        return createTime;
    }

    @Override
    public LocalDateTime getUpdateTime(BaseEntity entity) {
        return updateTime;
    }

    @Override
    public LocalDateTime getDeleteTime(BaseEntity entity) {
        return deleteTime;
    }
}

LocalDateTime createTime = LocalDateTime.of(2024, 1, 30, 2, 15);
        LocalDateTime updateTime = LocalDateTime.of(2024, 1, 30, 2, 20);
        TestDateTimeHolder timeHolder = TestDateTimeHolder.builder()
                .createTime(createTime)
                .updateTime(updateTime)
                .build();

        // when
        OrderCancelReturnDetailResponseDto result = OrderCancelReturnDetailResponseDto.of(order, orderDetails, WOW.getText(), timeHolder);

        // then
        assertThat(result).extracting("orderDate", "cancelDate", "orderNo", "cancelReason")
                .contains(createTime, updateTime, "123", "단순변심");

이런식으로 주입받아서 사용하면 @Mockbean, Mockito등을 사용하지 않아도 테스트가 가능해진다!!!

고민의 결과가 나와서 기분이 매우 좋아버린다~!~!