Merge pull request #280 from sap-contributions/274-debug-already-present

Do not add debug options if already available in JAVA_TOOL_OPTIONS
paketo-buildpacks · Apr 21, 2023 · 1c0e73b · 1c0e73b
2 parents 42d22a2 + 7188912
commit 1c0e73b
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 2 deletions.
diff --git a/helper/debug_8.go b/helper/debug_8.go
@@ -18,6 +18,7 @@ package helper
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/paketo-buildpacks/libpak/bard"
 	"github.com/paketo-buildpacks/libpak/sherpa"
@@ -33,6 +34,14 @@ func (d Debug8) Execute() (map[string]string, error) {
 		return nil, nil
 	}
 
+	opts := sherpa.GetEnvWithDefault("JAVA_TOOL_OPTIONS", "")
+	debugAlreadyExists := strings.Contains(opts, "-agentlib:jdwp=")
+
+	if debugAlreadyExists {
+		d.Logger.Info("Java agent 'jdwp' already configured")
+		return nil, nil
+	}
+
 	port := sherpa.GetEnvWithDefault("BPL_DEBUG_PORT", "8000")
 
 	suspend := sherpa.ResolveBool("BPL_DEBUG_SUSPEND")
@@ -49,7 +58,7 @@ func (d Debug8) Execute() (map[string]string, error) {
 		s = "n"
 	}
 
-	opts := sherpa.AppendToEnvVar("JAVA_TOOL_OPTIONS", " ", fmt.Sprintf("-agentlib:jdwp=transport=dt_socket,server=y,address=%s,suspend=%s", port, s))
+	opts = sherpa.AppendToEnvVar("JAVA_TOOL_OPTIONS", " ", fmt.Sprintf("-agentlib:jdwp=transport=dt_socket,server=y,address=%s,suspend=%s", port, s))
 
 	return map[string]string{"JAVA_TOOL_OPTIONS": opts}, nil
 }
diff --git a/helper/debug_8_test.go b/helper/debug_8_test.go
@@ -53,6 +53,20 @@ func testDebug8(t *testing.T, context spec.G, it spec.S) {
 			}))
 		})
 
+		context("jdwp agent already configured", func() {
+			it.Before(func() {
+				Expect(os.Setenv("JAVA_TOOL_OPTIONS", "-agentlib:jdwp=something")).To(Succeed())
+			})
+
+			it.After(func() {
+				Expect(os.Unsetenv("JAVA_TOOL_OPTIONS")).To(Succeed())
+			})
+
+			it("does not update JAVA_TOOL_OPTIONS", func() {
+				Expect(d.Execute()).To(BeEmpty())
+			})
+		})
+
 		context("$BPL_DEBUG_PORT", func() {
 			it.Before(func() {
 				Expect(os.Setenv("BPL_DEBUG_PORT", "8001")).To(Succeed())

diff --git a/helper/debug_9.go b/helper/debug_9.go
@@ -18,6 +18,7 @@ package helper
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/paketo-buildpacks/libpak/sherpa"
 
@@ -34,6 +35,14 @@ func (d Debug9) Execute() (map[string]string, error) {
 		return nil, nil
 	}
 
+	opts := sherpa.GetEnvWithDefault("JAVA_TOOL_OPTIONS", "")
+	debugAlreadyExists := strings.Contains(opts, "-agentlib:jdwp=")
+
+	if debugAlreadyExists {
+		d.Logger.Info("Java agent 'jdwp' already configured")
+		return nil, nil
+	}
+
 	port := "*:" + sherpa.GetEnvWithDefault("BPL_DEBUG_PORT", "8000")
 
 	suspend := sherpa.ResolveBool("BPL_DEBUG_SUSPEND")
@@ -50,7 +59,7 @@ func (d Debug9) Execute() (map[string]string, error) {
 		s = "n"
 	}
 
-	opts := sherpa.AppendToEnvVar("JAVA_TOOL_OPTIONS", " ", fmt.Sprintf("-agentlib:jdwp=transport=dt_socket,server=y,address=%s,suspend=%s", port, s))
+	opts = sherpa.AppendToEnvVar("JAVA_TOOL_OPTIONS", " ", fmt.Sprintf("-agentlib:jdwp=transport=dt_socket,server=y,address=%s,suspend=%s", port, s))
 
 	return map[string]string{"JAVA_TOOL_OPTIONS": opts}, nil
 }
diff --git a/helper/debug_9_test.go b/helper/debug_9_test.go
@@ -52,6 +52,20 @@ func testDebug9(t *testing.T, context spec.G, it spec.S) {
 			}))
 		})
 
+		context("jdwp agent already configured", func() {
+			it.Before(func() {
+				Expect(os.Setenv("JAVA_TOOL_OPTIONS", "-agentlib:jdwp=something")).To(Succeed())
+			})
+
+			it.After(func() {
+				Expect(os.Unsetenv("JAVA_TOOL_OPTIONS")).To(Succeed())
+			})
+
+			it("does not update JAVA_TOOL_OPTIONS", func() {
+				Expect(d.Execute()).To(BeEmpty())
+			})
+		})
+
 		context("$BPL_DEBUG_PORT", func() {
 			it.Before(func() {
 				Expect(os.Setenv("BPL_DEBUG_PORT", "8001")).To(Succeed())