1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
# Copyright 2025, the TUF contributors
# SPDX-License-Identifier: MIT OR Apache-2.0
"""Test ngclient ProxyEnvironment"""
from __future__ import annotations
import sys
import unittest
from unittest.mock import Mock, patch
from urllib3 import PoolManager, ProxyManager
from tests import utils
from tuf.ngclient._internal.proxy import ProxyEnvironment
class TestProxyEnvironment(unittest.TestCase):
"""Test ngclient ProxyEnvironment implementation
These tests use the ProxyEnvironment.get_pool_manager() endpoint and then
look at the ProxyEnvironment._poolmanagers dict keys to decide if the result
is correct.
The test environment is changed via mocking getproxies(): this is a urllib
method that returns a dict with the proxy environment variable contents.
Testing ProxyEnvironment.request() would possibly be better but far more
difficult: the current test implementation does not require actually setting up
all of the different proxies.
"""
def assert_pool_managers(
self, env: ProxyEnvironment, expected: list[str | None]
) -> None:
# Pool managers have the expected proxy urls
self.assertEqual(list(env._pool_managers.keys()), expected)
# Pool manager types are as expected
for proxy_url, pool_manager in env._pool_managers.items():
self.assertIsInstance(pool_manager, PoolManager)
if proxy_url is not None:
self.assertIsInstance(pool_manager, ProxyManager)
@patch("tuf.ngclient._internal.proxy.getproxies")
def test_no_variables(self, mock_getproxies: Mock) -> None:
mock_getproxies.return_value = {}
env = ProxyEnvironment()
env.get_pool_manager("http", "example.com")
env.get_pool_manager("https", "example.com")
env.get_pool_manager("https", "example.com")
env.get_pool_manager("https", "subdomain.example.com")
env.get_pool_manager("https", "differentsite.com")
# There is a single pool manager (no proxies)
self.assert_pool_managers(env, [None])
@patch("tuf.ngclient._internal.proxy.getproxies")
def test_proxy_set(self, mock_getproxies: Mock) -> None:
mock_getproxies.return_value = {
"https": "http://localhost:8888",
}
env = ProxyEnvironment()
env.get_pool_manager("http", "example.com")
env.get_pool_manager("https", "example.com")
env.get_pool_manager("https", "example.com")
env.get_pool_manager("https", "differentsite.com")
# There are two pool managers: A plain poolmanager and https proxymanager
self.assert_pool_managers(env, [None, "http://localhost:8888"])
@patch("tuf.ngclient._internal.proxy.getproxies")
def test_proxies_set(self, mock_getproxies: Mock) -> None:
mock_getproxies.return_value = {
"http": "http://localhost:8888",
"https": "http://localhost:9999",
}
env = ProxyEnvironment()
env.get_pool_manager("http", "example.com")
env.get_pool_manager("https", "example.com")
env.get_pool_manager("https", "example.com")
env.get_pool_manager("https", "subdomain.example.com")
env.get_pool_manager("https", "differentsite.com")
# There are two pool managers: A http proxymanager and https proxymanager
self.assert_pool_managers(
env, ["http://localhost:8888", "http://localhost:9999"]
)
@patch("tuf.ngclient._internal.proxy.getproxies")
def test_no_proxy_set(self, mock_getproxies: Mock) -> None:
mock_getproxies.return_value = {
"http": "http://localhost:8888",
"https": "http://localhost:9999",
"no": "somesite.com, example.com, another.site.com",
}
env = ProxyEnvironment()
env.get_pool_manager("http", "example.com")
env.get_pool_manager("https", "example.com")
env.get_pool_manager("https", "example.com")
# There is a single pool manager (no proxies)
self.assert_pool_managers(env, [None])
env.get_pool_manager("http", "differentsite.com")
env.get_pool_manager("https", "differentsite.com")
# There are three pool managers: plain poolmanager for no_proxy domains,
# http proxymanager and https proxymanager
self.assert_pool_managers(
env, [None, "http://localhost:8888", "http://localhost:9999"]
)
@patch("tuf.ngclient._internal.proxy.getproxies")
def test_no_proxy_subdomain_match(self, mock_getproxies: Mock) -> None:
mock_getproxies.return_value = {
"https": "http://localhost:9999",
"no": "somesite.com, example.com, another.site.com",
}
env = ProxyEnvironment()
# this should match example.com in no_proxy
env.get_pool_manager("https", "subdomain.example.com")
# There is a single pool manager (no proxies)
self.assert_pool_managers(env, [None])
# this should not match example.com in no_proxy
env.get_pool_manager("https", "xexample.com")
# There are two pool managers: plain poolmanager for no_proxy domains,
# and a https proxymanager
self.assert_pool_managers(env, [None, "http://localhost:9999"])
@patch("tuf.ngclient._internal.proxy.getproxies")
def test_no_proxy_wildcard(self, mock_getproxies: Mock) -> None:
mock_getproxies.return_value = {
"https": "http://localhost:8888",
"no": "*",
}
env = ProxyEnvironment()
env.get_pool_manager("https", "example.com")
env.get_pool_manager("https", "differentsite.com")
env.get_pool_manager("https", "subdomain.example.com")
# There is a single pool manager, no proxies
self.assert_pool_managers(env, [None])
@patch("tuf.ngclient._internal.proxy.getproxies")
def test_no_proxy_leading_dot(self, mock_getproxies: Mock) -> None:
mock_getproxies.return_value = {
"https": "http://localhost:8888",
"no": ".example.com",
}
env = ProxyEnvironment()
env.get_pool_manager("https", "example.com")
env.get_pool_manager("https", "subdomain.example.com")
# There is a single pool manager, no proxies
self.assert_pool_managers(env, [None])
@patch("tuf.ngclient._internal.proxy.getproxies")
def test_all_proxy_set(self, mock_getproxies: Mock) -> None:
mock_getproxies.return_value = {
"all": "http://localhost:8888",
}
env = ProxyEnvironment()
env.get_pool_manager("http", "example.com")
env.get_pool_manager("https", "example.com")
env.get_pool_manager("https", "example.com")
env.get_pool_manager("https", "subdomain.example.com")
env.get_pool_manager("https", "differentsite.com")
# There is a single proxy manager
self.assert_pool_managers(env, ["http://localhost:8888"])
# This urllib3 currently only handles http and https but let's test anyway
env.get_pool_manager("file", None)
# proxy manager and a plain pool manager
self.assert_pool_managers(env, ["http://localhost:8888", None])
@patch("tuf.ngclient._internal.proxy.getproxies")
def test_all_proxy_and_no_proxy_set(self, mock_getproxies: Mock) -> None:
mock_getproxies.return_value = {
"all": "http://localhost:8888",
"no": "somesite.com, example.com, another.site.com",
}
env = ProxyEnvironment()
env.get_pool_manager("http", "example.com")
env.get_pool_manager("https", "example.com")
env.get_pool_manager("https", "example.com")
env.get_pool_manager("https", "subdomain.example.com")
# There is a single pool manager (no proxies)
self.assert_pool_managers(env, [None])
env.get_pool_manager("http", "differentsite.com")
env.get_pool_manager("https", "differentsite.com")
# There are two pool managers: plain poolmanager for no_proxy domains and
# one proxymanager
self.assert_pool_managers(env, [None, "http://localhost:8888"])
if __name__ == "__main__":
utils.configure_test_logging(sys.argv)
unittest.main()
|
