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

day

infix fun Expect<LocalDate>.day(assertionCreator: Expect<Int>.() -> Unit): Expect<LocalDate>(source)

Expects that the property LocalDate.dayOfMonth 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.

Return

an Expect for the subject of this expectation.

Since

0.12.0

Samples

expect(LocalDate.of(2021, Month.OCTOBER, 9)) day {
    // subject inside this expectation-group is of type Int (actually 9)
    it toEqual 9
    it toBeGreaterThan 5
} // subject here is back to type LocalDate

fails {
    expect(LocalDate.of(2021, Month.OCTOBER, 9)) day {
        // subject inside this expectation-group is of type Int (actually 9)
        it toEqual 5       // fails
        it toBeLessThan 7  // still evaluated even though toEqual already fails
        //                    use `.day` if you want a fail fast behaviour
    } // subject here is back to type LocalDate
}

infix fun Expect<LocalDateTime>.day(assertionCreator: Expect<Int>.() -> Unit): Expect<LocalDateTime>(source)

Expects that the property LocalDateTime.dayOfMonth 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.

Return

an Expect for the subject of this expectation.

Since

0.12.0

Samples

expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56)) day {
    // subject inside this expectation-group is of type Int (actually 9)
    it toEqual 9
    it toBeGreaterThan 5
} // subject here is back to type LocalDateTime

fails {
    expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56)) day {
        // subject inside this expectation-group is of type Int (actually 9)
        it toEqual 5       // fails
        it toBeLessThan 7  // still evaluated even though toEqual already fails
        //                    use `.day` if you want a fail fast behaviour
    } // subject here is back to type LocalDateTime
}

infix fun Expect<ZonedDateTime>.day(assertionCreator: Expect<Int>.() -> Unit): Expect<ZonedDateTime>(source)

Expects that the property ZonedDateTime.dayOfMonth 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.

Return

an Expect for the subject of this expectation.

Since

0.12.0

Samples

expect(ZonedDateTime.of(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56), ZoneId.systemDefault())) day {
    // subject inside this expectation-group is of type Int (actually 9)
    it toEqual 9
    it toBeGreaterThan 5
} // subject here is back to type ZonedDateTime

fails {
    expect(ZonedDateTime.of(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56), ZoneId.systemDefault())) day {
        // subject inside this expectation-group is of type Int (actually 9)
        it toEqual 5       // fails
        it toBeLessThan 7  // still evaluated even though toEqual already fails
        //                    use `.day` if you want a fail fast behaviour
    } // subject here is back to type ZonedDateTime
}

val Expect<LocalDate>.day: Expect<Int>(source)

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

Return

The newly created Expect for the extracted feature.

Since

0.12.0

Samples

expect(LocalDate.of(2021, Month.OCTOBER, 9))
    .day toEqual 9
//    | subject is now of type Int (actually 9)

fails {
    expect(LocalDate.of(2021, Month.OCTOBER, 9))
        .day toEqual 5 toBeGreaterThan 10
    //    |    |         | not reported because toEqual already fails
    //    |    |         | use `day { ... }` if you want that all expectations are evaluated
    //    |    | fails
    //    | subject is now of type Int (actually 9)
}

val Expect<LocalDateTime>.day: Expect<Int>(source)

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

Return

The newly created Expect for the extracted feature.

Since

0.12.0

Samples

expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56))
    .day toEqual 9
//    | subject is now of type Int (actually 9)

fails {
    expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56))
        .day toEqual 5 toBeGreaterThan 10
    //    |    |         | not reported because toEqual already fails
    //    |    |         | use `day { ... }` if you want that all expectations are evaluated
    //    |    | fails
    //    | subject is now of type Int (actually 9)
}

val Expect<ZonedDateTime>.day: Expect<Int>(source)

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

Return

The newly created Expect for the extracted feature.

Since

0.12.0

Samples

expect(ZonedDateTime.of(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56), ZoneId.systemDefault()))
    .day toEqual 9
//    | subject is now of type Int (actually 9)

fails {
    expect(ZonedDateTime.of(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56), ZoneId.systemDefault()))
        .day toEqual 5 toBeGreaterThan 10
    //    |    |         | not reported because toEqual already fails
    //    |    |         | use `day { ... }` if you want that all expectations are evaluated
    //    |    | fails
    //    | subject is now of type Int (actually 9)
}