Add email address replacer for test framework

Author: evelyn-ys

src/azure-cli-testsdk/azure/cli/testsdk/base.py

@@ -24,7 +24,7 @@
                       patch_progress_controller, patch_get_current_system_username)
 from .exceptions import CliExecutionError
 from .utilities import (find_recording_dir, StorageAccountKeyReplacer, GraphClientPasswordReplacer,
-                        MSGraphClientPasswordReplacer, AADAuthRequestFilter)
+                        MSGraphClientPasswordReplacer, AADAuthRequestFilter, EmailAddressReplacer)
 from .reverse_dependency import get_dummy_cli
 
 logger = logging.getLogger('azure.cli.testsdk')
@@ -93,6 +93,7 @@ def __init__(self, method_name, config_file=None, recording_name=None,
         default_recording_processors = [
             SubscriptionRecordingProcessor(MOCKED_SUBSCRIPTION_ID),
             AADAuthRequestFilter(),
+            EmailAddressReplacer(),
             LargeRequestBodyProcessor(),
             LargeResponseBodyProcessor(),
             DeploymentNameReplacer(),

src/azure-cli-testsdk/azure/cli/testsdk/utilities.py

@@ -4,6 +4,7 @@
 # --------------------------------------------------------------------------------------------
 
 import os
+import re
 from contextlib import contextmanager
 
 from .scenario_tests import (create_random_name as create_random_name_base, RecordingProcessor)
@@ -210,6 +211,31 @@ def process_response(self, response):
         return response
 
 
+class EmailAddressReplacer(RecordingProcessor):
+    """Replace email address like [email protected] with [email protected]"""
+
+    EMAIL_REPLACEMENT = '[email protected]'
+
+    def process_request(self, request):
+        return request
+
+    def process_response(self, response):
+        if response['body']['string']:
+            body = _byte_to_str(response['body']['string'])
+            pattern = r'[\w.%#+-]+[%40|@|_]microsoft.com'
+            index = 0
+            replaced_body = ''
+            for match in re.finditer(pattern, body):
+                start = match.start()
+                end = match.end()
+                replaced_body += body[index:start] + self.EMAIL_REPLACEMENT
+                index = end
+            if index < len(body):
+                replaced_body += body[index:]
+            response['body']['string'] = replaced_body
+        return response
+
+
 class AADAuthRequestFilter(RecordingProcessor):
     """Remove oauth authentication requests and responses from recording.
     This is derived from OAuthRequestResponsesFilter.