LayoutFriendlyURLTest.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.layout.test;

import com.liferay.arquillian.extension.junit.bridge.junit.Arquillian;
import com.liferay.portal.kernel.exception.LayoutFriendlyURLException;
import com.liferay.portal.kernel.exception.LayoutFriendlyURLsException;
import com.liferay.portal.kernel.model.Group;
import com.liferay.portal.kernel.model.Layout;
import com.liferay.portal.kernel.model.LayoutConstants;
import com.liferay.portal.kernel.service.LayoutLocalServiceUtil;
import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.test.rule.AggregateTestRule;
import com.liferay.portal.kernel.test.rule.DeleteAfterTestRun;
import com.liferay.portal.kernel.test.rule.Sync;
import com.liferay.portal.kernel.test.util.GroupTestUtil;
import com.liferay.portal.kernel.test.util.RandomTestUtil;
import com.liferay.portal.kernel.test.util.ServiceContextTestUtil;
import com.liferay.portal.kernel.test.util.TestPropsValues;
import com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil;
import com.liferay.portal.kernel.util.ListUtil;
import com.liferay.portal.kernel.util.LocaleUtil;
import com.liferay.portal.kernel.util.StringPool;
import com.liferay.portal.test.rule.LiferayIntegrationTestRule;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;

import org.junit.Assert;
import org.junit.Before;
import org.junit.ClassRule;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;

/**
 * @author Sergio González
 */
@RunWith(Arquillian.class)
@Sync
public class LayoutFriendlyURLTest {

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

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

		_groups.add(_group);
	}

	@Test
	public void testDifferentFriendlyURLDifferentLocaleDifferentGroup()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.SPAIN, "/casa");
		friendlyURLMap.put(LocaleUtil.US, "/home");

		addLayout(_group.getGroupId(), false, friendlyURLMap);

		Group group = GroupTestUtil.addGroup();

		_groups.add(group);

		addLayout(group.getGroupId(), false, friendlyURLMap);
	}

	@Test
	public void testDifferentFriendlyURLDifferentLocaleDifferentLayoutSet()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.SPAIN, "/casa");
		friendlyURLMap.put(LocaleUtil.US, "/home");

		addLayout(_group.getGroupId(), false, friendlyURLMap);

		Group group = GroupTestUtil.addGroup();

		_groups.add(group);

		addLayout(group.getGroupId(), true, friendlyURLMap);
	}

	@Test
	public void testDifferentFriendlyURLDifferentLocaleSameLayout()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.SPAIN, "/casa");
		friendlyURLMap.put(LocaleUtil.US, "/home");

		addLayout(_group.getGroupId(), false, friendlyURLMap);
	}

	@Test
	public void testFriendlyURLWithSpecialCharacter() throws Exception {
		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/Football⚽");

		addLayout(_group.getGroupId(), false, friendlyURLMap);

		String friendlyURL = FriendlyURLNormalizerUtil.normalizeWithEncoding(
			"/Football⚽");

		Layout layout = LayoutLocalServiceUtil.fetchLayoutByFriendlyURL(
			_group.getGroupId(), false, friendlyURL);

		Assert.assertNotNull(layout);
	}

	@Test(expected = LayoutFriendlyURLsException.class)
	public void testInvalidFriendlyURLLanguageId() throws Exception {
		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/es");

		addLayout(_group.getGroupId(), false, friendlyURLMap);
	}

	@Test(expected = LayoutFriendlyURLsException.class)
	public void testInvalidFriendlyURLLanguageIdAndCountryId()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/es_ES");

		addLayout(_group.getGroupId(), false, friendlyURLMap);
	}

	@Test
	public void testInvalidFriendlyURLMapperURLInDefaultLocale()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/tags");

		try {
			addLayout(_group.getGroupId(), false, friendlyURLMap);

			Assert.fail();
		}
		catch (LayoutFriendlyURLsException lfurle) {
			Map<Locale, Exception> localizedExceptionsMap =
				lfurle.getLocalizedExceptionsMap();

			List<Exception> layoutFriendlyURLExceptions =
				ListUtil.fromCollection(localizedExceptionsMap.values());

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

			LayoutFriendlyURLException layoutFriendlyURLException =
				(LayoutFriendlyURLException)layoutFriendlyURLExceptions.get(0);

			Assert.assertEquals(
				"tags", layoutFriendlyURLException.getKeywordConflict());
		}

		friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/home/tags");

		try {
			addLayout(_group.getGroupId(), false, friendlyURLMap);

			Assert.fail();
		}
		catch (LayoutFriendlyURLsException lfurle) {
			Map<Locale, Exception> localizedExceptionsMap =
				lfurle.getLocalizedExceptionsMap();

			List<Exception> layoutFriendlyURLExceptions =
				ListUtil.fromCollection(localizedExceptionsMap.values());

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

			LayoutFriendlyURLException layoutFriendlyURLException =
				(LayoutFriendlyURLException)layoutFriendlyURLExceptions.get(0);

			Assert.assertEquals(
				"tags", layoutFriendlyURLException.getKeywordConflict());
		}

		friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/tags/home");

		try {
			addLayout(_group.getGroupId(), false, friendlyURLMap);

			Assert.fail();
		}
		catch (LayoutFriendlyURLsException lfurle) {
			Map<Locale, Exception> localizedExceptionsMap =
				lfurle.getLocalizedExceptionsMap();

			List<Exception> layoutFriendlyURLExceptions =
				ListUtil.fromCollection(localizedExceptionsMap.values());

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

			LayoutFriendlyURLException layoutFriendlyURLException =
				(LayoutFriendlyURLException)layoutFriendlyURLExceptions.get(0);

			Assert.assertEquals(
				"tags", layoutFriendlyURLException.getKeywordConflict());
		}

		friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/blogs/-/home");

		try {
			addLayout(_group.getGroupId(), false, friendlyURLMap);

			Assert.fail();
		}
		catch (LayoutFriendlyURLsException lfurle) {
			Map<Locale, Exception> localizedExceptionsMap =
				lfurle.getLocalizedExceptionsMap();

			List<Exception> layoutFriendlyURLExceptions =
				ListUtil.fromCollection(localizedExceptionsMap.values());

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

			LayoutFriendlyURLException layoutFriendlyURLException =
				(LayoutFriendlyURLException)layoutFriendlyURLExceptions.get(0);

			Assert.assertEquals(
				"/-/", layoutFriendlyURLException.getKeywordConflict());
		}
	}

	@Test(expected = LayoutFriendlyURLsException.class)
	public void testInvalidFriendlyURLMapperURLInNonDefaultLocale()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.SPAIN, "/tags/two");
		friendlyURLMap.put(LocaleUtil.US, "/two");

		addLayout(_group.getGroupId(), false, friendlyURLMap);
	}

	@Test(expected = LayoutFriendlyURLsException.class)
	public void testInvalidFriendlyURLStartingWithLanguageId()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/es/home");

		addLayout(_group.getGroupId(), false, friendlyURLMap);
	}

	@Test(expected = LayoutFriendlyURLsException.class)
	public void testInvalidFriendlyURLStartingWithLanguageIdAndCountryId()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/es_ES/home");

		addLayout(_group.getGroupId(), false, friendlyURLMap);
	}

	@Test(expected = LayoutFriendlyURLsException.class)
	public void testInvalidFriendlyURLStartingWithLowerCaseLanguageIdAndCountryId()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/es_es/home");

		addLayout(_group.getGroupId(), false, friendlyURLMap);
	}

	@Test
	public void testMultipleInvalidFriendlyURLMapperURL() throws Exception {
		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.SPAIN, "/tags/dos");
		friendlyURLMap.put(LocaleUtil.US, "/tags/two");

		try {
			addLayout(_group.getGroupId(), false, friendlyURLMap);
		}
		catch (LayoutFriendlyURLsException lfurle) {
			Map<Locale, Exception> localizedExceptionsMap =
				lfurle.getLocalizedExceptionsMap();

			List<Exception> layoutFriendlyURLExceptions =
				ListUtil.fromCollection(localizedExceptionsMap.values());

			Assert.assertEquals(
				layoutFriendlyURLExceptions.toString(), 2,
				layoutFriendlyURLExceptions.size());

			for (Exception e : layoutFriendlyURLExceptions) {
				String keywordsConflict =
					((LayoutFriendlyURLException)e).getKeywordConflict();

				Assert.assertEquals("tags", keywordsConflict);
			}
		}
	}

	@Test
	public void testSameFriendlyURLDifferentLocaleDifferentGroup()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.SPAIN, "/home");
		friendlyURLMap.put(LocaleUtil.US, "/home");

		addLayout(_group.getGroupId(), false, friendlyURLMap);

		Group group = GroupTestUtil.addGroup();

		_groups.add(group);

		addLayout(group.getGroupId(), false, friendlyURLMap);
	}

	@Test
	public void testSameFriendlyURLDifferentLocaleDifferentLayout()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.SPAIN, "/casa");
		friendlyURLMap.put(LocaleUtil.US, "/home");

		addLayout(_group.getGroupId(), false, friendlyURLMap);

		friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.SPAIN, "/home");
		friendlyURLMap.put(LocaleUtil.US, "/welcome");

		try {
			addLayout(_group.getGroupId(), false, friendlyURLMap);

			Assert.fail();
		}
		catch (LayoutFriendlyURLsException lfurle) {
		}
	}

	@Test
	public void testSameFriendlyURLDifferentLocaleDifferentLayoutSet()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.SPAIN, "/home");
		friendlyURLMap.put(LocaleUtil.US, "/home");

		addLayout(_group.getGroupId(), false, friendlyURLMap);
		addLayout(_group.getGroupId(), true, friendlyURLMap);
	}

	@Test
	public void testSameFriendlyURLDifferentLocaleSameLayout()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.SPAIN, "/home");
		friendlyURLMap.put(LocaleUtil.US, "/home");

		addLayout(_group.getGroupId(), false, friendlyURLMap);
	}

	@Test
	public void testSameFriendlyURLSameLocaleDifferentLayout()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.SPAIN, "/casa");
		friendlyURLMap.put(LocaleUtil.US, "/home");

		addLayout(_group.getGroupId(), false, friendlyURLMap);

		friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.SPAIN, "/casa");
		friendlyURLMap.put(LocaleUtil.US, "/house");

		try {
			addLayout(_group.getGroupId(), false, friendlyURLMap);

			Assert.fail();
		}
		catch (LayoutFriendlyURLsException lfurle) {
		}
	}

	@Test
	public void testValidFriendlyURLEndingWithLanguageId() throws Exception {
		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/home/es");

		addLayout(_group.getGroupId(), false, friendlyURLMap);
	}

	@Test
	public void testValidFriendlyURLEndingWithLanguageIdAndCountryId()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/home/es_ES");

		addLayout(_group.getGroupId(), false, friendlyURLMap);
	}

	@Test
	public void testValidFriendlyURLEndingWithLowerCaseLanguageIdAndCountryId()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/home/es_es");

		addLayout(_group.getGroupId(), false, friendlyURLMap);
	}

	@Test
	public void testValidFriendlyURLMapperURLInDefaultLocale()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/blogs");

		addLayout(_group.getGroupId(), false, friendlyURLMap);

		friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/home/blogs");

		addLayout(_group.getGroupId(), false, friendlyURLMap);

		friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/blogs/home");

		addLayout(_group.getGroupId(), false, friendlyURLMap);
	}

	@Test
	public void testValidFriendlyURLMapperURLInNonDefaultLocale()
		throws Exception {

		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.SPAIN, "/blogs/two");
		friendlyURLMap.put(LocaleUtil.US, "/two");

		addLayout(_group.getGroupId(), false, friendlyURLMap);
	}

	@Test
	public void testValidFriendlyURLStartingWithLanguageId() throws Exception {
		Map<Locale, String> friendlyURLMap = new HashMap<>();

		friendlyURLMap.put(LocaleUtil.US, "/eshome");

		addLayout(_group.getGroupId(), false, friendlyURLMap);
	}

	protected void addLayout(
			long groupId, boolean privateLayout,
			Map<Locale, String> friendlyURLMap)
		throws Exception {

		ServiceContext serviceContext =
			ServiceContextTestUtil.getServiceContext(groupId);

		LayoutLocalServiceUtil.addLayout(
			TestPropsValues.getUserId(), groupId, privateLayout,
			LayoutConstants.DEFAULT_PARENT_LAYOUT_ID,
			RandomTestUtil.randomLocaleStringMap(),
			RandomTestUtil.randomLocaleStringMap(),
			RandomTestUtil.randomLocaleStringMap(),
			RandomTestUtil.randomLocaleStringMap(),
			RandomTestUtil.randomLocaleStringMap(),
			LayoutConstants.TYPE_PORTLET, StringPool.BLANK, false,
			friendlyURLMap, serviceContext);
	}

	private Group _group;

	@DeleteAfterTestRun
	private final List<Group> _groups = new ArrayList<>();

}