User agent (#335)

* chore(deps): bump github.com/docker/distribution

Bumps [github.com/docker/distribution](https://github.com/docker/distribution) from 2.8.1+incompatible to 2.8.2+incompatible.
- [Release notes](https://github.com/docker/distribution/releases)
- [Commits](distribution/distribution@v2.8.1...v2.8.2)

---
updated-dependencies:
- dependency-name: github.com/docker/distribution
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>

* feat(client): add user agent
---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Author: filiptubic

.goreleaser.yml

@@ -14,7 +14,7 @@ builds:
     flags:
       - -trimpath
     ldflags:
-      - '-s -w -X main.version={{.Version}} -X main.commit={{.Commit}}'
+      - '-s -w -X github.com/draios/terraform-provider-sysdig/buildinfo.Version={{.Version}} -X main.commit={{.Commit}}'
     goos:
       - freebsd
       - windows

buildinfo/info.go

@@ -1,6 +1,7 @@
 package buildinfo
 
 var (
+	Version       = "dev"
 	SysdigMonitor bool
 	SysdigSecure  bool
 	IBMMonitor    bool

go.mod

@@ -21,7 +21,7 @@ require (
 	github.com/containerd/stargz-snapshotter/estargz v0.10.1 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/docker/cli v20.10.12+incompatible // indirect
-	github.com/docker/distribution v2.8.1+incompatible // indirect
+	github.com/docker/distribution v2.8.2+incompatible // indirect
 	github.com/docker/docker v20.10.24+incompatible // indirect
 	github.com/docker/docker-credential-helpers v0.6.4 // indirect
 	github.com/falcosecurity/kilt/pkg v0.0.0-20211102134108-7c97c711c0d2 // indirect

go.sum

@@ -295,8 +295,8 @@ github.com/docker/cli v20.10.12+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hH
 github.com/docker/distribution v0.0.0-20190905152932-14b96e55d84c/go.mod h1:0+TTO4EOBfRPhZXAeF1Vu+W3hHZ8eLp8PgKVZlcvtFY=
 github.com/docker/distribution v2.7.1-0.20190205005809-0d3efadf0154+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w=
 github.com/docker/distribution v2.7.1+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w=
-github.com/docker/distribution v2.8.1+incompatible h1:Q50tZOPR6T/hjNsyc9g8/syEs6bk8XXApsHjKukMl68=
-github.com/docker/distribution v2.8.1+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w=
+github.com/docker/distribution v2.8.2+incompatible h1:T3de5rq0dB1j30rp0sA2rER+m322EBzniBPB6ZIzuh8=
+github.com/docker/distribution v2.8.2+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w=
 github.com/docker/docker v1.4.2-0.20190924003213-a8608b5b67c7/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk=
 github.com/docker/docker v20.10.12+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk=
 github.com/docker/docker v20.10.24+incompatible h1:Ugvxm7a8+Gz6vqQYQQ2W7GYq5EUPaAiuPgIfVyI3dYE=

sysdig/internal/client/v2/client.go

@@ -7,6 +7,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"github.com/draios/terraform-provider-sysdig/buildinfo"
 	"github.com/hashicorp/go-retryablehttp"
 	"github.com/jmespath/go-jmespath"
 	"github.com/spf13/cast"
@@ -18,13 +19,15 @@ import (
 )
 
 const (
-	GetMePath                 = "/api/users/me"
-	AuthorizationHeader       = "Authorization"
-	ContentTypeHeader         = "Content-Type"
-	SysdigProviderHeader      = "Sysdig-Provider"
-	SysdigProviderHeaderValue = "Terraform"
-	ContentTypeJSON           = "application/json"
-	ContentTypeFormURLEncoded = "x-www-form-urlencoded"
+	GetMePath                  = "/api/users/me"
+	UserAgentHeader            = "User-Agent"
+	AuthorizationHeader        = "Authorization"
+	ContentTypeHeader          = "Content-Type"
+	SysdigProviderHeader       = "Sysdig-Provider"
+	SysdigProviderHeaderValue  = "Terraform"
+	SysdigUserAgentHeaderValue = "SysdigTerraform"
+	ContentTypeJSON            = "application/json"
+	ContentTypeFormURLEncoded  = "x-www-form-urlencoded"
 )
 
 var (
@@ -92,6 +95,8 @@ func Marshal[T any](data T) (io.Reader, error) {
 }
 
 func request(httpClient *http.Client, cfg *config, request *http.Request) (*http.Response, error) {
+	request.Header.Set(UserAgentHeader, fmt.Sprintf("%s/%s", SysdigUserAgentHeaderValue, buildinfo.Version))
+
 	if cfg.extraHeaders != nil {
 		for key, value := range cfg.extraHeaders {
 			request.Header.Set(key, value)

sysdig/internal/client/v2/client_test.go

@@ -4,8 +4,10 @@ package v2
 
 import (
 	"encoding/json"
+	"fmt"
 	"io"
 	"net/http"
+	"net/http/httptest"
 	"strings"
 	"testing"
 )
@@ -91,3 +93,28 @@ func TestClient_ErrorFromResponse(t *testing.T) {
 		t.Errorf("expected err %v, got %v", expected, err)
 	}
 }
+
+func TestRequest(t *testing.T) {
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		agent := r.Header.Get(UserAgentHeader)
+		agentParts := strings.Split(agent, "/")
+		if len(agentParts) != 2 || agentParts[0] != SysdigUserAgentHeaderValue || agentParts[1] == "" {
+			t.Errorf("invalid user agent: %v", agent)
+		}
+	}))
+
+	cfg := &config{
+		url: server.URL,
+	}
+	client := newHTTPClient(cfg)
+
+	r, err := http.NewRequest(http.MethodGet, fmt.Sprintf("%s/", cfg.url), nil)
+	if err != nil {
+		t.Errorf("failed to create request, %v", err)
+	}
+
+	_, err = request(client, cfg, r)
+	if err != nil {
+		t.Errorf("failed to send request, %v", err)
+	}
+}