add new env to fix an issue when domainNameOverride has 3. in the end instead of two

Author: zexinwanoci

oci/provider.go

@@ -65,6 +65,7 @@ const (
 	userAgentFormatter                    = "Oracle-GoSDK/%s (go/%s; %s/%s; terraform/%s; terraform-cli/%s) %s/%s"
 	userAgentProviderNameEnv              = "USER_AGENT_PROVIDER_NAME"
 	domainNameOverrideEnv                 = "domain_name_override"
+	hasCorrectDomainNameEnv               = "has_correct_domain_name"
 	clientHostOverridesEnv                = "CLIENT_HOST_OVERRIDES"
 	customCertLocationEnv                 = "custom_cert_location"
 	acceptLocalCerts                      = "accept_local_certs"
@@ -610,8 +611,11 @@ func buildConfigureClientFn(configProvider oci_common.ConfigurationProvider, htt
 		domainNameOverride := getEnvSettingWithBlankDefault(domainNameOverrideEnv)
 
 		if domainNameOverride != "" {
-			re := regexp.MustCompile(`(.*?)[-\w]+\.\w+$`)                             // (capture: preamble) match: d0main-name . tld end-of-string
-			client.Host = re.ReplaceAllString(client.Host, "${1}"+domainNameOverride) // non-match conveniently returns original string
+			hasCorrectDomainName := getEnvSettingWithBlankDefault(hasCorrectDomainNameEnv)
+			re := regexp.MustCompile(`(.*?)[-\w]+\.\w+$`) // (capture: preamble) match: d0main-name . tld end-of-string
+			if hasCorrectDomainName == "" || !strings.HasSuffix(client.Host, hasCorrectDomainName) {
+				client.Host = re.ReplaceAllString(client.Host, "${1}"+domainNameOverride) // non-match conveniently returns original string
+			}
 		}
 
 		customCertLoc := getEnvSettingWithBlankDefault(customCertLocationEnv)

oci/provider_test.go

@@ -695,6 +695,12 @@ func TestUnitBuildClientConfigureFn_withDomainNameOverride(t *testing.T) {
 		defer os.Unsetenv(domainNameOverrideEnv)
 	}
 
+	if hadPreviousEnvVar {
+		defer os.Setenv(hasCorrectDomainNameEnv, prevEnvVar)
+	} else {
+		defer os.Unsetenv(hasCorrectDomainNameEnv)
+	}
+
 	os.Setenv(domainNameOverrideEnv, "0r4-c10ud.com")
 	assert.Equal(t, "0r4-c10ud.com", getEnvSettingWithBlankDefault(domainNameOverrideEnv))
 	configProvider := oci_common.DefaultConfigProvider()
@@ -732,6 +738,61 @@ func TestUnitBuildClientConfigureFn_withDomainNameOverride(t *testing.T) {
 	assert.Equal(t, `DUMMY_ENDPOINT`, baseClient.Host)
 }
 
+// ensure a custom domain that has already override with more than 2 dots can be targeted and expected http client settings are preserved
+func TestUnitBuildClientConfigureFn_withDomainNameOverrideAndCorrectDomainName(t *testing.T) {
+
+	prevEnvVar, hadPreviousEnvVar := os.LookupEnv(domainNameOverrideEnv)
+	if hadPreviousEnvVar {
+		defer os.Setenv(domainNameOverrideEnv, prevEnvVar)
+	} else {
+		defer os.Unsetenv(domainNameOverrideEnv)
+	}
+
+	if hadPreviousEnvVar {
+		defer os.Setenv(hasCorrectDomainNameEnv, prevEnvVar)
+	} else {
+		defer os.Unsetenv(hasCorrectDomainNameEnv)
+	}
+
+	os.Setenv(domainNameOverrideEnv, "oc.0r4-c10ud.com")
+	os.Setenv(hasCorrectDomainNameEnv, "oc.0r4-c10ud.com")
+	assert.Equal(t, "oc.0r4-c10ud.com", getEnvSettingWithBlankDefault(domainNameOverrideEnv))
+	assert.Equal(t, "oc.0r4-c10ud.com", getEnvSettingWithBlankDefault(hasCorrectDomainNameEnv))
+	configProvider := oci_common.DefaultConfigProvider()
+	httpClient := buildHttpClient()
+	configureClientFn, err := buildConfigureClientFn(configProvider, httpClient)
+	assert.NoError(t, err)
+
+	baseClient := &oci_common.BaseClient{}
+	baseClient.Host = "https://svc.region.oc.0r4-c10ud.com"
+	err = configureClientFn(baseClient)
+	assert.NoError(t, err)
+
+	// verify transport settings are unchanged
+	tr := httpClient.Transport.(*http.Transport)
+	assert.NotNil(t, tr.TLSClientConfig)
+	assert.Equal(t, uint16(tls.VersionTLS12), tr.TLSClientConfig.MinVersion, "expected min tls 1.2")
+	assert.NotNil(t, tr.Proxy, "expected http.ProxyFromEnvironment fn")
+	assert.Nil(t, tr.TLSClientConfig.RootCAs)
+
+	// verify url has expected domain
+	assert.Equal(t, `https://svc.region.oc.0r4-c10ud.com`, baseClient.Host)
+
+	// verify subdomains are preserved
+	baseClient = &oci_common.BaseClient{}
+	baseClient.Host = "avnzdivwaadfa-management.kms.us-phoenix-1.oraclecloud.com"
+	err = configureClientFn(baseClient)
+	assert.NoError(t, err)
+	assert.Equal(t, `avnzdivwaadfa-management.kms.us-phoenix-1.oc.0r4-c10ud.com`, baseClient.Host)
+
+	// verify non-match preserves original url
+	baseClient = &oci_common.BaseClient{}
+	baseClient.Host = "DUMMY_ENDPOINT"
+	err = configureClientFn(baseClient)
+	assert.NoError(t, err)
+	assert.Equal(t, `DUMMY_ENDPOINT`, baseClient.Host)
+}
+
 // ensure use_obo_token env var results in `opc-obo-token` http header injection
 func TestUnitBuildClientConfigureFn_interceptor(t *testing.T) {