@WebMvcTest for controller testing in JUnit - Framework Patterns

Framework Mode - @WebMvcTest for controller testing

Folder Structure

spring-boot-app/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/example/app/
│   │   │       ├── controller/
│   │   │       │   └── UserController.java
│   │   │       ├── service/
│   │   │       │   └── UserService.java
│   │   │       └── model/
│   │   │           └── User.java
│   │   └── resources/
│   │       └── application.properties
│   └── test/
│       ├── java/
│       │   └── com/example/app/
│       │       └── controller/
│       │           └── UserControllerTest.java
│       └── resources/
└── build.gradle

Test Framework Layers

• Test Class Layer: Contains JUnit test classes annotated with @WebMvcTest to test Spring MVC controllers in isolation.
• Controller Layer: Spring MVC controllers handling HTTP requests.
• Mocked Service Layer: Services are mocked using @MockBean to isolate controller logic.
• Test Utilities: Helper methods for building mock requests and responses, JSON converters.
• Configuration Layer: Spring Boot test configuration, including mock MVC setup.

Configuration Patterns

• Use @WebMvcTest(ControllerClass.class): Limits Spring context loading to web layer only, speeding up tests.
• Mock Dependencies with @MockBean: Replace service beans to isolate controller behavior.
• Profiles and Properties: Use application-test.properties or @TestPropertySource to configure environment-specific settings.
• MockMvc Injection: Inject MockMvc to perform HTTP requests and verify responses.
• JSON Serialization: Use JacksonTester or ObjectMapper for request/response body conversion.

Test Reporting and CI/CD Integration

• JUnit Reports: Standard JUnit XML reports generated by build tools (Maven/Gradle) for test results.
• IDE Integration: Run and debug @WebMvcTest tests inside IDEs like IntelliJ or Eclipse with clear pass/fail feedback.
• CI/CD Pipelines: Integrate tests in pipelines (GitHub Actions, Jenkins) to run on each commit or pull request.
• Code Coverage: Use tools like JaCoCo to measure how much controller code is covered by tests.
• Test Logs: Capture detailed logs for failed tests to help debugging.

Best Practices

1. Isolate Controller Tests: Use @WebMvcTest to load only the web layer, avoiding full application context startup.
2. Mock External Dependencies: Use @MockBean to mock services and repositories, focusing tests on controller logic.
3. Use MockMvc for HTTP Simulation: Perform GET, POST, PUT, DELETE requests and verify status, headers, and body.
4. Test JSON Serialization: Verify request and response JSON formats match expected structure.
5. Keep Tests Small and Focused: Each test should verify one controller endpoint or behavior clearly.

Self Check

Where in this folder structure would you add a new test class to verify the behavior of a newly created OrderController?

Key Result

Use @WebMvcTest to isolate and test Spring MVC controllers with mocked dependencies for fast, focused tests.

Practice

1. What is the main purpose of using @WebMvcTest in Spring Boot testing?

easy

A. To test only the Spring MVC controllers without starting the full application context

B. To test the entire application including database and services

C. To perform integration testing of all layers

D. To mock external APIs automatically

Solution

1. Step 1: Understand the role of @WebMvcTest

   @WebMvcTest is designed to load only the Spring MVC components, mainly controllers, for focused testing.

2. Step 2: Compare with other test types

   Unlike full integration tests, it does not load services or repositories, making tests faster and isolated.

3. Final Answer:

   To test only the Spring MVC controllers without starting the full application context -> Option A

4. Quick Check:

   @WebMvcTest = Controller-only test [OK]

Hint: Remember: @WebMvcTest loads controllers only, not full app [OK]

Common Mistakes:

• Thinking @WebMvcTest loads full application context
• Confusing @WebMvcTest with @SpringBootTest
• Assuming it mocks external APIs automatically

2. Which annotation is used to mock a service dependency inside a @WebMvcTest annotated test class?

easy

A. @InjectMocks

B. @MockMvc

C. @Autowired

D. @MockBean

Solution

1. Step 1: Identify mocking annotation for Spring beans

   @MockBean is used to add mock implementations of Spring beans into the application context during tests.

2. Step 2: Differentiate from other annotations

   @MockMvc is not an annotation, @Autowired injects real beans, and @InjectMocks is from Mockito but not for Spring context injection.

3. Final Answer:

   @MockBean -> Option D

4. Quick Check:

   Mock dependencies in @WebMvcTest = @MockBean [OK]

Hint: Use @MockBean to mock Spring beans in @WebMvcTest [OK]

Common Mistakes:

• Using @Autowired instead of @MockBean for mocks
• Confusing @MockBean with Mockito's @InjectMocks
• Thinking @MockMvc is an annotation

3. Given the following test snippet using @WebMvcTest and MockMvc:

@WebMvcTest(MyController.class)
class MyControllerTest {
  @Autowired
  private MockMvc mockMvc;

  @Test
  void testHello() throws Exception {
    mockMvc.perform(get("/hello"))
      .andExpect(status().isOk())
      .andExpect(content().string("Hello World"));
  }
}

What will happen if the controller method mapped to /hello returns "Hello World" as response?

medium

A. The test will fail because MockMvc is not autowired correctly

B. The test will pass because the response matches the expected string

C. The test will fail due to status code mismatch

D. The test will throw a NullPointerException

Solution

1. Step 1: Analyze the test expectations

   The test expects HTTP status 200 OK and response body "Hello World".

2. Step 2: Match with controller behavior

   If the controller returns "Hello World" with status 200, both expectations are met, so the test passes.

3. Final Answer:

   The test will pass because the response matches the expected string -> Option B

4. Quick Check:

   Matching response and status = test pass [OK]

Hint: Match expected status and content to pass MockMvc tests [OK]

Common Mistakes:

• Assuming test fails if no explicit status set in controller
• Confusing autowiring issues with test failures
• Ignoring response content in assertions

4. Consider this test class snippet:

@WebMvcTest(MyController.class)
class MyControllerTest {
  @Autowired
  private MockMvc mockMvc;

  @MockBean
  private MyService myService;

  @Test
  void testEndpoint() throws Exception {
    when(myService.getData()).thenReturn("data");
    mockMvc.perform(get("/data"))
      .andExpect(status().isOk())
      .andExpect(content().string("data"));
  }
}

If the test fails with a 404 Not Found error, what is the most likely cause?

medium

A. The test class is missing @SpringBootTest annotation

B. The mock service is not returning the expected value

C. The controller method for /data is missing or not mapped correctly

D. MockMvc is not autowired properly

Solution

1. Step 1: Understand 404 error in MockMvc test

   A 404 means the requested URL is not found in the controller mappings.

2. Step 2: Check test setup

   @WebMvcTest loads only controllers; if /data mapping is missing or incorrect, 404 occurs despite mocks.

3. Final Answer:

   The controller method for /data is missing or not mapped correctly -> Option C

4. Quick Check:

   404 error = missing controller mapping [OK]

Hint: 404 in @WebMvcTest usually means missing controller mapping [OK]

Common Mistakes:

• Blaming mock service return value for 404
• Assuming @SpringBootTest is needed for controller tests
• Ignoring URL mapping correctness

5. You want to test a controller method that depends on a service returning a list of users. Using @WebMvcTest, how should you mock the service and verify the controller returns JSON with the user list correctly?

hard

A. Use @MockBean to mock the service, stub the method to return a list, then use MockMvc to perform GET and expect JSON content

B. Use @Autowired to inject the real service and call the controller method directly

C. Use @SpringBootTest to load full context and test the controller with real service

D. Use Mockito's @InjectMocks on the controller and call methods without MockMvc

Solution

1. Step 1: Mock the service dependency with @MockBean

   In @WebMvcTest, use @MockBean to replace the service bean with a mock and stub its method to return the user list.

2. Step 2: Use MockMvc to perform HTTP GET and verify JSON response

   Perform a GET request on the controller endpoint and assert the JSON response matches the expected user list.

3. Final Answer:

   Use @MockBean to mock the service, stub the method to return a list, then use MockMvc to perform GET and expect JSON content -> Option A

4. Quick Check:

   Mock service + MockMvc GET + JSON assert = correct test [OK]

Hint: Mock service with @MockBean and verify JSON via MockMvc [OK]

Common Mistakes:

• Injecting real service instead of mocking
• Using full context test instead of @WebMvcTest
• Calling controller methods directly without MockMvc