Pruebe las excepciones esperadas en Kotlin

91

En Java, el programador puede especificar excepciones esperadas para casos de prueba JUnit como este:

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

¿Cómo haría esto en Kotlin? Probé dos variaciones de sintaxis, pero ninguna de ellas funcionó:

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 ')'
fredoverflow
fuente

Respuestas:

126

La traducción de Kotlin del ejemplo de Java para JUnit 4.12 es:

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

Sin embargo, JUnit 4.13 introdujo dos assertThrowsmétodos para ámbitos de excepción más detallados:

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

Ambos assertThrowsmétodos devuelven la excepción esperada para aserciones adicionales:

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

Kotlin tiene su propio paquete de ayuda de prueba que puede ayudar a realizar este tipo de prueba unitaria.

Su prueba puede ser muy expresiva con el uso assertFailWith:

@Test
fun test_arithmethic() {
    assertFailsWith<ArithmeticException> {
        omg()
    }
}
Michele d'Amico
fuente
1
Si obtiene un 404 en su enlace, ¿ha kotlin.testsido reemplazado por algo más?
fredoverflow
@fredoverflow No, no se reemplaza, simplemente se elimina de las bibliotecas estándar. He actualizado el enlace al repositorio de github kotlin, pero desafortunadamente no puedo encontrar ningún enlace a la documentación. De todos modos, jar es enviado por kotlin-plugin en intelliJ o puede encontrarlo en la red o agregar la dependencia maven / grandle a su proyecto.
Michele d'Amico
7
compile "org.jetbrains.kotlin: kotlin-test: $ kotlin_version"
mac229
4
@ mac229 s / compile / testCompile /
Laurence Gonsalves
@AshishSharma: kotlinlang.org/api/latest/kotlin.test/kotlin.test/… assertFailWith devuelve la excepción y puede usarla para escribir su propia afirmación.
Michele d'Amico
26

Puede usar @Test(expected = ArithmeticException::class)o incluso mejor uno de los métodos de biblioteca de Kotlin como failsWith().

Puede acortarlo aún más utilizando genéricos reificados y un método auxiliar como este:

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

Y ejemplo usando la anotación:

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

}
Kirill Rakhman
fuente
javaClass<T>()ahora está en desuso. Úselo en su MyException::class.javalugar.
ayuno
failWith está en desuso, en su lugar se debería utilizar assertFailsWith .
gvlasov
15

Puede usar KotlinTest para esto.

En su prueba, puede envolver código arbitrario con un bloque shouldThrow:

shouldThrow<ArithmeticException> {
  // code in here that you expect to throw a ArithmeticException
}
sksamuel
fuente
Parece que la línea no funciona correctamente. Verifico 1. shouldThrow <java.lang.AssertionError> {someMethod (). IsOK shouldBe true} - green 2. shouldThrow <java.lang.AssertionError> {someMethod (). IsOK shouldBe false} - verde someMethod () throw "java .lang.AssertionError: message "cuando debería, y devuelve el objeto si está bien. En ambos casos shouldThrow es verde cuando está OK y cuando NO.
Ivan Trechyokas
Tal vez eche un vistazo a los documentos, podría haber cambiado desde mi respuesta en 2016. github.com/kotlintest/kotlintest/blob/master/doc/…
sksamuel
13

JUnit5 tiene soporte kotlin integrado.

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 }
    }
}
Frank Neblung
fuente
3
Esta es mi respuesta preferida. Si te Cannot inline bytecode built with JVM target 1.8 into bytecode that is being built with JVM target 1.6subes a assertThrows, asegúrate de que tu build.gradle tengacompileTestKotlin { kotlinOptions.jvmTarget = "1.8" }
Big Pumpkin
11

También puede usar genéricos con el paquete kotlin.test:

import kotlin.test.assertFailsWith 

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

Afirmar la extensión que verifica la clase de excepción y también si el mensaje de error coincide.

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}")

}

por ejemplo:

assertThrows<IllegalStateException>({
        throw IllegalStateException("fake error message")
    }, "fake error message")
Yanay Hollander
fuente
1

Nadie mencionó que assertFailsWith () devuelve el valor y puede verificar los atributos de excepción:

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

Otra versión de sintaxis usando kluent :

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

Los primeros pasos son agregar (expected = YourException::class)una anotación de prueba

@Test(expected = YourException::class)

El segundo paso es agregar esta función

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

Finalmente tendrás algo como esto:

@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()
Cabezas
fuente
0

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)
Coronel braian
fuente