Merge 49695439-servlet-3 to master

[Completes #49695439]

Author: nebhale

config/play_framework_jpa_plugin.yml

@@ -15,5 +15,5 @@
 
 # Configuration for the Play JPA Plugin framework
 ---
-version: 0.+
+version: 1.0.+
 repository_root: "{default.repository.root}/play-jpa-plugin"

config/spring_auto_reconfiguration.yml

@@ -17,5 +17,5 @@
 # Note that the repository is shared with the Play Auto Reconfiguration framework and should be kept in step to
 # avoid conflicts.
 ---
-version: 0.+
+version: 1.0.+
 repository_root: "{default.repository.root}/auto-reconfiguration"

lib/java_buildpack/framework/spring_auto_reconfiguration/web_xml_modifier.rb

@@ -22,19 +22,12 @@ module JavaBuildpack
   module Framework
 
     # A class that encapsulates the modification of a +web.xml+ Servlet configuration file for the Auto-reconfiguration
-    # framework.  The modifications of +web.xml+ consist of two major behaviors.
-    #
-    # 1. Augmenting +contextConfigLocation+.  The function starts be enumerating the current +contextConfigLocation+ s.
-    #    If none exist, a default configuration is created with +/WEB-INF/application-context.xml+ or
-    #    +/WEB-INF/<servlet-name>-servlet.xml+ as the default.  An additional location is then added to the collection of
-    #    locations; +classpath:META- INF/cloud/cloudfoundry-auto-reconfiguration-context.xml+ if the +ApplicationContext+
-    #    is XML-based, +org.cloudfoundry.reconfiguration.spring.web.CloudAppAnnotationConfigAutoReconfig+ if the
-    #    +ApplicationContext+ is annotation-based.
-    #
-    # 2. Augmenting +contextInitializerClasses+.  The function starts by enumerating the current
-    #    +contextInitializerClasses+.  If none exist, a default configuration is created with no value as the default.
-    #    The +org.cloudfoundry.reconfiguration.spring.CloudApplicationContextInitializer+ class is then added to the
-    #    collection of classes.
+    # framework.  The modifications of +web.xml+ consist of augmenting +contextInitializerClasses+.  The function starts
+    # by enumerating the current +contextInitializerClasses+.  If none exist, a default configuration is created with no
+    # value as the default. The +org.cloudfoundry.reconfiguration.spring.CloudProfileApplicationContextInitializer+,
+    # +org.cloudfoundry.reconfiguration.spring.CloudPropertySourceApplicationContextInitializer+, and
+    # +org.cloudfoundry.reconfiguration.spring.CloudAutoReconfigurationApplicationContextInitializer+ classes are then
+    # added to the collection of classes.
     class WebXmlModifier
 
       # Creates a new instance of the modifier.
@@ -48,19 +41,15 @@ def initialize(source)
       #
       # @return [Void]
       def augment_root_context
-        if context_loader_listener?
-          augment_context_config_locations web_app(@document), 'context-param', CONTEXT_LOCATION_DEFAULT
-          augment_context_initializer_classes web_app(@document), 'context-param'
-        end
+        augment web_app(@document), 'context-param' if context_loader_listener?
       end
 
       # Make modifications to the the servlet contexts
       #
       # @return [Void]
       def augment_servlet_contexts
         servlets.each do |servlet|
-          augment_context_config_locations servlet, 'init-param', default_servlet_context_location(servlet)
-          augment_context_initializer_classes servlet, 'init-param'
+          augment servlet, 'init-param'
         end
       end
 
@@ -77,55 +66,33 @@ def to_s
 
       private
 
-      CONTEXT_CLASS = 'contextClass'.freeze
-
-      CONTEXT_CLASS_ANNOTATION = 'org.springframework.web.context.support.AnnotationConfigWebApplicationContext'.freeze
-
-      CONTEXT_CONFIG_LOCATION = 'contextConfigLocation'.freeze
-
-      CONTEXT_INITIALIZER_ADDITIONAL = 'org.cloudfoundry.reconfiguration.spring.CloudApplicationContextInitializer'.freeze
+      CONTEXT_INITIALIZER_ADDITIONAL = %w(
+        org.cloudfoundry.reconfiguration.spring.CloudProfileApplicationContextInitializer
+        org.cloudfoundry.reconfiguration.spring.CloudPropertySourceApplicationContextInitializer
+        org.cloudfoundry.reconfiguration.spring.CloudAutoReconfigurationApplicationContextInitializer).freeze
 
       CONTEXT_INITIALIZER_CLASSES = 'contextInitializerClasses'.freeze
 
       CONTEXT_LOADER_LISTENER = 'ContextLoaderListener'.freeze
 
-      CONTEXT_LOCATION_ADDITIONAL_ANNOTATION = 'org.cloudfoundry.reconfiguration.spring.web.CloudAppAnnotationConfigAutoReconfig'.freeze
-
-      CONTEXT_LOCATION_ADDITIONAL_XML = 'classpath:META-INF/cloud/cloudfoundry-auto-reconfiguration-context.xml'.freeze
-
-      CONTEXT_LOCATION_DEFAULT = '/WEB-INF/applicationContext.xml'.freeze
-
       DISPATCHER_SERVLET = 'DispatcherServlet'.freeze
 
-      private_constant :CONTEXT_CLASS, :CONTEXT_CLASS_ANNOTATION, :CONTEXT_CONFIG_LOCATION,
-                       :CONTEXT_INITIALIZER_ADDITIONAL, :CONTEXT_INITIALIZER_CLASSES, :CONTEXT_LOADER_LISTENER,
-                       :CONTEXT_LOCATION_ADDITIONAL_ANNOTATION, :CONTEXT_LOCATION_ADDITIONAL_XML,
-                       :CONTEXT_LOCATION_DEFAULT, :DISPATCHER_SERVLET
-
-      def additional_context_config_location(root, param_type)
-        annotation_application_context?(root, param_type) ? CONTEXT_LOCATION_ADDITIONAL_ANNOTATION : CONTEXT_LOCATION_ADDITIONAL_XML
-      end
-
-      def augment_context_config_locations(root, param_type, default_location)
-        locations_string = xpath(root, "#{param_type}[param-name[contains(text(), '#{CONTEXT_CONFIG_LOCATION}')]]/param-value/text()").first
-        locations_string = create_param(root, param_type, CONTEXT_CONFIG_LOCATION, default_location) unless locations_string
-
-        locations = locations_string.value.strip.split(/[,;\s]+/)
-        locations << additional_context_config_location(root, param_type)
-
-        locations_string.value = locations.join(' ') # rubocop:disable UselessSetterCall
-      end
+      private_constant :CONTEXT_INITIALIZER_CLASSES, :CONTEXT_LOADER_LISTENER, :DISPATCHER_SERVLET
 
-      def augment_context_initializer_classes(root, param_type)
+      def augment(root, param_type)
         classes_string = xpath(root, "#{param_type}[param-name[contains(text(), '#{CONTEXT_INITIALIZER_CLASSES}')]]/param-value/text()").first
         classes_string = create_param(root, param_type, CONTEXT_INITIALIZER_CLASSES, '') unless classes_string
 
         classes = classes_string.value.strip.split(/[,;\s]+/)
-        classes << CONTEXT_INITIALIZER_ADDITIONAL
+        classes = classes.concat CONTEXT_INITIALIZER_ADDITIONAL
 
         classes_string.value = classes.join(',') # rubocop:disable UselessSetterCall
       end
 
+      def context_loader_listener?
+        xpath(@document, "/web-app/listener/listener-class[contains(text(), '#{CONTEXT_LOADER_LISTENER}')]").any?
+      end
+
       def create_param(root, param_type, name, value)
         param = REXML::Element.new param_type, root
 
@@ -136,27 +103,12 @@ def create_param(root, param_type, name, value)
         REXML::Text.new value, true, param_value
       end
 
-      def default_servlet_context_location(servlet)
-        name = xpath(servlet, 'servlet-name/text()').first.value.strip
-        "/WEB-INF/#{name}-servlet.xml"
-      end
-
       def formatter
         formatter         = REXML::Formatters::Pretty.new(4)
         formatter.compact = true
         formatter
       end
 
-      def annotation_application_context?(root, param_type)
-        context_class_name       = xpath(root, "#{param_type}[param-name[contains(text(), '#{CONTEXT_CLASS}')]]/param-value/text()").first
-        context_class_name_value = context_class_name ? context_class_name.value.strip : nil
-        CONTEXT_CLASS_ANNOTATION == context_class_name_value
-      end
-
-      def context_loader_listener?
-        xpath(@document, "/web-app/listener/listener-class[contains(text(), '#{CONTEXT_LOADER_LISTENER}')]").any?
-      end
-
       def servlets
         xpath(@document, "/web-app/servlet[servlet-class[contains(text(), '#{DISPATCHER_SERVLET}')]]")
       end

spec/fixtures/web_root_annotation_after.xml

@@ -3,18 +3,10 @@
     <listener>
         <listener-class> org.springframework.web.context.ContextLoaderListener </listener-class>
     </listener>
-    <context-param>
-        <param-name> contextConfigLocation </param-name>
-        <param-value>
-            /WEB-INF/dataContext.xml /WEB-INF/repositoryContext.xml
-            /WEB-INF/serviceContext.xml /WEB-INF/utilContext.xml
-            classpath:META-INF/cloud/cloudfoundry-auto-reconfiguration-context.xml
-        </param-value>
-    </context-param>
     <context-param>
         <param-name> contextInitializerClasses </param-name>
         <param-value>
-            com.gopivotal.test,org.cloudfoundry.reconfiguration.spring.CloudApplicationContextInitializer
+            com.gopivotal.test,org.cloudfoundry.reconfiguration.spring.CloudProfileApplicationContextInitializer,org.cloudfoundry.reconfiguration.spring.CloudPropertySourceApplicationContextInitializer,org.cloudfoundry.reconfiguration.spring.CloudAutoReconfigurationApplicationContextInitializer
         </param-value>
     </context-param>
 </web-app>

spec/fixtures/web_root_annotation_before.xml

@@ -7,15 +7,6 @@
         </listener-class>
     </listener>
 
-    <context-param>
-        <param-name>
-            contextConfigLocation
-        </param-name>
-        <param-value>
-            /WEB-INF/dataContext.xml, /WEB-INF/repositoryContext.xml; /WEB-INF/serviceContext.xml  /WEB-INF/utilContext.xml
-        </param-value>
-    </context-param>
-
     <context-param>
         <param-name>
             contextInitializerClasses

spec/fixtures/web_root_annotation_wrong_class_after.xml

@@ -4,14 +4,9 @@
         <listener-class> org.springframework.web.context.ContextLoaderListener </listener-class>
     </listener>
     <context-param>
-        <param-name>contextConfigLocation</param-name>
+        <param-name>contextInitializerClasses</param-name>
         <param-value>
-            /WEB-INF/applicationContext.xml
-            classpath:META-INF/cloud/cloudfoundry-auto-reconfiguration-context.xml
+            org.cloudfoundry.reconfiguration.spring.CloudProfileApplicationContextInitializer,org.cloudfoundry.reconfiguration.spring.CloudPropertySourceApplicationContextInitializer,org.cloudfoundry.reconfiguration.spring.CloudAutoReconfigurationApplicationContextInitializer
         </param-value>
     </context-param>
-    <context-param>
-        <param-name>contextInitializerClasses</param-name>
-        <param-value>org.cloudfoundry.reconfiguration.spring.CloudApplicationContextInitializer</param-value>
-    </context-param>
 </web-app>