deprecate WHITELIST, switch to ALLOWLIST in ARMHttpLoggingPolicy

Author: iscai-msft

sdk/core/azure-mgmt-core/azure/mgmt/core/policies/__init__.py

@@ -32,7 +32,7 @@ class ARMHttpLoggingPolicy(HttpLoggingPolicy):
     """HttpLoggingPolicy with ARM specific safe headers fopr loggers.
     """
 
-    DEFAULT_HEADERS_WHITELIST = HttpLoggingPolicy.DEFAULT_HEADERS_WHITELIST | set([
+    DEFAULT_HEADERS_ALLOWLIST = HttpLoggingPolicy.DEFAULT_HEADERS_ALLOWLIST | set([
         # https://docs.microsoft.com/azure/azure-resource-manager/management/request-limits-and-throttling#remaining-requests
         "x-ms-ratelimit-remaining-subscription-reads",
         "x-ms-ratelimit-remaining-subscription-writes",
@@ -47,9 +47,12 @@ class ARMHttpLoggingPolicy(HttpLoggingPolicy):
         "x-ms-request-charge",
     ])
 
+    # Deprecated
+    DEFAULT_HEADERS_WHITELIST = DEFAULT_HEADERS_ALLOWLIST
+
     def __init__(self, logger=None, **kwargs):
         super(ARMHttpLoggingPolicy, self).__init__(logger=None, **kwargs)
-        self.allowed_header_names = set(ARMHttpLoggingPolicy.DEFAULT_HEADERS_WHITELIST)
+        self.allowed_header_names = set(ARMHttpLoggingPolicy.DEFAULT_HEADERS_ALLOWLIST)
 
 
 __all__ = ["ARMAutoResourceProviderRegistrationPolicy", "ARMHttpLoggingPolicy"]

sdk/core/azure-mgmt-core/tests/asynctests/test_policies.py

@@ -31,7 +31,7 @@ def test_default_http_logging_policy():
     config = Configuration()
     pipeline_client = AsyncARMPipelineClient(base_url="test", config=config)
     http_logging_policy = pipeline_client._default_policies(config=config)[-1]
-    assert http_logging_policy.allowed_header_names == ARMHttpLoggingPolicy.DEFAULT_HEADERS_WHITELIST
+    assert http_logging_policy.allowed_header_names == ARMHttpLoggingPolicy.DEFAULT_HEADERS_ALLOWLIST
 
 def test_pass_in_http_logging_policy():
     config = Configuration()
@@ -43,4 +43,4 @@ def test_pass_in_http_logging_policy():
 
     pipeline_client = AsyncARMPipelineClient(base_url="test", config=config)
     http_logging_policy = pipeline_client._default_policies(config=config)[-1]
-    assert http_logging_policy.allowed_header_names == ARMHttpLoggingPolicy.DEFAULT_HEADERS_WHITELIST.union({"x-ms-added-header"})
+    assert http_logging_policy.allowed_header_names == ARMHttpLoggingPolicy.DEFAULT_HEADERS_ALLOWLIST.union({"x-ms-added-header"})

sdk/core/azure-mgmt-core/tests/test_policies.py

@@ -172,7 +172,7 @@ def test_default_http_logging_policy():
     config = Configuration()
     pipeline_client = ARMPipelineClient(base_url="test", config=config)
     http_logging_policy = pipeline_client._default_policies(config=config)[-1]
-    assert http_logging_policy.allowed_header_names == ARMHttpLoggingPolicy.DEFAULT_HEADERS_WHITELIST
+    assert http_logging_policy.allowed_header_names == ARMHttpLoggingPolicy.DEFAULT_HEADERS_ALLOWLIST
 
 def test_pass_in_http_logging_policy():
     config = Configuration()
@@ -184,4 +184,4 @@ def test_pass_in_http_logging_policy():
 
     pipeline_client = ARMPipelineClient(base_url="test", config=config)
     http_logging_policy = pipeline_client._default_policies(config=config)[-1]
-    assert http_logging_policy.allowed_header_names == ARMHttpLoggingPolicy.DEFAULT_HEADERS_WHITELIST.union({"x-ms-added-header"})
+    assert http_logging_policy.allowed_header_names == ARMHttpLoggingPolicy.DEFAULT_HEADERS_ALLOWLIST.union({"x-ms-added-header"})