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
|
from typing import Any, Dict, Generator, List, Optional
import pytest
from typing_extensions import Annotated
from litestar import Controller, Litestar, MediaType, get, post
from litestar.di import Provide
from litestar.exceptions import ImproperlyConfiguredException
from litestar.params import Body, Dependency, Parameter
from litestar.status_codes import HTTP_200_OK, HTTP_201_CREATED, HTTP_400_BAD_REQUEST, HTTP_500_INTERNAL_SERVER_ERROR
from litestar.testing import TestClient, create_test_client
def test_parsing_of_parameter_as_annotated() -> None:
@get(path="/")
def handler(param: Annotated[str, Parameter(min_length=1)]) -> str:
return param
with create_test_client(handler) as client:
response = client.get("/")
assert response.status_code == HTTP_400_BAD_REQUEST
response = client.get("/?param=a")
assert response.status_code == HTTP_200_OK
def test_parsing_of_parameter_as_default() -> None:
@get(path="/")
def handler(param: str = Parameter(min_length=1)) -> str:
return param
with create_test_client(handler) as client:
response = client.get("/?param=")
assert response.status_code == HTTP_400_BAD_REQUEST
response = client.get("/?param=a")
assert response.status_code == HTTP_200_OK
def test_parsing_of_body_as_annotated() -> None:
@post(path="/")
def handler(data: Annotated[List[str], Body(min_items=1)]) -> List[str]:
return data
with create_test_client(handler) as client:
response = client.post("/", json=[])
assert response.status_code == HTTP_400_BAD_REQUEST
response = client.post("/", json=["a"])
assert response.status_code == HTTP_201_CREATED
def test_parsing_of_body_as_default() -> None:
@post(path="/")
def handler(data: List[str] = Body(min_items=1)) -> List[str]:
return data
with create_test_client(handler) as client:
response = client.post("/", json=[])
assert response.status_code == HTTP_400_BAD_REQUEST
response = client.post("/", json=["a"])
assert response.status_code == HTTP_201_CREATED
def test_parsing_of_dependency_as_annotated() -> None:
@get(path="/", dependencies={"dep": Provide(lambda: None, sync_to_thread=False)})
def handler(dep: Annotated[int, Dependency(skip_validation=True)]) -> int:
return dep
with create_test_client(handler) as client:
response = client.get("/")
assert response.text == "null"
def test_parsing_of_dependency_as_default() -> None:
@get(path="/", dependencies={"dep": Provide(lambda: None, sync_to_thread=False)})
def handler(dep: int = Dependency(skip_validation=True)) -> int:
return dep
with create_test_client(handler) as client:
response = client.get("/")
assert response.text == "null"
@pytest.mark.parametrize(
"dependency, expected",
[
(Dependency(), None),
(Dependency(default=None), None),
(Dependency(default=13), 13),
],
)
def test_dependency_defaults(dependency: Any, expected: Optional[int]) -> None:
@get("/")
def handler(value: Optional[int] = dependency) -> Dict[str, Optional[int]]:
return {"value": value}
with create_test_client(route_handlers=[handler]) as client:
resp = client.get("/")
assert resp.json() == {"value": expected}
def test_dependency_non_optional_with_default() -> None:
@get("/")
def handler(value: int = Dependency(default=13)) -> Dict[str, int]:
return {"value": value}
with create_test_client(route_handlers=[handler]) as client:
resp = client.get("/")
assert resp.json() == {"value": 13}
def test_dependency_no_default() -> None:
@get(dependencies={"value": Provide(lambda: 13, sync_to_thread=False)})
def test(value: int = Dependency()) -> Dict[str, int]:
return {"value": value}
with create_test_client(route_handlers=[test]) as client:
resp = client.get("/")
assert resp.json() == {"value": 13}
def test_dependency_not_provided_and_no_default() -> None:
@get()
def test(value: int = Dependency()) -> Dict[str, int]:
return {"value": value}
with pytest.raises(ImproperlyConfiguredException):
Litestar(route_handlers=[test])
def test_dependency_provided_on_controller() -> None:
"""Ensures that we don't only consider the handler's dependencies when checking that an explicit non-optional
dependency has been provided.
"""
class C(Controller):
path = ""
dependencies = {"value": Provide(lambda: 13, sync_to_thread=False)}
@get()
def test(self, value: int = Dependency()) -> Dict[str, int]:
return {"value": value}
with create_test_client(route_handlers=[C]) as client:
resp = client.get("/")
assert resp.json() == {"value": 13}
def test_dependency_skip_validation() -> None:
@get("/validated")
def validated(value: int = Dependency()) -> Dict[str, int]:
return {"value": value}
@get("/skipped")
def skipped(value: int = Dependency(skip_validation=True)) -> Dict[str, int]:
return {"value": value}
with create_test_client(
route_handlers=[validated, skipped], dependencies={"value": Provide(lambda: "str", sync_to_thread=False)}
) as client:
validated_resp = client.get("/validated")
assert validated_resp.status_code == HTTP_500_INTERNAL_SERVER_ERROR
skipped_resp = client.get("/skipped")
assert skipped_resp.status_code == HTTP_200_OK
assert skipped_resp.json() == {"value": "str"}
def test_dependency_skip_validation_with_default() -> None:
@get("/skipped")
def skipped(value: int = Dependency(default=1, skip_validation=True)) -> Dict[str, int]:
return {"value": value}
with create_test_client(route_handlers=[skipped]) as client:
skipped_resp = client.get("/skipped")
assert skipped_resp.status_code == HTTP_200_OK
assert skipped_resp.json() == {"value": 1}
def test_dependency_nested_sequence() -> None:
class Obj:
def __init__(self, seq: List[str]) -> None:
self.seq = seq
async def provides_obj(seq: List[str]) -> Obj:
return Obj(seq)
@get("/obj")
def get_obj(obj: Obj) -> List[str]:
return obj.seq
@get("/seq")
def get_seq(seq: List[str]) -> List[str]:
return seq
with create_test_client(
route_handlers=[get_obj, get_seq],
dependencies={"obj": Provide(provides_obj)},
) as client:
seq = ["a", "b", "c"]
resp = client.get("/seq", params={"seq": seq})
assert resp.json() == ["a", "b", "c"]
resp = client.get("/obj", params={"seq": seq})
assert resp.json() == ["a", "b", "c"]
def test_regex_validation() -> None:
# https://github.com/litestar-org/litestar/issues/1860
@get(path="/val_regex", media_type=MediaType.TEXT)
async def regex_val(text: Annotated[str, Parameter(title="a or b", pattern="[a|b]")]) -> str:
return f"str: {text}"
with create_test_client(route_handlers=[regex_val]) as client:
for letter in ("a", "b"):
response = client.get(f"/val_regex?text={letter}")
assert response.status_code == HTTP_200_OK
assert response.text == f"str: {letter}"
response = client.get("/val_regex?text=c")
assert response.status_code == HTTP_400_BAD_REQUEST
@pytest.fixture(name="optional_no_default_client")
def optional_no_default_client_fixture() -> Generator[TestClient, None, None]:
@get("/optional-no-default")
def handle_optional(key: Optional[str]) -> Dict[str, Optional[str]]:
return {"key": key}
@get("/optional-annotated-no-default")
def handle_optional_annotated(param: Annotated[Optional[str], Parameter(query="key")]) -> Dict[str, Optional[str]]:
return {"key": param}
with create_test_client(route_handlers=[handle_optional, handle_optional_annotated], openapi_config=None) as client:
yield client
def test_optional_query_parameter_consistency_no_default_queried_without_param(
optional_no_default_client: TestClient,
) -> None:
assert optional_no_default_client.get("/optional-no-default", params={}).json() == {"key": None}
assert optional_no_default_client.get("/optional-annotated-no-default", params={}).json() == {"key": None}
def test_optional_query_parameter_consistency_no_default_queried_with_expected_param(
optional_no_default_client: TestClient,
) -> None:
assert optional_no_default_client.get("/optional-no-default", params={"key": "a"}).json() == {"key": "a"}
assert optional_no_default_client.get("/optional-annotated-no-default", params={"key": "a"}).json() == {"key": "a"}
def test_optional_query_parameter_consistency_no_default_queried_with_other_param(
optional_no_default_client: TestClient,
) -> None:
assert optional_no_default_client.get("/optional-no-default", params={"param": "a"}).json() == {"key": None}
assert optional_no_default_client.get("/optional-annotated-no-default", params={"param": "a"}).json() == {
"key": None
}
@pytest.fixture(name="optional_default_client")
def optional_default_client_fixture() -> Generator[TestClient, None, None]:
@get("/optional-default")
def handle_default(key: Optional[str] = None) -> Dict[str, Optional[str]]:
return {"key": key}
@get("/optional-annotated-default")
def handle_default_annotated(
param: Annotated[Optional[str], Parameter(query="key")] = None,
) -> Dict[str, Optional[str]]:
return {"key": param}
with create_test_client(route_handlers=[handle_default, handle_default_annotated], openapi_config=None) as client:
yield client
def test_optional_query_parameter_consistency_with_default_queried_without_param(
optional_default_client: TestClient,
) -> None:
assert optional_default_client.get("/optional-default", params={}).json() == {"key": None}
assert optional_default_client.get("/optional-annotated-default", params={}).json() == {"key": None}
def test_optional_query_parameter_consistency_with_default_queried_with_expected_param(
optional_default_client: TestClient,
) -> None:
assert optional_default_client.get("/optional-default", params={"key": "a"}).json() == {"key": "a"}
assert optional_default_client.get("/optional-annotated-default", params={"key": "a"}).json() == {"key": "a"}
def test_optional_query_parameter_consistency_with_default_queried_with_other_param(
optional_default_client: TestClient,
) -> None:
assert optional_default_client.get("/optional-default", params={"param": "a"}).json() == {"key": None}
assert optional_default_client.get("/optional-annotated-default", params={"abc": "xyz"}).json() == {"key": None}
assert optional_default_client.get("/optional-annotated-default", params={"param": "a"}).json() == {"key": None}
def test_not_included_in_schema_param_as_annotated() -> None:
@get(path="/")
def handler(param: Annotated[str, Parameter(include_in_schema=True)]) -> str:
return param
with create_test_client(handler) as client:
response = client.get("/")
assert response.status_code == HTTP_400_BAD_REQUEST
response = client.get("/?param=a")
assert response.status_code == HTTP_200_OK
assert response.text == "a"
def test_not_included_in_schema_param_as_default() -> None:
@get(path="/")
def handler(param: str = Parameter(include_in_schema=True)) -> str:
return param
with create_test_client(handler) as client:
response = client.get("/")
assert response.status_code == HTTP_400_BAD_REQUEST
response = client.get("/?param=a")
assert response.status_code == HTTP_200_OK
assert response.text == "a"
def test_not_included_in_schema_param_with_default_value() -> None:
@get(path="/")
def handler(param: str = Parameter(default="b", include_in_schema=True)) -> str:
return param
with create_test_client(handler) as client:
response = client.get("/")
assert response.status_code == HTTP_200_OK
assert response.text == "b"
|
