MockKã®ãé»éè¡ããè§£æãã
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ãã¡ã€ã«ããã³ã³ãã€ã«ãããšã以äžã®ããã«ãªããŸãã
// ç¥
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";
}
}
}
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";
}
}
}
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