@WebMvcTest for controller testing in Spring Boot - Mini Project: Build & Apply

Testing a Spring Boot Controller with @WebMvcTest

📖 Scenario: You are building a simple Spring Boot web application that has a controller to handle greeting requests. You want to write a test that checks if the controller returns the correct greeting message.

🎯 Goal: Create a Spring Boot test class using @WebMvcTest to test the GreetingController. You will set up the test class, configure the mock MVC, write a test method to perform a GET request, and verify the response.

📋 What You'll Learn

Create a controller class named GreetingController with a GET endpoint /greet that returns a greeting string.

Create a test class annotated with @WebMvcTest(GreetingController.class).

Inject a MockMvc object to perform HTTP requests in the test.

Write a test method that performs a GET request to /greet and asserts the response status is 200 and the content is the expected greeting.

💡 Why This Matters

🌍 Real World

Testing controllers with @WebMvcTest helps ensure your web endpoints behave correctly without starting the full application. This speeds up development and catches bugs early.

💼 Career

Many Java backend developer roles require writing unit and integration tests for Spring Boot applications. Knowing @WebMvcTest is essential for testing web layers efficiently.

1

Create the GreetingController class

Create a Spring Boot controller class named GreetingController with a method greet() mapped to GET requests at /greet. The method should return the string "Hello, Spring!".

Spring Boot

// Create the GreetingController class with a GET endpoint /greet
// Your code here

Hint

Use @RestController on the class and @GetMapping("/greet") on the method.

2

Set up the test class with @WebMvcTest

Create a test class named GreetingControllerTest annotated with @WebMvcTest(GreetingController.class). Inside, declare a private field mockMvc of type MockMvc and annotate it with @Autowired.

Spring Boot

import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.web.servlet.MockMvc;

@WebMvcTest(GreetingController.class)
public class GreetingControllerTest {
    @Autowired
    private MockMvc mockMvc;
    
    // Your code here
}

Hint

Use @WebMvcTest on the test class and @Autowired to inject MockMvc.

3

Write a test method to perform GET request

In the GreetingControllerTest class, write a test method named testGreetReturnsHelloSpring annotated with @Test. Use mockMvc.perform(get("/greet")) to perform a GET request. Then use andExpect(status().isOk()) and andExpect(content().string("Hello, Spring!")) to verify the response status and content.

Spring Boot

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import org.junit.jupiter.api.Test;

@WebMvcTest(GreetingController.class)
public class GreetingControllerTest {
    @Autowired
    private MockMvc mockMvc;

    @Test
    public void testGreetReturnsHelloSpring() throws Exception {
        // Your code here
    }
}

Hint

Use mockMvc.perform(get("/greet")) and chain andExpect calls to check status and content.

4

Complete the test class with imports and annotations

Ensure the test class GreetingControllerTest has all necessary imports: @Test from org.junit.jupiter.api.Test, static imports for get, status, and content from MockMvcRequestBuilders and MockMvcResultMatchers. Confirm the class is annotated with @WebMvcTest(GreetingController.class) and the mockMvc field is @Autowired.

Spring Boot

// Review your imports and annotations
// Your code here

Hint

Check that all imports and annotations are present for the test to run correctly.

Practice

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

easy

A. To test only the web layer (controllers) without starting the full application context

B. To test the entire Spring Boot application including database and services

C. To perform integration testing with real HTTP calls

D. To test only the service layer without controllers

Solution

1. Step 1: Understand the role of @WebMvcTest

   @WebMvcTest is designed to load only the Spring MVC components like controllers, filters, and related configurations, not the full app context.

2. Step 2: Compare with other test annotations

   Unlike @SpringBootTest which loads the full context, @WebMvcTest focuses on controller layer for fast, isolated web tests.

3. Final Answer:

   To test only the web layer (controllers) without starting the full application context -> Option A

4. Quick Check:

   @WebMvcTest = controller-only test [OK]

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

Common Mistakes:

• Thinking @WebMvcTest loads full Spring context
• Confusing @WebMvcTest with @SpringBootTest
• Assuming it tests service or repository layers

2. Which of the following is the correct way to declare a test class using @WebMvcTest for a controller named UserController?

easy

A. @WebMvcTest(UserController.class)
public class UserControllerTest {}

B. @WebMvcTest
public class UserControllerTest {}

C. @WebMvcTest(services = UserController.class)
public class UserControllerTest {}

D. @WebMvcTest(controllers = UserController.class)
public class UserControllerTest {}

Solution

1. Step 1: Check @WebMvcTest syntax for specifying controllers

   The correct syntax to specify which controllers to test is using the 'controllers' attribute, e.g., @WebMvcTest(controllers = UserController.class).

2. Step 2: Eliminate incorrect options

   @WebMvcTest(UserController.class) public class UserControllerTest {} misses 'controllers =' keyword, @WebMvcTest public class UserControllerTest {} does not specify controller, @WebMvcTest(services = UserController.class) public class UserControllerTest {} wrongly uses 'services' attribute.

3. Final Answer:

   @WebMvcTest(controllers = UserController.class) public class UserControllerTest {} -> Option D

4. Quick Check:

   @WebMvcTest(controllers = ...) is correct syntax [OK]

Hint: Use 'controllers =' to specify controller class in @WebMvcTest [OK]

Common Mistakes:

• Omitting 'controllers =' keyword
• Using 'services =' instead of 'controllers ='
• Not specifying any controller class

3. Given the following test code snippet using @WebMvcTest and MockMvc, what will be the HTTP status returned by the test?

@WebMvcTest(controllers = HelloController.class)
public class HelloControllerTest {

  @Autowired
  private MockMvc mockMvc;

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

@RestController
class HelloController {
  @GetMapping("/hello")
  public String sayHello() {
    return "Hello World";
  }
}

medium

A. 404 Not Found

B. 200 OK

C. 500 Internal Server Error

D. 302 Found (Redirect)

Solution

1. Step 1: Analyze the controller mapping

   The HelloController has a GET mapping for '/hello' that returns a string "Hello World".

2. Step 2: Understand MockMvc test behavior

   The test performs a GET request to '/hello' and expects status 200 OK, which matches the controller's response.

3. Final Answer:

   200 OK -> Option B

4. Quick Check:

   GET /hello returns 200 OK [OK]

Hint: Check controller mappings match test request URL [OK]

Common Mistakes:

• Expecting 404 when mapping exists
• Confusing status codes for successful GET
• Missing controller in @WebMvcTest causing 404

4. Identify the error in the following @WebMvcTest test class that causes the test to fail with a NullPointerException.

@WebMvcTest(controllers = UserController.class)
public class UserControllerTest {

  private MockMvc mockMvc;

  @Test
  public void testGetUser() throws Exception {
    mockMvc.perform(get("/user/1"))
           .andExpect(status().isOk());
  }
}

medium

A. Missing @Autowired annotation on MockMvc field

B. Wrong controller class specified in @WebMvcTest

C. Missing @Test annotation on test method

D. MockMvc cannot perform GET requests

Solution

1. Step 1: Check MockMvc initialization

   The MockMvc field is declared but not initialized or injected, so it remains null causing NullPointerException.

2. Step 2: Fix by adding @Autowired

   Adding @Autowired on the MockMvc field lets Spring inject the mockMvc instance for testing.

3. Final Answer:

   Missing @Autowired annotation on MockMvc field -> Option A

4. Quick Check:

   MockMvc must be @Autowired to avoid null [OK]

Hint: Always @Autowired MockMvc in @WebMvcTest classes [OK]

Common Mistakes:

• Forgetting @Autowired on MockMvc
• Assuming MockMvc is auto-initialized without annotation
• Misnaming test methods without @Test

5. You want to test a controller OrderController that depends on a service OrderService. Using @WebMvcTest, how can you provide a mock OrderService to the controller during testing?

hard

A. Create a new OrderService instance manually in the test method

B. Use @Autowired on OrderService field to inject real service

C. Use @MockBean on OrderService field in the test class to inject a mock

D. Use @SpringBootTest instead of @WebMvcTest to load full context

Solution

1. Step 1: Understand @WebMvcTest scope

   @WebMvcTest loads only web layer, so service beans are not loaded automatically.

2. Step 2: Use @MockBean to provide mock dependencies

   Annotating OrderService with @MockBean in the test class creates and injects a mock into the controller.

3. Final Answer:

   Use @MockBean on OrderService field in the test class to inject a mock -> Option C

4. Quick Check:

   @MockBean mocks service dependencies in @WebMvcTest [OK]

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

Common Mistakes:

• Trying to @Autowired real service in @WebMvcTest
• Not mocking service causing NoSuchBeanDefinitionException
• Switching to @SpringBootTest unnecessarily