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
|
from __future__ import annotations
import io
import json
import os
import typing as t
import pytest
from werkzeug import wsgi
from werkzeug.exceptions import BadRequest
from werkzeug.exceptions import ClientDisconnected
from werkzeug.test import Client
from werkzeug.test import create_environ
from werkzeug.test import run_wsgi_app
from werkzeug.wrappers import Response
from werkzeug.wsgi import _RangeWrapper
from werkzeug.wsgi import ClosingIterator
from werkzeug.wsgi import wrap_file
@pytest.mark.parametrize(
("environ", "expect"),
(
pytest.param({"HTTP_HOST": "spam"}, "spam", id="host"),
pytest.param({"HTTP_HOST": "spam:80"}, "spam", id="host, strip http port"),
pytest.param(
{"wsgi.url_scheme": "https", "HTTP_HOST": "spam:443"},
"spam",
id="host, strip https port",
),
pytest.param({"HTTP_HOST": "spam:8080"}, "spam:8080", id="host, custom port"),
pytest.param(
{"HTTP_HOST": "spam", "SERVER_NAME": "eggs", "SERVER_PORT": "80"},
"spam",
id="prefer host",
),
pytest.param(
{"SERVER_NAME": "eggs", "SERVER_PORT": "80"},
"eggs",
id="name, ignore http port",
),
pytest.param(
{"wsgi.url_scheme": "https", "SERVER_NAME": "eggs", "SERVER_PORT": "443"},
"eggs",
id="name, ignore https port",
),
pytest.param(
{"SERVER_NAME": "eggs", "SERVER_PORT": "8080"},
"eggs:8080",
id="name, custom port",
),
pytest.param(
{"HTTP_HOST": "ham", "HTTP_X_FORWARDED_HOST": "eggs"},
"ham",
id="ignore x-forwarded-host",
),
),
)
def test_get_host(environ, expect):
environ.setdefault("wsgi.url_scheme", "http")
assert wsgi.get_host(environ) == expect
def test_get_host_validate_trusted_hosts():
env = {"SERVER_NAME": "example.org", "SERVER_PORT": "80", "wsgi.url_scheme": "http"}
assert wsgi.get_host(env, trusted_hosts=[".example.org"]) == "example.org"
pytest.raises(BadRequest, wsgi.get_host, env, trusted_hosts=["example.com"])
env["SERVER_PORT"] = "8080"
assert wsgi.get_host(env, trusted_hosts=[".example.org:8080"]) == "example.org:8080"
pytest.raises(BadRequest, wsgi.get_host, env, trusted_hosts=[".example.com"])
env = {"HTTP_HOST": "example.org", "wsgi.url_scheme": "http"}
assert wsgi.get_host(env, trusted_hosts=[".example.org"]) == "example.org"
pytest.raises(BadRequest, wsgi.get_host, env, trusted_hosts=["example.com"])
def test_responder():
def foo(environ, start_response):
return Response(b"Test")
client = Client(wsgi.responder(foo))
response = client.get("/")
assert response.status_code == 200
assert response.data == b"Test"
def test_path_info_and_script_name_fetching():
env = create_environ("/\N{SNOWMAN}", "http://example.com/\N{COMET}/")
assert wsgi.get_path_info(env) == "/\N{SNOWMAN}"
def test_limited_stream():
class RaisingLimitedStream(wsgi.LimitedStream):
def on_exhausted(self):
raise BadRequest("input stream exhausted")
io_ = io.BytesIO(b"123456")
stream = RaisingLimitedStream(io_, 3)
assert stream.read() == b"123"
pytest.raises(BadRequest, stream.read)
io_ = io.BytesIO(b"123456")
stream = RaisingLimitedStream(io_, 3)
assert stream.tell() == 0
assert stream.read(1) == b"1"
assert stream.tell() == 1
assert stream.read(1) == b"2"
assert stream.tell() == 2
assert stream.read(1) == b"3"
assert stream.tell() == 3
pytest.raises(BadRequest, stream.read)
io_ = io.BytesIO(b"123456\nabcdefg")
stream = wsgi.LimitedStream(io_, 9)
assert stream.readline() == b"123456\n"
assert stream.readline() == b"ab"
io_ = io.BytesIO(b"123456\nabcdefg")
stream = wsgi.LimitedStream(io_, 9)
assert stream.readlines() == [b"123456\n", b"ab"]
io_ = io.BytesIO(b"123\n456\nabcdefg")
stream = wsgi.LimitedStream(io_, 9)
assert stream.readlines(2) == [b"123\n"]
assert stream.readlines() == [b"456\n", b"a"]
io_ = io.BytesIO(b"123456\nabcdefg")
stream = wsgi.LimitedStream(io_, 9)
assert stream.readline(100) == b"123456\n"
io_ = io.BytesIO(b"123456\nabcdefg")
stream = wsgi.LimitedStream(io_, 9)
assert stream.readlines(100) == [b"123456\n", b"ab"]
io_ = io.BytesIO(b"123456")
stream = wsgi.LimitedStream(io_, 3)
assert stream.read(1) == b"1"
assert stream.read(1) == b"2"
assert stream.read() == b"3"
assert stream.read() == b""
io_ = io.BytesIO(b"123456")
stream = wsgi.LimitedStream(io_, 3)
assert stream.read(-1) == b"123"
io_ = io.BytesIO(b"123456")
stream = wsgi.LimitedStream(io_, 0)
assert stream.read(-1) == b""
stream = wsgi.LimitedStream(io.BytesIO(b"123\n456\n"), 8)
assert list(stream) == [b"123\n", b"456\n"]
def test_limited_stream_json_load():
stream = wsgi.LimitedStream(io.BytesIO(b'{"hello": "test"}'), 17)
# flask.json adapts bytes to text with TextIOWrapper
# this expects stream.readable() to exist and return true
stream = io.TextIOWrapper(io.BufferedReader(stream), "UTF-8")
data = json.load(stream)
assert data == {"hello": "test"}
def test_limited_stream_disconnection():
# disconnect because stream returns zero bytes
stream = wsgi.LimitedStream(io.BytesIO(), 255)
with pytest.raises(ClientDisconnected):
stream.read()
# disconnect because stream is closed
data = io.BytesIO(b"x" * 255)
data.close()
stream = wsgi.LimitedStream(data, 255)
with pytest.raises(ClientDisconnected):
stream.read()
def test_limited_stream_read_with_raw_io():
class OneByteStream(t.BinaryIO):
def __init__(self, buf: bytes) -> None:
self.buf = buf
self.pos = 0
def read(self, size: int | None = None) -> bytes:
"""Return one byte at a time regardless of requested size."""
if size is None or size == -1:
raise ValueError("expected read to be called with specific limit")
if size == 0 or len(self.buf) < self.pos:
return b""
b = self.buf[self.pos : self.pos + 1]
self.pos += 1
return b
stream = wsgi.LimitedStream(OneByteStream(b"foo"), 4)
assert stream.read(5) == b"f"
assert stream.read(5) == b"o"
assert stream.read(5) == b"o"
# The stream has fewer bytes (3) than the limit (4), therefore the read returns 0
# bytes before the limit is reached.
with pytest.raises(ClientDisconnected):
stream.read(5)
stream = wsgi.LimitedStream(OneByteStream(b"foo123"), 3)
assert stream.read(5) == b"f"
assert stream.read(5) == b"o"
assert stream.read(5) == b"o"
# The limit was reached, therefore the wrapper is exhausted, not disconnected.
assert stream.read(5) == b""
stream = wsgi.LimitedStream(OneByteStream(b"foo"), 3)
assert stream.read() == b"foo"
stream = wsgi.LimitedStream(OneByteStream(b"foo"), 2)
assert stream.read() == b"fo"
def test_get_host_fallback():
assert (
wsgi.get_host(
{
"SERVER_NAME": "foobar.example.com",
"wsgi.url_scheme": "http",
"SERVER_PORT": "80",
}
)
== "foobar.example.com"
)
assert (
wsgi.get_host(
{
"SERVER_NAME": "foobar.example.com",
"wsgi.url_scheme": "http",
"SERVER_PORT": "81",
}
)
== "foobar.example.com:81"
)
def test_get_current_url_unicode():
env = create_environ(query_string="foo=bar&baz=blah&meh=\xcf")
rv = wsgi.get_current_url(env)
assert rv == "http://localhost/?foo=bar&baz=blah&meh=\xcf"
def test_get_current_url_invalid_utf8():
env = create_environ()
# set the query string *after* wsgi dance, so \xcf is invalid
env["QUERY_STRING"] = "foo=bar&baz=blah&meh=\xcf"
rv = wsgi.get_current_url(env)
# it remains percent-encoded
assert rv == "http://localhost/?foo=bar&baz=blah&meh=%CF"
def test_range_wrapper():
response = Response(b"Hello World")
range_wrapper = _RangeWrapper(response.response, 6, 4)
assert next(range_wrapper) == b"Worl"
response = Response(b"Hello World")
range_wrapper = _RangeWrapper(response.response, 1, 0)
with pytest.raises(StopIteration):
next(range_wrapper)
response = Response(b"Hello World")
range_wrapper = _RangeWrapper(response.response, 6, 100)
assert next(range_wrapper) == b"World"
response = Response(x for x in (b"He", b"ll", b"o ", b"Wo", b"rl", b"d"))
range_wrapper = _RangeWrapper(response.response, 6, 4)
assert not range_wrapper.seekable
assert next(range_wrapper) == b"Wo"
assert next(range_wrapper) == b"rl"
response = Response(x for x in (b"He", b"ll", b"o W", b"o", b"rld"))
range_wrapper = _RangeWrapper(response.response, 6, 4)
assert next(range_wrapper) == b"W"
assert next(range_wrapper) == b"o"
assert next(range_wrapper) == b"rl"
with pytest.raises(StopIteration):
next(range_wrapper)
response = Response(x for x in (b"Hello", b" World"))
range_wrapper = _RangeWrapper(response.response, 1, 1)
assert next(range_wrapper) == b"e"
with pytest.raises(StopIteration):
next(range_wrapper)
resources = os.path.join(os.path.dirname(__file__), "res")
env = create_environ()
with open(os.path.join(resources, "test.txt"), "rb") as f:
response = Response(wrap_file(env, f))
range_wrapper = _RangeWrapper(response.response, 1, 2)
assert range_wrapper.seekable
assert next(range_wrapper) == b"OU"
with pytest.raises(StopIteration):
next(range_wrapper)
with open(os.path.join(resources, "test.txt"), "rb") as f:
response = Response(wrap_file(env, f))
range_wrapper = _RangeWrapper(response.response, 2)
assert next(range_wrapper) == b"UND\n"
with pytest.raises(StopIteration):
next(range_wrapper)
def test_closing_iterator():
class Namespace:
got_close = False
got_additional = False
class Response:
def __init__(self, environ, start_response):
self.start = start_response
# Return a generator instead of making the object its own
# iterator. This ensures that ClosingIterator calls close on
# the iterable (the object), not the iterator.
def __iter__(self):
self.start("200 OK", [("Content-Type", "text/plain")])
yield "some content"
def close(self):
Namespace.got_close = True
def additional():
Namespace.got_additional = True
def app(environ, start_response):
return ClosingIterator(Response(environ, start_response), additional)
app_iter, status, headers = run_wsgi_app(app, create_environ(), buffered=True)
assert "".join(app_iter) == "some content"
assert Namespace.got_close
assert Namespace.got_additional
|
