Spring Boot - Test for controller fails with 404 code

Question

I want to write a test for controller. Here is test snippet:

@RunWith(SpringRunner.class)
@WebMvcTest(WeatherStationController.class)
@ContextConfiguration(classes = MockConfig.class)
public class WeatherStationControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Autowired
    private IStationRepository stationRepository;

    @Test
    public void shouldReturnCorrectStation() throws Exception {

        mockMvc.perform(get("/stations")
                .accept(MediaType.APPLICATION_JSON))
                .andExpect(status().isOk());
    }
}

controller code snippet:

@RestController
@RequestMapping(value = "stations")
public class WeatherStationController {

    @Autowired
    private WeatherStationService weatherService;

    @RequestMapping(method = RequestMethod.GET)
    public List<WeatherStation> getAllWeatherStations() {
        return weatherService.getAllStations();
    }

    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
    public WeatherStation getWeatherStation(@PathVariable String id) {
        return weatherService.getStation(id);
    }

MockConfig class:

@Configuration
@ComponentScan(basePackages = "edu.lelyak.repository")
public class MockConfig {

    //**************************** MOCK BEANS ******************************

    @Bean
    @Primary
    public WeatherStationService weatherServiceMock() {
        WeatherStationService mock = Mockito.mock(WeatherStationService.class);
        return mock;
    }

Here is error stack trace:

java.lang.AssertionError: Status 
Expected :200
Actual   :404

I can get what is wrong here.
How to fix test for controller?

Had a similar issue when I renamed the package and forgot to change in the @ComponentScan. — Pranjal, Mar 20 '20 at 00:56

score 27 · Answer 1 · answered Jul 06 '20 at 15:39

27

I had the same issue. The controller was not getting picked up despite specifying it with @WebMvcTest(MyController.class). This meant all of its mappings were ignored, causing the 404. Adding @Import(MyController.class) resolved the issue, but I didn't expect the import to be necessary when I'm already specifying which controller to test.

answered Jul 06 '20 at 15:39

rougou

956
9
14

4

That doesn't make any sense but worked for me :D. I'm using Spring boot 2.4.4 – Diego Lins de Freitas Apr 03 '21 at 21:22
The same worked for me also with @ContextConfiguration(classes = {MyController.class)} – Sergey Jul 06 '22 at 08:59
well this works for my case, thanks for your pointer man, saved a headache for 2.1.6 – Guntur Santoso Aug 28 '22 at 16:31
I think, ContextConfiguration does not add, but overwrites which classes are put into the context. So as soon as you use ContextConfiguration to add classes to the context (like some security configuration as in my case), you also have to add the controller under test in ContextConfiguration, despite being given in WebMvcTest already. Actually, you can leave out the controller from the WebMvcTest annotation and keep your code DRY. – Matthias Aug 26 '23 at 07:32
However, in the end I added all classes to the value aka controllers attribute of WebMvcTest and removed the ContextConfiguration. At least with Spring 3.1.2, this works, although the documentation of the controllers attribute says that these should be the controllers under test. – Matthias Aug 26 '23 at 07:42

score 23 · Accepted Answer · answered Aug 08 '17 at 23:20

HTTP code 404, means no resource found (on the server) for your request, which I think that your controller is not visible(let me say is not scanned) by spring boot.

A simple solution is scanning a parent package in MockConfig class, so spring can pick up all beans,

@ComponentScan(basePackages = "edu.lelyak") // assuming that's the parent package in your project

if you don't like this approach, you can add the controller's package name in basePackages

@ComponentScan(basePackages = {"edu.lelyak.controller","edu.lelyak.repository")

BTW, you don't have to manually set up WeatherStationService in MockConfig class, Spring boot can inject a mock for you and automatically reset it after each test method, you should just declare it in your test class:

@MockBean
private IStationRepository stationRepository;

On the other hand, you should mock weatherService.getAllStations() before calling get("/stations") in your test method (as you're not running integration test), so you can do:

List<WeatherStation> myList = ...;
//Add element(s) to your list
 Mockito.when(stationService.getAllStations()).thenReturn(myList);

You can find more in :

For me it turned out to be as simple as missing "/" in starting of the request path. I was trying "v1/user/{id}" instead of "/v1/user/{id}" in my controller test. — Shrikant Prabhu, Aug 08 '19 at 06:57

score 9 · Answer 3 · answered Jan 09 '17 at 13:35

9

I am not sure why your test is not working. But I got another solution which works for me.

@SpringBootTest
public class ControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Before
    public void setup() {
        this.mockMvc = MockMvcBuilders.standaloneSetup(new TestController()).build();
    }

    @Test
    public void shouldReturnCorrectStation() throws Exception {
        mockMvc.perform(get("/stations")
                .accept(MediaType.APPLICATION_JSON))
                .andExpect(status().isOk());
    }
}

answered Jan 09 '17 at 13:35

Patrick

12,336
15
73
115

how you looked to full controller test? – catch23 Jan 11 '17 at 11:57
@nazar_art I cloned you github project but it was full of errors. Not sure if your MockMvc is correct. I would go the easy way and register one controller in your test class like I provided. – Patrick Jan 11 '17 at 12:21
This app has exactly one controller. Also, you need to set up [lombok](https://projectlombok.org/) support for your IDE. Without this, it wouldn't compile. – catch23 Jan 11 '17 at 13:43
For IntelliJ you need only install `Lombok plugin` and `enable annotation processor` at settings for the full project. – catch23 Apr 27 '18 at 17:59

score 8 · Answer 4 · edited Jun 08 '19 at 11:34

8

After some debugging, it appears that the target controller is simply not registered as a method handler. Spring scans the beans for the presence of RestController annotation.

But the problem is that the annotation could be found only if the bean is proxied via CGLIB, but for the case when we use WebMvcTest it's proxied by JDK.

As a result, I searched for the configuration which is responsible for making the choice, and the one was finally found AopAutoConfiguration. So when SpringBootTest is used this one is autoloaded when you need WebMvcTest+PreAuthorize in your controllers, then simply use:

@Import(AopAutoConfiguration.class)

edited Jun 08 '19 at 11:34

catch23

17,519
42
144
217

answered Jun 08 '19 at 08:26

Maksym Symonov

81
1
1

1

The correct way to import autoconfiguration is using `@ImportAutoConfiguration`. Alternatively you can use `@EnableAspectJAutoProxy` – StasKolodyuk Aug 16 '19 at 17:42
@StasKolodyuk `@ImportAutoConfiguration` doesn't work me, which makes sense as it is part of `@WebMvcTest` as well. `@EnableAspectJAutoProxy` didn't work for me either. In the end only `@Import(AopAutoConfiguration.class)` from this answer fixed the 404's on the controller with my `@PreAuthorize`-annotated endpoints. – Jur_ Nov 23 '22 at 12:17

score 4 · Answer 5 · answered Jul 05 '19 at 11:13

4

I import external configuration class by @ContextConfiguration(classes = MyConfig.class)

When I changed in MyConfig annotation @Configuration into @TestConfiguration it started to work properly.

answered Jul 05 '19 at 11:13

TOUDIdel

1,322
14
22

Dherik · Answer 6 · 2018-04-27T18:01:00.220

I couldn't find a good answer but I could find one of the causes.

I was using in my tests the @PreAuthorize on the RestController.
You can mock the Oauth with this tip on the integration tests that use SpringBootTest. For SpringBootTest, this works very well too, but using SpringBootTest you load a lot of other resources (like JPA) that is not necessary to do a simple Controller test.

But with @WebMvcTest this not works as expected. The use of the WithMockOAuth2Scope annotation can be enough to stop the 401 error from authentication problem, but after that the WebMvcTest can't find the rest endpoint, returning the 404 error code.

After removing the @PreAuthorize on Controller, the test with WebMvcTest pass.

Francislainy Campos · Answer 7 · 2022-10-17T12:45:29.663

3

Based on the accepted answer, in my case I had copied and modified the file based on another test, but forgot to change the name for the controller on the top of the class, that being the reason why it was not finding the resource, as the error says.

@RunWith(SpringRunner.class)
@WebMvcTest(AnswerCommandController.class)
public class AnswerCommandControllerTest {

edited Oct 17 '22 at 12:45

answered Jan 26 '21 at 03:35

Francislainy Campos

3,462
4
33
81

Nkokhelox · Answer 8 · 2017-01-21T09:25:01.760

Here is a different approach to the controller test that worked for me.

Assumption: The class WeatherStationService is a @SpringBootApplication

Then, the test class below should work for you:

@RunWith(SpringRunner.class)
@SpringApplicationConfiguration(WeatherStationService.class)
@WebIntegrationTest
public class WeatherStationControllerTest {

    @Autowired
    private WebApplicationContext context;

    MockMvc mockMvc;

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

    @Test
    public void shouldReturnCorrectStation() throws Exception {
        mockMvc.perform(get("/stations")
                .accept(MediaType.APPLICATION_JSON))
        .andExpect(status().isOk();
    }
}

With this test setup, you should no longer need the MockConfig class.

I hope the suggestion will be helpful this time and it is not too late. — Nkokhelox, Jan 21 '17 at 09:25

score 1 · Answer 9 · answered Dec 03 '19 at 13:03

1

In my case it was about a missing starting slash /

I've appended / to both RequestMapping value and MockHttpServletRequestBuilder post urlTemplate parameters as first character.

answered Dec 03 '19 at 13:03

Ismail Yavuz

6,727
6
29
50

Tom · Answer 10 · 2023-02-15T19:07:37.167

1

In case anyone is wondering.

If we don't use @ContextConfiguration, @WebMvcTest annotation will load the REST controller class. Otherwise, when we use use @ContextConfiguration, seems ContextConfiguration clear the context REST controller config. We need to add the REST controller to ContextConfiguration such as: @ContextConfiguration(classes = {MockConfig.class, WeatherStationController.class})

edited Feb 15 '23 at 19:07

answered Feb 15 '23 at 19:06

Tom

11
2

score 0 · Answer 11 · answered Jun 01 '23 at 13:52

0

In my case, I have to add the controller also to the @ContextConfiguration.

@ContextConfiguration(classes = {MockConfig.class, WeatherStationController.class})

answered Jun 01 '23 at 13:52

Sudheera

355
3
8

Spring Boot - Test for controller fails with 404 code

11 Answers11

Linked

Related