Spring Boot controller test loading entire application context

Question

Spring Boot here. I currently have the following REST controller:

@RestController
public class FizzbuzzController {

    private final FizzbuzzService FizzbuzzService;

    public FizzbuzzController(FizzbuzzService FizzbuzzService) {
        this.FizzbuzzService = FizzbuzzService;
    }

    @PostMapping("/Fizzbuzzs/{fizzbuzzId}")
    public ResponseEntity<FizzbuzzDTO> addFizzbuzz(@RequestParam("files") List<MultipartFile> files,
                                      @PathVariable String fizzbuzzId) throws IOException {

        FizzbuzzDTO fizzbuzzDTO = fizzbuzzService.store(files, fizzbuzzId);
        return ResponseEntity.status(HttpStatus.OK).body(fizzbuzzDTO);
        
    }

}

I would like to write an integration test for it that:

Mocks or stubs an HTTP request to the URL; and
Allows me to inject the FizzbuzzController (under test) with a mocked FizzbuzzService or the real thing; and
Allows me to inspect the HTTP response coming back from the method (check status code, check response entity, etc.)

My best attempt thus far:

@WebMvcTest(FizzbuzzController.class)
@EnableConfigurationProperties
@AutoConfigureMockMvc
public class FizzbuzzControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @MockBean
    private FizzbuzzService FizzbuzzService;

    @Test
    public void should_store_fizzbuzz_files() throws Exception {
        // I can't even get the test to run
        assertTrue(1 == 1);
    }

}

When I run this, the test fails to run and it is clear (looking at the logs) that Spring is loading the entire application context of my app, whereas I just want it to isolate the context to this test class, the main FizzbuzzController class, and anything in the dependency tree underneath it.

Can anyone spot where I'm going awry?

Juliyanage Silva · Accepted Answer · 2021-05-12 16:03:38Z

2

You need another context for testing. I'm suggesting you to have a separate Test config:

@TestConfiguration
@Slf4j
@EnableJpaRepositories("tth.patientportal.repository")
public class TestConfig { // bean configs goes here for testing if you need to change 
  // context}

and in a controller test build the context like below:

@RunWith(SpringRunner.class)
@AutoConfigureTestEntityManager
@SpringBootTest
@TestPropertySource("classpath:application-unittest.properties")
@ContextConfiguration(classes = {TestConfig.class})    
public class RestControllerTest {
    @Autowired
    private WebApplicationContext webApplicationContext;
    private MockMvc mockMvc;

    @Before
    public void setup() 
    {
       mockMvc = MockMvcBuilders.
            webAppContextSetup(webApplicationContext)
            .build();
    }

    @Test
    public void shouldReturnRegisteredUser() throws Exception {
        this.mockMvc.
            perform(MockMvcRequestBuilders
                    .post("url")                        
                    .contentType(MediaType.APPLICATION_JSON)
                    .accept(MediaType.APPLICATION_JSON))
            .andExpect(status().isOk())
            .andExpect(MockMvcResultMatchers.jsonPath("$.username").exists());
    }

}

answered May 12, 2021 at 16:03

Juliyanage Silva

2,7193 gold badges26 silver badges41 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

hotmeatballsoup Over a year ago

Thanks so much @Shamitha (+1) -- quick question, what does @EnableJpaRepositories("...") do?

Juliyanage Silva Over a year ago

That's for when you use jpa repositories, I bet you are going to need them

user11153 · Accepted Answer · 2025-10-23 12:07:27Z

You don't need separate @TestConfiguration to perform integration tests using @WebMvcTest, @RestClientTest or other dedicated annotations, that load only subset of beans from your entire application. But you must be aware, that the way you configure your application may disrupt beans filtering and you will end up with your case of "Spring is loading the entire application context of my app".

See this quote from "Testing Spring Boot Applications" documentation:

If you use a test annotation to test a more specific slice of your application, you should avoid adding configuration settings that are specific to a particular area on the main method’s application class.

The underlying component scan configuration of @SpringBootApplication defines exclude filters that are used to make sure slicing works as expected. If you are using an explicit @ComponentScan directive on your @SpringBootApplication-annotated class, be aware that those filters will be disabled. If you are using slicing, you should define them again.

In my case, I fixed this issue by simple moving all @Enable... and @ComponentScan custom annotations away from @SpringBootApplication, to separate @Configuration class.

Collectives™ on Stack Overflow

Spring Boot controller test loading entire application context

2 Answers 2

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related