Java tutorial
/** * 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.journal.transformer.test; import com.liferay.arquillian.extension.junit.bridge.junit.Arquillian; import com.liferay.dynamic.data.mapping.model.DDMForm; import com.liferay.dynamic.data.mapping.model.DDMStructure; import com.liferay.dynamic.data.mapping.model.DDMTemplate; import com.liferay.dynamic.data.mapping.test.util.DDMFormTestUtil; import com.liferay.dynamic.data.mapping.test.util.DDMStructureTestUtil; import com.liferay.dynamic.data.mapping.test.util.DDMTemplateTestUtil; import com.liferay.journal.model.JournalArticle; import com.liferay.journal.test.util.JournalTestUtil; import com.liferay.journal.transformer.RegexTransformerUtil; import com.liferay.journal.util.impl.JournalUtil; import com.liferay.portal.kernel.cache.CacheRegistryUtil; import com.liferay.portal.kernel.language.LanguageUtil; import com.liferay.portal.kernel.portlet.PortletRequestModel; import com.liferay.portal.kernel.service.ClassNameLocalServiceUtil; import com.liferay.portal.kernel.template.TemplateConstants; import com.liferay.portal.kernel.test.ReflectionTestUtil; import com.liferay.portal.kernel.test.rule.AggregateTestRule; import com.liferay.portal.kernel.test.rule.DeleteAfterTestRun; import com.liferay.portal.kernel.test.util.TestPropsUtil; import com.liferay.portal.kernel.test.util.TestPropsValues; import com.liferay.portal.kernel.util.Constants; import com.liferay.portal.kernel.util.LocaleUtil; import com.liferay.portal.kernel.util.PortalUtil; import com.liferay.portal.kernel.util.StringBundler; import com.liferay.portal.kernel.util.Validator; import com.liferay.portal.kernel.xml.Attribute; import com.liferay.portal.kernel.xml.Document; import com.liferay.portal.kernel.xml.Element; import com.liferay.portal.kernel.xml.UnsecureSAXReaderUtil; 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 java.util.regex.Pattern; 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 Marcellus Tavares */ @RunWith(Arquillian.class) public class JournalTransformerTest { @ClassRule @Rule public static final AggregateTestRule aggregateTestRule = new LiferayIntegrationTestRule(); @Before public void setUp() throws Exception { _ddmStructure = DDMStructureTestUtil.addStructure(JournalArticle.class.getName()); } @Test public void testContentTransformerListener() throws Exception { DDMForm ddmForm = new DDMForm(); ddmForm.addAvailableLocale(LocaleUtil.US); ddmForm.addDDMFormField(DDMFormTestUtil.createTextDDMFormField("link", false, false, false)); ddmForm.addDDMFormField(DDMFormTestUtil.createTextDDMFormField("name", false, false, false)); ddmForm.setDefaultLocale(LocaleUtil.US); _ddmStructure = DDMStructureTestUtil.addStructure(JournalArticle.class.getName(), ddmForm); String xsl = "$name.getData()"; _ddmTemplate = DDMTemplateTestUtil.addTemplate(_ddmStructure.getStructureId(), PortalUtil.getClassNameId(JournalArticle.class), TemplateConstants.LANG_TYPE_VM, xsl); String xml = DDMStructureTestUtil.getSampleStructuredContent("Joe Bloggs"); _article = JournalTestUtil.addArticleWithXMLContent(xml, _ddmStructure.getStructureKey(), _ddmTemplate.getTemplateKey()); Map<String, String> tokens = getTokens(); String content = JournalUtil.transform(null, tokens, Constants.VIEW, "en_US", UnsecureSAXReaderUtil.read(xml), null, xsl, TemplateConstants.LANG_TYPE_VM); Assert.assertEquals("Joe Bloggs", content); Document document = UnsecureSAXReaderUtil.read(xml); Element element = (Element) document.selectSingleNode("//dynamic-content"); element.setText("[@" + _article.getArticleId() + ";name@]"); content = JournalUtil.transform(null, tokens, Constants.VIEW, "en_US", document, null, xsl, TemplateConstants.LANG_TYPE_VM); Assert.assertEquals("Joe Bloggs", content); } @Test public void testFTLTransformation() throws Exception { Map<String, String> tokens = getTokens(); String xml = DDMStructureTestUtil.getSampleStructuredContent("name", "Joe Bloggs"); String script = "${name.getData()} - ${viewMode}"; String content = JournalUtil.transform(null, tokens, Constants.PRINT, "en_US", UnsecureSAXReaderUtil.read(xml), null, script, TemplateConstants.LANG_TYPE_FTL); Assert.assertEquals("Joe Bloggs - print", content); } @Test public void testLocaleTransformerListener() throws Exception { Map<String, String> tokens = getTokens(); Map<Locale, String> contents = new HashMap<>(); contents.put(LocaleUtil.BRAZIL, "Joao da Silva"); contents.put(LocaleUtil.US, "Joe Bloggs"); String xml = DDMStructureTestUtil.getSampleStructuredContent(contents, LanguageUtil.getLanguageId(LocaleUtil.US)); String script = "$name.getData()"; String content = JournalUtil.transform(null, tokens, Constants.VIEW, "en_US", UnsecureSAXReaderUtil.read(xml), null, script, TemplateConstants.LANG_TYPE_VM); Assert.assertEquals("Joe Bloggs", content); content = JournalUtil.transform(null, tokens, Constants.VIEW, "pt_BR", UnsecureSAXReaderUtil.read(xml), null, script, TemplateConstants.LANG_TYPE_VM); Assert.assertEquals("Joao da Silva", content); content = JournalUtil.transform(null, tokens, Constants.VIEW, "fr_CA", UnsecureSAXReaderUtil.read(xml), null, script, TemplateConstants.LANG_TYPE_VM); Assert.assertEquals("Joe Bloggs", content); } @Test public void testLocaleTransformerListenerNestedFieldWithNoTranslation() throws Exception { Map<String, String> tokens = getTokens(); Map<Locale, String> contents = new HashMap<>(); contents.put(LocaleUtil.US, "Joe Bloggs"); String xml = DDMStructureTestUtil.getSampleStructuredContent(contents, LanguageUtil.getLanguageId(LocaleUtil.US)); Document document = UnsecureSAXReaderUtil.read(xml); Element rootElement = document.getRootElement(); Attribute availableLocalesAttribute = rootElement.attribute("available-locales"); availableLocalesAttribute.setValue("en_US,pt_BR"); Element dynamicElement = (Element) document.selectSingleNode("//dynamic-element"); dynamicElement.addElement("nestedElement"); String script = "$name.getData()"; String content = JournalUtil.transform(null, tokens, Constants.VIEW, "en_US", document, null, script, TemplateConstants.LANG_TYPE_VM); Assert.assertEquals("Joe Bloggs", content); content = JournalUtil.transform(null, tokens, Constants.VIEW, "pt_BR", document, null, script, TemplateConstants.LANG_TYPE_VM); Assert.assertEquals("Joe Bloggs", content); } @Test public void testRegexTransformerListener() throws Exception { initRegexTransformerUtil(); Map<String, String> tokens = getTokens(); String xml = DDMStructureTestUtil.getSampleStructuredContent("name", "Joe Bloggs"); String script = "Hello $name.getData(), Welcome to beta.sample.com."; String content = JournalUtil.transform(null, tokens, Constants.VIEW, "en_US", UnsecureSAXReaderUtil.read(xml), null, script, TemplateConstants.LANG_TYPE_VM); Assert.assertEquals("Hello Joe Bloggs, Welcome to production.sample.com.", content); } @Test public void testTokensTransformerListener() throws Exception { Map<String, String> tokens = getTokens(); String xml = DDMStructureTestUtil.getSampleStructuredContent(); String script = "@company_id@"; String content = JournalUtil.transform(null, tokens, Constants.VIEW, "en_US", UnsecureSAXReaderUtil.read(xml), null, script, TemplateConstants.LANG_TYPE_VM); Assert.assertEquals(String.valueOf(TestPropsValues.getCompanyId()), content); script = "@@company_id@@"; content = JournalUtil.transform(null, tokens, Constants.VIEW, "en_US", UnsecureSAXReaderUtil.read(xml), null, script, TemplateConstants.LANG_TYPE_VM); Assert.assertEquals(String.valueOf(TestPropsValues.getCompanyId()), content); } @Test public void testViewCounterTransformerListener() throws Exception { Map<String, String> tokens = getTokens(); tokens.put("article_resource_pk", "1"); String xml = DDMStructureTestUtil.getSampleStructuredContent(); String script = "@view_counter@"; String content = JournalUtil.transform(null, tokens, Constants.VIEW, "en_US", UnsecureSAXReaderUtil.read(xml), null, script, TemplateConstants.LANG_TYPE_VM); StringBundler sb = new StringBundler(5); sb.append("<script type=\"text/javascript\">"); sb.append("Liferay.Service.Asset.AssetEntry.incrementViewCounter"); sb.append("({userId:0, className:'"); sb.append("com.liferay.journal.model.JournalArticle', classPK:1});"); sb.append("</script>"); Assert.assertEquals(sb.toString(), content); } @Test public void testVMTransformation() throws Exception { Map<String, String> tokens = getTokens(); _ddmStructure = DDMStructureTestUtil.addStructure(TestPropsValues.getGroupId(), JournalArticle.class.getName()); _ddmTemplate = DDMTemplateTestUtil.addTemplate(_ddmStructure.getStructureId(), PortalUtil.getClassNameId(JournalArticle.class), TemplateConstants.LANG_TYPE_VM, "$name.getData()"); String xml = DDMStructureTestUtil.getSampleStructuredContent("name", "Joe Bloggs"); String content = JournalUtil.transform(null, tokens, Constants.VIEW, "en_US", UnsecureSAXReaderUtil.read(xml), null, "#parse(\"$templatesPath/" + _ddmTemplate.getTemplateKey() + "\")", TemplateConstants.LANG_TYPE_VM); Assert.assertEquals("Joe Bloggs", content); content = JournalUtil.transform(null, tokens, Constants.VIEW, "en_US", UnsecureSAXReaderUtil.read(xml), null, "#parse(\"$journalTemplatesPath/" + _ddmTemplate.getTemplateKey() + "\")", TemplateConstants.LANG_TYPE_VM); Assert.assertEquals("Joe Bloggs", content); } protected Map<String, String> getTokens() throws Exception { Map<String, String> tokens = JournalUtil.getTokens(TestPropsValues.getGroupId(), (PortletRequestModel) null, null); tokens.put(TemplateConstants.CLASS_NAME_ID, String.valueOf(ClassNameLocalServiceUtil.getClassNameId(DDMStructure.class.getName()))); tokens.put("article_group_id", String.valueOf(TestPropsValues.getGroupId())); tokens.put("ddm_structure_id", String.valueOf(_ddmStructure.getStructureId())); tokens.put("company_id", String.valueOf(TestPropsValues.getCompanyId())); return tokens; } protected void initRegexTransformerUtil() { Object instance = ReflectionTestUtil.getFieldValue(RegexTransformerUtil.class, "_instance"); CacheRegistryUtil.setActive(true); List<Pattern> patterns = new ArrayList<>(); List<String> replacements = new ArrayList<>(); for (int i = 0; i < 100; i++) { String regex = TestPropsUtil.get("journal.transformer.regex.pattern." + i); String replacement = TestPropsUtil.get("journal.transformer.regex.replacement." + i); if (Validator.isNull(regex) || Validator.isNull(replacement)) { break; } patterns.add(Pattern.compile(regex)); replacements.add(replacement); } ReflectionTestUtil.setFieldValue(instance, "_patterns", patterns); ReflectionTestUtil.setFieldValue(instance, "_replacements", replacements); } @DeleteAfterTestRun private JournalArticle _article; @DeleteAfterTestRun private DDMStructure _ddmStructure; @DeleteAfterTestRun private DDMTemplate _ddmTemplate; }