Refactor VaadinPortletRequest extending. (#13551)

Change-Id: Ibe169bf0ec6d2f335e099ac2659079c8fad6ac0b

5 files changed, 351 insertions, 0 deletions

diff --git a/server/tests/src/com/vaadin/server/VaadinGateInRequestTests.java b/server/tests/src/com/vaadin/server/VaadinGateInRequestTests.java
new file mode 100644
index 0000000000..017613661e
--- /dev/null
+++ b/server/tests/src/com/vaadin/server/VaadinGateInRequestTests.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2000-2013 Vaadin Ltd.
+ * 
+ * Licensed 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 com.vaadin.server;
+
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.spy;
+
+import com.vaadin.server.VaadinPortlet.VaadinGateInRequest;
+
+public class VaadinGateInRequestTests extends
+        VaadinHttpAndPortletRequestTests<VaadinGateInRequest> {
+
+    @Override
+    protected VaadinGateInRequest createSut() {
+
+        VaadinGateInRequest request = new VaadinGateInRequest(portletRequest,
+                vaadinPortletService);
+
+        // Although partial mocking can be considered a code smell,
+        // here it's actually quite useful to mock reflection calls.
+        VaadinGateInRequest spy = spy(request);
+        doReturn(servletRequest).when(spy).getServletRequest(portletRequest);
+
+        return spy;
+    }
+}
diff --git a/server/tests/src/com/vaadin/server/VaadinHttpAndPortletRequestTests.java b/server/tests/src/com/vaadin/server/VaadinHttpAndPortletRequestTests.java
new file mode 100644
index 0000000000..01d501c4fb
--- /dev/null
+++ b/server/tests/src/com/vaadin/server/VaadinHttpAndPortletRequestTests.java
@@ -0,0 +1,140 @@
+/*
+ * Copyright 2000-2013 Vaadin Ltd.
+ * 
+ * Licensed 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 com.vaadin.server;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.core.Is.is;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import java.util.Enumeration;
+import java.util.Map;
+
+import javax.portlet.PortletRequest;
+import javax.servlet.http.HttpServletRequest;
+
+import org.junit.Before;
+import org.junit.Ignore;
+import org.junit.Test;
+
+import com.vaadin.server.VaadinPortlet.VaadinHttpAndPortletRequest;
+import com.vaadin.server.VaadinPortletService;
+
+//Have to ignore this class - otherwise JUnit tries to instantiate it...
+@Ignore
+public abstract class VaadinHttpAndPortletRequestTests<T extends VaadinHttpAndPortletRequest> {
+
+    protected VaadinHttpAndPortletRequest sut;
+    protected HttpServletRequest servletRequest;
+    protected PortletRequest portletRequest;
+    protected VaadinPortletService vaadinPortletService;
+
+    protected abstract T createSut();
+
+    @Before
+    public void setup() {
+        portletRequest = mock(PortletRequest.class);
+        vaadinPortletService = mock(VaadinPortletService.class);
+        servletRequest = mock(HttpServletRequest.class);
+
+        sut = createSut();
+    }
+
+    @Test
+    public void parameterIsFetchedFromServletRequest() {
+        when(servletRequest.getParameter("foo")).thenReturn("bar");
+
+        String parameter = sut.getParameter("foo");
+
+        assertThat(parameter, is("bar"));
+    }
+
+    @Test
+    public void originalParameterIsOverridden() {
+        when(servletRequest.getParameter("foo")).thenReturn("braa");
+        when(portletRequest.getParameter("foo")).thenReturn("bar");
+
+        String parameter = sut.getParameter("foo");
+
+        assertThat(parameter, is("bar"));
+    }
+
+    @Test
+    public void remoteAddressIsFetchedFromServletRequest() {
+        when(servletRequest.getRemoteAddr()).thenReturn("foo");
+
+        String remoteAddr = sut.getRemoteAddr();
+
+        assertThat(remoteAddr, is("foo"));
+    }
+
+    @Test
+    public void remoteHostIsFetchedFromServletRequest() {
+        when(servletRequest.getRemoteHost()).thenReturn("foo");
+
+        String remoteHost = sut.getRemoteHost();
+
+        assertThat(remoteHost, is("foo"));
+    }
+
+    @Test
+    public void remotePortIsFetchedFromServletRequest() {
+        when(servletRequest.getRemotePort()).thenReturn(12345);
+
+        int remotePort = sut.getRemotePort();
+
+        assertThat(remotePort, is(12345));
+    }
+
+    @Test
+    public void headerIsFetchedFromServletRequest() {
+        when(servletRequest.getHeader("foo")).thenReturn("bar");
+
+        String header = sut.getHeader("foo");
+
+        assertThat(header, is("bar"));
+    }
+
+    @Test
+    public void headerNamesAreFetchedFromServletRequest() {
+        Enumeration expectedHeaderNames = mock(Enumeration.class);
+        when(servletRequest.getHeaderNames()).thenReturn(expectedHeaderNames);
+
+        Enumeration<String> actualHeaderNames = sut.getHeaderNames();
+
+        assertThat(actualHeaderNames, is(expectedHeaderNames));
+    }
+
+    @Test
+    public void headersAreFetchedFromServletRequest() {
+        Enumeration expectedHeaders = mock(Enumeration.class);
+        when(servletRequest.getHeaders("foo")).thenReturn(expectedHeaders);
+
+        Enumeration<String> actualHeaders = sut.getHeaders("foo");
+
+        assertThat(actualHeaders, is(expectedHeaders));
+    }
+
+    @Test
+    public void parameterMapIsFetchedFromServletRequest() {
+        Map expectedParameterMap = mock(Map.class);
+        when(servletRequest.getParameterMap()).thenReturn(expectedParameterMap);
+
+        Map<String, String[]> actualParameterMap = sut.getParameterMap();
+
+        assertThat(actualParameterMap, is(expectedParameterMap));
+    }
+}
diff --git a/server/tests/src/com/vaadin/server/VaadinLiferayRequestTests.java b/server/tests/src/com/vaadin/server/VaadinLiferayRequestTests.java
new file mode 100644
index 0000000000..074941a556
--- /dev/null
+++ b/server/tests/src/com/vaadin/server/VaadinLiferayRequestTests.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2000-2013 Vaadin Ltd.
+ * 
+ * Licensed 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 com.vaadin.server;
+
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.spy;
+
+import com.vaadin.server.VaadinPortlet.VaadinLiferayRequest;
+
+public class VaadinLiferayRequestTests extends
+        VaadinHttpAndPortletRequestTests<VaadinLiferayRequest> {
+
+    @Override
+    protected VaadinLiferayRequest createSut() {
+
+        VaadinLiferayRequest request = new VaadinLiferayRequest(portletRequest,
+                vaadinPortletService);
+
+        // Although partial mocking can be considered a code smell,
+        // here it's actually quite useful to mock reflection calls.
+        VaadinLiferayRequest spy = spy(request);
+        doReturn(servletRequest).when(spy).getServletRequest(portletRequest);
+
+        return spy;
+    }
+}
\ No newline at end of file
diff --git a/server/tests/src/com/vaadin/server/VaadinPortletTests.java b/server/tests/src/com/vaadin/server/VaadinPortletTests.java
new file mode 100644
index 0000000000..93f8fd0778
--- /dev/null
+++ b/server/tests/src/com/vaadin/server/VaadinPortletTests.java
@@ -0,0 +1,94 @@
+/*
+ * Copyright 2000-2013 Vaadin Ltd.
+ * 
+ * Licensed 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 com.vaadin.server;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.core.IsInstanceOf.instanceOf;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import javax.portlet.PortalContext;
+import javax.portlet.PortletRequest;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import com.vaadin.server.VaadinPortlet.VaadinGateInRequest;
+import com.vaadin.server.VaadinPortlet.VaadinLiferayRequest;
+import com.vaadin.server.VaadinPortlet.VaadinWebSpherePortalRequest;
+
+public class VaadinPortletTests {
+
+    private VaadinPortlet sut;
+    private PortletRequest portletRequest;
+    private PortalContext portalContext;
+
+    @Before
+    public void setup() {
+        sut = new VaadinPortlet();
+
+        portletRequest = mock(PortletRequest.class);
+        portalContext = mock(PortalContext.class);
+
+        when(portletRequest.getPortalContext()).thenReturn(portalContext);
+    }
+
+    private void mockPortalInfo(String name) {
+        when(portalContext.getPortalInfo()).thenReturn(name);
+    }
+
+    private VaadinPortletRequest createRequest() {
+        VaadinPortletRequest request = sut.createVaadinRequest(portletRequest);
+        return request;
+    }
+
+    @Test
+    public void gateInRequestIsCreated() {
+        mockPortalInfo("gatein");
+
+        VaadinPortletRequest request = createRequest();
+
+        assertThat(request, instanceOf(VaadinGateInRequest.class));
+    }
+
+    @Test
+    public void liferayRequestIsCreated() {
+        mockPortalInfo("liferay");
+
+        VaadinPortletRequest request = createRequest();
+
+        assertThat(request, instanceOf(VaadinLiferayRequest.class));
+    }
+
+    @Test
+    public void webspherePortalRequestIsCreated() {
+        mockPortalInfo("websphere portal");
+
+        VaadinPortletRequest request = createRequest();
+
+        assertThat(request, instanceOf(VaadinWebSpherePortalRequest.class));
+    }
+
+    @Test
+    public void defaultPortletRequestIsCreated() {
+        mockPortalInfo("foobar");
+
+        VaadinPortletRequest request = createRequest();
+
+        assertThat(request, instanceOf(VaadinPortletRequest.class));
+    }
+
+}
diff --git a/server/tests/src/com/vaadin/server/VaadinWebSpherePortalRequestTests.java b/server/tests/src/com/vaadin/server/VaadinWebSpherePortalRequestTests.java
new file mode 100644
index 0000000000..0da85c7111
--- /dev/null
+++ b/server/tests/src/com/vaadin/server/VaadinWebSpherePortalRequestTests.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2000-2013 Vaadin Ltd.
+ * 
+ * Licensed 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 com.vaadin.server;
+
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.spy;
+
+import com.vaadin.server.VaadinPortlet.VaadinWebSpherePortalRequest;
+
+public class VaadinWebSpherePortalRequestTests extends
+        VaadinHttpAndPortletRequestTests<VaadinWebSpherePortalRequest> {
+
+    @Override
+    protected VaadinWebSpherePortalRequest createSut() {
+
+        VaadinWebSpherePortalRequest request = new VaadinWebSpherePortalRequest(
+                portletRequest, vaadinPortletService);
+
+        // Although partial mocking can be considered a code smell,
+        // here it's actually quite useful to mock reflection calls.
+        VaadinWebSpherePortalRequest spy = spy(request);
+        doReturn(servletRequest).when(spy).getServletRequest(portletRequest);
+
+        return spy;
+    }
+}
\ No newline at end of file