Ensure that web.xml adds servlet init-params before any load-on-startup element

Author: Stuart Charlton

lib/java_buildpack/framework/spring_auto_reconfiguration/web_xml_modifier.rb

@@ -95,8 +95,13 @@ def context_loader_listener?
       end
 
       def create_param(root, param_type, name, value)
-        param = REXML::Element.new param_type, root
-
+        load_on_startup = xpath(root, 'load-on-startup')
+        if load_on_startup.any?
+          param = REXML::Element.new param_type
+          load_on_startup.first.previous_sibling = param
+        else
+          param = REXML::Element.new param_type, root
+        end
         param_name = REXML::Element.new 'param-name', param
         REXML::Text.new name, true, param_name
 

spec/fixtures/web_servlet_existing_load_on_startup_after.xml

@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<web-app xsi:schemaLocation='http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd' version='2.5' xmlns='http://java.sun.com/xml/ns/javaee' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
+    <servlet>
+        <servlet-name>test</servlet-name>
+        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
+        <init-param>
+            <param-name> contextInitializerClasses </param-name>
+            <param-value>
+                com.gopivotal.test,org.cloudfoundry.reconfiguration.spring.CloudProfileApplicationContextInitializer,org.cloudfoundry.reconfiguration.spring.CloudPropertySourceApplicationContextInitializer,org.cloudfoundry.reconfiguration.spring.CloudAutoReconfigurationApplicationContextInitializer
+            </param-value>
+        </init-param>
+        <load-on-startup>1</load-on-startup>
+    </servlet>
+</web-app>

spec/fixtures/web_servlet_existing_load_on_startup_before.xml

@@ -0,0 +1,16 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<web-app xsi:schemaLocation='http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd' version='2.5' xmlns='http://java.sun.com/xml/ns/javaee' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
+    <servlet>
+        <servlet-name>test</servlet-name>
+        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
+        <init-param>
+            <param-name>
+                contextInitializerClasses
+            </param-name>
+            <param-value>
+                com.gopivotal.test
+            </param-value>
+        </init-param>
+        <load-on-startup>1</load-on-startup>
+    </servlet>
+</web-app>

spec/fixtures/web_servlet_load_on_startup_after.xml

@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<web-app xsi:schemaLocation='http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd' version='2.5' xmlns='http://java.sun.com/xml/ns/javaee' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
+    <servlet>
+        <servlet-name>test</servlet-name>
+        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
+        <init-param>
+            <param-name>contextInitializerClasses</param-name>
+            <param-value>
+                org.cloudfoundry.reconfiguration.spring.CloudProfileApplicationContextInitializer,org.cloudfoundry.reconfiguration.spring.CloudPropertySourceApplicationContextInitializer,org.cloudfoundry.reconfiguration.spring.CloudAutoReconfigurationApplicationContextInitializer
+            </param-value>
+        </init-param>
+        <load-on-startup>1</load-on-startup>
+    </servlet>
+</web-app>

spec/fixtures/web_servlet_load_on_startup_before.xml

@@ -0,0 +1,8 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<web-app xsi:schemaLocation='http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd' version='2.5' xmlns='http://java.sun.com/xml/ns/javaee' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
+    <servlet>
+        <servlet-name>test</servlet-name>
+        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
+        <load-on-startup>1</load-on-startup>
+    </servlet>
+</web-app>

spec/java_buildpack/framework/spring_auto_reconfiguration/web_xml_modifier_spec.rb

@@ -30,11 +30,13 @@
   it 'adds a new contextInitializerClasses if it does not exist' do
     assert_equality('web_root_no_params') { |modifier| modifier.augment_root_context }
     assert_equality('web_servlet_no_params') { |modifier| modifier.augment_servlet_contexts }
+    assert_equality('web_servlet_load_on_startup') { |modifier| modifier.augment_servlet_contexts }
   end
 
   it 'updates existing contextInitializerClasses if it does exist' do
     assert_equality('web_root_existing_params') { |modifier| modifier.augment_root_context }
     assert_equality('web_servlet_existing_params') { |modifier| modifier.augment_servlet_contexts }
+    assert_equality('web_servlet_existing_load_on_startup') { |modifier| modifier.augment_servlet_contexts }
   end
 
   def assert_equality(fixture)