[CI] Test updates for central sanitizers (Azure#35385)

This PR updates our Python testing framework to adopt the new TestProxy
which enables numerous common sanitizers.


Signed-off-by: Paul Van Eck <[email protected]>

Author: pvaneck

eng/target_proxy_version.txt

@@ -1 +1 @@
-1.0.0-dev.20240410.1
+1.0.0-dev.20240506.5

sdk/ai/azure-ai-generative/tests/conftest.py

@@ -86,7 +86,7 @@ def fake_datastore_key() -> str:
     return str(b64_key, "ascii")
 
 
-@pytest.fixture(autouse=True)
+@pytest.fixture(scope="session", autouse=True)
 def add_sanitizers(test_proxy, fake_datastore_key):
     """Register recording sanitizers for the function under test"""
     add_remove_header_sanitizer(headers="x-azureml-token,Log-URL,Authorization")

sdk/ai/azure-ai-resources/tests/conftest.py

@@ -100,7 +100,7 @@ def fake_datastore_key() -> str:
     return str(b64_key, "ascii")
 
 
-@pytest.fixture(autouse=True)
+@pytest.fixture(scope="session", autouse=True)
 def add_sanitizers(test_proxy, fake_datastore_key):
     """Register recording sanitizers for the function under test"""
     add_remove_header_sanitizer(headers="x-azureml-token,Log-URL,Authorization")

sdk/appconfiguration/azure-appconfiguration-provider/tests/conftest.py

@@ -4,6 +4,7 @@
     add_general_string_sanitizer,
     add_oauth_response_sanitizer,
     set_custom_default_matcher,
+    remove_batch_sanitizers,
 )
 import pytest
 
@@ -37,3 +38,8 @@ def add_sanitizers(test_proxy):
     add_general_regex_sanitizer(value="api-version=1970-01-01", regex="api-version=.+")
     set_custom_default_matcher(ignored_headers="x-ms-content-sha256, Accept", excluded_headers="Content-Length")
     add_oauth_response_sanitizer()
+
+    # Remove the following sanitizers since certain fields are needed in tests and are non-sensitive:
+    #  - AZSDK3430: $..id
+    #  - AZSDK3447: $.key
+    remove_batch_sanitizers(["AZSDK3430", "AZSDK3447"])

sdk/appconfiguration/azure-appconfiguration/tests/conftest.py

@@ -25,7 +25,7 @@
 # --------------------------------------------------------------------------
 import pytest
 import os
-from devtools_testutils import add_general_regex_sanitizer, test_proxy, set_bodiless_matcher
+from devtools_testutils import add_general_regex_sanitizer, test_proxy, set_bodiless_matcher, remove_batch_sanitizers
 
 
 @pytest.fixture(scope="session", autouse=True)
@@ -38,3 +38,9 @@ def add_sanitizers(test_proxy):
     add_general_regex_sanitizer(regex=client_secret, value="client-secret")
     tenant_id = os.environ.get("APPCONFIGURATION_TENANT_ID", "00000000-0000-0000-0000-000000000000")
     add_general_regex_sanitizer(value="00000000-0000-0000-0000-000000000000", regex=tenant_id)
+
+    # Remove the following sanitizers since certain fields are needed in tests and are non-sensitive:
+    #  - AZSDK3447: $.key
+    #  - AZSDK3490: $..etag
+    #  - AZSDK3493: $..name
+    remove_batch_sanitizers(["AZSDK3447", "AZSDK3490", "AZSDK3493"])

sdk/cognitivelanguage/azure-ai-language-questionanswering/tests/conftest.py

@@ -6,7 +6,11 @@
 # --------------------------------------------------------------------------
 import pytest
 
-from devtools_testutils.sanitizers import add_header_regex_sanitizer, add_oauth_response_sanitizer
+from devtools_testutils.sanitizers import (
+    add_header_regex_sanitizer,
+    add_oauth_response_sanitizer,
+    remove_batch_sanitizers
+)
 
 
 # Environment variable keys
@@ -40,6 +44,10 @@ def add_sanitizers(test_proxy, environment_variables):
     add_oauth_response_sanitizer()
     add_header_regex_sanitizer(key="Set-Cookie", value="[set-cookie;]")
 
+    # Remove the following sanitizers since certain fields are needed in tests and are non-sensitive:
+    #  - AZSDK3430: $..id
+    remove_batch_sanitizers(["AZSDK3430"])
+
 
 @pytest.fixture(scope="session")
 def qna_creds(environment_variables):

sdk/communication/azure-communication-callautomation/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/communication/azure-communication-callautomation",
-  "Tag": "python/communication/azure-communication-callautomation_707ce35a60"
+  "Tag": "python/communication/azure-communication-callautomation_ab7206cdd8"
 }

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

@@ -11,6 +11,7 @@
     set_default_session_settings,
     add_body_key_sanitizer,
     add_general_string_sanitizer,
+    remove_batch_sanitizers,
 )
 
 # autouse=True will trigger this fixture on each pytest run, even if it's not explicitly used by a test method
@@ -24,7 +25,7 @@ def start_proxy(test_proxy):
     add_general_string_sanitizer(target=connection_str, value=fake_connection_str)
 
     add_general_regex_sanitizer(regex="https://[^/]+", value="https://sanitized")
-    add_body_key_sanitizer(json_path="callbackUri", value="https://sanitized")
+    add_body_key_sanitizer(json_path="callbackUri", value="https://sanitized/")
     add_body_key_sanitizer(json_path="$..file.uri", value="https://REDACTED/prompt.wav")
     add_header_regex_sanitizer(key="Set-Cookie", value="sanitized")
     add_header_regex_sanitizer(key="Date", value="sanitized")
@@ -40,4 +41,8 @@ def start_proxy(test_proxy):
     add_header_regex_sanitizer(key="Repeatability-First-Sent", value="sanitized")
     add_header_regex_sanitizer(key="Repeatability-Request-ID", value="sanitized")
 
-    return
+    # Remove the following sanitizers since certain fields are needed in tests and are non-sensitive:
+    #  - AZSDK3430: $..id
+    remove_batch_sanitizers(["AZSDK3430"])
+
+    return

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

@@ -35,6 +35,7 @@
     set_default_session_settings,
     add_uri_regex_sanitizer,
     add_body_key_sanitizer,
+    remove_batch_sanitizers,
 )
 from router_test_constants import SANITIZED, FAKE_FUNCTION_URI, FAKE_ENDPOINT, FAKE_CONNECTION_STRING
 from azure.communication.jobrouter._shared.utils import parse_connection_str
@@ -69,6 +70,11 @@ def start_proxy(test_proxy):
     add_body_key_sanitizer(json_path="$..functionKey", value=SANITIZED)
     add_body_key_sanitizer(json_path="$..appKey", value=SANITIZED)
     add_body_key_sanitizer(json_path="$..clientId", value=SANITIZED)
+
+    # Remove the following sanitizers since certain fields are needed in tests and are non-sensitive:
+    #  - AZSDK3430: $..id
+    #  - AZSDK3493: $..name
+    remove_batch_sanitizers(["AZSDK3430", "AZSDK3493"])
     return
 
 

sdk/communication/azure-communication-phonenumbers/test/conftest.py

@@ -6,7 +6,8 @@
     add_general_string_sanitizer,
     add_general_regex_sanitizer,
     add_header_regex_sanitizer,
-    test_proxy
+    test_proxy,
+    remove_batch_sanitizers,
 )
 
 
@@ -45,10 +46,10 @@ def add_sanitizers(test_proxy):
     add_body_key_sanitizer(json_path="phoneNumbers[*].id", value="sanitized")
     add_body_key_sanitizer(
         json_path="phoneNumbers[*].phoneNumber", value="sanitized")
-    
+
     add_general_regex_sanitizer(
         regex=r"-[0-9a-fA-F]{32}\.[0-9a-zA-Z\.]*(\.com|\.net|\.test)", value=".sanitized.com")
-    
+
     add_general_regex_sanitizer(regex=r"(?:(?:%2B)|\+)\d{10,15}", value="sanitized")
 
     add_general_regex_sanitizer(
@@ -68,3 +69,9 @@ def add_sanitizers(test_proxy):
     add_header_regex_sanitizer(key="x-ms-request-id", value="sanitized")
     add_header_regex_sanitizer(
         key="Content-Security-Policy-Report-Only", value="sanitized")
+
+    # Remove the following sanitizers since certain fields are needed in tests and are non-sensitive:
+    #  - AZSDK3493: $..name
+    #  - AZSDK2003: Location
+    remove_batch_sanitizers(["AZSDK3493", "AZSDK2003"])
+