Add proxy policy to credential pipelines (#8945)

Author: chlowell

sdk/identity/azure-identity/HISTORY.md

@@ -1,3 +1,9 @@
+# Unreleased
+
+- All credential pipelines include `ProxyPolicy`
+([#8945](https://github.com/Azure/azure-sdk-for-python/pull/8945))
+
+
 # 2019-11-27 1.1.0
 
 - Constructing `DefaultAzureCredential` no longer raises `ImportError` on Python

sdk/identity/azure-identity/azure/identity/_authn_client.py

@@ -177,6 +177,7 @@ def __init__(
         config = config or self._create_config(**kwargs)
         policies = policies or [
             ContentDecodePolicy(),
+            config.proxy_policy,
             config.retry_policy,
             config.logging_policy,
             DistributedTracingPolicy(**kwargs),

sdk/identity/azure-identity/azure/identity/_internal/msal_transport_adapter.py

@@ -86,6 +86,7 @@ def _build_pipeline(self, config=None, policies=None, transport=None, **kwargs):
         config = config or self._create_config(**kwargs)
         policies = policies or [
             ContentDecodePolicy(),
+            config.proxy_policy,
             config.retry_policy,
             config.logging_policy,
             DistributedTracingPolicy(**kwargs),

sdk/identity/azure-identity/azure/identity/aio/_authn_client.py

@@ -40,6 +40,7 @@ def __init__(
         config = config or self._create_config(**kwargs)
         policies = policies or [
             ContentDecodePolicy(),
+            config.proxy_policy,
             config.retry_policy,
             config.logging_policy,
             DistributedTracingPolicy(**kwargs),

sdk/identity/azure-identity/azure/identity/aio/_internal/msal_transport_adapter.py

@@ -15,6 +15,7 @@
     DistributedTracingPolicy,
     HttpLoggingPolicy,
     NetworkTraceLoggingPolicy,
+    ProxyPolicy,
 )
 from azure.core.pipeline.transport import AioHttpTransport, HttpRequest
 
@@ -40,6 +41,7 @@ def __init__(
 
         config = config or self._create_config(**kwargs)
         policies = policies or [
+            config.proxy_policy,
             config.retry_policy,
             config.logging_policy,
             DistributedTracingPolicy(**kwargs),
@@ -113,6 +115,7 @@ def post(
     @staticmethod
     def _create_config(**kwargs: "Any") -> Configuration:
         config = Configuration(**kwargs)
+        config.proxy_policy = ProxyPolicy(**kwargs)
         config.logging_policy = NetworkTraceLoggingPolicy(**kwargs)
         config.retry_policy = AsyncRetryPolicy(**kwargs)
         return config

sdk/identity/azure-identity/tests/helpers.py

@@ -4,9 +4,11 @@
 # ------------------------------------
 import base64
 import json
-import six
 import time
 
+from azure.core.pipeline.policies import SansIOHTTPPolicy
+import six
+
 try:
     from unittest import mock
 except ImportError:  # python < 3.3
@@ -104,6 +106,11 @@ def mock_response(status_code=200, headers={}, json_payload=None):
     return response
 
 
+def get_discovery_response(endpoint="https://a/b"):
+    aad_metadata_endpoint_names = ("authorization_endpoint", "token_endpoint", "tenant_discovery_endpoint")
+    return mock_response(json_payload={name: endpoint for name in aad_metadata_endpoint_names})
+
+
 def validating_transport(requests, responses):
     if len(requests) != len(responses):
         raise ValueError("each request must have one response")

sdk/identity/azure-identity/tests/test_auth_code.py

@@ -3,14 +3,32 @@
 # Licensed under the MIT License.
 # ------------------------------------
 from azure.core.credentials import AccessToken
+from azure.core.pipeline.policies import SansIOHTTPPolicy
 from azure.identity import AuthorizationCodeCredential
 
+from helpers import build_aad_response, mock_response
+
 try:
     from unittest.mock import Mock
 except ImportError:  # python < 3.3
     from mock import Mock  # type: ignore
 
 
+def test_policies_configurable():
+    policy = Mock(spec_set=SansIOHTTPPolicy, on_request=Mock())
+
+    def send(*_, **__):
+        return mock_response(json_payload=build_aad_response(access_token="**"))
+
+    credential = AuthorizationCodeCredential(
+        "tenant-id", "client-id", "auth-code", "http://localhost", policies=[policy], transport=Mock(send=send)
+    )
+
+    credential.get_token("scope")
+
+    assert policy.on_request.called
+
+
 def test_auth_code_credential():
     client_id = "client id"
     tenant_id = "tenant"

sdk/identity/azure-identity/tests/test_auth_code_async.py

@@ -7,9 +7,28 @@
 
 from azure.core.credentials import AccessToken
 from azure.core.exceptions import ClientAuthenticationError
+from azure.core.pipeline.policies import SansIOHTTPPolicy
 from azure.identity.aio import AuthorizationCodeCredential
 import pytest
 
+from helpers import build_aad_response, mock_response
+
+
+@pytest.mark.asyncio
+async def test_policies_configurable():
+    policy = Mock(spec_set=SansIOHTTPPolicy, on_request=Mock())
+
+    async def send(*_, **__):
+        return mock_response(json_payload=build_aad_response(access_token="**"))
+
+    credential = AuthorizationCodeCredential(
+        "tenant-id", "client-id", "auth-code", "http://localhost", policies=[policy], transport=Mock(send=send)
+    )
+
+    await credential.get_token("scope")
+
+    assert policy.on_request.called
+
 
 @pytest.mark.asyncio
 async def test_auth_code_credential():

sdk/identity/azure-identity/tests/test_certificate_credential.py

@@ -5,9 +5,10 @@
 import json
 import os
 
+from azure.core.pipeline.policies import ContentDecodePolicy, SansIOHTTPPolicy
 from azure.identity import CertificateCredential
 from six.moves.urllib_parse import urlparse
-from helpers import urlsafeb64_decode, mock_response
+from helpers import build_aad_response, urlsafeb64_decode, mock_response
 
 try:
     from unittest.mock import Mock, patch
@@ -17,6 +18,21 @@
 CERT_PATH = os.path.join(os.path.dirname(__file__), "certificate.pem")
 
 
+def test_policies_configurable():
+    policy = Mock(spec_set=SansIOHTTPPolicy, on_request=Mock())
+
+    def send(*_, **__):
+        return mock_response(json_payload=build_aad_response(access_token="**"))
+
+    credential = CertificateCredential(
+        "tenant-id", "client-id", CERT_PATH, policies=[ContentDecodePolicy(), policy], transport=Mock(send=send)
+    )
+
+    credential.get_token("scope")
+
+    assert policy.on_request.called
+
+
 def test_request_url():
     authority = "authority.com"
     tenant_id = "expected_tenant"

sdk/identity/azure-identity/tests/test_certificate_credential_async.py

@@ -7,13 +7,30 @@
 from unittest.mock import Mock, patch
 from urllib.parse import urlparse
 
+from azure.core.pipeline.policies import ContentDecodePolicy, SansIOHTTPPolicy
 from azure.identity.aio import CertificateCredential
-from helpers import urlsafeb64_decode, mock_response
+from helpers import build_aad_response, urlsafeb64_decode, mock_response
 import pytest
 
 CERT_PATH = os.path.join(os.path.dirname(__file__), "certificate.pem")
 
 
+@pytest.mark.asyncio
+async def test_policies_configurable():
+    policy = Mock(spec_set=SansIOHTTPPolicy, on_request=Mock())
+
+    async def send(*_, **__):
+        return mock_response(json_payload=build_aad_response(access_token="**"))
+
+    credential = CertificateCredential(
+        "tenant-id", "client-id", CERT_PATH, policies=[ContentDecodePolicy(), policy], transport=Mock(send=send)
+    )
+
+    await credential.get_token("scope")
+
+    assert policy.on_request.called
+
+
 @pytest.mark.asyncio
 async def test_request_url():
     authority = "authority.com"