DLFileEntryDDMFormValuesReaderTest.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.documentlibrary.asset;

import com.liferay.asset.kernel.model.DDMFormValuesReader;
import com.liferay.document.library.kernel.model.DLFileEntry;
import com.liferay.document.library.kernel.model.DLFileEntryType;
import com.liferay.document.library.kernel.model.DLFolderConstants;
import com.liferay.document.library.kernel.service.DLAppLocalServiceUtil;
import com.liferay.document.library.kernel.service.DLFileEntryLocalServiceUtil;
import com.liferay.document.library.kernel.service.DLFileEntryTypeLocalServiceUtil;
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.LocalizedValue;
import com.liferay.dynamic.data.mapping.kernel.UnlocalizedValue;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.model.Group;
import com.liferay.portal.kernel.model.User;
import com.liferay.portal.kernel.repository.model.FileEntry;
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.RandomTestUtil;
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.StringPool;
import com.liferay.portal.test.randomizerbumpers.TikaSafeRandomizerBumper;
import com.liferay.portal.test.rule.LiferayIntegrationTestRule;

import java.io.ByteArrayInputStream;

import java.util.HashMap;
import java.util.List;
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 Marcellus Tavares
 */
public class DLFileEntryDDMFormValuesReaderTest {

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

	@Before
	public void setUp() throws Exception {
		setUpGroup();
		setUpFileEntry();
	}

	@Test
	public void testGetDDMFormValues() throws Exception {
		DDMFormValuesReader ddmFormValuesReader =
			new DLFileEntryDDMFormValuesReader(
				_fileEntry, _fileEntry.getFileVersion());

		DDMFormValues expectedDDMFormValues = getExpectedDDMFormValues();

		Assert.assertEquals(
			expectedDDMFormValues, ddmFormValuesReader.getDDMFormValues());
	}

	protected DLFileEntryType addDLFileEntryType(ServiceContext serviceContext)
		throws Exception {

		return DLFileEntryTypeLocalServiceUtil.addFileEntryType(
			TestPropsValues.getUserId(), _group.getGroupId(),
			RandomTestUtil.randomString(), StringPool.BLANK, new long[0],
			serviceContext);
	}

	protected DLFileEntry addFileEntry() throws Exception {
		ServiceContext serviceContext = getServiceContext();

		DLFileEntryType dlFileEntryType = addDLFileEntryType(serviceContext);

		serviceContext.setAttribute(
			"fileEntryTypeId", dlFileEntryType.getFileEntryTypeId());

		List<DDMStructure> ddmStructures = dlFileEntryType.getDDMStructures();

		Map<String, DDMFormValues> ddmFormValuesMap = createDDMFormValuesMap(
			ddmStructures.get(0));

		ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(
			RandomTestUtil.randomBytes(TikaSafeRandomizerBumper.INSTANCE));

		return DLFileEntryLocalServiceUtil.addFileEntry(
			TestPropsValues.getUserId(), _group.getGroupId(),
			_group.getGroupId(), DLFolderConstants.DEFAULT_PARENT_FOLDER_ID,
			RandomTestUtil.randomString(), null, RandomTestUtil.randomString(),
			null, null, dlFileEntryType.getFileEntryTypeId(), ddmFormValuesMap,
			null, byteArrayInputStream, byteArrayInputStream.available(),
			serviceContext);
	}

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

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

		ddmForm.addDDMFormField(createTextDDMFormField("Text1"));
		ddmForm.addDDMFormField(createTextDDMFormField("Text2"));

		return ddmForm;
	}

	protected DDMFormFieldValue createDDMFormFieldValue(
		String instanceId, String name, String value) {

		DDMFormFieldValue ddmFormFieldValue = new DDMFormFieldValue();

		ddmFormFieldValue.setInstanceId(instanceId);
		ddmFormFieldValue.setName(name);
		ddmFormFieldValue.setValue(new UnlocalizedValue(value));

		return ddmFormFieldValue;
	}

	protected DDMFormValues createDDMFormValues(DDMForm ddmForm)
		throws Exception {

		DDMFormValues ddmFormValues = new DDMFormValues(ddmForm);

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

		ddmFormValues.addDDMFormFieldValue(
			createDDMFormFieldValue("baga", "Text1", "Text 1 Value"));
		ddmFormValues.addDDMFormFieldValue(
			createDDMFormFieldValue("hagt", "Text2", "Text 2 Value"));

		return ddmFormValues;
	}

	protected Map<String, DDMFormValues> createDDMFormValuesMap(
			DDMStructure ddmStructure)
		throws Exception {

		Map<String, DDMFormValues> ddmFormValuesMap = new HashMap<>();

		DDMForm ddmForm = createDDMForm();

		DDMFormValues ddmFormValues = createDDMFormValues(ddmForm);

		ddmFormValuesMap.put(ddmStructure.getStructureKey(), ddmFormValues);

		return ddmFormValuesMap;
	}

	protected DDMFormField createTextDDMFormField(String name) {
		DDMFormField ddmFormField = new DDMFormField(name, "text");

		ddmFormField.setDataType("string");

		LocalizedValue label = new LocalizedValue(LocaleUtil.US);

		label.addString(LocaleUtil.US, name);

		ddmFormField.setLabel(label);

		ddmFormField.setLocalizable(false);

		return ddmFormField;
	}

	protected DDMFormValues getExpectedDDMFormValues() throws Exception {
		return createDDMFormValues(null);
	}

	protected ServiceContext getServiceContext() throws Exception {
		ServiceContext serviceContext =
			ServiceContextTestUtil.getServiceContext(
				_group, TestPropsValues.getUserId());

		DDMForm ddmForm = createDDMForm();

		serviceContext.setAttribute("ddmForm", ddmForm);

		User user = TestPropsValues.getUser();

		serviceContext.setLanguageId(LocaleUtil.toLanguageId(user.getLocale()));

		return serviceContext;
	}

	protected void setUpFileEntry() throws Exception, PortalException {
		DLFileEntry dlFileEntry = addFileEntry();

		_fileEntry = DLAppLocalServiceUtil.getFileEntry(
			dlFileEntry.getFileEntryId());
	}

	protected void setUpGroup() throws Exception {
		_group = GroupTestUtil.addGroup();
	}

	private FileEntry _fileEntry;

	@DeleteAfterTestRun
	private Group _group;

}