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

size

val <T : Collection<*>> Expect<T>.size: Expect<Int> (source)

Creates an Expect for the property Collection.size of the subject of this expectation, so that further fluent calls are assertions about it.

expect(listOf(1, 2, 3))
    .size toBeGreaterThan 1 toBeLessThan 4
//       |                 |             | subject is still of type Int (still 3)
//       |                 | subject is still of type Int (still 3)
//       | subject is now of type Int (actually 3)

fails {
    expect(listOf(1, 2, 3))
        .size toBeLessThan 1 toBeGreaterThan 4
    //       |              |         | not reported because `isLessThan 1` already fails
    //       |              | fails
    //       | subject is now of type Int (actually 3)
} message {
    toContain("${isLessThanDescr}: 1")
    notToContain("${isGreaterThanDescr}: 4")
}

Return
The newly created Expect for the extracted feature.

infix fun <E, T : Collection<E>> Expect<T>.size(assertionCreator: Expect<Int>.() -> Unit): Expect<T> (source)

Expects that the property Collection.size of the subject of this expectation holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of this expectation.

expect(listOf(1, 2, 3))
    .size { // subject inside this block is of type Int (actually 3)
        it toBeGreaterThan 1
    } // subject here is back to type List<Int>
    .size { // subject inside this block is of type Int (actually 3)
        it toBeLessThan 4
    }

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(listOf(1, 2, 3)) size { // subject inside this block is of type Int (actually 3)
        it toBeLessThan 1     // fails
        it toBeGreaterThan 4  // isLessThan 1 fails, but isGreaterThan 4 still evaluated
        //                       use `.size.` if you want a fail fast behaviour
    }
} messageToContain values(
    "${isLessThanDescr}: 1",
    "${isGreaterThanDescr}: 4"
)

Return
an Expect for the subject of this expectation.