/******************************************************************************
* JBoss, a division of Red Hat *
* Copyright 2006, Red Hat Middleware, LLC, and individual *
* contributors as indicated by the @authors tag. See the *
* copyright.txt in the distribution for a full listing of *
* individual contributors. *
* *
* This is free software; you can redistribute it and/or modify it *
* under the terms of the GNU Lesser General Public License as *
* published by the Free Software Foundation; either version 2.1 of *
* the License, or (at your option) any later version. *
* *
* This software is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this software; if not, write to the Free *
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
* 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
******************************************************************************/
package org.gatein.pc.test.unit.base;
import org.apache.log4j.Logger;
import org.gatein.pc.test.unit.JoinPoint;
import org.gatein.pc.test.unit.PortletTestCase;
import org.gatein.pc.test.unit.actions.ServletServiceTestAction;
import org.gatein.pc.test.unit.TestAction;
import org.jboss.portal.test.framework.server.NodeId;
import org.gatein.pc.test.unit.JoinPointType;
import org.gatein.pc.test.unit.PortletTestDriver;
import org.gatein.pc.test.unit.PortletTestContext;
import org.jboss.unit.driver.DriverResponse;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
/**
* Universal test servlet that enables to reuse servlet instances across several tests
*
* @author <a href="mailto:boleslaw.dawidowicz@jboss.com">Boleslaw Dawidowicz</a>
* @version $Revision: 7954 $
*/
public abstract class AbstractUniversalTestServlet extends HttpServlet
{
/** The logger. */
private final Logger log = Logger.getLogger(getClass());
/** Jointpoint for service method. */
private final JoinPoint serviceJoinPoint = JoinPoint.createJoinPoint(getClass(), JoinPointType.SERVLET_SERVICE);
/** Construct a test servlet with a test id computed with the method <code>getTestId(Class)</code>. */
public AbstractUniversalTestServlet()
{
}
/**
* Standart implementation of service() method to handle requests and invoke actions from sequence
*
* @param request
* @param response
* @throws ServletException
* @throws IOException
*/
protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
{
PortletTestContext ctx = PortletTestDriver.getPortletTestContext();
//
log.info("JoinPoint " + serviceJoinPoint + " invoked for '"
+ ctx.getTestName() + "' testId and '" +
+ctx.getRequestCount() + "' request count");
// Reset instance state
if (ctx.getRequestCount() == 0)
{
reset();
}
PortletTestCase portletTestCase = getSequence(ctx.getTestName());
if (portletTestCase != null)
{
TestAction action = portletTestCase.getAction(ctx.getRequestCount(), NodeId.locate(), getServiceJointpoint());
if (action != null && action instanceof ServletServiceTestAction)
{
log.info("Found Action for this jointpoint");
DriverResponse dr = ((ServletServiceTestAction)action).execute(this, request, response, ctx);
if (dr != null)
{
ctx.updateResponse(dr);
}
}
}
}
/**
* Returns SequenceRegistry which should be injected into ServletContext Returns null if there is no SequenceRegistry
* in context
*
* @return SequenceRegistry
*/
private PortletTestDriver getSequenceRegistry()
{
return (PortletTestDriver)getServletContext().getAttribute("SequenceRegistry");
}
/**
* Returns Sequence for current testId Returns null if there is no Sequence for current testId
*
* @return
* @throws javax.servlet.ServletException if there is no SequenceRegistry
*/
protected PortletTestCase getSequence(String testId) throws ServletException
{
PortletTestDriver registry = getSequenceRegistry();
if (registry == null)
{
log.info("No SequenceRegistry object found in current context");
throw new ServletException("No SequenceRegistry object found in context");
}
return registry.getTestCase(testId);
}
public JoinPoint getServiceJointpoint()
{
return serviceJoinPoint;
}
public abstract void reset();
}