http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/7d784b2b/src/test/java/org/apache/freemarker/core/SeldomEscapedOutputFormat.java ---------------------------------------------------------------------- diff --git a/src/test/java/org/apache/freemarker/core/SeldomEscapedOutputFormat.java b/src/test/java/org/apache/freemarker/core/SeldomEscapedOutputFormat.java new file mode 100644 index 0000000..1aa22cf --- /dev/null +++ b/src/test/java/org/apache/freemarker/core/SeldomEscapedOutputFormat.java @@ -0,0 +1,71 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.freemarker.core; + +import java.io.IOException; +import java.io.Writer; + +import org.apache.freemarker.core.CommonMarkupOutputFormat; +import org.apache.freemarker.core.model.TemplateModelException; + +public class SeldomEscapedOutputFormat extends CommonMarkupOutputFormat<TemplateSeldomEscapedOutputModel> { + + public static final SeldomEscapedOutputFormat INSTANCE = new SeldomEscapedOutputFormat(); + + private SeldomEscapedOutputFormat() { + // hide + } + + @Override + public String getName() { + return "seldomEscaped"; + } + + @Override + public String getMimeType() { + return "text/seldomEscaped"; + } + + @Override + public void output(String textToEsc, Writer out) throws IOException, TemplateModelException { + out.write(escapePlainText(textToEsc)); + } + + @Override + public String escapePlainText(String plainTextContent) { + return plainTextContent.replaceAll("(\\.|\\\\)", "\\\\$1"); + } + + @Override + public boolean isLegacyBuiltInBypassed(String builtInName) { + return false; + } + + @Override + public boolean isAutoEscapedByDefault() { + return false; + } + + @Override + protected TemplateSeldomEscapedOutputModel newTemplateMarkupOutputModel( + String plainTextContent, String markupContent) { + return new TemplateSeldomEscapedOutputModel(plainTextContent, markupContent); + } + +} \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/7d784b2b/src/test/java/org/apache/freemarker/core/SettingDirectiveTest.java ---------------------------------------------------------------------- diff --git a/src/test/java/org/apache/freemarker/core/SettingDirectiveTest.java b/src/test/java/org/apache/freemarker/core/SettingDirectiveTest.java new file mode 100644 index 0000000..8b4a957 --- /dev/null +++ b/src/test/java/org/apache/freemarker/core/SettingDirectiveTest.java @@ -0,0 +1,41 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.freemarker.core; + +import static org.hamcrest.Matchers.*; +import static org.junit.Assert.*; + +import org.apache.freemarker.core.ASTDirSetting; +import org.junit.Test; + +public class SettingDirectiveTest { + + @Test + public void testGetSettingNamesSorted() throws Exception { + String prevName = null; + for (String name : ASTDirSetting.SETTING_NAMES) { + if (prevName != null) { + assertThat(name, greaterThan(prevName)); + } + prevName = name; + } + } + +} http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/7d784b2b/src/test/java/org/apache/freemarker/core/SpecialVariableTest.java ---------------------------------------------------------------------- diff --git a/src/test/java/org/apache/freemarker/core/SpecialVariableTest.java b/src/test/java/org/apache/freemarker/core/SpecialVariableTest.java new file mode 100644 index 0000000..b657164 --- /dev/null +++ b/src/test/java/org/apache/freemarker/core/SpecialVariableTest.java @@ -0,0 +1,105 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.freemarker.core; + +import static org.hamcrest.Matchers.greaterThan; +import static org.junit.Assert.assertThat; + +import org.apache.freemarker.core.ASTExpBuiltInVariable; +import org.apache.freemarker.core.Configuration; +import org.apache.freemarker.core.HTMLOutputFormat; +import org.apache.freemarker.core.PlainTextOutputFormat; +import org.apache.freemarker.core.UndefinedOutputFormat; +import org.apache.freemarker.core.Version; +import org.apache.freemarker.test.TemplateTest; +import org.junit.Test; + +public class SpecialVariableTest extends TemplateTest { + + @Test + public void testNamesSorted() throws Exception { + String prevName = null; + for (String name : ASTExpBuiltInVariable.SPEC_VAR_NAMES) { + if (prevName != null) { + assertThat(name, greaterThan(prevName)); + } + prevName = name; + } + } + + @Test + public void testVersion() throws Exception { + String versionStr = Configuration.getVersion().toString(); + assertOutput("${.version}", versionStr); + } + + @Test + public void testIncompationImprovements() throws Exception { + assertOutput( + "${.incompatibleImprovements}", + getConfiguration().getIncompatibleImprovements().toString()); + + getConfiguration().setIncompatibleImprovements(new Version(3, 0, 0)); + assertOutput( + "${.incompatible_improvements}", + getConfiguration().getIncompatibleImprovements().toString()); + } + + @Test + public void testAutoEsc() throws Exception { + Configuration cfg = getConfiguration(); + + for (int autoEscaping : new int[] { + Configuration.ENABLE_IF_DEFAULT_AUTO_ESCAPING_POLICY, Configuration.ENABLE_IF_SUPPORTED_AUTO_ESCAPING_POLICY }) { + cfg.setAutoEscapingPolicy(autoEscaping); + cfg.setOutputFormat(HTMLOutputFormat.INSTANCE); + assertOutput("${.autoEsc?c}", "true"); + assertOutput("<#ftl autoEsc=false>${.autoEsc?c}", "false"); + cfg.setOutputFormat(PlainTextOutputFormat.INSTANCE); + assertOutput("${.autoEsc?c}", "false"); + cfg.setOutputFormat(UndefinedOutputFormat.INSTANCE); + assertOutput("${.autoEsc?c}", "false"); + } + + cfg.setAutoEscapingPolicy(Configuration.DISABLE_AUTO_ESCAPING_POLICY); + cfg.setOutputFormat(HTMLOutputFormat.INSTANCE); + assertOutput("${.autoEsc?c}", "false"); + assertOutput("<#ftl autoEsc=true>${.autoEsc?c}", "true"); + cfg.setOutputFormat(PlainTextOutputFormat.INSTANCE); + assertOutput("${.autoEsc?c}", "false"); + cfg.setOutputFormat(UndefinedOutputFormat.INSTANCE); + assertOutput("${.autoEsc?c}", "false"); + + cfg.setAutoEscapingPolicy(Configuration.ENABLE_IF_DEFAULT_AUTO_ESCAPING_POLICY); + assertOutput( + "${.autoEsc?c} " + + "<#outputFormat 'HTML'>${.autoEsc?c}</#outputFormat> " + + "<#outputFormat 'undefined'>${.autoEsc?c}</#outputFormat> " + + "<#outputFormat 'HTML'>" + + "${.autoEsc?c} <#noAutoEsc>${.autoEsc?c} " + + "<#autoEsc>${.autoEsc?c}</#autoEsc> ${.autoEsc?c}</#noAutoEsc> ${.autoEsc?c}" + + "</#outputFormat>", + "false true false " + + "true false true false true"); + + assertErrorContains("${.autoEscaping}", "You may meant: \"autoEsc\""); + } + +} http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/7d784b2b/src/test/java/org/apache/freemarker/core/StringLiteralInterpolationTest.java ---------------------------------------------------------------------- diff --git a/src/test/java/org/apache/freemarker/core/StringLiteralInterpolationTest.java b/src/test/java/org/apache/freemarker/core/StringLiteralInterpolationTest.java new file mode 100644 index 0000000..561cc2f --- /dev/null +++ b/src/test/java/org/apache/freemarker/core/StringLiteralInterpolationTest.java @@ -0,0 +1,133 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.freemarker.core; + +import java.io.IOException; +import java.util.Collections; + +import org.apache.freemarker.core.Configuration; +import org.apache.freemarker.core.InvalidReferenceException; +import org.apache.freemarker.core.RTFOutputFormat; +import org.apache.freemarker.core.TemplateException; +import org.apache.freemarker.test.TemplateTest; +import org.junit.Test; + +@SuppressWarnings("boxing") +public class StringLiteralInterpolationTest extends TemplateTest { + + @Test + public void basics() throws IOException, TemplateException { + addToDataModel("x", 1); + assertOutput("${'${x}'}", "1"); + assertOutput("${'#{x}'}", "1"); + assertOutput("${'a${x}b${x*2}c'}", "a1b2c"); + assertOutput("${'a#{x}b#{x*2}c'}", "a1b2c"); + assertOutput("${'a#{x; m2}'}", "a1.00"); + assertOutput("${'${x} ${x}'}", "1 1"); + assertOutput("${'$\\{x}'}", "${x}"); + assertOutput("${'$\\{x} $\\{x}'}", "${x} ${x}"); + assertOutput("${'<#-- not a comment -->${x}'}", "<#-- not a comment -->1"); + assertOutput("${'<#-- not a comment -->$\\{x}'}", "<#-- not a comment -->${x}"); + assertOutput("${'<#assign x = 2> ${x} <#assign x = 2>'}", "<#assign x = 2> 1 <#assign x = 2>"); + assertOutput("${'<#assign x = 2> $\\{x} <#assign x = 2>'}", "<#assign x = 2> ${x} <#assign x = 2>"); + assertOutput("${'<@x/>${x}<@x/>'}", "<@x/>1<@x/>"); + assertOutput("${'<@x/>$\\{x}<@x/>'}", "<@x/>${x}<@x/>"); + assertOutput("${'<@ ${x}<@'}", "<@ 1<@"); + assertOutput("${'<@ $\\{x}<@'}", "<@ ${x}<@"); + assertOutput("${'</@x>${x}'}", "</@x>1"); + assertOutput("${'</@x>$\\{x}'}", "</@x>${x}"); + assertOutput("${'</@ ${x}</@'}", "</@ 1</@"); + assertOutput("${'</@ $\\{x}</@'}", "</@ ${x}</@"); + assertOutput("${'[@ ${x}'}", "[@ 1"); + assertOutput("${'[@ $\\{x}'}", "[@ ${x}"); + } + + /** + * Broken behavior for backward compatibility. + */ + @Test + public void legacyEscapingBugStillPresent() throws IOException, TemplateException { + addToDataModel("x", 1); + assertOutput("${'$\\{x} ${x}'}", "1 1"); + assertOutput("${'${x} $\\{x}'}", "1 1"); + } + + @Test + public void legacyLengthGlitch() throws IOException, TemplateException { + assertOutput("${'${'}", "${"); + assertOutput("${'${1'}", "${1"); + assertOutput("${'${}'}", "${}"); + assertOutput("${'${1}'}", "1"); + assertErrorContains("${'${ '}", ""); + } + + @Test + public void testErrors() { + addToDataModel("x", 1); + assertErrorContains("${'${noSuchVar}'}", InvalidReferenceException.class, "missing", "noSuchVar"); + assertErrorContains("${'${x/0}'}", ArithmeticException.class, "zero"); + } + + @Test + public void escaping() throws IOException, TemplateException { + assertOutput("<#escape x as x?html><#assign x = '&'>${x} ${'${x}'}</#escape> ${x}", "& & &"); + } + + // We couldn't test this on 3.0.0, as nothing was fixed there with IcI yet + /*- + @Test + public void iciInheritanceBugFixed() throws Exception { + // Broken behavior emulated: + getConfiguration().setIncompatibleImprovements(Configuration.VERSION_2_3_23); + assertOutput("${'&\\''?html} ${\"${'&\\\\\\''?html}\"}", "&' &'"); + + // Fix enabled: + getConfiguration().setIncompatibleImprovements(Configuration.VERSION_2_3_24); + assertOutput("${'&\\''?html} ${\"${'&\\\\\\''?html}\"}", "&' &'"); + } + */ + + @Test + public void markup() throws IOException, TemplateException { + Configuration cfg = getConfiguration(); + cfg.setCustomNumberFormats(Collections.singletonMap("G", PrintfGTemplateNumberFormatFactory.INSTANCE)); + cfg.setNumberFormat("@G 3"); + + assertOutput("${\"${1000}\"}", "1.00*10<sup>3</sup>"); + assertOutput("${\"&_${1000}\"}", "&_1.00*10<sup>3</sup>"); + assertOutput("${\"${1000}_&\"}", "1.00*10<sup>3</sup>_&"); + assertOutput("${\"${1000}, ${2000}\"}", "1.00*10<sup>3</sup>, 2.00*10<sup>3</sup>"); + assertOutput("${\"& ${'x'}, ${2000}\"}", "& x, 2.00*10<sup>3</sup>"); + assertOutput("${\"& ${'x'}, #{2000}\"}", "& x, 2000"); + + assertOutput("${\"${2000}\"?isMarkupOutput?c}", "true"); + assertOutput("${\"x ${2000}\"?isMarkupOutput?c}", "true"); + assertOutput("${\"${2000} x\"?isMarkupOutput?c}", "true"); + assertOutput("${\"#{2000}\"?isMarkupOutput?c}", "false"); + assertOutput("${\"${'x'}\"?isMarkupOutput?c}", "false"); + assertOutput("${\"x ${'x'}\"?isMarkupOutput?c}", "false"); + assertOutput("${\"${'x'} x\"?isMarkupOutput?c}", "false"); + + addToDataModel("rtf", RTFOutputFormat.INSTANCE.fromMarkup("\\p")); + assertOutput("${\"${rtf}\"?isMarkupOutput?c}", "true"); + assertErrorContains("${\"${1000}${rtf}\"}", TemplateException.class, "HTML", "RTF", "onversion"); + assertErrorContains("x${\"${1000}${rtf}\"}", TemplateException.class, "HTML", "RTF", "onversion"); + } + +} http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/7d784b2b/src/test/java/org/apache/freemarker/core/TabSizeTest.java ---------------------------------------------------------------------- diff --git a/src/test/java/org/apache/freemarker/core/TabSizeTest.java b/src/test/java/org/apache/freemarker/core/TabSizeTest.java new file mode 100644 index 0000000..3f7accc --- /dev/null +++ b/src/test/java/org/apache/freemarker/core/TabSizeTest.java @@ -0,0 +1,97 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.freemarker.core; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.fail; + +import java.io.IOException; + +import org.apache.freemarker.core.Configuration; +import org.apache.freemarker.core.ParseException; +import org.apache.freemarker.core.Template; +import org.apache.freemarker.core.TemplateNotFoundException; +import org.apache.freemarker.core.templateresolver.MalformedTemplateNameException; +import org.apache.freemarker.test.TemplateTest; +import org.junit.Test; + +public class TabSizeTest extends TemplateTest { + + @Override + protected Configuration createConfiguration() throws Exception { + Configuration cfg = super.createConfiguration(); + return cfg; + } + + @Test + public void testBasics() throws Exception { + assertErrorColumnNumber(3, "${*}"); + assertErrorColumnNumber(8 + 3, "\t${*}"); + assertErrorColumnNumber(16 + 3, "\t\t${*}"); + assertErrorColumnNumber(16 + 3, " \t \t${*}"); + + getConfiguration().setTabSize(1); + assertErrorColumnNumber(3, "${*}"); + assertErrorColumnNumber(1 + 3, "\t${*}"); + assertErrorColumnNumber(2 + 3, "\t\t${*}"); + assertErrorColumnNumber(6 + 3, " \t \t${*}"); + } + + @Test + public void testEvalBI() throws Exception { + assertErrorContains("${r'\t~'?eval}", "column 9"); + getConfiguration().setTabSize(4); + assertErrorContains("${r'\t~'?eval}", "column 5"); + } + + @Test + public void testInterpretBI() throws Exception { + assertErrorContains("<@'\\t$\\{*}'?interpret />", "column 11"); + getConfiguration().setTabSize(4); + assertErrorContains("<@'\\t$\\{*}'?interpret />", "column 7"); + } + + @Test + public void testStringLiteralInterpolation() throws Exception { + assertErrorColumnNumber(6, "${'${*}'}"); + assertErrorColumnNumber(9, "${'${\t*}'}"); + getConfiguration().setTabSize(16); + assertErrorColumnNumber(17, "${'${\t*}'}"); + } + + protected void assertErrorColumnNumber(int expectedColumn, String templateSource) + throws TemplateNotFoundException, MalformedTemplateNameException, IOException { + addTemplate("t", templateSource); + try { + getConfiguration().getTemplate("t"); + fail(); + } catch (ParseException e) { + assertEquals(expectedColumn, e.getColumnNumber()); + } + getConfiguration().clearTemplateCache(); + + try { + new Template(null, templateSource, getConfiguration()); + fail(); + } catch (ParseException e) { + assertEquals(expectedColumn, e.getColumnNumber()); + } + } + +} http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/7d784b2b/src/test/java/org/apache/freemarker/core/TagSyntaxVariationsTest.java ---------------------------------------------------------------------- diff --git a/src/test/java/org/apache/freemarker/core/TagSyntaxVariationsTest.java b/src/test/java/org/apache/freemarker/core/TagSyntaxVariationsTest.java new file mode 100644 index 0000000..a995b51 --- /dev/null +++ b/src/test/java/org/apache/freemarker/core/TagSyntaxVariationsTest.java @@ -0,0 +1,181 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.freemarker.core; + +import java.io.IOException; +import java.io.StringReader; +import java.io.StringWriter; + +import org.apache.freemarker.core.Configuration; +import org.apache.freemarker.core.ParseException; +import org.apache.freemarker.core.Template; +import org.apache.freemarker.core.TemplateException; +import org.apache.freemarker.core.util._StringUtil; + +import junit.framework.TestCase; + +/** + * Test various generated templates (permutations), including some deliberately + * wrong ones, with various tag_syntax settings. + */ +public class TagSyntaxVariationsTest extends TestCase { + + private static final String HDR_ANG = "<#ftl>"; + private static final String HDR_SQU = squarify(HDR_ANG); + private static final String IF_ANG = "<#if true>i</#if>"; + private static final String IF_SQU = squarify(IF_ANG); + private static final String IF_OUT = "i"; + private static final String ASSIGN_ANG = "<#assign x = 1>a"; + private static final String ASSIGN_SQU = squarify(ASSIGN_ANG); + private static final String ASSIGN_OUT = "a"; + private static final String WRONG_ANG = "<#wrong>"; + private static final String WRONG_SQU = squarify(WRONG_ANG); + private static final String WRONGC_ANG = "</#wrong>"; + private static final String WRONGC_SQU = squarify(WRONGC_ANG ); + private static final String CUST_ANG = "<@compress> z </@>"; + private static final String CUST_SQU = squarify(CUST_ANG); + private static final String CUST_OUT = "z"; + + public TagSyntaxVariationsTest(String name) { + super(name); + } + + private static String squarify(String s) { + return s.replace('<', '[').replace('>', ']'); + } + + public final void test() + throws TemplateException, IOException { + Configuration cfg = new Configuration(Configuration.VERSION_3_0_0); + + // Permutations + for (int ifOrAssign = 0; ifOrAssign < 2; ifOrAssign++) { + String dir_ang = ifOrAssign == 0 ? IF_ANG : ASSIGN_ANG; + String dir_squ = ifOrAssign == 0 ? IF_SQU : ASSIGN_SQU; + String dir_out = ifOrAssign == 0 ? IF_OUT : ASSIGN_OUT; + + // Permutations + for (int angOrSqu = 0; angOrSqu < 2; angOrSqu++) { + cfg.setTagSyntax(angOrSqu == 0 + ? Configuration.ANGLE_BRACKET_TAG_SYNTAX + : Configuration.SQUARE_BRACKET_TAG_SYNTAX); + + String dir_xxx = angOrSqu == 0 ? dir_ang : dir_squ; + String cust_xxx = angOrSqu == 0 ? CUST_ANG : CUST_SQU; + String hdr_xxx = angOrSqu == 0 ? HDR_ANG : HDR_SQU; + String wrong_xxx = angOrSqu == 0 ? WRONG_ANG : WRONG_SQU; + String wrongc_xxx = angOrSqu == 0 ? WRONGC_ANG : WRONGC_SQU; + + test(cfg, + dir_xxx + cust_xxx, + dir_out + CUST_OUT); + + // Permutations + for (int wrongOrWrongc = 0; wrongOrWrongc < 2; wrongOrWrongc++) { + String wrongx_xxx = wrongOrWrongc == 0 ? wrong_xxx : wrongc_xxx; + + test(cfg, + wrongx_xxx + dir_xxx, + null); + + test(cfg, + dir_xxx + wrongx_xxx, + null); + + test(cfg, + hdr_xxx + wrongx_xxx, + null); + + test(cfg, + cust_xxx + wrongx_xxx + dir_xxx, + null); + } // for wrongc + } // for squ + + cfg.setTagSyntax(Configuration.AUTO_DETECT_TAG_SYNTAX); + for (int perm = 0; perm < 4; perm++) { + // All 4 permutations + String wrong_xxx = (perm & 1) == 0 ? WRONG_ANG : WRONG_SQU; + String dir_xxx = (perm & 2) == 0 ? dir_ang : dir_squ; + + test(cfg, + wrong_xxx + dir_xxx, + null); + } // for perm + + // Permutations + for (int angOrSquStart = 0; angOrSquStart < 2; angOrSquStart++) { + String hdr_xxx = angOrSquStart == 0 ? HDR_ANG : HDR_SQU; + String cust_xxx = angOrSquStart == 0 ? CUST_ANG : CUST_SQU; + String wrong_yyy = angOrSquStart != 0 ? WRONG_ANG : WRONG_SQU; + String dir_xxx = angOrSquStart == 0 ? dir_ang : dir_squ; + String dir_yyy = angOrSquStart != 0 ? dir_ang : dir_squ; + + test(cfg, + cust_xxx + wrong_yyy + dir_xxx, + CUST_OUT + wrong_yyy + dir_out); + + test(cfg, + hdr_xxx + wrong_yyy + dir_xxx, + wrong_yyy + dir_out); + + test(cfg, + cust_xxx + wrong_yyy + dir_yyy, + CUST_OUT + wrong_yyy + dir_yyy); + + test(cfg, + hdr_xxx + wrong_yyy + dir_yyy, + wrong_yyy + dir_yyy); + + test(cfg, + dir_xxx + wrong_yyy + dir_yyy, + dir_out + wrong_yyy + dir_yyy); + } // for squStart + + } // for assign + } + + /** + * @param expected the expected output or <tt>null</tt> if we expect + * a parsing error. + */ + private static final void test( + Configuration cfg, String template, String expected) + throws TemplateException, IOException { + Template t = null; + try { + t = new Template("string", new StringReader(template), cfg); + } catch (ParseException e) { + if (expected != null) { + fail("Couldn't create Template from " + + _StringUtil.jQuote(template) + ": " + e); + } else { + return; + } + } + if (expected == null) fail("Template parsing should have fail for " + + _StringUtil.jQuote(template)); + + StringWriter out = new StringWriter(); + t.process(new Object(), out); + assertEquals(expected, out.toString()); + } + +} http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/7d784b2b/src/test/java/org/apache/freemarker/core/TemplatGetEncodingTest.java ---------------------------------------------------------------------- diff --git a/src/test/java/org/apache/freemarker/core/TemplatGetEncodingTest.java b/src/test/java/org/apache/freemarker/core/TemplatGetEncodingTest.java new file mode 100644 index 0000000..384111d --- /dev/null +++ b/src/test/java/org/apache/freemarker/core/TemplatGetEncodingTest.java @@ -0,0 +1,89 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.freemarker.core; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotSame; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertSame; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; + +import org.apache.freemarker.core.Configuration; +import org.apache.freemarker.core.ParseException; +import org.apache.freemarker.core.Template; +import org.apache.freemarker.core.TemplateNotFoundException; +import org.apache.freemarker.core.templateresolver.MalformedTemplateNameException; +import org.apache.freemarker.core.templateresolver.impl.ByteArrayTemplateLoader; +import org.apache.freemarker.core.templateresolver.impl.StrongCacheStorage; +import org.junit.Test; + +public class TemplatGetEncodingTest { + + @Test + public void test() throws TemplateNotFoundException, MalformedTemplateNameException, ParseException, IOException { + Configuration cfg = new Configuration(Configuration.VERSION_3_0_0); + { + cfg.setDefaultEncoding("ISO-8859-2"); + ByteArrayTemplateLoader tl = new ByteArrayTemplateLoader(); + tl.putTemplate("t", "test".getBytes(StandardCharsets.UTF_8)); + tl.putTemplate("tnp", "<#test>".getBytes(StandardCharsets.UTF_8)); + cfg.setTemplateLoader(tl); + cfg.setCacheStorage(new StrongCacheStorage()); + } + + { + Template tDefEnc = cfg.getTemplate("t"); + assertEquals("ISO-8859-2", tDefEnc.getEncoding()); + assertSame(tDefEnc, cfg.getTemplate("t")); + + Template tDefEnc2 = cfg.getTemplate("t", (String) null); + assertEquals("ISO-8859-2", tDefEnc2.getEncoding()); + assertSame(tDefEnc, tDefEnc2); + + Template tUTF8 = cfg.getTemplate("t", "UTF-8"); + assertEquals("UTF-8", tUTF8.getEncoding()); + assertSame(tUTF8, cfg.getTemplate("t", "UTF-8")); + assertNotSame(tDefEnc, tUTF8); + } + + { + Template tDefEnc = cfg.getTemplate("tnp", null, null, false); + assertEquals("ISO-8859-2", tDefEnc.getEncoding()); + assertSame(tDefEnc, cfg.getTemplate("tnp", null, null, false)); + + Template tUTF8 = cfg.getTemplate("tnp", null, "UTF-8", false); + assertEquals("UTF-8", tUTF8.getEncoding()); + assertSame(tUTF8, cfg.getTemplate("tnp", null, "UTF-8", false)); + assertNotSame(tDefEnc, tUTF8); + } + + { + Template nonStoredT = new Template(null, "test", cfg); + assertNull(nonStoredT.getEncoding()); + } + + { + Template nonStoredT = Template.getPlainTextTemplate(null, "<#test>", cfg); + assertNull(nonStoredT.getEncoding()); + } + } + +} http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/7d784b2b/src/test/java/org/apache/freemarker/core/TemplateConfigurationTest.java ---------------------------------------------------------------------- diff --git a/src/test/java/org/apache/freemarker/core/TemplateConfigurationTest.java b/src/test/java/org/apache/freemarker/core/TemplateConfigurationTest.java new file mode 100644 index 0000000..abf637c --- /dev/null +++ b/src/test/java/org/apache/freemarker/core/TemplateConfigurationTest.java @@ -0,0 +1,940 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.freemarker.core; + +import static org.hamcrest.Matchers.containsString; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotEquals; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertThat; +import static org.junit.Assert.assertTrue; +import static org.junit.Assert.fail; + +import java.beans.BeanInfo; +import java.beans.IntrospectionException; +import java.beans.Introspector; +import java.beans.PropertyDescriptor; +import java.io.IOException; +import java.io.StringReader; +import java.io.StringWriter; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.util.ArrayList; +import java.util.Collections; +import java.util.Comparator; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Set; +import java.util.TimeZone; + +import org.apache.commons.collections.ListUtils; +import org.apache.freemarker.core.ArithmeticEngine; +import org.apache.freemarker.core.Configurable; +import org.apache.freemarker.core.Configuration; +import org.apache.freemarker.core.CustomAttribute; +import org.apache.freemarker.core.HTMLOutputFormat; +import org.apache.freemarker.core.ParseException; +import org.apache.freemarker.core.ParserConfiguration; +import org.apache.freemarker.core.Template; +import org.apache.freemarker.core.TemplateClassResolver; +import org.apache.freemarker.core.TemplateConfiguration; +import org.apache.freemarker.core.TemplateDateFormatFactory; +import org.apache.freemarker.core.TemplateException; +import org.apache.freemarker.core.TemplateExceptionHandler; +import org.apache.freemarker.core.TemplateNumberFormatFactory; +import org.apache.freemarker.core.UndefinedOutputFormat; +import org.apache.freemarker.core.Version; +import org.apache.freemarker.core.XMLOutputFormat; +import org.apache.freemarker.core.model.impl.SimpleObjectWrapper; +import org.apache.freemarker.core.templateresolver.impl.StringTemplateLoader; +import org.apache.freemarker.core.util._NullArgumentException; +import org.junit.Test; + +import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableMap; + +@SuppressWarnings("boxing") +public class TemplateConfigurationTest { + + private final class DummyArithmeticEngine extends ArithmeticEngine { + + @Override + public int compareNumbers(Number first, Number second) throws TemplateException { + return 0; + } + + @Override + public Number add(Number first, Number second) throws TemplateException { + return 22; + } + + @Override + public Number subtract(Number first, Number second) throws TemplateException { + return null; + } + + @Override + public Number multiply(Number first, Number second) throws TemplateException { + return 33; + } + + @Override + public Number divide(Number first, Number second) throws TemplateException { + return null; + } + + @Override + public Number modulus(Number first, Number second) throws TemplateException { + return null; + } + + @Override + public Number toNumber(String s) { + return 11; + } + } + + private static final Version ICI = Configuration.VERSION_3_0_0; + + private static final Configuration DEFAULT_CFG = new Configuration(ICI); + static { + StringTemplateLoader stl = new StringTemplateLoader(); + stl.putTemplate("t1.ftl", "<#global loaded = (loaded!) + 't1;'>In t1;"); + stl.putTemplate("t2.ftl", "<#global loaded = (loaded!) + 't2;'>In t2;"); + stl.putTemplate("t3.ftl", "<#global loaded = (loaded!) + 't3;'>In t3;"); + DEFAULT_CFG.setTemplateLoader(stl); + } + + private static final TimeZone NON_DEFAULT_TZ; + static { + TimeZone defaultTZ = DEFAULT_CFG.getTimeZone(); + TimeZone tz = TimeZone.getTimeZone("UTC"); + if (tz.equals(defaultTZ)) { + tz = TimeZone.getTimeZone("GMT+01"); + if (tz.equals(defaultTZ)) { + throw new AssertionError("Couldn't chose a non-default time zone"); + } + } + NON_DEFAULT_TZ = tz; + } + + private static final Locale NON_DEFAULT_LOCALE; + static { + Locale defaultLocale = DEFAULT_CFG.getLocale(); + Locale locale = Locale.GERMAN; + if (locale.equals(defaultLocale)) { + locale = Locale.US; + if (locale.equals(defaultLocale)) { + throw new AssertionError("Couldn't chose a non-default locale"); + } + } + NON_DEFAULT_LOCALE = locale; + } + + private static final String NON_DEFAULT_ENCODING; + + static { + String defaultEncoding = DEFAULT_CFG.getDefaultEncoding(); + String encoding = "UTF-16"; + if (encoding.equals(defaultEncoding)) { + encoding = "UTF-8"; + if (encoding.equals(defaultEncoding)) { + throw new AssertionError("Couldn't chose a non-default locale"); + } + } + NON_DEFAULT_ENCODING = encoding; + } + + private static final Map<String, Object> SETTING_ASSIGNMENTS; + + static { + SETTING_ASSIGNMENTS = new HashMap<>(); + + // "Configurable" settings: + SETTING_ASSIGNMENTS.put("APIBuiltinEnabled", true); + SETTING_ASSIGNMENTS.put("SQLDateAndTimeTimeZone", NON_DEFAULT_TZ); + SETTING_ASSIGNMENTS.put("URLEscapingCharset", "utf-16"); + SETTING_ASSIGNMENTS.put("autoFlush", false); + SETTING_ASSIGNMENTS.put("booleanFormat", "J,N"); + SETTING_ASSIGNMENTS.put("dateFormat", "yyyy-#DDD"); + SETTING_ASSIGNMENTS.put("dateTimeFormat", "yyyy-#DDD-@HH:mm"); + SETTING_ASSIGNMENTS.put("locale", NON_DEFAULT_LOCALE); + SETTING_ASSIGNMENTS.put("logTemplateExceptions", true); + SETTING_ASSIGNMENTS.put("newBuiltinClassResolver", TemplateClassResolver.ALLOWS_NOTHING_RESOLVER); + SETTING_ASSIGNMENTS.put("numberFormat", "0.0000"); + SETTING_ASSIGNMENTS.put("objectWrapper", new SimpleObjectWrapper(ICI)); + SETTING_ASSIGNMENTS.put("outputEncoding", "utf-16"); + SETTING_ASSIGNMENTS.put("showErrorTips", false); + SETTING_ASSIGNMENTS.put("templateExceptionHandler", TemplateExceptionHandler.IGNORE_HANDLER); + SETTING_ASSIGNMENTS.put("timeFormat", "@HH:mm"); + SETTING_ASSIGNMENTS.put("timeZone", NON_DEFAULT_TZ); + SETTING_ASSIGNMENTS.put("arithmeticEngine", ArithmeticEngine.CONSERVATIVE_ENGINE); + SETTING_ASSIGNMENTS.put("customNumberFormats", + ImmutableMap.of("dummy", HexTemplateNumberFormatFactory.INSTANCE)); + SETTING_ASSIGNMENTS.put("customDateFormats", + ImmutableMap.of("dummy", EpochMillisTemplateDateFormatFactory.INSTANCE)); + + // Parser-only settings: + SETTING_ASSIGNMENTS.put("tagSyntax", Configuration.SQUARE_BRACKET_TAG_SYNTAX); + SETTING_ASSIGNMENTS.put("namingConvention", Configuration.LEGACY_NAMING_CONVENTION); + SETTING_ASSIGNMENTS.put("whitespaceStripping", false); + SETTING_ASSIGNMENTS.put("strictSyntaxMode", false); + SETTING_ASSIGNMENTS.put("autoEscapingPolicy", Configuration.DISABLE_AUTO_ESCAPING_POLICY); + SETTING_ASSIGNMENTS.put("outputFormat", HTMLOutputFormat.INSTANCE); + SETTING_ASSIGNMENTS.put("recognizeStandardFileExtensions", false); + SETTING_ASSIGNMENTS.put("tabSize", 1); + SETTING_ASSIGNMENTS.put("lazyImports", Boolean.TRUE); + SETTING_ASSIGNMENTS.put("lazyAutoImports", Boolean.FALSE); + SETTING_ASSIGNMENTS.put("autoImports", ImmutableMap.of("a", "/lib/a.ftl")); + SETTING_ASSIGNMENTS.put("autoIncludes", ImmutableList.of("/lib/b.ftl")); + + // Special settings: + SETTING_ASSIGNMENTS.put("encoding", NON_DEFAULT_ENCODING); + } + + public static String getIsSetMethodName(String readMethodName) { + return (readMethodName.startsWith("get") ? "is" + readMethodName.substring(3) + : readMethodName) + + "Set"; + } + + public static List<PropertyDescriptor> getTemplateConfigurationSettingPropDescs( + boolean includeCompilerSettings, boolean includeSpecialSettings) + throws IntrospectionException { + List<PropertyDescriptor> settingPropDescs = new ArrayList<>(); + + BeanInfo beanInfo = Introspector.getBeanInfo(TemplateConfiguration.class); + for (PropertyDescriptor pd : beanInfo.getPropertyDescriptors()) { + String name = pd.getName(); + if (pd.getWriteMethod() != null && !IGNORED_PROP_NAMES.contains(name) + && (includeCompilerSettings + || (CONFIGURABLE_PROP_NAMES.contains(name) || !PARSER_PROP_NAMES.contains(name))) + && (includeSpecialSettings + || !SPECIAL_PROP_NAMES.contains(name))) { + if (pd.getReadMethod() == null) { + throw new AssertionError("Property has no read method: " + pd); + } + settingPropDescs.add(pd); + } + } + + Collections.sort(settingPropDescs, new Comparator<PropertyDescriptor>() { + + @Override + public int compare(PropertyDescriptor o1, PropertyDescriptor o2) { + return o1.getName().compareToIgnoreCase(o2.getName()); + } + }); + + return settingPropDescs; + } + + private static final Set<String> IGNORED_PROP_NAMES; + + static { + IGNORED_PROP_NAMES = new HashSet(); + IGNORED_PROP_NAMES.add("class"); + IGNORED_PROP_NAMES.add("strictBeanModels"); + IGNORED_PROP_NAMES.add("parentConfiguration"); + IGNORED_PROP_NAMES.add("settings"); + } + + private static final Set<String> CONFIGURABLE_PROP_NAMES; + static { + CONFIGURABLE_PROP_NAMES = new HashSet<>(); + try { + for (PropertyDescriptor propDesc : Introspector.getBeanInfo(Configurable.class).getPropertyDescriptors()) { + String propName = propDesc.getName(); + if (!IGNORED_PROP_NAMES.contains(propName)) { + CONFIGURABLE_PROP_NAMES.add(propName); + } + } + } catch (IntrospectionException e) { + throw new IllegalStateException("Failed to init static field", e); + } + } + + private static final Set<String> PARSER_PROP_NAMES; + static { + PARSER_PROP_NAMES = new HashSet<>(); + // It's an interface; can't use standard Inrospector + for (Method m : ParserConfiguration.class.getMethods()) { + String propertyName; + if (m.getName().startsWith("get")) { + propertyName = m.getName().substring(3); + } else if (m.getName().startsWith("is")) { + propertyName = m.getName().substring(2); + } else { + propertyName = null; + } + if (propertyName != null) { + if (!Character.isUpperCase(propertyName.charAt(1))) { + propertyName = Character.toLowerCase(propertyName.charAt(0)) + propertyName.substring(1); + } + PARSER_PROP_NAMES.add(propertyName); + } + } + } + + private static final Set<String> SPECIAL_PROP_NAMES; + static { + SPECIAL_PROP_NAMES = new HashSet<>(); + SPECIAL_PROP_NAMES.add("encoding"); + } + + private static final CustomAttribute CA1 = new CustomAttribute(CustomAttribute.SCOPE_TEMPLATE); + private static final CustomAttribute CA2 = new CustomAttribute(CustomAttribute.SCOPE_TEMPLATE); + private static final CustomAttribute CA3 = new CustomAttribute(CustomAttribute.SCOPE_TEMPLATE); + private static final CustomAttribute CA4 = new CustomAttribute(CustomAttribute.SCOPE_TEMPLATE); + + @Test + public void testMergeBasicFunctionality() throws Exception { + for (PropertyDescriptor propDesc1 : getTemplateConfigurationSettingPropDescs(true, true)) { + for (PropertyDescriptor propDesc2 : getTemplateConfigurationSettingPropDescs(true, true)) { + TemplateConfiguration tc1 = new TemplateConfiguration(); + TemplateConfiguration tc2 = new TemplateConfiguration(); + + Object value1 = SETTING_ASSIGNMENTS.get(propDesc1.getName()); + propDesc1.getWriteMethod().invoke(tc1, value1); + Object value2 = SETTING_ASSIGNMENTS.get(propDesc2.getName()); + propDesc2.getWriteMethod().invoke(tc2, value2); + + tc1.merge(tc2); + if (propDesc1.getName().equals(propDesc2.getName()) && value1 instanceof List + && !propDesc1.getName().equals("autoIncludes")) { + assertEquals("For " + propDesc1.getName(), + ListUtils.union((List) value1, (List) value1), propDesc1.getReadMethod().invoke(tc1)); + } else { // Values of the same setting merged + assertEquals("For " + propDesc1.getName(), value1, propDesc1.getReadMethod().invoke(tc1)); + assertEquals("For " + propDesc2.getName(), value2, propDesc2.getReadMethod().invoke(tc1)); + } + } + } + } + + @Test + public void testMergeMapSettings() throws Exception { + TemplateConfiguration tc1 = new TemplateConfiguration(); + tc1.setCustomDateFormats(ImmutableMap.of( + "epoch", EpochMillisTemplateDateFormatFactory.INSTANCE, + "x", LocAndTZSensitiveTemplateDateFormatFactory.INSTANCE)); + tc1.setCustomNumberFormats(ImmutableMap.of( + "hex", HexTemplateNumberFormatFactory.INSTANCE, + "x", LocaleSensitiveTemplateNumberFormatFactory.INSTANCE)); + tc1.setAutoImports(ImmutableMap.of("a", "a1.ftl", "b", "b1.ftl")); + + TemplateConfiguration tc2 = new TemplateConfiguration(); + tc2.setCustomDateFormats(ImmutableMap.of( + "loc", LocAndTZSensitiveTemplateDateFormatFactory.INSTANCE, + "x", EpochMillisDivTemplateDateFormatFactory.INSTANCE)); + tc2.setCustomNumberFormats(ImmutableMap.of( + "loc", LocaleSensitiveTemplateNumberFormatFactory.INSTANCE, + "x", BaseNTemplateNumberFormatFactory.INSTANCE)); + tc2.setAutoImports(ImmutableMap.of("b", "b2.ftl", "c", "c2.ftl")); + + tc1.merge(tc2); + + Map<String, ? extends TemplateDateFormatFactory> mergedCustomDateFormats = tc1.getCustomDateFormats(); + assertEquals(EpochMillisTemplateDateFormatFactory.INSTANCE, mergedCustomDateFormats.get("epoch")); + assertEquals(LocAndTZSensitiveTemplateDateFormatFactory.INSTANCE, mergedCustomDateFormats.get("loc")); + assertEquals(EpochMillisDivTemplateDateFormatFactory.INSTANCE, mergedCustomDateFormats.get("x")); + + Map<String, ? extends TemplateNumberFormatFactory> mergedCustomNumberFormats = tc1.getCustomNumberFormats(); + assertEquals(HexTemplateNumberFormatFactory.INSTANCE, mergedCustomNumberFormats.get("hex")); + assertEquals(LocaleSensitiveTemplateNumberFormatFactory.INSTANCE, mergedCustomNumberFormats.get("loc")); + assertEquals(BaseNTemplateNumberFormatFactory.INSTANCE, mergedCustomNumberFormats.get("x")); + + Map<String, String> mergedAutoImports = tc1.getAutoImports(); + assertEquals("a1.ftl", mergedAutoImports.get("a")); + assertEquals("b2.ftl", mergedAutoImports.get("b")); + assertEquals("c2.ftl", mergedAutoImports.get("c")); + + // Empty map merging optimization: + tc1.merge(new TemplateConfiguration()); + assertSame(mergedCustomDateFormats, tc1.getCustomDateFormats()); + assertSame(mergedCustomNumberFormats, tc1.getCustomNumberFormats()); + + // Empty map merging optimization: + TemplateConfiguration tc3 = new TemplateConfiguration(); + tc3.merge(tc1); + assertSame(mergedCustomDateFormats, tc3.getCustomDateFormats()); + assertSame(mergedCustomNumberFormats, tc3.getCustomNumberFormats()); + } + + @Test + public void testMergeListSettings() throws Exception { + TemplateConfiguration tc1 = new TemplateConfiguration(); + tc1.setAutoIncludes(ImmutableList.of("a.ftl", "x.ftl", "b.ftl")); + + TemplateConfiguration tc2 = new TemplateConfiguration(); + tc2.setAutoIncludes(ImmutableList.of("c.ftl", "x.ftl", "d.ftl")); + + tc1.merge(tc2); + + assertEquals(ImmutableList.of("a.ftl", "b.ftl", "c.ftl", "x.ftl", "d.ftl"), tc1.getAutoIncludes()); + } + + @Test + public void testMergePriority() throws Exception { + TemplateConfiguration tc1 = new TemplateConfiguration(); + tc1.setDateFormat("1"); + tc1.setTimeFormat("1"); + tc1.setDateTimeFormat("1"); + + TemplateConfiguration tc2 = new TemplateConfiguration(); + tc2.setDateFormat("2"); + tc2.setTimeFormat("2"); + + TemplateConfiguration tc3 = new TemplateConfiguration(); + tc3.setDateFormat("3"); + + tc1.merge(tc2); + tc1.merge(tc3); + + assertEquals("3", tc1.getDateFormat()); + assertEquals("2", tc1.getTimeFormat()); + assertEquals("1", tc1.getDateTimeFormat()); + } + + @Test + public void testMergeCustomAttributes() throws Exception { + TemplateConfiguration tc1 = new TemplateConfiguration(); + tc1.setCustomAttribute("k1", "v1"); + tc1.setCustomAttribute("k2", "v1"); + tc1.setCustomAttribute("k3", "v1"); + CA1.set("V1", tc1); + CA2.set("V1", tc1); + CA3.set("V1", tc1); + + TemplateConfiguration tc2 = new TemplateConfiguration(); + tc2.setCustomAttribute("k1", "v2"); + tc2.setCustomAttribute("k2", "v2"); + CA1.set("V2", tc2); + CA2.set("V2", tc2); + + TemplateConfiguration tc3 = new TemplateConfiguration(); + tc3.setCustomAttribute("k1", "v3"); + CA1.set("V3", tc2); + + tc1.merge(tc2); + tc1.merge(tc3); + + assertEquals("v3", tc1.getCustomAttribute("k1")); + assertEquals("v2", tc1.getCustomAttribute("k2")); + assertEquals("v1", tc1.getCustomAttribute("k3")); + assertEquals("V3", CA1.get(tc1)); + assertEquals("V2", CA2.get(tc1)); + assertEquals("V1", CA3.get(tc1)); + } + + @Test + public void testMergeNullCustomAttributes() throws Exception { + TemplateConfiguration tc1 = new TemplateConfiguration(); + tc1.setCustomAttribute("k1", "v1"); + tc1.setCustomAttribute("k2", "v1"); + tc1.setCustomAttribute(null, "v1"); + CA1.set("V1", tc1); + CA2.set("V1", tc1); + CA3.set(null, tc1); + + assertEquals("v1", tc1.getCustomAttribute("k1")); + assertEquals("v1", tc1.getCustomAttribute("k2")); + assertNull("v1", tc1.getCustomAttribute("k3")); + assertEquals("V1", CA1.get(tc1)); + assertEquals("V1", CA2.get(tc1)); + assertNull(CA3.get(tc1)); + + TemplateConfiguration tc2 = new TemplateConfiguration(); + tc2.setCustomAttribute("k1", "v2"); + tc2.setCustomAttribute("k2", null); + CA1.set("V2", tc2); + CA2.set(null, tc2); + + TemplateConfiguration tc3 = new TemplateConfiguration(); + tc3.setCustomAttribute("k1", null); + CA1.set(null, tc2); + + tc1.merge(tc2); + tc1.merge(tc3); + + assertNull(tc1.getCustomAttribute("k1")); + assertNull(tc1.getCustomAttribute("k2")); + assertNull(tc1.getCustomAttribute("k3")); + assertNull(CA1.get(tc1)); + assertNull(CA2.get(tc1)); + assertNull(CA3.get(tc1)); + + TemplateConfiguration tc4 = new TemplateConfiguration(); + tc4.setCustomAttribute("k1", "v4"); + CA1.set("V4", tc4); + + tc1.merge(tc4); + + assertEquals("v4", tc1.getCustomAttribute("k1")); + assertNull(tc1.getCustomAttribute("k2")); + assertNull(tc1.getCustomAttribute("k3")); + assertEquals("V4", CA1.get(tc1)); + assertNull(CA2.get(tc1)); + assertNull(CA3.get(tc1)); + } + + @Test + public void applyOrder() throws Exception { + Configuration cfg = new Configuration(Configuration.VERSION_3_0_0); + Template t = new Template(null, "", cfg); + + { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setParentConfiguration(cfg); + tc.setBooleanFormat("Y,N"); + tc.setAutoImports(ImmutableMap.of("a", "a.ftl", "b", "b.ftl", "c", "c.ftl")); + tc.setAutoIncludes(ImmutableList.of("i1.ftl", "i2.ftl", "i3.ftl")); + tc.setCustomNumberFormats(ImmutableMap.of( + "a", HexTemplateNumberFormatFactory.INSTANCE, + "b", LocaleSensitiveTemplateNumberFormatFactory.INSTANCE)); + + tc.apply(t); + } + assertEquals("Y,N", t.getBooleanFormat()); + assertEquals(ImmutableMap.of("a", "a.ftl", "b", "b.ftl", "c", "c.ftl"), t.getAutoImports()); + assertEquals(ImmutableList.of("a", "b", "c"), new ArrayList<>(t.getAutoImports().keySet())); + assertEquals(ImmutableList.of("i1.ftl", "i2.ftl", "i3.ftl"), t.getAutoIncludes()); + + { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setParentConfiguration(cfg); + tc.setBooleanFormat("J,N"); + tc.setAutoImports(ImmutableMap.of("b", "b2.ftl", "d", "d.ftl")); + tc.setAutoIncludes(ImmutableList.of("i2.ftl", "i4.ftl")); + tc.setCustomNumberFormats(ImmutableMap.of( + "b", BaseNTemplateNumberFormatFactory.INSTANCE, + "c", BaseNTemplateNumberFormatFactory.INSTANCE)); + + tc.apply(t); + } + assertEquals("Y,N", t.getBooleanFormat()); + assertEquals(ImmutableMap.of("d", "d.ftl", "a", "a.ftl", "b", "b.ftl", "c", "c.ftl"), t.getAutoImports()); + assertEquals(ImmutableList.of("d", "a", "b", "c"), new ArrayList<>(t.getAutoImports().keySet())); + assertEquals(ImmutableList.of("i4.ftl", "i1.ftl", "i2.ftl", "i3.ftl"), t.getAutoIncludes()); + assertEquals(ImmutableMap.of( // + "b", LocaleSensitiveTemplateNumberFormatFactory.INSTANCE, // + "c", BaseNTemplateNumberFormatFactory.INSTANCE, // + "a", HexTemplateNumberFormatFactory.INSTANCE), // + t.getCustomNumberFormats()); + } + + @Test + public void testConfigureNonParserConfig() throws Exception { + for (PropertyDescriptor pd : getTemplateConfigurationSettingPropDescs(false, true)) { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setParentConfiguration(DEFAULT_CFG); + + Object newValue = SETTING_ASSIGNMENTS.get(pd.getName()); + pd.getWriteMethod().invoke(tc, newValue); + + Template t = new Template(null, "", DEFAULT_CFG); + Method tReaderMethod = t.getClass().getMethod(pd.getReadMethod().getName()); + + assertNotEquals("For \"" + pd.getName() + "\"", newValue, tReaderMethod.invoke(t)); + tc.apply(t); + assertEquals("For \"" + pd.getName() + "\"", newValue, tReaderMethod.invoke(t)); + } + } + + @Test + public void testConfigureCustomAttributes() throws Exception { + Configuration cfg = new Configuration(Configuration.VERSION_3_0_0); + cfg.setCustomAttribute("k1", "c"); + cfg.setCustomAttribute("k2", "c"); + cfg.setCustomAttribute("k3", "c"); + + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setCustomAttribute("k2", "tc"); + tc.setCustomAttribute("k3", null); + tc.setCustomAttribute("k4", "tc"); + tc.setCustomAttribute("k5", "tc"); + tc.setCustomAttribute("k6", "tc"); + CA1.set("tc", tc); + CA2.set("tc", tc); + CA3.set("tc", tc); + + Template t = new Template(null, "", cfg); + t.setCustomAttribute("k5", "t"); + t.setCustomAttribute("k6", null); + t.setCustomAttribute("k7", "t"); + CA2.set("t", t); + CA3.set(null, t); + CA4.set("t", t); + + tc.setParentConfiguration(cfg); + tc.apply(t); + + assertEquals("c", t.getCustomAttribute("k1")); + assertEquals("tc", t.getCustomAttribute("k2")); + assertNull(t.getCustomAttribute("k3")); + assertEquals("tc", t.getCustomAttribute("k4")); + assertEquals("t", t.getCustomAttribute("k5")); + assertNull(t.getCustomAttribute("k6")); + assertEquals("t", t.getCustomAttribute("k7")); + assertEquals("tc", CA1.get(t)); + assertEquals("t", CA2.get(t)); + assertNull(CA3.get(t)); + assertEquals("t", CA4.get(t)); + } + + @Test + public void testConfigureParser() throws Exception { + Set<String> testedProps = new HashSet<>(); + + { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setParentConfiguration(DEFAULT_CFG); + tc.setTagSyntax(Configuration.SQUARE_BRACKET_TAG_SYNTAX); + assertOutputWithoutAndWithTC(tc, "[#if true]y[/#if]", "[#if true]y[/#if]", "y"); + testedProps.add(Configuration.TAG_SYNTAX_KEY_CAMEL_CASE); + } + + { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setParentConfiguration(DEFAULT_CFG); + tc.setNamingConvention(Configuration.CAMEL_CASE_NAMING_CONVENTION); + assertOutputWithoutAndWithTC(tc, "<#if true>y<#elseif false>n</#if>", "y", null); + testedProps.add(Configuration.NAMING_CONVENTION_KEY_CAMEL_CASE); + } + + { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setParentConfiguration(DEFAULT_CFG); + tc.setWhitespaceStripping(false); + assertOutputWithoutAndWithTC(tc, "<#if true>\nx\n</#if>\n", "x\n", "\nx\n\n"); + testedProps.add(Configuration.WHITESPACE_STRIPPING_KEY_CAMEL_CASE); + } + + { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setParentConfiguration(DEFAULT_CFG); + tc.setArithmeticEngine(new DummyArithmeticEngine()); + assertOutputWithoutAndWithTC(tc, "${1} ${1+1}", "1 2", "11 22"); + testedProps.add(Configuration.ARITHMETIC_ENGINE_KEY_CAMEL_CASE); + } + + { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setParentConfiguration(DEFAULT_CFG); + tc.setOutputFormat(XMLOutputFormat.INSTANCE); + assertOutputWithoutAndWithTC(tc, "${.outputFormat} ${\"a'b\"}", + UndefinedOutputFormat.INSTANCE.getName() + " a'b", + XMLOutputFormat.INSTANCE.getName() + " a'b"); + testedProps.add(Configuration.OUTPUT_FORMAT_KEY_CAMEL_CASE); + } + + { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setParentConfiguration(DEFAULT_CFG); + tc.setOutputFormat(XMLOutputFormat.INSTANCE); + tc.setAutoEscapingPolicy(Configuration.DISABLE_AUTO_ESCAPING_POLICY); + assertOutputWithoutAndWithTC(tc, "${'a&b'}", "a&b", "a&b"); + testedProps.add(Configuration.AUTO_ESCAPING_POLICY_KEY_CAMEL_CASE); + } + + { + TemplateConfiguration tc = new TemplateConfiguration(); + /* Can't test this now, as the only valid value is 3.0.0. [FM3.0.1] + tc.setParentConfiguration(new Configuration(new Version(2, 3, 0))); + assertOutputWithoutAndWithTC(tc, "<#foo>", null, "<#foo>"); + */ + testedProps.add(Configuration.INCOMPATIBLE_IMPROVEMENTS_KEY_CAMEL_CASE); + } + + { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setParentConfiguration(DEFAULT_CFG); + tc.setRecognizeStandardFileExtensions(false); + assertOutputWithoutAndWithTC(tc, "adhoc.ftlh", "${.outputFormat}", + HTMLOutputFormat.INSTANCE.getName(), UndefinedOutputFormat.INSTANCE.getName()); + testedProps.add(Configuration.RECOGNIZE_STANDARD_FILE_EXTENSIONS_KEY_CAMEL_CASE); + } + + { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setLogTemplateExceptions(false); + tc.setParentConfiguration(DEFAULT_CFG); + tc.setTabSize(3); + assertOutputWithoutAndWithTC(tc, + "<#attempt><@'\\t$\\{1+}'?interpret/><#recover>" + + "${.error?replace('(?s).*?column ([0-9]+).*', '$1', 'r')}" + + "</#attempt>", + "13", "8"); + testedProps.add(Configuration.TAB_SIZE_KEY_CAMEL_CASE); + } + + assertEquals("Check that you have tested all parser settings; ", PARSER_PROP_NAMES, testedProps); + } + + @Test + public void testArithmeticEngine() throws TemplateException, IOException { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setParentConfiguration(DEFAULT_CFG); + tc.setArithmeticEngine(new DummyArithmeticEngine()); + assertOutputWithoutAndWithTC(tc, + "<#setting locale='en_US'>${1} ${1+1} ${1*3} <#assign x = 1>${x + x} ${x * 3}", + "1 2 3 2 3", "11 22 33 22 33"); + + // Doesn't affect template.arithmeticEngine, only affects the parsing: + Template t = new Template(null, null, new StringReader(""), DEFAULT_CFG, tc, null); + assertEquals(DEFAULT_CFG.getArithmeticEngine(), t.getArithmeticEngine()); + } + + @Test + public void testAutoImport() throws TemplateException, IOException { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setAutoImports(ImmutableMap.of("t1", "t1.ftl", "t2", "t2.ftl")); + tc.setParent(DEFAULT_CFG); + assertOutputWithoutAndWithTC(tc, "<#import 't3.ftl' as t3>${loaded}", "t3;", "t1;t2;t3;"); + } + + @Test + public void testAutoIncludes() throws TemplateException, IOException { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setAutoIncludes(ImmutableList.of("t1.ftl", "t2.ftl")); + tc.setParent(DEFAULT_CFG); + assertOutputWithoutAndWithTC(tc, "<#include 't3.ftl'>", "In t3;", "In t1;In t2;In t3;"); + } + + @Test + public void testStringInterpolate() throws TemplateException, IOException { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setParentConfiguration(DEFAULT_CFG); + tc.setArithmeticEngine(new DummyArithmeticEngine()); + assertOutputWithoutAndWithTC(tc, + "<#setting locale='en_US'>${'${1} ${1+1} ${1*3}'} <#assign x = 1>${'${x + x} ${x * 3}'}", + "1 2 3 2 3", "11 22 33 22 33"); + + // Doesn't affect template.arithmeticEngine, only affects the parsing: + Template t = new Template(null, null, new StringReader(""), DEFAULT_CFG, tc, null); + assertEquals(DEFAULT_CFG.getArithmeticEngine(), t.getArithmeticEngine()); + } + + @Test + public void testInterpret() throws TemplateException, IOException { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setParentConfiguration(DEFAULT_CFG); + tc.setArithmeticEngine(new DummyArithmeticEngine()); + assertOutputWithoutAndWithTC(tc, + "<#setting locale='en_US'><#assign src = r'${1} <#assign x = 1>${x + x}'><@src?interpret />", + "1 2", "11 22"); + + tc.setWhitespaceStripping(false); + assertOutputWithoutAndWithTC(tc, + "<#if true>\nX</#if><#assign src = r'<#if true>\nY</#if>'><@src?interpret />", + "XY", "\nX\nY"); + } + + @Test + public void testEval() throws TemplateException, IOException { + { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setParentConfiguration(DEFAULT_CFG); + tc.setArithmeticEngine(new DummyArithmeticEngine()); + assertOutputWithoutAndWithTC(tc, + "<#assign x = 1>${r'1 + x'?eval?c}", + "2", "22"); + assertOutputWithoutAndWithTC(tc, + "${r'1?c'?eval}", + "1", "11"); + } + + { + TemplateConfiguration tc = new TemplateConfiguration(); + tc.setParentConfiguration(DEFAULT_CFG); + String outputEncoding = "ISO-8859-2"; + tc.setOutputEncoding(outputEncoding); + + String legacyNCFtl = "${r'.output_encoding!\"null\"'?eval}"; + String camelCaseNCFtl = "${r'.outputEncoding!\"null\"'?eval}"; + + // Default is re-auto-detecting in ?eval: + assertOutputWithoutAndWithTC(tc, legacyNCFtl, "null", outputEncoding); + assertOutputWithoutAndWithTC(tc, camelCaseNCFtl, "null", outputEncoding); + + // Force camelCase: + tc.setNamingConvention(Configuration.CAMEL_CASE_NAMING_CONVENTION); + assertOutputWithoutAndWithTC(tc, legacyNCFtl, "null", null); + assertOutputWithoutAndWithTC(tc, camelCaseNCFtl, "null", outputEncoding); + + // Force legacy: + tc.setNamingConvention(Configuration.LEGACY_NAMING_CONVENTION); + assertOutputWithoutAndWithTC(tc, legacyNCFtl, "null", outputEncoding); + assertOutputWithoutAndWithTC(tc, camelCaseNCFtl, "null", null); + } + } + + @Test + public void testSetParentConfiguration() throws IOException { + TemplateConfiguration tc = new TemplateConfiguration(); + + Template t = new Template(null, "", DEFAULT_CFG); + try { + tc.apply(t); + fail(); + } catch (IllegalStateException e) { + assertThat(e.getMessage(), containsString("Configuration")); + } + + tc.setParent(DEFAULT_CFG); + + try { + tc.setParentConfiguration(new Configuration()); + fail(); + } catch (IllegalStateException e) { + assertThat(e.getMessage(), containsString("Configuration")); + } + + try { + // Same as setParentConfiguration + tc.setParent(new Configuration()); + fail(); + } catch (IllegalStateException e) { + assertThat(e.getMessage(), containsString("Configuration")); + } + + try { + tc.setParentConfiguration(null); + fail(); + } catch (_NullArgumentException e) { + // exected + } + + tc.setParent(DEFAULT_CFG); + + tc.apply(t); + } + + private void assertOutputWithoutAndWithTC( + TemplateConfiguration tc, String ftl, String expectedDefaultOutput, + String expectedConfiguredOutput) throws TemplateException, IOException { + assertOutputWithoutAndWithTC(tc, null, ftl, expectedDefaultOutput, expectedConfiguredOutput); + } + + private void assertOutputWithoutAndWithTC( + TemplateConfiguration tc, String templateName, String ftl, String expectedDefaultOutput, + String expectedConfiguredOutput) throws TemplateException, IOException { + if (templateName == null) { + templateName = "adhoc.ftl"; + } + assertOutput(null, templateName, ftl, expectedDefaultOutput); + assertOutput(tc, templateName, ftl, expectedConfiguredOutput); + } + + private void assertOutput(TemplateConfiguration tc, String templateName, String ftl, String expectedConfiguredOutput) + throws TemplateException, IOException { + StringWriter sw = new StringWriter(); + try { + Configuration cfg = tc != null ? tc.getParentConfiguration() : DEFAULT_CFG; + Template t = new Template(templateName, null, new StringReader(ftl), cfg, tc, null); + if (tc != null) { + tc.apply(t); + } + t.process(null, sw); + if (expectedConfiguredOutput == null) { + fail("Template should have fail."); + } + } catch (TemplateException e) { + if (expectedConfiguredOutput != null) { + throw e; + } + } catch (ParseException e) { + if (expectedConfiguredOutput != null) { + throw e; + } + } + if (expectedConfiguredOutput != null) { + assertEquals(expectedConfiguredOutput, sw.toString()); + } + } + + @Test + public void testIsSet() throws Exception { + for (PropertyDescriptor pd : getTemplateConfigurationSettingPropDescs(true, true)) { + TemplateConfiguration tc = new TemplateConfiguration(); + checkAllIsSetFalseExcept(tc, null); + pd.getWriteMethod().invoke(tc, SETTING_ASSIGNMENTS.get(pd.getName())); + checkAllIsSetFalseExcept(tc, pd.getName()); + } + } + + private void checkAllIsSetFalseExcept(TemplateConfiguration tc, String setSetting) + throws SecurityException, IntrospectionException, + IllegalArgumentException, IllegalAccessException, InvocationTargetException { + for (PropertyDescriptor pd : getTemplateConfigurationSettingPropDescs(true, true)) { + String isSetMethodName = getIsSetMethodName(pd.getReadMethod().getName()); + Method isSetMethod; + try { + isSetMethod = TemplateConfiguration.class.getMethod(isSetMethodName); + } catch (NoSuchMethodException e) { + fail("Missing " + isSetMethodName + " method for \"" + pd.getName() + "\"."); + return; + } + if (pd.getName().equals(setSetting)) { + assertTrue(isSetMethod + " should return true", (Boolean) (isSetMethod.invoke(tc))); + } else { + assertFalse(isSetMethod + " should return false", (Boolean) (isSetMethod.invoke(tc))); + } + } + } + + /** + * Test case self-check. + */ + @Test + public void checkTestAssignments() throws Exception { + for (PropertyDescriptor pd : getTemplateConfigurationSettingPropDescs(true, true)) { + String propName = pd.getName(); + if (!SETTING_ASSIGNMENTS.containsKey(propName)) { + fail("Test case doesn't cover all settings in SETTING_ASSIGNMENTS. Missing: " + propName); + } + Method readMethod = pd.getReadMethod(); + String cfgMethodName = readMethod.getName(); + if (cfgMethodName.equals("getEncoding")) { + // Because Configuration has local-to-encoding map too, this has a different name there. + cfgMethodName = "getDefaultEncoding"; + } + Method cfgMethod = DEFAULT_CFG.getClass().getMethod(cfgMethodName, readMethod.getParameterTypes()); + Object defaultSettingValue = cfgMethod.invoke(DEFAULT_CFG); + Object assignedValue = SETTING_ASSIGNMENTS.get(propName); + assertNotEquals("SETTING_ASSIGNMENTS must contain a non-default value for " + propName, + assignedValue, defaultSettingValue); + + TemplateConfiguration tc = new TemplateConfiguration(); + try { + pd.getWriteMethod().invoke(tc, assignedValue); + } catch (Exception e) { + throw new IllegalStateException("For setting \"" + propName + "\" and assigned value of type " + + (assignedValue != null ? assignedValue.getClass().getName() : "Null"), + e); + } + } + } + +}
