/
BDDMockito.java
557 lines (479 loc) · 16.3 KB
/
BDDMockito.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
/*
* Copyright (c) 2007 Mockito contributors
* This program is made available under the terms of the MIT License.
*/
package org.mockito;
import org.mockito.stubbing.Answer;
import org.mockito.stubbing.OngoingStubbing;
import org.mockito.stubbing.Stubber;
import org.mockito.verification.VerificationMode;
/**
* Behavior Driven Development style of writing tests uses <b>//given //when //then</b> comments as fundamental parts of your test methods.
* This is exactly how we write our tests and we warmly encourage you to do so!
* <p>
* Start learning about BDD here: <a href="http://en.wikipedia.org/wiki/Behavior_Driven_Development">http://en.wikipedia.org/wiki/Behavior_Driven_Development</a>
* <p>
* The problem is that current stubbing api with canonical role of <b>when</b> word does not integrate nicely with <b>//given //when //then</b> comments.
* It's because stubbing belongs to <b>given</b> component of the test and not to the <b>when</b> component of the test.
* Hence {@link BDDMockito} class introduces an alias so that you stub method calls with {@link BDDMockito#given(Object)} method.
* Now it really nicely integrates with the <b>given</b> component of a BDD style test!
* <p>
* Here is how the test might look like:
* <pre class="code"><code class="java">
* import static org.mockito.BDDMockito.*;
*
* Seller seller = mock(Seller.class);
* Shop shop = new Shop(seller);
*
* public void shouldBuyBread() throws Exception {
* //given
* given(seller.askForBread()).willReturn(new Bread());
*
* //when
* Goods goods = shop.buyBread();
*
* //then
* assertThat(goods, containBread());
* }
* </code></pre>
*
* Stubbing voids with throwables:
* <pre class="code"><code class="java">
* //given
* willThrow(new RuntimeException("boo")).given(mock).foo();
*
* //when
* Result result = systemUnderTest.perform();
*
* //then
* assertEquals(failure, result);
* </code></pre>
* <p>
* For BDD style mock verification take a look at {@link Then} in action:
* <pre class="code"><code class="java">
* person.ride(bike);
* person.ride(bike);
*
* then(person).should(times(2)).ride(bike);
* then(person).shouldHaveNoMoreInteractions();
* then(police).shouldHaveZeroInteractions();
* </code></pre>
* <p>
* It is also possible to do BDD style {@link InOrder} verification:
* <pre class="code"><code class="java">
* InOrder inOrder = inOrder(person);
*
* person.drive(car);
* person.ride(bike);
* person.ride(bike);
*
* then(person).should(inOrder).drive(car);
* then(person).should(inOrder, times(2)).ride(bike);
* </code></pre>
* <p>
* One of the purposes of BDDMockito is also to show how to tailor the mocking syntax to a different programming style.
*
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public class BDDMockito extends Mockito {
/**
* See original {@link OngoingStubbing}
* @since 1.8.0
*/
public interface BDDMyOngoingStubbing<T> {
/**
* See original {@link OngoingStubbing#thenAnswer(Answer)}
* @since 1.8.0
*/
BDDMyOngoingStubbing<T> willAnswer(Answer<?> answer);
/**
* See original {@link OngoingStubbing#then(Answer)}
* @since 1.9.0
*/
BDDMyOngoingStubbing<T> will(Answer<?> answer);
/**
* See original {@link OngoingStubbing#thenReturn(Object)}
* @since 1.8.0
*/
BDDMyOngoingStubbing<T> willReturn(T value);
/**
* See original {@link OngoingStubbing#thenReturn(Object, Object[])}
* @since 1.8.0
*/
@SuppressWarnings({"unchecked", "varargs"})
BDDMyOngoingStubbing<T> willReturn(T value, T... values);
/**
* See original {@link OngoingStubbing#thenThrow(Throwable...)}
* @since 1.8.0
*/
BDDMyOngoingStubbing<T> willThrow(Throwable... throwables);
/**
* See original {@link OngoingStubbing#thenThrow(Class)}
* @since 2.1.0
*/
BDDMyOngoingStubbing<T> willThrow(Class<? extends Throwable> throwableType);
/**
* See original {@link OngoingStubbing#thenThrow(Class, Class[])}
* @since 2.1.0
*/
// Additional method helps users of JDK7+ to hide heap pollution / unchecked generics array
// creation
@SuppressWarnings({"unchecked", "varargs"})
BDDMyOngoingStubbing<T> willThrow(
Class<? extends Throwable> throwableType,
Class<? extends Throwable>... throwableTypes);
/**
* See original {@link OngoingStubbing#thenCallRealMethod()}
* @since 1.9.0
*/
BDDMyOngoingStubbing<T> willCallRealMethod();
/**
* See original {@link OngoingStubbing#getMock()}
* @since 1.9.0
*/
<M> M getMock();
}
private static class BDDOngoingStubbingImpl<T> implements BDDMyOngoingStubbing<T> {
private final OngoingStubbing<T> mockitoOngoingStubbing;
public BDDOngoingStubbingImpl(OngoingStubbing<T> ongoingStubbing) {
this.mockitoOngoingStubbing = ongoingStubbing;
}
public BDDMyOngoingStubbing<T> willAnswer(Answer<?> answer) {
return new BDDOngoingStubbingImpl<T>(mockitoOngoingStubbing.thenAnswer(answer));
}
public BDDMyOngoingStubbing<T> will(Answer<?> answer) {
return new BDDOngoingStubbingImpl<T>(mockitoOngoingStubbing.then(answer));
}
public BDDMyOngoingStubbing<T> willReturn(T value) {
return new BDDOngoingStubbingImpl<T>(mockitoOngoingStubbing.thenReturn(value));
}
public BDDMyOngoingStubbing<T> willReturn(T value, T... values) {
return new BDDOngoingStubbingImpl<T>(mockitoOngoingStubbing.thenReturn(value, values));
}
public BDDMyOngoingStubbing<T> willThrow(Throwable... throwables) {
return new BDDOngoingStubbingImpl<T>(mockitoOngoingStubbing.thenThrow(throwables));
}
public BDDMyOngoingStubbing<T> willThrow(Class<? extends Throwable> throwableType) {
return new BDDOngoingStubbingImpl<T>(mockitoOngoingStubbing.thenThrow(throwableType));
}
public BDDMyOngoingStubbing<T> willThrow(
Class<? extends Throwable> throwableType,
Class<? extends Throwable>... throwableTypes) {
return new BDDOngoingStubbingImpl<T>(
mockitoOngoingStubbing.thenThrow(throwableType, throwableTypes));
}
public BDDMyOngoingStubbing<T> willCallRealMethod() {
return new BDDOngoingStubbingImpl<T>(mockitoOngoingStubbing.thenCallRealMethod());
}
public <M> M getMock() {
return (M) mockitoOngoingStubbing.getMock();
}
}
/**
* see original {@link Mockito#when(Object)}
* @since 1.8.0
*/
public static <T> BDDMyOngoingStubbing<T> given(T methodCall) {
return new BDDOngoingStubbingImpl<T>(Mockito.when(methodCall));
}
/**
* Bdd style verification of mock behavior.
*
* <pre class="code"><code class="java">
* person.ride(bike);
* person.ride(bike);
*
* then(person).should(times(2)).ride(bike);
* </code></pre>
*
* @see #verify(Object)
* @see #verify(Object, VerificationMode)
* @since 1.10.0
*/
public static <T> Then<T> then(T mock) {
return new ThenImpl<T>(mock);
}
/**
* Provides fluent way of mock verification.
*
* @param <T> type of the mock
*
* @since 1.10.5
*/
public interface Then<T> {
/**
* @see #verify(Object)
* @since 1.10.5
*/
T should();
/**
* @see #verify(Object, VerificationMode)
* @since 1.10.5
*/
T should(VerificationMode mode);
/**
* @see InOrder#verify(Object)
* @since 2.1.0
*/
T should(InOrder inOrder);
/**
* @see InOrder#verify(Object, VerificationMode)
* @since 2.1.0
*/
T should(InOrder inOrder, VerificationMode mode);
/**
* @see #verifyZeroInteractions(Object...)
* @since 2.1.0
* @deprecated Since 3.0.1. Please migrate your code to {@link #shouldHaveNoInteractions()}
*/
@Deprecated
void shouldHaveZeroInteractions();
/**
* @see #verifyNoMoreInteractions(Object...)
* @since 2.1.0
*/
void shouldHaveNoMoreInteractions();
/**
* @see #verifyNoInteractions(Object...)
* @since 3.0.1
*/
void shouldHaveNoInteractions();
}
private static class ThenImpl<T> implements Then<T> {
private final T mock;
ThenImpl(T mock) {
this.mock = mock;
}
/**
* @see #verify(Object)
* @since 1.10.5
*/
public T should() {
return verify(mock);
}
/**
* @see #verify(Object, VerificationMode)
* @since 1.10.5
*/
public T should(VerificationMode mode) {
return verify(mock, mode);
}
/**
* @see InOrder#verify(Object)
* @since 2.1.0
*/
public T should(InOrder inOrder) {
return inOrder.verify(mock);
}
/**
* @see InOrder#verify(Object, VerificationMode)
* @since 2.1.0
*/
public T should(InOrder inOrder, VerificationMode mode) {
return inOrder.verify(mock, mode);
}
/**
* @see #verifyZeroInteractions(Object...)
* @since 2.1.0
*/
public void shouldHaveZeroInteractions() {
verifyZeroInteractions(mock);
}
/**
* @see #verifyNoMoreInteractions(Object...)
* @since 2.1.0
*/
public void shouldHaveNoMoreInteractions() {
verifyNoMoreInteractions(mock);
}
/**
* @see #verifyNoInteractions(Object...)
* @since 3.0.1
*/
public void shouldHaveNoInteractions() {
verifyNoInteractions(mock);
}
}
/**
* See original {@link Stubber}
* @since 1.8.0
*/
public interface BDDStubber {
/**
* See original {@link Stubber#doAnswer(Answer)}
* @since 1.8.0
*/
BDDStubber willAnswer(Answer<?> answer);
/**
* See original {@link Stubber#doAnswer(Answer)}
* @since 1.8.0
*/
BDDStubber will(Answer<?> answer);
/**
* See original {@link Stubber#doNothing()}.
*
* This method will be removed in version 4.0.0
*
* @since 1.8.0
* @deprecated as of 2.1.0 please use {@link #willDoNothing()} instead
*/
@Deprecated
BDDStubber willNothing();
/**
* See original {@link Stubber#doNothing()}
* @since 1.10.20
*/
BDDStubber willDoNothing();
/**
* See original {@link Stubber#doReturn(Object)}
* @since 2.1.0
*/
BDDStubber willReturn(Object toBeReturned);
/**
* See original {@link Stubber#doReturn(Object)}
* @since 2.1.0
*/
@SuppressWarnings({"unchecked", "varargs"})
BDDStubber willReturn(Object toBeReturned, Object... nextToBeReturned);
/**
* See original {@link Stubber#doThrow(Throwable...)}
* @since 1.8.0
*/
BDDStubber willThrow(Throwable... toBeThrown);
/**
* See original {@link Stubber#doThrow(Class)}
* @since 2.1.0
*/
BDDStubber willThrow(Class<? extends Throwable> toBeThrown);
/**
* See original {@link Stubber#doThrow(Class, Class[])}
* @since 2.1.0
*/
@SuppressWarnings({"unchecked", "varargs"})
BDDStubber willThrow(
Class<? extends Throwable> toBeThrown,
Class<? extends Throwable>... nextToBeThrown);
/**
* See original {@link Stubber#doCallRealMethod()}
* @since 1.9.0
*/
BDDStubber willCallRealMethod();
/**
* See original {@link Stubber#when(Object)}
* @since 1.8.0
*/
<T> T given(T mock);
}
private static class BDDStubberImpl implements BDDStubber {
private final Stubber mockitoStubber;
public BDDStubberImpl(Stubber mockitoStubber) {
this.mockitoStubber = mockitoStubber;
}
public <T> T given(T mock) {
return mockitoStubber.when(mock);
}
public BDDStubber willAnswer(Answer<?> answer) {
return new BDDStubberImpl(mockitoStubber.doAnswer(answer));
}
public BDDStubber will(Answer<?> answer) {
return new BDDStubberImpl(mockitoStubber.doAnswer(answer));
}
/**
* @deprecated please use {@link #willDoNothing()} instead
*/
@Deprecated
public BDDStubber willNothing() {
return willDoNothing();
}
public BDDStubber willDoNothing() {
return new BDDStubberImpl(mockitoStubber.doNothing());
}
public BDDStubber willReturn(Object toBeReturned) {
return new BDDStubberImpl(mockitoStubber.doReturn(toBeReturned));
}
public BDDStubber willReturn(Object toBeReturned, Object... nextToBeReturned) {
return new BDDStubberImpl(
mockitoStubber.doReturn(toBeReturned).doReturn(nextToBeReturned));
}
public BDDStubber willThrow(Throwable... toBeThrown) {
return new BDDStubberImpl(mockitoStubber.doThrow(toBeThrown));
}
public BDDStubber willThrow(Class<? extends Throwable> toBeThrown) {
return new BDDStubberImpl(mockitoStubber.doThrow(toBeThrown));
}
public BDDStubber willThrow(
Class<? extends Throwable> toBeThrown,
Class<? extends Throwable>... nextToBeThrown) {
return new BDDStubberImpl(mockitoStubber.doThrow(toBeThrown, nextToBeThrown));
}
public BDDStubber willCallRealMethod() {
return new BDDStubberImpl(mockitoStubber.doCallRealMethod());
}
}
/**
* see original {@link Mockito#doThrow(Throwable[])}
* @since 2.1.0
*/
public static BDDStubber willThrow(Throwable... toBeThrown) {
return new BDDStubberImpl(Mockito.doThrow(toBeThrown));
}
/**
* see original {@link Mockito#doThrow(Class)}
* @since 1.9.0
*/
public static BDDStubber willThrow(Class<? extends Throwable> toBeThrown) {
return new BDDStubberImpl(Mockito.doThrow(toBeThrown));
}
/**
* see original {@link Mockito#doThrow(Class)}
* @since 1.9.0
*/
public static BDDStubber willThrow(
Class<? extends Throwable> toBeThrown, Class<? extends Throwable>... throwableTypes) {
return new BDDStubberImpl(Mockito.doThrow(toBeThrown, throwableTypes));
}
/**
* see original {@link Mockito#doAnswer(Answer)}
* @since 1.8.0
*/
public static BDDStubber willAnswer(Answer<?> answer) {
return new BDDStubberImpl(Mockito.doAnswer(answer));
}
/**
* see original {@link Mockito#doAnswer(Answer)}
* @since 2.1.0
*/
public static BDDStubber will(Answer<?> answer) {
return new BDDStubberImpl(Mockito.doAnswer(answer));
}
/**
* see original {@link Mockito#doNothing()}
* @since 1.8.0
*/
public static BDDStubber willDoNothing() {
return new BDDStubberImpl(Mockito.doNothing());
}
/**
* see original {@link Mockito#doReturn(Object)}
* @since 1.8.0
*/
public static BDDStubber willReturn(Object toBeReturned) {
return new BDDStubberImpl(Mockito.doReturn(toBeReturned));
}
/**
* see original {@link Mockito#doReturn(Object, Object...)}
* @since 2.1.0
*/
@SuppressWarnings({"unchecked", "varargs"})
public static BDDStubber willReturn(Object toBeReturned, Object... toBeReturnedNext) {
return new BDDStubberImpl(Mockito.doReturn(toBeReturned, toBeReturnedNext));
}
/**
* see original {@link Mockito#doCallRealMethod()}
* @since 1.8.0
*/
public static BDDStubber willCallRealMethod() {
return new BDDStubberImpl(Mockito.doCallRealMethod());
}
}