CLOUDP-202471: add support to track GH Actions telemetry (#2557)

Author: matt-condon

internal/config/profile.go

@@ -69,13 +69,18 @@ const (
 	TelemetryEnabledProperty     = "telemetry_enabled"
 	MongoCLI                     = "mongocli"
 	AtlasCLI                     = "atlascli"
+	ContainerizedHostNameEnv     = "MONGODB_ATLAS_IS_CONTAINERIZED"
+	GitHubActionsHostNameEnv     = "GITHUB_ACTIONS"
+	AtlasActionHostNameEnv       = "ATLAS_GITHUB_ACTION"
 	NativeHostName               = "native"
-	ContainerHostName            = "container"
+	DockerContainerHostName      = "container"
+	GitHubActionsHostName        = "all_github_actions"
+	AtlasActionHostName          = "atlascli_github_action"
 )
 
 var (
 	ToolName       = MongoCLI
-	HostName       = NativeHostName
+	HostName       = getConfigHostnameFromEnvs()
 	UserAgent      = fmt.Sprintf("%s/%s (%s;%s;%s)", ToolName, version.Version, runtime.GOOS, runtime.GOARCH, HostName)
 	defaultProfile = newProfile()
 )
@@ -175,6 +180,51 @@ func Exists(name string) bool {
 	return search.StringInSlice(List(), name)
 }
 
+// getConfigHostnameFromEnvs patches the agent hostname based on set env vars.
+func getConfigHostnameFromEnvs() string {
+	var builder strings.Builder
+
+	envVars := []struct {
+		envName  string
+		hostName string
+	}{
+		{AtlasActionHostNameEnv, AtlasActionHostName},
+		{GitHubActionsHostNameEnv, GitHubActionsHostName},
+		{ContainerizedHostNameEnv, DockerContainerHostName},
+	}
+
+	for _, envVar := range envVars {
+		if envIsTrue(envVar.envName) {
+			appendToHostName(&builder, envVar.hostName)
+		} else {
+			appendToHostName(&builder, "-")
+		}
+	}
+	configHostName := builder.String()
+
+	if isDefaultHostName(configHostName) {
+		return NativeHostName
+	}
+	return configHostName
+}
+
+func envIsTrue(env string) bool {
+	return IsTrue(os.Getenv(env))
+}
+
+func appendToHostName(builder *strings.Builder, configVal string) {
+	if builder.Len() > 0 {
+		builder.WriteString("|")
+	}
+	builder.WriteString(configVal)
+}
+
+// isDefaultHostName checks if the hostname is the default placeholder.
+func isDefaultHostName(hostname string) bool {
+	// Using strings.Count for a more dynamic approach.
+	return strings.Count(hostname, "-") == strings.Count(hostname, "|")+1
+}
+
 func newProfile() *Profile {
 	configDir, err := CLIConfigHome()
 	np := &Profile{

internal/config/profile_test.go

@@ -20,6 +20,8 @@ import (
 	"fmt"
 	"os"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 func TestConfig_MongoCLIConfigHome(t *testing.T) {
@@ -159,3 +161,74 @@ func TestConfig_IsTrue(t *testing.T) {
 		}
 	}
 }
+
+func Test_getConfigHostname(t *testing.T) {
+	type fields struct {
+		containerizedEnv string
+		atlasActionEnv   string
+		ghActionsEnv     string
+	}
+	tests := []struct {
+		name             string
+		fields           fields
+		expectedHostName string
+	}{
+		{
+			name: "sets native hostname when no hostname env var is set",
+			fields: fields{
+				containerizedEnv: "",
+				atlasActionEnv:   "",
+				ghActionsEnv:     "",
+			},
+			expectedHostName: NativeHostName,
+		},
+		{
+			name: "sets container hostname when containerized env var is set",
+			fields: fields{
+				containerizedEnv: "true",
+				atlasActionEnv:   "",
+				ghActionsEnv:     "",
+			},
+			expectedHostName: "-|-|" + DockerContainerHostName,
+		},
+		{
+			name: "sets atlas action hostname when containerized env var is set",
+			fields: fields{
+				containerizedEnv: "",
+				atlasActionEnv:   "true",
+				ghActionsEnv:     "",
+			},
+			expectedHostName: AtlasActionHostName + "|-|-",
+		},
+		{
+			name: "sets github actions hostname when action env var is set",
+			fields: fields{
+				containerizedEnv: "",
+				atlasActionEnv:   "",
+				ghActionsEnv:     "true",
+			},
+			expectedHostName: "-|" + GitHubActionsHostName + "|-",
+		},
+		{
+			name: "sets actions and containerized hostnames when both env vars are set",
+			fields: fields{
+				containerizedEnv: "true",
+				atlasActionEnv:   "true",
+				ghActionsEnv:     "true",
+			},
+			expectedHostName: AtlasActionHostName + "|" + GitHubActionsHostName + "|" + DockerContainerHostName,
+		},
+	}
+	for _, tt := range tests {
+		fields := tt.fields
+		expectedHostName := tt.expectedHostName
+		t.Run(tt.name, func(t *testing.T) {
+			t.Setenv(AtlasActionHostNameEnv, fields.atlasActionEnv)
+			t.Setenv(GitHubActionsHostNameEnv, fields.ghActionsEnv)
+			t.Setenv(ContainerizedHostNameEnv, fields.containerizedEnv)
+			actualHostName := getConfigHostnameFromEnvs()
+
+			assert.Equal(t, expectedHostName, actualHostName)
+		})
+	}
+}

internal/oauth/oauth.go

@@ -17,8 +17,6 @@ package oauth
 import (
 	"net"
 	"net/http"
-	"os"
-	"strings"
 	"time"
 
 	"github.com/mongodb/mongodb-atlas-cli/internal/config"
@@ -58,13 +56,6 @@ const (
 	GovClientID = "0oabtyfelbTBdoucy297" // GovClientID for production
 )
 
-func changeHostNameToContainer() {
-	if !strings.Contains(config.UserAgent, config.ContainerHostName) {
-		config.UserAgent = strings.ReplaceAll(config.UserAgent, config.HostName, config.ContainerHostName)
-		config.HostName = config.ContainerHostName
-	}
-}
-
 func FlowWithConfig(c ServiceGetter) (*auth.Config, error) {
 	client := http.DefaultClient
 	client.Transport = defaultTransport
@@ -75,10 +66,6 @@ func FlowWithConfig(c ServiceGetter) (*auth.Config, error) {
 	if c.ClientID() != "" {
 		id = c.ClientID()
 	}
-	runningFromContainer, runningFromContainerIsSet := os.LookupEnv("MONGODB_ATLAS_IS_CONTAINERIZED")
-	if runningFromContainerIsSet && runningFromContainer == "true" {
-		changeHostNameToContainer()
-	}
 
 	authOpts := []auth.ConfigOpt{
 		auth.SetUserAgent(config.UserAgent),