Kotlin에서 Mockito 사용하여 테스트 할 때 유의할 점

[emiling]

Kotlin에서 Mockito 사용하여 테스트 할 때 유의할 점

• Kotlin에서 Mocktio로 아래와 같이 ArgumentCaptor<T> 를 사용하여 테스트 코드를 작성했는데

data class Bucket(
    val id: Long = 0,
    val name: String = "",
    val url: String? = null
)

class BucketService {
    fun execute(bucket: Bucket) { ... }
}

class BucketTest {
    private lateinit var service: BucketService
    // ...
    @Test
    fun `버킷이 정상적으로 들어왔을 때 execute 함수를 테스트한다`() {
        // given & when 
        ...
        // then
        val captor = ArgumentCaptor.forClass(Bucket::class.java)
        verify(service, times(1)).execute(captor.capture())
        ...
    }
}

• 이런 에러가 발생한다 🤔

java.lang.NullPointerException: captor.capture() must not be null
  at com.example.bucket.service.BucketTest.버킷이 정상적으로 들어왔을 때 execute 함수를 테스트한다 (BucketTest.kt:39)
  at java.util.ArrayList.forEach(ArrayList.java:1259)
  at java.util.ArrayList.forEach(ArrayList.java:1259)

[emiling]

Decompile Kotlin Code

같은 코드를 JAVA로 작성하면 문제가 없는데 Kotlin 코드 상에서 문제가 되는 것이 이상해서 테스트 코드 부분을 Kotlin Decompile 했더니 다음과 같았다.

      ArgumentCaptor var5 = ArgumentCaptor.forClass(Bucket.class);
      Intrinsics.checkNotNullExpressionValue(var5, "ArgumentCaptor.forClass(…Bucket::class.java)");
      ArgumentCaptor captor = var5;
      BucketService var6 = this.service;
      if (var6 == null) {
         Intrinsics.throwUninitializedPropertyAccessException("executor");
      }

      var6 = (BucketService)Mockito.verify(var6, Mockito.times(1));
      Object var10001 = captor.capture();
      Intrinsics.checkNotNullExpressionValue(var10001, "captor.capture()"); // 여기서 NPE발생
      var6.execute((Bucket)var10001);

• execute 함수의 파라미터는 Bucket? 이 아니라 Bucket 이므로 null을 허용하지 않고 있다
• 따라서 execute 함수를 실행하기 이전에 Intrinsics.checkNotNullExpressionValue 로 captor.capture 값을 체크한다
• 그러나 captor.capture 는 mockito에서 선언된 타입이라 Platform Type 으로 Kotlin 컴파일러로 간주되어 nullable로 처리된다
• 그리고 execute가 실행되기 전까지는 captor.capture 값이 null인 것이 당연하므로 null check 를 하지 않아야 하는데 수행하고 있다

Solution

mockito-kotlin 사용

• 이러한 문제가 있어 mockito에서는 Kotlin을 위한 mockito-kotlin을 제공한다
• 여기서 한 번 wrapping 된 ArgumentCaptor 를 사용하는 것도 하나의 방법

DIY

• 먼저 ArugmentCaptor의 타입을 non-nullable로 "명시적으로" 선언한다
• 이렇게 명시적으로 선언하지 않으면 코틀린은 ArgumentCaptor<Bucket!>! 이런 식으로 전환된다

  val captor = ArgumentCaptor<Bucket> = ArgumentCaptor.forClass(Bucket::class.java)

• 이후 아래 함수를 선언해서 사용한다

  @Suppress("UNCHECKED_CAST")
  private fun <T> capture(captor: ArgumentCaptor<T>): T = captor.capture()

• 이로써 Platform Type의 파라미터를 그대로 반환하지 않고 T가 non-nullable 이면 해당 리턴값도 non-nullable이 된다.
• 위 함수를 Kotlin Decompile 하면 아래 처럼 되고

  private final Object capture(ArgumentCaptor captor) {
    return captor.capture();
  }

• 실제 테스트 코드는 아래와 같이 decompile 되어 처리되므로 NPE 에러가 사라지게 된다

  ...
  ((BucketService)Mockito.verify(var6, Mockito.times(1))).execute((Bucket)this.capture(captor));
  ...

참고 : Mockito - Kotlin test throws Null Pointer Exception when trying to capture Pageable argument