fix for GRAILS-9490 "Cannot use Java String with '${}' in Config.groovy"

Author: graemerocher

grails-core/src/main/groovy/grails/util/Holders.java

@@ -21,6 +21,8 @@
 
 import javax.servlet.ServletContext;
 
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import org.codehaus.groovy.grails.commons.GrailsApplication;
 import org.codehaus.groovy.grails.compiler.support.GrailsResourceLoader;
 import org.codehaus.groovy.grails.plugins.GrailsPluginManager;
@@ -34,6 +36,7 @@
  */
 public class Holders {
 
+    private static final Log LOG = LogFactory.getLog(Holders.class);
     private static final String APPLICATION_BEAN_NAME = "grailsApplication";
 
     private static Holder<GrailsResourceLoader> resourceLoaders = new Holder<GrailsResourceLoader>("ResourceLoader");
@@ -175,15 +178,15 @@ private static void createServletContextsHolder() {
         }
         catch (ClassNotFoundException e) {
             // shouldn't happen
-            throw new RuntimeException(e);
+            LOG.error("Error initializing servlet context holder", e);
         }
         catch (InstantiationException e) {
             // shouldn't happen
-            throw new RuntimeException(e);
+            LOG.error("Error initializing servlet context holder", e);
         }
         catch (IllegalAccessException e) {
             // shouldn't happen
-            throw new RuntimeException(e);
+            LOG.error("Error initializing servlet context holder", e);
         }
     }
 }

grails-core/src/main/groovy/org/codehaus/groovy/grails/commons/cfg/GrailsConfig.java

@@ -33,6 +33,7 @@
  */
 public class GrailsConfig {
 
+    public static final String SPRING_PLACEHOLDER_PREFIX = "grails.spring.placeholder.prefix";
     private static final Log LOG = LogFactory.getLog(GrailsConfig.class);
 
     private GrailsApplication grailsApplication;

grails-core/src/main/groovy/org/codehaus/groovy/grails/commons/cfg/GrailsPlaceholderConfigurer.java

@@ -21,19 +21,23 @@
 
 import org.codehaus.groovy.grails.commons.GrailsApplication;
 import org.springframework.beans.factory.config.PropertyPlaceholderConfigurer;
+import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
 
 /**
  * Uses Grails' ConfigObject for place holder values.
  *
  * @author Graeme Rocher
  * @since 1.0
  */
-public class GrailsPlaceholderConfigurer extends PropertyPlaceholderConfigurer {
+public class GrailsPlaceholderConfigurer extends PropertySourcesPlaceholderConfigurer {
 
     private GrailsApplication grailsApplication;
 
     public GrailsPlaceholderConfigurer(GrailsApplication grailsApplication) {
         this.grailsApplication = grailsApplication;
+        GrailsConfig config = new GrailsConfig(grailsApplication);
+        setPlaceholderPrefix(config.get(GrailsConfig.SPRING_PLACEHOLDER_PREFIX, "${"));
+        setIgnoreUnresolvablePlaceholders(true);
     }
 
     @Override

grails-core/src/test/groovy/org/codehaus/groovy/grails/commons/cfg/GrailsPlaceholderConfigurerSpec.groovy

@@ -0,0 +1,73 @@
+package org.codehaus.groovy.grails.commons.cfg
+
+import grails.spring.BeanBuilder
+import org.codehaus.groovy.grails.commons.DefaultGrailsApplication
+import spock.lang.Issue
+import spock.lang.Specification
+
+/**
+ * @author Graeme Rocher
+ */
+class GrailsPlaceholderConfigurerSpec extends Specification {
+
+    void "Test that property placeholder configuration works for simple properties"() {
+        when:"A bean is defined with a placeholder"
+            def application = new DefaultGrailsApplication()
+            application.config.foo.bar="test"
+            def bb = new BeanBuilder()
+            bb.beans {
+                addBeanFactoryPostProcessor(new GrailsPlaceholderConfigurer(application))
+                testBean(TestBean) {
+                    name = '${foo.bar}'
+                }
+            }
+            def applicationContext = bb.createApplicationContext()
+            def bean = applicationContext.getBean(TestBean)
+        then:"The placeholder is replaced"
+            bean.name == "test"
+
+    }
+
+    @Issue('GRAILS-9490')
+    void "Test that property placeholder configuration doesn't throw an error if invalid placeholders are configured"() {
+        when:"A bean is defined with a placeholder"
+        def application = new DefaultGrailsApplication()
+        application.config.bar.foo="test"
+        application.config.more.stuff='another ${place.holder}'
+        def bb = new BeanBuilder()
+        bb.beans {
+            addBeanFactoryPostProcessor(new GrailsPlaceholderConfigurer(application))
+            testBean(TestBean) {
+                name = '${foo.bar}'
+            }
+        }
+        def applicationContext = bb.createApplicationContext()
+        def bean = applicationContext.getBean(TestBean)
+        then:"The placeholder is replaced"
+        bean.name == '${foo.bar}'
+
+    }
+
+    void "Test that property placeholder configuration works for simple properties with a custom placeholder prefix"() {
+        when:"A bean is defined with a placeholder"
+        def application = new DefaultGrailsApplication()
+        application.config.foo.bar="test"
+        application.config.grails.spring.placeholder.prefix='£{'
+        application.setConfig(application.config)
+        def bb = new BeanBuilder()
+        bb.beans {
+            addBeanFactoryPostProcessor(new GrailsPlaceholderConfigurer(application))
+            testBean(TestBean) {
+                name = '£{foo.bar}'
+            }
+        }
+        def applicationContext = bb.createApplicationContext()
+        def bean = applicationContext.getBean(TestBean)
+        then:"The placeholder is replaced"
+        bean.name == "test"
+
+    }
+}
+class TestBean {
+    String name
+}