plugins/struts2-portlet-plugin/src/test/java/org/apache/struts2/components/PortletUrlRendererTest.java

/*
 * $Id$
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.struts2.components;

import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;

import javax.portlet.PortletMode;
import javax.portlet.PortletURL;

import org.apache.struts2.StrutsStatics;
import org.apache.struts2.StrutsTestCase;
import org.apache.struts2.portlet.PortletActionConstants;
import org.apache.struts2.portlet.context.PortletActionContext;
import org.apache.struts2.portlet.servlet.PortletServletRequest;
import org.apache.struts2.portlet.servlet.PortletServletResponse;
import org.easymock.EasyMock;
import org.springframework.mock.web.portlet.MockPortalContext;
import org.springframework.mock.web.portlet.MockPortletContext;
import org.springframework.mock.web.portlet.MockPortletURL;
import org.springframework.mock.web.portlet.MockRenderRequest;
import org.springframework.mock.web.portlet.MockRenderResponse;

import com.opensymphony.xwork2.ActionContext;
import com.opensymphony.xwork2.mock.MockActionInvocation;
import com.opensymphony.xwork2.mock.MockActionProxy;
import com.opensymphony.xwork2.util.ValueStack;

public class PortletUrlRendererTest extends StrutsTestCase {

	PortletUrlRenderer renderer;
	MockPortletURL renderUrl;
	MockPortletURL actionUrl;
	MockRenderRequest request;
	MockRenderResponse response;
	MockPortletContext context;
	ActionContext ctx;
	ValueStack stack;

	public void setUp() throws Exception {
		super.setUp();
		renderer = new PortletUrlRenderer();
		context = new MockPortletContext();
		renderUrl = new MockPortletURL(
				new MockPortalContext(), "render");
		actionUrl = new MockPortletURL(
				new MockPortalContext(), "action");
		request = new MockRenderRequest();
		response = new MockRenderResponse() {
			@Override
			public PortletURL createActionURL() {
				return actionUrl;
			}
			@Override
			public PortletURL createRenderURL() {
				return renderUrl;
			}
		};

		ctx = ActionContext.getContext();
		ctx.put(PortletActionConstants.PHASE,
				PortletActionConstants.RENDER_PHASE);
		ctx.put(PortletActionConstants.REQUEST, request);
		ctx.put(PortletActionConstants.RESPONSE, response);
		ctx.put(StrutsStatics.STRUTS_PORTLET_CONTEXT, context);

		Map<PortletMode, String> modeMap = new HashMap<PortletMode, String>();
		modeMap.put(PortletMode.VIEW, "/view");
		ctx.put(PortletActionConstants.MODE_NAMESPACE_MAP, modeMap);
		stack = ctx.getValueStack();
	}

	/**
	 * Ensure that the namespace of the current executing action is used when no
	 * namespace is specified. (WW-1875)
	 */
	public void testShouldIncludeCurrentNamespaceIfNoNamespaceSpecifiedForRenderUrl()
			throws Exception {
		
		URL url = new URL(stack, new PortletServletRequest(request, null),
				new PortletServletResponse(response));

		MockActionInvocation ai = new MockActionInvocation();
		MockActionProxy ap = new MockActionProxy();
		ap.setActionName("testAction");
		ap.setNamespace("/current_namespace");
		ai.setProxy(ap);
		ai.setStack(stack);
		ai.setAction(new Object());
		ctx.setActionInvocation(ai);

		StringWriter renderOutput = new StringWriter();
		renderer.renderUrl(renderOutput, url.getUrlProvider());

		String action = renderUrl
				.getParameter(PortletActionConstants.ACTION_PARAM);
		assertEquals("/view/current_namespace/testAction", action);
	}

	/**
	 * Ensure that the namespace of the current executing action is used when no
	 * namespace is specified. (WW-1875)
	 */
	public void testShouldIncludeCurrentNamespaceIfNoNamespaceSpecifiedForRenderFormUrl()
			throws Exception {

		Form form = new Form(stack, new PortletServletRequest(request, null),
				new PortletServletResponse(response));

		MockActionInvocation ai = new MockActionInvocation();
		MockActionProxy ap = new MockActionProxy();
		ap.setActionName("testAction");
		ap.setNamespace("/current_namespace");
		ai.setProxy(ap);
		ai.setStack(stack);
		ai.setAction(new Object());
		ctx.setActionInvocation(ai);

		renderer.renderFormUrl(form);

		String action = actionUrl
				.getParameter(PortletActionConstants.ACTION_PARAM);
		assertEquals("/view/current_namespace/testAction", action);
	}
	
	public void testShouldEvaluateActionAsOGNLExpression() throws Exception {
		
		TestObject obj = new TestObject();
		obj.someProperty = "EvaluatedProperty";
		stack.push(obj);
		MockActionInvocation ai = new MockActionInvocation();
		MockActionProxy ap = new MockActionProxy();
		ap.setActionName("testAction");
		ap.setNamespace("");
		ai.setProxy(ap);
		ai.setStack(stack);
		ctx.setActionInvocation(ai);
		
		URL url = new URL(stack, new PortletServletRequest(request, null),
				new PortletServletResponse(response));
		url.setAction("%{someProperty}");
		
		StringWriter renderOutput = new StringWriter();
		renderer.renderUrl(renderOutput, url.getUrlProvider());

		String action = renderUrl
				.getParameter(PortletActionConstants.ACTION_PARAM);
		assertEquals("/view/EvaluatedProperty", action);
		
	}
	
	public void testShouldEvaluateAnchorAsOGNLExpression() throws Exception {
		
		TestObject obj = new TestObject();
		obj.someProperty = "EvaluatedProperty";
		stack.push(obj);
		MockActionInvocation ai = new MockActionInvocation();
		MockActionProxy ap = new MockActionProxy();
		ap.setActionName("testAction");
		ap.setNamespace("");
		ai.setProxy(ap);
		ai.setStack(stack);
		ctx.setActionInvocation(ai);
		
		URL url = new URL(stack, new PortletServletRequest(request, null),
				new PortletServletResponse(response));
		url.setAnchor("%{someProperty}");
		
		StringWriter renderOutput = new StringWriter();
		renderer.renderUrl(renderOutput, url.getUrlProvider());
		assertTrue(renderOutput.toString().indexOf("#EvaluatedProperty") != -1);
		
	}
	
	public void testShouldPassThroughRenderUrlToServletUrlRendererIfNotPortletRequest() throws Exception {
		UrlRenderer mockRenderer = EasyMock.createMock(UrlRenderer.class);
		ActionContext.getContext().put(StrutsStatics.STRUTS_PORTLET_CONTEXT, null);
		renderer.setServletRenderer(mockRenderer);
		URL url = new URL(stack, new PortletServletRequest(request, null), new PortletServletResponse(response));
		StringWriter renderOutput = new StringWriter();
		mockRenderer.renderUrl(renderOutput, url.getUrlProvider());
		EasyMock.replay(mockRenderer);
		renderer.renderUrl(renderOutput, url.getUrlProvider());
		EasyMock.verify(mockRenderer);
	}
	
	public void testShouldPassThroughRenderFormUrlToServletUrlRendererIfNotPortletRequest() throws Exception {
		UrlRenderer mockRenderer = EasyMock.createMock(UrlRenderer.class);
		ActionContext.getContext().put(StrutsStatics.STRUTS_PORTLET_CONTEXT, null);
		renderer.setServletRenderer(mockRenderer);
		Form form = new Form(stack, new PortletServletRequest(request, null), new PortletServletResponse(response));
		mockRenderer.renderFormUrl(form);
		EasyMock.replay(mockRenderer);
		renderer.renderFormUrl(form);
		EasyMock.verify(mockRenderer);
	}
	
	public void testShouldPassThroughRenderUrlToServletUrlRendererWhenPortletUrlTypeIsNone() throws Exception {
		UrlRenderer mockRenderer = EasyMock.createMock(UrlRenderer.class);
		renderer.setServletRenderer(mockRenderer);
		URL url = new URL(stack, new PortletServletRequest(request, null), new PortletServletResponse(response));
		url.setPortletUrlType("none");
		StringWriter renderOutput = new StringWriter();
		mockRenderer.renderUrl(renderOutput, url.getUrlProvider());
		EasyMock.replay(mockRenderer);
		renderer.renderUrl(renderOutput, url.getUrlProvider());
		EasyMock.verify(mockRenderer);
	}
	
	private final static class TestObject {
		public String someProperty;
	}
	
	
}