Testing Service Calls in Struts 2.0 Action Class

[Jay Abrahm]

In the action test case below I was able to test the loop which did not have the service call using a very useful struts extension (attached) that I had downloaded from another website.

However, I am not sure on how to test the second scenario commented out in the test method. Should I mock the service call or else is there some other pattern that I need to apply

   
package com.test.project.web.action.main;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import junit.framework.TestCase;

import org.apache.struts2.dispatcher.Dispatcher;
import org.easymock.EasyMock;

import com.client.project.business.model.security.Function;
import com.client.project.business.model.security.User;
import com.client.project.business.service.LogabbleService;
import com.client.project.testutils.StrutsTestContext;
import com.mockrunner.mock.web.MockServletContext;
import com.opensymphony.xwork2.ActionProxy;

public class LoggableActionTest extends TestCase {

	public void testRemoveData() throws Exception {
	/*
	** Create a Dispatcher.
	** This is an expensive operation as it has to load all
	** the struts configuration so you will want to reuse the Dispatcher for
	** multiple tests instead of re-creating it each time.
	**
	** In this example I'm setting configuration parameter to override the
	** values in struts.xml.
	*/
	  HashMap<String, String> params = new HashMap<String, String>();
	  // Override struts.xml config constants to use a guice test module
//	  params.put("struts.objectFactory", "guice");
//	  params.put("guice.module", "com.client.project.business.service.LogabbleService");

	  MockServletContext servletContext = new MockServletContext();
	  Dispatcher dispatcher = StrutsTestContext.prepareDispatcher(
	       servletContext, params);

	/*
	**  Create an ActionProxy based on the namespace and action.
	**  Pass in request parameters and session attributes needed for this
	**  test.
	*/
	  StrutsTestContext context = new StrutsTestContext(
	      dispatcher, servletContext);
	  Map<String, String> requestParams = new HashMap<String, String>();
	  Map<String, Object> sessionAttributes = new HashMap<String, Object>();
	  User u = new User();
	  stubUser(u);
	  sessionAttributes.put("LoggedIn_User", u);

	  Map<Long, String> copyComments = null;
	  copyComments = new HashMap<Long, String>();
	  copyComments.put(121L, "TestingOnce");
	  copyComments.put(122L, "TestingTwice");
	  sessionAttributes.put("CopyComments", copyComments);

	  String a = copyComments.get(121L);

	  requestParams.put("commentID", "121");
	  requestParams.put("flg", "C");

	  ActionProxy proxy = context.createActionProxy("/main", "LoggableAction_removeData", requestParams, sessionAttributes);

	  assertTrue(proxy.getAction() instanceof LoggableAction);

	  // Run the Struts Interceptor stack and the Action
	  String result = proxy.execute();

	  // Check the results
	  assertEquals(null, result);
	  Map<Long, String> resultComments = (HashMap<Long, String>)sessionAttributes.get("CopyComments");
	  String b = resultComments.get(121L);
	  assertEquals(null,b);

	  //***********************SECOND SCENARIO*********************************
//	  requestParams.put("flg", "elseLoop");
//	  LoggableService loggableService = EasyMock.createMock(LoggableService.class);
//	  EasyMock.expect(loggableService.removeComments(1L, null))
//				.andReturn(true);
//	  EasyMock.replay(loggableService);
//	  ActionProxy proxy2 = context.createActionProxy("/main", "LoggableAction_removeData", requestParams, sessionAttributes);
//	  proxy2.execute();
//	  EasyMock.verify();
	}

	private void stubUser(User u) {
		List<Function> functionList = new ArrayList<Function>();
		  Function function1 = new Function();
		  Function function2 = new Function();
		  function1.setName(Function.ACTIVE);
		  function2.setName(Function.DELETE);
		  functionList.add(function1);
		  functionList.add(function2);
		  u.setFunctions(functionList);
	}
}

    
package com.client.project.web.action.main;

import java.io.File;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;

import org.apache.commons.io.FileUtils;

import com.client.project.business.model.security.User;
import com.client.project.business.service.LoggableService;
import com.client.project.business.service.impl.LoggableServiceImpl;
import com.client.project.web.action.BaseAction;
import com.opensymphony.xwork2.Preparable;

public class LoggableAction extends BaseAction implements Preparable {

	public LoggableAction() {
	}

	public String execute() throws Exception {
		return "success";
	}

	@SuppressWarnings("unused")
	public void prepare() {
	}

	public void removeData() throws Exception {
		String strCommentID = null;
		String strCopyFlag = null;
		long commentID = 0;
		String user = null;
		strCommentID = request.getParameter("commentID");
		strCopyFlag = request.getParameter("flg");
		Map<Long, String> copyComments = null;

		if (strCommentID != null) {
			commentID = Long.parseLong(strCommentID);
		}

		User userInfo = (User) session.get(User.SESS_USER);
		if (userInfo != null) {
			user = userInfo.getUserId();
		}
		if (strCommentID != null) {

			if (strCopyFlag.equalsIgnoreCase("C")) {
				copyComments = (Map<Long, String>) this.session
						.get("CopyComments");
				copyComments.remove(Long.parseLong(strCommentID));
				logger.info("Removing from the Session");
				this.session.put("CopyComments", copyComments);

			} else {

				loggableService.removeComments(commentID, user);
			}

		}
	}

}

[Jay Abrahm]

I have created a new Mock Service to extend that service and set it in the session assuming that the Dependency Injection would be overridden as mentioned in the mockrunner examples

package com.jci.glims.business.service.designsheet;

import com.jci.glims.business.service.impl.designsheet.DesignComponentServiceImpl;

public class MockLoggableServiceImpl extends LoggableServiceImpl {

	private boolean isCommentsRemoved;


	@Override
	public boolean removeComments(long commentID, String user) throws Exception {
//		return super.removeComments(commentID, user);
		return isCommentsRemoved;
	}

	public void setUpCommentsRemoved(boolean isCommentsRemoved) {
		this.isCommentsRemoved = isCommentsRemoved;
	}

}

And I have changed LoggableActionTest second scenario to as follows

	  requestParams.put("flg", "elseLoop");
	  MockLoggableServiceImpl mockLoggableServiceImpl = new MockLoggableServiceImpl();
	  mockLoggableServiceImpl.setUpCommentsRemoved(true);
	  // Just putting them in both variables to be doubly sure
	  sessionAttributes.put(LoggableService.class.getName(), mockLoggableServiceImpl);
	  sessionAttributes.put(LoggableServiceImpl.class.getName(), mockLoggableServiceImpl);
	  ActionProxy proxy2 = context.createActionProxy("/main", "LoggableAction_removeData", requestParams, sessionAttributes);
	  proxy2.execute();
	  Map<Long, String> resultComments2 = (HashMap<Long, String>)sessionAttributes.get("CopyComments");
	  String b2 = resultComments2.get(121L);
	  assertNotNull(b2);

But it still goes to the actual LoggableServiceImpl instead of the MockLoggableServiceImpl. What did I mess up or not understand ?

[Jay Abrahm]

Adding

LogabbleService ls = (LogabbleServiceImpl)session.get(LoggableServiceImpl.class.getName());

to the LoggableAction solved the problem, but then I cant do that since it would mess the actual functionality.

Any idea on how I can override the setting of LoggableService with my MockLoggableServiceImpl.

[Jay Abrahm]

MMmm ..

http://www.javaworld.com/javaworld/jw-11-2006/jw-1109-test.html?page=1

Got me worried. So is there no way to pass a mock service into my action class.