Allow configuration of API host

internal/constants/constants.go

@@ -181,9 +181,6 @@ const SvcLogRotateIntervalEnvVarName = "ACTIVESTATE_CLI_LOG_ROTATE_INTERVAL_MS"
 // DisableActivateEventsEnvVarName is the environment variable used to disable events when activating or checking out a project
 const DisableActivateEventsEnvVarName = "ACTIVESTATE_CLI_DISABLE_ACTIVATE_EVENTS"
 
-// APIUpdateInfoURL is the URL for our update info server
-const APIUpdateInfoURL = "https://platform.activestate.com/sv/state-update/api/v1"
-
 // APIUpdateURL is the URL for our update files
 const APIUpdateURL = "https://state-tool.activestate.com/update/state"
 
@@ -261,6 +258,9 @@ const VulnerabilitiesAPIPath = "/v13s/v1/graphql"
 // HasuraInventoryAPIPath is the path used for the hasura inventory api
 const HasuraInventoryAPIPath = "/sv/hasura-inventory/v1/graphql"
 
+// UpdateInfoAPIPath is the path used for the update info api
+const UpdateInfoAPIPath = "/sv/state-update/api/v1"
+
 // NotificationsInfoURL is the URL we check against to see what versions are deprecated
 const NotificationsInfoURL = "https://state-tool.s3.amazonaws.com/messages.json"
 
@@ -409,6 +409,9 @@ const SecurityPromptConfig = "security.prompt.enabled"
 // SecurityPromptLevelConfig is the config key used to determine the level of security prompts
 const SecurityPromptLevelConfig = "security.prompt.level"
 
+// APIHostConfig is the config key used to determine the api host
+const APIHostConfig = "api.host"
+
 // SvcAppName is the name we give our state-svc application
 const SvcAppName = "State Service"
 

internal/runbits/checkout/checkout.go

@@ -14,6 +14,7 @@ import (
 	"github.com/ActiveState/cli/internal/runbits/buildscript"
 	"github.com/ActiveState/cli/internal/runbits/git"
 	"github.com/ActiveState/cli/pkg/localcommit"
+	"github.com/ActiveState/cli/pkg/platform/api"
 	"github.com/ActiveState/cli/pkg/platform/api/mono/mono_models"
 	"github.com/ActiveState/cli/pkg/platform/authentication"
 	"github.com/ActiveState/cli/pkg/platform/model"
@@ -193,6 +194,7 @@ func CreateProjectFiles(checkoutPath, cachePath, owner, name, branch, commitID,
 			Language:   language,
 			Cache:      cachePath,
 			Portable:   portable,
+			Host:       api.HostOverride(),
 		})
 		if err != nil {
 			if osutils.IsAccessDeniedError(err) {

internal/runbits/runtime/runtime.go

@@ -27,6 +27,7 @@ import (
 	"github.com/ActiveState/cli/internal/runbits/runtime/trigger"
 	"github.com/ActiveState/cli/pkg/buildplan"
 	"github.com/ActiveState/cli/pkg/localcommit"
+	"github.com/ActiveState/cli/pkg/platform/api"
 	"github.com/ActiveState/cli/pkg/platform/model"
 	bpModel "github.com/ActiveState/cli/pkg/platform/model/buildplanner"
 	"github.com/ActiveState/cli/pkg/project"
@@ -264,7 +265,7 @@ func Update(
 		// Build progress URL is of the form
 		// https://<host>/<owner>/<project>/distributions?branch=<branch>&commitID=<commitID>
 		host := constants.DefaultAPIHost
-		if hostOverride := os.Getenv(constants.APIHostEnvVarName); hostOverride != "" {
+		if hostOverride := api.HostOverride(); hostOverride != "" {
 			host = hostOverride
 		}
 		path, err := url.JoinPath(proj.Owner(), proj.Name(), constants.BuildProgressUrlPathName)

internal/runners/initialize/init.go

@@ -25,6 +25,7 @@ import (
 	"github.com/ActiveState/cli/internal/runbits/runtime"
 	"github.com/ActiveState/cli/internal/runbits/runtime/trigger"
 	"github.com/ActiveState/cli/pkg/localcommit"
+	"github.com/ActiveState/cli/pkg/platform/api"
 	"github.com/ActiveState/cli/pkg/platform/authentication"
 	"github.com/ActiveState/cli/pkg/platform/model"
 	bpModel "github.com/ActiveState/cli/pkg/platform/model/buildplanner"
@@ -186,6 +187,7 @@ func (r *Initialize) Run(params *RunParams) (rerr error) {
 		Language:  lang.String(),
 		Directory: path,
 		Private:   params.Private,
+		Host:      api.HostOverride(),
 	}
 
 	pjfile, err := projectfile.Create(createParams)

internal/testhelpers/e2e/session.go

@@ -65,6 +65,7 @@ type Session struct {
 	spawned         []*SpawnedCmd
 	ignoreLogErrors bool
 	cache           keyCache
+	cfg             *config.Instance
 }
 
 type keyCache map[string]string
@@ -203,6 +204,7 @@ func new(t *testing.T, retainDirs, updatePath bool, extraEnv ...string) *Session
 	if err := cfg.Set(constants.SecurityPromptConfig, false); err != nil {
 		require.NoError(session.T, err)
 	}
+	session.cfg = cfg
 
 	return session
 }
@@ -790,6 +792,10 @@ func (s *Session) SetupRCFileCustom(subshell subshell.SubShell) {
 	require.NoError(s.T, err)
 }
 
+func (s *Session) SetConfig(key string, value interface{}) {
+	require.NoError(s.T, s.cfg.Set(key, value))
+}
+
 func RunningOnCI() bool {
 	return condition.OnCI()
 }

internal/updater/checker.go

@@ -13,11 +13,11 @@ import (
 	"github.com/ActiveState/cli/internal/analytics"
 	anaConst "github.com/ActiveState/cli/internal/analytics/constants"
 	"github.com/ActiveState/cli/internal/analytics/dimensions"
-	"github.com/ActiveState/cli/internal/constants"
 	"github.com/ActiveState/cli/internal/errs"
 	"github.com/ActiveState/cli/internal/logging"
 	"github.com/ActiveState/cli/internal/retryhttp"
 	"github.com/ActiveState/cli/internal/rtutils/ptr"
+	"github.com/ActiveState/cli/pkg/platform/api"
 )
 
 type Configurable interface {
@@ -44,7 +44,7 @@ type Checker struct {
 }
 
 func NewDefaultChecker(cfg Configurable, an analytics.Dispatcher) *Checker {
-	infoURL := constants.APIUpdateInfoURL
+	infoURL := api.GetServiceURL(api.ServiceUpdateInfo).String()
 	if url, ok := os.LookupEnv("_TEST_UPDATE_INFO_URL"); ok {
 		infoURL = url
 	}

pkg/platform/api/settings.go

@@ -5,13 +5,19 @@ import (
 	"os"
 	"strings"
 
+	configMediator "github.com/ActiveState/cli/internal/mediators/config"
 	"github.com/ActiveState/cli/pkg/projectfile"
 
 	"github.com/ActiveState/cli/internal/condition"
+	"github.com/ActiveState/cli/internal/config"
 	"github.com/ActiveState/cli/internal/constants"
 	"github.com/ActiveState/cli/internal/logging"
 )
 
+func init() {
+	configMediator.RegisterOption(constants.APIHostConfig, configMediator.String, "")
+}
+
 // Service records available api services
 type Service string
 
@@ -49,6 +55,9 @@ const (
 	// ServiceHasuraInventory is the Hasura service for inventory information.
 	ServiceHasuraInventory = "hasura-inventory"
 
+	// ServiceUpdateInfo is the service for update info
+	ServiceUpdateInfo = "update-info"
+
 	// TestingPlatform is the API host used by tests so-as not to affect production.
 	TestingPlatform = ".testing.tld"
 )
@@ -109,6 +118,11 @@ var urlsByService = map[Service]*url.URL{
 		Host:   constants.DefaultAPIHost,
 		Path:   constants.HasuraInventoryAPIPath,
 	},
+	ServiceUpdateInfo: {
+		Scheme: "https",
+		Host:   constants.DefaultAPIHost,
+		Path:   constants.UpdateInfoAPIPath,
+	},
 }
 
 // GetServiceURL returns the URL for the given service
@@ -121,7 +135,7 @@ func GetServiceURL(service Service) *url.URL {
 		serviceURL.Host = *host
 	}
 
-	if insecure := os.Getenv(constants.APIInsecureEnvVarName); insecure == "true" {
+	if insecure := getProjectHostFromEnv(); insecure == "true" {
 		if serviceURL.Scheme == "https" || serviceURL.Scheme == "wss" {
 			serviceURL.Scheme = strings.TrimRight(serviceURL.Scheme, "s")
 		}
@@ -142,8 +156,9 @@ func GetServiceURL(service Service) *url.URL {
 }
 
 func getProjectHost(service Service) *string {
-	if apiHost := os.Getenv(constants.APIHostEnvVarName); apiHost != "" {
-		return &apiHost
+	if host := HostOverride(); host != "" {
+		logging.Debug("Using host override: %s", host)
+		return &host
 	}
 
 	if condition.InUnitTest() {
@@ -164,11 +179,35 @@ func getProjectHost(service Service) *string {
 	return &url.Host
 }
 
+func getProjectHostFromConfig() string {
+	cfg, err := config.New()
+	if err != nil {
+		return ""
+	}
+	return cfg.GetString(constants.APIHostConfig)
+}
+
+func getProjectHostFromEnv() string {
+	return os.Getenv(constants.APIHostEnvVarName)
+}
+
+func HostOverride() string {
+	if apiHost := getProjectHostFromEnv(); apiHost != "" {
+		return apiHost
+	}
+
+	if apiHost := getProjectHostFromConfig(); apiHost != "" {
+		return apiHost
+	}
+
+	return ""
+}
+
 // GetPlatformURL returns a generic Platform URL for the given path.
 // This is for retrieving non-service URLs (e.g. signup URL).
 func GetPlatformURL(path string) *url.URL {
 	host := constants.DefaultAPIHost
-	if hostOverride := os.Getenv(constants.APIHostEnvVarName); hostOverride != "" {
+	if hostOverride := HostOverride(); hostOverride != "" {
 		host = hostOverride
 	}
 	return &url.URL{

pkg/projectfile/create_test.go

@@ -38,6 +38,7 @@ func Test_Create(t *testing.T) {
 				Project:   tt.args.project,
 				Directory: tt.args.directory,
 				Language:  tt.args.language,
+				Host:      "test.example.com",
 			})
 			assert.NoError(t, err)
 			configFile := filepath.Join(tempDir, constants.ConfigFileName)

pkg/projectfile/projectfile.go

@@ -922,6 +922,7 @@ type CreateParams struct {
 	ProjectURL string
 	Cache      string
 	Portable   bool
+	Host       string
 }
 
 // Create will create a new activestate.yaml with a projectURL for the given details
@@ -943,9 +944,9 @@ func createCustom(params *CreateParams, lang language.Language) (*Project, error
 
 	if params.ProjectURL == "" {
 		// Note: cannot use api.GetPlatformURL() due to import cycle.
-		host := constants.DefaultAPIHost
-		if hostOverride := os.Getenv(constants.APIHostEnvVarName); hostOverride != "" {
-			host = hostOverride
+		host := params.Host
+		if host == "" {
+			host = constants.DefaultAPIHost
 		}
 		u, err := url.Parse(fmt.Sprintf("https://%s/%s/%s", host, params.Owner, params.Project))
 		if err != nil {

test/integration/api_int_test.go

@@ -56,6 +56,77 @@ func (suite *ApiIntegrationTestSuite) TestNoApiCallsForPlainInvocation() {
 	suite.Assert().True(readLogFile, "did not read log file")
 }
 
+func (suite *ApiIntegrationTestSuite) TestAPIHostConfig_SetBeforeInvocation() {
+	suite.OnlyRunForTags(tagsuite.Critical)
+
+	ts := e2e.New(suite.T(), false)
+	defer ts.Close()
+
+	ts.SetConfig("api.host", "test.example.com")
+
+	cp := ts.SpawnWithOpts(
+		e2e.OptArgs("checkout", "doesnt/exist"),
+		e2e.OptAppendEnv("VERBOSE=true"),
+	)
+	cp.ExpectExitCode(11) // We know this command will fail, but we want to check the log file
+	ts.IgnoreLogErrors()
+
+	correctHostCount := 0
+	incorrectHostCount := 0
+	for _, path := range ts.LogFiles() {
+		contents := string(fileutils.ReadFileUnsafe(path))
+		if strings.Contains(contents, "test.example.com") {
+			correctHostCount++
+		}
+		if strings.Contains(contents, "platform.activestate.com") {
+			incorrectHostCount++
+		}
+	}
+	suite.Assert().Greater(correctHostCount, 0, "Log file should contain the configured API host 'test.example.com'")
+	suite.Assert().Equal(incorrectHostCount, 0, "Log file should not contain the default API host 'platform.activestate.com'")
+
+	// Clean up - remove the config setting
+	cp = ts.Spawn("config", "set", "api.host", "")
+	cp.Expect("Successfully")
+	cp.ExpectExitCode(0)
+}
+
+func (suite *ApiIntegrationTestSuite) TestAPIHostConfig_SetOnFirstInvocation() {
+	suite.OnlyRunForTags(tagsuite.Critical)
+
+	ts := e2e.New(suite.T(), false)
+	defer ts.Close()
+
+	cp := ts.Spawn("config", "set", "api.host", "test.example.com")
+	cp.Expect("Successfully")
+	cp.ExpectExitCode(0)
+
+	cp = ts.SpawnWithOpts(
+		e2e.OptArgs("checkout", "doesnt/exist"),
+		e2e.OptAppendEnv("VERBOSE=true"),
+	)
+	cp.ExpectExitCode(11) // We know this command will fail, but we want to check the log file
+	ts.IgnoreLogErrors()
+
+	// Because the config value is set on first invocation of the state tool the state-svc will start
+	// before the state tool has a chance to set the host in the config. This means that it will still
+	// use the default host. The above test confirms that the service will use the configured host if
+	// the config is set before the state tool is invoked.
+	correctHostCount := 0
+	for _, path := range ts.LogFiles() {
+		contents := string(fileutils.ReadFileUnsafe(path))
+		if strings.Contains(contents, "test.example.com") {
+			correctHostCount++
+		}
+	}
+	suite.Assert().Greater(correctHostCount, 0, "Log file should contain the configured API host 'test.example.com'")
+
+	// Clean up - remove the config setting
+	cp = ts.Spawn("config", "set", "api.host", "")
+	cp.Expect("Successfully")
+	cp.ExpectExitCode(0)
+}
+
 func TestApiIntegrationTestSuite(t *testing.T) {
 	suite.Run(t, new(ApiIntegrationTestSuite))
 }

test/integration/config_int_test.go

@@ -115,6 +115,38 @@ func (suite *ConfigIntegrationTestSuite) TestList() {
 
 	suite.Require().NotContains(cp.Snapshot(), constants.AsyncRuntimeConfig)
 }
+
+func (suite *ConfigIntegrationTestSuite) TestAPIHostConfig() {
+	suite.OnlyRunForTags(tagsuite.Config)
+	ts := e2e.New(suite.T(), false)
+	defer ts.Close()
+
+	cp := ts.Spawn("config", "set", "api.host", "test.example.com", "-o", "json")
+	cp.ExpectExitCode(0)
+	AssertValidJSON(suite.T(), cp)
+	cp.Expect(`{"name":"api.host","value":"test.example.com"}`)
+
+	cp = ts.Spawn("config", "get", "api.host", "-o", "json")
+	cp.ExpectExitCode(0)
+	AssertValidJSON(suite.T(), cp)
+	cp.Expect(`{"name":"api.host","value":"test.example.com"}`)
+
+	cp = ts.Spawn("config")
+	cp.Expect("api.host")
+	cp.Expect("test.example.com")
+	cp.ExpectExitCode(0)
+
+	cp = ts.Spawn("config", "set", "api.host", "", "-o", "json")
+	cp.ExpectExitCode(0)
+	AssertValidJSON(suite.T(), cp)
+	cp.Expect(`{"name":"api.host","value":""}`)
+
+	cp = ts.Spawn("config", "get", "api.host", "-o", "json")
+	cp.ExpectExitCode(0)
+	AssertValidJSON(suite.T(), cp)
+	cp.Expect(`{"name":"api.host","value":""}`)
+}
+
 func TestConfigIntegrationTestSuite(t *testing.T) {
 	suite.Run(t, new(ConfigIntegrationTestSuite))
 }