DEVPROD-13240 staging environment header for the CLI (#8534)

config.go

@@ -33,7 +33,7 @@ var (
 
 	// ClientVersion is the commandline version string used to control updating
 	// the CLI. The format is the calendar date (YYYY-MM-DD).
-	ClientVersion = "2024-12-05"
+	ClientVersion = "2024-12-06"
 
 	// Agent version to control agent rollover. The format is the calendar date
 	// (YYYY-MM-DD).

globals.go

@@ -559,6 +559,7 @@ const (
 	ContentLengthHeader = "Content-Length"
 	APIUserHeader       = "Api-User"
 	APIKeyHeader        = "Api-Key"
+	EnvironmentHeader   = "X-Evergreen-Environment"
 )
 
 const (

operations/http.go

@@ -27,12 +27,13 @@ import (
 // legacyClient manages requests to the API server endpoints, and unmarshaling the results into
 // usable structures.
 type legacyClient struct {
-	APIRoot    string
-	httpClient http.Client
-	User       string
-	APIKey     string
-	APIRootV2  string
-	UIRoot     string
+	APIRoot            string
+	httpClient         http.Client
+	User               string
+	APIKey             string
+	APIRootV2          string
+	UIRoot             string
+	stagingEnvironment string
 }
 
 // APIError is an implementation of error for reporting unexpected results from API calls.
@@ -82,6 +83,10 @@ func (ac *legacyClient) doReq(method, path string, apiVersion int, body io.Reade
 
 	req.Header.Add(evergreen.APIKeyHeader, ac.APIKey)
 	req.Header.Add(evergreen.APIUserHeader, ac.User)
+	if ac.stagingEnvironment != "" {
+		req.Header.Add(evergreen.EnvironmentHeader, ac.stagingEnvironment)
+	}
+
 	resp, err := ac.httpClient.Do(req)
 	if err != nil {
 		return nil, err

operations/model.go

@@ -91,6 +91,9 @@ type ClientSettings struct {
 	LoadedFrom            string              `json:"-" yaml:"-"`
 	DisableAutoDefaulting bool                `json:"disable_auto_defaulting" yaml:"disable_auto_defaulting"`
 	ProjectsForDirectory  map[string]string   `json:"projects_for_directory,omitempty" yaml:"projects_for_directory,omitempty"`
+
+	// StagingEnvironment configures which staging environment to point to.
+	StagingEnvironment string `json:"staging_environment,omitempty" yaml:"staging_environment,omitempty"`
 }
 
 func NewClientSettings(fn string) (*ClientSettings, error) {
@@ -194,19 +197,21 @@ func (s *ClientSettings) getLegacyClients() (*legacyClient, *legacyClient, error
 	}
 
 	ac := &legacyClient{
-		APIRoot:   s.APIServerHost,
-		APIRootV2: s.APIServerHost + "/rest/v2",
-		User:      s.User,
-		APIKey:    s.APIKey,
-		UIRoot:    s.UIServerHost,
+		APIRoot:            s.APIServerHost,
+		APIRootV2:          s.APIServerHost + "/rest/v2",
+		User:               s.User,
+		APIKey:             s.APIKey,
+		UIRoot:             s.UIServerHost,
+		stagingEnvironment: s.StagingEnvironment,
 	}
 
 	rc := &legacyClient{
-		APIRoot:   apiURL.Scheme + "://" + apiURL.Host + "/rest/v1",
-		APIRootV2: apiURL.Scheme + "://" + apiURL.Host + "/rest/v2",
-		User:      s.User,
-		APIKey:    s.APIKey,
-		UIRoot:    s.UIServerHost,
+		APIRoot:            apiURL.Scheme + "://" + apiURL.Host + "/rest/v1",
+		APIRootV2:          apiURL.Scheme + "://" + apiURL.Host + "/rest/v2",
+		User:               s.User,
+		APIKey:             s.APIKey,
+		UIRoot:             s.UIServerHost,
+		stagingEnvironment: s.StagingEnvironment,
 	}
 
 	return ac, rc, nil