servletunit.struts

Class CactusStrutsTestCase

java.lang.Object

ServletTestCase

servletunit.struts.CactusStrutsTestCase

public class CactusStrutsTestCase
extends ServletTestCase

CactusStrutsTestCase is an extension of the Cactus ServletTestCase base class that provides additional methods to aid in testing Struts Action objects. It uses an in-container approach to run the servlet container, and tests the execution of Action objects as they are actually run through the Struts ActionServlet. CactusStrutsTestCase provides methods that set up the request path, request parameters for ActionForm subclasses, as well as methods that can verify that the correct ActionForward was used and that the proper ActionError messages were supplied.

Please note that this class is meant to run in the Cactus framework, and you must configure your test environment accordingly. Please see http://jakarta.apache.org/cactus for more details.

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionServlet	actionServlet
protected boolean	actionServletIsInitialized
protected boolean	isInitialized
protected static org.apache.commons.logging.Log	logger
protected java.lang.String	moduleName
protected boolean	requestPathIsSet
protected HttpServletRequestWrapper	requestWrapper
protected HttpServletResponseWrapper	responseWrapper
protected java.lang.String	servletMapping

Constructor Summary

Constructors

Constructor and Description
CactusStrutsTestCase() Default constructor.
CactusStrutsTestCase(java.lang.String testName) Constructor that takes test name parameter, for backwards compatibility with older versions on JUnit.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerform() Executes the Action instance to be tested.
void	addRequestParameter(java.lang.String parameterName, java.lang.String parameterValue) Adds an HttpServletRequest parameter to be used in setting up the ActionForm instance to be used in this test.
void	addRequestParameter(java.lang.String parameterName, java.lang.String[] parameterValues) Adds an HttpServletRequest parameter that is an array of String values to be used in setting up the ActionForm instance to be used in this test.
void	clearRequestParameters() Clears all request parameters previously set.
ActionForm	getActionForm() Returns the ActionForm instance stored in either the request or session.
ActionServlet	getActionServlet() Returns the ActionServlet controller used in this test.
protected java.lang.String	getActualForward() Returns the forward sent to RequestDispatcher.
HttpServletRequest	getRequest() Returns an HttpServletRequest object that can be used in this test.
HttpServletRequestWrapper	getRequestWrapper() Returns a HttpServletRequestWrapper object that can be used in this test.
HttpServletResponse	getResponse() Returns an HttpServletResponse object that can be used in this test.
HttpServletResponseWrapper	getResponseWrapper() Returns an HttpServletResponseWrapper object that can be used in this test.
HttpSession	getSession() Returns an HttpSession object that can be used in this test.
void	processRequest(boolean flag) Instructs StrutsTestCase to fully process a forward request.
void	setActionForm(ActionForm form) Sets an ActionForm instance to be used in this test.
void	setActionServlet(ActionServlet servlet) Sets the ActionServlet to be used in this test execution.
void	setConfigFile(java.lang.String pathname) Sets the location of the Struts configuration file for the default module.
void	setConfigFile(java.lang.String moduleName, java.lang.String pathname) Sets the struts configuration file for a given sub-application.
void	setInitParameter(java.lang.String key, java.lang.String value) Sets an initialization parameter on the ActionServlet.
void	setRequestPathInfo(java.lang.String pathInfo) Sets the request path instructing the ActionServlet to used a particual ActionMapping.
void	setRequestPathInfo(java.lang.String moduleName, java.lang.String pathInfo) Sets the request path instructing the ActionServlet to used a particual ActionMapping.
void	setRequestWrapper(HttpServletRequestWrapper wrapper) Set this TestCase to use a given HttpServletRequestWrapper class when calling Action.execute().
void	setResponseWrapper(HttpServletResponseWrapper wrapper) Set this TestCase to use a given HttpServletResponseWrapper class when calling Action.execute().
void	setServletMapping(java.lang.String servletMapping) Sets the servlet mapping used to map requests to the Struts controller.
protected void	setUp() Sets up the test fixture for this test.
protected void	tearDown()
void	verifyActionErrors(java.lang.String[] errorNames) Verifies if the ActionServlet controller sent these error messages.
void	verifyActionMessages(java.lang.String[] messageNames) Verifies if the ActionServlet controller sent these action messages.
void	verifyForward(java.lang.String forwardName) Verifies if the ActionServlet controller used this forward.
void	verifyForwardPath(java.lang.String forwardPath) Verifies if the ActionServlet controller used this actual path as a forward.
void	verifyInputForward() Verifies if the ActionServlet controller forwarded to the defined input path.
void	verifyInputTilesForward(java.lang.String definitionName) Verifies that the ActionServlet controller forwarded to the defined input Tiles definition.
void	verifyNoActionErrors() Verifies that the ActionServlet controller sent no error messages upon executing an Action object.
void	verifyNoActionMessages() Verifies that the ActionServlet controller sent no action messages upon executing an Action object.
void	verifyTilesForward(java.lang.String forwardName, java.lang.String definitionName) Verifies that the ActionServlet controller used this forward and Tiles definition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

actionServlet

protected ActionServlet actionServlet

requestWrapper

protected HttpServletRequestWrapper requestWrapper

responseWrapper

protected HttpServletResponseWrapper responseWrapper

isInitialized

protected boolean isInitialized

actionServletIsInitialized

protected boolean actionServletIsInitialized

requestPathIsSet

protected boolean requestPathIsSet

moduleName

protected java.lang.String moduleName

servletMapping

protected java.lang.String servletMapping

logger

protected static org.apache.commons.logging.Log logger

Constructor Detail

CactusStrutsTestCase

public CactusStrutsTestCase()

Default constructor.

CactusStrutsTestCase

public CactusStrutsTestCase(java.lang.String testName)

Constructor that takes test name parameter, for backwards compatibility with older versions on JUnit.

Method Detail

setUp

protected void setUp()
              throws java.lang.Exception

Sets up the test fixture for this test. This method creates an instance of the ActionServlet, initializes it to validate forms and turn off debugging, and clears all other parameters.

Throws:

java.lang.Exception

setServletMapping

public void setServletMapping(java.lang.String servletMapping)

Sets the servlet mapping used to map requests to the Struts controller. This is used to restore proper setting after the test has been executed. By default, the stanard "*.do" mapping will be restored, so only use this method for non-standard servlet mappings.

Parameters:

servletMapping -

tearDown

protected void tearDown()
                 throws java.lang.Exception

Throws:

java.lang.Exception

getRequest

public HttpServletRequest getRequest()

Returns an HttpServletRequest object that can be used in this test.

getRequestWrapper

public HttpServletRequestWrapper getRequestWrapper()

Returns a HttpServletRequestWrapper object that can be used in this test. Note that if setRequestWrapper(HttpServletRequestWrapper) has not been called, this method will return an instance of javax.servlet.http.HttpServletRequestWrapper.

setRequestWrapper

public void setRequestWrapper(HttpServletRequestWrapper wrapper)

Set this TestCase to use a given HttpServletRequestWrapper class when calling Action.execute(). Note that if this method is not called, then the normal HttpServletRequest object is used.

Parameters:

wrapper - an HttpServletRequestWrapper object to be used when calling Action.execute().

getResponse

public HttpServletResponse getResponse()

Returns an HttpServletResponse object that can be used in this test.

getResponseWrapper

public HttpServletResponseWrapper getResponseWrapper()

Returns an HttpServletResponseWrapper object that can be used in this test. Note that if setResponseWrapper(HttpServletResponseWrapper) has not been called, this method will return an instance of javax.servlet.http.HttpServletResponseWrapper.

setResponseWrapper

public void setResponseWrapper(HttpServletResponseWrapper wrapper)

Set this TestCase to use a given HttpServletResponseWrapper class when calling Action.execute(). Note that if this method is not called, then the normal HttpServletResponse object is used.

Parameters:

wrapper - an HttpServletResponseWrapper object to be used when calling Action.execute().

getSession

public HttpSession getSession()

Returns an HttpSession object that can be used in this test.

addRequestParameter

public void addRequestParameter(java.lang.String parameterName,
                       java.lang.String parameterValue)

Adds an HttpServletRequest parameter to be used in setting up the ActionForm instance to be used in this test. Each parameter added should correspond to an attribute in the ActionForm instance used by the Action instance being tested.

addRequestParameter

public void addRequestParameter(java.lang.String parameterName,
                       java.lang.String[] parameterValues)

Adds an HttpServletRequest parameter that is an array of String values to be used in setting up the ActionForm instance to be used in this test. Each parameter added should correspond to an attribute in the ActionForm instance used by the Action instance being tested.

clearRequestParameters

public void clearRequestParameters()

Clears all request parameters previously set. NOTE: This will not clear parameters set using Cactus beginXXX methods!

setRequestPathInfo

public void setRequestPathInfo(java.lang.String pathInfo)

Sets the request path instructing the ActionServlet to used a particual ActionMapping.

Parameters:

pathInfo - the request path to be processed. This should correspond to a particular action mapping, as would normally appear in an HTML or JSP source file.

setRequestPathInfo

public void setRequestPathInfo(java.lang.String moduleName,
                      java.lang.String pathInfo)

Sets the request path instructing the ActionServlet to used a particual ActionMapping. Also sets the ServletPath property on the request.

Parameters:

moduleName - the name of the Struts sub-application with which this request is associated, or null if it is the default application.

pathInfo - the request path to be processed. This should correspond to a particular action mapping, as would normally appear in an HTML or JSP source file. If this request is part of a sub-application, the module name should not appear in the request path.

setInitParameter

public void setInitParameter(java.lang.String key,
                    java.lang.String value)

Sets an initialization parameter on the ActionServlet. Allows you to simulate an init parameter that would normally have been found in web.xml.

Parameters:

key - the name of the initialization parameter

value - the value of the intialization parameter

setConfigFile

public void setConfigFile(java.lang.String pathname)

Sets the location of the Struts configuration file for the default module. This method can take either an absolute path, or a relative path. If an absolute path is supplied, the configuration file will be loaded from the underlying filesystem; otherwise, the ServletContext loader will be used.

setConfigFile

public void setConfigFile(java.lang.String moduleName,
                 java.lang.String pathname)

Sets the struts configuration file for a given sub-application. This method can take either an absolute path, or a relative path. If an absolute path is supplied, the configuration file will be loaded from the underlying filesystem; otherwise, the ServletContext loader will be used.

Parameters:

moduleName - the name of the sub-application, or null if this is the default application

pathname - the location of the configuration file for this sub-application

getActionServlet

public ActionServlet getActionServlet()

Returns the ActionServlet controller used in this test.

setActionServlet

public void setActionServlet(ActionServlet servlet)

Sets the ActionServlet to be used in this test execution. This method should only be used if you plan to use a customized version different from that provided in the Struts distribution.

actionPerform

public void actionPerform()

Executes the Action instance to be tested. This method initializes the ActionServlet, sets up and optionally validates the ActionForm bean associated with the Action to be tested, and then calls the Action.execute() method. Results are stored for further validation.

Throws:

junit.framework.AssertionFailedError - if there are any execution errors while calling Action.execute() or ActionForm.validate().

getActualForward

protected java.lang.String getActualForward()

Returns the forward sent to RequestDispatcher.

verifyForward

public void verifyForward(java.lang.String forwardName)
                   throws junit.framework.AssertionFailedError

Verifies if the ActionServlet controller used this forward.

Parameters:

forwardName - the logical name of a forward, as defined in the Struts configuration file. This can either refer to a global forward, or one local to the ActionMapping.

Throws:

junit.framework.AssertionFailedError - if the ActionServlet controller used a different forward than forwardName after executing an Action object.

verifyForwardPath

public void verifyForwardPath(java.lang.String forwardPath)
                       throws junit.framework.AssertionFailedError

Verifies if the ActionServlet controller used this actual path as a forward.

Parameters:

forwardPath - an absolute pathname to which the request is to be forwarded.

Throws:

junit.framework.AssertionFailedError - if the ActionServlet controller used a different forward path than forwardPath after executing an Action object.

verifyInputForward

public void verifyInputForward()

Verifies if the ActionServlet controller forwarded to the defined input path.

Throws:

junit.framework.AssertionFailedError - if the ActionServlet controller used a different forward than the defined input path after executing an Action object.

verifyTilesForward

public void verifyTilesForward(java.lang.String forwardName,
                      java.lang.String definitionName)

Verifies that the ActionServlet controller used this forward and Tiles definition.

Parameters:

forwardName - the logical name of a forward, as defined in the Struts configuration file. This can either refer to a global forward, or one local to the ActionMapping.

definitionName - the name of a Tiles definition, as defined in the Tiles configuration file.

Throws:

junit.framework.AssertionFailedError - if the ActionServlet controller used a different forward or tiles definition than those given after executing an Action object.

verifyInputTilesForward

public void verifyInputTilesForward(java.lang.String definitionName)

Verifies that the ActionServlet controller forwarded to the defined input Tiles definition.

Parameters:

definitionName - the name of a Tiles definition, as defined in the Tiles configuration file.

Throws:

junit.framework.AssertionFailedError - if the ActionServlet controller used a different forward than the defined input path after executing an Action object.

verifyActionErrors

public void verifyActionErrors(java.lang.String[] errorNames)

Verifies if the ActionServlet controller sent these error messages. There must be an exact match between the provided error messages, and those sent by the controller, in both name and number.

Parameters:

errorNames - a String array containing the error message keys to be verified, as defined in the application resource properties file.

Throws:

junit.framework.AssertionFailedError - if the ActionServlet controller sent different error messages than those in errorNames after executing an Action object.

verifyNoActionErrors

public void verifyNoActionErrors()

Verifies that the ActionServlet controller sent no error messages upon executing an Action object.

Throws:

junit.framework.AssertionFailedError - if the ActionServlet controller sent any error messages after excecuting and Action object.

verifyActionMessages

public void verifyActionMessages(java.lang.String[] messageNames)

Verifies if the ActionServlet controller sent these action messages. There must be an exact match between the provided action messages, and those sent by the controller, in both name and number.

Parameters:

messageNames - a String array containing the action message keys to be verified, as defined in the application resource properties file.

Throws:

junit.framework.AssertionFailedError - if the ActionServlet controller sent different action messages than those in messageNames after executing an Action object.

verifyNoActionMessages

public void verifyNoActionMessages()

Verifies that the ActionServlet controller sent no action messages upon executing an Action object.

Throws:

junit.framework.AssertionFailedError - if the ActionServlet controller sent any action messages after excecuting and Action object.

getActionForm

public ActionForm getActionForm()

Returns the ActionForm instance stored in either the request or session. Note that no form will be returned if the Action being tested cleans up the form instance.

setActionForm

public void setActionForm(ActionForm form)

Sets an ActionForm instance to be used in this test. The given ActionForm instance will be stored in the scope specified in the Struts configuration file (ie: request or session). Note that while this ActionForm instance is passed to the test, Struts will still control how it is used. In particular, it will call the ActionForm.reset() method, so if you override this method in your ActionForm subclass, you could potentially reset attributes in the form passed through this method.

Parameters:

form - the ActionForm instance to be used in this test.

processRequest

public void processRequest(boolean flag)

Instructs StrutsTestCase to fully process a forward request. By default, StrutsTestCase stops processing a request as soon as the forward path has been collected, in order to avoid side effects; calling this method overrides this behavior.

Parameters:

flag - set to true to fully process forward requests