在Kotlin中测试预期的异常

在Java中，程序员可以为JUnit测试用例指定预期的异常，如下所示：

@Test(expected = ArithmeticException.class)
public void omg()
{
    int blackHole = 1 / 0;
}

我将如何在Kotlin中做到这一点？我尝试了两种语法变体，但没有一个起作用：

import org.junit.Test

// ...

@Test(expected = ArithmeticException) fun omg()
    Please specify constructor invocation;
    classifier 'ArithmeticException' does not have a companion object

@Test(expected = ArithmeticException.class) fun omg()
                            name expected ^
                                            ^ expected ')'

JUnit 4.12的Java示例的Kotlin转换为：

@Test(expected = ArithmeticException::class)
fun omg() {
    val blackHole = 1 / 0
}

但是，JUnit 4.13 引入了两种assertThrows用于更细粒度异常范围的方法：

@Test
fun omg() {
    // ...
    assertThrows(ArithmeticException::class.java) {
        val blackHole = 1 / 0
    }
    // ...
}

这两种assertThrows方法都将为其他断言返回预期的异常：

@Test
fun omg() {
    // ...
    val exception = assertThrows(ArithmeticException::class.java) {
        val blackHole = 1 / 0
    }
    assertEquals("/ by zero", exception.message)
    // ...
}

Kotlin有自己的测试帮助程序包，可以帮助您进行这种单元测试。

通过使用，您的测试可以非常有表现力assertFailWith：

@Test
fun test_arithmethic() {
    assertFailsWith<ArithmeticException> {
        omg()
    }
}

您可以使用@Test(expected = ArithmeticException::class)甚至更好的Kotlin的库方法之一，例如failsWith()。

您可以通过使用通用化泛型和类似如下的辅助方法来使其更短：

inline fun <reified T : Throwable> failsWithX(noinline block: () -> Any) {
    kotlin.test.failsWith(javaClass<T>(), block)
}

以及使用注释的示例：

@Test(expected = ArithmeticException::class)
fun omg() {

}

您可以为此使用KotlinTest。

在您的测试中，您可以使用shouldThrow块包装任意代码：

shouldThrow<ArithmeticException> {
  // code in here that you expect to throw a ArithmeticException
}

JUnit5具有内置的kotlin支持。

import org.junit.jupiter.api.Test
import org.junit.jupiter.api.assertThrows

class MyTests {
    @Test
    fun `division by zero -- should throw ArithmeticException`() {
        assertThrows<ArithmeticException> {  1 / 0 }
    }
}

您还可以将泛型与kotlin.test包一起使用：

import kotlin.test.assertFailsWith 

@Test
fun testFunction() {
    assertFailsWith<MyException> {
         // The code that will throw MyException
    }
}

声明扩展，以验证异常类以及错误消息是否匹配。

inline fun <reified T : Exception> assertThrows(runnable: () -> Any?, message: String?) {
try {
    runnable.invoke()
} catch (e: Throwable) {
    if (e is T) {
        message?.let {
            Assert.assertEquals(it, "${e.message}")
        }
        return
    }
    Assert.fail("expected ${T::class.qualifiedName} but caught " +
            "${e::class.qualifiedName} instead")
}
Assert.fail("expected ${T::class.qualifiedName}")

}

例如：

assertThrows<IllegalStateException>({
        throw IllegalStateException("fake error message")
    }, "fake error message")

没有人提到assertFailsWith（）返回值，您可以检查异常属性：

@Test
fun `my test`() {
        val exception = assertFailsWith<MyException> {method()}
        assertThat(exception.message, equalTo("oops!"))
    }
}

语法的另一个版本使用kluent：

@Test
fun `should throw ArithmeticException`() {
    invoking {
        val backHole = 1 / 0
    } `should throw` ArithmeticException::class
}

首要步骤是添加(expected = YourException::class)测试注释

@Test(expected = YourException::class)

第二步是添加此功能

private fun throwException(): Boolean = throw YourException()

最终，您将获得以下内容：

@Test(expected = ArithmeticException::class)
fun `get query error from assets`() {
    //Given
    val error = "ArithmeticException"

    //When
    throwException()
    val result =  omg()

    //Then
    Assert.assertEquals(result, error)
}
private fun throwException(): Boolean = throw ArithmeticException()

org.junit.jupiter.api.Assertions.kt

/**
 * Example usage:
 * ```kotlin
 * val exception = assertThrows<IllegalArgumentException>("Should throw an Exception") {
 *     throw IllegalArgumentException("Talk to a duck")
 * }
 * assertEquals("Talk to a duck", exception.message)
 * ```
 * @see Assertions.assertThrows
 */
inline fun <reified T : Throwable> assertThrows(message: String, noinline executable: () -> Unit): T =
        assertThrows({ message }, executable)