Improve FreeMarker tests in spring-webmvc and spring-context-support

This commit improves FreeMarkerConfigurerTests in spring-webmvc by
testing against FreeMarkerConfigurer instead of
FreeMarkerConfigurationFactoryBean and moves the original
FreeMarkerConfigurationFactoryBeanTests to spring-context-support in
the org.springframework.ui.freemarker package.

Closes gh-23073

spring-context-support/src/test/java/org/springframework/ui/freemarker/FreeMarkerConfigurationFactoryBeanTests.java

+/*
+ * Copyright 2002-2019 the original author or authors.
+ *
+ * Licensed 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
+ *
+ *      https://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.springframework.ui.freemarker;
+
+import freemarker.template.Configuration;
+import freemarker.template.Template;
+import org.junit.Test;
+import org.springframework.beans.factory.support.DefaultListableBeanFactory;
+import org.springframework.beans.factory.support.RootBeanDefinition;
+import org.springframework.core.io.ByteArrayResource;
+import org.springframework.core.io.DefaultResourceLoader;
+import org.springframework.core.io.FileSystemResource;
+import org.springframework.core.io.Resource;
+import org.springframework.core.io.ResourceLoader;
+
+import java.util.HashMap;
+import java.util.Properties;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatIOException;
+
+/**
+ * @author Juergen Hoeller
+ * @author Issam El-atif
+ */
+public class FreeMarkerConfigurationFactoryBeanTests {
+
+	@Test
+	public void freeMarkerConfigurationFactoryBeanWithConfigLocation() throws Exception {
+		FreeMarkerConfigurationFactoryBean fcfb = new FreeMarkerConfigurationFactoryBean();
+		fcfb.setConfigLocation(new FileSystemResource("myprops.properties"));
+		Properties props = new Properties();
+		props.setProperty("myprop", "/mydir");
+		fcfb.setFreemarkerSettings(props);
+		assertThatIOException().isThrownBy(
+				fcfb::afterPropertiesSet);
+	}
+
+	@Test
+	public void freeMarkerConfigurationFactoryBeanWithResourceLoaderPath() throws Exception {
+		FreeMarkerConfigurationFactoryBean fcfb = new FreeMarkerConfigurationFactoryBean();
+		fcfb.setTemplateLoaderPath("file:/mydir");
+		fcfb.afterPropertiesSet();
+		Configuration cfg = fcfb.getObject();
+		assertThat(cfg.getTemplateLoader() instanceof SpringTemplateLoader).isTrue();
+	}
+
+	@Test
+	@SuppressWarnings("rawtypes")
+	public void freeMarkerConfigurationFactoryBeanWithNonFileResourceLoaderPath() throws Exception {
+		FreeMarkerConfigurationFactoryBean fcfb = new FreeMarkerConfigurationFactoryBean();
+		fcfb.setTemplateLoaderPath("file:/mydir");
+		Properties settings = new Properties();
+		settings.setProperty("localized_lookup", "false");
+		fcfb.setFreemarkerSettings(settings);
+		fcfb.setResourceLoader(new ResourceLoader() {
+			@Override
+			public Resource getResource(String location) {
+				if (!("file:/mydir".equals(location) || "file:/mydir/test".equals(location))) {
+					throw new IllegalArgumentException(location);
+				}
+				return new ByteArrayResource("test".getBytes(), "test");
+			}
+			@Override
+			public ClassLoader getClassLoader() {
+				return getClass().getClassLoader();
+			}
+		});
+		fcfb.afterPropertiesSet();
+		assertThat(fcfb.getObject()).isInstanceOf(Configuration.class);
+		Configuration fc = fcfb.getObject();
+		Template ft = fc.getTemplate("test");
+		assertThat(FreeMarkerTemplateUtils.processTemplateIntoString(ft, new HashMap())).isEqualTo("test");
+	}
+
+	@Test  // SPR-12448
+	public void freeMarkerConfigurationAsBean() {
+		DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
+		RootBeanDefinition loaderDef = new RootBeanDefinition(SpringTemplateLoader.class);
+		loaderDef.getConstructorArgumentValues().addGenericArgumentValue(new DefaultResourceLoader());
+		loaderDef.getConstructorArgumentValues().addGenericArgumentValue("/freemarker");
+		RootBeanDefinition configDef = new RootBeanDefinition(Configuration.class);
+		configDef.getPropertyValues().add("templateLoader", loaderDef);
+		beanFactory.registerBeanDefinition("freeMarkerConfig", configDef);
+		beanFactory.getBean(Configuration.class);
+	}
+
+}

spring-webmvc/src/test/java/org/springframework/web/servlet/view/freemarker/FreeMarkerConfigurerTests.java

@@ -19,6 +19,8 @@ package org.springframework.web.servlet.view.freemarker;
 import java.util.HashMap;
 import java.util.Properties;
 
+import freemarker.cache.ClassTemplateLoader;
+import freemarker.cache.MultiTemplateLoader;
 import freemarker.template.Configuration;
 import freemarker.template.Template;
 import org.junit.Test;
@@ -30,7 +32,6 @@ import org.springframework.core.io.DefaultResourceLoader;
 import org.springframework.core.io.FileSystemResource;
 import org.springframework.core.io.Resource;
 import org.springframework.core.io.ResourceLoader;
-import org.springframework.ui.freemarker.FreeMarkerConfigurationFactoryBean;
 import org.springframework.ui.freemarker.FreeMarkerTemplateUtils;
 import org.springframework.ui.freemarker.SpringTemplateLoader;
 
@@ -39,39 +40,42 @@ import static org.assertj.core.api.Assertions.assertThatIOException;
 
 /**
  * @author Juergen Hoeller
- * @since 14.03.2004
+ * @author Issam El-atif
  */
 public class FreeMarkerConfigurerTests {
 
 	@Test
 	public void freeMarkerConfigurationFactoryBeanWithConfigLocation() throws Exception {
-		FreeMarkerConfigurationFactoryBean fcfb = new FreeMarkerConfigurationFactoryBean();
-		fcfb.setConfigLocation(new FileSystemResource("myprops.properties"));
+		FreeMarkerConfigurer freeMarkerConfigurer = new FreeMarkerConfigurer();
+		freeMarkerConfigurer.setConfigLocation(new FileSystemResource("myprops.properties"));
 		Properties props = new Properties();
 		props.setProperty("myprop", "/mydir");
-		fcfb.setFreemarkerSettings(props);
+		freeMarkerConfigurer.setFreemarkerSettings(props);
 		assertThatIOException().isThrownBy(
-				fcfb::afterPropertiesSet);
+				freeMarkerConfigurer::afterPropertiesSet);
 	}
 
 	@Test
 	public void freeMarkerConfigurationFactoryBeanWithResourceLoaderPath() throws Exception {
-		FreeMarkerConfigurationFactoryBean fcfb = new FreeMarkerConfigurationFactoryBean();
-		fcfb.setTemplateLoaderPath("file:/mydir");
-		fcfb.afterPropertiesSet();
-		Configuration cfg = fcfb.getObject();
-		assertThat(cfg.getTemplateLoader() instanceof SpringTemplateLoader).isTrue();
+		FreeMarkerConfigurer freeMarkerConfigurer = new FreeMarkerConfigurer();
+		freeMarkerConfigurer.setTemplateLoaderPath("file:/mydir");
+		freeMarkerConfigurer.afterPropertiesSet();
+		Configuration cfg = freeMarkerConfigurer.getConfiguration();
+		assertThat(cfg.getTemplateLoader()).isInstanceOf(MultiTemplateLoader.class);
+		MultiTemplateLoader multiTemplateLoader = (MultiTemplateLoader)cfg.getTemplateLoader();
+		assertThat(multiTemplateLoader.getTemplateLoader(0)).isInstanceOf(SpringTemplateLoader.class);
+		assertThat(multiTemplateLoader.getTemplateLoader(1)).isInstanceOf(ClassTemplateLoader.class);
 	}
 
 	@Test
 	@SuppressWarnings("rawtypes")
 	public void freeMarkerConfigurationFactoryBeanWithNonFileResourceLoaderPath() throws Exception {
-		FreeMarkerConfigurationFactoryBean fcfb = new FreeMarkerConfigurationFactoryBean();
-		fcfb.setTemplateLoaderPath("file:/mydir");
+		FreeMarkerConfigurer freeMarkerConfigurer = new FreeMarkerConfigurer();
+		freeMarkerConfigurer.setTemplateLoaderPath("file:/mydir");
 		Properties settings = new Properties();
 		settings.setProperty("localized_lookup", "false");
-		fcfb.setFreemarkerSettings(settings);
-		fcfb.setResourceLoader(new ResourceLoader() {
+		freeMarkerConfigurer.setFreemarkerSettings(settings);
+		freeMarkerConfigurer.setResourceLoader(new ResourceLoader() {
 			@Override
 			public Resource getResource(String location) {
 				if (!("file:/mydir".equals(location) || "file:/mydir/test".equals(location))) {
@@ -84,9 +88,9 @@ public class FreeMarkerConfigurerTests {
 				return getClass().getClassLoader();
 			}
 		});
-		fcfb.afterPropertiesSet();
-		assertThat(fcfb.getObject()).isInstanceOf(Configuration.class);
-		Configuration fc = fcfb.getObject();
+		freeMarkerConfigurer.afterPropertiesSet();
+		assertThat(freeMarkerConfigurer.getConfiguration()).isInstanceOf(Configuration.class);
+		Configuration fc = freeMarkerConfigurer.getConfiguration();
 		Template ft = fc.getTemplate("test");
 		assertThat(FreeMarkerTemplateUtils.processTemplateIntoString(ft, new HashMap())).isEqualTo("test");
 	}