🐀

MockKの「黒魔術」を解明する

に公開
2021/01/17

An English translation of this article was published by @chao2zhang.
읎 Ʞ사의 한국얎 번역은 @sukyology 에 의핎 출판되었습니닀.

この蚘事はKotlin Advent Calendar 2020 23日目の蚘事です。

昚日は優秀な同僚@_a_akiraさんの蚘事でした。䜙談ですが圌の名前をZennのMarkdown゚ディタに入力するずitalic刀定がおかしくお少しバグるので、ぜひテストケヌスに远加しおあげおください。

閑話䌑題、本日はMockKの話です。MockKはテストコヌドに甚いられるKotlin補のモックラむブラリです。MockKではJVM向けモックラむブラリが埓来から持぀機胜に加え、Kotlinの蚀語機胜により䜿い勝手が向䞊しおいるため、私はKotlinを䜿甚するプロゞェクトで愛甚しおいたす。

しかし、MockKに限った話ではありたせんが、JVM向けモックラむブラリがどのように動いおいるのか疑問に思ったこずはないでしょうかたた、モックラむブラリで、他のラむブラリず䜵甚するず問題が発生し、原因の特定に苊劎したこずはないでしょうかそれを理由にMockKや他の䌌た振る舞いをするモックラむブラリを敬遠する方もいらっしゃるず思いたす。かく蚀う私も最近Androidのナニットテストで甚いられるRobolectricずの䜵甚で問題が発生し、詳しい動䜜を調べる必芁がありたした。

そこで本蚘事では、MockKがmockkメ゜ッドで䜕をしおいるのか、そしおeveryやverifyではどのようにしおモックの挙動の蚭定や呌び出し回数のチェックを行うのかに぀いお解説したす。

なお、本蚘事ではMockKの䜿い方は解説したせん。たた、MockKはAndroidやJSでも動䜜するように䜜られおいたすが、基本的にはJVM (HotSpot) での動䜜に぀いお解説したす。


mockk でモックむンスタンスを生成する

モック察象は通垞のクラスか、それずもむンタヌフェむス、抜象クラスか

モック察象が通垞のクラスかどうかは、生成するむンスタンスのクラスに圱響がありたす。
詊しに以䞋のようなテストコヌドを曞いおみたしょう。

open class OpenClass
class FinalClass
abstract class AbstractClass
interface Interface

class ExampleTest {
    @Test
    fun `mock instance class`() {
        val o: OpenClass = mockk()
        val f: FinalClass = mockk()
        val a: AbstractClass = mockk()
        val i: Interface = mockk()
 
        println(o::class)
        println(f::class)
        println(a::class)
        println(i::class)
    }
}

するず、以䞋のような出力が埗られたす

class com.example.mockk_example.OpenClass
class com.example.mockk_example.FinalClass
class com.example.mockk_example.AbstractClass$Subclass0
class com.example.mockk_example.Interface$Subclass1

通垞のクラスはfinalかそうでないかに関わらず指定したクラスそのもののむンスタンスですが、抜象クラスやむンタヌフェむスの堎合はサブクラスが䜜られおいたす。Javaの䞖界においお、むンタヌフェむスや抜象クラスのむンスタンスをそのたた生成するこずはできず、実装ないし継承した具象クラスを定矩する必芁があるのは呚知の事実ですが、モックむンスタンスを生成するずきもその制玄は適甚されたす。

では、これらのAbstractClass$Subclass0やInterface$Subclass1ずいうクラスは䞀䜓どこから出おきたのでしょうかたた、通垞のクラスはサブクラスを生成せずに、どのようにしお戻り倀などのカスタマむズをできるようにしおいるのでしょうか

ByteBuddyによるクラス曞き換え・サブクラス生成

それを知るには、ByteBuddyずいうラむブラリを知る必芁がありたす仕組みに぀いおは詳しい解説をするず蚘事が膚倧になっおしたうため省略したす。

ByteBuddyは、クラスを動的に生成したり、クラスを曞き換える機胜をも぀ラむブラリです。内郚的にはJavaバむトコヌドを生成、曞き換えしおいるのですが、Javaバむトコヌドの知識がなくおも生成できるようなAPIになっおいたす。

MockKでは、たずモックされるクラスずその党おのスヌパヌクラスをByteBuddyを甚いお曞き換え、各メ゜ッドの呌び出し結果を倉曎できるようにしたす。
実装

MockKでは、テスト実行時に以䞋のようなVMオプションを远加するず、指定したディレクトリ内に生成したサブクラスのclassファむルを保存するようになっおいたす。

-Dio.mockk.classdump.path=/path/to/output/classfiles

この機胜を䜿い、実際に通垞のクラスがモックされたずきに、メ゜ッドが曞き換えられるこずを確認しおみたしょう。

open class Root {
    fun root() = "root"
}
class Sub : Root() {
    fun sub() = "sub"
}
class ExampleTest {
    @Test
    fun `class transform`() {
        mockk<Sub>()
    }
}

䞊のclass transformテストを実行したずきに生成されるclassファむルをデコンパむルするず、以䞋のようになりたす。

inline/1/com/example/mockk_example/Sub.class
// 略
public final class Sub
extends Root {
    public final String sub() {
        // äž­ç•¥
	JvmMockKDispatcher dispatcher = JvmMockKDispatcher.get((long)-8685426189273937011L, (Object)this));
	Callable<?> callable;
	if (dispatcher == null) {
            callable = null;
	} else {
            callable = dispatcher.handler((Object)this, Sub.class.getMethod("sub", new Class[0]), new Object[0]);
	}
	
        if (callable != null) {
            return (String)callable.call();
        } else {
            return "sub";
        }
    }
}
inline/2/com/example/mockk_example/Root.class
public class Root {
    public final String root() {
        // äž­ç•¥
	JvmMockKDispatcher dispatcher = JvmMockKDispatcher.get((long)-8685426189273937011L, (Object)this));
	Callable<?> callable;
	if (dispatcher == null) {
            callable = null;
	} else {
            callable = dispatcher.handler((Object)this, Root.class.getMethod("root", new Class[0]), new Object[0]);
	}
	
        if (callable != null) {
            return (String)callable.call();
        } else {
            return "root";
        }
    }
}
inline/3/java/lang/Object.class
public class Object {
    @HotSpotIntrinsicCandidate
    public Object() {
    }
    
    static {
        Object.registerNatives();
    }
    
    public String toString() {
        // äž­ç•¥
	JvmMockKDispatcher dispatcher = JvmMockKDispatcher.get((long)-8685426189273937011L, (Object)this));
	Callable<?> callable;
	if (dispatcher == null) {
            callable = null;
	} else {
            callable = dispatcher.handler((Object)this, Object.class.getMethod("toString", new Class[0]), new Object[0]);
	}
	
	if (callable != null) {
            return (String)callable.call();
        } else {
            return this.getClass().getName() + "@" + Integer.toHexString(this.hashCode());
        }
    }
    
    // 以䞋略
}

実装が若干冗長になっおいるのは、ByteBuddyの制玄によるものです。Subクラスだけではなく、スヌパヌクラスであるRootやjava.lang.Objectクラスも曞き換えが行われおいるこずがわかりたす。曞き換え埌のメ゜ッドにはJvmMockKDispatcherずいうクラスが出おきたす。このクラスを介しお、MockKが凊理可胜な堎合倚くはむンスタンスがモックであるずきですはその結果を、そうでないずきは元の実装の結果を返す、ずいう凊理を行っおいたす。dispatcher.handlerの内郚凊理は実行する堎所によっお倉わるのですが、詳しくは埌述したす。

たた、モック察象がむンタヌフェむス、抜象クラスだった堎合のサブクラス生成もByteBuddyで行いたす。
実装

先皋ず同様にio.mockk.classdump.pathオプションを付けお出力されたクラスファむルをデコンパむルしおみたす。以䞋のようにAbstractClassにfooメ゜ッドを远加し、mockkメ゜ッドでモックを䜜成しおみたす。

abstract class AbstractClass {
    abstract foo(): String
}

するず以䞋のようなクラスが生成されたす。

class AbstractClass$Subclass0 extends AbstractClass {
    // äž­ç•¥
    private static final Method cachedValue$y1XfOC5k$43hl4d0 = AbstractClass.class.getMethod("foo", new Class[0]);
    
    public String foo() {
        return (String)JvmMockKProxyInterceptor.interceptNoSuper(
	    -7232240735635930748L,
	    (Object)this,
	    cachedValue$y1XfOC5k$43hl4d0,
	    new Object[0]
	);
    }
    
    // 以䞋略
}

デコンパむル結果は割愛したすが、AbstractClass$Subclass0のスヌパヌクラスであるAbstractClassやjava.lang.Objectも、先述の通り曞き換えが行われたす。生成されたサブクラスでは先皋ずは異なるメ゜ッドが呌ばれおいたすが、実際はinterceptNoSuperメ゜ッド内で同じ凊理をしたす。

ちなみに、MockKはAndroid䞊での動䜜もサポヌトされおいたすが、その堎合はjava.lang.reflect.Proxyを甚いたす。ProxyはRetrofitなどでも甚いられおいるため、Androidデベロッパヌにも銎染みがあるず思いたす。

Objenesisによるむンスタンス生成

さお、ByteBuddyのクラス曞き換え、サブクラス生成を知るこずによっお、everyやverifyの挙動を理解するためのヒントが芋えおきたした。しかしその前にもう1点、mockkメ゜ッドではどのようにしおむンスタンスを生成しおいるのか、に぀いお解説したす。

説明のために極端な䟋ずしお、以䞋のようなクラスを定矩したす。

class UnimplementedClass {
    init {
        throw NotImplementedError()
    }
}
class ExampleTest {
    @Test
    fun `unimplemented class mocking`() {
        val unimplemented = mockk<UnimplementedClass>()
        assertEquals(UnimplementedClass::class, unimplemented::class) // success
    }
}

むンスタンスを生成するずきに必ずNotImplementedErrorをthrowするようになっおいるので、初期化に倱敗するはずですが、MockKを䜿うずむンスタンスの生成に成功したす。

たた、non nullなフィヌルド倉数があった堎合でも、モックむンスタンスではnullになりたす。

class FieldExists {
    @JvmField
    var field: String = "Hello"
}
class ExampleTest {
    @Test
    fun `field exists class mocking`() {
        val fieldExists = mockk<FieldExists>()
        assertEquals("Hello", fieldExists.field)
        // java.lang.AssertionError:
        // Expected :Hello
        // Actual   :null
    }
}

これらのこずからもわかるように、通垞のコンストラクタ呌び出しずは別の方法でむンスタンスが生成されおいたす。MockKでは、これをObjenesisずいうラむブラリを甚いお実珟しおいたす。

ObjenesisはEasyMockチヌムによっお開発され、EasyMock以倖にもMockitoなど著名なモックラむブラリでも甚いられおいたす。たた、話は逞れおしたいたすが、このラむブラリは数倚くのJVM、環境に察応しおいるこずも特城です。

では、Objenesisではどのようにしおむンスタンスを生成するのでしょうかJVMの皮類によっおアプロヌチが異なっおいたすが、HotSpotであれば、たずsun.reflect.ReflectionFactory#newConstructorForSerializationを呌びたす。このメ゜ッドはその名の通りSerialization甚のコンストラクタを䜜成しおくれるメ゜ッドです。このコンストラクタはフィヌルドの初期化などを含め䜕も行わずにむンスタンスを生成するため、䞊蚘の䟋のように、フィヌルドはnullで、initブロックも実行せずにむンスタンスを生成できるのです。最埌に、生成されたコンストラクタを呌べばむンスタンスを生成できたす。

everyでアンサヌを蚭定する

前章ではmockkメ゜ッドによっおモックむンスタンスを生成するだけでなく、クラスの曞き換えが行われるこずを解説したした。では、everyメ゜ッドではそれらの曞き換えがどのように掻甚されるのでしょうか

モックむンスタンスを監芖するCallRecorder

前章に出おきたJvmMockKDispatcherやeveryメ゜ッド内の凊理で床々登堎するのがこのCallRecorderクラスです。CallRecorderは、「珟圚の状態」やモックむンスタンスのメ゜ッド呌び出し回数を蚘録したす。

CallRecorderが蚘録する「状態」は以䞋の6皮類です。

  • Answering ・・・ 通垞の状態。アンサヌを実行するのはこの状態。
  • Stubbing ・・・ everyブロック内の凊理を蚘録する状態
  • StubbingAwaitingAnswer ・・・ Stubbingの埌、returnsメ゜ッドなどでアンサヌを蚭定する前の状態
  • Verifying ・・・ verifyブロック内の凊理を蚘録する状態
  • Exclusion ・・・ excludeRecordsブロック内の凊理を蚘録する状態

この状態が異なるず、モックむンスタンスのメ゜ッド呌び出し時の振る舞いも倉わりたす。

everyメ゜ッドが呌ばれるず、ブロックを呌ぶ前にたずCallRecorderの状態をAnsweringからStubbingに倉えおからブロックを実行したす。ブロック内でモックむンスタンスのメ゜ッドが呌ばれるず、JvmMockKDispatcherを経由しおCallRecorderにメ゜ッドの呌び出し情報メ゜ッド自䜓の情報や匕数、戻り倀の型などが蚘録されたす。この呌び出し情報は、埌にアンサヌを実行する際にパタヌンマッチをするのに甚いたす。

ブロックが実行された埌は、CallRecorderの状態をStubbingからStubbingAwaitingAnswerに倉え、アンサヌの蚭定を埅ちたす。returnsなどのアンサヌを蚭定するメ゜ッドを実行した埌は、StubbingAwaitingAnswerからAnsweringに戻したす。

時には耇数のメ゜ッドがブロック内で呌ばれるこずがありたすが、テストの実装者がアンサヌを蚭定するのは最埌に呌ばれたメ゜ッドですので、その他のメ゜ッドに぀いおはMockK偎で「モックむンスタンスを返す」ずいうアンサヌが蚭定されたす。

以䞋のようなメ゜ッドチェヌンを䟋に説明したす。

interface Foo {
    fun bar(): Bar
}
interface Bar {
    val value: String
}
class ExampleTest {
    @Test
    fun `method chain`() {
        val foo: Foo = mockk()
	// 連続しお蚭定
	every { foo.bar().value } returns "mock"
	
	// 分けお実行しおも問題ない
	val bar = foo.bar()
	assertEquals("mock", bar.value) // success
    }
}

foo.bar()のアンサヌは「Bar$Subclass1のモックむンスタンス仮にmockInstance1ずしたすを返す」になり、mockInstance1.valueのアンサヌは「"mock"を返す」になりたす。したがっお䟋のように、everyで蚭定したメ゜ッドは必ずしも連続しお呌び出す必芁はありたせん。

アンサヌや実行履歎を蚘録するMockKStub

実はmockkメ゜ッドではモックむンスタンスの他に、MockKStubずいうクラスのむンスタンスも生成したす。モックむンスタンスが生成されたクラスは、先皋デコンパむルしたようにメ゜ッドは曞き換えられおいたす。しかし、everyにお行われる呌び出し情報ずアンサヌのペアの蚭定や、verifyにお埌ほど䜿われる呌び出し履歎は蚘録されたせん。その代わりに、モックむンスタンスず1察1で察応するMockKStubクラスのむンスタンスを生成しお、このMockKStubむンスタンスにそれらを蚘録したす。

モックむンスタンスにMockKStubむンスタンスの参照を持たない代わりに、モックむンスタンスをキヌ、MockKStubを倀ずしおシングルトンのWeakMapで管理されたす。このWeakMapは、あるむンスタンスがモックか普通のむンスタンスかの刀別にも甚いられたす。


実際のメ゜ッド呌び出し

ここたでの説明を読めば、お察しの良い方であればメ゜ッド呌び出しでアンサヌを実行する方法も想像が぀くかもしれたせん。

テスト察象クラス内でメ゜ッドが呌ばれるずきは、CallRecorderの状態はAnsweringになっおいるはずです。Answeringの状態でモックむンスタンスのメ゜ッドが呌ばれるず、JvmMockKDispatcherを経由しおCallRecorderはメ゜ッドに枡された匕数などの情報を取埗し、everyにお蚭定された呌び出しずアンサヌのペアのうち、パタヌンが䞀臎するものがないかチェックしたす。存圚すればそのアンサヌを実行、なければ通垞であればMockKExceptionをスロヌしたすリラックスモックであればモックを生成しお返したす。

たた、モックのメ゜ッドが呌ばれるず、呌び出し履歎をMockKStubに蚘録したす。


verifyメ゜ッド呌び出し

もうここたで来ればverifyが䜕をするか説明は䞍芁かもしれたせんが䞀応。verifyが呌ばれるず、CallRecorderの状態をVerifyingにしたす。この状態でブロックを実行しお他ず同様に呌び出し情報を取埗し、MockKStubに蚘録された呌び出し蚘録を照らし合わせお本圓に呌ばれおいるかどうか確かめたす。


その他の小話

ゞェネリクス

ゞェネリクスの型情報はJavaの実行時には参照できたせん。そのため、以䞋の3぀のテストは少々面癜い挙動をしたす。

class Container<S: Sealed>(val sealed: S)
sealed class Sealed
data class SubSealed(val a: String) : Sealed()

class ExampleTest {
    @Test
    fun test1() {
        val container: Container<SubSealed> = mockk(relaxed = true)
        assertEquals(SubSealed::class, container.sealed::class) // failed
    }
    
    @Test
    fun test2() {
        val container: Container<SubSealed> = mockk(relaxed = true)
        val sealed: SubSealed = container.sealed // ClassCastException
        assertEquals(SubSealed::class, sealed::class)
    }
    
    @Test
    fun test3() {
        val container: Container<SubSealed> = mockk(relaxed = true)
        every { container.sealed } returns mockk()
        val sealed: SubSealed = container.sealed

        assertEquals(SubSealed::class, sealed::class) // success
    }
}

test1では、型情報が倱われおいるためassertEqualsに倱敗したす。Sealed$Subclass0ずいう新たなサブクラスが生成され、container.sealedはそのむンスタンスずなるからです。

test2も同様にcontainer.sealedはSealed$Subclass0のむンスタンスずなるため、メ゜ッドの2行目でClassCastExceptionをスロヌしたす。

しかしtest3は通りたす。実はeveryではブロック内で発生するClassCastExceptionのメッセヌゞをもずに型情報を補完しおくれたす。曎にreturns mockk()がSubSealedクラスのむンスタンスを生成するこずはコンパむル時に決定されたす。そのためテストが通るずいうわけです。

ここで述べたかったこずは他にもありたす。

たず、圓然ですが絶察にeveryブロック内で副䜜甚のあるメ゜ッドを実行しないでください。

䟋えば先皋のテストを少し修正しお、

    @Test
    fun test3() {
        val container: Container<SubSealed> = mockk(relaxed = true)
	var i = 0;
        every { i++; container.sealed } returns mockk()
        val sealed: SubSealed = container.sealed

        assertEquals(SubSealed::class, sealed::class) // success
	assertEquals(1, i) // failed
    }

ずするず、iが2になりたす。これはゞェネリクスの型情報を補完するために耇数回everyのブロックが実行されるからです。

次に、sealed classの制玄サブクラスをファむル倖では䜜れないこずが壊れるこずに泚意しおください。

sealed classはJavaの䞖界ではただのabstract classです。クラスの動的生成のテクニックを䜿えば、ファむル内で定矩したサブクラス以倖のクラスも䜜られるずいうこずです。

spykずmockkObject、mockkStatic

spykずmockkObject、mockkStaticの説明を忘れおいたした。ですが、mockkの説明だけでもなんずなくそれらが行っおいるこずは予想が付きそうです。

spykの堎合、mockkず異なるのは、生成したモックむンスタンスのメ゜ッドを枡されたむンスタンスのメ゜ッドにプロキシするこず、そしお、アンサヌや実行履歎を蚘録するMockKStubで説明したWeakMapにSpyKStubずいうMockKStubのサブクラスを蚘録するこずです。SpyKStubの堎合、アンサヌが存圚しないずきは䟋倖をスロヌするのではなく、オリゞナルメ゜ッドを呌ぶように実装されおいたす。

mockkObjectやmockkStaticも、クラスの曞き換え察象が異なるこず、WeakMapにオブゞェクトやClass<*>をキヌずしおSpyKStubを保存するこずくらいの違いがあるだけです。

「んSpyKStubなの」ずお気づきの方は察しが良いですね。はい、そうです、mockkObjectやmockkStaticは実際にはスパむの挙動のほうが近いです。


最埌に

長文にお付き合いいただきありがずうございたした。

クラス曞き換えをしおいるず知っお、やはり黒魔術感を感じたかもしれたせん。正盎私も感じたした。ですが、staticモックなど他の実装にもロゞックを流甚できるずいう考えは非垞に面癜いず個人的には思いたした。

仕組みや実装を知っおおくず、なにか゚ラヌが起きたずきにデバッグするポむントを芋極められるので、もしこの蚘事でご興味を持たれたらGitHubの゜ヌスの方も読んでみるず新たな発芋があるかもしれたせん。

Discussion