[Communication] - All SDKs- Print headers (Azure#18462)

* Custom logger for ms-cv headers

* Custom logger for ms-cv headers

* using System

* Integrate custom policy with SMS tests

* Fix build

* New changes

* Integrating logger with chat tests

* Supress good logging

* Remove unused import

* Integrate with phone number

* Fix build

* Fix build

* Update names

* Update test names

* Clean up PR

* Fix checkstyle

* Update log

* Address comments

* Add line back

* Fix build

* add test scope

* Update headers change

* Clean up PR

Co-authored-by: Minnie Liu <peiliu@microsoft.com>

Author: minnieliu

sdk/communication/azure-communication-administration/src/test/java/com/azure/communication/administration/CommunicationIdentityAsyncTests.java

@@ -92,6 +92,10 @@ private static TestMode initializeTestMode() {
             return TestMode.PLAYBACK;
         }
     }
+    
+    protected CommunicationIdentityClientBuilder addLoggingPolicy(CommunicationIdentityClientBuilder builder, String testName) {
+        return builder.addPolicy(new CommunicationLoggerPolicy(testName));
+    }
 
     static class FakeCredentials implements TokenCredential {
         @Override

sdk/communication/azure-communication-administration/src/test/java/com/azure/communication/administration/CommunicationIdentityClientTestBase.java

@@ -30,7 +30,8 @@ protected void beforeTest() {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void createIdentityClientUsingManagedIdentity(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient);
+        client = setupClient(builder, "createIdentityClientUsingManagedIdentitySync");
         assertNotNull(client);
 
         // Action & Assert
@@ -43,7 +44,8 @@ public void createIdentityClientUsingManagedIdentity(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void createIdentityClientUsingConnectionString(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClientUsingConnectionString(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClientUsingConnectionString(httpClient);
+        client = setupClient(builder, "createIdentityClientUsingConnectionStringSync");
         assertNotNull(client);
 
         // Action & Assert
@@ -57,7 +59,8 @@ public void createIdentityClientUsingConnectionString(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void createUser(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClient(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClient(httpClient);
+        client = setupClient(builder, "createUserSync");
 
         // Action & Assert
         CommunicationUserIdentifier communicationUser = client.createUser();
@@ -69,7 +72,8 @@ public void createUser(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void createUserWithResponse(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClient(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClient(httpClient);
+        client = setupClient(builder, "createUserWithResponseSync");
 
         // Action & Assert
         Response<CommunicationUserIdentifier> response = client.createUserWithResponse(Context.NONE);
@@ -82,7 +86,8 @@ public void createUserWithResponse(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void deleteUser(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClient(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClient(httpClient);
+        client = setupClient(builder, "deleteUserSync");
 
         // Action & Assert
         CommunicationUserIdentifier communicationUser = client.createUser();
@@ -94,7 +99,8 @@ public void deleteUser(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void deleteUserWithResponse(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClient(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClient(httpClient);
+        client = setupClient(builder, "deleteUserWithResponseSync");
 
         // Action & Assert
         CommunicationUserIdentifier communicationUser = client.createUser();
@@ -106,7 +112,8 @@ public void deleteUserWithResponse(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void revokeToken(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClient(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClient(httpClient);
+        client = setupClient(builder, "revokeTokenSync");
 
         // Action & Assert
         CommunicationUserIdentifier communicationUser = client.createUser();
@@ -120,7 +127,8 @@ public void revokeToken(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void revokeTokenWithResponse(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClient(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClient(httpClient);
+        client = setupClient(builder, "revokeTokenWithResponseSync");
 
         // Action & Assert
         CommunicationUserIdentifier communicationUser = client.createUser();
@@ -135,7 +143,8 @@ public void revokeTokenWithResponse(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void issueToken(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClient(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClient(httpClient);
+        client = setupClient(builder, "issueTokenSync");
 
         // Action & Assert
         CommunicationUserIdentifier communicationUser = client.createUser();
@@ -153,7 +162,8 @@ public void issueToken(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void issueTokenWithResponse(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClient(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClient(httpClient);
+        client = setupClient(builder, "issueTokenWithResponseSync");
 
         // Action & Assert
         CommunicationUserIdentifier communicationUser = client.createUser();
@@ -173,7 +183,8 @@ public void issueTokenWithResponse(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void createUserWithResponseUsingManagedIdentity(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient);
+        client = setupClient(builder, "createUserWithResponseUsingManagedIdentitySync");
 
         // Action & Assert
         Response<CommunicationUserIdentifier> response = client.createUserWithResponse(Context.NONE);
@@ -186,7 +197,8 @@ public void createUserWithResponseUsingManagedIdentity(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void deleteUserUsingManagedIdentity(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient);
+        client = setupClient(builder, "deleteUserUsingManagedIdentitySync");
 
         // Action & Assert
         CommunicationUserIdentifier communicationUser = client.createUser();
@@ -198,7 +210,8 @@ public void deleteUserUsingManagedIdentity(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void deleteUserWithResponseUsingManagedIdentity(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient);
+        client = setupClient(builder, "deleteUserWithResponseUsingManagedIdentitySync");
 
         // Action & Assert
         CommunicationUserIdentifier communicationUser = client.createUser();
@@ -210,7 +223,8 @@ public void deleteUserWithResponseUsingManagedIdentity(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void revokeTokenUsingManagedIdentity(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient);
+        client = setupClient(builder, "revokeTokenUsingManagedIdentitySync");
 
         // Action & Assert
         CommunicationUserIdentifier communicationUser = client.createUser();
@@ -224,7 +238,8 @@ public void revokeTokenUsingManagedIdentity(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void revokeTokenWithResponseUsingManagedIdentity(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient);
+        client = setupClient(builder, "revokeTokenWithResponseUsingManagedIdentitySync");
 
         // Action & Assert
         CommunicationUserIdentifier communicationUser = client.createUser();
@@ -239,7 +254,8 @@ public void revokeTokenWithResponseUsingManagedIdentity(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void issueTokenUsingManagedIdentity(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient);
+        client = setupClient(builder, "issueTokenUsingManagedIdentitySync");
 
         // Action & Assert
         CommunicationUserIdentifier communicationUser = client.createUser();
@@ -257,7 +273,8 @@ public void issueTokenUsingManagedIdentity(HttpClient httpClient) {
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void issueTokenWithResponseUsingManagedIdentity(HttpClient httpClient) {
         // Arrange
-        client = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient).buildClient();
+        CommunicationIdentityClientBuilder builder = getCommunicationIdentityClientBuilderUsingManagedIdentity(httpClient);
+        client = setupClient(builder, "issueTokenWithResponseUsingManagedIdentitySync");
 
         // Action & Assert
         CommunicationUserIdentifier communicationUser = client.createUser();
@@ -272,4 +289,8 @@ public void issueTokenWithResponseUsingManagedIdentity(HttpClient httpClient) {
         assertFalse(issuedToken.getExpiresOn().toString().isEmpty());
         assertNotNull(issuedToken.getUser());
     }
+
+    private CommunicationIdentityClient setupClient(CommunicationIdentityClientBuilder builder, String testName) {
+        return addLoggingPolicy(builder, testName).buildClient();
+    }
 }

sdk/communication/azure-communication-administration/src/test/java/com/azure/communication/administration/CommunicationIdentityTests.java

@@ -0,0 +1,42 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.communication.administration;
+
+import com.azure.core.http.HttpPipelineCallContext;
+import com.azure.core.http.HttpPipelineNextPolicy;
+import com.azure.core.http.HttpResponse;
+import com.azure.core.http.policy.HttpPipelinePolicy;
+import com.azure.core.util.logging.ClientLogger;
+
+import reactor.core.publisher.Mono;
+
+/**
+ * A policy that logs the Http Response
+ */
+public class CommunicationLoggerPolicy implements HttpPipelinePolicy {
+
+    private final ClientLogger logger = new ClientLogger(CommunicationLoggerPolicy.class);
+    private final String testName;
+
+    /**
+     * Creates a policy that logs the Http Response
+     * @param testName Name of the test to log
+     */
+    public CommunicationLoggerPolicy(String testName) {
+        this.testName = testName;
+    }
+
+    @Override
+    public Mono<HttpResponse> process(HttpPipelineCallContext context, HttpPipelineNextPolicy next) {
+        return next.process()
+        .flatMap(httpResponse -> {
+            final HttpResponse bufferedResponse = httpResponse.buffer();
+
+            // Should sanitize printed reponse url
+            System.out.println("MS-CV header for " + testName + " request "
+                + bufferedResponse.getRequest().getUrl() + ": " + bufferedResponse.getHeaderValue("MS-CV"));
+            return Mono.just(bufferedResponse);
+        });
+    }
+}