-
-
Notifications
You must be signed in to change notification settings - Fork 41
/
test_restrict_hosts.py
258 lines (187 loc) · 6.71 KB
/
test_restrict_hosts.py
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
import inspect
import pytest
localhost = "127.0.0.1"
connect_code_template = """
import socket
import pytest
{3}
def {2}():
socket.socket().connect(('{0}', {1}))
"""
connect_unicode_code_template = """
import socket
import pytest
{3}
def {2}():
socket.socket().connect((u'{0}', {1}))
"""
urlopen_code_template = """
import pytest
from urllib.request import urlopen
{3}
def {2}():
assert urlopen('http:https://{0}:{1}/').getcode() == 200
"""
def assert_host_blocked(result, host):
result.stdout.fnmatch_lines(
f'*A test tried to use socket.socket.connect() with host "{host}"*'
)
@pytest.fixture
def assert_connect(httpbin, testdir):
def assert_socket_connect(should_pass, **kwargs):
# get the name of the calling function
test_name = inspect.stack()[1][3]
mark = ""
cli_arg = kwargs.get("cli_arg", None)
code_template = kwargs.get("code_template", connect_code_template)
mark_arg = kwargs.get("mark_arg", None)
if mark_arg:
if isinstance(mark_arg, str):
mark = f'@pytest.mark.allow_hosts("{mark_arg}")'
elif isinstance(mark_arg, list):
hosts = '","'.join(mark_arg)
mark = f'@pytest.mark.allow_hosts(["{hosts}"])'
code = code_template.format(httpbin.host, httpbin.port, test_name, mark)
testdir.makepyfile(code)
if cli_arg:
result = testdir.runpytest(f"--allow-hosts={cli_arg}")
else:
result = testdir.runpytest()
if should_pass:
result.assert_outcomes(1, 0, 0)
else:
result.assert_outcomes(0, 0, 1)
assert_host_blocked(result, httpbin.host)
return assert_socket_connect
def test_help_message(testdir):
result = testdir.runpytest(
"--help",
)
result.stdout.fnmatch_lines(
[
"socket:",
"*--allow-hosts=ALLOWED_HOSTS_CSV",
"*Only allow specified hosts through",
"*socket.socket.connect((host, port)).",
]
)
def test_marker_help_message(testdir):
result = testdir.runpytest(
"--markers",
)
result.stdout.fnmatch_lines(
[
"@pytest.mark.allow_hosts([[]hosts[]]): "
"Restrict socket connection to defined list of hosts",
]
)
def test_default_connect_enabled(assert_connect):
assert_connect(True)
def test_single_cli_arg_connect_enabled(assert_connect):
assert_connect(True, cli_arg=localhost)
def test_single_cli_arg_connect_unicode_enabled(assert_connect):
assert_connect(True, cli_arg=localhost, code_template=connect_unicode_code_template)
def test_multiple_cli_arg_connect_enabled(assert_connect):
assert_connect(True, cli_arg=localhost + ",1.2.3.4")
def test_single_mark_arg_connect_enabled(assert_connect):
assert_connect(True, mark_arg=localhost)
def test_multiple_mark_arg_csv_connect_enabled(assert_connect):
assert_connect(True, mark_arg=localhost + ",1.2.3.4")
def test_multiple_mark_arg_list_connect_enabled(assert_connect):
assert_connect(True, mark_arg=[localhost, "1.2.3.4"])
def test_mark_cli_conflict_mark_wins_connect_enabled(assert_connect):
assert_connect(True, mark_arg=[localhost], cli_arg="1.2.3.4")
def test_single_cli_arg_connect_disabled(assert_connect):
assert_connect(
False, cli_arg="1.2.3.4", code_template=connect_unicode_code_template
)
def test_multiple_cli_arg_connect_disabled(assert_connect):
assert_connect(False, cli_arg="5.6.7.8,1.2.3.4")
def test_single_mark_arg_connect_disabled(assert_connect):
assert_connect(False, mark_arg="1.2.3.4")
def test_multiple_mark_arg_csv_connect_disabled(assert_connect):
assert_connect(False, mark_arg="5.6.7.8,1.2.3.4")
def test_multiple_mark_arg_list_connect_disabled(assert_connect):
assert_connect(False, mark_arg=["5.6.7.8", "1.2.3.4"])
def test_mark_cli_conflict_mark_wins_connect_disabled(assert_connect):
assert_connect(False, mark_arg=["1.2.3.4"], cli_arg=localhost)
def test_default_urlopen_succeeds_by_default(assert_connect):
assert_connect(True, code_template=urlopen_code_template)
def test_single_cli_arg_urlopen_enabled(assert_connect):
assert_connect(
True, cli_arg=localhost + ",1.2.3.4", code_template=urlopen_code_template
)
def test_single_mark_arg_urlopen_enabled(assert_connect):
assert_connect(
True, mark_arg=[localhost, "1.2.3.4"], code_template=urlopen_code_template
)
def test_global_restrict_via_config_fail(testdir):
testdir.makepyfile(
"""
import socket
def test_global_restrict_via_config_fail():
socket.socket().connect(('127.0.0.1', 80))
"""
)
testdir.makeini(
"""
[pytest]
addopts = --allow-hosts=2.2.2.2
"""
)
result = testdir.runpytest()
result.assert_outcomes(0, 0, 1)
assert_host_blocked(result, "127.0.0.1")
def test_global_restrict_via_config_pass(testdir, httpbin):
testdir.makepyfile(
f"""
import socket
def test_global_restrict_via_config_pass():
socket.socket().connect(('{httpbin.host}', {httpbin.port}))
"""
)
testdir.makeini(
f"""
[pytest]
addopts = --allow-hosts={httpbin.host}
"""
)
result = testdir.runpytest()
result.assert_outcomes(1, 0, 0)
def test_test_isolation(testdir, httpbin):
testdir.makepyfile(
f"""
import pytest
import socket
@pytest.mark.allow_hosts('{httpbin.host}')
def test_pass():
socket.socket().connect(('{httpbin.host}', {httpbin.port}))
@pytest.mark.allow_hosts('2.2.2.2')
def test_fail():
socket.socket().connect(('{httpbin.host}', {httpbin.port}))
def test_pass_2():
socket.socket().connect(('{httpbin.host}', {httpbin.port}))
"""
)
result = testdir.runpytest()
result.assert_outcomes(2, 0, 1)
assert_host_blocked(result, httpbin.host)
def test_conflicting_cli_vs_marks(testdir, httpbin):
testdir.makepyfile(
f"""
import pytest
import socket
@pytest.mark.allow_hosts('{httpbin.host}')
def test_pass():
socket.socket().connect(('{httpbin.host}', {httpbin.port}))
@pytest.mark.allow_hosts('2.2.2.2')
def test_fail():
socket.socket().connect(('{httpbin.host}', {httpbin.port}))
def test_fail_2():
socket.socket().connect(('2.2.2.2', {httpbin.port}))
"""
)
result = testdir.runpytest("--allow-hosts=1.2.3.4")
result.assert_outcomes(1, 0, 2)
assert_host_blocked(result, "2.2.2.2")
assert_host_blocked(result, httpbin.host)