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
|
from pathlib import Path
from typing import Any, Optional
import pytest
from litestar import Litestar, Request, Response, Router
from litestar.connection import ASGIConnection
from litestar.datastructures import CacheControlHeader
from litestar.exceptions import ValidationException
from litestar.handlers import BaseRouteHandler
from litestar.static_files import create_static_files_router
from litestar.status_codes import HTTP_200_OK
from litestar.testing.helpers import create_test_client
def test_route_reverse() -> None:
app = Litestar(
route_handlers=[create_static_files_router(path="/static", directories=["something"], name="static")]
)
assert app.route_reverse("static", file_path="foo.py") == "/static/foo.py"
def test_pass_options() -> None:
def guard(connection: ASGIConnection, handler: BaseRouteHandler) -> None:
pass
def handle(request: Request, exception: Any) -> Response:
return Response(b"")
async def after_request(response: Response) -> Response:
return Response(b"")
async def after_response(request: Request) -> None:
pass
async def before_request(request: Request) -> Any:
pass
exception_handlers = {ValidationException: handle}
opts = {"foo": "bar"}
cache_control = CacheControlHeader()
security = [{"foo": ["bar"]}]
tags = ["static", "random"]
router = create_static_files_router(
path="/",
directories=["something"],
guards=[guard],
exception_handlers=exception_handlers, # type: ignore[arg-type]
opt=opts,
after_request=after_request,
after_response=after_response,
before_request=before_request,
cache_control=cache_control,
include_in_schema=False,
security=security,
tags=tags,
)
assert router.guards == [guard]
assert router.exception_handlers == exception_handlers
assert router.opt == opts
assert router.after_request is after_request
assert router.after_response is after_response
assert router.before_request is before_request
assert router.cache_control is cache_control
assert router.include_in_schema is False
assert router.security == security
assert router.tags == tags
def test_custom_router_class() -> None:
class MyRouter(Router):
pass
router = create_static_files_router("/", directories=["some"], router_class=MyRouter)
assert isinstance(router, MyRouter)
@pytest.mark.parametrize("cache_control", (None, CacheControlHeader(max_age=3600)))
def test_cache_control(tmp_path: Path, cache_control: Optional[CacheControlHeader]) -> None:
static_dir = tmp_path / "foo"
static_dir.mkdir()
static_dir.joinpath("test.txt").write_text("hello")
router = create_static_files_router("/static", [static_dir], name="static", cache_control=cache_control)
with create_test_client([router]) as client:
response = client.get("static/test.txt")
assert response.status_code == HTTP_200_OK
if cache_control is not None:
assert response.headers["cache-control"] == cache_control.to_header()
else:
assert "cache-control" not in response.headers
|
