Merge pull request #853 from BenjaminPerryRoss/ben/detect-geode-tomcat-version

Detect Geode Tomcat module version

Author: ekcasey

config/open_jdk_jre.yml

@@ -25,6 +25,6 @@ jvmkill_agent:
 memory_calculator:
   version: 3.+
   repository_root: "{default.repository.root}/memory-calculator/{platform}/{architecture}"
-  class_count: 
-  headroom: 
+  class_count:
+  headroom:
   stack_threads: 250

config/tomcat.yml

@@ -1,5 +1,5 @@
 # Cloud Foundry Java Buildpack
-# Copyright 2013-2020 the original author or authors.
+# Copyright 2013-2021 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.

lib/java_buildpack/container/tomcat.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Cloud Foundry Java Buildpack
-# Copyright 2013-2020 the original author or authors.
+# Copyright 2013-2021 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.
@@ -52,10 +52,14 @@ def command
 
       # (see JavaBuildpack::Component::ModularComponent#sub_components)
       def sub_components(context)
+        instance = TomcatInstance.new(sub_configuration_context(context, 'tomcat'))
+        # pass Tomcat major version to geode_store so we can verify compatibility.
+        tomcat_version = instance.instance_variable_get(:@version)[0]
+
         components = [
-          TomcatInstance.new(sub_configuration_context(context, 'tomcat')),
+          instance,
           TomcatAccessLoggingSupport.new(sub_configuration_context(context, 'access_logging_support')),
-          TomcatGeodeStore.new(sub_configuration_context(context, 'geode_store')),
+          TomcatGeodeStore.new(sub_configuration_context(context, 'geode_store'), tomcat_version),
           TomcatInsightSupport.new(context),
           TomcatLifecycleSupport.new(sub_configuration_context(context, 'lifecycle_support')),
           TomcatLoggingSupport.new(sub_configuration_context(context, 'logging_support')),

lib/java_buildpack/container/tomcat/tomcat_geode_store.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Cloud Foundry Java Buildpack
-# Copyright 2013-2020 the original author or authors.
+# Copyright 2013-2021 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.
@@ -27,11 +27,22 @@ module Container
     class TomcatGeodeStore < JavaBuildpack::Component::VersionedDependencyComponent
       include JavaBuildpack::Container
 
+      # Creates an instance.  In addition to the functionality inherited from +VersionedDependencyComponent+
+      # +@tomcat_version+ instance variable is exposed.
+      #
+      # @param [Hash] context a collection of utilities used by components
+      # @param [String] tomcat_version is the major version of tomcat
+      def initialize(context, tomcat_version)
+        super(context)
+        @tomcat_version = tomcat_version
+      end
+
       # (see JavaBuildpack::Component::BaseComponent#compile)
       def compile
         return unless supports?
 
         download_tar(false, tomcat_lib, tar_name)
+        detect_geode_tomcat_version
         mutate_context
         mutate_server
         create_cache_client_xml
@@ -58,7 +69,6 @@ def supports?
       KEY_LOCATORS = 'locators'
       KEY_USERS = 'users'
 
-      SESSION_MANAGER_CLASS_NAME = 'org.apache.geode.modules.session.catalina.Tomcat9DeltaSessionManager'
       REGION_ATTRIBUTES_ID = 'PARTITION_REDUNDANT_HEAP_LRU'
       CACHE_CLIENT_LISTENER_CLASS_NAME =
         'org.apache.geode.modules.session.catalina.ClientServerCacheLifecycleListener'
@@ -67,7 +77,7 @@ def supports?
       SCHEMA_LOCATION = 'http://geode.apache.org/schema/cache http://geode.apache.org/schema/cache/cache-1.0.xsd'
       LOCATOR_REGEXP = Regexp.new('([^\\[]+)\\[([^\\]]+)\\]').freeze
 
-      private_constant :FILTER, :KEY_LOCATORS, :KEY_USERS, :SESSION_MANAGER_CLASS_NAME, :REGION_ATTRIBUTES_ID,
+      private_constant :FILTER, :KEY_LOCATORS, :KEY_USERS, :REGION_ATTRIBUTES_ID,
                        :CACHE_CLIENT_LISTENER_CLASS_NAME, :SCHEMA_URL, :SCHEMA_INSTANCE_URL, :SCHEMA_LOCATION,
                        :LOCATOR_REGEXP
 
@@ -98,7 +108,7 @@ def add_locators(pool)
 
       def add_manager(context)
         context.add_element 'Manager',
-                            'className' => SESSION_MANAGER_CLASS_NAME,
+                            'className' => @session_manager_classname,
                             'enableLocalCache' => 'true',
                             'regionAttributesId' => REGION_ATTRIBUTES_ID
       end
@@ -124,9 +134,41 @@ def create_cache_client_xml
         write_xml cache_client_xml_path, document
       end
 
+      def detect_geode_tomcat_version
+        geode_tomcat_version = nil
+
+        geode_modules_tomcat_pattern = /geode-modules-tomcat(?<version>[0-9]*).*.jar/.freeze
+        Dir.foreach(@droplet.sandbox + 'lib') do |file|
+          if geode_modules_tomcat_pattern.match(file)
+            unless geode_tomcat_version.nil?
+              raise('Multiple versions of geode-modules-tomcat jar found. ' \
+                'Please verify your geode_store tar only contains one geode-modules-tomcat jar.')
+            end
+
+            geode_tomcat_version = geode_modules_tomcat_pattern.match(file).named_captures['version']
+          end
+        end
+
+        if geode_tomcat_version.nil?
+          raise('Geode Tomcat module not found. ' \
+            'Please verify your geode_store tar contains a geode-modules-tomcat jar.')
+        end
+
+        puts "       Detected Geode Tomcat #{geode_tomcat_version} module"
+
+        # leave possibility for generic jar/session manager class that is compatible with all tomcat versions
+        if !geode_tomcat_version.empty? && geode_tomcat_version != @tomcat_version
+          puts "       WARNING: Tomcat version #{@tomcat_version} " \
+                  "does not match Geode Tomcat #{geode_tomcat_version} module. " \
+                  'If you encounter compatibility issues, please make sure these versions match.'
+        end
+
+        @session_manager_classname =
+          "org.apache.geode.modules.session.catalina.Tomcat#{geode_tomcat_version}DeltaSessionManager"
+      end
+
       def mutate_context
         puts '       Adding Geode-based Session Replication'
-
         document = read_xml context_xml
         context = REXML::XPath.match(document, '/Context').first
 

spec/fixtures/container_no_tomcat_version_geode_store_context_after.xml

@@ -0,0 +1,20 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!--
+  ~ Cloud Foundry Java Buildpack
+  ~ Copyright 2013-2020 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
+  ~
+  ~      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.
+  --> 
+<Context allowLinking='true'>
+    <Manager className='org.apache.geode.modules.session.catalina.TomcatDeltaSessionManager' enableLocalCache='true' regionAttributesId='PARTITION_REDUNDANT_HEAP_LRU'/>
+</Context>

spec/fixtures/stub-geode-store-no-geode-tomcat.tar

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Cloud Foundry Java Buildpack
-# Copyright 2013-2020 the original author or authors.
+# Copyright 2013-2021 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.
@@ -22,6 +22,8 @@
 describe JavaBuildpack::Container::TomcatGeodeStore do
   include_context 'with component help'
 
+  let(:component) { described_class.new(context, '9') }
+
   let(:component_id) { 'tomcat' }
 
   let(:configuration) do
@@ -64,8 +66,9 @@
 
       component.compile
 
-      expect(sandbox + 'lib/stub-geode-store/stub-jar-1.jar').to exist
-      expect(sandbox + 'lib/stub-geode-store/stub-jar-2.jar').to exist
+      expect(sandbox + 'lib/stub-jar-1.jar').to exist
+      expect(sandbox + 'lib/stub-jar-2.jar').to exist
+      expect(sandbox + 'lib/geode-modules-tomcat9.jar').to exist
     end
 
     it 'mutates context.xml',
@@ -78,6 +81,45 @@
         .to eq(Pathname.new('spec/fixtures/container_tomcat_geode_store_context_after.xml').read)
     end
 
+    it 'prints warning when Tomcat version in buildpack is different from Geode Tomcat module version',
+       app_fixture: 'container_tomcat_geode_store',
+       cache_fixture: 'stub-geode-store.tar' do
+
+      component = described_class.new(context, '8')
+
+      expect { component.compile }.to output(
+        # rubocop:disable Layout/LineLength
+        /WARNING: Tomcat version 8 does not match Geode Tomcat 9 module\. If you encounter compatibility issues, please make sure these versions match\./
+        # rubocop:enable Layout/LineLength
+      ).to_stdout
+    end
+
+    it 'does not add Geode Tomcat module version to Session Manager classname if version is empty',
+       app_fixture: 'container_tomcat_geode_store',
+       cache_fixture: 'stub-geode-store-no-tomcat-version.tar' do
+
+      component.compile
+
+      expect((sandbox + 'conf/context.xml').read)
+        .to eq(Pathname.new('spec/fixtures/container_no_tomcat_version_geode_store_context_after.xml').read)
+    end
+
+    it 'raises runtime error if multiple Geode Tomcat module jars are detected',
+       app_fixture: 'container_tomcat_geode_store',
+       cache_fixture: 'stub-geode-store-tomcat-multi-version.tar' do
+
+      expect { component.compile }.to raise_error RuntimeError, 'Multiple versions of geode-modules-tomcat jar found.' \
+        ' Please verify your geode_store tar only contains one geode-modules-tomcat jar.'
+    end
+
+    it 'raises runtime error if no Geode Tomcat module jar is detected',
+       app_fixture: 'container_tomcat_geode_store',
+       cache_fixture: 'stub-geode-store-no-geode-tomcat.tar' do
+
+      expect { component.compile }.to raise_error RuntimeError, 'Geode Tomcat module not found. ' \
+          'Please verify your geode_store tar contains a geode-modules-tomcat jar.'
+    end
+
     it 'mutates server.xml',
        app_fixture: 'container_tomcat_geode_store',
        cache_fixture: 'stub-geode-store.tar' do
@@ -98,7 +140,7 @@
         .to eq(Pathname.new('spec/fixtures/container_tomcat_geode_store_cache_client_after.xml').read)
     end
 
-    it 'passes security properties to the release',
+    it 'passes client auth class to the release',
        app_fixture: 'container_tomcat_geode_store',
        cache_fixture: 'stub-geode-store.tar' do