[Communication] Cleanup the Recording Test Infrastructure for Identity, Chat and Phone Numbers (Azure#18715)

* [Communication] Cleanup the Recording Test Infrastructure for Identity, Chat and Phone Numbers

* Sanitize Location headers

* Onboard the Sms package tests

* Update the recorded tests

* Disable TollFree tests and record phone number tests

* Update the recordings

Author: RezaJooyandeh

sdk/communication/Azure.Communication.Chat/README.md

@@ -47,7 +47,7 @@ using Azure.Communication.Chat;
 This will allow you to create, get, or delete chat threads.
 ```C# Snippet:Azure_Communication_Chat_Tests_Samples_CreateChatClient
 ChatClient chatClient = new ChatClient(
-    new Uri(endpoint),
+    endpoint,
     new CommunicationTokenCredential(userToken));
 ```
 
@@ -175,7 +175,7 @@ Use `CreateChatThread` to create a chat thread client object.
 
 ```C# Snippet:Azure_Communication_Chat_Tests_Samples_CreateChatClient
 ChatClient chatClient = new ChatClient(
-    new Uri(endpoint),
+    endpoint,
     new CommunicationTokenCredential(userToken));
 ```
 ```C# Snippet:Azure_Communication_Chat_Tests_Samples_CreateThread

sdk/communication/Azure.Communication.Chat/tests/Azure.Communication.Chat.Tests.csproj

@@ -11,6 +11,7 @@
   <ItemGroup>
     <ProjectReference Include="$(AzureCoreTestFramework)" />
     <ProjectReference Include="..\..\Azure.Communication.Identity\src\Azure.Communication.Identity.csproj" />
+    <ProjectReference Include="..\..\Azure.Communication.Common\tests\Azure.Communication.Common.Tests.csproj" />
     <ProjectReference Include="..\src\Azure.Communication.Chat.csproj" />
   </ItemGroup>
 

sdk/communication/Azure.Communication.Chat/tests/Infrastructure/ChatLiveTestBase.cs

@@ -36,7 +36,7 @@ protected ChatClient CreateInstrumentedChatClient(string token)
             }
 
             CommunicationTokenCredential communicationTokenCredential = new CommunicationTokenCredential(token);
-            return InstrumentClient(new ChatClient(new Uri(TestEnvironment.ChatApiUrl()), communicationTokenCredential,
+            return InstrumentClient(new ChatClient(TestEnvironment.Endpoint, communicationTokenCredential,
                 InstrumentClientOptions(new ChatClientOptions())));
         }
 

sdk/communication/Azure.Communication.Chat/tests/Infrastructure/ChatRecordedTestSanitizer.cs

@@ -3,47 +3,24 @@
 
 using System.Collections.Generic;
 using System.Linq;
+using Azure.Communication.Pipeline;
 using Azure.Core;
-using Azure.Core.TestFramework;
 
 namespace Azure.Communication.Chat.Tests
 {
-    public class ChatRecordedTestSanitizer : RecordedTestSanitizer
+    public class ChatRecordedTestSanitizer : CommunicationRecordedTestSanitizer
     {
         public const string SanitizedUnsignedUserTokenValue = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
 
         public ChatRecordedTestSanitizer() : base()
-        {
-            JsonPathSanitizers.Add("$..token");
-        }
+            => JsonPathSanitizers.Add("$..token");
 
-        public override void SanitizeHeaders(IDictionary<string, string[]> headers)
+        protected override void SanitizeAuthenticationHeader(IDictionary<string, string[]> headers)
         {
-            if (headers.ContainsKey(HttpHeader.Names.Authorization))
-            {
-                if (headers.ContainsKey(HttpHeader.Names.UserAgent) && headers[HttpHeader.Names.UserAgent].Any(x => x.Contains("Communication.Chat")))
-                {
-                    headers[HttpHeader.Names.Authorization] = new[] { SanitizedUnsignedUserTokenValue };
-                    return;
-                }
-                headers[HttpHeader.Names.Authorization] = new[] { SanitizeValue };
-            }
-        }
-        public override string SanitizeVariable(string variableName, string environmentVariableValue)
-            => variableName switch
-            {
-                ChatTestEnvironment.ConnectionStringEnvironmentVariableName => SanitizeConnectionString(environmentVariableValue),
-                _ => base.SanitizeVariable(variableName, environmentVariableValue)
-            };
-
-        private static string SanitizeConnectionString(string connectionString)
-        {
-            const string accessKey = "accesskey";
-
-            var parsed = ConnectionString.Parse(connectionString, allowEmptyValues: true);
-            parsed.Replace(accessKey, "Kg==;");
-
-            return parsed.ToString();
+            if (headers.ContainsKey(HttpHeader.Names.UserAgent) && headers[HttpHeader.Names.UserAgent].Any(x => x.Contains("Communication.Chat")))
+                headers[HttpHeader.Names.Authorization] = new[] { SanitizedUnsignedUserTokenValue };
+            else
+                base.SanitizeAuthenticationHeader(headers);
         }
     }
 }

sdk/communication/Azure.Communication.Chat/tests/Infrastructure/ChatTestEnvironment.cs

@@ -1,25 +1,14 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-using Azure.Core.TestFramework;
+using Azure.Communication.Tests;
 
 namespace Azure.Communication.Chat.Tests
 {
     /// <summary>
     /// A helper class used to retrieve information to be used for tests.
     /// </summary>
-    public class ChatTestEnvironment: TestEnvironment
+    public class ChatTestEnvironment : CommunicationTestEnvironment
     {
-        /// <summary>The name of the environment variable from which the Azure Communicion Service resource's connection string will be extracted for the live tests.</summary>
-        internal const string ConnectionStringEnvironmentVariableName = "COMMUNICATION_CONNECTION_STRING";
-
-        public string ConnectionString => GetRecordedVariable(ConnectionStringEnvironmentVariableName);
-
-        public string ChatApiUrl()
-        {
-            var url = ConnectionString.Replace("endpoint=", "");
-            var len = url.IndexOf("/;accesskey=");
-            return url.Substring(0, len);
-        }
     }
 }