@MockBean for mocking dependencies in Spring Boot

Introduction

@MockBean helps you replace real parts of your app with fake ones during tests. This way, you can test one part without worrying about others.

When you want to test a service without calling the real database.

When you need to fake a web service call inside your app during tests.

When you want to isolate a component and avoid side effects from its dependencies.

When you want to control the behavior of a dependency to test different scenarios.

When you want to speed up tests by avoiding slow or complex real dependencies.

Syntax

Spring Boot

@MockBean
private DependencyType dependency;

Place @MockBean on a field inside a Spring Boot test class.

Spring Boot will replace the real bean with this mock during the test.

Examples

This mocks the UserRepository bean so you can fake database calls in tests.

Spring Boot

@MockBean
private UserRepository userRepository;

This replaces the real EmailService with a mock to avoid sending real emails during tests.

Spring Boot

@MockBean
private EmailService emailService;

Sample Program

This test mocks UserRepository to return "Alice" when asked for user 1. The UserService uses this mock, so the test prints "Alice" without needing a real database.

Spring Boot

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import static org.mockito.Mockito.*;

@SpringBootTest
public class UserServiceTest {

    @MockBean
    private UserRepository userRepository;

    @Autowired
    private UserService userService;

    @Test
    public void testGetUserName() {
        when(userRepository.findNameById(1L)).thenReturn("Alice");

        String name = userService.getUserName(1L);

        System.out.println(name);
    }
}

// UserService.java
// public class UserService {
//     @Autowired
//     private UserRepository userRepository;
//     public String getUserName(Long id) {
//         return userRepository.findNameById(id);
//     }
// }

// UserRepository.java
// public interface UserRepository {
//     String findNameById(Long id);
// }

Important Notes

Use @MockBean only in Spring Boot test classes annotated with @SpringBootTest or similar.

Mocks created by @MockBean are automatically injected into the Spring context, replacing real beans.

Remember to import Mockito static methods like when() and verify() to control mock behavior.

Summary

@MockBean replaces real beans with mocks during tests.

It helps isolate the part you want to test by faking dependencies.

Use it to control dependency behavior and avoid side effects in tests.

Practice

1. What is the main purpose of using @MockBean in a Spring Boot test?

easy

A. To replace a real Spring bean with a mock for isolated testing

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

C. To automatically inject real dependencies into the test

D. To configure database connections for integration tests

Solution

1. Step 1: Understand the role of @MockBean

   @MockBean is used to replace a real bean in the Spring context with a mock version during tests.

2. Step 2: Identify the testing benefit

   This replacement helps isolate the component under test by faking dependencies, avoiding real implementations.

3. Final Answer:

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

4. Quick Check:

   @MockBean replaces real beans [OK]

Hint: Remember: @MockBean fakes dependencies for focused tests [OK]

Common Mistakes:

• Thinking @MockBean creates new beans instead of replacing
• Confusing @MockBean with @Autowired injection
• Using @MockBean to configure real database connections

2. Which of the following is the correct way to declare a mock bean for a service named UserService in a Spring Boot test?

easy

A. @MockBean UserService userService = new UserService();

B. @MockBean private UserService userService;

C. @MockBean public void userService();

D. @MockBean UserService userService();

Solution

1. Step 1: Recall @MockBean declaration syntax

   @MockBean is used as an annotation on a field to create a mock instance injected by Spring.

2. Step 2: Check each option

   @MockBean private UserService userService; correctly declares a private field annotated with @MockBean. Other options use invalid syntax such as instantiating manually with new or declaring as methods.

3. Final Answer:

   @MockBean private UserService userService; -> Option B

4. Quick Check:

   @MockBean on private field [OK]

Hint: Use @MockBean on private fields only [OK]

Common Mistakes:

• Trying to instantiate mock manually with new
• Declaring @MockBean on methods instead of fields
• Omitting access modifier or using invalid syntax

3. Given this test snippet:

@MockBean
private PaymentService paymentService;

@Test
void testProcess() {
  when(paymentService.pay()).thenReturn(true);
  boolean result = paymentService.pay();
  System.out.println(result);
}

What will be printed when the test runs?

medium

A. null

B. false

C. true

D. Exception thrown

Solution

1. Step 1: Understand mocking behavior

   The mock paymentService is told to return true when pay() is called using when().thenReturn(true).

2. Step 2: Trace the method call

   Calling paymentService.pay() returns true as configured, so result is true and printed.

3. Final Answer:

   true -> Option C

4. Quick Check:

   Mock returns configured value = true [OK]

Hint: Mock returns what you tell it with when().thenReturn() [OK]

Common Mistakes:

• Expecting default false instead of configured true
• Confusing mock with real implementation output
• Not setting up when().thenReturn() before call

4. Consider this test code snippet:

@MockBean
private OrderService orderService;

@Test
void testOrder() {
  orderService.placeOrder();
  verify(orderService).placeOrder();
}

When running this test, it fails with a NullPointerException. What is the most likely cause?

medium

A. The orderService is not mocked properly because it is private

B. The verify method is called before placeOrder()

C. The placeOrder() method is final and cannot be mocked

D. The @MockBean annotation was not processed because the test class lacks @SpringBootTest

Solution

1. Step 1: Check test setup requirements

   @MockBean requires Spring Boot test context to process annotations, usually via @SpringBootTest or similar.

2. Step 2: Identify cause of NullPointerException

   If @MockBean is not processed, orderService remains null, causing NPE when calling placeOrder().

3. Final Answer:

   The @MockBean annotation was not processed because the test class lacks @SpringBootTest -> Option D

4. Quick Check:

   @MockBean needs Spring context [OK]

Hint: Always use @SpringBootTest to enable @MockBean processing [OK]

Common Mistakes:

• Assuming private fields can't be mocked
• Misordering verify and method calls
• Not realizing final methods can't be mocked (but not cause NPE here)

5. You have a Spring Boot service NotificationService that depends on EmailSender. You want to test NotificationService without sending real emails. Which setup correctly uses @MockBean to mock EmailSender and verify sendEmail() was called once during the test?

hard

A. Use @MockBean EmailSender emailSender; in the test class, call notificationService.notify(), then verify with verify(emailSender, times(1)).sendEmail();

B. Use @Autowired EmailSender emailSender; and call sendEmail() directly in the test

C. Create a new EmailSender instance manually and inject it into NotificationService

D. Use @MockBean NotificationService notificationService; and verify sendEmail() on it

Solution

1. Step 1: Mock the dependency EmailSender

   Use @MockBean on EmailSender to replace the real bean with a mock in the test context.

2. Step 2: Call the method under test and verify interaction

   Call notificationService.notify() which uses EmailSender internally, then verify sendEmail() was called once on the mock.

3. Final Answer:

   Use @MockBean EmailSender emailSender; call notificationService.notify(); verify sendEmail() called once -> Option A

4. Quick Check:

   Mock dependency, call service, verify mock call [OK]

Hint: Mock dependencies, test service, verify mock interactions [OK]

Common Mistakes:

• Mocking the service instead of its dependency
• Manually creating dependency instead of using @MockBean
• Not verifying the mock method call properly