Unit testing Spring MVC 3 Web Components

package com.bitbybit.service;
 
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.stereotype.Service;
 
@Service
public class UserService {
 
	public UserDetails getUserDetails() {
	        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
	        if (authentication == null) {
                         return null;
                } else {
                         return (UserDetails) authentication.getPrincipal();
                }
	} 
 
	public String getUsername() {
		if (getUserDetails() == null) {
			return null;
		} else {
			return getUserDetails().getUsername();
		}	
	}
 
}

package com.bitbybit.web.controller;
 
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Map;
import org.apache.log4j.Logger;
import com.bitbybit.domain.Greeting;
import com.bitbybit.domain.Color;
import com.bitbybit.service.GreetingService;
import com.bitbybit.service.UserService;
import com.bitbybit.web.form.GreetingForm;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
 
@Controller
@RequestMapping("/home") 
public class GreetingController {
 
	protected static Logger logger = Logger.getLogger("GreetingController");
 
	private final String DEFAULT_FAVORITE_COLOR_CODE = "FFFFFF";
 
	private GreetingService greetingService;
 
	private UserService userService; 
 
	//add this because it complains otherwise when doing security annotations
	//public GreetingController() {}
 
	@Autowired 
	public GreetingController(GreetingService greetingService, UserService userService) { //another change!!
		this.greetingService = greetingService;
		this.userService = userService;
	}
 
    //note there is no actual greetings.html file!! 
	@RequestMapping(value = "/addgreeting.html", method = RequestMethod.GET)
    public String showAddGreetingPage(@ModelAttribute("greetingform") GreetingForm greetingForm) {		
 
    	//resolves to /WEB-INF/jsp/addgreeting.jsp
    	return "addgreeting";
	}	
 
	@ModelAttribute("colorlist")
	public List<Color> populateColorList() {
		//color list is hardcoded for now...
		List<Color> colorList = new ArrayList<Color>();
		colorList.add(new Color("Indian Red", "F75D59"));
		colorList.add(new Color("Red", "FF0000"));
		colorList.add(new Color("Salmon", "F9966B"));
		colorList.add(new Color("Lemon Chiffon", "FFF8C6"));
		colorList.add(new Color("Olive Green", "BCE954"));
		colorList.add(new Color("Steel Blue", "C6DEFF"));
		colorList.add(new Color("Medium Purple", "9E7BFF"));
		return colorList;
	}	
 
	@RequestMapping(value = "/greetings.html", method = RequestMethod.POST)
	public String addGreetingAndShowAll(@ModelAttribute("greetingform") GreetingForm greetingForm,
			Map<String, Object> model) {		
 
		//get the greeting from the form (that contains what the user input to the form) 
		Greeting greeting = greetingForm.getGreeting();
 
		//set the date to the current date
		greeting.setGreetingDate(new Date());
 
		greeting.setUsername(userService.getUsername()); 
 
		//persist the greeting
		greetingService.addGreeting(greeting);  
 
		//prepare the greetings list to be displayed
		List<Greeting> greetings = greetingService.getAllGreetings();
		model.put("greetinglist", greetings);
 
    	String selectedColorCode=greetingForm.getColor().getColorCode(); 
    	//if no color selected, then assign default
    	if(selectedColorCode == null || selectedColorCode.equals("")) {
    		selectedColorCode=DEFAULT_FAVORITE_COLOR_CODE;
    	}
 
    	model.put("colorcode", selectedColorCode);
 
    	// This will resolve to /WEB-INF/jsp/greetings.jsp
    	return "greetings";
	} 
 
	//define the same url with GET so users can skip to the greetings page
	@RequestMapping(value = "/greetings.html", method = RequestMethod.GET)
	public String showAllGreetings(Map<String, Object> model) {		
 
		List<Greeting> greetings = greetingService.getAllGreetings();
		model.put("greetinglist", greetings);		
		model.put("colorcode", DEFAULT_FAVORITE_COLOR_CODE);
 
    	// This will resolve to /WEB-INF/jsp/greetings.jsp
    	return "greetings";
	}	
 
}

package com.bitbybit.web.controller;
 
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.junit.Before;
import org.junit.Test;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter;
import com.bitbybit.domain.Color;
import com.bitbybit.domain.Greeting;
import com.bitbybit.service.GreetingService;
import com.bitbybit.service.UserService;
import com.bitbybit.web.form.GreetingForm;
import static org.mockito.Mockito.*;
import junit.framework.TestCase;
 
public class GreetingControllerTest extends TestCase {
 
	private GreetingForm greetingForm; 
	Greeting greeting;
	Color color;
	Map<String, Object> model;
	GreetingService fakeGreetingService;
	List<Greeting> fakeGreetingList;
	UserService fakeUserService;
	GreetingController greetingController;
 
	@Before 
	protected void setUp() {
		//first initialize the 2 parameters of the method addGreetingAndShowAll() for testing
		greetingForm = new GreetingForm(); //first parameter of addGreetingAndShowAll()
		greeting = new Greeting();
		greetingForm.setGreeting(greeting);
		color = new Color();
		greetingForm.setColor(color);
		model = new HashMap<String, Object>(); //second parameter of addGreetingAndShowAll()
		//mock the GreetingService
		fakeGreetingService = mock(GreetingService.class);
		fakeGreetingList = new ArrayList<Greeting>();
		fakeGreetingList.add(greeting);
		//mock the UserDetails
		UserService fakeUserService = mock(UserService.class);
		when(fakeUserService.getUsername()).thenReturn("altheaparker");
		//inject the GreetingController with a fake GreetingService and UserService
		greetingController = new GreetingController(fakeGreetingService, fakeUserService);
		when(fakeGreetingService.getAllGreetings()).thenReturn(fakeGreetingList);
	}
 
	//test that the greeting text should be inserted into a Greeting object 
	//which ends up inside a list inside the model
	@Test
	public void testModelShouldContainNewGreetingText() {		
		//GIVEN
		greeting.setGreetingText("hello world");
		//WHEN
		greetingController.addGreetingAndShowAll(greetingForm, model);
		//THEN
		List<Greeting> greetingListResult = (ArrayList<Greeting>)(model.get("greetinglist")); 
		assertEquals("hello world", greetingListResult.get(0).getGreetingText());
	}
 
	//test that when the color red is selected, it is assigned correctly in the model
	@Test
	public void testModelShouldContainColorRedWhenSelected() {
		//GIVEN
		color.setColorCode("FF0000");
		//WHEN
		greetingController.addGreetingAndShowAll(greetingForm, model);
		//THEN
		assertEquals("FF0000", model.get("colorcode"));
	}	
 
	//test that when no color is selected, the default color should be white
	//the color should end up inside the model and is called 'colorcode'
	@Test
	public void testModelShouldContainColorWhiteWhenNoColorIsSelected() {		
		//GIVEN
		//no color value is initialized		
		//WHEN
		greetingController.addGreetingAndShowAll(greetingForm, model);
		//THEN
		assertEquals("FFFFFF", model.get("colorcode"));
	}	
 
	//test that the username makes it into the Greeting object inside the model
	@Test
	public void testModelShouldContainGreetingWithUsername() {
		//WHEN
		greetingController.addGreetingAndShowAll(greetingForm, model);
		//THEN
		List<Greeting> greetingListResult = (ArrayList<Greeting>)(model.get("greetinglist")); 
		assertEquals("altheaparker",  greetingListResult.get(0).getUsername());
	}	
 
	//test that the current date goes into the Greeting object inside the model
	@Test
	public void testModelShouldContainGreetingWithCurrentDate() {
		//GIVEN
		Date dateBeforeMethodCall = new Date();
		//WHEN
		greetingController.addGreetingAndShowAll(greetingForm, model);
		//THEN
		List<Greeting> greetingListResult = (ArrayList<Greeting>)(model.get("greetinglist")); 
		Date resultDate = greetingListResult.get(0).getGreetingDate(); 
		assertEquals(dateBeforeMethodCall.getTime(), resultDate.getTime());		
	}	
 
	//test that when a new Greeting is created, it ends up inside a list inside the model
	@Test
	public void testNewGreetingShouldBeInsertedIntoList() {
		//WHEN
		greetingController.addGreetingAndShowAll(greetingForm, model);		
		//THEN
		List<Greeting> greetingListResult = (ArrayList<Greeting>)(model.get("greetinglist")); 
		assertNotNull(greetingListResult);
		assertEquals(greetingListResult.size(), 1);		
	}
 
	//when the user skips directly to the greetings page without entering a greeting....
	//given @RequestMapping(value = "/greetings.html", method = RequestMethod.GET)
	//showAllGreetings() method should be called
	//and "greetings" should be returned and default color should be white 
	@Test 
	public void testShowAllGreetingsMethodShouldBeCalledWithGET() throws Exception {
		//GIVEN
		AnnotationMethodHandlerAdapter handlerAdapter = new AnnotationMethodHandlerAdapter();
		MockHttpServletRequest request = new MockHttpServletRequest("GET","/home/greetings.html");
                MockHttpServletResponse response = new MockHttpServletResponse();
                //WHEN
                ModelAndView mav = handlerAdapter.handle(request, response, greetingController);
                //THEN
                assertEquals("greetings", mav.getViewName());
                assertEquals("FFFFFF", mav.getModel().get("colorcode"));
	}
 
	//when the user adds a greeting....
	//given @RequestMapping(value = "/greetings.html", method = RequestMethod.POST)
	//addGreetingAndShowAll() method should be called
	//and "greetings" should be returned	
	@Test 
	public void testAddGreetingAndShowAllMethodShouldBeCalledWithPOST() throws Exception {
		//GIVEN
		AnnotationMethodHandlerAdapter handlerAdapter = new AnnotationMethodHandlerAdapter();
		MockHttpServletRequest request = new MockHttpServletRequest("POST","/home/greetings.html");
                MockHttpServletResponse response = new MockHttpServletResponse();
                //WHEN
                ModelAndView mav = handlerAdapter.handle(request, response, greetingController);
                //THEN
                assertEquals("greetings", mav.getViewName());
	}	
 
}