Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To test actions that do not use Spring, extend StrutsTestCase. The following example shows different ways of testing an action:
Mapping:

Code Block
xml
xml

<struts>
    <constant name="struts.objectFactory" value="spring"/>
    <package name="test" namespace="/test" extends="struts-default">
        <action name="testAction" class="org.apache.struts2.TestAction">
            <result type="freemarker">/template.ftl</result>
        </action>
    </package>
</struts>

Action:

Code Block
java
java

public class TestAction extends ActionSupport {
    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

JUnit:

Code Block
java
java

package org.apache.struts2;

import org.apache.struts2.dispatcher.mapper.ActionMapping;

import java.util.HashMap;
import java.io.UnsupportedEncodingException;

import com.opensymphony.xwork2.ActionProxy;
import com.opensymphony.xwork2.Action;

import javax.servlet.ServletException;

public class StrutsTestCaseTest extends StrutsTestCase {
    public void testGetActionMapping() {
        ActionMapping mapping = getActionMapping("/test/testAction.action");
        assertNotNull(mapping);
        assertEquals("/test", mapping.getNamespace());
        assertEquals("testAction", mapping.getName());
    }

    public void testGetActionProxy() throws Exception {
        //set parameters before calling getActionProxy
        request.setParameter("name", "FD");
        
        ActionProxy proxy = getActionProxy("/test/testAction.action");
        assertNotNull(proxy);

        TestAction action = (TestAction) proxy.getAction();
        assertNotNull(action);

        String result = proxy.execute();
        assertEquals(Action.SUCCESS, result);
        assertEquals("FD", action.getName());
    }

    public void testExecuteAction() throws ServletException, UnsupportedEncodingException {
        String output = executeAction("/test/testAction.action");
        assertEquals("Hello", output);
    }

    public void testGetValueFromStack() throws ServletException, UnsupportedEncodingException {
        request.setParameter("name", "FD");
        executeAction("/test/testAction.action");
        String name = (String) findValueAfterExecute("name");
        assertEquals("FD", name);
    }
}

...

Method Name

Description

executeAction(String)

Pass the url for the action, and it will return the output of the action. This output is not the action result, like "success", but what would be written to the result stream. To use this the actions must be using a result type that can be read from the classpath, like FreeMarker, velocity, etc (if you are using the experimental Embedded JSP Plugin, you can use JSPs also)

getActionProxy(String)

Builds an action proxy that can be used to invoke an action, by calling execute() on the returned proxy object. The return value of execute() is the action result, like "success"

getActionMapping(String)

Gets an ActionMapping for the url

injectStrutsDependencies(object)

Injects Struts dependencies into an object (dependencies are marked with Inject)

findValueAfterExecute(String)

Finds an object in the value stack, after an action has been executed

applyAdditionalParams(ActionContext)

Can be overwritten in subclass to provide additional params and settings used during action invocation

createAction(Class)Can be used to instantiate an action which requires framework's dependencies to be injected (e.g. extending ActionSupport requires inject some internal dependencies)

Field

Description

MockHttpServletRequest request

The request that will be passed to Struts. Make sure to set parameters in this object before calling methods like getActionProxy

MockHttpServletResponse response

The response object passed to Struts, you can use this class to test the output, response headers, etc

MockServletContext servletContext

The servlet context object passed to Struts

...

Make sure to add a dependency to the Spring Plugin to your pom.xml:

Code Block
xml
xml

<dependency>
    <groupId>org.apache.struts</groupId>
    <artifactId>struts2-spring-plugin</artifactId>
    <version>STRUTS_VERSION</version>
</dependency>

...