commonMain.io.kotest.assertions.fail.kt Maven / Gradle / Ivy

Go to download

package io.kotest.assertions

import io.kotest.assertions.throwables.shouldThrow

/**
 * Verifies that [block] throws an [AssertionError]
 *
 * If [block] throws an [AssertionError], this method will pass. Otherwise, it will throw an error, as a failure was
 * expected.
 *
 * This should be used mainly to check that an assertion fails, for example:
 *
 * ```
 *     shouldFail {
 *        1 shouldBe 2  // This should fail
 *     }
 * ```
 *
 * @see shouldThrowAny
 * @see shouldThrow
 * @see shouldThrowExactly
 */
inline fun shouldFail(block: () -> Any?): AssertionError = shouldThrow(block)

fun fail(msg: String): Nothing = throw failure(msg)