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 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
|
import dataclasses
from typing import TYPE_CHECKING, Any, List, Optional, Type, cast
from uuid import UUID
import pytest
from typing_extensions import Annotated, NewType
from litestar import Controller, Litestar, Router, get
from litestar._openapi.datastructures import OpenAPIContext
from litestar._openapi.parameters import ParameterFactory
from litestar._openapi.schema_generation.examples import ExampleFactory
from litestar._openapi.typescript_converter.schema_parsing import is_schema_value
from litestar.di import Provide
from litestar.enums import ParamType
from litestar.exceptions import ImproperlyConfiguredException
from litestar.handlers import HTTPRouteHandler
from litestar.openapi import OpenAPIConfig
from litestar.openapi.spec import Example, OpenAPI, Reference, Schema
from litestar.openapi.spec.enums import OpenAPIType
from litestar.params import Dependency, Parameter
from litestar.routes import BaseRoute
from litestar.testing import create_test_client
from litestar.utils import find_index
from tests.unit.test_openapi.utils import Gender, LuckyNumber
if TYPE_CHECKING:
from litestar.openapi.spec.parameter import Parameter as OpenAPIParameter
def create_factory(route: BaseRoute, handler: HTTPRouteHandler) -> ParameterFactory:
return ParameterFactory(
OpenAPIContext(
openapi_config=OpenAPIConfig(title="Test API", version="1.0.0", create_examples=True), plugins=[]
),
route_handler=handler,
path_parameters=route.path_parameters,
)
def _create_parameters(app: Litestar, path: str) -> List["OpenAPIParameter"]:
index = find_index(app.routes, lambda x: x.path_format == path)
route = app.routes[index]
route_handler = route.route_handler_map["GET"][0] # type: ignore[union-attr]
handler = route_handler.fn
assert callable(handler)
return create_factory(route, route_handler).create_parameters_for_handler()
def test_create_parameters(person_controller: Type[Controller]) -> None:
ExampleFactory.seed_random(10)
parameters = _create_parameters(app=Litestar(route_handlers=[person_controller]), path="/{service_id}/person")
assert len(parameters) == 10
service_id, page, name, page_size, from_date, to_date, gender, lucky_number, secret_header, cookie_value = tuple(
parameters
)
assert service_id.name == "service_id"
assert service_id.param_in == ParamType.PATH
assert is_schema_value(service_id.schema)
assert service_id.schema.type == OpenAPIType.INTEGER
assert service_id.required
assert service_id.schema.examples
assert page.param_in == ParamType.QUERY
assert page.name == "page"
assert is_schema_value(page.schema)
assert page.schema.type == OpenAPIType.INTEGER
assert page.required
assert page.schema.examples
assert page_size.param_in == ParamType.QUERY
assert page_size.name == "pageSize"
assert is_schema_value(page_size.schema)
assert page_size.schema.type == OpenAPIType.INTEGER
assert page_size.required
assert page_size.description == "Page Size Description"
assert page_size.examples
assert page_size.schema.examples == [1]
assert name.param_in == ParamType.QUERY
assert name.name == "name"
assert is_schema_value(name.schema)
assert name.schema.one_of
assert len(name.schema.one_of) == 3
assert not name.required
assert name.schema.examples
assert from_date.param_in == ParamType.QUERY
assert from_date.name == "from_date"
assert is_schema_value(from_date.schema)
assert from_date.schema.one_of
assert len(from_date.schema.one_of) == 4
assert not from_date.required
assert from_date.schema.examples
assert to_date.param_in == ParamType.QUERY
assert to_date.name == "to_date"
assert is_schema_value(to_date.schema)
assert to_date.schema.one_of
assert len(to_date.schema.one_of) == 4
assert not to_date.required
assert to_date.schema.examples
assert gender.param_in == ParamType.QUERY
assert gender.name == "gender"
assert is_schema_value(gender.schema)
assert gender.schema == Schema(
one_of=[
Reference(ref="#/components/schemas/tests_unit_test_openapi_utils_Gender"),
Schema(
type=OpenAPIType.ARRAY,
items=Reference(ref="#/components/schemas/tests_unit_test_openapi_utils_Gender"),
examples=[[Gender.FEMALE]],
),
Schema(type=OpenAPIType.NULL),
],
examples=[Gender.MALE, [Gender.MALE, Gender.OTHER]],
)
assert not gender.required
assert secret_header.param_in == ParamType.HEADER
assert is_schema_value(secret_header.schema)
assert secret_header.schema.type == OpenAPIType.STRING
assert secret_header.required
assert secret_header.schema.examples
assert cookie_value.param_in == ParamType.COOKIE
assert is_schema_value(cookie_value.schema)
assert cookie_value.schema.type == OpenAPIType.INTEGER
assert cookie_value.required
assert cookie_value.schema.examples
assert lucky_number.param_in == ParamType.QUERY
assert lucky_number.name == "lucky_number"
assert is_schema_value(lucky_number.schema)
assert lucky_number.schema == Schema(
one_of=[
Reference(ref="#/components/schemas/tests_unit_test_openapi_utils_LuckyNumber"),
Schema(type=OpenAPIType.NULL),
],
examples=[LuckyNumber.SEVEN],
)
assert not lucky_number.required
def test_deduplication_for_param_where_key_and_type_are_equal() -> None:
class BaseDep:
def __init__(self, query_param: str) -> None: ...
class ADep(BaseDep): ...
class BDep(BaseDep): ...
async def c_dep(other_param: float) -> float:
return other_param
async def d_dep(other_param: float) -> float:
return other_param
@get(
"/test",
dependencies={
"a": Provide(ADep, sync_to_thread=False),
"b": Provide(BDep, sync_to_thread=False),
"c": Provide(c_dep),
"d": Provide(d_dep),
},
)
def handler(a: ADep, b: BDep, c: float, d: float) -> str:
return "OK"
app = Litestar(route_handlers=[handler])
assert isinstance(app.openapi_schema, OpenAPI)
open_api_path_item = app.openapi_schema.paths["/test"] # type: ignore[index]
open_api_parameters = open_api_path_item.get.parameters # type: ignore[union-attr]
assert len(open_api_parameters) == 2 # type: ignore[arg-type]
assert {p.name for p in open_api_parameters} == {"query_param", "other_param"} # type: ignore[union-attr]
def test_raise_for_multiple_parameters_of_same_name_and_differing_types() -> None:
async def a_dep(query_param: int) -> int:
return query_param
async def b_dep(query_param: str) -> int:
return 1
@get("/test", dependencies={"a": Provide(a_dep), "b": Provide(b_dep)})
def handler(a: int, b: int) -> str:
return "OK"
app = Litestar(route_handlers=[handler])
with pytest.raises(ImproperlyConfiguredException):
app.openapi_schema
def test_dependency_params_in_docs_if_dependency_provided() -> None:
async def produce_dep(param: str) -> int:
return 13
@get(dependencies={"dep": Provide(produce_dep)})
def handler(dep: Optional[int] = Dependency()) -> None:
return None
app = Litestar(route_handlers=[handler])
param_name_set = {p.name for p in cast("OpenAPI", app.openapi_schema).paths["/"].get.parameters} # type: ignore[index, redundant-cast, union-attr]
assert "dep" not in param_name_set
assert "param" in param_name_set
def test_dependency_not_in_doc_params_if_not_provided() -> None:
@get()
def handler(dep: Optional[int] = Dependency()) -> None:
return None
app = Litestar(route_handlers=[handler])
assert cast("OpenAPI", app.openapi_schema).paths["/"].get.parameters is None # type: ignore[index, redundant-cast, union-attr]
def test_non_dependency_in_doc_params_if_not_provided() -> None:
@get()
def handler(param: Optional[int]) -> None:
return None
app = Litestar(route_handlers=[handler])
param_name_set = {p.name for p in cast("OpenAPI", app.openapi_schema).paths["/"].get.parameters} # type: ignore[index, redundant-cast, union-attr]
assert "param" in param_name_set
def test_layered_parameters() -> None:
class MyController(Controller):
path = "/controller"
parameters = {
"controller1": Parameter(lt=100),
"controller2": Parameter(str, query="controller3"),
}
@get("/{local:int}")
def my_handler(
self,
local: int,
controller1: int,
router1: str,
router2: float,
app1: str,
app2: List[str],
controller2: float = Parameter(float, ge=5.0),
) -> dict:
return {}
router = Router(
path="/router",
route_handlers=[MyController],
parameters={
"router1": Parameter(str, pattern="^[a-zA-Z]$"),
"router2": Parameter(float, multiple_of=5.0, header="router3"),
},
)
parameters = _create_parameters(
app=Litestar(
route_handlers=[router],
parameters={
"app1": Parameter(str, cookie="app4"),
"app2": Parameter(List[str], min_items=2),
"app3": Parameter(bool, required=False),
},
),
path="/router/controller/{local}",
)
local, app3, controller1, router1, router3, app4, app2, controller3 = tuple(parameters)
assert app4.param_in == ParamType.COOKIE
assert app4.schema.type == OpenAPIType.STRING # type: ignore[union-attr]
assert app4.required
assert app4.schema.examples # type: ignore[union-attr]
assert app2.param_in == ParamType.QUERY
assert app2.schema.type == OpenAPIType.ARRAY # type: ignore[union-attr]
assert app2.required
assert app2.schema.examples # type: ignore[union-attr]
assert app3.param_in == ParamType.QUERY
assert app3.schema.type == OpenAPIType.BOOLEAN # type: ignore[union-attr]
assert not app3.required
assert app3.schema.examples # type: ignore[union-attr]
assert router1.param_in == ParamType.QUERY
assert router1.schema.type == OpenAPIType.STRING # type: ignore[union-attr]
assert router1.required
assert router1.schema.pattern == "^[a-zA-Z]$" # type: ignore[union-attr]
assert router1.schema.examples # type: ignore[union-attr]
assert router3.param_in == ParamType.HEADER
assert router3.schema.type == OpenAPIType.NUMBER # type: ignore[union-attr]
assert router3.required
assert router3.schema.multiple_of == 5.0 # type: ignore[union-attr]
assert router3.schema.examples # type: ignore[union-attr]
assert controller1.param_in == ParamType.QUERY
assert controller1.schema.type == OpenAPIType.INTEGER # type: ignore[union-attr]
assert controller1.required
assert controller1.schema.exclusive_maximum == 100.0 # type: ignore[union-attr]
assert controller1.schema.examples # type: ignore[union-attr]
assert controller3.param_in == ParamType.QUERY
assert controller3.schema.type == OpenAPIType.NUMBER # type: ignore[union-attr]
assert controller3.required
assert controller3.schema.minimum == 5.0 # type: ignore[union-attr]
assert controller3.schema.examples # type: ignore[union-attr]
assert local.param_in == ParamType.PATH
assert local.schema.type == OpenAPIType.INTEGER # type: ignore[union-attr]
assert local.required
assert local.schema.examples # type: ignore[union-attr]
def test_parameter_examples() -> None:
@get(path="/")
async def index(
text: Annotated[str, Parameter(examples=[Example(value="example value", summary="example summary")])],
) -> str:
return text
with create_test_client(
route_handlers=[index], openapi_config=OpenAPIConfig(title="Test API", version="1.0.0")
) as client:
response = client.get("/schema/openapi.json")
assert response.json()["paths"]["/"]["get"]["parameters"][0]["examples"] == {
"text-example-1": {"summary": "example summary", "value": "example value"}
}
def test_parameter_schema_extra() -> None:
@get()
async def handler(
query1: Annotated[
str,
Parameter(
schema_extra={
"schema_not": Schema(
any_of=[
Schema(type=OpenAPIType.STRING, pattern=r"^somePrefix:.*$"),
Schema(type=OpenAPIType.STRING, enum=["denied", "values"]),
]
),
}
),
],
query2: Annotated[
Gender,
Parameter(description="gender description", schema_extra={"format": "foo"}, schema_component_key="q2"),
],
query3: Annotated[Gender, Parameter(schema_extra={"format": "bar"}, schema_component_key="q3")],
) -> Any:
return query1
@get()
async def error_handler(query1: Annotated[str, Parameter(schema_extra={"invalid": "dummy"})]) -> Any:
return query1
# Success
app = Litestar([handler])
schema = app.openapi_schema.to_schema()
assert schema["paths"]["/"]["get"]["parameters"][0]["schema"]["not"] == {
"anyOf": [
{"type": "string", "pattern": r"^somePrefix:.*$"},
{"type": "string", "enum": ["denied", "values"]},
]
}
assert schema["paths"]["/"]["get"]["parameters"][1]["schema"]["$ref"] == "#/components/schemas/q2"
assert schema["paths"]["/"]["get"]["parameters"][1]["description"] == "gender description"
assert schema["components"]["schemas"]["q2"]["format"] == "foo"
assert schema["paths"]["/"]["get"]["parameters"][2]["schema"]["$ref"] == "#/components/schemas/q3"
assert schema["paths"]["/"]["get"]["parameters"][2]["description"] == Gender.__doc__
assert schema["components"]["schemas"]["q3"]["format"] == "bar"
# Attempt to pass invalid key
app = Litestar([error_handler])
with pytest.raises(ValueError) as e:
app.openapi_schema
assert str(e.value).startswith("`schema_extra` declares key")
def test_uuid_path_description_generation() -> None:
# https://github.com/litestar-org/litestar/issues/2967
@get("str/{id:str}")
async def str_path(id: Annotated[str, Parameter(description="String ID")]) -> str:
return id
@get("uuid/{id:uuid}")
async def uuid_path(id: Annotated[UUID, Parameter(description="UUID ID")]) -> UUID:
return id
with create_test_client(
[str_path, uuid_path], openapi_config=OpenAPIConfig(title="Test API", version="1.0.0")
) as client:
response = client.get("/schema/openapi.json")
assert response.json()["paths"]["/str/{id}"]["get"]["parameters"][0]["description"] == "String ID"
assert response.json()["paths"]["/uuid/{id}"]["get"]["parameters"][0]["description"] == "UUID ID"
def test_unwrap_new_type() -> None:
FancyString = NewType("FancyString", str)
@get("/{path_param:str}")
async def handler(
param: FancyString,
optional_param: Optional[FancyString],
path_param: FancyString,
) -> FancyString:
return FancyString("")
app = Litestar([handler])
assert app.openapi_schema.paths["/{path_param}"].get.parameters[0].schema.type == OpenAPIType.STRING # type: ignore[index, union-attr]
assert app.openapi_schema.paths["/{path_param}"].get.parameters[1].schema.one_of == [ # type: ignore[index, union-attr]
Schema(type=OpenAPIType.STRING),
Schema(type=OpenAPIType.NULL),
]
assert app.openapi_schema.paths["/{path_param}"].get.parameters[2].schema.type == OpenAPIType.STRING # type: ignore[index, union-attr]
assert (
app.openapi_schema.paths["/{path_param}"].get.responses["200"].content["application/json"].schema.type # type: ignore[index, union-attr]
== OpenAPIType.STRING
)
def test_unwrap_nested_new_type() -> None:
FancyString = NewType("FancyString", str)
FancierString = NewType("FancierString", FancyString) # pyright: ignore
@get("/")
async def handler(
param: FancierString,
) -> None:
return None
app = Litestar([handler])
assert app.openapi_schema.paths["/"].get.parameters[0].schema.type == OpenAPIType.STRING # type: ignore[index, union-attr]
def test_unwrap_annotated_new_type() -> None:
FancyString = NewType("FancyString", str)
@dataclasses.dataclass
class TestModel:
param: Annotated[FancyString, "foo"]
@get("/")
async def handler(
param: TestModel,
) -> None:
return None
app = Litestar([handler])
testmodel_schema_name = app.openapi_schema.paths["/"].get.parameters[0].schema.value # type: ignore[index, union-attr]
assert app.openapi_schema.components.schemas[testmodel_schema_name].properties["param"].type == OpenAPIType.STRING # type: ignore[index, union-attr]
def test_query_param_only_properties() -> None:
# https://github.com/litestar-org/litestar/issues/3908
@get("/{path_param:str}")
def handler(
path_param: str,
query_param: str,
header_param: Annotated[str, Parameter(header="header_param")],
cookie_param: Annotated[str, Parameter(cookie="cookie_param")],
) -> None:
pass
app = Litestar([handler])
params = {p.name: p for p in app.openapi_schema.paths["/{path_param}"].get.parameters} # type: ignore[union-attr, index]
for key in ["path_param", "header_param", "cookie_param"]:
schema = params[key].to_schema()
assert "allowEmptyValue" not in schema
assert "allowReserved" not in schema
assert params["query_param"].to_schema() == {
"name": "query_param",
"in": "query",
"schema": {"type": "string"},
"required": True,
"deprecated": False,
"allowEmptyValue": False,
"allowReserved": False,
}
def test_not_included_in_schema_parameter() -> None:
@get("/handler")
async def handler(param: Annotated[str, Parameter(include_in_schema=False)]) -> None:
pass
with create_test_client(handler) as client:
response = client.get("/schema/openapi.json")
response_json = response.json()
handler_schema = response_json["paths"]["/handler"]["get"]
assert "parameters" not in handler_schema
def test_two_parameters_but_one_not_included_in_schema() -> None:
@get("/handler")
def handler(param1: str, param2: str = Parameter(include_in_schema=False)) -> None:
pass
with create_test_client(handler) as client:
response = client.get("/schema/openapi.json")
response_json = response.json()
handler_schema = response_json["paths"]["/handler"]["get"]
assert "parameters" in handler_schema
parameter_names = {param["name"] for param in handler_schema["parameters"]}
assert "param1" in parameter_names
assert "param2" not in parameter_names
|