Add cf cli version to user agent header

JIRA:LMCROSSITXSADEPLOY-2854

Author: theghost5800

multiapps_plugin.go

@@ -43,6 +43,12 @@ func (p *MultiappsPlugin) Run(cliConnection plugin.CliConnection, args []string)
 	if err != nil {
 		log.Fatalln(err)
 	}
+	versionOutput, err := cliConnection.CliCommandWithoutTerminalOutput("version")
+	if err != nil {
+		log.Traceln(err)
+		versionOutput = []string{util.DefaultCliVersion}
+	}
+	util.SetCfCliVersion(strings.Join(versionOutput, " "))
 	util.SetPluginVersion(Version)
 	command.Initialize(command.GetPluginCommand().Name, cliConnection)
 	status := command.Execute(args[1:])

util/user_agent_builder.go

@@ -10,28 +10,43 @@ import (
 
 // Limit for MULTIAPPS_USER_AGENT_SUFFIX
 const maxSuffixLength = 128
+const DefaultCliVersion = "unknown-cf cli version"
 
 // pluginVersion stores the version set from the main package
 var pluginVersion string = "0.0.0"
 
+// cfCliVersion stores the version set from the main package
+var cfCliVersion string = DefaultCliVersion
+
 // SetPluginVersion sets the plugin version for use in User-Agent
 func SetPluginVersion(version string) {
 	pluginVersion = version
 }
 
+// SetCfCliVersion sets the cf CLI version for use in User-Agent
+func SetCfCliVersion(version string) {
+	cfCliVersion = version
+}
+
 // GetPluginVersion returns the current plugin version
 func GetPluginVersion() string {
 	return pluginVersion
 }
 
+// GetCfCliVersion returns the current cf CLI version
+func GetCfCliVersion() string {
+	return cfCliVersion
+}
+
 // BuildUserAgent creates a User-Agent string in the format:
 // "Multiapps-CF-plugin/{version} ({operating system version}) {golang builder version} {custom_env_value}"
 func BuildUserAgent() string {
 	osInformation := getOperatingSystemInformation()
 	goVersion := runtime.Version()
+	cfCliVersion := GetCfCliVersion()
 	customValue := getCustomEnvValue()
 
-	userAgent := fmt.Sprintf("Multiapps-CF-plugin/%s (%s) %s", pluginVersion, osInformation, goVersion)
+	userAgent := fmt.Sprintf("Multiapps-CF-plugin/%s (%s) %s (%s)", pluginVersion, osInformation, goVersion, cfCliVersion)
 
 	if customValue != "" {
 		userAgent = fmt.Sprintf("%s %s", userAgent, customValue)

util/user_agent_builder_test.go

@@ -3,6 +3,7 @@ package util_test
 import (
 	"fmt"
 	"os"
+	"regexp"
 	"runtime"
 	"strings"
 
@@ -15,15 +16,18 @@ var _ = Describe("UserAgentBuilder", func() {
 
 	Describe("BuildUserAgent", func() {
 		var originalVersion string
+		var originalCfCliVersion string
 
 		BeforeEach(func() {
-			// Save original version for restoration
+			// Save original versions for restoration
 			originalVersion = util.GetPluginVersion()
+			originalCfCliVersion = util.GetCfCliVersion()
 		})
 
 		AfterEach(func() {
-			// Restore original version and clean up environment
+			// Restore original versions and clean up environment
 			util.SetPluginVersion(originalVersion)
+			util.SetCfCliVersion(originalCfCliVersion)
 			os.Unsetenv("MULTIAPPS_USER_AGENT_SUFFIX")
 		})
 
@@ -73,6 +77,29 @@ var _ = Describe("UserAgentBuilder", func() {
 			})
 		})
 
+		Context("with custom CF CLI version", func() {
+			BeforeEach(func() {
+				util.SetPluginVersion("1.0.0")
+				util.SetCfCliVersion("8.5.0")
+			})
+
+			It("should contain the CF CLI version in parentheses", func() {
+				userAgent := util.BuildUserAgent()
+
+				Expect(userAgent).To(ContainSubstring("(8.5.0)"))
+				Expect(userAgent).To(ContainSubstring("Multiapps-CF-plugin/1.0.0"))
+			})
+
+			It("should have correct format with CF CLI version", func() {
+				userAgent := util.BuildUserAgent()
+
+				// Expected format: "Multiapps-CF-plugin/{version} ({os} {arch}) {go version} ({cf cli version})"
+				expectedPattern := fmt.Sprintf("Multiapps-CF-plugin/1.0.0 \\(%s %s\\) %s \\(8.5.0\\)", runtime.GOOS, runtime.GOARCH, regexp.QuoteMeta(runtime.Version()))
+				matched, _ := regexp.MatchString(expectedPattern, userAgent)
+				Expect(matched).To(BeTrue(), fmt.Sprintf("User agent '%s' should match pattern '%s'", userAgent, expectedPattern))
+			})
+		})
+
 		Context("with custom environment value", func() {
 			BeforeEach(func() {
 				util.SetPluginVersion("3.6.0")
@@ -136,7 +163,7 @@ var _ = Describe("UserAgentBuilder", func() {
 				userAgent := util.BuildUserAgent()
 
 				// Should only contain the base user agent without suffix
-				expectedBase := fmt.Sprintf("Multiapps-CF-plugin/1.0.0 (%s %s) %s", runtime.GOOS, runtime.GOARCH, runtime.Version())
+				expectedBase := fmt.Sprintf("Multiapps-CF-plugin/1.0.0 (%s %s) %s (unknown-cf cli version)", runtime.GOOS, runtime.GOARCH, runtime.Version())
 				Expect(userAgent).To(Equal(expectedBase))
 			})
 
@@ -145,7 +172,7 @@ var _ = Describe("UserAgentBuilder", func() {
 				userAgent := util.BuildUserAgent()
 
 				// Should only contain the base user agent without suffix (whitespace gets trimmed to empty)
-				expectedBase := fmt.Sprintf("Multiapps-CF-plugin/1.0.0 (%s %s) %s", runtime.GOOS, runtime.GOARCH, runtime.Version())
+				expectedBase := fmt.Sprintf("Multiapps-CF-plugin/1.0.0 (%s %s) %s (unknown-cf cli version)", runtime.GOOS, runtime.GOARCH, runtime.Version())
 				Expect(userAgent).To(Equal(expectedBase))
 			})
 
@@ -245,4 +272,57 @@ var _ = Describe("UserAgentBuilder", func() {
 			Expect(util.GetPluginVersion()).To(Equal("0.0.0"))
 		})
 	})
+
+	Describe("SetCfCliVersion", func() {
+		var originalVersion string
+
+		BeforeEach(func() {
+			originalVersion = util.GetCfCliVersion()
+		})
+
+		AfterEach(func() {
+			util.SetCfCliVersion(originalVersion)
+		})
+
+		It("should set the CF CLI version correctly", func() {
+			testVersion := "8.5.0"
+			util.SetCfCliVersion(testVersion)
+
+			Expect(util.GetCfCliVersion()).To(Equal(testVersion))
+		})
+
+		It("should be used in BuildUserAgent", func() {
+			testVersion := "8.5.0"
+			util.SetCfCliVersion(testVersion)
+			util.SetPluginVersion("1.0.0")
+
+			userAgent := util.BuildUserAgent()
+			Expect(userAgent).To(ContainSubstring(fmt.Sprintf("(%s)", testVersion)))
+		})
+	})
+
+	Describe("GetCfCliVersion", func() {
+		var originalVersion string
+
+		BeforeEach(func() {
+			originalVersion = util.GetCfCliVersion()
+		})
+
+		AfterEach(func() {
+			util.SetCfCliVersion(originalVersion)
+		})
+
+		It("should return the current CF CLI version", func() {
+			testVersion := "8.6.0"
+			util.SetCfCliVersion(testVersion)
+
+			Expect(util.GetCfCliVersion()).To(Equal(testVersion))
+		})
+
+		It("should return default CF CLI version initially", func() {
+			util.SetCfCliVersion(util.DefaultCliVersion)
+
+			Expect(util.GetCfCliVersion()).To(Equal(util.DefaultCliVersion))
+		})
+	})
 })