如何模拟 Kotlin 单例对象？

Question

给定一个 Kotlin 单例对象和一个有趣的方法

object SomeObject {
   fun someFun() {}
}

fun callerFun() {
   SomeObject.someFun()
}

有没有办法模拟呼叫SomeObject.someFun()？

Answer 1

有一个非常棒的 Kotlin 模拟库 - Mockk，它允许你模拟对象，就像你想要的一样。

截至其文档：

---

对象可以通过以下方式转换为模拟：

object MockObj {
  fun add(a: Int, b: Int) = a + b
}

mockkObject(MockObj) // aplies mocking to an Object

assertEquals(3, MockObj.add(1, 2))

every { MockObj.add(1, 2) } returns 55

assertEquals(55, MockObj.add(1, 2))

要恢复使用 unmockkAll 或 unmockkObject：

@Before
fun beforeTests() {
    mockkObject(MockObj)
    every { MockObj.add(1,2) } returns 55
}

@Test
fun willUseMockBehaviour() {
    assertEquals(55, MockObj.add(1,2))
}

@After
fun afterTests() {
    unmockkAll()
    // or unmockkObject(MockObj)
}

尽管有 Kotlin 语言限制，但如果测试逻辑需要，您可以创建新的对象实例：

val newObjectMock = mockk<MockObj>()

Answer 2

只需让您的对象实现一个接口，就可以使用任何模拟库来模拟您的对象。这里是 Junit + Mockito + Mockito-Kotlin 的例子：

import com.nhaarman.mockito_kotlin.mock
import com.nhaarman.mockito_kotlin.whenever
import org.junit.Assert.assertEquals
import org.junit.Test

object SomeObject : SomeInterface {
    override fun someFun():String {
        return ""
    }
}

interface SomeInterface {
    fun someFun():String
}

class SampleTest {

    @Test
    fun test_with_mock() {
        val mock = mock<SomeInterface>()

        whenever(mock.someFun()).thenReturn("42")

        val answer = mock.someFun()

        assertEquals("42", answer)
    }
}

或者如果你想在 callerFun 中模拟 SomeObject：

import com.nhaarman.mockito_kotlin.mock
import com.nhaarman.mockito_kotlin.whenever
import org.junit.Assert.assertEquals
import org.junit.Test

object SomeObject : SomeInterface {
    override fun someFun():String {
        return ""
    }
}

class Caller(val someInterface: SomeInterface) {
    fun callerFun():String {
        return "Test ${someInterface.someFun()}"
    }
}

// Example of use
val test = Caller(SomeObject).callerFun()

interface SomeInterface {
    fun someFun():String
}

class SampleTest {

    @Test
    fun test_with_mock() {
        val mock = mock<SomeInterface>()
        val caller = Caller(mock)

        whenever(mock.someFun()).thenReturn("42")

        val answer = caller.callerFun()

        assertEquals("Test 42", answer)
    }
}

Answer 3

您可以通过使用类委托来模拟对象而无需任何额外的库。

这是我的建议

val someObjectDelegate : SomeInterface? = null

object SomeObject: by someObjectDelegate ?: SomeObjectImpl

object SomeObjectImpl : SomeInterface {

    fun someFun() {
        println("SomeObjectImpl someFun called")
    }
}

interface SomeInterface {
    fun someFun()
}

在您的测试中，您可以设置会改变行为的委托对象，否则它将使用它的真实实现。

@Beofre
fun setUp() {
  someObjectDelegate = object : SomeInterface {
      fun someFun() {
          println("Mocked function")
      }
  }
  // Will call method from your delegate
  SomeObject.someFun()
}

上面的名字当然不好，但为了举例说明目的。

SomeObject 初始化后，委托将处理所有功能。
更多内容请关注官方documentation

Answer 4

除了使用非常方便的Mockk 库之外，还可以简单地使用Mockito 和反射来模拟object。 Kotlin 对象只是具有私有构造函数和 INSTANCE 静态字段的常规 Java 类，通过反射可以将 INSTANCE 的值替换为模拟对象。测试后应恢复原件，以免更改影响其他测试

使用 Mockito Kotlin（需要按照here 的描述添加扩展配置来模拟最终类）：

testCompile "com.nhaarman:mockito-kotlin:1.5.0"

第一个乐趣可以替换object 类中的静态INSTANCE 字段的值并返回之前的值

fun <T> replaceObjectInstance(clazz: Class<T>, newInstance: T): T {

    if (!clazz.declaredFields.any {
                it.name == "INSTANCE" && it.type == clazz && Modifier.isStatic(it.modifiers)
            }) {
        throw InstantiationException("clazz ${clazz.canonicalName} does not have a static  " +
                "INSTANCE field, is it really a Kotlin \"object\"?")
    }

    val instanceField = clazz.getDeclaredField("INSTANCE")
    val modifiersField = Field::class.java.getDeclaredField("modifiers")
    modifiersField.isAccessible = true
    modifiersField.setInt(instanceField, instanceField.modifiers and Modifier.FINAL.inv())

    instanceField.isAccessible = true
    val originalInstance = instanceField.get(null) as T
    instanceField.set(null, newInstance)
    return originalInstance
}

然后你可以创建一个 object 的模拟实例并用模拟的值替换原始值，返回原始值以便稍后重置

fun <T> mockObject(clazz: Class<T>): T {
    val constructor = clazz.declaredConstructors.find { it.parameterCount == 0 }
            ?: throw InstantiationException("class ${clazz.canonicalName} has no empty constructor, " +
                    "is it really a Kotlin \"object\"?")

    constructor.isAccessible = true

    val mockedInstance = spy(constructor.newInstance() as T)

    return replaceObjectInstance(clazz, mockedInstance)
}

添加一些 Kotlin 糖

class MockedScope<T : Any>(private val clazz: Class<T>) {

    fun test(block: () -> Unit) {
        val originalInstance = mockObject(clazz)
        block.invoke()
        replaceObjectInstance(clazz, originalInstance)
    }
}

fun <T : Any> withMockObject(clazz: Class<T>) = MockedScope(clazz)

最后，给定一个object

object Foo {
    fun bar(arg: String) = 0
}

你可以这样测试

withMockObject(Foo.javaClass).test {
    doAnswer { 1 }.whenever(Foo).bar(any())

    Assert.assertEquals(1, Foo.bar(""))
}

Assert.assertEquals(0, Foo.bar(""))

Answer 5

不操纵字节码答案是否定的，除非您愿意并且能够更改代码。模拟callerFun 对SomeObject.someFun() 的调用最直接的方法（也是我推荐的方法）是提供某种方法将其滑入模拟对象。

例如

object SomeObject {
    fun someFun() {}
}

fun callerFun() {
    _callerFun { SomeObject.someFun() }
}

internal inline fun _callerFun(caller: () -> Unit) {
    caller()
}

这里的想法是改变你愿意改变的东西。如果您确定需要一个单例和一个作用于该单例的顶级函数，那么如上所示，在不更改其公共签名的情况下使顶级函数可测试的一种方法是将其实现移动到 @987654324 @ 允许滑动模拟的函数。