PortletDataHandlerExceptionTest.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.exportimport.test;

import com.liferay.arquillian.extension.junit.bridge.junit.Arquillian;
import com.liferay.exportimport.kernel.lar.BasePortletDataHandler;
import com.liferay.exportimport.kernel.lar.PortletDataContext;
import com.liferay.exportimport.kernel.lar.PortletDataException;
import com.liferay.exportimport.kernel.lar.PortletDataHandler;
import com.liferay.exportimport.test.util.ExportImportTestUtil;
import com.liferay.portal.kernel.test.rule.AggregateTestRule;
import com.liferay.portal.kernel.test.rule.Sync;
import com.liferay.portal.kernel.test.rule.SynchronousDestinationTestRule;
import com.liferay.portal.kernel.test.util.RandomTestUtil;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.test.rule.LiferayIntegrationTestRule;

import javax.portlet.PortletPreferences;

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

/**
 * @author Mate Thurzo
 */
@RunWith(Arquillian.class)
@Sync
public class PortletDataHandlerExceptionTest {

	@ClassRule
	@Rule
	public static final AggregateTestRule aggregateTestRule =
		new AggregateTestRule(
			new LiferayIntegrationTestRule(),
			SynchronousDestinationTestRule.INSTANCE);

	@BeforeClass
	public static void setUpClass() throws Exception {
		_portletDataContextExport =
			ExportImportTestUtil.getExportPortletDataContext();

		_portletDataContextExport.setPortletId(RandomTestUtil.randomString());

		_portletDataContextImport =
			ExportImportTestUtil.getImportPortletDataContext();
	}

	@Test
	public void testPortletDataHandlerDeleteException() throws Exception {
		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected PortletPreferences doDeleteData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences)
				throws Exception {

				throw new Exception();
			}

		};

		try {
			portletDataHandler.deleteData(
				_portletDataContextImport, RandomTestUtil.randomString(), null);
		}
		catch (Exception e) {
			_validateException(e, null);
		}
	}

	@Test
	public void testPortletDataHandlerDeleteExceptionMessage()
		throws Exception {

		final String message = RandomTestUtil.randomString();

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected PortletPreferences doDeleteData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences)
				throws Exception {

				throw new Exception(message);
			}

		};

		try {
			portletDataHandler.deleteData(
				_portletDataContextImport, RandomTestUtil.randomString(), null);
		}
		catch (Exception e) {
			_validateException(e, message);
		}
	}

	@Test
	public void testPortletDataHandlerDeletePortletDataException()
		throws Exception {

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected PortletPreferences doDeleteData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences)
				throws Exception {

				throw new PortletDataException();
			}

		};

		try {
			portletDataHandler.deleteData(
				_portletDataContextImport, RandomTestUtil.randomString(), null);
		}
		catch (Exception e) {
			_validateException(e, null);
		}
	}

	@Test
	public void testPortletDataHandlerDeletePortletDataExceptionMessage()
		throws Exception {

		final String message = RandomTestUtil.randomString();

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected PortletPreferences doDeleteData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences)
				throws Exception {

				throw new PortletDataException(message);
			}

		};

		try {
			portletDataHandler.deleteData(
				_portletDataContextImport, RandomTestUtil.randomString(), null);
		}
		catch (Exception e) {
			_validateException(e, message);
		}
	}

	@Test
	public void testPortletDataHandlerDeletePortletDataExceptionMessageType()
		throws Exception {

		final String message = RandomTestUtil.randomString();

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected PortletPreferences doDeleteData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences)
				throws Exception {

				PortletDataException pde = new PortletDataException(message);

				pde.setType(PortletDataException.INVALID_GROUP);

				throw pde;
			}

		};

		try {
			portletDataHandler.deleteData(
				_portletDataContextImport, RandomTestUtil.randomString(), null);
		}
		catch (Exception e) {
			_validateException(e, message);
		}
	}

	@Test
	public void testPortletDataHandlerDeletePortletDataExceptionType()
		throws Exception {

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected PortletPreferences doDeleteData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences)
				throws Exception {

				throw new PortletDataException(
					PortletDataException.INVALID_GROUP);
			}

		};

		try {
			portletDataHandler.deleteData(
				_portletDataContextImport, RandomTestUtil.randomString(), null);
		}
		catch (Exception e) {
			_validateException(e, null);
		}
	}

	@Test
	public void testPortletDataHandlerExportException() throws Exception {
		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected String doExportData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences)
				throws Exception {

				throw new Exception();
			}

		};

		try {
			portletDataHandler.exportData(
				_portletDataContextExport, RandomTestUtil.randomString(), null);
		}
		catch (Exception e) {
			_validateException(e, null);
		}
	}

	@Test
	public void testPortletDataHandlerExportExceptionMessage()
		throws Exception {

		final String message = RandomTestUtil.randomString();

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected String doExportData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences)
				throws Exception {

				throw new Exception(message);
			}

		};

		try {
			portletDataHandler.exportData(
				_portletDataContextExport, RandomTestUtil.randomString(), null);
		}
		catch (Exception e) {
			_validateException(e, message);
		}
	}

	@Test
	public void testPortletDataHandlerExportPortletDataException()
		throws Exception {

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected String doExportData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences)
				throws Exception {

				throw new PortletDataException();
			}

		};

		try {
			portletDataHandler.exportData(
				_portletDataContextExport, RandomTestUtil.randomString(), null);
		}
		catch (Exception e) {
			_validateException(e, null);
		}
	}

	@Test
	public void testPortletDataHandlerExportPortletDataExceptionMessage()
		throws Exception {

		final String message = RandomTestUtil.randomString();

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected String doExportData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences)
				throws Exception {

				throw new PortletDataException(message);
			}

		};

		try {
			portletDataHandler.exportData(
				_portletDataContextExport, RandomTestUtil.randomString(), null);
		}
		catch (Exception e) {
			_validateException(e, message);
		}
	}

	@Test
	public void testPortletDataHandlerExportPortletDataExceptionMessageType()
		throws Exception {

		final String message = RandomTestUtil.randomString();

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected String doExportData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences)
				throws Exception {

				PortletDataException pde = new PortletDataException(message);

				pde.setType(PortletDataException.INVALID_GROUP);

				throw pde;
			}

		};

		try {
			portletDataHandler.exportData(
				_portletDataContextExport, RandomTestUtil.randomString(), null);
		}
		catch (Exception e) {
			_validateException(e, message);
		}
	}

	@Test
	public void testPortletDataHandlerExportPortletDataExceptionType()
		throws Exception {

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected String doExportData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences)
				throws Exception {

				throw new PortletDataException(
					PortletDataException.INVALID_GROUP);
			}

		};

		try {
			portletDataHandler.exportData(
				_portletDataContextExport, RandomTestUtil.randomString(), null);
		}
		catch (Exception e) {
			_validateException(e, null);
		}
	}

	@Test
	public void testPortletDataHandlerImportException() throws Exception {
		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected PortletPreferences doImportData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences, String data)
				throws Exception {

				throw new Exception();
			}

		};

		try {
			portletDataHandler.importData(
				_portletDataContextImport, RandomTestUtil.randomString(), null,
				null);
		}
		catch (Exception e) {
			_validateException(e, null);
		}
	}

	@Test
	public void testPortletDataHandlerImportExceptionMessage()
		throws Exception {

		final String message = RandomTestUtil.randomString();

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected PortletPreferences doImportData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences, String data)
				throws Exception {

				throw new Exception(message);
			}

		};

		try {
			portletDataHandler.importData(
				_portletDataContextImport, RandomTestUtil.randomString(), null,
				null);
		}
		catch (Exception e) {
			_validateException(e, message);
		}
	}

	@Test
	public void testPortletDataHandlerImportPortletDataException()
		throws Exception {

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected PortletPreferences doImportData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences, String data)
				throws Exception {

				throw new PortletDataException();
			}

		};

		try {
			portletDataHandler.importData(
				_portletDataContextImport, RandomTestUtil.randomString(), null,
				null);
		}
		catch (Exception e) {
			_validateException(e, null);
		}
	}

	@Test
	public void testPortletDataHandlerImportPortletDataExceptionMessage()
		throws Exception {

		final String message = RandomTestUtil.randomString();

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected PortletPreferences doImportData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences, String data)
				throws Exception {

				throw new PortletDataException(message);
			}

		};

		try {
			portletDataHandler.importData(
				_portletDataContextImport, RandomTestUtil.randomString(), null,
				null);
		}
		catch (Exception e) {
			_validateException(e, message);
		}
	}

	@Test
	public void testPortletDataHandlerImportPortletDataExceptionMessageType()
		throws Exception {

		final String message = RandomTestUtil.randomString();

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected PortletPreferences doImportData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences, String data)
				throws Exception {

				PortletDataException pde = new PortletDataException(message);

				pde.setType(PortletDataException.INVALID_GROUP);

				throw pde;
			}

		};

		try {
			portletDataHandler.importData(
				_portletDataContextImport, RandomTestUtil.randomString(), null,
				null);
		}
		catch (Exception e) {
			_validateException(e, message);
		}
	}

	@Test
	public void testPortletDataHandlerImportPortletDataExceptionType()
		throws Exception {

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected PortletPreferences doImportData(
					PortletDataContext portletDataContext, String portletId,
					PortletPreferences portletPreferences, String data)
				throws Exception {

				throw new PortletDataException(
					PortletDataException.INVALID_GROUP);
			}

		};

		try {
			portletDataHandler.importData(
				_portletDataContextImport, RandomTestUtil.randomString(), null,
				null);
		}
		catch (Exception e) {
			_validateException(e, null);
		}
	}

	@Test
	public void testPortletDataHandlerPrepareManifestException()
		throws Exception {

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected void doPrepareManifestSummary(
					PortletDataContext portletDataContext,
					PortletPreferences portletPreferences)
				throws Exception {

				throw new Exception();
			}

		};

		try {
			portletDataHandler.prepareManifestSummary(
				_portletDataContextExport);
		}
		catch (Exception e) {
			_validateException(e, null);
		}
	}

	@Test
	public void testPortletDataHandlerPrepareManifestExceptionMessage()
		throws Exception {

		final String message = RandomTestUtil.randomString();

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected void doPrepareManifestSummary(
					PortletDataContext portletDataContext,
					PortletPreferences portletPreferences)
				throws Exception {

				throw new Exception(message);
			}

		};

		try {
			portletDataHandler.prepareManifestSummary(
				_portletDataContextExport);
		}
		catch (Exception e) {
			_validateException(e, message);
		}
	}

	@Test
	public void testPortletDataHandlerPrepareManifestPortletDataException()
		throws Exception {

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected void doPrepareManifestSummary(
					PortletDataContext portletDataContext,
					PortletPreferences portletPreferences)
				throws Exception {

				throw new PortletDataException();
			}

		};

		try {
			portletDataHandler.prepareManifestSummary(
				_portletDataContextExport);
		}
		catch (Exception e) {
			_validateException(e, null);
		}
	}

	@Test
	public void testPortletDataHandlerPrepareManifestPortletDataExceptionMessage()
		throws Exception {

		final String message = RandomTestUtil.randomString();

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected void doPrepareManifestSummary(
					PortletDataContext portletDataContext,
					PortletPreferences portletPreferences)
				throws Exception {

				throw new PortletDataException(message);
			}

		};

		try {
			portletDataHandler.prepareManifestSummary(
				_portletDataContextExport);
		}
		catch (Exception e) {
			_validateException(e, message);
		}
	}

	@Test
	public void testPortletDataHandlerPrepareManifestPortletDataExceptionMessageType()
		throws Exception {

		final String message = RandomTestUtil.randomString();

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected void doPrepareManifestSummary(
					PortletDataContext portletDataContext,
					PortletPreferences portletPreferences)
				throws Exception {

				PortletDataException pde = new PortletDataException(message);

				pde.setType(PortletDataException.INVALID_GROUP);

				throw pde;
			}

		};

		try {
			portletDataHandler.prepareManifestSummary(
				_portletDataContextExport);
		}
		catch (Exception e) {
			_validateException(e, message);
		}
	}

	@Test
	public void testPortletDataHandlerPrepareManifestPortletDataExceptionType()
		throws Exception {

		PortletDataHandler portletDataHandler = new TestPortletDataHandler() {

			@Override
			protected void doPrepareManifestSummary(
					PortletDataContext portletDataContext,
					PortletPreferences portletPreferences)
				throws Exception {

				throw new PortletDataException(
					PortletDataException.INVALID_GROUP);
			}

		};

		try {
			portletDataHandler.prepareManifestSummary(
				_portletDataContextExport);
		}
		catch (Exception e) {
			_validateException(e, null);
		}
	}

	private void _validateException(Exception e, String message) {

		// Ensure that thrown exceptions are an instance of PortletDataException

		Assert.assertTrue(
			"Exception thrown always have to be type of PortletDataException",
			e instanceof PortletDataException);

		PortletDataException pde = (PortletDataException)e;

		String portletId = pde.getPortletId();
		int type = pde.getType();

		// At this point, the portlet ID is mandatory

		Assert.assertFalse(
			"Exceptions coming from a PortletDataHandler has to have a " +
				"portletId attribute",
			Validator.isNull(portletId));

		// It should also have a type by now

		Assert.assertFalse(
			"Exception coming from a PortletDatahandler has to have a type " +
				"attribute",
			type == PortletDataException.DEFAULT);

		// If there was a message, validate that it has not disappeared

		Assert.assertEquals(message, pde.getMessage());
	}

	private static PortletDataContext _portletDataContextExport;
	private static PortletDataContext _portletDataContextImport;

	private class TestPortletDataHandler extends BasePortletDataHandler {
	}

}