DDMStructureManagerUtilTest.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.portlet.dynamicdatamapping;

import com.liferay.dynamic.data.mapping.kernel.DDMForm;
import com.liferay.dynamic.data.mapping.kernel.DDMFormField;
import com.liferay.dynamic.data.mapping.kernel.DDMFormFieldValue;
import com.liferay.dynamic.data.mapping.kernel.DDMFormValues;
import com.liferay.dynamic.data.mapping.kernel.DDMStructure;
import com.liferay.dynamic.data.mapping.kernel.DDMStructureManager;
import com.liferay.dynamic.data.mapping.kernel.DDMStructureManagerUtil;
import com.liferay.dynamic.data.mapping.kernel.LocalizedValue;
import com.liferay.dynamic.data.mapping.kernel.StorageEngineManager;
import com.liferay.dynamic.data.mapping.kernel.Value;
import com.liferay.portal.kernel.dao.orm.QueryUtil;
import com.liferay.portal.kernel.json.JSONArray;
import com.liferay.portal.kernel.model.Group;
import com.liferay.portal.kernel.search.Document;
import com.liferay.portal.kernel.search.DocumentImpl;
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.util.GroupTestUtil;
import com.liferay.portal.kernel.test.util.ServiceContextTestUtil;
import com.liferay.portal.kernel.test.util.TestPropsValues;
import com.liferay.portal.kernel.util.LocaleUtil;
import com.liferay.portal.kernel.util.PortalUtil;
import com.liferay.portal.kernel.util.StringUtil;
import com.liferay.portal.test.rule.LiferayIntegrationTestRule;

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;

/**
 * @author Leonardo Barros
 */
public class DDMStructureManagerUtilTest {

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

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

		_classNameId = PortalUtil.getClassNameId(
			"com.liferay.dynamic.data.lists.model.DDLRecordSet");

		_serviceContext = ServiceContextTestUtil.getServiceContext(
			_group.getGroupId(), TestPropsValues.getUserId());
	}

	@Test
	public void testAddAttributes() throws Exception {
		DDMStructure structure = addStructure();

		Document document = new DocumentImpl();

		DDMStructureManagerUtil.addAttributes(
			structure.getStructureId(), document, createDDMFormValues());

		String fieldProperty = structure.getFieldProperty(
			"fieldName", "indexType");

		Assert.assertNotNull(fieldProperty);
	}

	@Test
	public void testAddStructure() throws Exception {
		DDMStructure structure = addStructure();

		Assert.assertNotNull(structure);
	}

	@Test
	public void testDeleteStructure() throws Exception {
		DDMStructure structure = addStructure();

		Assert.assertNotNull(structure);

		DDMStructureManagerUtil.deleteStructure(structure.getStructureId());

		structure = DDMStructureManagerUtil.fetchStructure(
			structure.getGroupId(), structure.getClassNameId(),
			structure.getStructureKey());

		Assert.assertNull(structure);
	}

	@Test
	public void testExtractAttributes() throws Exception {
		DDMStructure structure = addStructure();

		Document document = new DocumentImpl();

		DDMFormValues ddmFormValues = createDDMFormValues();

		DDMStructureManagerUtil.addAttributes(
			structure.getStructureId(), document, ddmFormValues);

		String attributes = DDMStructureManagerUtil.extractAttributes(
			structure.getStructureId(), ddmFormValues, LocaleUtil.US);

		Assert.assertNotNull(attributes);
	}

	@Test
	public void testFetchStructure() throws Exception {
		DDMStructure expectedStructure = addStructure();

		DDMStructure actualStructure = DDMStructureManagerUtil.fetchStructure(
			_group.getGroupId(), expectedStructure.getClassNameId(),
			expectedStructure.getStructureKey());

		Assert.assertNotNull(actualStructure);

		assertEquals(expectedStructure, actualStructure);
	}

	@Test
	public void testFetchStructureByUuidAndGroupId() throws Exception {
		DDMStructure expectedStructure = addStructure();

		DDMStructure actualStructure =
			DDMStructureManagerUtil.fetchStructureByUuidAndGroupId(
				expectedStructure.getUuid(), expectedStructure.getGroupId());

		Assert.assertNotNull(actualStructure);

		assertEquals(expectedStructure, actualStructure);
	}

	@Test
	public void testGetClassStructures() throws Exception {
		List<DDMStructure> structures =
			DDMStructureManagerUtil.getClassStructures(
				_group.getCompanyId(), _classNameId, QueryUtil.ALL_POS,
				QueryUtil.ALL_POS);

		int initialSize = structures.size();

		addStructure();

		structures = DDMStructureManagerUtil.getClassStructures(
			_group.getCompanyId(), _classNameId, QueryUtil.ALL_POS,
			QueryUtil.ALL_POS);

		Assert.assertEquals(
			structures.toString(), initialSize + 1, structures.size());
	}

	@Test
	public void testGetClassStructuresUsingComparator() throws Exception {
		List<DDMStructure> structures =
			DDMStructureManagerUtil.getClassStructures(
				_group.getCompanyId(), _classNameId,
				DDMStructureManager.STRUCTURE_COMPARATOR_STRUCTURE_KEY);

		int initialSize = structures.size();

		addStructure();

		structures = DDMStructureManagerUtil.getClassStructures(
			_group.getCompanyId(), _classNameId,
			DDMStructureManager.STRUCTURE_COMPARATOR_STRUCTURE_KEY);

		Assert.assertEquals(
			structures.toString(), initialSize + 1, structures.size());
	}

	@Test
	public void testGetClassStructuresWithCompanyAndClassNameId()
		throws Exception {

		List<DDMStructure> structures =
			DDMStructureManagerUtil.getClassStructures(
				_group.getCompanyId(), _classNameId);

		int initialSize = structures.size();

		addStructure();

		structures = DDMStructureManagerUtil.getClassStructures(
			_group.getCompanyId(), _classNameId);

		Assert.assertEquals(
			structures.toString(), initialSize + 1, structures.size());
	}

	@Test
	public void testGetDDMFormFieldsJSONArray() throws Exception {
		DDMStructure structure = addStructure();

		JSONArray jsonArray = DDMStructureManagerUtil.getDDMFormFieldsJSONArray(
			structure.getStructureId(), structure.getDefinition());

		Assert.assertEquals(1, jsonArray.length());
	}

	@Test
	public void testGetStructure() throws Exception {
		DDMStructure expectedStructure = addStructure();

		DDMStructure actualStructure = DDMStructureManagerUtil.getStructure(
			_group.getGroupId(), expectedStructure.getClassNameId(),
			expectedStructure.getStructureKey());

		assertEquals(expectedStructure, actualStructure);
	}

	@Test
	public void testGetStructureById() throws Exception {
		DDMStructure expectedStructure = addStructure();

		DDMStructure actualStructure = DDMStructureManagerUtil.getStructure(
			expectedStructure.getStructureId());

		assertEquals(expectedStructure, actualStructure);
	}

	@Test
	public void testGetStructureByUuidAndGroupId() throws Exception {
		DDMStructure expectedStructure = addStructure();

		DDMStructure actualStructure =
			DDMStructureManagerUtil.getStructureByUuidAndGroupId(
				expectedStructure.getUuid(), _group.getGroupId());

		assertEquals(expectedStructure, actualStructure);
	}

	@Test
	public void testUpdateStructure() throws Exception {
		DDMStructure expectedStructure = addStructure();

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

		nameMap.put(LocaleUtil.US, "Structure Name Modified");

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

		descriptionMap.put(LocaleUtil.US, "Structure Description Modified");

		DDMStructure actualStructure = DDMStructureManagerUtil.updateStructure(
			TestPropsValues.getUserId(), expectedStructure.getStructureId(), 0,
			nameMap, descriptionMap, expectedStructure.getDDMForm(),
			_serviceContext);

		Assert.assertEquals(nameMap, actualStructure.getNameMap());
		Assert.assertEquals(
			descriptionMap, actualStructure.getDescriptionMap());
	}

	@Test
	public void testUpdateStructureDefinition() throws Exception {
		DDMStructure expectedStructure = addStructure();

		String definition = expectedStructure.getDefinition();

		definition = definition.replaceAll(
			"(?s)<dynamic-element[^>]*>.*?</dynamic-element>", "");

		DDMStructureManagerUtil.updateStructureDefinition(
			expectedStructure.getStructureId(), definition);

		DDMStructure structure = DDMStructureManagerUtil.getStructure(
			expectedStructure.getStructureId());

		Assert.assertEquals(definition, structure.getDefinition());
	}

	@Test
	public void testUpdateStructureKey() throws Exception {
		DDMStructure expectedStructure = addStructure();

		DDMStructureManagerUtil.updateStructureKey(
			expectedStructure.getStructureId(), "NEW_KEY");

		DDMStructure structure = DDMStructureManagerUtil.getStructure(
			expectedStructure.getStructureId());

		Assert.assertEquals("NEW_KEY", structure.getStructureKey());
	}

	protected DDMStructure addStructure() throws Exception {
		Map<Locale, String> nameMap = new HashMap<>();

		nameMap.put(LocaleUtil.US, "Test Structure Name");

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

		descriptionMap.put(LocaleUtil.US, "Test Structure Description");

		return DDMStructureManagerUtil.addStructure(
			TestPropsValues.getUserId(), _group.getGroupId(), null,
			_classNameId, StringUtil.randomString(), nameMap, descriptionMap,
			createDDMForm(), StorageEngineManager.STORAGE_TYPE_DEFAULT,
			DDMStructureManager.STRUCTURE_TYPE_DEFAULT, _serviceContext);
	}

	protected void assertEquals(
		DDMStructure expectedStructure, DDMStructure actualStructure) {

		Assert.assertEquals(
			expectedStructure.getStructureId(),
			actualStructure.getStructureId());
		Assert.assertEquals(
			expectedStructure.getGroupId(), actualStructure.getGroupId());
		Assert.assertEquals(
			expectedStructure.getCompanyId(), actualStructure.getCompanyId());
		Assert.assertEquals(
			expectedStructure.getClassNameId(),
			actualStructure.getClassNameId());
		Assert.assertEquals(
			expectedStructure.getStructureKey(),
			actualStructure.getStructureKey());
		Assert.assertEquals(
			expectedStructure.getNameMap(), actualStructure.getNameMap());
		Assert.assertEquals(
			expectedStructure.getDescriptionMap(),
			actualStructure.getDescriptionMap());
	}

	protected DDMForm createDDMForm() {
		DDMForm ddmForm = new DDMForm();

		ddmForm.setDefaultLocale(LocaleUtil.US);
		ddmForm.addAvailableLocale(LocaleUtil.US);

		DDMFormField ddmFormField = new DDMFormField("fieldName", "text");

		ddmForm.addDDMFormField(ddmFormField);

		return ddmForm;
	}

	protected DDMFormValues createDDMFormValues() {
		DDMFormValues ddmFormValues = new DDMFormValues(createDDMForm());

		ddmFormValues.addAvailableLocale(LocaleUtil.US);

		DDMFormFieldValue ddmFormFieldValue = new DDMFormFieldValue();

		ddmFormFieldValue.setName("fieldName");

		Value value = new LocalizedValue(LocaleUtil.US);

		value.addString(LocaleUtil.US, "name");

		ddmFormFieldValue.setValue(value);

		ddmFormValues.addDDMFormFieldValue(ddmFormFieldValue);

		return ddmFormValues;
	}

	private long _classNameId;

	@DeleteAfterTestRun
	private Group _group;

	private ServiceContext _serviceContext;

}