Send user agent header as "acs-test" (#39937)

* Always send x-ms-useragent header from tests * Test fix * Update assets file with test recordings stamp * Updating test recordings * Remove default value of user-agent header and use only value from environment variable if it's set
Azure · Nov 23, 2023 · 6b5f6d1 · 6b5f6d1
1 parent 36ab08b
commit 6b5f6d1
Show file tree

Hide file tree

Showing 5 changed files with 66 additions and 5 deletions.
diff --git a/sdk/communication/Azure.Communication.PhoneNumbers/assets.json b/sdk/communication/Azure.Communication.PhoneNumbers/assets.json
@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "net",
   "TagPrefix": "net/communication/Azure.Communication.PhoneNumbers",
-  "Tag": "net/communication/Azure.Communication.PhoneNumbers_a2ce6fc537"
+  "Tag": "net/communication/Azure.Communication.PhoneNumbers_x9ndpu0nad"
 }
diff --git a/sdk/communication/Azure.Communication.PhoneNumbers/src/SipRouting/SipRoutingClient.cs b/sdk/communication/Azure.Communication.PhoneNumbers/src/SipRouting/SipRoutingClient.cs
@@ -69,15 +69,15 @@ public SipRoutingClient(Uri endpoint, TokenCredential tokenCredential, SipRoutin
         #region private constructors
 
         private SipRoutingClient(ConnectionString connectionString, SipRoutingClientOptions options)
-            : this(connectionString.GetRequired("endpoint"), options.BuildHttpPipeline(connectionString), options)
+            : this(connectionString.GetRequired("endpoint"), options.BuildSipRoutingHttpPipeline(connectionString), options)
         { }
 
         private SipRoutingClient(string endpoint, AzureKeyCredential keyCredential, SipRoutingClientOptions options)
-            : this(endpoint, options.BuildHttpPipeline(keyCredential), options)
+            : this(endpoint, options.BuildSipRoutingHttpPipeline(keyCredential), options)
         { }
 
         private SipRoutingClient(string endpoint, TokenCredential tokenCredential, SipRoutingClientOptions options)
-            : this(endpoint, options.BuildHttpPipeline(tokenCredential), options)
+            : this(endpoint, options.BuildSipRoutingHttpPipeline(tokenCredential), options)
         { }
 
         private SipRoutingClient(string endpoint, HttpPipeline httpPipeline, SipRoutingClientOptions options)

diff --git a/...tion/Azure.Communication.PhoneNumbers/src/SipRouting/SipRoutingClientOptionsExtensions.cs b/...tion/Azure.Communication.PhoneNumbers/src/SipRouting/SipRoutingClientOptionsExtensions.cs
@@ -0,0 +1,59 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Collections.Generic;
+using System.Text;
+using Azure.Communication.Pipeline;
+using Azure.Core.Pipeline;
+using Azure.Core;
+
+namespace Azure.Communication.PhoneNumbers.SipRouting
+{
+    internal static class SipRoutingClientOptionsExtensions
+    {
+        public static HttpPipeline BuildSipRoutingHttpPipeline(this ClientOptions options, ConnectionString connectionString)
+        {
+            var pipelineOptions = new HttpPipelineOptions(options)
+            {
+                RequestFailedDetailsParser = new CommunicationRequestFailedDetailsParser(),
+                PerRetryPolicies =
+                {
+                    new HMACAuthenticationPolicy(new AzureKeyCredential(connectionString.GetRequired("accesskey"))),
+                    new MSUserAgentPolicy()
+                }
+            };
+            HttpPipelineTransportOptions httpPipelineTransportOptions = new() { IsClientRedirectEnabled = true };
+            return HttpPipelineBuilder.Build(pipelineOptions, httpPipelineTransportOptions);
+        }
+
+        public static HttpPipeline BuildSipRoutingHttpPipeline(this ClientOptions options, AzureKeyCredential keyCredential)
+        {
+            var pipelineOptions = new HttpPipelineOptions(options)
+            {
+                RequestFailedDetailsParser = new CommunicationRequestFailedDetailsParser(),
+                PerRetryPolicies =
+                {
+                    new HMACAuthenticationPolicy(keyCredential),
+                    new MSUserAgentPolicy()
+                }
+            };
+            HttpPipelineTransportOptions httpPipelineTransportOptions = new() { IsClientRedirectEnabled = true };
+            return HttpPipelineBuilder.Build(pipelineOptions, httpPipelineTransportOptions);
+        }
+
+        public static HttpPipeline BuildSipRoutingHttpPipeline(this ClientOptions options, TokenCredential tokenCredential)
+        {
+            var pipelineOptions = new HttpPipelineOptions(options)
+            {
+                RequestFailedDetailsParser = new CommunicationRequestFailedDetailsParser(),
+                PerRetryPolicies =
+                {
+                    new BearerTokenAuthenticationPolicy(tokenCredential, "https://communication.azure.com//.default"),
+                    new MSUserAgentPolicy()
+                }
+            };
+            return HttpPipelineBuilder.Build(pipelineOptions);
+        }
+    }
+}
diff --git a/...n/Azure.Communication.PhoneNumbers/tests/Infrastructure/PhoneNumbersClientLiveTestBase.cs b/...n/Azure.Communication.PhoneNumbers/tests/Infrastructure/PhoneNumbersClientLiveTestBase.cs
@@ -17,12 +17,14 @@ public class PhoneNumbersClientLiveTestBase : RecordedTestBase<PhoneNumbersClien
         private const string UrlEncodedPhoneNumberRegEx = @"[\\%2B]{0,3}[0-9]{11,15}";
         protected const string UnauthorizedNumber = "+14255550123";
         protected const string UnknownPhoneNumberSearchResultId = "01234567-0123-0123-0123-0123456789AB";
+        private const string URIDomainNameReplacerRegEx = @"https://([^/?]+)";
 
         public PhoneNumbersClientLiveTestBase(bool isAsync) : base(isAsync)
         {
             SanitizedHeaders.Add("location");
             BodyRegexSanitizers.Add(new BodyRegexSanitizer(PhoneNumberRegEx, SanitizeValue));
             UriRegexSanitizers.Add(new UriRegexSanitizer(UrlEncodedPhoneNumberRegEx, SanitizeValue));
+            UriRegexSanitizers.Add(new UriRegexSanitizer(URIDomainNameReplacerRegEx, "https://sanitized.communication.azure.com"));
             SanitizedHeaders.Add("x-ms-content-sha256");
         }
 

diff --git a/sdk/communication/Shared/tests/CommunicationTestEnvironment.cs b/sdk/communication/Shared/tests/CommunicationTestEnvironment.cs
@@ -26,7 +26,7 @@ public class CommunicationTestEnvironment : TestEnvironment
 
         public string LiveTestStaticConnectionString => GetRecordedVariable(
                 LiveTestStaticConnectionStringEnvironmentVariableName,
-                options => options.HasSecretConnectionStringParameter("accessKey", SanitizedValue.Base64));
+                options => options.IsSecret("endpoint=https://sanitized.communication.azure.com/;accesskey=Kg=="));
 
         public Uri LiveTestStaticEndpoint => new(Core.ConnectionString.Parse(LiveTestStaticConnectionString).GetRequired("endpoint"));