|
| 1 | +# ------------------------------------ |
| 2 | +# Copyright (c) Microsoft Corporation. |
| 3 | +# Licensed under the MIT License. |
| 4 | +# ------------------------------------ |
| 5 | +"""Tests for policy override support in azure-identity pipelines.""" |
| 6 | + |
| 7 | +from unittest.mock import Mock |
| 8 | + |
| 9 | +import pytest |
| 10 | + |
| 11 | +from azure.core.pipeline.policies import ( |
| 12 | + ContentDecodePolicy, |
| 13 | + CustomHookPolicy, |
| 14 | + DistributedTracingPolicy, |
| 15 | + HeadersPolicy, |
| 16 | + HttpLoggingPolicy, |
| 17 | + NetworkTraceLoggingPolicy, |
| 18 | + ProxyPolicy, |
| 19 | + RequestIdPolicy, |
| 20 | + RetryPolicy, |
| 21 | + SansIOHTTPPolicy, |
| 22 | + UserAgentPolicy, |
| 23 | +) |
| 24 | + |
| 25 | +from azure.identity._internal.pipeline import ( |
| 26 | + _get_config, |
| 27 | + _get_policies, |
| 28 | + build_pipeline, |
| 29 | + build_async_pipeline, |
| 30 | +) |
| 31 | + |
| 32 | +CONFIG_POLICIES = [ |
| 33 | + ("custom_hook_policy", CustomHookPolicy), |
| 34 | + ("headers_policy", HeadersPolicy), |
| 35 | + ("http_logging_policy", HttpLoggingPolicy), |
| 36 | + ("logging_policy", NetworkTraceLoggingPolicy), |
| 37 | + ("proxy_policy", ProxyPolicy), |
| 38 | + ("user_agent_policy", UserAgentPolicy), |
| 39 | +] |
| 40 | + |
| 41 | + |
| 42 | +class TestGetConfigPolicyOverrides: |
| 43 | + """Tests that _get_config respects policy override kwargs.""" |
| 44 | + |
| 45 | + def test_default_policies_created_when_no_overrides(self): |
| 46 | + config = _get_config() |
| 47 | + for attr, cls in CONFIG_POLICIES: |
| 48 | + assert isinstance(getattr(config, attr), cls) |
| 49 | + |
| 50 | + @pytest.mark.parametrize("kwarg,cls", CONFIG_POLICIES) |
| 51 | + def test_single_policy_override(self, kwarg, cls): |
| 52 | + custom = Mock(spec=cls) |
| 53 | + config = _get_config(**{kwarg: custom}) |
| 54 | + assert getattr(config, kwarg) is custom |
| 55 | + |
| 56 | + @pytest.mark.parametrize("kwarg,cls", CONFIG_POLICIES) |
| 57 | + def test_non_overridden_policies_unaffected(self, kwarg, cls): |
| 58 | + """Overriding one policy should not affect others.""" |
| 59 | + custom = Mock(spec=cls) |
| 60 | + config = _get_config(**{kwarg: custom}) |
| 61 | + for other_attr, other_cls in CONFIG_POLICIES: |
| 62 | + if other_attr == kwarg: |
| 63 | + assert getattr(config, other_attr) is custom |
| 64 | + else: |
| 65 | + assert isinstance(getattr(config, other_attr), other_cls) |
| 66 | + |
| 67 | + |
| 68 | +class TestGetPoliciesOverrides: |
| 69 | + """Tests for per_call_policies and per_retry_policies in _get_policies.""" |
| 70 | + |
| 71 | + @staticmethod |
| 72 | + def _make_config(): |
| 73 | + config = _get_config() |
| 74 | + config.retry_policy = RetryPolicy() |
| 75 | + return config |
| 76 | + |
| 77 | + def test_default_policy_order(self): |
| 78 | + policies = _get_policies(self._make_config()) |
| 79 | + |
| 80 | + assert [type(p) for p in policies] == [ |
| 81 | + RequestIdPolicy, |
| 82 | + HeadersPolicy, |
| 83 | + UserAgentPolicy, |
| 84 | + ProxyPolicy, |
| 85 | + ContentDecodePolicy, |
| 86 | + RetryPolicy, |
| 87 | + CustomHookPolicy, |
| 88 | + NetworkTraceLoggingPolicy, |
| 89 | + DistributedTracingPolicy, |
| 90 | + HttpLoggingPolicy, |
| 91 | + ] |
| 92 | + |
| 93 | + @pytest.mark.parametrize("as_list", [False, True], ids=["single", "list"]) |
| 94 | + def test_per_call_policies_inserted_before_retry(self, as_list): |
| 95 | + custom_policies = [Mock(spec=SansIOHTTPPolicy) for _ in range(2 if as_list else 1)] |
| 96 | + arg = custom_policies if as_list else custom_policies[0] |
| 97 | + |
| 98 | + policies = _get_policies(self._make_config(), per_call_policies=arg) |
| 99 | + retry_idx = next(i for i, p in enumerate(policies) if isinstance(p, RetryPolicy)) |
| 100 | + for custom in custom_policies: |
| 101 | + assert policies.index(custom) < retry_idx |
| 102 | + |
| 103 | + @pytest.mark.parametrize("as_list", [False, True], ids=["single", "list"]) |
| 104 | + def test_per_retry_policies_inserted_after_retry(self, as_list): |
| 105 | + custom_policies = [Mock(spec=SansIOHTTPPolicy) for _ in range(2 if as_list else 1)] |
| 106 | + arg = custom_policies if as_list else custom_policies[0] |
| 107 | + |
| 108 | + policies = _get_policies(self._make_config(), per_retry_policies=arg) |
| 109 | + retry_idx = next(i for i, p in enumerate(policies) if isinstance(p, RetryPolicy)) |
| 110 | + for custom in custom_policies: |
| 111 | + assert policies.index(custom) > retry_idx |
| 112 | + |
| 113 | + def test_both_per_call_and_per_retry(self): |
| 114 | + per_call = Mock(spec=SansIOHTTPPolicy) |
| 115 | + per_retry = Mock(spec=SansIOHTTPPolicy) |
| 116 | + |
| 117 | + policies = _get_policies(self._make_config(), per_call_policies=per_call, per_retry_policies=per_retry) |
| 118 | + retry_idx = next(i for i, p in enumerate(policies) if isinstance(p, RetryPolicy)) |
| 119 | + assert policies.index(per_call) < retry_idx |
| 120 | + assert policies.index(per_retry) > retry_idx |
| 121 | + |
| 122 | + |
| 123 | +class TestBuildPipelineOverrides: |
| 124 | + """Tests for policy overrides in build_pipeline and build_async_pipeline.""" |
| 125 | + |
| 126 | + @pytest.mark.parametrize("builder", [build_pipeline, build_async_pipeline]) |
| 127 | + def test_retry_policy_override(self, builder): |
| 128 | + custom_retry = Mock(spec=RetryPolicy) |
| 129 | + pipeline = builder(retry_policy=custom_retry, transport=Mock()) |
| 130 | + effective_policies = [getattr(policy, "_policy", policy) for policy in pipeline._impl_policies] |
| 131 | + assert custom_retry in effective_policies |
| 132 | + |
| 133 | + def test_default_retry_policy_when_no_override(self): |
| 134 | + pipeline = build_pipeline(transport=Mock()) |
| 135 | + retry_policies = [p for p in pipeline._impl_policies if isinstance(p, RetryPolicy)] |
| 136 | + assert len(retry_policies) == 1 |
| 137 | + |
| 138 | + @pytest.mark.parametrize("builder", [build_pipeline, build_async_pipeline]) |
| 139 | + def test_policy_override_flows_through(self, builder): |
| 140 | + """Verify that config policy overrides reach the pipeline.""" |
| 141 | + custom_headers = Mock(spec=HeadersPolicy) |
| 142 | + pipeline = builder(headers_policy=custom_headers, transport=Mock()) |
| 143 | + effective_policies = [getattr(policy, "_policy", policy) for policy in pipeline._impl_policies] |
| 144 | + assert custom_headers in effective_policies |
0 commit comments