Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add support for user-agent configuration #232

Merged
merged 1 commit into from
Jan 18, 2023
Merged

feat: add support for user-agent configuration #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@ var (
//go:embed version.txt
versionString string
// metadataString indiciates additional build or distribution metadata.
metadataString string
userAgent string
metadataString string
defaultUserAgent string
)

func init() {
versionString = semanticVersion()
userAgent = "alloy-db-auth-proxy/" + versionString
defaultUserAgent = "alloy-db-auth-proxy/" + versionString
}

// semanticVersion returns the version of the proxy including an compile-time
Expand Down Expand Up @@ -98,6 +98,7 @@ type Command struct {
httpAddress string
httpPort string
quiet bool
otherUserAgents string

// impersonationChain is a comma separated list of one or more service
// accounts. The first entry in the chain is the impersonation target. Any
Expand Down Expand Up @@ -320,7 +321,7 @@ func NewCommand(opts ...Option) *Command {
logger: logger,
cleanup: func() error { return nil },
conf: &proxy.Config{
UserAgent: userAgent,
UserAgent: defaultUserAgent,
},
}
for _, o := range opts {
Expand Down Expand Up @@ -355,6 +356,8 @@ func NewCommand(opts ...Option) *Command {
pflags := cmd.PersistentFlags()

// Global-only flags
pflags.StringVar(&c.otherUserAgents, "user-agent", "",
"Space separated list of additional user agents, e.g. cloud-sql-proxy-operator/0.0.1")
pflags.StringVarP(&c.conf.Token, "token", "t", "",
"Bearer token used for authorization.")
pflags.StringVarP(&c.conf.CredentialsFile, "credentials-file", "c", "",
Expand Down Expand Up @@ -517,6 +520,11 @@ func parseConfig(cmd *Command, conf *proxy.Config, args []string) error {
cmd.logger.Infof("Ignoring --disable-traces as --telemetry-project was not set")
}

if userHasSet("user-agent") {
defaultUserAgent += " " + cmd.otherUserAgents
conf.UserAgent = defaultUserAgent
}

if cmd.impersonationChain != "" {
accts := strings.Split(cmd.impersonationChain, ",")
conf.ImpersonateTarget = accts[0]
Expand Down
40 changes: 39 additions & 1 deletion cmd/root_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"net/http"
"os"
"path/filepath"
"strings"
"sync"
"testing"
"time"
Expand Down Expand Up @@ -52,7 +53,7 @@ func invokeProxyCommand(args []string) (*Command, error) {

func withDefaults(c *proxy.Config) *proxy.Config {
if c.UserAgent == "" {
c.UserAgent = userAgent
c.UserAgent = defaultUserAgent
}
if c.Addr == "" {
c.Addr = "127.0.0.1"
Expand All @@ -77,6 +78,43 @@ func withDefaults(c *proxy.Config) *proxy.Config {
return c
}

func TestUserAgentWithVersionEnvVar(t *testing.T) {
os.Setenv("ALLOYDB_PROXY_USER_AGENT", "some-runtime/0.0.1")
defer os.Unsetenv("ALLOYDB_PROXY_USER_AGENT")

cmd, err := invokeProxyCommand([]string{
"projects/proj/locations/region/clusters/clust/instances/inst",
})
if err != nil {
t.Fatalf("want error = nil, got = %v", err)
}

want := "some-runtime/0.0.1"
got := cmd.conf.UserAgent
if !strings.Contains(got, want) {
t.Errorf("expected user agent to contain: %v; got: %v", want, got)
}
}

func TestUserAgent(t *testing.T) {
cmd, err := invokeProxyCommand(
[]string{
"--user-agent",
"some-runtime/0.0.1",
"projects/proj/locations/region/clusters/clust/instances/inst",
},
)
if err != nil {
t.Fatalf("want error = nil, got = %v", err)
}

want := "some-runtime/0.0.1"
got := cmd.conf.UserAgent
if !strings.Contains(got, want) {
t.Errorf("expected userAgent to contain: %v; got: %v", want, got)
}
}

func TestNewCommandArguments(t *testing.T) {
tcs := []struct {
desc string
Expand Down