spring-boot w/ embedded tomcat doesn't dispatch requests to controller

Question

I have an application using spring-boot and an embedded Tomcat container.

As far as I can tell, my code is the same as the spring-boot sample project. However, when I run my test, I get a 404 instead of a 200 (in the case where I try to post instead of get I receive a 405, which is consistent with Tomcat being incorrectly setup):

Failed tests:
UserControllerTest.testMethod:45 Status expected:<200> but was:<404>

My Java-based configuration (some configuration classes omitted):

@Configuration
@ComponentScan
@EnableAutoConfiguration
@Import({ ServiceConfig.class, DefaultRepositoryConfig.class })
public class ApplicationConfig {

    private static Log logger = LogFactory.getLog(ApplicationConfig.class);

    public static void main(String[] args) {
        SpringApplication.run(ApplicationConfig.class);
    }

    @Bean
    protected ServletContextListener listener() {
        return new ServletContextListener() {
            @Override
            public void contextInitialized(ServletContextEvent sce) {
                logger.info("ServletContext initialized");
            }

            @Override
            public void contextDestroyed(ServletContextEvent sce) {
                logger.info("ServletContext destroyed");
            }
        };
    }
}

UserController.java:

@RestController
@RequestMapping("/")
public class UserController {

    @Autowired
    UserService userService;

    @RequestMapping(method = RequestMethod.GET)
    public ResponseEntity<String> testMethod() {
        return new ResponseEntity<>("Success!", HttpStatus.OK);
    }
}

UserControllerTest.java:

RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
@ContextConfiguration(classes = {ApplicationConfig.class})
public class UserControllerTest {
    @Autowired
    private WebApplicationContext webApplicationContext;
    private MockMvc mockMvc;

    @Before
    public void setUp() throws Exception {
        this.mockMvc = MockMvcBuilders.webAppContextSetup(this.webApplicationContext).build();
    }

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

Is there something basic I'm missing? I'm not providing my own Mvc configuration, and I haven't touched the Spring MVC DispatcherServlet, so I assume spring-boot will configure Tomcat automatically.

Answer 1

It turns out the issue was the component scanning configuration. Even though the @ComponentScan annotation was used, the controller was under a separate package, so Spring never included it in the dispatcher.

Adding @ComponentScan(basePackages = "com.my.controller")) solved my issue.