Modify azure-communication conftest to apply a customdefault matcher on python 3.14 (#43719)

* modify azure-communication conftest to apply a customdefault matcher that ignores the Accept-Encoding header VALUE only on python 314

Author: scbedd

sdk/communication/azure-communication-callautomation/tests/conftest.py

@@ -3,6 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
+import sys
 import pytest
 import os
 import asyncio
@@ -14,15 +15,21 @@
     add_body_key_sanitizer,
     add_general_string_sanitizer,
     remove_batch_sanitizers,
+    set_custom_default_matcher
 )
 
 
 # autouse=True will trigger this fixture on each pytest run, even if it's not explicitly used by a test method
 @pytest.fixture(scope="session", autouse=True)
 def start_proxy(test_proxy):
-
     set_default_session_settings()
 
+    # On python 3.14, azure-core sends an additional 'Accept-Encoding' header value that causes playback issues.
+    # By ignoring it, we can avoid really wonky mismatch errors, while still validating the other headers
+    if sys.version_info >= (3, 14):
+        headers_to_ignore = "Accept-Encoding"
+        set_custom_default_matcher(ignored_headers=headers_to_ignore)
+
     fake_connection_str = "endpoint=https://sanitized.communication.azure.com/;accesskey=fake=="
     connection_str = os.getenv("COMMUNICATION_LIVETEST_STATIC_CONNECTION_STRING", fake_connection_str)
     add_general_string_sanitizer(target=connection_str, value=fake_connection_str)

sdk/communication/azure-communication-identity/tests/conftest.py

@@ -27,7 +27,9 @@
 # cSpell:ignore ests
 import pytest
 import os
+import sys
 from devtools_testutils import (
+    set_custom_default_matcher,
     test_proxy,
     add_general_regex_sanitizer,
     add_header_regex_sanitizer,
@@ -42,6 +44,13 @@
 @pytest.fixture(scope="session", autouse=True)
 def add_sanitizers(test_proxy):
     set_default_session_settings()
+
+    # On python 3.14, azure-core sends an additional 'Accept-Encoding' header value that causes playback issues.
+    # By ignoring it, we can avoid really wonky mismatch errors, while still validating the other headers
+    if sys.version_info >= (3, 14):
+        headers_to_ignore = "Accept-Encoding"
+        set_custom_default_matcher(ignored_headers=headers_to_ignore)
+
     add_oauth_response_sanitizer()
 
     connection_str = os.environ.get("COMMUNICATION_LIVETEST_DYNAMIC_CONNECTION_STRING")

sdk/communication/azure-communication-jobrouter/tests/conftest.py

@@ -36,6 +36,7 @@
     add_uri_regex_sanitizer,
     add_body_key_sanitizer,
     remove_batch_sanitizers,
+    set_custom_default_matcher
 )
 from router_test_constants import SANITIZED, FAKE_FUNCTION_URI, FAKE_ENDPOINT, FAKE_CONNECTION_STRING
 from azure.communication.jobrouter._shared.utils import parse_connection_str
@@ -49,6 +50,12 @@
 def start_proxy(test_proxy):
     set_default_session_settings()
 
+    # On python 3.14, azure-core sends an additional 'Accept-Encoding' header value that causes playback issues.
+    # By ignoring it, we can avoid really wonky mismatch errors, while still validating the other headers
+    if sys.version_info >= (3, 14):
+        headers_to_ignore = "Accept-Encoding"
+        set_custom_default_matcher(ignored_headers=headers_to_ignore)
+
     communication_connection_string = os.getenv(
         "COMMUNICATION_LIVETEST_DYNAMIC_CONNECTION_STRING", FAKE_CONNECTION_STRING
     )

sdk/communication/azure-communication-messages/tests/conftest.py

@@ -27,7 +27,9 @@
 # cSpell:ignore ests
 import pytest
 import os
+import sys
 from devtools_testutils import (
+    set_custom_default_matcher,
     test_proxy,
     add_header_regex_sanitizer,
     set_default_session_settings,
@@ -43,6 +45,13 @@
 @pytest.fixture(scope="session", autouse=True)
 def start_proxy(test_proxy):
     set_default_session_settings()
+
+    # On python 3.14, azure-core sends an additional 'Accept-Encoding' header value that causes playback issues.
+    # By ignoring it, we can avoid really wonky mismatch errors, while still validating the other headers
+    if sys.version_info >= (3, 14):
+        headers_to_ignore = "Accept-Encoding"
+        set_custom_default_matcher(ignored_headers=headers_to_ignore)
+
     add_oauth_response_sanitizer()
 
     FAKE_CONNECTION_STRING = "endpoint=https://sanitized.unitedstates.ppe.communication.azure.net/;accesskey=fake==="

sdk/communication/azure-communication-rooms/tests/conftest.py

@@ -25,12 +25,14 @@
 # --------------------------------------------------------------------------
 import pytest
 import os
+import sys
 from devtools_testutils import (
     add_general_string_sanitizer,
     add_header_regex_sanitizer,
     set_default_session_settings,
     remove_batch_sanitizers,
     add_uri_regex_sanitizer,
+    set_custom_default_matcher
 )
 from azure.communication.rooms._shared.utils import parse_connection_str
 
@@ -39,6 +41,12 @@
 def add_sanitizers(test_proxy):
     set_default_session_settings()
 
+    # On python 3.14, azure-core sends an additional 'Accept-Encoding' header value that causes playback issues.
+    # By ignoring it, we can avoid really wonky mismatch errors, while still validating the other headers
+    if sys.version_info >= (3, 14):
+        headers_to_ignore = "Accept-Encoding"
+        set_custom_default_matcher(ignored_headers=headers_to_ignore)
+
     communication_connection_string = os.getenv(
         "COMMUNICATION_CONNECTION_STRING_ROOMS", "endpoint=https://sanitized.communication.azure.com/;accesskey=fake==="
     )

sdk/communication/azure-communication-sms/tests/conftest.py

@@ -27,20 +27,29 @@
 # cSpell:ignore ests
 import pytest
 import os
+import sys
 from devtools_testutils import (
     test_proxy,
     add_header_regex_sanitizer,
     set_default_session_settings,
     add_body_key_sanitizer,
     add_oauth_response_sanitizer,
     add_general_string_sanitizer,
+    set_custom_default_matcher
 )
 from azure.communication.sms._shared.utils import parse_connection_str
 
 
 @pytest.fixture(scope="session", autouse=True)
 def add_sanitizers(test_proxy):
     set_default_session_settings()
+
+    # On python 3.14, azure-core sends an additional 'Accept-Encoding' header value that causes playback issues.
+    # By ignoring it, we can avoid really wonky mismatch errors, while still validating the other headers
+    if sys.version_info >= (3, 14):
+        headers_to_ignore = "Accept-Encoding"
+        set_custom_default_matcher(ignored_headers=headers_to_ignore)
+
     add_oauth_response_sanitizer()
 
     connection_str = os.environ.get("COMMUNICATION_LIVETEST_STATIC_CONNECTION_STRING")

sdk/communication/azure-communication-sms/tests/test_sms_client_e2e_async.py

@@ -10,7 +10,7 @@
 import pytest
 from devtools_testutils.aio import recorded_by_proxy_async
 from devtools_testutils.fake_credentials_async import AsyncFakeCredential
-from devtools_testutils import get_credential, is_live
+from devtools_testutils import get_credential, is_live, set_custom_default_matcher
 from azure.communication.sms.aio import SmsClient
 from azure.core.exceptions import HttpResponseError
 from _shared.utils import async_create_token_credential, get_http_logging_policy
@@ -22,6 +22,12 @@ class TestClientAsync(ACSSMSTestCase):
     def setup_method(self):
         super().setUp()
 
+        # On python 3.14, azure-core sends an additional 'Accept-Encoding' header value that causes playback issues.
+        # By ignoring it, we can avoid really wonky mismatch errors, while still validating the other headers
+        if sys.version_info >= (3, 14):
+            headers_to_ignore = "Accept-Encoding"
+            set_custom_default_matcher(ignored_headers=headers_to_ignore)
+
     @recorded_by_proxy_async
     async def test_send_sms_single_async(self):
         sms_client = self.create_client_from_connection_string()