Merge pull request #1157 from kiril-keranov/patch-11

Correct framework order for java_cf_env and spring auto reconfiguration

Author: ramonskie

src/integration/frameworks_test.go

@@ -671,13 +671,16 @@ func testFrameworks(platform switchblade.Platform, fixtures string) func(*testin
 						}).
 						WithEnv(map[string]string{
 							"BP_JAVA_VERSION":                        "11",
+							"JBP_CONFIG_JAVA_CF_ENV":                 "'{enabled: false}'",
 							"JBP_CONFIG_SPRING_AUTO_RECONFIGURATION": "'{enabled: true}'",
 						}).
 						Execute(name, filepath.Join(fixtures, "frameworks", "auto_reconfiguration_servlet_3"))
 					Expect(err).NotTo(HaveOccurred(), logs.String)
 
 					// Spring Auto-reconfiguration should be detected for Spring apps with services
 					Expect(logs.String()).To(ContainSubstring("Spring Auto-reconfiguration"))
+					// Spring Auto-reconfiguration should only be provided in the absence of Java Cf Env
+					Expect(logs.String()).NotTo(ContainSubstring("Java CF Env"))
 					Eventually(deployment).Should(matchers.Serve(ContainSubstring("")))
 				})
 
@@ -695,6 +698,8 @@ func testFrameworks(platform switchblade.Platform, fixtures string) func(*testin
 						Execute(name, filepath.Join(fixtures, "frameworks", "auto_reconfiguration_servlet_3"))
 					Expect(err).NotTo(HaveOccurred(), logs.String)
 
+					// Java Cf Env should be provided as it is enabled by default for Spring3 apps
+					Expect(logs.String()).To(ContainSubstring("Java CF Env"))
 					// Should not install when explicitly disabled
 					Expect(logs.String()).NotTo(ContainSubstring("Spring Auto-reconfiguration"))
 					Eventually(deployment).Should(matchers.Serve(ContainSubstring("")))

src/integration/spring_boot_test.go

@@ -49,21 +49,6 @@ func testSpringBoot(platform switchblade.Platform, fixtures string) func(*testin
 			})
 		})
 
-		context("with Spring Auto-reconfiguration", func() {
-			it("detects Spring Framework", func() {
-				deployment, logs, err := platform.Deploy.
-					WithEnv(map[string]string{
-						"BP_JAVA_VERSION": "11",
-					}).
-					Execute(name, filepath.Join(fixtures, "containers", "spring_boot_staged"))
-				Expect(err).NotTo(HaveOccurred(), logs.String)
-
-				// Spring auto-reconfiguration should be detected
-				Expect(logs.String()).To(ContainSubstring("Java Buildpack"))
-				Eventually(deployment).Should(matchers.Serve(Not(BeEmpty())))
-			})
-		})
-
 		context("with embedded Tomcat", func() {
 			it("starts successfully", func() {
 				deployment, logs, err := platform.Deploy.
@@ -85,11 +70,13 @@ func testSpringBoot(platform switchblade.Platform, fixtures string) func(*testin
 			it("includes java-cfenv when Spring Boot is detected", func() {
 				deployment, logs, err := platform.Deploy.
 					WithEnv(map[string]string{
-						"BP_JAVA_VERSION":       "11",
-						"JBP_CONFIG_JAVA_CFENV": "{enabled: true}",
+						"BP_JAVA_VERSION":        "11",
+						"JBP_CONFIG_JAVA_CF_ENV": "{enabled: true}",
 					}).
 					Execute(name, filepath.Join(fixtures, "containers", "spring_boot_staged"))
 				Expect(err).NotTo(HaveOccurred(), logs.String)
+				// Fixture is not a Spring3 app, so Java CF Env detect should not pass
+				Expect(logs.String()).NotTo(ContainSubstring("Java CF Env"))
 
 				Eventually(deployment).Should(matchers.Serve(Not(BeEmpty())))
 			})

src/integration/testdata/frameworks/auto_reconfiguration_servlet_3/WEB-INF/lib/spring-boot-3.0.0.jar

@@ -51,8 +51,9 @@ func (r *Registry) RegisterStandardFrameworks() {
 	r.Register(NewElasticApmAgentFramework(r.context))
 
 	// Spring Service Bindings (Priority 1)
-	r.Register(NewSpringAutoReconfigurationFramework(r.context))
+	// Note: order matters, Java Cf Env should be registered before StringAutoReconfiguration
 	r.Register(NewJavaCfEnvFramework(r.context))
+	r.Register(NewSpringAutoReconfigurationFramework(r.context))
 
 	// JDBC Drivers (Priority 1)
 	r.Register(NewPostgresqlJdbcFramework(r.context))

src/java/frameworks/framework.go

@@ -1,8 +1,8 @@
 package frameworks
 
 import (
-	"github.com/cloudfoundry/java-buildpack/src/java/common"
 	"fmt"
+	"github.com/cloudfoundry/java-buildpack/src/java/common"
 	"os"
 	"path/filepath"
 	"strings"
@@ -47,6 +47,11 @@ func (s *SpringAutoReconfigurationFramework) Detect() (string, error) {
 
 // Supply installs the Spring Auto-reconfiguration JAR
 func (s *SpringAutoReconfigurationFramework) Supply() error {
+	// Check again if java-cfenv framework is being installed
+	if s.hasJavaCfEnv() {
+		s.context.Log.Debug("java-cfenv present, skipping Spring Auto-reconfiguration installation")
+		return nil
+	}
 	s.context.Log.BeginStep("Installing Spring Auto-reconfiguration")
 
 	// Log deprecation warnings
@@ -56,12 +61,6 @@ func (s *SpringAutoReconfigurationFramework) Supply() error {
 		s.context.Log.Warning("Please migrate to java-cfenv immediately. See https://via.vmw.com/EiBW for migration instructions.")
 	}
 
-	// Check again if java-cfenv framework is being installed
-	if s.hasJavaCfEnv() {
-		s.context.Log.Debug("java-cfenv present, skipping Spring Auto-reconfiguration installation")
-		return nil
-	}
-
 	// Get Spring Auto-reconfiguration dependency from manifest
 	dep, err := s.context.Manifest.DefaultVersion("auto-reconfiguration")
 	if err != nil {