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 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
|
# ruff: noqa: UP006
from __future__ import annotations
import inspect
import logging
from collections.abc import AsyncGenerator
from contextlib import asynccontextmanager
from dataclasses import fields
from typing import TYPE_CHECKING, Any, Callable, List, Tuple
from unittest.mock import MagicMock, Mock, PropertyMock
import pytest
from click import Group
from pytest import MonkeyPatch
from litestar import Litestar, MediaType, Request, Response, get
from litestar._asgi.asgi_router import ASGIRouter
from litestar.config.app import AppConfig, ExperimentalFeatures
from litestar.config.response_cache import ResponseCacheConfig
from litestar.contrib.sqlalchemy.plugins import SQLAlchemySerializationPlugin
from litestar.datastructures import MutableScopeHeaders, State
from litestar.events.emitter import SimpleEventEmitter
from litestar.exceptions import (
ImproperlyConfiguredException,
InternalServerException,
LitestarWarning,
NotFoundException,
)
from litestar.logging.config import LoggingConfig
from litestar.plugins import CLIPluginProtocol
from litestar.router import Router
from litestar.status_codes import HTTP_200_OK, HTTP_400_BAD_REQUEST, HTTP_500_INTERNAL_SERVER_ERROR
from litestar.testing import TestClient, create_test_client
if TYPE_CHECKING:
from typing import Dict
from litestar.types import Message, Scope
@pytest.fixture()
def app_config_object() -> AppConfig:
return AppConfig(
after_exception=[],
after_request=None,
after_response=None,
allowed_hosts=[],
before_request=None,
before_send=[],
response_cache_config=ResponseCacheConfig(),
cache_control=None,
compression_config=None,
cors_config=None,
csrf_config=None,
debug=False,
dependencies={},
etag=None,
event_emitter_backend=SimpleEventEmitter,
exception_handlers={},
guards=[],
listeners=[],
logging_config=None,
middleware=[],
multipart_form_part_limit=1000,
on_shutdown=[],
on_startup=[],
openapi_config=None,
opt={},
parameters={},
plugins=[],
request_class=None,
response_class=None,
response_cookies=[],
response_headers=[],
route_handlers=[],
security=[],
static_files_config=[],
tags=[],
template_config=None,
websocket_class=None,
)
def test_access_openapi_schema_raises_if_not_configured() -> None:
"""Test that accessing the openapi schema raises if not configured."""
app = Litestar(openapi_config=None)
with pytest.raises(ImproperlyConfiguredException):
app.openapi_schema
def test_set_debug_updates_logging_level() -> None:
app = Litestar()
assert app.logger is not None
assert app.logger.level == logging.INFO # type: ignore[attr-defined]
app.debug = True
assert app.logger.level == logging.DEBUG # type: ignore[attr-defined]
app.debug = False
assert app.logger.level == logging.INFO # type: ignore[attr-defined]
@pytest.mark.parametrize("env_name,app_attr", [("LITESTAR_DEBUG", "debug"), ("LITESTAR_PDB", "pdb_on_exception")])
@pytest.mark.parametrize(
"env_value,app_value,expected_value",
[
(None, None, False),
(None, False, False),
(None, True, True),
("0", None, False),
("0", False, False),
("0", True, True),
("1", None, True),
("1", False, False),
("1", True, True),
],
)
@pytest.mark.filterwarnings("ignore::litestar.utils.warnings.LitestarWarning:")
def test_set_env_flags(
monkeypatch: MonkeyPatch,
env_value: str | None,
app_value: bool | None,
expected_value: bool,
env_name: str,
app_attr: str,
) -> None:
if env_value is not None:
monkeypatch.setenv(env_name, env_value)
else:
monkeypatch.delenv(env_name, raising=False)
app = Litestar(**{app_attr: app_value}) # type: ignore[arg-type]
assert getattr(app, app_attr) is expected_value
def test_warn_pdb_on_exception() -> None:
with pytest.warns(LitestarWarning, match="Debugger"):
Litestar(pdb_on_exception=True)
def test_app_params_defined_on_app_config_object() -> None:
"""Ensures that all parameters to the `Litestar` constructor are present on the `AppConfig` object."""
litestar_signature = inspect.signature(Litestar)
app_config_fields = {f.name for f in fields(AppConfig)}
for name in litestar_signature.parameters:
if name in {"on_app_init", "initial_state", "_preferred_validation_backend"}:
continue
assert name in app_config_fields
# ensure there are not fields defined on AppConfig that aren't in the Litestar signature
assert not (app_config_fields - set(litestar_signature.parameters.keys()))
def test_app_config_object_used(app_config_object: AppConfig, monkeypatch: pytest.MonkeyPatch) -> None:
"""Ensure that the properties on the `AppConfig` object are accessed within the `Litestar` constructor.
In the test we replace every field on the `AppConfig` type with a property mock so that we can check that it has at
least been accessed. It doesn't actually check that we do the right thing with it, but is a guard against the case
of adding a parameter to the `Litestar` signature and to the `AppConfig` object, and using the value from the
parameter downstream from construction of the `AppConfig` object.
"""
# replace each field on the `AppConfig` object with a `PropertyMock`, this allows us to assert that the properties
# have been accessed during app instantiation.
property_mocks: List[Tuple[str, Mock]] = []
for field in fields(AppConfig):
property_mock = PropertyMock()
property_mocks.append((field.name, property_mock))
monkeypatch.setattr(type(app_config_object), field.name, property_mock, raising=False)
# Things that we don't actually need to call for this test
monkeypatch.setattr(Litestar, "register", MagicMock())
monkeypatch.setattr(Litestar, "_create_asgi_handler", MagicMock())
monkeypatch.setattr(Router, "__init__", MagicMock())
monkeypatch.setattr(ASGIRouter, "__init__", MagicMock(return_value=None))
# instantiates the app with an `on_app_config` that returns our patched `AppConfig` object.
Litestar(on_app_init=[MagicMock(return_value=app_config_object)])
# this ensures that each of the properties of the `AppConfig` object have been accessed within `Litestar.__init__()`
for name, mock in property_mocks:
assert mock.called, f"expected {name} to be called"
def test_app_debug_create_logger() -> None:
app = Litestar([], debug=True)
assert app.logging_config
assert app.logging_config.loggers["litestar"]["level"] == "DEBUG" # type: ignore[attr-defined]
def test_app_debug_explicitly_disable_logging() -> None:
app = Litestar([], logging_config=None)
assert not app.logging_config
def test_app_debug_update_logging_config() -> None:
logging_config = LoggingConfig()
app = Litestar([], logging_config=logging_config, debug=True)
assert app.logging_config is logging_config
assert app.logging_config.loggers["litestar"]["level"] == "DEBUG" # type: ignore[attr-defined]
def test_set_state() -> None:
def modify_state_in_hook(app_config: AppConfig) -> AppConfig:
assert isinstance(app_config.state, State)
app_config.state["c"] = "D"
app_config.state["e"] = "f"
return app_config
app = Litestar(state=State({"a": "b", "c": "d"}), on_app_init=[modify_state_in_hook])
assert app.state._state == {"a": "b", "c": "D", "e": "f"}
async def test_dont_override_initial_state(create_scope: Callable[..., Scope]) -> None:
app = Litestar()
scope = create_scope(headers=[], state={"foo": "bar"})
async def send(message: Message) -> None:
pass
async def receive() -> None:
pass
await app(scope, receive, send) # type: ignore[arg-type]
assert scope["state"].get("foo") == "bar"
def test_app_from_config(app_config_object: AppConfig) -> None:
Litestar.from_config(app_config_object)
def test_before_send() -> None:
@get("/test")
def handler() -> Dict[str, str]:
return {"key": "value"}
async def before_send_hook_handler(message: Message, scope: Scope) -> None:
if message["type"] == "http.response.start":
headers = MutableScopeHeaders(message)
headers.add("My-Header", Litestar.from_scope(scope).state.message)
def on_startup(app: Litestar) -> None:
app.state.message = "value injected during send"
with create_test_client(handler, on_startup=[on_startup], before_send=[before_send_hook_handler]) as client:
response = client.get("/test")
assert response.status_code == HTTP_200_OK
assert response.headers.get("My-Header") == "value injected during send"
def test_using_custom_http_exception_handler() -> None:
@get("/{param:int}")
def my_route_handler(param: int) -> None: ...
def my_custom_handler(_: Request[Any, Any, State], __: Exception) -> Response[str]:
return Response(content="custom message", media_type=MediaType.TEXT, status_code=HTTP_400_BAD_REQUEST)
with create_test_client(my_route_handler, exception_handlers={NotFoundException: my_custom_handler}) as client:
response = client.get("/abc")
assert response.text == "custom message"
assert response.status_code == HTTP_400_BAD_REQUEST
def test_debug_response_created() -> None:
# this will test exception causes are recorded in output
# since frames include code in context we should not raise
# exception directly
def exception_thrower() -> float:
return 1 / 0
@get("/")
def my_route_handler() -> None:
try:
exception_thrower()
except Exception as e:
raise InternalServerException() from e
app = Litestar(route_handlers=[my_route_handler], debug=True)
client = TestClient(app=app)
response = client.get("/")
assert response.status_code == HTTP_500_INTERNAL_SERVER_ERROR
assert "text/plain" in response.headers["content-type"]
response = client.get("/", headers={"accept": "text/html"})
assert response.status_code == HTTP_500_INTERNAL_SERVER_ERROR
assert "text/html" in response.headers["content-type"]
assert "ZeroDivisionError" in response.text
def test_handler_error_return_status_500() -> None:
@get("/")
def my_route_handler() -> None:
raise KeyError("custom message")
with create_test_client(my_route_handler) as client:
response = client.get("/")
assert response.status_code == HTTP_500_INTERNAL_SERVER_ERROR
def test_lifespan() -> None:
events: list[str] = []
counter = {"value": 0}
def sync_function_without_app() -> None:
events.append("sync_function_without_app")
counter["value"] += 1
async def async_function_without_app() -> None:
events.append("async_function_without_app")
counter["value"] += 1
def sync_function_with_app(app: Litestar) -> None:
events.append("sync_function_with_app")
assert app is not None
assert isinstance(app.state, State)
counter["value"] += 1
app.state.x = True
async def async_function_with_app(app: Litestar) -> None:
events.append("async_function_with_app")
assert app is not None
assert isinstance(app.state, State)
counter["value"] += 1
app.state.y = True
with create_test_client(
[],
on_startup=[
sync_function_without_app,
async_function_without_app,
sync_function_with_app,
async_function_with_app,
],
on_shutdown=[
sync_function_without_app,
async_function_without_app,
sync_function_with_app,
async_function_with_app,
],
) as client:
assert counter["value"] == 4
assert client.app.state.x
assert client.app.state.y
counter["value"] = 0
assert counter["value"] == 0
assert counter["value"] == 4
assert events == [
"sync_function_without_app",
"async_function_without_app",
"sync_function_with_app",
"async_function_with_app",
"sync_function_without_app",
"async_function_without_app",
"sync_function_with_app",
"async_function_with_app",
]
def test_registering_route_handler_generates_openapi_docs() -> None:
def fn() -> None:
return
app = Litestar(route_handlers=[])
assert app.openapi_schema
app.register(get("/path1")(fn))
assert app.openapi_schema.paths is not None
assert app.openapi_schema.paths.get("/path1")
app.register(get("/path2")(fn))
assert app.openapi_schema.paths.get("/path1")
assert app.openapi_schema.paths.get("/path2")
def test_plugin_properties() -> None:
class FooPlugin(CLIPluginProtocol):
def on_cli_init(self, cli: Group) -> None:
return
app = Litestar(plugins=[FooPlugin(), SQLAlchemySerializationPlugin()])
assert app.openapi_schema_plugins == list(app.plugins.openapi)
assert app.cli_plugins == list(app.plugins.cli)
assert app.serialization_plugins == list(app.plugins.serialization)
def test_plugin_registry() -> None:
class FooPlugin(CLIPluginProtocol):
def on_cli_init(self, cli: Group) -> None:
return
foo = FooPlugin()
app = Litestar(plugins=[foo])
assert foo in app.plugins.cli
def test_lifespan_context_and_shutdown_hook_execution_order() -> None:
events: list[str] = []
counter = {"value": 0}
@asynccontextmanager
async def lifespan_context_1(app: Litestar) -> AsyncGenerator[None, None]:
try:
yield
finally:
events.append("ctx_1")
counter["value"] += 1
@asynccontextmanager
async def lifespan_context_2(app: Litestar) -> AsyncGenerator[None, None]:
try:
yield
finally:
events.append("ctx_2")
counter["value"] += 1
async def hook_a(app: Litestar) -> None:
events.append("hook_a")
counter["value"] += 1
async def hook_b(app: Litestar) -> None:
events.append("hook_b")
counter["value"] += 1
with create_test_client(
route_handlers=[],
lifespan=[
lifespan_context_1,
lifespan_context_2,
],
on_shutdown=[hook_a, hook_b],
):
assert counter["value"] == 0
assert counter["value"] == 4
assert events[0] == "ctx_2"
assert events[1] == "ctx_1"
assert events[2] == "hook_a"
assert events[3] == "hook_b"
def test_use_dto_codegen_feature_flag_warns() -> None:
with pytest.warns(LitestarWarning, match="Use of redundant experimental feature flag DTO_CODEGEN"):
Litestar(experimental_features=[ExperimentalFeatures.DTO_CODEGEN])
def test_use_future_feature_flag_warns() -> None:
app = Litestar(experimental_features=[ExperimentalFeatures.FUTURE])
assert app.experimental_features == frozenset([ExperimentalFeatures.FUTURE])
def test_using_custom_path_parameter() -> None:
@get()
def my_route_handler() -> None: ...
with create_test_client(my_route_handler, path="/abc") as client:
response = client.get("/abc")
assert response.status_code == HTTP_200_OK
def test_from_scope() -> None:
mock = MagicMock()
@get()
def handler(scope: Scope) -> None:
mock(Litestar.from_scope(scope))
return
app = Litestar(route_handlers=[handler])
with TestClient(app) as client:
client.get("/")
mock.assert_called_once_with(app)
|