Skip to content

Commit

Permalink
fix link to expectation-group explanation in samples, improve formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@robstoll
robstoll committed Apr 2, 2024
1 parent 5d98d57 commit a8f1a32
Show file tree
Hide file tree
Showing 18 changed files with 376 additions and 410 deletions.
15 changes: 10 additions & 5 deletions ...src/commonTest/kotlin/ch/tutteli/atrium/api/fluent/en_GB/samples/AnyExpectationSamples.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,9 @@ class AnyExpectationSamples {
}

fails { // because sub-expectation 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<Int?>(1).notToEqualNull {
toBeLessThan(0) // fails
toBeGreaterThan(5) // still evaluated even though `toBeLessThan` already fails,
Expand Down Expand Up @@ -152,6 +155,9 @@ class AnyExpectationSamples {
}

fails { // because sub-expectation 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(n).toBeAnInstanceOf<Long> {
toEqual(-1L) // fails
toBeLessThan(2L) // still evaluated even though `toEqual` already fails,
Expand Down Expand Up @@ -223,14 +229,13 @@ class AnyExpectationSamples {
}

fails {
expect(13).toBeAnInstanceOf<Int>().and {
// introduces an expectation-group block where all expectations inside
// are evaluated together; for more details see:
// https://github.com/robstoll/atrium#define-single-expectations-or-expectation-groups
// use `.and.` if you want fail fast behaviour
// 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(13).toBeAnInstanceOf<Int>().and {
notToEqualOneOf(1, 2, 13) // fails
toBeLessThan(10) // still evaluated and included in the error report
// use `.and.` if you want fail fast behaviour
}
}
}
Expand Down
177 changes: 79 additions & 98 deletions ...ommonTest/kotlin/ch/tutteli/atrium/api/fluent/en_GB/samples/ArraySubjectChangerSamples.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,19 @@ class ArraySubjectChangerSamples {

@Test
fun asList() {
expect(arrayOf("A", "B"))
.asList { // subject within this expectation-group is of type List<String>
toEqual(listOf("A", "B"))
} // subject here is back to type Array<String>
expect(arrayOf("A", "B")).asList { // subject within this expectation-group is of type List<String>
toEqual(listOf("A", "B"))
} // subject here is back to type Array<String>

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

expect(arrayOf("A", "B"))
.asList {
toContain("C") // fails
toContain("D") // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
expect(arrayOf("A", "B")).asList {
toContain("C") // fails
toContain("D") // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
}
}

Expand All @@ -52,12 +50,11 @@ class ArraySubjectChangerSamples {
// all expectations inside an expectation-group are evaluated together; for more details see:
// https://github.com/robstoll/atrium#define-single-expectations-or-an-expectation-group

expect<Array<out String>>(arrayOf("A", "B"))
.asList {
toContain("C") // fails
toContain("D") // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
expect<Array<out String>>(arrayOf("A", "B")).asList {
toContain("C") // fails
toContain("D") // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
}
}

Expand All @@ -70,21 +67,19 @@ class ArraySubjectChangerSamples {

@Test
fun byteArrAsList() {
expect(byteArrayOf(1, 2, 3))
.asList { // subject within this expectation-group is of type List<Byte>
toEqual(listOf<Byte>(1, 2, 3))
} // subject here is back to type Array<Byte>
expect(byteArrayOf(1, 2, 3)).asList { // subject within this expectation-group is of type List<Byte>
toEqual(listOf<Byte>(1, 2, 3))
} // subject here is back to type Array<Byte>

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

expect(byteArrayOf(1, 2, 3))
.asList {
toContain(98) // fails
toContain(99) // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
expect(byteArrayOf(1, 2, 3)).asList {
toContain(98) // fails
toContain(99) // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
}
}

Expand All @@ -97,21 +92,19 @@ class ArraySubjectChangerSamples {

@Test
fun charArrAsList() {
expect(charArrayOf('A', 'B', 'C'))
.asList { // subject within this expectation-group is of type List<Char>
toEqual(listOf('A', 'B', 'C'))
} // subject here is back to type Array<Char>
expect(charArrayOf('A', 'B', 'C')).asList { // subject within this expectation-group is of type List<Char>
toEqual(listOf('A', 'B', 'C'))
} // subject here is back to type Array<Char>

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

expect(charArrayOf('A', 'B', 'C'))
.asList {
toContain('X') // fails
toContain('Y') // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
expect(charArrayOf('A', 'B', 'C')).asList {
toContain('X') // fails
toContain('Y') // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
}
}

Expand All @@ -124,21 +117,19 @@ class ArraySubjectChangerSamples {

@Test
fun shortArrAsList() {
expect(shortArrayOf(1, 2, 3))
.asList { // subject within this expectation-group is of type List<Short>
toEqual(listOf<Short>(1, 2, 3))
} // subject here is back to type Array<Short>
expect(shortArrayOf(1, 2, 3)).asList { // subject within this expectation-group is of type List<Short>
toEqual(listOf<Short>(1, 2, 3))
} // subject here is back to type Array<Short>

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

expect(shortArrayOf(1, 2, 3))
.asList {
toContain(98) // fails
toContain(99) // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
expect(shortArrayOf(1, 2, 3)).asList {
toContain(98) // fails
toContain(99) // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
}
}

Expand All @@ -151,21 +142,19 @@ class ArraySubjectChangerSamples {

@Test
fun intArrAsList() {
expect(intArrayOf(1, 2, 3))
.asList { // subject within this expectation-group is of type List<Int>
toEqual(listOf(1, 2, 3))
} // subject here is back to type Array<Int>
expect(intArrayOf(1, 2, 3)).asList { // subject within this expectation-group is of type List<Int>
toEqual(listOf(1, 2, 3))
} // subject here is back to type Array<Int>

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

expect(intArrayOf(1, 2, 3))
.asList {
toContain(98) // fails
toContain(99) // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
expect(intArrayOf(1, 2, 3)).asList {
toContain(98) // fails
toContain(99) // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
}
}

Expand All @@ -178,21 +167,19 @@ class ArraySubjectChangerSamples {

@Test
fun longArrAsList() {
expect(longArrayOf(1L, 2L, 3L))
.asList { // subject within this expectation-group is of type List<Long>
toEqual(listOf(1L, 2L, 3L))
} // subject here is back to type Array<Long>
expect(longArrayOf(1L, 2L, 3L)).asList { // subject within this expectation-group is of type List<Long>
toEqual(listOf(1L, 2L, 3L))
} // subject here is back to type Array<Long>

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

expect(longArrayOf(1L, 2L, 3L))
.asList {
toContain(98L) // fails
toContain(99L) // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
expect(longArrayOf(1L, 2L, 3L)).asList {
toContain(98L) // fails
toContain(99L) // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
}
}

Expand All @@ -205,21 +192,19 @@ class ArraySubjectChangerSamples {

@Test
fun floatArrAsList() {
expect(floatArrayOf(1f, 2f, 3f))
.asList { // subject within this expectation-group is of type List<Float>
toEqual(listOf(1f, 2f, 3f))
} // subject here is back to type Array<Float>
expect(floatArrayOf(1f, 2f, 3f)).asList { // subject within this expectation-group is of type List<Float>
toEqual(listOf(1f, 2f, 3f))
} // subject here is back to type Array<Float>

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

expect(floatArrayOf(1f, 2f, 3f))
.asList {
toContain(98f) // fails
toContain(99f) // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
expect(floatArrayOf(1f, 2f, 3f)).asList {
toContain(98f) // fails
toContain(99f) // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
}
}

Expand All @@ -232,21 +217,19 @@ class ArraySubjectChangerSamples {

@Test
fun doubleArrAsList() {
expect(doubleArrayOf(1.1, 2.2, 3.3))
.asList { // subject within this expectation-group is of type List<Double>
toEqual(listOf(1.1, 2.2, 3.3))
} // subject here is back to type Array<Double>
expect(doubleArrayOf(1.1, 2.2, 3.3)).asList { // subject within this expectation-group is of type List<Double>
toEqual(listOf(1.1, 2.2, 3.3))
} // subject here is back to type Array<Double>

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

expect(doubleArrayOf(1.1, 2.2, 3.3))
.asList {
toContain(98.1) // fails
toContain(99.2) // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
expect(doubleArrayOf(1.1, 2.2, 3.3)).asList {
toContain(98.1) // fails
toContain(99.2) // still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
}
}
}

Expand All @@ -259,24 +242,22 @@ class ArraySubjectChangerSamples {

@Test
fun booleanArrAsList() {
expect(booleanArrayOf(true, false))
.asList { // subject within this expectation-group is of type List<Boolean>
toEqual(listOf(true, false))
} // subject here is back to type Array<Boolean>
expect(booleanArrayOf(true, false)).asList { // subject within this expectation-group is of type List<Boolean>
toEqual(listOf(true, false))
} // subject here is back to type Array<Boolean>

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

expect(booleanArrayOf(true, true))
.asList {
// fails
toContain(false)
expect(booleanArrayOf(true, true)).asList {
// fails
toContain(false)

// still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
toContain.inAnyOrder.atLeast(3).value(true)
}
// still evaluated even though above `toContain` already fails
// use `.asList().` if you want a fail fast behaviour
toContain.inAnyOrder.atLeast(3).value(true)
}
}
}
}
Loading

0 comments on commit a8f1a32

Please sign in to comment.