forked from antoinemeyer/mock-in-bean
-
Notifications
You must be signed in to change notification settings - Fork 0
/
MockInBean.java
85 lines (79 loc) · 3.15 KB
/
MockInBean.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
package com.teketik.test.mockinbean;
import org.mockito.Mock;
import org.springframework.boot.test.mock.mockito.MockBean;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* <p>Annotation used to inject a mockito {@link Mock} in a Spring Bean for the duration of a test.
* <p>This is a convenient alternative to {@link MockBean @MockBean} that provides surgical mock injection without dirtying or polluting the Spring context:<br>
* Mocks are injected for every test method and the original Spring Beans(s) are re-injected after the test class is done.
* <hr>
* <p><strong>Example:</strong><br>
* Assuming you have the following service:<br>
* <pre class="code">
* @Service
* public class MyService {
*
* @Autowired
* private ThirdPartyApi thirdPartyApi;
*
* public Object returnSomethingFromThirdPartyApi() {
* return thirdPartyApi.returnSomething();
* }
* }
* </pre>
* You can create a test for your service with a mocked {@code ThirdPartyApi} like:
* <pre class="code">
* @SpringBootTest
* public class MyServiceTest {
*
* @MockInBean(MyService.class)
* private ThirdPartyApi thirdPartyApi;
*
* @Autowired
* private MyService myService;
*
* @Test
* public void test() {
* final Object expected = new Object();
* Mockito.when(thirdPartyApi.returnSomething()).thenReturn(expected);
* final Object actual = myService.returnSomethingFromThirdPartyApi();
* Assert.assertEquals(expected, actual);
* }
* }
* </pre>
* {@code thirdPartyApi} will be a {@link Mock} that is recreated for every test method in {@code MyServiceTest} and {@code MyService}.<br>
* The original {@code ThirdPartyApi} Spring bean will be re-injected in {@code MyService} after all the tests of {@code MyServiceTest}.
* <hr>
* <p>In case the bean in which you are trying to inject a mock has multiple instances registered in the context, you can specify the {@link #name() name} of the bean:
* <pre class="code">
* @MockInBean(value = MyService.class, name = "nameOfMyService")
* private ThirdPartyApi thirdPartyApi;
* </pre>
* <hr>
* <p>You can also inject your mock in multiple beans by repeating the annotation:
* <pre class="code">
* @MockInBean(MyFirstService.class),
* @MockInBean(MySecondService.class)
* private ThirdPartyApi thirdPartyApi;
* </pre>
* @author Antoine Meyer
* @see SpyInBean
*/
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(MockInBeans.class)
public @interface MockInBean {
/**
* @return the {@code class} of the Spring Bean in which you want your {@link Mock} to be injected for the duration of the test.
*/
Class<?> value();
/**
* @return the {@code name} of the Spring Bean in which you want your {@link Mock} to be injected for the duration of the test.<br>
* This is not necessary and is only useful if your context contains multiple Beans of the same type with different names.
*/
String name() default "";
}