atrium-api-infix/ch.tutteli.atrium.api.infix.en_GB/get

get

infix fun <E, T : List<E>> Expect<T>.get(index: Int): Expect<E>(source)

Expects that the given index is within the bounds of the subject of this expectation (a List) and returns an Expect for the element at that position.

Return

The newly created Expect for the element at position index.

Samples

val list = listOf(1, 2, 3)

expect(list) get 0 toBeGreaterThan 0 toBeLessThan 2
//               |                 | subject is still of type Int (still 1)
//               | subject is now of type Int (actually 1)

fails {
    expect(list) get 3 toBeLessThan 0
    //             |        | not reported
    //             | fails because index 3 is out of bound
    // use `get index(elementIndex) { ... }` if you want that all expectations are evaluated
}

fails {
    expect(list) get 0 toBeGreaterThan 2 toBeLessThan 0
    //               |        |            | not reported because `toBeGreaterThan 2` already fails
    //               |        | fails
    //               | subject is now of type Int (actually 1)
    expect(list) get 0 toBeLessThan 0
    // use `get index(elementIndex) { ... }` if you want that all expectations are evaluated

}

infix fun <E, T : List<E>> Expect<T>.get(index: IndexWithCreator<E>): Expect<T>(source)

Expects that the given index is within the bounds of the subject of this expectation (a List) and that the element at that position holds all assertions the given IndexWithCreator.assertionCreator creates for it.

Use the function index(Int) { ... } to create an IndexWithCreator.

Return

an Expect for the subject of this expectation.

Samples

val list = listOf(1, 2, 3)

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

expect(list) get index(1) {  // subject inside this expectation-group 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-expectations-or-an-expectation-group

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