/
AbstractObjectArrayAssert.java
573 lines (523 loc) · 19.5 KB
/
AbstractObjectArrayAssert.java
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
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
/*
* Created on Jul 26, 2010
*
* 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 @2010-2011 the original author or authors.
*/
package org.assertj.core.api;
import static org.assertj.core.internal.Arrays.assertIsArray;
import java.util.Comparator;
import org.assertj.core.data.Index;
import org.assertj.core.groups.FieldsOrPropertiesExtractor;
import org.assertj.core.groups.MethodInvocationResultExtractor;
import org.assertj.core.groups.Tuple;
import org.assertj.core.internal.Arrays;
import org.assertj.core.internal.ComparatorBasedComparisonStrategy;
import org.assertj.core.internal.ObjectArrays;
import org.assertj.core.util.VisibleForTesting;
import org.assertj.core.util.introspection.IntrospectionError;
/**
* Assertion methods for arrays of objects.
* <p>
* To create an instance of this class, invoke <code>{@link Assertions#assertThat(T[])}</code>.
* </p>
*
* @param <T> the type of elements of the "actual" value.
*
* @author Yvonne Wang
* @author Alex Ruiz
* @author Joel Costigliola
* @author Nicolas François
* @author Mikhail Mazursky
*/
public abstract class AbstractObjectArrayAssert<S extends AbstractObjectArrayAssert<S, T>, T>
extends AbstractAssert<S, T[]>
implements
IndexedObjectEnumerableAssert<AbstractObjectArrayAssert<S, T>, T>,
ArraySortedAssert<AbstractObjectArrayAssert<S, T>, T> {
@VisibleForTesting
ObjectArrays arrays = ObjectArrays.instance();
protected AbstractObjectArrayAssert(T[] actual, Class<?> selfType) {
super(actual, selfType);
}
/**
* {@inheritDoc}
* @throws AssertionError {@inheritDoc}
*/
@Override
public void isNullOrEmpty() {
arrays.assertNullOrEmpty(info, actual);
}
/**
* {@inheritDoc}
* @throws AssertionError {@inheritDoc}
*/
@Override
public void isEmpty() {
arrays.assertEmpty(info, actual);
}
/**
* {@inheritDoc}
* @throws AssertionError {@inheritDoc}
*/
@Override
public S isNotEmpty() {
arrays.assertNotEmpty(info, actual);
return myself;
}
/**
* {@inheritDoc}
* @throws AssertionError {@inheritDoc}
*/
@Override
public S hasSize(int expected) {
arrays.assertHasSize(info, actual, expected);
return myself;
}
/**
* {@inheritDoc}
*/
@Override
public S hasSameSizeAs(Object other) {
// TODO same implementation as in AbstractArrayAssert, but can't inherit from it due to generics problem ...
arrays.assertHasSameSizeAs(info, actual, other);
return myself;
}
/** {@inheritDoc} */
@Override
public S hasSameSizeAs(Iterable<?> other) {
arrays.assertHasSameSizeAs(info, actual, other);
return myself;
}
/** {@inheritDoc} */
@Override
public S contains(T... values) {
arrays.assertContains(info, actual, values);
return myself;
}
/** {@inheritDoc} */
@Override
public S containsOnly(T... values) {
arrays.assertContainsOnly(info, actual, values);
return myself;
}
/** {@inheritDoc} */
@Override
public S containsOnlyOnce(T... values) {
arrays.assertContainsOnlyOnce(info, actual, values);
return myself;
}
/** {@inheritDoc} */
@Override
public S containsExactly(T... values) {
objects.assertEqual(info, actual, values);
return myself;
}
/** {@inheritDoc} */
@Override
public S containsSequence(T... sequence) {
arrays.assertContainsSequence(info, actual, sequence);
return myself;
}
/** {@inheritDoc} */
@Override
public S containsSubsequence(T... subsequence) {
arrays.assertContainsSubsequence(info, actual, subsequence);
return myself;
}
/** {@inheritDoc} */
@Override
public S contains(T value, Index index) {
arrays.assertContains(info, actual, value, index);
return myself;
}
/** {@inheritDoc} */
@Override
public S doesNotContain(T value, Index index) {
arrays.assertDoesNotContain(info, actual, value, index);
return myself;
}
/** {@inheritDoc} */
@Override
public S doesNotContain(T... values) {
arrays.assertDoesNotContain(info, actual, values);
return myself;
}
/** {@inheritDoc} */
@Override
public S doesNotHaveDuplicates() {
arrays.assertDoesNotHaveDuplicates(info, actual);
return myself;
}
/** {@inheritDoc} */
@Override
public S startsWith(T... sequence) {
arrays.assertStartsWith(info, actual, sequence);
return myself;
}
/** {@inheritDoc} */
@Override
public S endsWith(T... sequence) {
arrays.assertEndsWith(info, actual, sequence);
return myself;
}
/** {@inheritDoc} */
@Override
public S containsNull() {
arrays.assertContainsNull(info, actual);
return myself;
}
/** {@inheritDoc} */
@Override
public S doesNotContainNull() {
arrays.assertDoesNotContainNull(info, actual);
return myself;
}
/** {@inheritDoc} */
@Override
public S are(Condition<? super T> condition) {
arrays.assertAre(info, actual, condition);
return myself;
}
/** {@inheritDoc} */
@Override
public S areNot(Condition<? super T> condition) {
arrays.assertAreNot(info, actual, condition);
return myself;
}
/** {@inheritDoc} */
@Override
public S have(Condition<? super T> condition) {
arrays.assertHave(info, actual, condition);
return myself;
}
/** {@inheritDoc} */
@Override
public S doNotHave(Condition<? super T> condition) {
arrays.assertDoNotHave(info, actual, condition);
return myself;
}
/** {@inheritDoc} */
@Override
public S areAtLeast(int times, Condition<? super T> condition) {
arrays.assertAreAtLeast(info, actual, times, condition);
return myself;
}
/** {@inheritDoc} */
@Override
public S areAtMost(int times, Condition<? super T> condition) {
arrays.assertAreAtMost(info, actual, times, condition);
return myself;
}
/** {@inheritDoc} */
@Override
public S areExactly(int times, Condition<? super T> condition) {
arrays.assertAreExactly(info, actual, times, condition);
return myself;
}
/** {@inheritDoc} */
@Override
public S haveAtLeast(int times, Condition<? super T> condition) {
arrays.assertHaveAtLeast(info, actual, times, condition);
return myself;
}
/** {@inheritDoc} */
@Override
public S haveAtMost(int times, Condition<? super T> condition) {
arrays.assertHaveAtMost(info, actual, times, condition);
return myself;
}
/** {@inheritDoc} */
@Override
public S haveExactly(int times, Condition<? super T> condition) {
arrays.assertHaveExactly(info, actual, times, condition);
return myself;
}
/** {@inheritDoc} */
@Override
public S isSorted() {
arrays.assertIsSorted(info, actual);
return myself;
}
/** {@inheritDoc} */
@Override
public S isSortedAccordingTo(Comparator<? super T> comparator) {
arrays.assertIsSortedAccordingToComparator(info, actual, comparator);
return myself;
}
/** {@inheritDoc} */
@Override
public S containsAll(Iterable<? extends T> iterable) {
arrays.assertContainsAll(info, actual, iterable);
return myself;
}
@Override
public S usingElementComparator(Comparator<? super T> customComparator) {
this.arrays = new ObjectArrays(new ComparatorBasedComparisonStrategy(customComparator));
return myself;
}
@Override
public S usingDefaultElementComparator() {
this.arrays = ObjectArrays.instance();
return myself;
}
/**
* Extract the values of given field or property from the array's elements under test into a new array, this new array
* becoming the array under test.
* <p>
* It allows you to test a field/property of the array's elements instead of testing the elements themselves, it can
* be sometimes much less work !
* <p>
* Let's take an example to make things clearer :
*
* <pre>
* // Build a array of TolkienCharacter, a TolkienCharacter has a name (String) and a Race (a class)
* // they can be public field or properties, both works when extracting their values.
* TolkienCharacter[] fellowshipOfTheRing = new TolkienCharacter[] {
* new TolkienCharacter("Frodo", 33, HOBBIT),
* new TolkienCharacter("Sam", 38, HOBBIT),
* new TolkienCharacter("Gandalf", 2020, MAIA),
* new TolkienCharacter("Legolas", 1000, ELF),
* new TolkienCharacter("Pippin", 28, HOBBIT),
* new TolkienCharacter("Gimli", 139, DWARF),
* new TolkienCharacter("Aragorn", 87, MAN,
* new TolkienCharacter("Boromir", 37, MAN)
* };
*
* // let's verify the names of TolkienCharacter in fellowshipOfTheRing :
*
* assertThat(fellowshipOfTheRing).extracting("name")
* .contains("Boromir", "Gandalf", "Frodo")
* .doesNotContain("Sauron", "Elrond");
*
* // you can also extract nested field/property like the name of Race :
*
* assertThat(fellowshipOfTheRing).extracting("race.name")
* .contains("Hobbit", "Elf")
* .doesNotContain("Orc");
* </pre>
*
* A field with the given name is looked for first, if it is not accessible (ie. does not exist or is not public) then
* a property with the given name is looked for.
* <p>
* It works only if all objects have the field or all objects have the property with the given name, i.e. it won't
* work if half of the objects have the field and the other the property.
* <p>
* Note that the order of extracted field/property values is consistent with the array order.
*
* @param fieldOrProperty the field/property to extract from the array under test
* @return a new assertion object whose object under test is the array of extracted field/property values.
* @throws IntrospectionError if no field or property exists with the given name (or field exists but is not public)
*/
public ObjectArrayAssert<Object> extracting(String fieldOrProperty) {
Object[] values = FieldsOrPropertiesExtractor.extract(fieldOrProperty, actual);
return new ObjectArrayAssert<Object>(values);
}
/**
* Extract the values of given field or property from the array's elements under test into a new array, this new array
* becoming the array under test with type.
* <p>
* It allows you to test a field/property of the array's elements instead of testing the elements themselves, it can
* be sometimes much less work !
* <p>
* Let's take an example to make things clearer :
*
* <pre>
* // Build a array of TolkienCharacter, a TolkienCharacter has a name (String) and a Race (a class)
* // they can be public field or properties, both works when extracting their values.
* TolkienCharacter[] fellowshipOfTheRing = new TolkienCharacter[] {
* new TolkienCharacter("Frodo", 33, HOBBIT),
* new TolkienCharacter("Sam", 38, HOBBIT),
* new TolkienCharacter("Gandalf", 2020, MAIA),
* new TolkienCharacter("Legolas", 1000, ELF),
* new TolkienCharacter("Pippin", 28, HOBBIT),
* new TolkienCharacter("Gimli", 139, DWARF),
* new TolkienCharacter("Aragorn", 87, MAN,
* new TolkienCharacter("Boromir", 37, MAN)
* };
*
* // let's verify the names of TolkienCharacter in fellowshipOfTheRing :
*
* assertThat(fellowshipOfTheRing).extracting("name", String.class)
* .contains("Boromir", "Gandalf", "Frodo")
* .doesNotContain("Sauron", "Elrond");
*
* // you can also extract nested field/property like the name of Race :
*
* assertThat(fellowshipOfTheRing).extracting("race.name", String.class)
* .contains("Hobbit", "Elf")
* .doesNotContain("Orc");
* </pre>
*
* A field with the given name is looked for first, if it is not accessible (ie. does not exist or is not public) then
* a property with the given name is looked for.
* <p>
* It works only if all objects have the field or all objects have the property with the given name, i.e. it won't
* work if half of the objects have the field and the other the property.
* <p>
* Note that the order of extracted field/property values is consistent with the order of the array under test.
*
* @param fieldOrProperty the field/property to extract from the array under test
* @param extractingType type to return
* @return a new assertion object whose object under test is the array of extracted field/property values.
* @throws IntrospectionError if no field or property exists with the given name (or field exists but is not public)
*/
public <P> ObjectArrayAssert<P> extracting(String fieldOrProperty, Class<P> extractingType) {
@SuppressWarnings("unchecked")
P[] values = (P[]) FieldsOrPropertiesExtractor.extract(fieldOrProperty, actual);
return new ObjectArrayAssert<P>(values);
}
// TODO : write javadoc !
public ObjectArrayAssert<Tuple> extracting(String... fieldsOrProperties) {
Tuple[] values = FieldsOrPropertiesExtractor.extract(actual, fieldsOrProperties);
return new ObjectArrayAssert<Tuple>(values);
}
/**
* Extract the result of given method invocation from the array's elements under test into a new array, this new array
* becoming the array under test.
* <p>
* It allows you to test a method reslts of the array's elements instead of testing the elements themselves, it can
* be sometimes much less work!
* <p>
* It is especially usefull for classes that does not conform to Java Bean's getter specification (i.e. public String toString() or public String status() instead
* of public String getStatus()).
* <p>
* Let's take an example to make things clearer :
*
* <pre>
* // Build a array of WesterosHouse, a WesterosHouse has a method: public String sayTheWords()
* WesterosHouse[] greatHousesOfWesteros = new WesterosHouse[] {
* new WesterosHouse("Stark", "Winter is Comming"),
* new WesterosHouse("Lannister", "Hear Me Roar!"),
* new WesterosHouse("Greyjoy", "We Do Not Sow"),
* new WesterosHouse("Baratheon", "Our is the Fury"),
* new WesterosHouse("Martell", "Unbowed, Unbent, Unbroken"),
* new WesterosHouse("Tyrell", "Growing Strong")
* };
*
* // let's verify the words of great houses in Westeros:
*
* assertThat(greatHousesOfWesteros).extractingResultOf("sayTheWords")
* .contains("Winter is Comming", "We Do Not Sow", "Hear Me Roar")
* .doesNotContain("Lannisters always pay their debts");
* </pre>
*
* <p>
* Following requirements have to be met to extract method results:
* <ul>
* <li>method has to be public,</li>
* <li>method cannot accept any arguments,</li>
* <li>method cannot return void.</li>
* </ul>
* <p>
* Note that the order of extracted values is consistent with the order of the array under test.
*
* @param method the name of the method which result is to be extracted from the array under test
* @return a new assertion object whose object under test is the array of extracted values.
* @throws IllegalArgumentException if no method exists with the given name, or method is not public,
* or method does return void, or method accepts arguments.
*/
public ObjectArrayAssert<Object> extractingResultOf(String method) {
Object[] values = MethodInvocationResultExtractor.extractResultOf(method, actual);
return new ObjectArrayAssert<Object>(values);
}
/**
* Extract the result of given method invocation from the array's elements under test into a new array, this new array
* becoming the array under test.
* <p>
* It allows you to test a method reslts of the array's elements instead of testing the elements themselves, it can
* be sometimes much less work!
* <p>
* It is especially usefull for classes that does not conform to Java Bean's getter specification (i.e. public String toString() or public String status() instead
* of public String getStatus()).
* <p>
* Let's take an example to make things clearer :
*
* <pre>
* // Build a array of WesterosHouse, a WesterosHouse has a method: public String sayTheWords()
* WesterosHouse[] greatHousesOfWesteros = new WesterosHouse[] {
* new WesterosHouse("Stark", "Winter is Comming"),
* new WesterosHouse("Lannister", "Hear Me Roar!"),
* new WesterosHouse("Greyjoy", "We Do Not Sow"),
* new WesterosHouse("Baratheon", "Our is the Fury"),
* new WesterosHouse("Martell", "Unbowed, Unbent, Unbroken"),
* new WesterosHouse("Tyrell", "Growing Strong")
* };
*
* // let's verify the words of great houses in Westeros:
*
* assertThat(greatHousesOfWesteros).extractingResultOf("sayTheWords", String.class)
* .contains("Winter is Comming", "We Do Not Sow", "Hear Me Roar")
* .doesNotContain("Lannisters always pay their debts");
* </pre>
*
* <p>
* Following requirements have to be met to extract method results:
* <ul>
* <li>method has to be public,</li>
* <li>method can not accept any arguments,</li>
* <li>method can not return void.</li>
* </ul>
* <p>
* Note that the order of extracted values is consistent with the order of the array under test.
*
* @param method the name of the method which result is to be extracted from the array under test
* @param extractingType type to return
* @return a new assertion object whose object under test is the array of extracted values.
* @throws IllegalArgumentException if no method exists with the given name, or method is not public,
* or method does return void, or method accepts arguments.
*/
public <P> ObjectArrayAssert<P> extractingResultOf(String method, Class<P> extractingType) {
@SuppressWarnings("unchecked")
P[] values = (P[]) MethodInvocationResultExtractor.extractResultOf(method, actual);
return new ObjectArrayAssert<P>(values);
}
/**
* Enable hexadecimal object representation of Itearble elements instead of standard java representation in error messages.
* <p/>
* It can be useful to better understand what the error was with a more meaningful error message.
* <p/>
* Example
* <pre>
* assertThat(new Byte[]{0x10,0x20}).asHexadecimal().contains(new Byte[]{0x30});
* </pre>
*
* With standard error message:
* <pre>
* Expecting:
* <[16, 32]>
* to contain:
* <[48]>
* but could not find:
* <[48]>
* </pre>
*
* With Hexadecimal error message:
* <pre>
* Expecting:
* <[0x10, 0x20]>
* to contain:
* <[0x30]>
* but could not find:
* <[0x30]>
* </pre>
*
* @return {@code this} assertion object.
*/
@Override
public S asHexadecimal() {
return super.asHexadecimal();
}
@Override
public S asBinary() {
return super.asBinary();
}
}