Add deprecation warnings around SAR/SCC (#947)

- Add a deprecation warning if you are manually including Spring Cloud Connectors in your app
- Add a deprecation warning if you are relying on Spring Auto Reconfiguration, which has Spring Cloud Connectors shaded into it
- Do not include Spring Auto Reconfiguration if java-cfenv JARs are present in the app

Signed-off-by: Daniel Mikusa <[email protected]>

Author: Daniel Mikusa

lib/java_buildpack/framework/spring_auto_reconfiguration.rb

@@ -25,10 +25,19 @@ module Framework
     # applications.
     class SpringAutoReconfiguration < JavaBuildpack::Component::VersionedDependencyComponent
 
+      def initialize(context)
+        super(context)
+        @logger = JavaBuildpack::Logging::LoggerFactory.instance.get_logger SpringAutoReconfiguration
+      end
+
       # (see JavaBuildpack::Component::BaseComponent#compile)
       def compile
+        log_warning_scc_manual if spring_cloud_connectors?
+
         download_jar
         @droplet.additional_libraries << (@droplet.sandbox + jar_name)
+
+        log_warning_sar_scc_auto
       end
 
       # (see JavaBuildpack::Component::BaseComponent#release)
@@ -40,10 +49,52 @@ def release
 
       # (see JavaBuildpack::Component::VersionedDependencyComponent#supports?)
       def supports?
-        @configuration['enabled'] && (@droplet.root + '**/*spring-core*.jar').glob.any?
+        @configuration['enabled'] && spring? && !java_cfenv?
       end
 
-    end
+      private
+
+      def spring?
+        (@droplet.root + '**/*spring-core*.jar').glob.any?
+      end
 
+      def java_cfenv?
+        (@droplet.root + '**/*java-cfenv*.jar').glob.any?
+      end
+
+      def spring_cloud_connectors?
+        (@droplet.root + '**/spring-cloud-cloudfoundry-connector*.jar').glob.any? ||
+          (@droplet.root + '**/spring-cloud-spring-service-connector*.jar').glob.any?
+      end
+
+      def log_warning_scc_manual
+        @logger.warn do
+          'ATTENTION: The Spring Cloud Connectors library is present in your application. This library ' \
+            'has been in maintenance mode since July 2019 and will stop receiving all updates after ' \
+            'Dec 2022.'
+        end
+        @logger.warn do
+          'Please migrate to java-cfenv immediately. See https://via.vmw.com/EhzD for migration instructions.' \
+        end
+      end
+
+      def log_warning_sar_scc_auto
+        @logger.warn do
+          'ATTENTION: The Spring Auto Reconfiguration and shaded Spring Cloud Connectors libraries are ' \
+            'being installed. These projects have been deprecated, are no longer receiving updates and should ' \
+            'not be used going forward.'
+        end
+        @logger.warn do
+          'If you are not using these libraries, set `JBP_CONFIG_SPRING_AUTO_RECONFIGURATION=\'{enabled: false}\'` ' \
+            'to disable their installation and clear this warning message. The buildpack will switch its default ' \
+            'to disable by default after Aug 2022. Spring Auto Reconfiguration and its shaded Spring Cloud ' \
+            'Connectors will be removed from the buildpack after Dec 2022.'
+        end
+        @logger.warn do
+          'If you are using these libraries, please migrate to java-cfenv immediately. ' \
+            'See https://via.vmw.com/EhzD for migration instructions. Once you upgrade this message will go away.'
+        end
+      end
+    end
   end
 end

spec/fixtures/framework_auto_reconfiguration_java_cfenv/WEB-INF/lib/java-cfenv-2.1.2.RELEASE.jar

@@ -17,10 +17,13 @@
 
 require 'spec_helper'
 require 'component_helper'
+require 'logging_helper'
 require 'java_buildpack/framework/spring_auto_reconfiguration'
 
 describe JavaBuildpack::Framework::SpringAutoReconfiguration do
   include_context 'with component help'
+  include_context 'with console help'
+  include_context 'with logging help'
 
   let(:configuration) { { 'enabled' => true } }
 
@@ -36,10 +39,43 @@
     expect(component.detect).to eq("spring-auto-reconfiguration=#{version}")
   end
 
+  it 'does not detect with Spring JAR and java-cfenv',
+     app_fixture: 'framework_auto_reconfiguration_java_cfenv' do
+
+    expect(component.detect).to be_nil
+  end
+
   it 'does not detect without Spring JAR' do
     expect(component.detect).to be_nil
   end
 
+  it 'warns if SCC is present',
+     cache_fixture: 'stub-auto-reconfiguration.jar',
+     app_fixture: 'framework_auto_reconfiguration_scc' do
+
+    component.compile
+
+    expect(stderr.string).to match(/ATTENTION: The Spring Cloud Connectors library is present in your application/)
+  end
+
+  it 'does not warn when SCC is missing',
+     cache_fixture: 'stub-auto-reconfiguration.jar',
+     app_fixture: 'framework_auto_reconfiguration_servlet_3' do
+
+    component.compile
+
+    expect(stderr.string).not_to match(/ATTENTION: The Spring Cloud Connectors library is present in your application/)
+  end
+
+  it 'warns if SAR is contributed',
+     cache_fixture: 'stub-auto-reconfiguration.jar',
+     app_fixture: 'framework_auto_reconfiguration_servlet_3' do
+
+    component.compile
+
+    expect(stderr.string).to match(/ATTENTION: The Spring Auto Reconfiguration and shaded Spring Cloud/)
+  end
+
   context do
     let(:configuration) { { 'enabled' => false } }