File: test_endpoints.py

package info (click to toggle)
litestar 2.19.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 12,500 kB
  • sloc: python: 70,169; makefile: 254; javascript: 105; sh: 60
file content (487 lines) | stat: -rw-r--r-- 20,208 bytes parent folder | download
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
from typing import List, Optional, Type

import pytest

from litestar import Controller
from litestar.enums import MediaType
from litestar.openapi.config import OpenAPIConfig
from litestar.openapi.controller import OpenAPIController
from litestar.openapi.plugins import (
    JsonRenderPlugin,
    OpenAPIRenderPlugin,
    RapidocRenderPlugin,
    RedocRenderPlugin,
    ScalarRenderPlugin,
    StoplightRenderPlugin,
    SwaggerRenderPlugin,
)
from litestar.status_codes import HTTP_200_OK, HTTP_404_NOT_FOUND
from litestar.testing import create_test_client

root_paths: List[str] = ["", "/part1", "/part1/part2"]


@pytest.fixture()
def config(openapi_controller: Optional[Type[OpenAPIController]]) -> OpenAPIConfig:
    return OpenAPIConfig(title="Litestar API", version="1.0.0", openapi_controller=openapi_controller)


def test_default_redoc_cdn_urls(
    person_controller: Type[Controller], pet_controller: Type[Controller], config: OpenAPIConfig
) -> None:
    default_redoc_version = "latest"
    default_redoc_js_bundle = f"https://cdn.redoc.ly/redoc/{default_redoc_version}/bundles/redoc.standalone.js"
    with create_test_client([person_controller, pet_controller], openapi_config=config) as client:
        response = client.get("/schema/redoc")
        assert default_redoc_js_bundle in response.text


def test_default_swagger_ui_cdn_urls(
    person_controller: Type[Controller], pet_controller: Type[Controller], config: OpenAPIConfig
) -> None:
    default_swagger_ui_version = "5.18.2"
    default_swagger_bundles = [
        f"https://cdn.jsdelivr.net/npm/swagger-ui-dist@{default_swagger_ui_version}/swagger-ui.css",
        f"https://cdn.jsdelivr.net/npm/swagger-ui-dist@{default_swagger_ui_version}/swagger-ui-bundle.js",
        f"https://cdn.jsdelivr.net/npm/swagger-ui-dist@{default_swagger_ui_version}/swagger-ui-standalone-preset.js",
    ]
    with create_test_client([person_controller, pet_controller], openapi_config=config) as client:
        response = client.get("/schema/swagger")
        assert all(cdn_url in response.text for cdn_url in default_swagger_bundles)


def test_default_stoplight_elements_cdn_urls(
    person_controller: Type[Controller], pet_controller: Type[Controller], config: OpenAPIConfig
) -> None:
    default_stoplight_elements_version = "7.7.18"
    default_stoplight_elements_bundles = [
        f"https://unpkg.com/@stoplight/elements@{default_stoplight_elements_version}/styles.min.css",
        f"https://unpkg.com/@stoplight/elements@{default_stoplight_elements_version}/web-components.min.js",
    ]
    with create_test_client([person_controller, pet_controller], openapi_config=config) as client:
        response = client.get("/schema/elements")
        assert all(cdn_url in response.text for cdn_url in default_stoplight_elements_bundles)


def test_default_rapidoc_elements_cdn_urls(
    person_controller: Type[Controller], pet_controller: Type[Controller], config: OpenAPIConfig
) -> None:
    default_rapidoc_version = "9.3.4"
    default_rapidoc_bundles = [f"https://unpkg.com/rapidoc@{default_rapidoc_version}/dist/rapidoc-min.js"]
    with create_test_client([person_controller, pet_controller], openapi_config=config) as client:
        response = client.get("/schema/rapidoc")
        assert all(cdn_url in response.text for cdn_url in default_rapidoc_bundles)


def test_redoc_with_google_fonts(
    person_controller: Type[Controller], pet_controller: Type[Controller], config: OpenAPIConfig
) -> None:
    google_font_cdn = "https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700"
    with create_test_client([person_controller, pet_controller], openapi_config=config) as client:
        response = client.get("/schema/redoc")
        assert google_font_cdn in response.text


@pytest.mark.parametrize(
    ("openapi_controller", "render_plugins"),
    [
        (type("OfflineOpenAPIController", (OpenAPIController,), {"redoc_google_fonts": False}), []),
        (None, [RedocRenderPlugin(google_fonts=False)]),
    ],
)
def test_redoc_without_google_fonts(
    person_controller: Type[Controller],
    pet_controller: Type[Controller],
    openapi_controller: Optional[Type[OpenAPIController]],
    render_plugins: List[OpenAPIRenderPlugin],
) -> None:
    offline_config = OpenAPIConfig(
        title="Litestar API", version="1.0.0", openapi_controller=openapi_controller, render_plugins=render_plugins
    )
    with create_test_client([person_controller, pet_controller], openapi_config=offline_config) as client:
        response = client.get("/schema/redoc")
        assert "fonts.googleapis.com" not in response.text


OFFLINE_LOCATION_JS_URL = "https://offline_location/bundle.js"
OFFLINE_LOCATION_CSS_URL = "https://offline_location/bundle.css"
OFFLINE_LOCATION_OTHER_URL = "https://offline_location/bundle.other"


@pytest.mark.parametrize(
    ("openapi_controller", "render_plugins"),
    [
        (type("OfflineOpenAPIController", (OpenAPIController,), {"redoc_js_url": OFFLINE_LOCATION_JS_URL}), []),
        (None, [RedocRenderPlugin(js_url=OFFLINE_LOCATION_JS_URL)]),
    ],
)
def test_openapi_redoc_offline(
    person_controller: Type[Controller],
    pet_controller: Type[Controller],
    openapi_controller: Optional[Type[OpenAPIController]],
    render_plugins: List[OpenAPIRenderPlugin],
) -> None:
    offline_config = OpenAPIConfig(
        title="Litestar API", version="1.0.0", openapi_controller=openapi_controller, render_plugins=render_plugins
    )
    with create_test_client([person_controller, pet_controller], openapi_config=offline_config) as client:
        response = client.get("/schema/redoc")
        assert OFFLINE_LOCATION_JS_URL in response.text


@pytest.mark.parametrize(
    ("openapi_controller", "render_plugins"),
    [
        (
            type(
                "OfflineOpenAPIController",
                (OpenAPIController,),
                {
                    "swagger_ui_bundle_js_url": OFFLINE_LOCATION_JS_URL,
                    "swagger_css_url": OFFLINE_LOCATION_CSS_URL,
                    "swagger_ui_standalone_preset_js_url": OFFLINE_LOCATION_OTHER_URL,
                },
            ),
            [],
        ),
        (
            None,
            [
                SwaggerRenderPlugin(
                    js_url=OFFLINE_LOCATION_JS_URL,
                    css_url=OFFLINE_LOCATION_CSS_URL,
                    standalone_preset_js_url=OFFLINE_LOCATION_OTHER_URL,
                )
            ],
        ),
    ],
)
def test_openapi_swagger_offline(
    person_controller: Type[Controller],
    pet_controller: Type[Controller],
    openapi_controller: Optional[Type[OpenAPIController]],
    render_plugins: List[OpenAPIRenderPlugin],
) -> None:
    offline_config = OpenAPIConfig(
        title="Litestar API", version="1.0.0", openapi_controller=openapi_controller, render_plugins=render_plugins
    )
    with create_test_client([person_controller, pet_controller], openapi_config=offline_config) as client:
        response = client.get("/schema/swagger")
        assert all(
            offline_url in response.text
            for offline_url in [OFFLINE_LOCATION_JS_URL, OFFLINE_LOCATION_CSS_URL, OFFLINE_LOCATION_OTHER_URL]
        )


@pytest.mark.parametrize(
    ("openapi_controller", "render_plugins"),
    [
        (
            type(
                "OfflineOpenAPIController",
                (OpenAPIController,),
                {
                    "stoplight_elements_css_url": OFFLINE_LOCATION_CSS_URL,
                    "stoplight_elements_js_url": OFFLINE_LOCATION_JS_URL,
                },
            ),
            [],
        ),
        (
            None,
            [
                StoplightRenderPlugin(
                    js_url=OFFLINE_LOCATION_JS_URL,
                    css_url=OFFLINE_LOCATION_CSS_URL,
                )
            ],
        ),
    ],
)
def test_openapi_stoplight_elements_offline(
    person_controller: Type[Controller],
    pet_controller: Type[Controller],
    openapi_controller: Optional[Type[OpenAPIController]],
    render_plugins: List[OpenAPIRenderPlugin],
) -> None:
    offline_config = OpenAPIConfig(
        title="Litestar API", version="1.0.0", openapi_controller=openapi_controller, render_plugins=render_plugins
    )
    with create_test_client([person_controller, pet_controller], openapi_config=offline_config) as client:
        response = client.get("/schema/elements")
        assert all(offline_url in response.text for offline_url in [OFFLINE_LOCATION_JS_URL, OFFLINE_LOCATION_CSS_URL])


@pytest.mark.parametrize(
    ("openapi_controller", "render_plugins"),
    [
        (
            None,
            [
                ScalarRenderPlugin(
                    js_url=OFFLINE_LOCATION_JS_URL,
                    css_url=OFFLINE_LOCATION_CSS_URL,
                )
            ],
        ),
    ],
)
def test_openapi_scalar_offline(
    person_controller: Type[Controller],
    pet_controller: Type[Controller],
    openapi_controller: Optional[Type[OpenAPIController]],
    render_plugins: List[OpenAPIRenderPlugin],
) -> None:
    offline_config = OpenAPIConfig(
        title="Litestar API", version="1.0.0", openapi_controller=openapi_controller, render_plugins=render_plugins
    )
    with create_test_client([person_controller, pet_controller], openapi_config=offline_config) as client:
        response = client.get("/schema/scalar")
        assert all(offline_url in response.text for offline_url in [OFFLINE_LOCATION_JS_URL, OFFLINE_LOCATION_CSS_URL])


@pytest.mark.parametrize(
    ("openapi_controller", "render_plugins"),
    [
        (type("OfflineOpenAPIController", (OpenAPIController,), {"rapidoc_js_url": OFFLINE_LOCATION_JS_URL}), []),
        (None, [RapidocRenderPlugin(js_url=OFFLINE_LOCATION_JS_URL)]),
    ],
)
def test_openapi_rapidoc_offline(
    person_controller: Type[Controller],
    pet_controller: Type[Controller],
    openapi_controller: Optional[Type[OpenAPIController]],
    render_plugins: List[OpenAPIRenderPlugin],
) -> None:
    offline_config = OpenAPIConfig(
        title="Litestar API", version="1.0.0", openapi_controller=openapi_controller, render_plugins=render_plugins
    )
    with create_test_client([person_controller, pet_controller], openapi_config=offline_config) as client:
        response = client.get("/schema/rapidoc")
        assert OFFLINE_LOCATION_JS_URL in response.text


@pytest.mark.parametrize("root_path", root_paths)
def test_openapi_root(
    root_path: str, person_controller: Type[Controller], pet_controller: Type[Controller], config: OpenAPIConfig
) -> None:
    with create_test_client([person_controller, pet_controller], root_path=root_path, openapi_config=config) as client:
        response = client.get("/schema")
        assert response.status_code == HTTP_200_OK
        assert response.headers["content-type"].startswith(MediaType.HTML.value)


@pytest.mark.parametrize("root_path", root_paths)
def test_openapi_redoc(
    root_path: str, person_controller: Type[Controller], pet_controller: Type[Controller], config: OpenAPIConfig
) -> None:
    with create_test_client([person_controller, pet_controller], root_path=root_path, openapi_config=config) as client:
        response = client.get("/schema/redoc")
        assert response.status_code == HTTP_200_OK
        assert response.headers["content-type"].startswith(MediaType.HTML.value)


@pytest.mark.parametrize("root_path", root_paths)
def test_openapi_swagger(
    root_path: str, person_controller: Type[Controller], pet_controller: Type[Controller], config: OpenAPIConfig
) -> None:
    with create_test_client([person_controller, pet_controller], root_path=root_path, openapi_config=config) as client:
        response = client.get("/schema/swagger")
        assert response.status_code == HTTP_200_OK
        assert response.headers["content-type"].startswith(MediaType.HTML.value)


@pytest.mark.parametrize("root_path", root_paths)
def test_openapi_swagger_caching_schema(
    root_path: str, person_controller: Type[Controller], pet_controller: Type[Controller], config: OpenAPIConfig
) -> None:
    with create_test_client([person_controller, pet_controller], root_path=root_path, openapi_config=config) as client:
        # Make sure that the schema is tweaked for swagger as the openapi version is changed.
        # Because schema can get cached, make sure that getting a different schema type before works.
        client.get("/schema/redoc")  # Cache the schema
        response = client.get("/schema/swagger")  # Request swagger, should use a different cache

        assert "3.1.0" in response.text  # Make sure the injected version is still there
        assert response.status_code == HTTP_200_OK
        assert response.headers["content-type"].startswith(MediaType.HTML.value)


@pytest.mark.parametrize("root_path", root_paths)
def test_openapi_stoplight_elements(
    root_path: str, person_controller: Type[Controller], pet_controller: Type[Controller], config: OpenAPIConfig
) -> None:
    with create_test_client([person_controller, pet_controller], root_path=root_path, openapi_config=config) as client:
        response = client.get("/schema/elements/")
        assert response.status_code == HTTP_200_OK
        assert response.headers["content-type"].startswith(MediaType.HTML.value)


@pytest.mark.parametrize("root_path", root_paths)
def test_openapi_rapidoc(
    root_path: str, person_controller: Type[Controller], pet_controller: Type[Controller], config: OpenAPIConfig
) -> None:
    with create_test_client([person_controller, pet_controller], root_path=root_path, openapi_config=config) as client:
        response = client.get("/schema/rapidoc")
        assert response.status_code == HTTP_200_OK
        assert response.headers["content-type"].startswith(MediaType.HTML.value)


def test_openapi_root_not_allowed(
    person_controller: Type[Controller],
    pet_controller: Type[Controller],
    openapi_controller: Optional[Type[OpenAPIController]],
) -> None:
    with create_test_client(
        [person_controller, pet_controller],
        openapi_config=OpenAPIConfig(
            title="Litestar API",
            version="1.0.0",
            enabled_endpoints={"swagger", "elements", "openapi.json", "openapi.yaml", "openapi.yml"},
            openapi_controller=openapi_controller,
        ),
    ) as client:
        response = client.get("/schema")
        assert response.status_code == HTTP_404_NOT_FOUND
        assert response.headers["content-type"].startswith(MediaType.HTML.value)


def test_openapi_redoc_not_allowed(
    person_controller: Type[Controller],
    pet_controller: Type[Controller],
    openapi_controller: Optional[Type[OpenAPIController]],
) -> None:
    with create_test_client(
        [person_controller, pet_controller],
        openapi_config=OpenAPIConfig(
            title="Litestar API",
            version="1.0.0",
            enabled_endpoints={"swagger", "elements", "openapi.json", "openapi.yaml", "openapi.yml"},
            openapi_controller=openapi_controller,
        ),
    ) as client:
        response = client.get("/schema/redoc")
        assert response.status_code == HTTP_404_NOT_FOUND
        assert response.headers["content-type"].startswith(MediaType.HTML.value)


def test_openapi_swagger_not_allowed(
    person_controller: Type[Controller],
    pet_controller: Type[Controller],
    openapi_controller: Optional[Type[OpenAPIController]],
) -> None:
    with create_test_client(
        [person_controller, pet_controller],
        openapi_config=OpenAPIConfig(
            title="Litestar API",
            version="1.0.0",
            enabled_endpoints={"redoc", "elements", "openapi.json", "openapi.yaml", "openapi.yml"},
            openapi_controller=openapi_controller,
        ),
    ) as client:
        response = client.get("/schema/swagger")
        assert response.status_code == HTTP_404_NOT_FOUND
        assert response.headers["content-type"].startswith(MediaType.HTML.value)


def test_openapi_stoplight_elements_not_allowed(
    person_controller: Type[Controller],
    pet_controller: Type[Controller],
    openapi_controller: Optional[Type[OpenAPIController]],
) -> None:
    with create_test_client(
        [person_controller, pet_controller],
        openapi_config=OpenAPIConfig(
            title="Litestar API",
            version="1.0.0",
            enabled_endpoints={"redoc", "swagger", "openapi.json", "openapi.yaml", "openapi.yml"},
            openapi_controller=openapi_controller,
        ),
    ) as client:
        response = client.get("/schema/elements/")
        assert response.status_code == HTTP_404_NOT_FOUND
        assert response.headers["content-type"].startswith(MediaType.HTML.value)


def test_openapi_rapidoc_not_allowed(
    person_controller: Type[Controller],
    pet_controller: Type[Controller],
    openapi_controller: Optional[Type[OpenAPIController]],
) -> None:
    with create_test_client(
        [person_controller, pet_controller],
        openapi_config=OpenAPIConfig(
            title="Litestar API",
            version="1.0.0",
            enabled_endpoints={"swagger", "elements", "openapi.json", "openapi.yaml", "openapi.yml"},
            openapi_controller=openapi_controller,
        ),
    ) as client:
        response = client.get("/schema/rapidoc")
        assert response.status_code == HTTP_404_NOT_FOUND
        assert response.headers["content-type"].startswith(MediaType.HTML.value)


@pytest.mark.parametrize(
    ("render_plugins",),
    [
        ([],),
        ([RedocRenderPlugin()],),
        ([RedocRenderPlugin(), JsonRenderPlugin()],),
        ([JsonRenderPlugin(path="/custom_path")],),
        ([JsonRenderPlugin(path=["/openapi.json", "/custom_path"])],),
    ],
)
def test_json_plugin_always_enabled(render_plugins: List["OpenAPIRenderPlugin"]) -> None:
    """We assume that an '/openapi.json' path is available in many of the openapi render plugins.

    This test ensures that the json plugin is always enabled, even if the user has not explicitly
    included it in the render_plugins list.
    """

    openapi_config = OpenAPIConfig(title="my title", version="1.0.0", render_plugins=render_plugins)
    with create_test_client([], openapi_config=openapi_config) as client:
        response = client.get("/schema/openapi.json")
        assert response.status_code == HTTP_200_OK


def test_default_plugin_explicit_path() -> None:
    config = OpenAPIConfig(title="my title", version="1.0.0", render_plugins=[SwaggerRenderPlugin(path="/")])
    with create_test_client([], openapi_config=config) as client:
        response = client.get("/schema/")
        assert response.status_code == HTTP_200_OK

        response = client.get("/schema/swagger")
        assert response.status_code == HTTP_404_NOT_FOUND


def test_default_plugin_backward_compatibility() -> None:
    config = OpenAPIConfig(title="my title", version="1.0.0")
    with create_test_client([], openapi_config=config) as client:
        response = client.get("/schema/")
        assert response.status_code == HTTP_200_OK

        response = client.get("/schema/redoc")
        assert response.status_code == HTTP_200_OK


def test_default_plugin_backward_compatibility_not_found() -> None:
    config = OpenAPIConfig(title="my title", version="1.0.0", enabled_endpoints={"redoc"}, root_schema_site="swagger")
    with create_test_client([], openapi_config=config) as client:
        response = client.get("/schema/")
        assert response.status_code == HTTP_404_NOT_FOUND

        response = client.get("/schema/swagger")
        assert response.status_code == HTTP_404_NOT_FOUND

        response = client.get("/schema/redoc")
        assert response.status_code == HTTP_200_OK


def test_default_plugin_future_compatibility() -> None:
    config = OpenAPIConfig(title="my title", version="1.0.0", render_plugins=[SwaggerRenderPlugin()])
    with create_test_client([], openapi_config=config) as client:
        response = client.get("/schema/")
        assert response.status_code == HTTP_200_OK

        response = client.get("/schema/swagger")
        assert response.status_code == HTTP_200_OK