assertk/assertk

Package-level declarations

Types

sealed class Assert<out T>

An assertion. Holds an actual value to assertion on and an optional name.

annotation class AssertkDsl

Marks the assertion DSL.

sealed class Table

A table of rows to assert on. This makes it easy to run the same assertions are a number of inputs and outputs.

class Table1<C1> : Table

A table with rows of 1 value.

class Table1Builder : TableBuilder

Builds a table with the given rows.

class Table2<C1, C2> : Table

A table with rows of 2 values.

class Table2Builder : TableBuilder

Builds a table with the given rows.

class Table3<C1, C2, C3> : Table

A table with rows of 3 values.

class Table3Builder : TableBuilder

Builds a table with the given rows.

class Table4<C1, C2, C3, C4> : Table

A table with rows of 4 values.

class Table4Builder : TableBuilder

Builds a table with the given rows.

sealed class TableBuilder

Builds a table with the given rows.

actual open class ThreadLocalRef<T>(initial: () -> T)

actual open class ThreadLocalRef<T>(initial: () -> T) : ThreadLocal<T>

expect open class ThreadLocalRef<TT>(initial: () -> T)

actual open class ThreadLocalRef<TT>(initial: () -> T)

Properties

var <T> ThreadLocalRef<T>.value: T

Functions

fun <T> Assert<T>.all(body: Assert<T>.() -> Unit)

fun <T> Assert<T>.all(message: String, body: Assert<T>.() -> Unit)

All assertions in the given lambda are run.

inline fun assertAll(f: () -> Unit)

Runs all assertions in the given lambda and reports any failures.

inline fun assertFailure(f: () -> Unit): Assert<Throwable>

Asserts that the given block will throw an exception rather than complete successfully.

fun <T> assertThat(getter: KProperty0<T>, name: String? = null): Assert<T>

Asserts on the given property reference using its name, if no explicit name is specified. This method should be preferred in cases, where property references can be used, as it uses the property's name for the assertion automatically. The name may optionally be overridden, if needed.

fun <T> assertThat(actual: T, name: String? = null, displayActual: (T) -> String = { display(it) }): Assert<T>

Asserts on the given value with an optional name.

fun fail(error: AssertionError): Nothing

Fail the test with the given {@link AssertionError}.

fun fail(message: String, expected: Any? = NONE, actual: Any? = NONE, cause: Throwable? = null): Nothing

Fail the test with the given message.

fun notifyFailure(e: Throwable)

fun tableOf(name1: String): Table1Builder

fun tableOf(name1: String, name2: String): Table2Builder

fun tableOf(name1: String, name2: String, name3: String): Table3Builder

fun tableOf(name1: String, name2: String, name3: String, name4: String): Table4Builder

Builds a table with the given column names.