SpringMVC Unit testing - Service method is not called - spring

Question

When I run unit test on the controller by mocking the service bean, it looks like the service method is not called at all. Is this expected behvaior or am I missing something?
SearchController.java
#Controller
public class SearchController {
#Autowired
SearchService searchService;
#RequestMapping(value="/search", method=RequestMethod.GET)
public String showSearchPage(Model model){
model.addAttribute("list", searchService.findAll());
return "search";
}
}
SearchControllerTest.java
#RunWith(SpringJUnit4ClassRunner.class)
#WebAppConfiguration
#ContextConfiguration("file:src/main/webapp/WEB-INF/springapp-servlet.xml")
public class SearchControllerTest {
#Autowired
private WebApplicationContext webAppContext;
private MockMvc mockMvc;
private SearchService searchServiceMock;
#Before
public void setUp(){
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.webAppContext).build();
this.searchServiceMock = Mockito.mock(SearchServiceImpl.class);
}
#Test
public void testShowSearchPage() throws Exception{
when(searchServiceMock.findAll())
.thenReturn(Arrays.asList("abc", "acb", "123"));
this.mockMvc.perform(get("/search.do"))
.andExpect(status().isOk())
.andExpect(view().name("search"))
.andExpect(forwardedUrl("/WEB-INF/jsp/search.jsp"))
.andExpect(model().attribute("list", hasSize(3)));
verify(searchServiceMock, times(1)).findAll(); //this test is failing
verifyNoMoreInteractions(searchServiceMock);
}
}
When I run the test, it seems like findAll() method isn't getting called and it is throwing exception. "Wanted but not invoked searchServiceImpl.findAll()"
What mistake am I making here?
-------------Update------------------
SearchControllerTestNew.java
public class SearchControllerTestNew {
#InjectMocks
SearchController searchController;
#Mock
SearchService searchServiceMock;
#Mock
View mockView;
MockMvc mockMvc;
#Before
public void setUp(){
MockitoAnnotations.initMocks(this);
mockMvc = MockMvcBuilders.standaloneSetup(searchController).setSingleView(mockView)
.build();
}
#Test
public void testShowSearchPage() throws Exception{
when(searchServiceMock.findAll())
.thenReturn(Arrays.asList("abc", "acb", "123"));
this.mockMvc.perform(get("/search.do"))
.andExpect(status().isOk())
.andExpect(view().name("search"))
.andExpect(model().attribute("list", hasSize(3)))
.andExpect(forwardedUrl("/WEB-INF/jsp/search.jsp"));//this fails now
verify(searchServiceMock, times(1)).findAll();
verifyNoMoreInteractions(searchServiceMock);
}
}

Answer 1

Your SearchController will use the autowired SearchService (part of your application context) not your mock, notice you create a mock but you are not using it anywhere, instead you create a MockMvc based on your application context.
A solution would be, using a standalone setup which gives you full control over the instantiation and initialization of controllers and their dependencies:
#Before
public void setUp(){
this.searchServiceMock = Mockito.mock(SearchServiceImpl.class);
mockMvc = MockMvcBuilders.standaloneSetup(new SearchController(seachServiceMock))
.setViewResolvers(viewResolver())
.build();
}
private ViewResolver viewResolver() {
InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
viewResolver.setPrefix("/WEB-INF/jsp/");
viewResolver.setSuffix(".jsp");
return viewResolver;
}
I've omitted some MVC infrastructure configuration in this example check the MockMvcBuilder documentation for further configuration.

Answer 2

Although you have mocked the SearchService it isn't injected to the controller (at least not evident from code you shared).
Thus the verify(searchServiceMock, times(1)).findAll(); is bound to fail as it is indeed never invoked.
Take a look at #InjectMock how mocks are injected.
Also you need to add below LOCs for whole thing to work
First introduce a field
#InjectMocks
private SearchController controller;
Second in setUp() add
MockitoAnnotations.initMocks(this);
this.mockMvc = MockMvcBuilders.standaloneSetup(controller).build();

Answer 3

You can use #MockBean for your mocks, then they will be injected to Context automatically.
Doc: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-testing-spring-boot-applications-mocking-beans