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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
|
from __future__ import annotations
import socket
from unittest import mock
import pytest
from urllib3.connection import _get_default_user_agent
from urllib3.exceptions import ConnectionError
from urllib3.http2.connection import (
HTTP2Connection,
_is_illegal_header_value,
_is_legal_header_name,
)
# [1] https://httpwg.org/specs/rfc9113.html#n-field-validity
class TestHTTP2Connection:
def test__is_legal_header_name(self) -> None:
assert _is_legal_header_name(b"foo"), "foo"
assert _is_legal_header_name(b"foo-bar"), "foo-bar"
assert _is_legal_header_name(b"foo-bar-baz"), "foo-bar-baz"
# A field name MUST NOT contain characters in the ranges 0x00-0x20,
# 0x41-0x5a, or 0x7f-0xff (all ranges inclusive). [1]
for i in range(0x00, 0x20):
assert not _is_legal_header_name(
f"foo{chr(i)}bar".encode()
), f"foo\\x{i}bar"
for i in range(0x41, 0x5A):
assert not _is_legal_header_name(
f"foo{chr(i)}bar".encode()
), f"foo\\x{i}bar"
for i in range(0x7F, 0xFF):
assert not _is_legal_header_name(
f"foo{chr(i)}bar".encode()
), f"foo\\x{i}bar"
# This specifically excludes all non-visible ASCII characters, ASCII SP
# (0x20), and uppercase characters ('A' to 'Z', ASCII 0x41 to 0x5a). [1]
assert not _is_legal_header_name(b"foo bar"), "foo bar"
assert not _is_legal_header_name(b"foo\x20bar"), "foo\\x20bar"
assert not _is_legal_header_name(b"Foo-Bar"), "Foo-Bar"
# With the exception of pseudo-header fields (Section 8.3), which have a
# name that starts with a single colon, field names MUST NOT include a
# colon (ASCII COLON, 0x3a). [1]
assert not _is_legal_header_name(b":foo"), ":foo"
assert not _is_legal_header_name(b"foo:bar"), "foo:bar"
assert not _is_legal_header_name(b"foo:"), "foo:"
def test__is_illegal_header_value(self) -> None:
assert not _is_illegal_header_value(b"foo"), "foo"
assert not _is_illegal_header_value(b"foo bar"), "foo bar"
assert not _is_illegal_header_value(b"foo\tbar"), "foo\\tbar"
# A field value MUST NOT contain the zero value (ASCII NUL, 0x00), line
# feed (ASCII LF, 0x0a), or carriage return (ASCII CR, 0x0d) at any
# position. [1]
assert _is_illegal_header_value(b"foo\0bar"), "foo\\0bar"
assert _is_illegal_header_value(b"foo\x00bar"), "foo\\x00bar"
assert _is_illegal_header_value(b"foo\x0abar"), "foo\\x0abar"
assert _is_illegal_header_value(b"foo\x0dbar"), "foo\\x0dbar"
assert _is_illegal_header_value(b"foo\rbar"), "foo\\rbar"
assert _is_illegal_header_value(b"foo\nbar"), "foo\\nbar"
assert _is_illegal_header_value(b"foo\r\nbar"), "foo\\r\\nbar"
# A field value MUST NOT start or end with an ASCII whitespace character
# (ASCII SP or HTAB, 0x20 or 0x09). [1]
assert _is_illegal_header_value(b" foo"), " foo"
assert _is_illegal_header_value(b"foo "), "foo "
assert _is_illegal_header_value(b"foo\x20"), "foo\\x20"
assert _is_illegal_header_value(b"\tfoo"), "\\tfoo"
assert _is_illegal_header_value(b"foo\t"), "foo\\t"
assert _is_illegal_header_value(b"foo\x09"), "foo\\x09"
def test_default_socket_options(self) -> None:
conn = HTTP2Connection("example.com")
assert conn.socket_options == [(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)]
assert conn.port == 443
def test_putheader(self) -> None:
conn = HTTP2Connection("example.com")
conn.putheader("foo", "bar")
assert conn._headers == [(b"foo", b"bar")]
def test_request_putheader(self) -> None:
conn = HTTP2Connection("example.com")
conn.sock = mock.MagicMock(
sendall=mock.Mock(return_value=None),
)
conn.putheader = mock.MagicMock(return_value=None) # type: ignore[method-assign]
conn.request("GET", "/", headers={"foo": "bar"})
conn.putheader.assert_has_calls(
[
mock.call("foo", "bar"),
mock.call(b"user-agent", _get_default_user_agent()),
]
)
def test_putheader_ValueError(self) -> None:
conn = HTTP2Connection("example.com")
with pytest.raises(ValueError):
conn.putheader("foo\0bar", "baz")
with pytest.raises(ValueError):
conn.putheader("foo", "foo\r\nbar")
def test_endheaders_ConnectionError(self) -> None:
conn = HTTP2Connection("example.com")
with pytest.raises(ConnectionError):
conn.endheaders()
def test_send_ConnectionError(self) -> None:
conn = HTTP2Connection("example.com")
with pytest.raises(ConnectionError):
conn.send(b"foo")
def test_send_bytes(self) -> None:
conn = HTTP2Connection("example.com")
conn.sock = mock.MagicMock(
sendall=mock.Mock(return_value=None),
)
conn._h2_conn._obj.data_to_send = mock.Mock(return_value=b"bar")
conn._h2_conn._obj.send_data = mock.Mock(return_value=None)
conn._h2_conn._obj.get_next_available_stream_id = mock.Mock(return_value=1)
conn.putrequest("GET", "/")
conn.endheaders()
conn.send(b"foo")
conn._h2_conn._obj.data_to_send.assert_called_with()
conn.sock.sendall.assert_called_with(b"bar")
conn._h2_conn._obj.send_data.assert_called_with(1, b"foo", end_stream=True)
def test_send_str(self) -> None:
conn = HTTP2Connection("example.com")
conn.sock = mock.MagicMock(
sendall=mock.Mock(return_value=None),
)
conn._h2_conn._obj.data_to_send = mock.Mock(return_value=b"bar")
conn._h2_conn._obj.send_data = mock.Mock(return_value=None)
conn._h2_conn._obj.get_next_available_stream_id = mock.Mock(return_value=1)
conn.putrequest("GET", "/")
conn.endheaders(message_body=b"foo")
conn.send("foo")
conn._h2_conn._obj.data_to_send.assert_called_with()
conn.sock.sendall.assert_called_with(b"bar")
conn._h2_conn._obj.send_data.assert_called_with(1, b"foo", end_stream=True)
def test_send_iter(self) -> None:
conn = HTTP2Connection("example.com")
conn.sock = mock.MagicMock(
sendall=mock.Mock(return_value=None),
)
conn._h2_conn._obj.data_to_send = mock.Mock(return_value=b"baz")
conn._h2_conn._obj.send_data = mock.Mock(return_value=None)
conn._h2_conn._obj.get_next_available_stream_id = mock.Mock(return_value=1)
conn._h2_conn._obj.end_stream = mock.Mock(return_value=None)
conn.putrequest("GET", "/")
conn.endheaders(message_body=[b"foo", b"bar"])
conn.send([b"foo", b"bar"])
conn._h2_conn._obj.data_to_send.assert_has_calls(
[
mock.call(),
mock.call(),
]
)
conn.sock.sendall.assert_has_calls(
[
mock.call(b"baz"),
mock.call(b"baz"),
]
)
conn._h2_conn._obj.send_data.assert_has_calls(
[
mock.call(1, b"foo", end_stream=False),
mock.call(1, b"bar", end_stream=False),
]
)
conn._h2_conn._obj.end_stream.assert_called_with(1)
def test_send_file_str(self) -> None:
conn = HTTP2Connection("example.com")
mock_open = mock.mock_open(read_data="foo\r\nbar\r\n")
with mock.patch("builtins.open", mock_open):
conn.sock = mock.MagicMock(
sendall=mock.Mock(return_value=None),
)
conn._h2_conn._obj.data_to_send = mock.Mock(return_value=b"foo")
conn._h2_conn._obj.send_data = mock.Mock(return_value=None)
conn._h2_conn._obj.get_next_available_stream_id = mock.Mock(return_value=1)
conn._h2_conn._obj.end_stream = mock.Mock(return_value=None)
with open("foo") as body:
conn.putrequest("GET", "/")
conn.endheaders(message_body=body)
conn.send(body)
conn._h2_conn._obj.data_to_send.assert_called_with()
conn.sock.sendall.assert_called_with(b"foo")
conn._h2_conn._obj.send_data.assert_called_with(
1, b"foo\r\nbar\r\n", end_stream=False
)
conn._h2_conn._obj.end_stream.assert_called_with(1)
def test_send_file_bytes(self) -> None:
conn = HTTP2Connection("example.com")
mock_open = mock.mock_open(read_data=b"foo\r\nbar\r\n")
with mock.patch("builtins.open", mock_open):
conn.sock = mock.MagicMock(
sendall=mock.Mock(return_value=None),
)
conn._h2_conn._obj.data_to_send = mock.Mock(return_value=b"foo")
conn._h2_conn._obj.send_data = mock.Mock(return_value=None)
conn._h2_conn._obj.get_next_available_stream_id = mock.Mock(return_value=1)
conn._h2_conn._obj.end_stream = mock.Mock(return_value=None)
body = open("foo", "rb")
conn.putrequest("GET", "/")
conn.endheaders(message_body=body)
conn.send(body)
conn._h2_conn._obj.data_to_send.assert_called_with()
conn.sock.sendall.assert_called_with(b"foo")
conn._h2_conn._obj.send_data.assert_called_with(
1, b"foo\r\nbar\r\n", end_stream=False
)
conn._h2_conn._obj.end_stream.assert_called_with(1)
def test_send_invalid_type(self) -> None:
conn = HTTP2Connection("example.com")
conn.putrequest("GET", "/")
with pytest.raises(TypeError):
conn.send(1)
def test_request_GET(self) -> None:
conn = HTTP2Connection("example.com")
conn.sock = mock.MagicMock(
sendall=mock.Mock(return_value=None),
)
sendall = conn.sock.sendall
data_to_send = conn._h2_conn._obj.data_to_send = mock.Mock(return_value=b"foo")
send_headers = conn._h2_conn._obj.send_headers = mock.Mock(return_value=None)
conn._h2_conn._obj.send_data = mock.Mock(return_value=None)
conn._h2_conn._obj.get_next_available_stream_id = mock.Mock(return_value=1)
close_connection = conn._h2_conn._obj.close_connection = mock.Mock(
return_value=None
)
conn.request("GET", "/")
conn.close()
data_to_send.assert_called_with()
sendall.assert_called_with(b"foo")
send_headers.assert_called_with(
stream_id=1,
headers=[
(b":scheme", b"https"),
(b":method", b"GET"),
(b":authority", b"example.com:443"),
(b":path", b"/"),
(b"user-agent", _get_default_user_agent().encode()),
],
end_stream=True,
)
close_connection.assert_called_with()
def test_request_POST(self) -> None:
conn = HTTP2Connection("example.com")
conn.sock = mock.MagicMock(
sendall=mock.Mock(return_value=None),
)
sendall = conn.sock.sendall
data_to_send = conn._h2_conn._obj.data_to_send = mock.Mock(return_value=b"foo")
send_headers = conn._h2_conn._obj.send_headers = mock.Mock(return_value=None)
send_data = conn._h2_conn._obj.send_data = mock.Mock(return_value=None)
conn._h2_conn._obj.get_next_available_stream_id = mock.Mock(return_value=1)
close_connection = conn._h2_conn._obj.close_connection = mock.Mock(
return_value=None
)
conn.request("POST", "/", body=b"foo")
conn.close()
data_to_send.assert_called_with()
sendall.assert_called_with(b"foo")
send_headers.assert_called_with(
stream_id=1,
headers=[
(b":scheme", b"https"),
(b":method", b"POST"),
(b":authority", b"example.com:443"),
(b":path", b"/"),
(b"user-agent", _get_default_user_agent().encode()),
],
end_stream=False,
)
send_data.assert_called_with(1, b"foo", end_stream=True)
close_connection.assert_called_with()
def test_close(self) -> None:
conn = HTTP2Connection("example.com")
conn.sock = mock.MagicMock(
sendall=mock.Mock(side_effect=Exception("foo")),
)
sendall = conn.sock.sendall
data_to_send = conn._h2_conn._obj.data_to_send = mock.Mock(return_value=b"foo")
close_connection = conn._h2_conn._obj.close_connection = mock.Mock(
return_value=None
)
try:
conn.close()
except Exception:
assert False, "Exception was raised"
close_connection.assert_called_with()
data_to_send.assert_called_with()
sendall.assert_called_with(b"foo")
assert conn._h2_stream is None
assert conn._headers == []
def test_request_ignore_chunked(self) -> None:
conn = HTTP2Connection("example.com")
conn.sock = mock.MagicMock(
sendall=mock.Mock(return_value=None),
)
sendall = conn.sock.sendall
data_to_send = conn._h2_conn._obj.data_to_send = mock.Mock(return_value=b"foo")
send_headers = conn._h2_conn._obj.send_headers = mock.Mock(return_value=None)
conn._h2_conn._obj.send_data = mock.Mock(return_value=None)
conn._h2_conn._obj.get_next_available_stream_id = mock.Mock(return_value=1)
close_connection = conn._h2_conn._obj.close_connection = mock.Mock(
return_value=None
)
conn.request("GET", "/", headers={"Transfer-Encoding": "chunked"}, chunked=True)
conn.close()
data_to_send.assert_called_with()
sendall.assert_called_with(b"foo")
send_headers.assert_called_with(
stream_id=1,
headers=[
(b":scheme", b"https"),
(b":method", b"GET"),
(b":authority", b"example.com:443"),
(b":path", b"/"),
(b"user-agent", _get_default_user_agent().encode()),
],
end_stream=True,
)
close_connection.assert_called_with()
|
