Repository navigation
Expand file tree
/
Copy pathArrayAssertionsExamples.java
More file actions
502 lines (429 loc) · 21.6 KB
/
Copy pathArrayAssertionsExamples.java
File metadata and controls
502 lines (429 loc) · 21.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
/**
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*
* Copyright 2012-2016 the original author or authors.
*/
package org.assertj.examples;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.entry;
import static org.assertj.core.api.Assertions.extractProperty;
import static org.assertj.core.api.Assertions.failBecauseExceptionWasNotThrown;
import static org.assertj.core.api.Assertions.filter;
import static org.assertj.core.api.Assertions.setAllowExtractingPrivateFields;
import static org.assertj.core.api.Assertions.tuple;
import static org.assertj.core.data.Index.atIndex;
import static org.assertj.core.util.Arrays.array;
import static org.assertj.core.util.Lists.newArrayList;
import static org.assertj.examples.data.Alignment.EVIL;
import static org.assertj.examples.data.Race.ELF;
import static org.assertj.examples.data.Race.HOBBIT;
import static org.assertj.examples.data.Race.ORC;
import static org.assertj.examples.data.Ring.dwarfRing;
import static org.assertj.examples.data.Ring.manRing;
import static org.assertj.examples.data.Ring.narya;
import static org.assertj.examples.data.Ring.nenya;
import static org.assertj.examples.data.Ring.oneRing;
import static org.assertj.examples.data.Ring.vilya;
import java.awt.Rectangle;
import java.io.UnsupportedEncodingException;
import java.util.Arrays;
import java.util.Comparator;
import org.assertj.core.data.MapEntry;
import org.assertj.core.util.introspection.IntrospectionError;
import org.assertj.examples.data.Employee;
import org.assertj.examples.data.Race;
import org.assertj.examples.data.Ring;
import org.assertj.examples.data.TolkienCharacter;
import org.assertj.examples.data.movie.Movie;
import org.junit.jupiter.api.Test;
/**
* Array assertions examples.
*
* @author Joel Costigliola
*/
public class ArrayAssertionsExamples extends AbstractAssertionsExamples {
@Test
public void array_assertions_examples() {
// array assertion are very similar to newArrayList assertions
Ring[] elvesRings = array(vilya, nenya, narya);
Ring[] elvesRings2 = array(nenya, vilya, narya);
assertThat(elvesRings).containsOnly(elvesRings2);
assertThat(array(vilya, nenya, narya)).containsOnly(array(nenya, vilya, narya));
Movie[] trilogy = array(theFellowshipOfTheRing, theTwoTowers, theReturnOfTheKing);
assertThat(elvesRings).isNotEmpty().hasSize(3);
assertThat(elvesRings).hasSameSizeAs(trilogy);
assertThat(elvesRings).hasSameSizeAs(newArrayList(trilogy));
assertThat(elvesRings).contains(nenya).doesNotContain(oneRing);
assertThat(elvesRings).containsExactly(vilya, nenya, narya);
assertThat(elvesRings).containsExactlyElementsOf(newArrayList(vilya, nenya, narya));
// you can check element at a given index (we use Index.atIndex(int) synthetic sugar for better readability).
assertThat(elvesRings).contains(vilya, atIndex(0)).contains(nenya, atIndex(1)).contains(narya, atIndex(2));
// with containsOnly, all the elements must be present (but the order is not important)
assertThat(elvesRings).containsOnly(nenya, vilya, narya);
assertThat(elvesRings).containsOnlyElementsOf(newArrayList(nenya, vilya, narya));
assertThat(elvesRings).hasSameElementsAs(newArrayList(nenya, vilya, narya));
assertThat(elvesRings).doesNotContainNull().doesNotHaveDuplicates();
assertThat(elvesRings).doesNotContainAnyElementsOf(newArrayList(oneRing, manRing, dwarfRing));
// special check for null, empty collection or both
assertThat(newArrayList(frodo, null, sam)).containsNull();
Object[] array = array();
assertThat(array).isEmpty();
assertThat(array).contains();
assertThat(array).isNullOrEmpty();
array = null;
assertThat(array).isNullOrEmpty();
// you can also check the start or end of your collection/iterable
Ring[] allRings = array(oneRing, vilya, nenya, narya, dwarfRing, manRing);
assertThat(allRings).startsWith(oneRing, vilya)
.endsWith(dwarfRing, manRing)
.endsWith(manRing);
assertThat(allRings).containsSequence(nenya, narya, dwarfRing);
// you can check that an array is sorted
TolkienCharacter[] fellowshipOfTheRingArray = fellowshipOfTheRing.toArray(new TolkienCharacter[0]);
Arrays.sort(fellowshipOfTheRingArray, ageComparator);
assertThat(fellowshipOfTheRingArray).isSortedAccordingTo(ageComparator);
assertThat(fellowshipOfTheRingArray).usingElementComparator(ageComparator).isSorted();
String[] abc = { "a", "b", "c" };
assertThat(abc).containsExactly("a", "b", "c")
.containsAnyOf("b")
.containsAnyOf("b", "c")
.containsAnyOf("a", "b", "c")
.containsAnyOf("a", "b", "c", "d")
.containsExactly("a", "b", "c");
array = new String[] { "--option", "a=b", "--option", "c=d" };
assertThat(array).containsSequence("--option", "c=d");
// containsSequence would fail but not containsSubsequence.
assertThat(array).as("").containsSubsequence("a=b", "c=d");
}
@Test
public void display_array_with_one_element_per_line() throws Exception {
TolkienCharacter[] fellowshipOfTheRingArray = fellowshipOfTheRing.toArray(new TolkienCharacter[0]);
try {
assertThat(fellowshipOfTheRingArray).contains(sauron);
} catch (AssertionError e) {
logAssertionErrorMessage("isSorted with custom element comparator", e);
}
}
@Test
public void array_assertions_with_custom_comparison_examples() {
TolkienCharacter[] fellowshipOfTheRingCharacters = fellowshipOfTheRing.toArray(new TolkienCharacter[0]);
// standard comparison : the fellowshipOfTheRing includes Gandalf but not Sauron ...
assertThat(fellowshipOfTheRingCharacters).contains(gandalf).doesNotContain(sauron);
// ... but if we compare only race name Sauron is in fellowshipOfTheRing because he's a Maia like Gandalf.
assertThat(fellowshipOfTheRingCharacters).usingElementComparator(raceNameComparator).contains(sauron);
// isSorted assertion honors custom comparator
assertThat(array(sam, gandalf)).isSortedAccordingTo(ageComparator);
assertThat(array(sam, gandalf)).usingElementComparator(ageComparator).isSorted();
// note that error message mentions the comparator used to better understand the failure
try {
assertThat(array(gandalf, sam)).usingElementComparator(ageComparator).isSorted();
} catch (AssertionError e) {
logAssertionErrorMessage("isSorted with custom element comparator", e);
}
// duplicates assertion honors custom comparator :
assertThat(fellowshipOfTheRingCharacters).doesNotHaveDuplicates();
assertThat(array(sam, gandalf)).usingElementComparator(raceNameComparator).doesNotHaveDuplicates();
try {
assertThat(array(sam, gandalf, frodo)).usingElementComparator(raceNameComparator).doesNotHaveDuplicates();
} catch (AssertionError e) {
logAssertionErrorMessage("doesNotHaveDuplicates with custom element comparator", e);
}
}
@Test
public void array_assertions_on_extracted_values_example() {
TolkienCharacter[] fellowshipOfTheRingArray = fellowshipOfTheRing.toArray(new TolkienCharacter[0]);
// extract simple property value (having a java standard type)
assertThat(extractProperty("name").from(fellowshipOfTheRingArray)).contains("Boromir", "Gandalf", "Frodo",
"Legolas")
.doesNotContain("Sauron", "Elrond");
// extracting property works also with user's types (here Race)
assertThat(extractProperty("race").from(fellowshipOfTheRingArray)).contains(HOBBIT, ELF).doesNotContain(ORC);
// same assertion but specifying the type of the extracted values (here Race)
assertThat(fellowshipOfTheRingArray).extracting("race", Race.class)
.contains(HOBBIT, ELF)
.doesNotContain(ORC);
// extract nested property on Race
assertThat(extractProperty("race.name").from(fellowshipOfTheRingArray)).contains("Hobbit", "Elf")
.doesNotContain("Orc");
// same assertions but written with extracting(), it has the advantage of being able to extract field values as well
// as property values
// extract 'name' property values.
assertThat(fellowshipOfTheRing).extracting("name")
.contains("Boromir", "Gandalf", "Frodo", "Legolas")
.doesNotContain("Sauron", "Elrond");
// extract 'age' field values, it works because 'age' is public in TolkienCharacter class.
assertThat(fellowshipOfTheRing).extracting("age")
.contains(33, 38, 36);
// extracting works also with user's types (here Race),
assertThat(fellowshipOfTheRing).extracting("race")
.contains(HOBBIT, ELF)
.doesNotContain(ORC);
// extract nested property values on Race
assertThat(fellowshipOfTheRing).extracting("race.name")
.contains("Hobbit", "Elf")
.doesNotContain("Orc");
}
@Test
public void array_is_sorted_assertion_example() {
// enum order = order of declaration = ring power
assertThat(new Ring[] { oneRing, vilya, nenya, narya, dwarfRing, manRing }).isSorted();
// ring comparison by increasing power
Comparator<Ring> increasingPowerRingComparator = new Comparator<Ring>() {
@Override
public int compare(Ring ring1, Ring ring2) {
return -ring1.compareTo(ring2);
}
};
assertThat(new Ring[] { manRing, dwarfRing, narya, nenya, vilya, oneRing }).isSortedAccordingTo(
increasingPowerRingComparator);
}
@Test
public void filter_then_extract_assertion_example() {
Iterable<TolkienCharacter> badBadGuys = filter(orcsWithHobbitPrisoners).with("race.alignment", EVIL).get();
assertThat(badBadGuys).extracting("name").containsOnly("Guruk");
}
@Test
public void contains_exactly_for_primitive_types_assertion_examples() {
// boolean
assertThat(new boolean[] { true, false }).containsExactly(true, false)
.containsExactly(new Boolean[] { true, false });
// int
assertThat(new int[] { 1, 2, 3 }).containsExactly(1, 2, 3)
.containsExactly(new Integer[] { 1, 2, 3 });
// long
assertThat(new long[] { 1, 2, 3 }).containsExactly(1, 2, 3);
// short
assertThat(new short[] { 1, 2, 3 }).containsExactly((short) 1, (short) 2, (short) 3);
// byte
assertThat(new byte[] { 1, 2, 3 }).containsExactly((byte) 1, (byte) 2, (byte) 3);
// float
assertThat(new float[] { 1, 2.0f, 3 }).containsExactly(1.0f, 2, 3);
// double
assertThat(new double[] { 1.0, 2, 3 }).containsExactly(1.0, 2, 3);
}
@Test
public void containsOnlyOnce_for_primitive_types_assertion_examples() {
// int
assertThat(new int[] { 1, 2, 3 }).containsOnlyOnce(1);
assertThat(new int[] { 1, 2, 3 }).containsOnlyOnce(1, 2);
assertThat(new int[] { 1, 2, 3 }).containsOnlyOnce(1, 2, 3);
assertThat(new int[] { 1, 2, 3 }).containsOnlyOnce(3, 2, 3);
try {
assertThat(new int[] { 1, 2, 1 }).containsOnlyOnce(1);
} catch (AssertionError e) {
logAssertionErrorMessage("containsOnlyOnce for int array", e);
}
try {
assertThat(new int[] { 1, 2, 3 }).containsOnlyOnce(4);
} catch (AssertionError e) {
logAssertionErrorMessage("containsOnlyOnce for int array", e);
}
try {
assertThat(new int[] { 1, 2, 3, 3, 1 }).containsOnlyOnce(0, 1, 2, 3, 4, 5);
} catch (AssertionError e) {
logAssertionErrorMessage("containsOnlyOnce for int array", e);
}
assertThat(new char[] { 'a', 'b', 'c' }).containsOnlyOnce('a', 'b');
}
@Test
public void containsSubSequence_assertion_examples() {
String[] stringArray = { "Batman", "is", "weaker", "than", "Superman", "but", "he", "is", "less", "annoying" };
assertThat(stringArray).containsSubsequence("Superman", "is", "annoying");
assertThat(new String[] { "Breaking", "objects", "is", "pretty", "bad" }).containsSubsequence("Breaking", "bad");
try {
assertThat(new String[] { "A", "B", "C", "D" }).containsSubsequence("B", "A", "C");
} catch (AssertionError e) {
logAssertionErrorMessage("containsSubsequence for Array", e);
}
}
@Test
public void containsOnlyOnce_assertion_should_not_require_objects_to_be_comparable() {
// Rectangles are not Comparable.
Rectangle r0 = new Rectangle(0, 0);
Rectangle r1 = new Rectangle(1, 1);
Rectangle r2 = new Rectangle(2, 2);
assertThat(new Rectangle[] { r1, r2, r2 }).containsOnlyOnce(r1);
try {
assertThat(new Rectangle[] { r1, r2, r2 }).containsOnlyOnce(r0, r1, r2);
} catch (AssertionError e) {
logAssertionErrorMessage("containsOnlyOnce", e);
}
}
@Test
public void hasSameSizeAs_assertion_examples() {
// comparing primitive arrays with primitive arrays
assertThat(new byte[] { 1, 2 }).hasSameSizeAs(new byte[] { 2, 3 });
assertThat(new byte[] { 1, 2 }).hasSameSizeAs(new int[] { 2, 3 });
// comparing primitive arrays with Object array
assertThat(new byte[] { 1, 2 }).hasSameSizeAs(new Byte[] { 2, 3 });
assertThat(new byte[] { 1, 2 }).hasSameSizeAs(new String[] { "1", "2" });
// comparing primitive arrays with Iterable
assertThat(new long[] { 1, 2, 3 }).hasSameSizeAs(newArrayList(vilya, nenya, narya));
// comparing Iterable with object array
assertThat(newArrayList(vilya, nenya, narya)).hasSameSizeAs(new Long[] { 1L, 2L, 3L });
// comparing Iterable with primitive array
assertThat(newArrayList(vilya, nenya, narya)).hasSameSizeAs(new long[] { 1, 2, 3 });
// comparing Iterable with Iterable
assertThat(newArrayList(vilya, nenya, narya)).hasSameSizeAs(newArrayList("vilya", "nenya", "narya"));
// comparing Object array with primitive arrays
assertThat(array(vilya, nenya, narya)).hasSameSizeAs(new long[] { 1, 2, 3 });
// comparing Object array with Iterable
assertThat(array(vilya, nenya, narya)).hasSameSizeAs(newArrayList(nenya, nenya, nenya));
// comparing Object array with Iterable
assertThat(array(vilya, nenya, narya)).hasSameSizeAs(array(nenya, nenya, nenya));
}
@Test
public void use_hexadecimal_representation_in_error_messages() throws UnsupportedEncodingException {
try {
assertThat(new Byte[] { 0x10, 0x20 }).inHexadecimal().contains(new Byte[] { 0x30 });
} catch (AssertionError e) {
logAssertionErrorMessage("asHexadecimal for byte array", e);
}
try {
assertThat("zólc".getBytes()).inHexadecimal().contains("żółć".getBytes("ISO-8859-2"));
} catch (AssertionError e) {
logAssertionErrorMessage("asHexadecimal for byte array", e);
}
}
@Test
public void use_unicode_representation_in_error_messages() {
try {
assertThat("a6c".toCharArray()).inUnicode().isEqualTo("abó".toCharArray());
} catch (AssertionError e) {
logAssertionErrorMessage("inUnicode for char array", e);
}
}
@Test
public void iterable_assertions_on_extracted_private_fields_values_example() {
// extract private fields
final Object[] trilogyArray = trilogy.toArray();
assertThat(trilogyArray).extracting("duration").containsExactly("178 min", "179 min", "201 min");
// disable private field extraction
setAllowExtractingPrivateFields(false);
try {
assertThat(trilogyArray).extracting("duration").containsExactly("178 min", "179 min", "201 min");
failBecauseExceptionWasNotThrown(IntrospectionError.class);
} catch (Exception ignored) {
// ignore
} finally {
// back to default value
setAllowExtractingPrivateFields(true);
}
}
@Test
public void array_assertions_testing_elements_type() throws Exception {
Number[] numbers = { 2, 6L, 8.0 };
assertThat(numbers).hasAtLeastOneElementOfType(Long.class);
assertThat(numbers).hasOnlyElementsOfType(Number.class);
}
@Test
public void iterable_is_subset_of_assertion_example() {
Ring[] elvesRings = array(vilya, nenya, narya);
assertThat(elvesRings).isSubsetOf(ringsOfPower);
try {
assertThat(elvesRings).isSubsetOf(newArrayList(nenya, narya));
} catch (AssertionError e) {
logAssertionErrorMessage("isSubsetOf", e);
}
}
@Test
public void allMatch_iterable_assertion_example() {
TolkienCharacter[] hobbits = { frodo, sam, pippin };
assertThat(hobbits).allMatch(character -> character.getRace() == HOBBIT);
}
@Test
public void extracting_with_lambdas_example() {
TolkienCharacter[] fellowshipOfTheRingArray = fellowshipOfTheRing.toArray(new TolkienCharacter[0]);
assertThat(fellowshipOfTheRingArray).extracting(TolkienCharacter::getName)
.contains("Boromir", "Sam", "Legolas");
assertThat(fellowshipOfTheRingArray).extracting(TolkienCharacter::getName, tc -> tc.age)
.contains(tuple("Boromir", 37),
tuple("Sam", 38),
tuple("Legolas", 1000));
}
@Test
public void array_assertions_comparing_elements_field_by_field_example() {
// this is useful if elements don't have a good equals method implementation.
Employee bill = new Employee("Bill", 60, "Micro$oft");
final Employee[] micro$oftEmployees = array(bill);
Employee appleBill = new Employee("Bill", 60, "Apple");
// this assertion should fail as the company differs but it passes since Employee equals ignores company fields.
assertThat(micro$oftEmployees).contains(appleBill);
// let's make the assertion fails by comparing all Employee's fields instead of using equals.
try {
assertThat(micro$oftEmployees).usingFieldByFieldElementComparator().contains(appleBill);
} catch (AssertionError e) {
logAssertionErrorMessage("contains for Iterable using field by field element comparator", e);
}
// if we don't compare company, appleBill is equivalent to bill.
assertThat(micro$oftEmployees).usingElementComparatorIgnoringFields("company").contains(appleBill);
// if we compare only name and company, youngBill is equivalent to bill ...
Employee youngBill = new Employee("Bill", 25, "Micro$oft");
assertThat(micro$oftEmployees).usingElementComparatorOnFields("company").contains(youngBill);
// ... but not if we compare only age.
try {
assertThat(micro$oftEmployees).usingElementComparatorOnFields("age").contains(youngBill);
} catch (AssertionError e) {
logAssertionErrorMessage("contains for Iterable usingElementComparatorOnFields", e);
}
// another example with usingElementComparatorOnFields
TolkienCharacter frodo = new TolkienCharacter("Frodo", 33, HOBBIT);
TolkienCharacter sam = new TolkienCharacter("Sam", 38, HOBBIT);
// frodo and sam both are hobbits, so they are equals when comparing only race ...
TolkienCharacter[] array = array(frodo);
assertThat(array).usingElementComparatorOnFields("race").contains(sam);
assertThat(array).usingElementComparatorOnFields("race").isEqualTo(array(sam));
// ... but not when comparing both name and race
try {
assertThat(array).usingElementComparatorOnFields("name", "race").contains(sam);
} catch (AssertionError e) {
logAssertionErrorMessage("contains for Iterable usingElementComparatorOnFields", e);
}
}
@Test
public void primitive_arrays_assertion_examples() {
// int
int[] ints = new int[] { 1, 2, 3 };
assertThat(ints).containsExactly(1, 2, 3)
.containsAnyOf(0, 2, 4);
// long
long[] longs = new long[] { 1, 2, 3 };
assertThat(longs).containsExactly(1, 2, 3)
.containsAnyOf(0, 2, 4);
// short
short[] shorts = new short[] { 1, 2, 3 };
assertThat(shorts).containsExactly((short) 1, (short) 2, (short) 3)
.containsAnyOf((short) 0, (short) 2, (short) 4);
// byte
byte[] bytes = new byte[] { 1, 2, 3 };
assertThat(bytes).containsExactly(1, 2, 3)
.containsAnyOf((byte) 0, (byte) 2, (byte) 4);
// float
float[] floats = new float[] { 1, 2.0f, 3 };
assertThat(floats).containsExactly(1.0f, 2, 3)
.containsAnyOf(0, 2.0f, 4);
// double
double[] doubles = new double[] { 1.0, 2, 3 };
assertThat(doubles).containsExactly(1.0, 2, 3)
.containsAnyOf(0, 2.0, 4);
}
@Test
public void zipStatisfy_example() {
Ring[] elvesRings = { vilya, nenya, narya };
String[] elvesRingsToString = { "vilya", "nenya", "narya" };
assertThat(elvesRings).zipSatisfy(elvesRingsToString,
(ring, desc) -> assertThat(ring).hasToString(desc));
}
@Test
public void should_not_produce_warning_for_varargs_parameter() {
MapEntry<Ring, TolkienCharacter>[] ringBearers = array(entry(oneRing, frodo), entry(narya, gandalf));
assertThat(ringBearers).contains(entry(oneRing, frodo), entry(narya, gandalf));
}
}