feature!: support for setting HTTP User-Agent header (#157)

* feature!: support for setting HTTP User-Agent header

* fix lint

* fix e2e

* refactor: move http.go to internal/util/useragent package and rename functions to Get and Set

* Move packages and use attest version
This commit is contained in:
James Carnegie
2024-09-09 14:22:17 +01:00
committed by GitHub
parent ed0ae8ecf6
commit b4e6767cc6
33 changed files with 307 additions and 340 deletions

View File

@@ -0,0 +1,31 @@
package useragent
import (
"context"
"github.com/docker/attest/internal/version"
)
type userAgentKeyType string
const (
userAgentKey userAgentKeyType = "attest-user-agent"
defaultUserAgent string = "attest/unknown (docker)"
)
func Set(ctx context.Context, userAgent string) context.Context {
return context.WithValue(ctx, userAgentKey, userAgent)
}
// Get retrieves the HTTP user agent from the context.
func Get(ctx context.Context) string {
if ua, ok := ctx.Value(userAgentKey).(string); ok {
return ua
}
version, err := version.Get()
if err != nil || version == nil {
return defaultUserAgent
}
return "attest/" + version.String() + " (docker)"
}

View File

@@ -0,0 +1,19 @@
package useragent
import (
"context"
"testing"
)
// test the user agent setting and getting.
func TestSetUserAgent(t *testing.T) {
ctx := context.Background()
if Get(ctx) != defaultUserAgent {
t.Errorf("expected user agent to be '%s', got %q", defaultUserAgent, Get(ctx))
}
ctx = Set(ctx, "test-agent")
if Get(ctx) != "test-agent" {
t.Errorf("expected user agent to be 'test-agent', got %q", Get(ctx))
}
}