Skip to content

add support for spring boot 4, with a fallback to 3 #1226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zakerf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add support for spring boot 4, with a fallback to 3 #1226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ default_versions:
- name: auto-reconfiguration
version: 2.x
- name: java-cfenv
version: 4.x
- name: java-cfenv-sb3
version: 3.x
- name: client-certificate-mapper
version: 2.x
Expand Down Expand Up @@ -283,14 +285,22 @@ dependencies:
- cflinuxfs4
source: https://repo1.maven.org/maven2/org/jacoco/jacoco/0.8.14/jacoco-0.8.14.zip
source_sha256: 0372447f54900b4e77bcb216985b7d31cf5318fc599f8f9346ee35830448c125
- name: java-cfenv
- name: java-cfenv-sb3
version: 3.5.0
uri: https://java-buildpack.cloudfoundry.org/java-cfenv/java-cfenv-3.5.0.jar
Copy link
Copy Markdown
Contributor

@stokpop stokpop Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we also up this to 3.5.1?

Copy link
Copy Markdown
Contributor

@ramonskie ramonskie Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes that is possible
we could keep 2 lines
i already was worrking on a document for migrate/add to automation
see https://github.com/cloudfoundry/buildpacks-ci/blob/bfed40a5c25b065973b851dd5269a734fc380d1c/docs/java-dependency-migration-plan.md#java-cfenv---active-v400-released-feb-2026-breaking-change-from-3x

Copy link
Copy Markdown
Contributor

@ramonskie ramonskie Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is also a bigger problem. and that is that the buildpack is now exceeding the 1gb range. and is now even 1.2gb
so adding more dependencies/version is something we need to be aware off

Copy link
Copy Markdown
Contributor

@stokpop stokpop Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, I saw the size was also an issue in the past when Java 21 was added. There is a lot in the "--cached" buildpack.zip indeed. Did a local check and biggest dependencies are your-kit-profiler (137MB) and jprofiler (119MB). Then we have 5 java versions (8,11,17,21,25) in 3 distributions (OpenJDK, Zulu, SAPMachine) for a total of ~596MB. In comparison: the java-cfenv jar is about 872kb. ;-)

Seems off topic here: maybe for another issue/PR: is it possible to create slimmed down versions? E.g. with only one JDK distribution and with/without profilers?

We create a stripped down offline buildpack ourselves with only what we need by removing entries from the manifest.yml file. (One downside: if you then request something not present, e.g. a profiler that is not included, the cf push fails with an unclear error message).

sha256: 6a761fe530783c0ec9e6d1713ef54f6504803bf1ad02856d3ee7b46211f905c5
cf_stacks:
- cflinuxfs4
source: https://repo1.maven.org/maven2/io/pivotal/cfenv/java-cfenv/3.5.0/java-cfenv-3.5.0.jar
source_sha256: 9cc8d4c368bc90eafb7b6b14bc34c57ef5523f3ec8546e3fbd91326cdfc13500
- name: java-cfenv
version: 4.0.0
uri: https://java-buildpack.cloudfoundry.org/java-cfenv/java-cfenv-4.0.0.jar
Copy link
Copy Markdown
Author

@zakerf zakerf Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file is not available at this url but I couldn't find what the process was to get it available there

Copy link
Copy Markdown
Contributor

@ramonskie ramonskie Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need to add this to our dependecy-builds pipeline
https://github.com/cloudfoundry/buildpacks-ci/tree/master/pipelines/dependency-builds

Copy link
Copy Markdown
Author

@zakerf zakerf Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I prep a PR for that or do you have something in the works for it?

Copy link
Copy Markdown
Contributor

@ramonskie ramonskie Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The manifest will be populated once we add it to the buildpack dependency config in our overall dependency pipeline

sha256: caa4a78642a39df4fe01ed2013fef1f58ac7ce5376d7791f9b4c8f6eba9da94e
cf_stacks:
- cflinuxfs4
source: https://repo1.maven.org/maven2/io/pivotal/cfenv/java-cfenv/4.0.0/java-cfenv-4.0.0.jar
source_sha256: caa4a78642a39df4fe01ed2013fef1f58ac7ce5376d7791f9b4c8f6eba9da94e
- name: java-memory-assistant
version: 0.5.0
uri: https://github.com/SAP/java-memory-assistant/releases/download/0.5.0/java-memory-assistant-0.5.0.jar
Expand Down
38 changes: 23 additions & 15 deletions src/java/frameworks/java_cf_env.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@ package frameworks

import (
"fmt"
"github.com/cloudfoundry/java-buildpack/src/java/common"
"os"
"path/filepath"
"strings"

"github.com/cloudfoundry/java-buildpack/src/java/common"

"github.com/cloudfoundry/libbuildpack"
"gopkg.in/yaml.v2"
)
Expand All @@ -31,8 +32,8 @@ func (j *JavaCfEnvFramework) Detect() (string, error) {
return "", nil
}

// Check if Spring Boot 3.x is present
if !j.isSpringBoot3() {
// Check if Spring Boot 3.x/4.x is present
if !j.isSpringBootMajor(4) && !j.isSpringBootMajor(3) {
return "", nil
}

Expand All @@ -49,13 +50,21 @@ func (j *JavaCfEnvFramework) Detect() (string, error) {
func (j *JavaCfEnvFramework) Supply() error {
j.context.Log.BeginStep("Installing Java CF Env")

dependency := "java-cfenv"
defaultVersion := "4.0.0"

if j.isSpringBootMajor(3) {
dependency = "java-cfenv-sb3"
defaultVersion = "3.1.0"
}

// Get java-cfenv dependency from manifest
dep, err := j.context.Manifest.DefaultVersion("java-cfenv")
dep, err := j.context.Manifest.DefaultVersion(dependency)
if err != nil {
j.context.Log.Warning("Unable to determine Java CF Env version, using default")
dep = libbuildpack.Dependency{
Name: "java-cfenv",
Version: "3.1.0", // Fallback version
Name: dependency,
Version: defaultVersion,
}
}

Expand Down Expand Up @@ -139,15 +148,14 @@ func (j *JavaCfEnvFramework) isEnabled() bool {
return true
}

// isSpringBoot3 checks if the application is Spring Boot 3.x
func (j *JavaCfEnvFramework) isSpringBoot3() bool {
// Look for Spring Boot 3.x JARs
// Spring Boot 3.x uses spring-boot-3.*.jar
// isSpringBootMajor checks if the application is Spring Boot <major>.x
func (j *JavaCfEnvFramework) isSpringBootMajor(major int) bool {
jarGlob := fmt.Sprintf("spring-boot-%d.*.jar", major)
patterns := []string{
filepath.Join(j.context.Stager.BuildDir(), "**", "spring-boot-3.*.jar"),
filepath.Join(j.context.Stager.BuildDir(), "WEB-INF", "lib", "spring-boot-3.*.jar"),
filepath.Join(j.context.Stager.BuildDir(), "BOOT-INF", "lib", "spring-boot-3.*.jar"),
filepath.Join(j.context.Stager.BuildDir(), "lib", "spring-boot-3.*.jar"),
filepath.Join(j.context.Stager.BuildDir(), "**", jarGlob),
filepath.Join(j.context.Stager.BuildDir(), "WEB-INF", "lib", jarGlob),
filepath.Join(j.context.Stager.BuildDir(), "BOOT-INF", "lib", jarGlob),
filepath.Join(j.context.Stager.BuildDir(), "lib", jarGlob),
}

for _, pattern := range patterns {
Expand All @@ -161,7 +169,7 @@ func (j *JavaCfEnvFramework) isSpringBoot3() bool {
manifestPath := filepath.Join(j.context.Stager.BuildDir(), "META-INF", "MANIFEST.MF")
if content, err := os.ReadFile(manifestPath); err == nil {
manifest := string(content)
if strings.Contains(manifest, "Spring-Boot-Version: 3.") {
if strings.Contains(manifest, fmt.Sprintf("Spring-Boot-Version: %d.", major)) {
return true
}
}
Expand Down
31 changes: 28 additions & 3 deletions src/java/supply/supply_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ dependencies: []
})
})

Context("When a Spring-boot application is present", func() {
Context("When a Spring-boot 4 application is present", func() {
BeforeEach(func() {
// Create a Spring Boot JAR with BOOT-INF
bootInfDir := filepath.Join(buildDir, "BOOT-INF")
Expand All @@ -186,13 +186,13 @@ dependencies: []

// Create META-INF/MANIFEST.MF with corresponding content of a Spring Boot app
manifestFile := filepath.Join(buildDir, "META-INF", "MANIFEST.MF")
Expect(os.WriteFile(manifestFile, []byte("Spring-Boot-Version: 3.x.x"), 0644)).To(Succeed())
Expect(os.WriteFile(manifestFile, []byte("Spring-Boot-Version: 4.x.x"), 0644)).To(Succeed())

//Create install dir and mock for the java cf env spring boot related dependency
javaCfEnvInstallDir := filepath.Join(depsDir, depsIdx, "java_cf_env")
Expect(os.MkdirAll(filepath.Join(javaCfEnvInstallDir), 0755)).To(Succeed())

depJavaCfEnv := libbuildpack.Dependency{Name: "java-cfenv", Version: "3.5.0"}
depJavaCfEnv := libbuildpack.Dependency{Name: "java-cfenv", Version: "4.0.0"}
mockManifest.EXPECT().DefaultVersion("java-cfenv").Return(depJavaCfEnv, nil)
mockInstaller.EXPECT().InstallDependency(depJavaCfEnv, javaCfEnvInstallDir).Return(nil)
})
Expand All @@ -202,6 +202,31 @@ dependencies: []
})
})

Context("When a Spring-boot 3 application is present", func() {
BeforeEach(func() {
// Create a Spring Boot JAR with BOOT-INF
bootInfDir := filepath.Join(buildDir, "BOOT-INF")
Expect(os.MkdirAll(bootInfDir, 0755)).To(Succeed())
Expect(os.MkdirAll(filepath.Join(buildDir, "META-INF"), 0755)).To(Succeed())

// Create META-INF/MANIFEST.MF with corresponding content of a Spring Boot app
manifestFile := filepath.Join(buildDir, "META-INF", "MANIFEST.MF")
Expect(os.WriteFile(manifestFile, []byte("Spring-Boot-Version: 3.x.x"), 0644)).To(Succeed())

//Create install dir and mock for the java cf env spring boot related dependency
javaCfEnvInstallDir := filepath.Join(depsDir, depsIdx, "java_cf_env")
Expect(os.MkdirAll(filepath.Join(javaCfEnvInstallDir), 0755)).To(Succeed())

depJavaCfEnv := libbuildpack.Dependency{Name: "java-cfenv-sb3", Version: "3.5.0"}
mockManifest.EXPECT().DefaultVersion("java-cfenv-sb3").Return(depJavaCfEnv, nil)
mockInstaller.EXPECT().InstallDependency(depJavaCfEnv, javaCfEnvInstallDir).Return(nil)
})

It("Supply passes successfully", func() {
Expect(supply.Run(supplier)).To(Succeed())
})
})

Context("When a Groovy application is present", func() {
BeforeEach(func() {
// Create a .groovy file
Expand Down