fun <E, T : List<E>> Expect<T>.get(index: Int): Expect<E>
Expects that the given index is within the bounds of the subject of the assertion (a List) and returns an Expect for the element at that position.
val list = listOf(1, 2, 3)
expect(list)
.get(0) // subject is now of type Int (actually 1)
.isLessThan(2) // subject is still of type Int (still 1)
.isGreaterThan(0)
fails {
expect(list)
.get(3) // fails because index 3 is out of bound
.isLessThan(0) // not reported
// use `get(index) { ... }` if you want that all assertions are evaluated
}.message {
contains("index out of bounds")
containsNot("is less than: 2")
}
fails {
expect(list)
.get(0)
.isGreaterThan(2) // fails
.isLessThan(0) // not reported because `isGreaterThan(2)` already fails
// use `get(index) { ... }` if you want that all assertions are evaluated
}.message {
contains("is greater than: 2")
containsNot("is less than: 0")
}
AssertionError - Might throw an AssertionError if the given index is out of bound.
Return
The newly created Expect for the element at position index.
fun <E, T : List<E>> Expect<T>.get(index: Int, assertionCreator: Expect<E>.() -> Unit): Expect<T>
Expects that the given index is within the bounds of the subject of the assertion (a List) and that the element at that position holds all assertions the given assertionCreator creates for it.
val list = listOf(1, 2, 3)
expect(list)
.get(0) { // subject inside this block is of type Int (actually 1)
isLessThan(2)
isGreaterThan(0)
} // subject here is back to type List<Int>
.get(1) { // subject inside this block is of type Int (actually 2)
isLessThan(3)
isGreaterThan(1)
}
fails {
// all assertions are evaluated inside an assertion group block; for more details:
// https://github.com/robstoll/atrium#define-single-assertions-or-assertion-groups
expect(list)
.get(0) {
isGreaterThan(2) // fails
isLessThan(0) // still evaluated even though `isGreaterThan(2)` already fails,
// use the `.get(index).` if you want a fail fast behaviour
}
}.messageContains(
"is greater than: 2",
"is less than: 0"
)
AssertionError - Might throw an AssertionError if the given index is out of bound.
Return
An Expect for the current subject of the assertion.