Fixture Monkey With Kotlin

테스트를 작성하다 보면 프로덕션 코드보다 테스트 픽스처를 만드는 데 더 많은 시간이 드는 경우가 있습니다. 테스트 작성이 번거롭고 시간이 많이 걸릴수록 테스트 코드를 생략하게 되고, 결국 결함에 취약한 시스템을 구현할 위험이 커집니다.

주문 로직을 테스트하기 위해 Order 픽스처를 만들어야 했는데, Order 객체 내부 필드만 24개였고 내부 객체의 필드까지 합치면 정의해야 할 필드가 수십 개에 달했습니다. 게다가 케이스마다 다른 상태를 가진 Order 픽스처를 추가로 만들어야 해서 테스트 준비에 상당한 시간이 소요되었습니다.

그러던 중 Fixture Monkey라는 PBT(Property Based Testing) 라이브러리를 알게 되었고, 이를 활용해 테스트를 훨씬 편리하게 작성할 수 있었습니다. 오늘은 개인적으로 유용하게 사용했던 핵심 기능을 간략히 소개하고자 합니다.

FixtureMonkey의 주요 기능

랜덤하고 복잡한 제약 조건을 가진 객체를 자동 생성합니다
설정한 제약 조건을 검증할 수 있습니다
테스트 케이스마다 객체를 유연하게 제어할 수 있습니다

FixtureMonkey는 엔티티 필드에 지정된 Bean Validation 어노테이션에 따라 유효한 속성값을 가진 객체를 생성합니다.

실패 테스트 작성처럼 특정 케이스에서 조건을 추가하거나 제약을 벗어난 필드를 설정해야 할 경우, ArbitraryBuilder를 사용해 픽스처를 제어할 수 있습니다. ArbitraryBuilder는 빌더 패턴을 통해 객체의 필드값을 원하는 대로 설정하여 생성할 수 있습니다.

예제

Without FixtureMonkey Test

FixtureMonkey의 편리함을 살펴보기에 앞서, 먼저 기존 방식으로 테스트를 작성해 보겠습니다.

다음은 주문 과정에서 입력된 배송지 주소가 유효한지 검증하는 테스트입니다.

data class Order(  
    val product: List<Product>,  
    val purchaserName: String,  
    val receiver: Receiver,  
    val totalPrice: Long,  
    val coupon: List<Coupon>,  
    val delivery: Delivery,  
)

class OrderFixture {  
    companion object {  
        fun create(  
            id: Long = 1L,  
            product: List<Product> = listOf(  
                Product(name = "초콜릿", price = 300L),  
                Product(name = "키보드", price = 20000L),  
            ),  
            purchaserName: String = "홍길동",  
            receiver: Receiver = Receiver(name = "홍길동", "01012341234"),  
            totalPrice: Long = 20300L,  
            coupon: List<Coupon> = listOf(Coupon()),  
            delivery: Delivery = Delivery("경기도", "203동 1023호", true),  
        ): Order {  
            return Order(  
                id = id,  
                product = product,  
                purchaserName = purchaserName,  
                receiver = receiver,  
                totalPrice = totalPrice,  
                coupon = coupon,  
                delivery = delivery,  
            )  
        }  
    }  
}

class OrderServiceTestWithOutFixtureMonkey : DescribeSpec({  
    val sut = OrderService()  
    val log = LoggerFactory.getLogger(this.javaClass)  
  
    describe("배송 주소 유효성 검사") {  
        it("유효성 검증을 통과한다.") {  
            val order = OrderFixture.create()  
  
            shouldNotThrowAny {  
                sut.validateDeliveryAddress(order)  
            }  
        }  
        it("지번 주소를 입력받았을 경우, 상세 주소가 없으면 안 된다") {  
            val order = OrderFixture.create(delivery = Delivery(baseAddress = "경기도", road = false, detailAddress = null))  
  
            val exception = shouldThrow<IllegalArgumentException> {  
                sut.validateDeliveryAddress(order)  
            }  
  
            exception.message shouldBe "지번 주소에는 상세 주소가 반드시 필요합니다."  
        }  
    }})

테스트 성공과 실패 케이스를 위한 OrderFixture 객체를 정의하여 사용했습니다. Order 객체에 정의된 필드뿐만 아니라 연관된 객체의 필드값들도 함께 정의해야 하기 때문에 상당히 번거로운 작업입니다. 만약 연관된 엔티티가 더 많고 정의해야 할 필드 수가 훨씬 많아진다면, 테스트 픽스처를 정의하는 데 큰 비용이 소모됩니다.

FixtureMonkey Test

이번에는 FixtureMonkey를 사용해 간단하게 픽스처를 생성하여 테스트를 작성해 보겠습니다.

먼저 build.gradle.kts에 의존성을 추가합니다.

// fixture monkey  
testImplementation("com.navercorp.fixturemonkey:fixture-monkey-starter-kotlin:1.0.14")  
testImplementation("com.navercorp.fixturemonkey:fixture-monkey-jakarta-validation:0.6.3")  
testImplementation("com.navercorp.fixturemonkey:fixture-monkey-jackson:0.6.3")

DefaultMonkeyCreator

fun monkey() : FixtureMonkey {  
    return FixtureMonkey.builder()  
        .plugin(KotlinPlugin())  
        .build()  
}

FixtureBuilders

fun <T> defaultFixtureBuilder(clazz: Class<T>): ArbitraryBuilder<T> {  
    return monkey().giveMeBuilder(clazz)  
}

class OrderServiceTestWithFixtureMonkey: DescribeSpec({  
    val sut = OrderService()  
    val log = LoggerFactory.getLogger(this.javaClass)  
  
    describe("배송 주소 유효성 검사") {  
        it("유효성 검증을 통과한다.") {  
            val order = defaultFixtureBuilder(Order::class.java)  
                .setExp(  
                    Order::delivery,  
                    Delivery(baseAddress = "경기도", detailAddress = null, road = true))  
                .sample()  
  
            shouldNotThrowAny {  
                sut.validateDeliveryAddress(order)  
            }  
        }  
        it("지번 주소를 입력받았을 경우, 상세 주소가 없으면 안 된다") {  
            val order = defaultFixtureBuilder(Order::class.java)  
                .setExp(  
                    Order::delivery,  
                    Delivery(baseAddress = "경기도", detailAddress = null, road = false))  
                .sample()  
  
            val exception = shouldThrow<IllegalArgumentException> {  
                sut.validateDeliveryAddress(order)  
            }  
  
            exception.message shouldBe "지번 주소에는 상세 주소가 반드시 필요합니다."  
        }  
    }})

이처럼 FixtureMonkey를 사용하면 랜덤한 필드값을 가진 픽스처 객체를 손쉽게 생성할 수 있습니다.

setter를 통해서 객체를 제어할 수 있는데, 테스트하고자 하는 필드만 명확히 표현하기 때문에 테스트의 관심사를 바로 파악할 수 있다는 장점이 있습니다.