fix: expose version and user agent to consumers (#158)

useragent/useragent.go

@@ -0,0 +1,31 @@
+package useragent
+
+import (
+	"context"
+
+	"github.com/docker/attest/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)"
+}

useragent/useragent_test.go

@@ -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))
+	}
+}