doc / ch.tutteli.atrium.api.infix.en_GB / index

index

fun <E> index(index: Int, assertionCreator: Expect<E>.() -> Unit): IndexWithCreator<E> (source)

Helper function to create an IndexWithCreator based on the given index and assertionCreator.

val list = listOf(1, 2, 3)

expect(list) get index(0) {  // subject inside this block is of type Int (actually 1)
    it toBeLessThan 2
    it toBeGreaterThan 0
}

expect(list) get index(1) {  // subject inside this block is of type Int (actually 2)
    it toBeLessThan 3
    it toBeGreaterThan 1
}

fails {
    // all expectations are evaluated inside an expectation group block; for more details:
    // https://github.com/robstoll/atrium#define-single-assertions-or-assertion-groups

    expect(list) get index(0) {
        it toBeGreaterThan 2    // fails
        it toBeLessThan 0       // still evaluated even though `isGreaterThan(2)` already fails,
        //                         use `get index` if you want a fail fast behaviour
    }
} messageToContain values(
    "${toBeGreaterThanDescr}: 2",
    "${toBeLessThanDescr}: 0"
)