@MockBean for Spring mocking in JUnit - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the @MockBean annotation in Spring testing?

@MockBean creates and injects a mock of a Spring bean into the application context during tests. It replaces the real bean with a mock to isolate the unit under test.

intermediate

How does @MockBean differ from Mockito's @Mock annotation?

@MockBean integrates with Spring's application context and replaces beans there, while @Mock creates a mock object but does not replace Spring beans automatically.

beginner

Where should you place the @MockBean annotation in a Spring Boot test?

<p>You place <code>@MockBean</code> on a field in your test class where you want Spring to inject the mock bean instead of the real one.</p>

beginner

Can @MockBean be used to mock multiple beans in the same test?

<p>Yes, you can declare multiple <code>@MockBean</code> fields in the same test class to mock different beans as needed.</p>

intermediate

What happens if you use @MockBean on a bean that is not present in the Spring context?

Spring will add the mock bean to the context, so it can be used by other beans or the test, even if the original bean was not defined.

What does @MockBean do in a Spring Boot test?

A Replaces a Spring bean with a mock in the application context

B Creates a mock object but does not affect Spring beans

C Runs the real bean without mocking

D Disables Spring context loading

@MockBean replaces the real Spring bean with a mock in the application context during tests.

Where do you declare @MockBean in your test code?

A Inside the bean class

B On the main application class

C On a field in the test class

D In the application.properties file

You declare @MockBean on a field in the test class to inject the mock bean.

Which of these is a key benefit of using @MockBean over @Mock?

A It disables all beans except mocks

B It runs tests faster by skipping mocks

C It automatically generates test data

D It integrates mocks into Spring's application context

@MockBean integrates mocks into Spring's context, replacing real beans.

Can you use multiple @MockBean annotations in one test class?

A Only in integration tests

B Yes, to mock multiple beans

C Only if beans are of the same type

D No, only one mock bean per test

You can declare multiple @MockBean fields to mock different beans.

What happens if @MockBean is used on a bean not originally in the Spring context?

A Spring adds the mock bean to the context

B Test fails to start

C Mock is ignored

D Spring throws an error

Spring adds the mock bean to the context even if the original bean was missing.

Explain how @MockBean helps isolate units in Spring Boot tests.

Think about how mocking helps focus on one part of the code.

Describe the difference between @MockBean and @Mock in Spring testing.

Consider how Spring manages beans versus plain mocks.

Practice

1. What is the main purpose of using @MockBean in Spring tests?

easy

A. To replace a real Spring bean with a mock during testing

B. To create a new Spring bean in the application context

C. To run the application without any beans

D. To automatically generate test data for the application

Solution

1. Step 1: Understand the role of @MockBean

   @MockBean is used to replace a real Spring bean with a mock version during tests to isolate the tested component.

2. Step 2: Compare options with the purpose

   Only To replace a real Spring bean with a mock during testing correctly describes this purpose. Other options describe unrelated behaviors.

3. Final Answer:

   To replace a real Spring bean with a mock during testing -> Option A

4. Quick Check:

   @MockBean replaces beans = A [OK]

Hint: Remember: @MockBean swaps real beans with mocks [OK]

Common Mistakes:

• Thinking @MockBean creates new beans instead of replacing
• Confusing @MockBean with test data generation
• Assuming @MockBean disables all beans

2. Which of the following is the correct way to declare a mock bean in a Spring test class?

easy

A. @Mock private MyService myService;

B. @InjectMocks private MyService myService;

C. @Autowired private MyService myService;

D. @MockBean private MyService myService;

Solution

1. Step 1: Identify the correct annotation for Spring mock beans

   @MockBean is the Spring Boot test annotation to create mock beans in the application context.

2. Step 2: Check the options

   @MockBean private MyService myService; uses @MockBean correctly. Options A and D are Mockito annotations but not for Spring context replacement. @Autowired private MyService myService; is for injecting real beans.

3. Final Answer:

   @MockBean private MyService myService; -> Option D

4. Quick Check:

   @MockBean syntax = B [OK]

Hint: Use @MockBean for Spring context mocks, not @Mock or @InjectMocks [OK]

Common Mistakes:

• Using @Mock instead of @MockBean in Spring tests
• Confusing @Autowired with mocking
• Using @InjectMocks outside Mockito context

3. Given the following test code snippet, what will be the output of myService.getData() if myService is annotated with @MockBean and no behavior is defined?

@MockBean
private MyService myService;

@Test
void test() {
    System.out.println(myService.getData());
}

medium

A. Throws NullPointerException

B. Actual data from MyService implementation

C. null

D. Empty string

Solution

1. Step 1: Understand default behavior of @MockBean mocks

   @MockBean creates a Mockito mock. By default, methods return null for objects unless stubbed.

2. Step 2: Analyze the code snippet

   No behavior is defined for getData(), so it returns null by default.

3. Final Answer:

   null -> Option C

4. Quick Check:

   Unstubbed mock method returns null = C [OK]

Hint: Unstubbed mock methods return null by default [OK]

Common Mistakes:

• Expecting real method execution instead of mock
• Assuming default return is empty string or exception
• Confusing @MockBean with real bean injection

4. Identify the error in the following Spring test class using @MockBean:

@SpringBootTest
public class UserServiceTest {

    @MockBean
    private UserRepository userRepository;

    @Test
    public void testFindUser() {
        when(userRepository.findById(1L)).thenReturn(Optional.of(new User()));
        // test logic
    }
}

medium

A. Missing @RunWith(SpringRunner.class) or @ExtendWith(SpringExtension.class)

B. No error, the code is correct

C. UserRepository should be annotated with @Autowired, not @MockBean

D. Incorrect use of when() without MockitoAnnotations.initMocks()

Solution

1. Step 1: Check Spring test setup requirements

   @SpringBootTest provides the Spring context and necessary extensions (meta-annotated with @ExtendWith(SpringExtension.class)), enabling @MockBean.

2. Step 2: Analyze the code

   @MockBean is used correctly. Stubbing with when().thenReturn() works without additional Mockito initialization in Spring Boot tests.

3. Final Answer:

   No error, the code is correct -> Option B

4. Quick Check:

   @SpringBootTest enables @MockBean = D [OK]

Hint: @SpringBootTest is sufficient for @MockBean tests [OK]

Common Mistakes:

• Thinking @RunWith or @ExtendWith is required with @SpringBootTest
• Using MockitoAnnotations.initMocks() with @MockBean
• Annotating mocks with @Autowired

5. You have a Spring service OrderService that depends on PaymentService. You want to test OrderService without calling the real PaymentService. Which approach correctly uses @MockBean to achieve this?

@SpringBootTest
public class OrderServiceTest {

    @Autowired
    private OrderService orderService;

    // What should be here?

    @Test
    public void testPlaceOrder() {
        when(paymentService.processPayment(any())).thenReturn(true);
        boolean result = orderService.placeOrder(new Order());
        assertTrue(result);
    }
}

hard

A. @MockBean
private PaymentService paymentService;

B. @Mock
private PaymentService paymentService;

C. @Autowired
private PaymentService paymentService;

D. No declaration needed; real PaymentService will be used

Solution

1. Step 1: Understand the goal

   We want to test OrderService but replace PaymentService with a mock to avoid real calls.

2. Step 2: Choose the correct annotation

   @MockBean replaces the Spring bean in the context with a mock, so @MockBean private PaymentService paymentService; is correct. @Mock is Mockito-only and won't replace Spring beans. @Autowired injects real bean. No declaration uses real service.

3. Final Answer:

   @MockBean private PaymentService paymentService; -> Option A

4. Quick Check:

   Use @MockBean to mock Spring dependencies = D [OK]

Hint: Use @MockBean to mock Spring dependencies in tests [OK]

Common Mistakes:

• Using @Mock instead of @MockBean for Spring beans
• Injecting real beans instead of mocks
• Not declaring the mock bean at all