Merge pull request #33149 from anjumfatima90/SB4-fixEnvironmentProcessor

Fix EnvironmentProcessor lookup for different Spring Boot versions

Author: anjumfatima90

dev/com.ibm.websphere.appserver.features/visibility/private/io.openliberty.springBootHandler-4.0.feature

@@ -5,7 +5,7 @@ visibility=private
 	com.ibm.websphere.appserver.eeCompatible-11.0
 -bundles=\
  com.ibm.ws.app.manager.springboot.jakarta, \
- io.openliberty.springboot.support.shutdown.version40, \
+ com.ibm.ws.springboot.support.shutdown, \
  com.ibm.ws.springboot.utility
 -files=\
  bin/tools/ws-springbootutil.jar, \

dev/com.ibm.ws.app.manager.springboot/resources/com/ibm/ws/app/manager/springboot/internal/resources/Messages.nlsprops

@@ -62,7 +62,7 @@ error.spring.required.20.explanation=The currently configured Spring Boot featur
 error.spring.required.20.useraction=Configure a version of the Spring Boot feature that is compatible with application content.
 
 #ADDED for SpringBoot 3.0:
-error.spring3.required=CWWKC0273E: The springBoot-3.0 feature must be configured. The springBoot-1.5 or springBoot-2.0 feature is configured and the application has Spring 3.0 content.
+error.spring3.required=CWWKC0273E: The {0} feature must be configured in the server.xml file. The {1} feature is configured and the application has Spring Boot {2} content.
 error.spring3.required.explanation=The currently configured Spring Boot feature is not compatible with application content.
 error.spring3.required.useraction=Configure a version of the Spring Boot feature that is compatible with application content.
 

dev/com.ibm.ws.springboot.support.shutdown/bnd.bnd

@@ -49,7 +49,8 @@ instrument.disabled: true
 \
   com.ibm.ws.logging.core;version=latest, \
   com.ibm.ws.ras.instrument;version=latest, \
-  com.ibm.wsspi.org.osgi.service.component.annotations;version=latest
+  com.ibm.wsspi.org.osgi.service.component.annotations;version=latest, \
+  io.openliberty.springboot.support.shutdown.version40;version=latest
 
 -dsannotations: com.ibm.ws.springboot.support.osgi.shutdown.ShutdownSpringBootSupport
 -dsannotations-inherit: true

dev/com.ibm.ws.springboot.support.shutdown/bnd/springBootCloser.bnd

@@ -1,4 +1,5 @@
 Bundle-SymbolicName: springBootCloser
-Private-Package: com.ibm.ws.springboot.support.shutdown.*
+Private-Package: com.ibm.ws.springboot.support.shutdown.*; \
+			     io.openliberty.springboot.support.shutdown
 Include-Resource: resources/container
 -maven-dependencies:

dev/com.ibm.ws.springboot.support.shutdown/resources/container/META-INF/spring.factories

@@ -1,2 +1,4 @@
 org.springframework.boot.env.EnvironmentPostProcessor=com.ibm.ws.springboot.support.shutdown.ApplicationContextCloser,\
  com.ibm.ws.springboot.support.shutdown.FeatureAuditor
+org.springframework.boot.EnvironmentPostProcessor=io.openliberty.springboot.support.shutdown.ApplicationContextCloser40,\
+ io.openliberty.springboot.support.shutdown.FeatureAuditor40

dev/com.ibm.ws.springboot.support.shutdown/src/com/ibm/ws/springboot/support/shutdown/ApplicationContextCloser.java

@@ -4,7 +4,7 @@
  * are made available under the terms of the Eclipse Public License 2.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-2.0/
- * 
+ *
  * SPDX-License-Identifier: EPL-2.0
  *
  * Contributors:
@@ -24,8 +24,56 @@ public class ApplicationContextCloser implements EnvironmentPostProcessor {
     private static final Object token = new Object() {
     };
 
+    /**
+     * Generate the resource name for a specified class.
+     *
+     * Convert '.' into '/' and append '.class'.
+     *
+     * Note: This will not work for inner classes, which convert one or
+     * more '.' into '$' instead of '/'.
+     *
+     * @param className A fully qualified non-inner class name.
+     *
+     * @return The name of the resource of the class.
+     */
+    protected static String asResourceName(String className) {
+        return className.replace('.', '/') + ".class";
+    }
+
+    /**
+     * Tell if a class is available in the current classloading environment.
+     *
+     * That is, tell if the resource of the class is available using this class's
+     * classloader.
+     *
+     * Note: This does not work for inner classes. See {@link #asResourceName(String)}.
+     *
+     * @param className The name of the class which is to be located.
+     *
+     * @return True or false telling if the class resource was located.
+     */
+    protected static boolean isClassAvailable(String className) {
+        ClassLoader classLoader = FeatureAuditor.class.getClassLoader();
+        String resourceName = asResourceName(className);
+        boolean foundClass = (classLoader.getResource(resourceName) != null);
+
+        // System.out.println("FeatureAuditor: Found [ " + foundClass + " ] class [ " + className + " ] as [ " + resourceName + " ]");
+        // System.out.println("FeatureAuditor: Using [ " + classLoader + " ]");
+
+        return foundClass;
+    }
+
     @Override
     public void postProcessEnvironment(ConfigurableEnvironment env, SpringApplication app) {
+        boolean updatedEnvironmentProcessorAvailable = isClassAvailable("org.springframework.boot.EnvironmentPostProcessor");
+        // org.springframework.boot.EnvironmentPostProcessor was added in Spring Boot version 4.0.0-M3.
+        // They decided to keep the lagacy org.springframework.boot.env.EnvironmentPostProcessor from Spring Boot versions 4.0.0-RC1 until 4.2.0 (See https://github.com/spring-projects/spring-boot/issues/47272)
+        // Once the legacy org.springframework.boot.env.EnvironmentPostProcessor is removed, this class (com.ibm.ws.springboot.support.shutdown.ApplicationContextCloser) will no longer be looked up by the spring code.
+        // And the class which implements the org.springframework.boot.EnvironmentPostProcessor will only be looked up.
+        if (updatedEnvironmentProcessorAvailable) {
+            return;
+        }
+
         if (env.getPropertySources().contains("bootstrap")) {
             return;
         }

dev/com.ibm.ws.springboot.support.shutdown/src/com/ibm/ws/springboot/support/shutdown/FeatureAuditor.java

@@ -92,9 +92,18 @@ protected static void warning(Type msgId, Object...parms) {
      */
     @Override
     public void postProcessEnvironment(ConfigurableEnvironment env, SpringApplication app) {
+        boolean updatedEnvironmentProcessorAvailable =
+                        isClassAvailable("org.springframework.boot.EnvironmentPostProcessor");
+
+        // org.springframework.boot.EnvironmentPostProcessor was added in Spring Boot version 4.0.0-M3.
+        // They decided to keep the lagacy org.springframework.boot.env.EnvironmentPostProcessor from Spring Boot versions 4.0.0-RC1 until 4.2.0 (See https://github.com/spring-projects/spring-boot/issues/47272)
+        // Once the legacy org.springframework.boot.env.EnvironmentPostProcessor is removed, this class (com.ibm.ws.springboot.support.shutdown.FeatureAuditor) will no longer be looked up by the spring code.
+        // And the class which implements the org.springframework.boot.EnvironmentPostProcessor will only be looked up.
+        if (updatedEnvironmentProcessorAvailable) {
+            return;
+        }
         String appSpringBootVersion = SpringBootVersion.getVersion();
-        boolean appHasSpring40 = ( appSpringBootVersion.compareTo("4.0.0") >= 0 );
-        boolean appHasSpring30 = ( !appHasSpring40 && appSpringBootVersion.compareTo("3.0.0") >= 0 );
+        boolean appHasSpring30 = ( appSpringBootVersion.compareTo("3.0.0") >= 0 );
         boolean appHasSpring20 = ( !appHasSpring30 && appSpringBootVersion.compareTo("2.0.0") >= 0 );
         boolean appHasSpring15 = ( appSpringBootVersion.compareTo("2.0.0") < 0 );
 
@@ -217,7 +226,7 @@ public void postProcessEnvironment(ConfigurableEnvironment env, SpringApplicatio
             if ( appHasSpring20 ) {
                 requiredJavaVersion = 8;
                 requiredVersionText = "JavaSE-1.8";
-            } else { // ( appHasSpring30 or appHasSpring40)
+            } else { // ( appHasSpring30 )
                 requiredJavaVersion = 17;
                 requiredVersionText = "JavaSE-17.0";
             }
@@ -272,26 +281,10 @@ public void postProcessEnvironment(ConfigurableEnvironment env, SpringApplicatio
         //
         // Match the liberty spring version to the application content!
 
-        if ( appHasSpring40 ) {
-            // Don't test '!libertyHasSpring40'; that may not be set.
-            if ( libertyHasSpring15 || libertyHasSpring20  || libertyHasSpring30) {
-                ApplicationTr.error("error.spring4.required", "springBoot-4.0", libertySpringFeature, "4.0");
-                // "CWWKC0276E: Error: Feature springBoot-4.0 must be provisioned:
-                // Feature springBoot-1.5 or springBoot-2.0 or springBoot-3.0 is provisioned
-                // and the application has Spring 4.0 content."
-            } else if ( appUsesServlets && !libertyHasJakartaServlets ) {
-                ApplicationTr.error("error.spring4.requires.servlet61.or.later.application");
-                // "CWWKC0277E: Error: Feature servlet-6.1 or later must be provisioned:
-                // Feature springBoot-4.0 is provisioned and the application uses Servlets."
-            } else if ( appUsesWebsockets && !libertyHasJakartaWebsockets ) {
-                ApplicationTr.error("error.spring4.requires.websocket22.or.later.application");
-                // "CWWKC0278E: Error: Feature websocket-2.2 or later must be provisioned:
-                // Feature springBoot-4.0 is provisioned and the application uses WebSockets."
-            }
-        } else if ( appHasSpring30 ) {
+        if ( appHasSpring30 ) {
             // Don't test '!libertyHasSpring30'; that may not be set.
-            if ( libertyHasSpring15 || libertyHasSpring20 ) {
-                ApplicationTr.error("error.spring3.required");
+            if ( libertyHasSpring15 || libertyHasSpring20 || libertyHasSpring40) {
+                ApplicationTr.error("error.spring3.required", "springBoot-3.0", libertySpringFeature, "3.0");
                 // "CWWKC0273E: Error: Feature springBoot-3.0 must be provisioned:
                 // Feature springBoot-1.5 or springBoot-2.0 is provisioned
                 // and the application has Spring 3.0 content."
@@ -307,13 +300,13 @@ public void postProcessEnvironment(ConfigurableEnvironment env, SpringApplicatio
 
         } else {
             // Don't test '!libertyHasSpring20'; that may not be set.
-            if ( appHasSpring20 && (libertyHasSpring15 || libertyHasSpring30) ) {
+            if ( appHasSpring20 && (libertyHasSpring15 || libertyHasSpring30 || libertyHasSpring40) ) {
                 ApplicationTr.error("error.spring.required.20", "springBoot-2.0", libertySpringFeature, "2.0");
                 // "CWWKC0253E: Error: Feature {0} must be provisioned:
                 // Feature {1} is provisioned and the application has Spring {2} content.
 
             // Don't test '!libertyHasSpring15'; that may not be set.
-            } else if ( appHasSpring15 && (libertyHasSpring20 || libertyHasSpring30) ) {
+            } else if ( appHasSpring15 && (libertyHasSpring20 || libertyHasSpring30 || libertyHasSpring40) ) {
                 ApplicationTr.error("error.spring.required.15", "springBoot-1.5", libertySpringFeature, "1.5");
                 // "CWWKC0252E: Error: Feature {0} must be provisioned:
                 // Feature {1} is provisioned and the application has Spring {2} content.

dev/io.openliberty.springboot.fat40_fat/fat/src/com/ibm/ws/springboot/support/fat/FATSuite.java

@@ -34,7 +34,7 @@
                 MissingSslFeatureTests40.class,
                 SSLTests40.class,
                 SSLMutualAuthTests40.class,
-                //NeedSpringBootFeatureTests40.class,     // Disabling reason: See class for comments
+                NeedSpringBootFeatureTests40.class,
                 MultipleApplicationsNotSupported40.class,
                 NonZipExtensionFilesInBootInfLibTests40.class,
                 PreThinnedSpringBootTests40.class,

dev/io.openliberty.springboot.fat40_fat/fat/src/com/ibm/ws/springboot/support/fat/NeedSpringBootFeatureTests40.java

@@ -42,10 +42,6 @@ public void testNeedSpringBootFeature40() throws Exception {
         stopServer(true, "CWWKC0276E", "CWWKZ0002E");
     }
 
-    /*
-     * Temporarily disable the test till com.ibm.ws.springboot.support.shutdown.FeatureAuditor class is fixed.
-     * 
-     */
     @Override
     public Set<String> getFeatures() {
         return new HashSet<>(Arrays.asList("springBoot-3.0", "servlet-6.0"));

dev/io.openliberty.springboot.support.shutdown.version40/bnd.bnd

@@ -31,6 +31,8 @@ Include-Resource: springBoot40Closer.jar
 
 Provide-Capability: spring.boot.support; jars:List<String>=springBoot40Closer.jar; version:Version=1.0
 
+Export-Package: io.openliberty.springboot.support.shutdown
+
 instrument.disabled: true
 
 // 'com.ibm.ws.logging.core' and 'com.ibm.ws.ras.instrument' are present to avoid BND warnings,
@@ -54,7 +56,9 @@ instrument.disabled: true
 \
   com.ibm.ws.logging.core;version=latest, \
   com.ibm.ws.ras.instrument;version=latest, \
-  com.ibm.wsspi.org.osgi.service.component.annotations;version=latest
+  com.ibm.wsspi.org.osgi.service.component.annotations;version=latest, \
+  com.ibm.ws.org.osgi.annotation.versioning;version=latest
+  
 
 -dsannotations: io.openliberty.springboot.support.osgi.shutdown.ShutdownSpringBootSupport
 -dsannotations-inherit: true