[Python] Custom Teams Endpoint (CTE) GA (Azure#22987)

* regenerated & updated new client for GA(2022-06-01) version

* updated recordings & unit tests for CTE

* updated networktraversal recordings

* removed all occurrences of api_version parameter in other SDKs

* changed release version

* updated helper.py in all test shared folder

* synced test shared folders

* fix for cspell check

Co-authored-by: Aigerim Beishenbekova <[email protected]>
Co-authored-by: Petr Švihlík <[email protected]>

Author: 3 people

.vscode/cspell.json

@@ -393,7 +393,9 @@
         "FNNHHJT",
         "Zwiz",
         "nypg",
-        "PBOF"
+        "PBOF",
+        "tzutc",
+        "gettz"
       ]
     },
     {

sdk/communication/azure-communication-chat/tests/_shared/async_fake_token_credential.py

@@ -0,0 +1,14 @@
+
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+from azure.core.credentials import AccessToken
+
+class AsyncFakeTokenCredential(object):
+    def __init__(self):
+        self.token = AccessToken("Fake Token", 0)
+
+    async def get_token(self, *args):
+        return self.token

sdk/communication/azure-communication-chat/tests/_shared/asynctestcase.py

@@ -9,7 +9,6 @@
 from azure_devtools.scenario_tests.utilities import trim_kwargs_from_test_function
 from .testcase import CommunicationTestCase
 
-
 class AsyncCommunicationTestCase(CommunicationTestCase):
 
     @staticmethod
@@ -24,4 +23,4 @@ def run(test_class_instance, *args, **kwargs):
             loop = asyncio.get_event_loop()
             return loop.run_until_complete(test_fn(test_class_instance, **kwargs))
 
-        return run
+        return run

sdk/communication/azure-communication-chat/tests/_shared/communication_service_preparer.py

@@ -0,0 +1,12 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+
+import functools
+from devtools_testutils import PowerShellPreparer
+
+CommunicationPreparer = functools.partial(
+    PowerShellPreparer, "communication",
+    communication_livetest_dynamic_connection_string="endpoint=https://sanitized.communication.azure.com/;accesskey=fake==="
+)

sdk/communication/azure-communication-chat/tests/_shared/fake_token_credential.py

@@ -0,0 +1,14 @@
+
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+from azure.core.credentials import AccessToken
+
+class FakeTokenCredential(object):
+    def __init__(self):
+        self.token = AccessToken("Fake Token", 0)
+
+    def get_token(self, *args):
+        return self.token

sdk/communication/azure-communication-chat/tests/_shared/helper.py

@@ -39,4 +39,17 @@ def process_request(self, request):
     def process_response(self, response):
         if 'url' in response:
             response['url'] = re.sub('/identities/([^/?]+)', '/identities/sanitized', response['url'])
+        return response
+    
+class URIMsalUsernameReplacer(RecordingProcessor):
+    """Replace the MSAL username in request uri"""
+    def process_request(self, request):
+        resource = (urlparse(request.uri).netloc).split('.')[0]
+        request.uri = re.sub('common/userrealm/([^/.]+)', 'common/userrealm/sanitized@test', request.uri) 
+        request.uri = re.sub(resource, 'sanitized', request.uri)
+        return request
+    
+    def process_response(self, response):
+        if 'url' in response:
+            response['url'] = re.sub('common/userrealm/([^/.]+)', 'common/userrealm/sanitized@test', response['url'])
         return response

sdk/communication/azure-communication-chat/tests/_shared/testcase.py

@@ -46,17 +46,31 @@ def process_request(self, request):
 
     def process_response(self, response):
         if is_text_payload(response) and response['body']['string']:
-            response['body'] = self._replace_keys(response['body']['string'])
+            response['body']['string'] = self._replace_keys(response['body']['string'])
 
         return response
 
     def _replace_keys(self, body):
+        def _replace_recursively(obj):
+            if isinstance(obj, dict):
+                for key in obj:
+                    value = obj[key]
+                    if key in self._keys:
+                        obj[key] = self._replacement
+                    elif key == 'iceServers':
+                        _replace_recursively(value[0])
+                    elif key == 'urls':
+                        obj[key][0] = "turn.skype.com"
+                    else:
+                        _replace_recursively(value)
+            elif isinstance(obj, list):
+                for i in obj:
+                    _replace_recursively(i)
+
         import json
         try:
             body = json.loads(body)
-            for key in self._keys:
-                if key in body:
-                    body[key] = self._replacement
+            _replace_recursively(body)
 
         except (KeyError, ValueError):
             return body
@@ -72,9 +86,10 @@ def __init__(self, method_name, *args, **kwargs):
     def setUp(self):
         super(CommunicationTestCase, self).setUp()
         if self.is_playback():
-            self.connection_str = "endpoint=https://sanitized/;accesskey=fake==="
+            self.connection_str = "endpoint=https://sanitized.communication.azure.com/;accesskey=fake==="
         else:
-            self.connection_str = os.getenv('COMMUNICATION_LIVETEST_DYNAMIC_CONNECTION_STRING')
+            self.connection_str = os.getenv('COMMUNICATION_LIVETEST_DYNAMIC_CONNECTION_STRING') or \
+                                  os.getenv('COMMUNICATION_LIVETEST_STATIC_CONNECTION_STRING')
             endpoint, _ = parse_connection_str(self.connection_str)
             self._resource_name = endpoint.split(".")[0]
-            self.scrubber.register_name_pair(self._resource_name, "sanitized")
+            self.scrubber.register_name_pair(self._resource_name, "sanitized")

sdk/communication/azure-communication-chat/tests/_shared/utils.py

@@ -3,8 +3,30 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+import os
+from typing import (  # pylint: disable=unused-import
+    cast,
+    Tuple,
+)
+from azure.core.pipeline.policies import HttpLoggingPolicy, HeadersPolicy
 
-from azure.core.pipeline.policies import HttpLoggingPolicy
+def create_token_credential():
+    # type: () -> FakeTokenCredential or DefaultAzureCredential
+    from devtools_testutils import is_live
+    if not is_live():
+        from .fake_token_credential import FakeTokenCredential
+        return FakeTokenCredential()
+    from azure.identity import DefaultAzureCredential
+    return DefaultAzureCredential()
+
+def async_create_token_credential():
+    # type: () -> AsyncFakeTokenCredential or DefaultAzureCredential
+    from devtools_testutils import is_live
+    if not is_live():
+        from .async_fake_token_credential import AsyncFakeTokenCredential
+        return AsyncFakeTokenCredential()
+    from azure.identity.aio import DefaultAzureCredential
+    return DefaultAzureCredential()
 
 def get_http_logging_policy(**kwargs):
     http_logging_policy = HttpLoggingPolicy(**kwargs)
@@ -14,3 +36,39 @@ def get_http_logging_policy(**kwargs):
         }
     )
     return http_logging_policy
+
+def get_header_policy(**kwargs):
+    header_policy = HeadersPolicy(**kwargs)
+    
+    useragent = os.getenv("AZURE_USERAGENT_OVERRIDE")
+    if useragent:
+        header_policy.add_header("x-ms-useragent", useragent)
+
+    return header_policy
+
+def parse_connection_str(conn_str):
+    # type: (str) -> Tuple[str, str, str, str]
+    if conn_str is None:
+        raise ValueError(
+            "Connection string is undefined."
+        )
+    endpoint = None
+    shared_access_key = None
+    for element in conn_str.split(";"):
+        key, _, value = element.partition("=")
+        if key.lower() == "endpoint":
+            endpoint = value.rstrip("/")
+        elif key.lower() == "accesskey":
+            shared_access_key = value
+    if not all([endpoint, shared_access_key]):
+        raise ValueError(
+            "Invalid connection string. You can get the connection string from your resource page in the Azure Portal. "
+            "The format should be as follows: endpoint=https://<ResourceUrl>/;accesskey=<KeyValue>"
+        )
+    left_slash_pos = cast(str, endpoint).find("//")
+    if left_slash_pos != -1:
+        host = cast(str, endpoint)[left_slash_pos + 2:]
+    else:
+        host = str(endpoint)
+
+    return host, str(shared_access_key)

sdk/communication/azure-communication-chat/tests/_shared/test_communication_identifier_serializer.py renamed to sdk/communication/azure-communication-chat/tests/test_communication_identifier_serializer.py

@@ -1,8 +1,12 @@
 # Release History
 
-## 1.2.0 (Unreleased)
+## 1.1.0 (Unreleased)
 
 ### Features Added
+- Added support to build a custom Teams endpoint using Microsoft 365 Teams identities:
+    - Added `get_token_for_teams_user(aad_token, client_id, user_object_id)` method that provides the ability to exchange an Azure AD access token of a Teams user for a Communication Identity access token to `CommunicationIdentityClient`.
+- Removed `ApiVersion.V2021_10_31_preview` from API versions.
+- Added a new API version `ApiVersion.V2022_06_01` that is now the deafult API version
 
 ### Breaking Changes
 
@@ -16,7 +20,7 @@
 ### Features Added
 
 - Added support for Microsoft 365 Teams identities
-  - `CommunicationIdentityClient` added a new method `get_token_for_teams_user` that provides the ability to exchange an AAD access token of a Teams user for a Communication Identity access token
+  - `CommunicationIdentityClient` added a new method `get_token_for_teams_user` that provides the ability to exchange an Azure AD access token of a Teams user for a Communication Identity access token
 
 ## 1.0.1 (2021-06-08)