deprecate WHITELIST, switch to ALLOWLIST in HttpLoggingPolicy

Author: iscai-msft

sdk/core/azure-core/azure/core/pipeline/policies/_universal.py

@@ -339,7 +339,7 @@ class HttpLoggingPolicy(SansIOHTTPPolicy):
     """The Pipeline policy that handles logging of HTTP requests and responses.
     """
 
-    DEFAULT_HEADERS_WHITELIST = set([
+    DEFAULT_HEADERS_ALLOWLIST = set([
         "x-ms-request-id",
         "x-ms-client-request-id",
         "x-ms-return-client-request-id",
@@ -364,14 +364,18 @@ class HttpLoggingPolicy(SansIOHTTPPolicy):
         "Transfer-Encoding",
         "User-Agent",
     ])
+
+    # Deprecated
+    DEFAULT_HEADERS_WHITELIST = DEFAULT_HEADERS_ALLOWLIST
+
     REDACTED_PLACEHOLDER = "REDACTED"
 
     def __init__(self, logger=None, **kwargs):  # pylint: disable=unused-argument
         self.logger = logger or logging.getLogger(
             "azure.core.pipeline.policies.http_logging_policy"
         )
         self.allowed_query_params = set()
-        self.allowed_header_names = set(HttpLoggingPolicy.DEFAULT_HEADERS_WHITELIST)
+        self.allowed_header_names = set(HttpLoggingPolicy.DEFAULT_HEADERS_ALLOWLIST)
 
     def _redact_query_param(self, key, value):
         lower_case_allowed_query_params = [

sdk/core/azure-core/tests/azure_core_asynctests/test_pipeline.py

@@ -153,7 +153,7 @@ def test_default_http_logging_policy():
     pipeline_client = AsyncPipelineClient(base_url="test")
     pipeline = pipeline_client._build_pipeline(config)
     http_logging_policy = pipeline._impl_policies[-1]._policy
-    assert http_logging_policy.allowed_header_names == HttpLoggingPolicy.DEFAULT_HEADERS_WHITELIST
+    assert http_logging_policy.allowed_header_names == HttpLoggingPolicy.DEFAULT_HEADERS_ALLOWLIST
 
 def test_pass_in_http_logging_policy():
     config = Configuration()
@@ -166,7 +166,7 @@ def test_pass_in_http_logging_policy():
     pipeline_client = AsyncPipelineClient(base_url="test")
     pipeline = pipeline_client._build_pipeline(config)
     http_logging_policy = pipeline._impl_policies[-1]._policy
-    assert http_logging_policy.allowed_header_names == HttpLoggingPolicy.DEFAULT_HEADERS_WHITELIST.union({"x-ms-added-header"})
+    assert http_logging_policy.allowed_header_names == HttpLoggingPolicy.DEFAULT_HEADERS_ALLOWLIST.union({"x-ms-added-header"})
 
 @pytest.mark.asyncio
 async def test_conf_async_requests():

sdk/core/azure-core/tests/test_pipeline.py

@@ -67,7 +67,7 @@ def test_default_http_logging_policy():
     pipeline_client = PipelineClient(base_url="test")
     pipeline = pipeline_client._build_pipeline(config)
     http_logging_policy = pipeline._impl_policies[-1]._policy
-    assert http_logging_policy.allowed_header_names == HttpLoggingPolicy.DEFAULT_HEADERS_WHITELIST
+    assert http_logging_policy.allowed_header_names == HttpLoggingPolicy.DEFAULT_HEADERS_ALLOWLIST
 
 def test_pass_in_http_logging_policy():
     config = Configuration()
@@ -80,7 +80,7 @@ def test_pass_in_http_logging_policy():
     pipeline_client = PipelineClient(base_url="test")
     pipeline = pipeline_client._build_pipeline(config)
     http_logging_policy = pipeline._impl_policies[-1]._policy
-    assert http_logging_policy.allowed_header_names == HttpLoggingPolicy.DEFAULT_HEADERS_WHITELIST.union({"x-ms-added-header"})
+    assert http_logging_policy.allowed_header_names == HttpLoggingPolicy.DEFAULT_HEADERS_ALLOWLIST.union({"x-ms-added-header"})
 
 
 def test_sans_io_exception():