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
|
from __future__ import annotations
import asyncio
from unittest.mock import AsyncMock
from unittest.mock import Mock
import pytest
from hypercorn.typing import ASGIReceiveEvent
from hypercorn.typing import ASGISendEvent
from hypercorn.typing import HTTPScope
from hypercorn.typing import WebsocketScope
from werkzeug.datastructures import Headers
from quart import Quart
from quart.asgi import _convert_version
from quart.asgi import _handle_exception
from quart.asgi import ASGIHTTPConnection
from quart.asgi import ASGIWebsocketConnection
from quart.utils import encode_headers
@pytest.mark.parametrize(
"headers, expected", [([(b"host", b"quart")], "quart"), ([], "")]
)
async def test_http_1_0_host_header(headers: list, expected: str) -> None:
app = Quart(__name__)
scope: HTTPScope = {
"type": "http",
"asgi": {},
"http_version": "1.0",
"method": "GET",
"scheme": "https",
"path": "/",
"raw_path": b"/",
"query_string": b"",
"root_path": "",
"headers": headers,
"client": ("127.0.0.1", 80),
"server": None,
"extensions": {},
"state": {}, # type: ignore[typeddict-item]
}
connection = ASGIHTTPConnection(app, scope)
request = connection._create_request_from_scope(lambda: None) # type: ignore
assert request.headers["host"] == expected
async def test_http_completion() -> None:
# Ensure that the connecion callable returns on completion
app = Quart(__name__)
scope: HTTPScope = {
"type": "http",
"asgi": {},
"http_version": "1.1",
"method": "GET",
"scheme": "https",
"path": "/",
"raw_path": b"/",
"query_string": b"",
"root_path": "",
"headers": [(b"host", b"quart")],
"client": ("127.0.0.1", 80),
"server": None,
"extensions": {},
"state": {}, # type: ignore[typeddict-item]
}
connection = ASGIHTTPConnection(app, scope)
queue: asyncio.Queue = asyncio.Queue()
queue.put_nowait({"type": "http.request", "body": b"", "more_body": False})
async def receive() -> ASGIReceiveEvent:
# This will block after returning the first and only entry
return await queue.get()
async def send(message: ASGISendEvent) -> None:
pass
# This test fails if a timeout error is raised here
await asyncio.wait_for(connection(receive, send), timeout=1)
@pytest.mark.parametrize(
"request_message",
[
{"type": "http.request", "body": b"", "more_body": False},
{"type": "http.request", "more_body": False},
],
)
async def test_http_request_without_body(request_message: dict) -> None:
app = Quart(__name__)
scope: HTTPScope = {
"type": "http",
"asgi": {},
"http_version": "1.0",
"method": "GET",
"scheme": "https",
"path": "/",
"raw_path": b"/",
"query_string": b"",
"root_path": "",
"headers": [(b"host", b"quart")],
"client": ("127.0.0.1", 80),
"server": None,
"extensions": {},
"state": {}, # type: ignore[typeddict-item]
}
connection = ASGIHTTPConnection(app, scope)
request = connection._create_request_from_scope(lambda: None) # type: ignore
queue: asyncio.Queue = asyncio.Queue()
queue.put_nowait(request_message)
async def receive() -> ASGIReceiveEvent:
# This will block after returning the first and only entry
return await queue.get()
# This test fails with a timeout error if the request body is not received
# within 1 second
receiver_task = asyncio.ensure_future(connection.handle_messages(request, receive))
body = await asyncio.wait_for(request.body, timeout=1)
receiver_task.cancel()
assert body == b""
async def test_websocket_completion() -> None:
# Ensure that the connecion callable returns on completion
app = Quart(__name__)
scope: WebsocketScope = {
"type": "websocket",
"asgi": {},
"http_version": "1.1",
"scheme": "wss",
"path": "/",
"raw_path": b"/",
"query_string": b"",
"root_path": "",
"headers": [(b"host", b"quart")],
"client": ("127.0.0.1", 80),
"server": None,
"subprotocols": [],
"extensions": {"websocket.http.response": {}},
"state": {}, # type: ignore[typeddict-item]
}
connection = ASGIWebsocketConnection(app, scope)
queue: asyncio.Queue = asyncio.Queue()
queue.put_nowait({"type": "websocket.connect"})
async def receive() -> ASGIReceiveEvent:
# This will block after returning the first and only entry
return await queue.get()
async def send(message: ASGISendEvent) -> None:
pass
# This test fails if a timeout error is raised here
await asyncio.wait_for(connection(receive, send), timeout=1)
def test_http_path_from_absolute_target() -> None:
app = Quart(__name__)
scope: HTTPScope = {
"type": "http",
"asgi": {},
"http_version": "1.1",
"method": "GET",
"scheme": "https",
"path": "http://quart/path",
"raw_path": b"/",
"query_string": b"",
"root_path": "",
"headers": [(b"host", b"quart")],
"client": ("127.0.0.1", 80),
"server": None,
"extensions": {},
"state": {}, # type: ignore[typeddict-item]
}
connection = ASGIHTTPConnection(app, scope)
request = connection._create_request_from_scope(lambda: None) # type: ignore
assert request.path == "/path"
@pytest.mark.parametrize(
"path, expected",
[("/app", "/ "), ("/", "/ "), ("/app/", "/"), ("/app/2", "/2")],
)
def test_http_path_with_root_path(path: str, expected: str) -> None:
app = Quart(__name__)
scope: HTTPScope = {
"type": "http",
"asgi": {},
"http_version": "1.1",
"method": "GET",
"scheme": "https",
"path": path,
"raw_path": b"/",
"query_string": b"",
"root_path": "/app",
"headers": [(b"host", b"quart")],
"client": ("127.0.0.1", 80),
"server": None,
"extensions": {},
"state": {}, # type: ignore[typeddict-item]
}
connection = ASGIHTTPConnection(app, scope)
request = connection._create_request_from_scope(lambda: None) # type: ignore
assert request.path == expected
def test_websocket_path_from_absolute_target() -> None:
app = Quart(__name__)
scope: WebsocketScope = {
"type": "websocket",
"asgi": {},
"http_version": "1.1",
"scheme": "wss",
"path": "ws://quart/path",
"raw_path": b"/",
"query_string": b"",
"root_path": "",
"headers": [(b"host", b"quart")],
"client": ("127.0.0.1", 80),
"server": None,
"subprotocols": [],
"extensions": {"websocket.http.response": {}},
"state": {}, # type: ignore[typeddict-item]
}
connection = ASGIWebsocketConnection(app, scope)
websocket = connection._create_websocket_from_scope(lambda: None) # type: ignore
assert websocket.path == "/path"
@pytest.mark.parametrize(
"path, expected",
[("/app", "/ "), ("/", "/ "), ("/app/", "/"), ("/app/2", "/2")],
)
def test_websocket_path_with_root_path(path: str, expected: str) -> None:
app = Quart(__name__)
scope: WebsocketScope = {
"type": "websocket",
"asgi": {},
"http_version": "1.1",
"scheme": "wss",
"path": path,
"raw_path": b"/",
"query_string": b"",
"root_path": "/app",
"headers": [(b"host", b"quart")],
"client": ("127.0.0.1", 80),
"server": None,
"subprotocols": [],
"extensions": {"websocket.http.response": {}},
"state": {}, # type: ignore[typeddict-item]
}
connection = ASGIWebsocketConnection(app, scope)
websocket = connection._create_websocket_from_scope(lambda: None) # type: ignore
assert websocket.path == expected
@pytest.mark.parametrize(
"scope, headers, subprotocol, has_headers",
[
({}, Headers(), None, False),
({}, Headers(), "abc", False),
({"asgi": {"spec_version": "2.1"}}, Headers({"a": "b"}), None, True),
({"asgi": {"spec_version": "2.1.1"}}, Headers({"a": "b"}), None, True),
],
)
async def test_websocket_accept_connection(
scope: dict, headers: Headers, subprotocol: str | None, has_headers: bool
) -> None:
connection = ASGIWebsocketConnection(Quart(__name__), scope) # type: ignore
mock_send = AsyncMock()
await connection.accept_connection(mock_send, headers, subprotocol)
if has_headers:
mock_send.assert_called_with(
{
"subprotocol": subprotocol,
"type": "websocket.accept",
"headers": encode_headers(headers),
}
)
else:
mock_send.assert_called_with(
{"headers": [], "subprotocol": subprotocol, "type": "websocket.accept"}
)
async def test_websocket_accept_connection_warns(
websocket_scope: WebsocketScope,
) -> None:
connection = ASGIWebsocketConnection(Quart(__name__), websocket_scope)
async def mock_send(message: ASGISendEvent) -> None:
pass
with pytest.warns(UserWarning):
await connection.accept_connection(mock_send, Headers({"a": "b"}), None)
def test__convert_version() -> None:
assert _convert_version("2.1") == [2, 1]
def test_http_asgi_scope_from_request() -> None:
app = Quart(__name__)
scope = {
"headers": [(b"host", b"quart")],
"http_version": "1.0",
"method": "GET",
"scheme": "https",
"path": "/",
"query_string": b"",
"test_result": "PASSED",
}
connection = ASGIHTTPConnection(app, scope) # type: ignore
request = connection._create_request_from_scope(lambda: None) # type: ignore
assert request.scope["test_result"] == "PASSED" # type: ignore
@pytest.mark.parametrize(
"propagate_exceptions, testing, raises",
[
(True, False, False),
(True, True, True),
(False, True, True),
(False, False, True),
],
)
async def test__handle_exception(
propagate_exceptions: bool, testing: bool, raises: bool
) -> None:
app = Mock()
app.config = {}
app.config["PROPAGATE_EXCEPTIONS"] = propagate_exceptions
app.testing = testing
if raises:
with pytest.raises(ValueError):
await _handle_exception(app, ValueError())
else:
await _handle_exception(app, ValueError())
|