読者です 読者をやめる 読者になる 読者になる

kotlinでMockテストのまとめ

1ヶ月ほどkotlinで開発をしてきて、不慣れなkotlinであってもテストをしっかり書いていこうと目標を立て臨んだ1ヶ月。
おかげでkotlinにおけるMockテストの知見が溜まってきたので、この機会にまとめていきます。

javaではJMockitでMockテストを書いてきたけど、いざkotlinでとなると弊害が多くMockitoやPowerMockに置き換えながら試していった。

どんなテストをするのか

トランザクションで扱う複数の関数のテストを次のように実現できるとプログラムを網羅的にテストできるでしょう。

  • クラス全体のパブリック関数のモック
  • クラス一部分のパブリック関数のモック
  • 呼び出す関数の引数のモック(anyString()やany()を使う)
  • クラスのプライベート関数のモック
  • クラスのプライベート関数のアサーションテスト

何をつかったか

次のテストライブラリを使いました。

github.com

  • Powermockはトランザクションで実行されるプライベート関数のモックに使います。
  • PowermockにはMockitoが内包されています。Mockitはクラス全体のパブリック関数のモックや一部分のパブリック関数のモックに使います。

jmockit.org

github.com
テストケースはJUnitではなく、kotlintestを使いました。BehaviorSpecを使うとテストコードの見通しが良くなりますね。後述しますがPowermockを使う場合はJUnitでないと動かないところがあるのでJUnitも使っています。

それではテストコードのまとめです

テスト対象とするクラスの説明

次のようなinterfaceを用意しました。

interface Ppap {
    fun leftHand(sing: Boolean): String
    fun rightHand(sing: Boolean): String
    fun woo(right: String, left: String): String
}

ピコ太郎のPPAPソングをクラス表現しました。

  • leftHand(sing: Boolean)関数は左手に持っているモノを返す関数です。引数のsingがtrueだと歌詞を返し、falseだとモノの名前を返します。(rightHand(sing: Boolean)関数も右手に持つモノで振る舞いは一緒です)
  • woo(right: String, left: String)は右手と左手のモノを合わせた歌詞を返します。

Ppapの実装クラスです。

open class PpapImpl constructor(val right: String, val left: String) : Ppap {

    val iHaveA = "I have"

    override fun leftHand(sing: Boolean): String {
        if (sing)
            return "$iHaveA $left."
        else
            return getObj(left)
    }

    override fun rightHand(sing: Boolean): String {
        if (sing)
            return "$iHaveA $right."
        else
            return getObj(right)
    }

    override fun woo(right: String, left: String): String = "%s%s.".format(left, right)

    private fun getObj(obj: String) = obj.split(Regex("\\s+")).get(1)
}

こちらのテストコードを見て頂くとプログラムのイメージが伝わるはずです。

PpapImplを使ってPPAPソングを歌うPpapSongクラスを用意しました。

class PpapSong constructor(val ppap: PpapImpl) {

    fun sing(): String {
        return "%s %s woo %s".format(
                ppap.rightHand(true),
                ppap.leftHand(true),
                ppap.woo(ppap.rightHand(false), ppap.leftHand(false)))
    }
}

PpapImplの関数をrightHand()からleftHand()、woo()と順番に呼び出しています。
PpapImplクラスの関数をモックしながらPpapSongクラスのテストをしました。

クラス全体のパブリック関数のモック

はじめにクラス全体のパブリック関数のモックです。Mockitoを活用していきます。

val ppapMock: PpapImpl = mock(PpapImpl::class.java) // PpapImplをモック対象にする

val ppapSong = PpapSong(ppapMock)

Mockito.`when`(ppapMock.rightHand(sing = true)).thenReturn("I have a Ebi.") // 各メソッドをモック
Mockito.`when`(ppapMock.leftHand(sing = true)).thenReturn("I have a Bin.")

Mockito.`when`(ppapMock.rightHand(sing = false)).thenReturn("Ebi")
Mockito.`when`(ppapMock.leftHand(sing = false)).thenReturn("Bin")

Mockito.`when`(ppapMock.woo("Ebi", "Bin")).thenReturn("EbiInBin.")

val actual = ppapSong.sing()

actual shouldBe "I have a Ebi. I have a Bin. woo EbiInBin."

Mockitoをkotlinで使ってみた、のようなコードです。

クラス一部分のパブリック関数のモック

次に一部分の関数をモックするパターンです。Mockitoのspyを使います。

val target: PpapImpl = PpapImpl(right = "a Pen", left = "an Apple")
val spy = spy(target) // PpapImplをspy対象にする

val ppapSong = PpapSong(spy)

Mockito.`when`(spy.leftHand(sing = true)).thenReturn("I have a PineApple.") // 左手をAppleからPineAppleにモックする
Mockito.`when`(spy.leftHand(sing = false)).thenReturn("PineApple")

val actual = ppapSong.sing()

actual shouldBe "I have a Pen. I have a PineApple. woo PineApplePen."

leftHandの呼び出しのみモックしました。他の関数はすべてモックされず実行しています。
最後が`ApplePen`ではなく`PineApplePen`になっているのが確認できますね。

関数の引数のモック(anyString()やany()を使う)

次に関数の引数をany()などを使い任意の引数にマッチさせたりマッチが難しい場合にany()で任意の値でマッチさせるケースです。
※マッチが難しいケースとしては引数にプリミティブな型を使っていないケースや、現在時刻のLocalDateTimeを引数にしているケースなどが考えられます。

val target: PpapImpl = PpapImpl(right = "a Pen", left = "an Apple")
val spy = spy(target)
val ppapSong = PpapSong(spy)

Mockito.`when`(spy.woo(anyString(), anyString())).thenReturn("PenPineAppleApplePen.") // wooメソッドの引数は任意でマッチさせてReturnの文字列を書き換えています

val actual = ppapSong.sing()

actual shouldBe "I have a Pen. I have an Apple. woo PenPineAppleApplePen."

このケースではプリミティブな型のためanyString()を利用しています。
プリミティブ型以外の場合はany()やanyObject()を使うところですが、kotlinでは嵌まりました。
詳細は以下の記事に詳しく載っていますので参照ください。
Kotlin + Mockitoでany<T>()やeq<T>()を使いたい - JDBな人生

テスト対象の関数の引数がNon-Nullなオブジェクトかどうかkotlinがチェックするため起こる現象で解決する方法も記載頂いています。
私はこのケースでド嵌まりしまして、この記事に救われました。

クラスのプライベート関数のモック

次にクラスのプライベート関数のモックです。このケースはPowerMockを使います。

@RunWith(PowerMockRunner::class) 
@PrepareForTest(PpapImpl::class)
class PpapSong_Private_Method_MockTest {

    @Test
    fun rightHand_test() {

        val target: PpapImpl = PpapImpl(right = "a Pen", left = "an Apple")
        val spy = PowerMockito.spy(target)

        PowerMockito.doReturn("Ebi").`when`(spy, "getObj", "a Pen")

        val actual = spy.rightHand(false)

        assertThat(actual, `is`("Ebi"))
    }
}
  • PpapImplのrightHand関数をモックしています。doReturn()を`Ebi`にしました。
  • クラスに@RunWithと@PrepareForTestのアノテーションを指定します。
  • @PrepareForTestにはテスト対象のクラスを指定します。今回はPpapImplクラスになります。
  • PowerMockRunnerクラスの実装を見ると今のところはJUnitのみをサポートしているようなので、PowerMockを使う場合はJUnitでテストケースを書きます。
クラスのプライベート関数のアサーションテスト

最後にクラスのプライベート関数のアサーションテストです。

given("getObj method") {

   val target = PpapImpl(right = "a Pen", left = "an Apple")
   var param: String

   `when`("param is 'a Pen'") {
       then("method should return 'Pen'") {
           param = "a Pen"
           val actual = Deencapsulation.invoke<String>(target, "getObj", param)
           actual shouldBe "Pen"
       }
   }

   `when`("param is 'an Apple'") {
       then("method should return 'Apple'") {
           param = "an Apple"
           val actual = Deencapsulation.invoke<String>(target, "getObj", param)
           actual shouldBe "Apple"
       }
   }

   `when`("param is 'Ebi'") {
       then("method throws exception") {
           param = "Ebi"
           shouldThrow<ArrayIndexOutOfBoundsException> {
               Deencapsulation.invoke<String>(target, "getObj", param)
           }
       }
   }
}

JMockitを使ってプライベート関数のアサーションテストをしています。

まとめ

objectやenumクラスの例はありませんでしたがプロジェクト内ではテストケースを書いており上記で紹介した書き方と同様な書き方でテストができています。
kotlinでもモックテストをガシガシ書けますし、これからはJava製のモックライブラリではなくkotlin純正のライブラリが出てくることを期待しています。
mockito-kotlinというkotlinで書かれたモックライブラリがありましたがMockitoをラッピングしているライブラリとなっています。どこかのエントリでこちらの使用感の報告もできればしたいです。

ソースを公開しています

ソースコードを公開しています。
github.com