EmbeddedPortletTest.java

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library 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 library 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.
 */

package com.liferay.portal.osgi.web.portlet.container.embedded.test;

import com.liferay.arquillian.extension.junit.bridge.junit.Arquillian;
import com.liferay.portal.kernel.model.Group;
import com.liferay.portal.kernel.model.Layout;
import com.liferay.portal.kernel.model.LayoutTypePortlet;
import com.liferay.portal.kernel.model.Portlet;
import com.liferay.portal.kernel.model.PortletPreferences;
import com.liferay.portal.kernel.service.PortletLocalServiceUtil;
import com.liferay.portal.kernel.service.PortletPreferencesLocalServiceUtil;
import com.liferay.portal.kernel.template.TemplateHandler;
import com.liferay.portal.kernel.test.rule.AggregateTestRule;
import com.liferay.portal.kernel.test.rule.DeleteAfterTestRun;
import com.liferay.portal.kernel.test.util.GroupTestUtil;
import com.liferay.portal.kernel.test.util.RandomTestUtil;
import com.liferay.portal.kernel.test.util.TestPropsValues;
import com.liferay.portal.kernel.util.HashMapDictionary;
import com.liferay.portal.kernel.util.PortletKeys;
import com.liferay.portal.kernel.util.PropsKeys;
import com.liferay.portal.kernel.util.StringBundler;
import com.liferay.portal.osgi.web.portlet.container.test.BasePortletContainerTestCase;
import com.liferay.portal.osgi.web.portlet.container.test.TestPortlet;
import com.liferay.portal.test.rule.LiferayIntegrationTestRule;
import com.liferay.portal.util.PropsUtil;
import com.liferay.portal.util.PropsValues;
import com.liferay.portal.util.test.LayoutTestUtil;
import com.liferay.portal.util.test.PortletContainerTestUtil;
import com.liferay.portal.util.test.PortletContainerTestUtil.Response;
import com.liferay.portlet.PortletURLImpl;

import java.io.IOException;

import java.util.Dictionary;
import java.util.Hashtable;
import java.util.List;

import javax.portlet.PortletContext;
import javax.portlet.PortletException;
import javax.portlet.PortletRequest;
import javax.portlet.PortletRequestDispatcher;
import javax.portlet.PortletURL;
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;
import javax.portlet.ResourceRequest;
import javax.portlet.ResourceResponse;

import javax.servlet.http.HttpServletRequest;

import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.ClassRule;
import org.junit.Rule;
import org.junit.Test;
import org.junit.experimental.runners.Enclosed;
import org.junit.runner.RunWith;

/**
 * @author Manuel de la Peña
 */
@RunWith(Enclosed.class)
public class EmbeddedPortletTest {

	@RunWith(Arquillian.class)
	public static class WhenEmbeddingEmbeddablePortletInLayout {

		@ClassRule
		@Rule
		public static final AggregateTestRule aggregateTestRule =
			new LiferayIntegrationTestRule();

		@Before
		public void setUp() throws Exception {
			_group = GroupTestUtil.addGroup();

			_layout = LayoutTestUtil.addLayout(_group);

			_layoutTypePortlet = (LayoutTypePortlet)_layout.getLayoutType();

			_layoutStaticPortletsAll = PropsValues.LAYOUT_STATIC_PORTLETS_ALL;
		}

		@Test
		public void shouldNotReturnItFromExplicitlyAddedPortlets()
			throws Exception {

			Portlet portlet = PortletLocalServiceUtil.getPortletById(
				PortletKeys.LOGIN);

			PortletPreferencesLocalServiceUtil.addPortletPreferences(
				TestPropsValues.getCompanyId(),
				PortletKeys.PREFS_OWNER_ID_DEFAULT,
				PortletKeys.PREFS_OWNER_TYPE_LAYOUT, _layout.getPlid(),
				portlet.getPortletId(), portlet, null);

			List<Portlet> explicitlyAddedPortlets =
				_layoutTypePortlet.getExplicitlyAddedPortlets();

			Assert.assertFalse(explicitlyAddedPortlets.contains(portlet));
		}

		@Test
		public void shouldReturnItFromAllPortlets() throws Exception {
			Portlet portlet = PortletLocalServiceUtil.getPortletById(
				PortletKeys.LOGIN);

			PortletPreferencesLocalServiceUtil.addPortletPreferences(
				TestPropsValues.getCompanyId(),
				PortletKeys.PREFS_OWNER_ID_DEFAULT,
				PortletKeys.PREFS_OWNER_TYPE_LAYOUT, _layout.getPlid(),
				portlet.getPortletId(), portlet, null);

			PortletPreferencesLocalServiceUtil.addPortletPreferences(
				TestPropsValues.getCompanyId(), _layout.getGroupId(),
				PortletKeys.PREFS_OWNER_TYPE_LAYOUT,
				PortletKeys.PREFS_PLID_SHARED, portlet.getPortletId(), portlet,
				null);

			List<Portlet> allPortlets = _layoutTypePortlet.getAllPortlets();

			Assert.assertTrue(allPortlets.contains(portlet));
		}

		@Test
		public void shouldReturnItFromEmbeddedPortlets() throws Exception {
			Portlet portlet = PortletLocalServiceUtil.getPortletById(
				PortletKeys.LOGIN);

			PortletPreferencesLocalServiceUtil.addPortletPreferences(
				TestPropsValues.getCompanyId(),
				PortletKeys.PREFS_OWNER_ID_DEFAULT,
				PortletKeys.PREFS_OWNER_TYPE_LAYOUT, _layout.getPlid(),
				portlet.getPortletId(), portlet, null);

			PortletPreferencesLocalServiceUtil.addPortletPreferences(
				TestPropsValues.getCompanyId(), _layout.getGroupId(),
				PortletKeys.PREFS_OWNER_TYPE_LAYOUT,
				PortletKeys.PREFS_PLID_SHARED, portlet.getPortletId(), portlet,
				null);

			List<Portlet> embeddedPortlets =
				_layoutTypePortlet.getEmbeddedPortlets();

			Assert.assertTrue(embeddedPortlets.contains(portlet));
		}

		@Test
		public void shouldReturnItsConfiguration() throws Exception {
			Portlet portlet = PortletLocalServiceUtil.getPortletById(
				PortletKeys.LOGIN);

			String defaultPreferences = RandomTestUtil.randomString();

			PortletPreferencesLocalServiceUtil.addPortletPreferences(
				TestPropsValues.getCompanyId(),
				PortletKeys.PREFS_OWNER_ID_DEFAULT,
				PortletKeys.PREFS_OWNER_TYPE_LAYOUT, _layout.getPlid(),
				portlet.getPortletId(), portlet, defaultPreferences);

			List<PortletPreferences> portletPreferences =
				PortletPreferencesLocalServiceUtil.getPortletPreferences(
					_layout.getPlid(), portlet.getPortletId());

			Assert.assertEquals(
				portletPreferences.toString(), 1, portletPreferences.size());

			PortletPreferences embeddedPortletPreference =
				portletPreferences.get(0);

			Assert.assertEquals(
				defaultPreferences, embeddedPortletPreference.getPreferences());
		}

		@After
		public void tearDown() {
			StringBundler sb = new StringBundler(
				_layoutStaticPortletsAll.length);

			for (String portletId : _layoutStaticPortletsAll) {
				sb.append(portletId);
			}

			PropsUtil.set(PropsKeys.LAYOUT_STATIC_PORTLETS_ALL, sb.toString());
		}

	}

	@RunWith(Arquillian.class)
	public static class WhenEmbeddingNonembeddablePortletInLayout
		extends BasePortletContainerTestCase {

		@ClassRule
		@Rule
		public static final AggregateTestRule aggregateTestRule =
			new LiferayIntegrationTestRule();

		@Before
		@Override
		public void setUp() throws Exception {
			super.setUp();

			_layoutTypePortlet = (LayoutTypePortlet)layout.getLayoutType();

			_layoutStaticPortletsAll = PropsValues.LAYOUT_STATIC_PORTLETS_ALL;

			_testNonembeddedPortlet = new TestNonembeddedPortlet();

			Dictionary<String, Object> properties = new Hashtable<>();

			setUpPortlet(
				_testNonembeddedPortlet, properties,
				_testNonembeddedPortlet.getPortletId(), false);
		}

		@Test
		public void shouldNotReturnItFromAllPortlets() throws Exception {
			PortletPreferencesLocalServiceUtil.addPortletPreferences(
				TestPropsValues.getCompanyId(),
				PortletKeys.PREFS_OWNER_ID_DEFAULT,
				PortletKeys.PREFS_OWNER_TYPE_LAYOUT, layout.getPlid(),
				_testNonembeddedPortlet.getPortletId(), _testNonembeddedPortlet,
				null);

			List<Portlet> allPortlets = _layoutTypePortlet.getAllPortlets();

			Assert.assertFalse(allPortlets.contains(_testNonembeddedPortlet));
		}

		@Test
		public void shouldNotReturnItFromEmbeddedPortlets() throws Exception {
			PortletPreferencesLocalServiceUtil.addPortletPreferences(
				TestPropsValues.getCompanyId(),
				PortletKeys.PREFS_OWNER_ID_DEFAULT,
				PortletKeys.PREFS_OWNER_TYPE_LAYOUT, layout.getPlid(),
				_testNonembeddedPortlet.getPortletId(), _testNonembeddedPortlet,
				null);

			List<Portlet> embeddedPortlets =
				_layoutTypePortlet.getEmbeddedPortlets();

			Assert.assertFalse(
				embeddedPortlets.contains(_testNonembeddedPortlet));
		}

		@Test
		public void shouldNotReturnItFromExplicitlyAddedPortlets()
			throws Exception {

			PortletPreferencesLocalServiceUtil.addPortletPreferences(
				TestPropsValues.getCompanyId(),
				PortletKeys.PREFS_OWNER_ID_DEFAULT,
				PortletKeys.PREFS_OWNER_TYPE_LAYOUT, layout.getPlid(),
				_testNonembeddedPortlet.getPortletId(), _testNonembeddedPortlet,
				null);

			List<Portlet> explicitlyAddedPortlets =
				_layoutTypePortlet.getExplicitlyAddedPortlets();

			Assert.assertFalse(
				explicitlyAddedPortlets.contains(_testNonembeddedPortlet));
		}

		@Test
		public void shouldReturnItsConfiguration() throws Exception {
			String defaultPreferences = RandomTestUtil.randomString();

			PortletPreferencesLocalServiceUtil.addPortletPreferences(
				TestPropsValues.getCompanyId(),
				PortletKeys.PREFS_OWNER_ID_DEFAULT,
				PortletKeys.PREFS_OWNER_TYPE_LAYOUT, layout.getPlid(),
				_testNonembeddedPortlet.getPortletId(), _testNonembeddedPortlet,
				defaultPreferences);

			List<PortletPreferences> portletPreferences =
				PortletPreferencesLocalServiceUtil.getPortletPreferences(
					layout.getPlid(), _testNonembeddedPortlet.getPortletId());

			Assert.assertEquals(
				portletPreferences.toString(), 1, portletPreferences.size());

			PortletPreferences embeddedPortletPreference =
				portletPreferences.get(0);

			Assert.assertEquals(
				defaultPreferences, embeddedPortletPreference.getPreferences());
		}

		@After
		@Override
		public void tearDown() throws Exception {
			StringBundler sb = new StringBundler(
				_layoutStaticPortletsAll.length);

			for (String portletId : _layoutStaticPortletsAll) {
				sb.append(portletId);
			}

			PropsUtil.set(PropsKeys.LAYOUT_STATIC_PORTLETS_ALL, sb.toString());

			super.tearDown();
		}

		private TestNonembeddedPortlet _testNonembeddedPortlet;

	}

	@RunWith(Arquillian.class)
	public static class WhenEmbeddingPortletUsingApplicationDisplayTemplate
		extends BasePortletContainerTestCase {

		@ClassRule
		@Rule
		public static final AggregateTestRule aggregateTestRule =
			new LiferayIntegrationTestRule();

		@Before
		@Override
		public void setUp() throws Exception {
			super.setUp();

			_layoutTypePortlet = (LayoutTypePortlet)layout.getLayoutType();

			_layoutStaticPortletsAll = PropsValues.LAYOUT_STATIC_PORTLETS_ALL;
		}

		@Test
		public void shouldRenderApplicationDisplayTemplateAndRuntimePortlets()
			throws Exception {

			TestPortlet testPortlet = new TestPortlet() {

				@Override
				public void render(
						RenderRequest renderRequest,
						RenderResponse renderResponse)
					throws IOException, PortletException {

					super.render(renderRequest, renderResponse);

					PortletContext portletContext = getPortletContext();

					PortletRequestDispatcher portletRequestDispatcher =
						portletContext.getRequestDispatcher("/view.jsp");

					portletRequestDispatcher.include(
						renderRequest, renderResponse);
				}

			};

			Dictionary<String, Object> properties = new HashMapDictionary<>();

			properties.put(
				"com.liferay.portlet.instanceable", Boolean.FALSE.toString());

			setUpPortlet(testPortlet, properties, TEST_PORTLET_ID);

			properties.put("javax.portlet.name", TEST_PORTLET_ID);

			registerService(
				TemplateHandler.class,
				new TestEmbeddedPortletDisplayTemplateHandler(), properties);

			HttpServletRequest httpServletRequest =
				PortletContainerTestUtil.getHttpServletRequest(group, layout);

			PortletURL portletURL = new PortletURLImpl(
				httpServletRequest, TEST_PORTLET_ID, layout.getPlid(),
				PortletRequest.RENDER_PHASE);

			TestRuntimePortlet testRuntimePortlet = new TestRuntimePortlet();
			String testRuntimePortletId = "testRuntimePortletId";

			setUpPortlet(
				testRuntimePortlet, properties, testRuntimePortletId, false);

			portletURL.setParameter(
				"testRuntimePortletId", testRuntimePortletId);

			Response response = PortletContainerTestUtil.request(
				portletURL.toString());

			Assert.assertEquals(200, response.getCode());

			Assert.assertTrue(testPortlet.isCalledRender());
			Assert.assertTrue(testRuntimePortlet.isCalledRuntime());
		}

	}

	@RunWith(Arquillian.class)
	public static class WhenEmbeddingPortletUsingRuntimeTag
		extends BasePortletContainerTestCase {

		@ClassRule
		@Rule
		public static final AggregateTestRule aggregateTestRule =
			new LiferayIntegrationTestRule();

		@Before
		@Override
		public void setUp() throws Exception {
			super.setUp();

			_layoutTypePortlet = (LayoutTypePortlet)layout.getLayoutType();

			_layoutStaticPortletsAll = PropsValues.LAYOUT_STATIC_PORTLETS_ALL;
		}

		@Test
		public void shouldRenderEmbeddedAndRuntimePortlets() throws Exception {
			TestPortlet testPortlet = new TestPortlet() {

				@Override
				public void serveResource(
						ResourceRequest resourceRequest,
						ResourceResponse resourceResponse)
					throws IOException, PortletException {

					super.serveResource(resourceRequest, resourceResponse);

					PortletContext portletContext = getPortletContext();

					PortletRequestDispatcher portletRequestDispatcher =
						portletContext.getRequestDispatcher(
							"/runtime_portlet.jsp");

					portletRequestDispatcher.include(
						resourceRequest, resourceResponse);
				}

			};

			Dictionary<String, Object> properties = new HashMapDictionary<>();

			setUpPortlet(testPortlet, properties, TEST_PORTLET_ID, false);

			PortletPreferencesLocalServiceUtil.addPortletPreferences(
				TestPropsValues.getCompanyId(),
				PortletKeys.PREFS_OWNER_ID_DEFAULT,
				PortletKeys.PREFS_OWNER_TYPE_LAYOUT, layout.getPlid(),
				TEST_PORTLET_ID, null, null);

			HttpServletRequest httpServletRequest =
				PortletContainerTestUtil.getHttpServletRequest(group, layout);

			PortletURL portletURL = new PortletURLImpl(
				httpServletRequest, TEST_PORTLET_ID, layout.getPlid(),
				PortletRequest.RESOURCE_PHASE);

			TestRuntimePortlet testRuntimePortlet = new TestRuntimePortlet();
			String testRuntimePortletId = "testRuntimePortletId";

			setUpPortlet(
				testRuntimePortlet, properties, testRuntimePortletId, false);

			portletURL.setParameter(
				"testRuntimePortletId", testRuntimePortletId);

			Response response = PortletContainerTestUtil.request(
				portletURL.toString());

			Assert.assertEquals(200, response.getCode());

			Assert.assertTrue(testPortlet.isCalledServeResource());
			Assert.assertTrue(testRuntimePortlet.isCalledRuntime());
		}

	}

	@DeleteAfterTestRun
	private static Group _group;

	private static Layout _layout;
	private static String[] _layoutStaticPortletsAll;
	private static LayoutTypePortlet _layoutTypePortlet;

}