Communication: Add new CallingServerClient constructor to support cre… (Azure#23299)

* Communication: Add new CallingServerClient constructor to support creation with TokenCredential

* Update Tests with local Record and generated apis. (Azure#23301)

* Fix test cases for different CallingServerClient auth types.
Update CallingServerClient snippets.

Co-authored-by: Melissa Neubert <mneubert@microsoft.com>
Co-authored-by: Zihan Zhang <43592314+zihzhan-msft@users.noreply.github.com>

Author: 3 people

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

@@ -35,6 +35,13 @@ var connectionString = "<connection_string>"; // Find your Communication Service
 CallingServerClient callingServerClient = new CallingServerClient(connectionString);
 ```
 
+Or alternatively using a valid Active Directory token.
+```C# Snippet:Azure_Communication_CallingServer_Tests_Samples_CreateCallingServerClientWithToken
+var endpoint = new Uri("https://my-resource.communication.azure.com");
+TokenCredential tokenCredential = new DefaultAzureCredential();
+var client = new CallingServerClient(endpoint, tokenCredential);
+```
+
 ## Examples
 ### Make a call to a phone number recipient
 To make an outbound call, call the `CreateCallConnection` or `CreateCallConnectionAsync` function from the `CallingServerClient`.

sdk/communication/Azure.Communication.CallingServer/api/Azure.Communication.CallingServer.netstandard2.0.cs

@@ -64,6 +64,7 @@ public partial class CallingServerClient
         protected CallingServerClient() { }
         public CallingServerClient(string connectionString) { }
         public CallingServerClient(string connectionString, Azure.Communication.CallingServer.CallingServerClientOptions options) { }
+        public CallingServerClient(System.Uri endpoint, Azure.Core.TokenCredential tokenCredential, Azure.Communication.CallingServer.CallingServerClientOptions options = null) { }
         public virtual Azure.Response<Azure.Communication.CallingServer.CallConnection> CreateCallConnection(Azure.Communication.CommunicationIdentifier source, System.Collections.Generic.IEnumerable<Azure.Communication.CommunicationIdentifier> targets, Azure.Communication.CallingServer.CreateCallOptions options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.CallingServer.CallConnection>> CreateCallConnectionAsync(Azure.Communication.CommunicationIdentifier source, System.Collections.Generic.IEnumerable<Azure.Communication.CommunicationIdentifier> targets, Azure.Communication.CallingServer.CreateCallOptions options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual Azure.Response<System.IO.Stream> DownloadStreaming(System.Uri sourceEndpoint, Azure.HttpRange range = default(Azure.HttpRange), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }

sdk/communication/Azure.Communication.CallingServer/src/CallingServerClient.cs

@@ -44,6 +44,17 @@ public CallingServerClient(string connectionString, CallingServerClientOptions o
                   Argument.CheckNotNull(options, nameof(options)))
         { }
 
+        /// <summary> Initializes a new instance of <see cref="CallingServerClient"/>.</summary>
+        /// <param name="endpoint">The URI of the Azure Communication Services resource.</param>
+        /// <param name="tokenCredential">The TokenCredential used to authenticate requests, such as DefaultAzureCredential.</param>
+        /// <param name="options">Client option exposing <see cref="ClientOptions.Diagnostics"/>, <see cref="ClientOptions.Retry"/>, <see cref="ClientOptions.Transport"/>, etc.</param>
+        public CallingServerClient(Uri endpoint, TokenCredential tokenCredential, CallingServerClientOptions options = default)
+            : this(
+                Argument.CheckNotNull(endpoint, nameof(endpoint)).AbsoluteUri,
+                Argument.CheckNotNull(tokenCredential, nameof(tokenCredential)),
+                options ?? new CallingServerClientOptions())
+        { }
+
         #endregion
 
         #region private constructors
@@ -52,6 +63,10 @@ private CallingServerClient(ConnectionString connectionString, CallingServerClie
             : this(connectionString.GetRequired("endpoint"), options.BuildHttpPipeline(connectionString), options)
         { }
 
+        private CallingServerClient(string endpoint, TokenCredential tokenCredential, CallingServerClientOptions options)
+            : this(endpoint, options.BuildHttpPipeline(tokenCredential), options)
+        { }
+
         private CallingServerClient(string endpoint, HttpPipeline httpPipeline, CallingServerClientOptions options)
         {
             _pipeline = httpPipeline;

sdk/communication/Azure.Communication.CallingServer/tests/CallConnection/CallConnectionLiveTests.cs

@@ -36,7 +36,7 @@ public async Task RunCreatePlayCancelHangupScenarioTests()
             if (SkipCallingServerInteractionLiveTests)
                 Assert.Ignore("Skip callingserver interaction live tests flag is on.");
 
-            CallingServerClient client = CreateInstrumentedCallingServerClient();
+            CallingServerClient client = CreateInstrumentedCallingServerClientWithConnectionString();
             try
             {
                 // Establish a Call
@@ -71,7 +71,7 @@ public async Task RunCreateAddRemoveHangupScenarioTests()
             if (SkipCallingServerInteractionLiveTests)
                 Assert.Ignore("Skip callingserver interaction live tests flag is on.");
 
-            CallingServerClient client = CreateInstrumentedCallingServerClient();
+            CallingServerClient client = CreateInstrumentedCallingServerClientWithConnectionString();
             try
             {
                 // Establish a call

sdk/communication/Azure.Communication.CallingServer/tests/Infrastructure/CallingServerLiveTestBase.cs

@@ -5,8 +5,10 @@
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
+using Azure.Core;
 using Azure.Communication.Identity;
 using Azure.Core.TestFramework;
+using Azure.Identity;
 using NUnit.Framework;
 
 namespace Azure.Communication.CallingServer.Tests
@@ -23,7 +25,7 @@ public class CallingServerLiveTestBase : RecordedTestBase<CallingServerTestEnvir
         protected const string RESOURCE_IDENTIFIER = "016a7064-0581-40b9-be73-6dde64d69d72";
 
         // Random Gen Guid
-        protected const string GROUP_IDENTIFIER = "3500789f-e11b-4ceb-85cb-bc8df2a01768";
+        protected const string GROUP_IDENTIFIER = "3500769f-e11b-4ceb-85cb-bc8df2a01768";
 
         protected string GetResourceId()
         {
@@ -102,7 +104,7 @@ protected CommunicationIdentityClient CreateInstrumentedCommunicationIdentityCli
         /// Creates a <see cref="CallingServerClient" />
         /// </summary>
         /// <returns>The instrumented <see cref="CallingServerClient" />.</returns>
-        protected CallingServerClient CreateInstrumentedCallingServerClient()
+        protected CallingServerClient CreateInstrumentedCallingServerClientWithConnectionString()
         {
             var connectionString = TestEnvironment.LiveTestStaticConnectionString;
             CallingServerClient callingServerClient = new CallingServerClient(connectionString, CreateServerCallingClientOptionsWithCorrelationVectorLogs());
@@ -115,6 +117,33 @@ protected CallingServerClient CreateInstrumentedCallingServerClient()
             return InstrumentClient(callingServerClient);
         }
 
+        /// <summary>
+        /// Creates a <see cref="CallingServerClient" />.
+        /// </summary>
+        /// <returns>The instrumented <see cref="CallingServerClient"/>.</returns>
+        protected CallingServerClient CreateInstrumentedCallingServerClientWithToken()
+        {
+            Uri endpoint = TestEnvironment.LiveTestStaticEndpoint;
+            TokenCredential tokenCredential;
+
+            if (Mode == RecordedTestMode.Playback)
+            {
+                tokenCredential = new MockCredential();
+            }
+            else
+            {
+                tokenCredential = new DefaultAzureCredential();
+                #region Snippet:Azure_Communication_CallingServer_Tests_Samples_CreateCallingServerClientWithToken
+                //@@ var endpoint = new Uri("https://my-resource.communication.azure.com");
+                //@@ TokenCredential tokenCredential = new DefaultAzureCredential();
+                //@@ var client = new CallingServerClient(endpoint, tokenCredential);
+                #endregion Snippet:Azure_Communication_CallingServer_Tests_Samples_CreateCallingServerClientWithToken
+            }
+
+            CallingServerClient client = new CallingServerClient(endpoint, tokenCredential, CreateServerCallingClientOptionsWithCorrelationVectorLogs());
+            return InstrumentClient(client);
+        }
+
         #region Api operation functions
         #region Snippet:Azure_Communication_ServerCalling_Tests_CreateGroupCallOperation
         internal async Task<IEnumerable<CallConnection>> CreateGroupCallOperation(CallingServerClient callingServerClient, string groupId, string from, string to, string callBackUri)
@@ -292,7 +321,7 @@ internal async Task<string> AddParticipantOperation(ServerCall serverCall)
         {
             Console.WriteLine("Performing add participant operation to add a participant");
 
-            string invitedUser = GetFixedUserId("0000000a-b200-7a0d-570c-113a0d00288d");
+            string invitedUser = GetFixedUserId("0000000b-d8d8-aaa3-3ef0-8b3a0d002f3f");
 
             var response = await serverCall.AddParticipantAsync(
                 new CommunicationUserIdentifier(invitedUser),

sdk/communication/Azure.Communication.CallingServer/tests/ServerCall/ServerCallLiveTests.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Linq;
 using System.Threading.Tasks;
+using Azure.Communication.Tests;
 using NUnit.Framework;
 
 namespace Azure.Communication.CallingServer.Tests
@@ -26,9 +27,17 @@ public ServerCallLiveTests(bool isAsync) : base(isAsync)
         }
 
         [Test]
-        public async Task RunAllRecordingFunctionsScenarioTests()
+        [TestCase(AuthMethod.ConnectionString, TestName = "RunAllRecordingFunctionsWithConnectionString")]
+        [TestCase(AuthMethod.TokenCredential, TestName = "RunAllRecordingFunctionsWithTokenCredential")]
+        public async Task RunAllRecordingFunctionsScenarioTests(AuthMethod authMethod)
         {
-            CallingServerClient callingServerClient = CreateInstrumentedCallingServerClient();
+            CallingServerClient callingServerClient = authMethod switch
+            {
+                AuthMethod.ConnectionString => CreateInstrumentedCallingServerClientWithConnectionString(),
+                AuthMethod.TokenCredential => CreateInstrumentedCallingServerClientWithToken(),
+                _ => throw new ArgumentOutOfRangeException(nameof(authMethod)),
+            };
+
             var groupId = GetGroupId();
             try
             {
@@ -73,7 +82,7 @@ public async Task RunAllRecordingFunctionsScenarioTests()
         [Test]
         public async Task RunCreatePlayCancelHangupScenarioTests()
         {
-            CallingServerClient callingServerClient = CreateInstrumentedCallingServerClient();
+            CallingServerClient callingServerClient = CreateInstrumentedCallingServerClientWithConnectionString();
             var groupId = GetGroupId();
             try
             {
@@ -110,7 +119,7 @@ public async Task RunCreateAddRemoveHangupScenarioTests()
             if (SkipCallingServerInteractionLiveTests)
                 Assert.Ignore("Skip callingserver interaction live tests flag is on.");
 
-            CallingServerClient callingServerClient = CreateInstrumentedCallingServerClient();
+            CallingServerClient callingServerClient = CreateInstrumentedCallingServerClientWithConnectionString();
             var groupId = GetGroupId();
             try
             {