feat: set User-Agent HTTP header on all outgoing requests

api/apihelper.go

@@ -34,17 +34,19 @@ const (
 )
 
 type APIHelper struct {
-	Endpoint *APIEndpoint
-	Client   *CFClient
-	Logger   trace.Printer
+	Endpoint  *APIEndpoint
+	Client    *CFClient
+	Logger    trace.Printer
+	UserAgent string
 }
 
-func NewAPIHelper(endpoint *APIEndpoint, cfclient *CFClient, traceEnabled string) *APIHelper {
+func NewAPIHelper(endpoint *APIEndpoint, cfclient *CFClient, traceEnabled string, userAgent string) *APIHelper {
 
 	return &APIHelper{
-		Endpoint: endpoint,
-		Client:   cfclient,
-		Logger:   trace.NewLogger(os.Stdout, false, traceEnabled, ""),
+		Endpoint:  endpoint,
+		Client:    cfclient,
+		Logger:    trace.NewLogger(os.Stdout, false, traceEnabled, ""),
+		UserAgent: userAgent,
 	}
 }
 
@@ -71,6 +73,7 @@ func makeTransport(skipSSLValidation bool, logger trace.Printer) http.RoundTripp
 }
 
 func (helper *APIHelper) DoRequest(req *http.Request) (*http.Response, error) {
+	req.Header.Set("User-Agent", helper.UserAgent)
 
 	client := newHTTPClient(helper.Endpoint.SkipSSLValidation || helper.Client.IsSSLDisabled, helper.Logger)
 	resp, err := client.Do(req)

api/apihelper_test.go

@@ -23,6 +23,7 @@ var _ = Describe("API Helper Test", func() {
 	const (
 		fakeAppId       string = "fakeAppId"
 		fakeAccessToken string = "fakeAccessToken"
+		fakeUserAgent   string = "app-autoscaler-cli-plugin/1.2.3 (https://github.com/test) Go/test"
 	)
 
 	var (
@@ -112,6 +113,7 @@ var _ = Describe("API Helper Test", func() {
 				AppName:       "fakeAppName",
 			},
 			"false",
+			fakeUserAgent,
 		)
 
 	})
@@ -120,6 +122,19 @@ var _ = Describe("API Helper Test", func() {
 		apiServer.Close()
 	})
 
+	Context("User-Agent header", func() {
+		It("is set on requests", func() {
+			apiServer.AppendHandlers(
+				ghttp.CombineHandlers(
+					ghttp.RespondWith(http.StatusOK, ""),
+					ghttp.VerifyHeaderKV("User-Agent", fakeUserAgent),
+				),
+			)
+			err = apihelper.CheckHealth()
+			Expect(err).NotTo(HaveOccurred())
+		})
+	})
+
 	Context("Common invalid access errors", func() {
 
 		Context("Server not started", func() {
@@ -184,6 +199,7 @@ var _ = Describe("API Helper Test", func() {
 						AppName:       "fakeAppName",
 					},
 					"false",
+					fakeUserAgent,
 				)
 
 			})

api/cf_api_client.go

@@ -15,14 +15,15 @@ type CFAPIClient struct {
 	client *cf_client.Client
 }
 
-func NewCFAPIClient(ccAPIEndpoint *url.URL, authToken string, skipTLSValidation bool) (*CFAPIClient, error) {
+func NewCFAPIClient(ccAPIEndpoint *url.URL, authToken string, skipTLSValidation bool, userAgent string) (*CFAPIClient, error) {
 	// A refresh token is not provided by the CF CLI Plugin API and is not required as
 	// "AccessToken() now provides a refreshed o-auth token.",
 	// see https://github.com/cloudfoundry/cli/blob/main/plugin/plugin_examples/CHANGELOG.md#changes-in-v614
 	refreshToken := ""
 
 	cfClientConfigOptions := []cf_client_config.Option{
 		cf_client_config.Token(authToken, refreshToken),
+		cf_client_config.UserAgent(userAgent),
 	}
 
 	if skipTLSValidation {

api/cfclient.go

@@ -16,6 +16,7 @@ type CFClient struct {
 	AppId         string
 	AppName       string
 	IsSSLDisabled bool
+	UserAgent     string
 }
 
 type Connection interface {
@@ -27,7 +28,7 @@ type Connection interface {
 	IsSSLDisabled() (bool, error)
 }
 
-func NewCFClient(connection Connection) (*CFClient, error) {
+func NewCFClient(connection Connection, userAgent string) (*CFClient, error) {
 
 	ccAPIEndpoint, err := connection.ApiEndpoint()
 	if err != nil {
@@ -46,6 +47,7 @@ func NewCFClient(connection Connection) (*CFClient, error) {
 		connection:    connection,
 		CCAPIEndpoint: ccAPIEndpoint,
 		IsSSLDisabled: isSSLDisabled,
+		UserAgent:     userAgent,
 	}
 
 	return client, nil
@@ -83,7 +85,7 @@ func (client *CFClient) Configure(appName string) error {
 		return err
 	}
 
-	cfAPIClient, err := NewCFAPIClient(ccAPIURL, authToken, client.IsSSLDisabled)
+	cfAPIClient, err := NewCFAPIClient(ccAPIURL, authToken, client.IsSSLDisabled, client.UserAgent)
 	if err != nil {
 		return err
 	}

api/endpoint.go

@@ -41,7 +41,7 @@ func UnsetEndpoint() error {
 	return nil
 }
 
-func SetEndpoint(cfclient *CFClient, url string, skipSSLValidation bool) error {
+func SetEndpoint(cfclient *CFClient, url string, skipSSLValidation bool, userAgent string) error {
 
 	cfDomain := getDomain(cfclient.CCAPIEndpoint)
 	autoscalerDomain := getDomain(url)
@@ -55,7 +55,7 @@ func SetEndpoint(cfclient *CFClient, url string, skipSSLValidation bool) error {
 		SkipSSLValidation: skipSSLValidation,
 	}
 
-	apihelper := NewAPIHelper(endpoint, cfclient, os.Getenv("CF_TRACE"))
+	apihelper := NewAPIHelper(endpoint, cfclient, os.Getenv("CF_TRACE"), userAgent)
 	err := apihelper.CheckHealth()
 	if err != nil {
 		return err
@@ -72,7 +72,7 @@ func SetEndpoint(cfclient *CFClient, url string, skipSSLValidation bool) error {
 	return nil
 }
 
-func GetEndpoint(cfclient *CFClient) (*APIEndpoint, error) {
+func GetEndpoint(cfclient *CFClient, userAgent string) (*APIEndpoint, error) {
 
 	endpoint, err := getEndpointFromConfig()
 	if err != nil {
@@ -89,7 +89,7 @@ func GetEndpoint(cfclient *CFClient) (*APIEndpoint, error) {
 	}
 
 	if endpoint.URL == "" {
-		endpoint, err = getDefaultEndpoint(cfclient)
+		endpoint, err = getDefaultEndpoint(cfclient, userAgent)
 		if err != nil {
 			return nil, err
 		}
@@ -98,13 +98,13 @@ func GetEndpoint(cfclient *CFClient) (*APIEndpoint, error) {
 
 }
 
-func getDefaultEndpoint(cfclient *CFClient) (*APIEndpoint, error) {
+func getDefaultEndpoint(cfclient *CFClient, userAgent string) (*APIEndpoint, error) {
 
 	ccAPIURL := cfclient.CCAPIEndpoint
 	asAPIURL := strings.Replace(ccAPIURL, "api.", "autoscaler.", 1)
 
 	//ignore all erros here if the default value won't work
-	SetEndpoint(cfclient, asAPIURL, cfclient.IsSSLDisabled)
+	SetEndpoint(cfclient, asAPIURL, cfclient.IsSSLDisabled, userAgent)
 	return getEndpointFromConfig()
 
 }

api/endpoint_test.go

@@ -18,6 +18,7 @@ var _ = Describe("Endpoint Helper Test", func() {
 
 	const (
 		fakeApiEndpoint = "autoscaler.boshlite.com"
+		fakeUserAgent   = "test-agent"
 	)
 
 	var (
@@ -50,18 +51,18 @@ var _ = Describe("Endpoint Helper Test", func() {
 
 			cliConnection.ApiEndpointReturns(apiServer.URL(), nil)
 			cliConnection.IsSSLDisabledReturns(false, nil)
-			cfclient, err = NewCFClient(cliConnection)
+			cfclient, err = NewCFClient(cliConnection, fakeUserAgent)
 			Expect(err).NotTo(HaveOccurred())
 		})
 
 		Context("When endpoint is valid", func() {
 			BeforeEach(func() {
-				err = SetEndpoint(cfclient, apiServer.URL()+"/", false)
+				err = SetEndpoint(cfclient, apiServer.URL()+"/", false, fakeUserAgent)
 				Expect(err).NotTo(HaveOccurred())
 			})
 
 			It("Set a valid json to config file", func() {
-				err = SetEndpoint(cfclient, apiServer.URL(), false)
+				err = SetEndpoint(cfclient, apiServer.URL(), false, fakeUserAgent)
 				Expect(err).NotTo(HaveOccurred())
 
 				content, err = ioutil.ReadFile(configFilePath)
@@ -80,11 +81,11 @@ var _ = Describe("Endpoint Helper Test", func() {
 			BeforeEach(func() {
 				cliConnection.ApiEndpointReturns("api.bosh-lite.com", nil)
 				cliConnection.IsSSLDisabledReturns(false, nil)
-				cfclient, err = NewCFClient(cliConnection)
+				cfclient, err = NewCFClient(cliConnection, fakeUserAgent)
 				Expect(err).NotTo(HaveOccurred())
 			})
 			It("it fails", func() {
-				err = SetEndpoint(cfclient, apiServer.URL(), false)
+				err = SetEndpoint(cfclient, apiServer.URL(), false, fakeUserAgent)
 				Expect(err).To(HaveOccurred())
 			})
 		})
@@ -97,7 +98,7 @@ var _ = Describe("Endpoint Helper Test", func() {
 			})
 
 			It("it fails", func() {
-				err = SetEndpoint(cfclient, apiServer.URL(), false)
+				err = SetEndpoint(cfclient, apiServer.URL(), false, fakeUserAgent)
 				Expect(err).To(HaveOccurred())
 			})
 		})
@@ -131,7 +132,7 @@ var _ = Describe("Endpoint Helper Test", func() {
 
 			cliConnection.ApiEndpointReturns(apiServer.URL(), nil)
 			cliConnection.IsSSLDisabledReturns(false, nil)
-			cfclient, err = NewCFClient(cliConnection)
+			cfclient, err = NewCFClient(cliConnection, fakeUserAgent)
 			Expect(err).NotTo(HaveOccurred())
 		})
 
@@ -144,7 +145,7 @@ var _ = Describe("Endpoint Helper Test", func() {
 			})
 
 			It("Return the existing URL when it's domain still consistent with the current cf domain", func() {
-				endpoint, err = GetEndpoint(cfclient)
+				endpoint, err = GetEndpoint(cfclient, fakeUserAgent)
 				Expect(err).NotTo(HaveOccurred())
 				Expect(endpoint.URL).Should(Equal(apiServer.URL()))
 			})
@@ -158,7 +159,7 @@ var _ = Describe("Endpoint Helper Test", func() {
 				})
 
 				It("Clear staled setting and return the default autoscaler endpoint if it does work ", func() {
-					endpoint, err = GetEndpoint(cfclient)
+					endpoint, err = GetEndpoint(cfclient, fakeUserAgent)
 					Expect(err).NotTo(HaveOccurred())
 					Expect(endpoint.URL).Should(Equal(apiServer.URL()))
 				})
@@ -171,7 +172,7 @@ var _ = Describe("Endpoint Helper Test", func() {
 					})
 
 					It("Clear staled setting and set the endpoint to empty", func() {
-						endpoint, err = GetEndpoint(cfclient)
+						endpoint, err = GetEndpoint(cfclient, fakeUserAgent)
 						Expect(err).NotTo(HaveOccurred())
 						Expect(endpoint.URL).Should(Equal(""))
 					})
@@ -187,7 +188,7 @@ var _ = Describe("Endpoint Helper Test", func() {
 			})
 
 			It("Return a default URL when it is an valid autoscaler api server", func() {
-				endpoint, err = GetEndpoint(cfclient)
+				endpoint, err = GetEndpoint(cfclient, fakeUserAgent)
 				Expect(err).NotTo(HaveOccurred())
 				Expect(endpoint.URL).Should(Equal(apiServer.URL()))
 			})
@@ -201,7 +202,7 @@ var _ = Describe("Endpoint Helper Test", func() {
 				})
 
 				It("Return empty string ", func() {
-					endpoint, err = GetEndpoint(cfclient)
+					endpoint, err = GetEndpoint(cfclient, fakeUserAgent)
 					Expect(err).NotTo(HaveOccurred())
 					Expect(endpoint.URL).Should(Equal(""))
 				})
@@ -219,7 +220,7 @@ var _ = Describe("Endpoint Helper Test", func() {
 				})
 
 				It("Clear the wrong setting and return the default autoscaler endpoint if it works", func() {
-					endpoint, err = GetEndpoint(cfclient)
+					endpoint, err = GetEndpoint(cfclient, fakeUserAgent)
 					Expect(err).NotTo(HaveOccurred())
 					Expect(endpoint.URL).Should(Equal(apiServer.URL()))
 				})
@@ -235,7 +236,7 @@ var _ = Describe("Endpoint Helper Test", func() {
 				})
 
 				It("Clear the wrong setting and return the default autoscaler endpoint if it works", func() {
-					endpoint, err = GetEndpoint(cfclient)
+					endpoint, err = GetEndpoint(cfclient, fakeUserAgent)
 					Expect(err).NotTo(HaveOccurred())
 					Expect(endpoint.URL).Should(Equal(apiServer.URL()))
 				})

commands/attach_policy.go

@@ -21,16 +21,16 @@ type AttachPolicyPositionalArgs struct {
 }
 
 func (command AttachPolicyCommand) Execute([]string) error {
-	return CreatePolicy(AutoScaler.CLIConnection, command.RequiredlArgs.AppName, command.RequiredlArgs.PolicyFile)
+	return CreatePolicy(AutoScaler.CLIConnection, command.RequiredlArgs.AppName, command.RequiredlArgs.PolicyFile, AutoScaler.UserAgent)
 }
 
-func CreatePolicy(cliConnection api.Connection, appName string, policyFile string) error {
+func CreatePolicy(cliConnection api.Connection, appName string, policyFile string, userAgent string) error {
 
-	cfclient, err := api.NewCFClient(cliConnection)
+	cfclient, err := api.NewCFClient(cliConnection, userAgent)
 	if err != nil {
 		return err
 	}
-	endpoint, err := api.GetEndpoint(cfclient)
+	endpoint, err := api.GetEndpoint(cfclient, userAgent)
 	if err != nil {
 		return err
 	}
@@ -43,7 +43,7 @@ func CreatePolicy(cliConnection api.Connection, appName string, policyFile strin
 		return err
 	}
 
-	apihelper := api.NewAPIHelper(endpoint, cfclient, os.Getenv("CF_TRACE"))
+	apihelper := api.NewAPIHelper(endpoint, cfclient, os.Getenv("CF_TRACE"), userAgent)
 
 	ui.SayMessage(ui.AttachPolicyHint, appName)
 	contents, err := ioutil.ReadFile(policyFile)

commands/autoscaler.go

@@ -6,6 +6,7 @@ import (
 
 type AutoScalerCmds struct {
 	CLIConnection api.Connection
+	UserAgent     string
 
 	API          ApiCommand          `command:"autoscaling-api" description:"Set or view AutoScaler service API endpoint"`
 	Policy       PolicyCommand       `command:"autoscaling-policy" description:"Retrieve the scaling policy of an application"`

commands/detach_policy.go

@@ -17,17 +17,17 @@ type DetachPolicyPositionalArgs struct {
 }
 
 func (command DetachPolicyCommand) Execute([]string) error {
-	return DetachPolicy(AutoScaler.CLIConnection, command.RequiredlArgs.AppName)
+	return DetachPolicy(AutoScaler.CLIConnection, command.RequiredlArgs.AppName, AutoScaler.UserAgent)
 }
 
-func DetachPolicy(cliConnection api.Connection, appName string) error {
+func DetachPolicy(cliConnection api.Connection, appName string, userAgent string) error {
 
-	cfclient, err := api.NewCFClient(cliConnection)
+	cfclient, err := api.NewCFClient(cliConnection, userAgent)
 	if err != nil {
 		return err
 	}
 
-	endpoint, err := api.GetEndpoint(cfclient)
+	endpoint, err := api.GetEndpoint(cfclient, userAgent)
 	if err != nil {
 		return err
 	}
@@ -40,7 +40,7 @@ func DetachPolicy(cliConnection api.Connection, appName string) error {
 		return err
 	}
 
-	apihelper := api.NewAPIHelper(endpoint, cfclient, os.Getenv("CF_TRACE"))
+	apihelper := api.NewAPIHelper(endpoint, cfclient, os.Getenv("CF_TRACE"), userAgent)
 
 	ui.SayMessage(ui.DetachPolicyHint, appName)
 	err = apihelper.DeletePolicy()