mirror of
https://github.com/correl/tornado-openapi3.git
synced 2024-11-23 11:09:56 +00:00
a2c25247d9
- Drop support for tornado<6 - Drop support for Python<3.9 - Add support for Python 3.10, 3.11, 3.12, and 3.13
102 lines
3.2 KiB
Python
102 lines
3.2 KiB
Python
from typing import Any
|
|
|
|
import tornado.httpclient
|
|
import tornado.testing
|
|
|
|
from openapi_core import create_spec # type: ignore
|
|
from openapi_core.spec.paths import SpecPath # type: ignore
|
|
from tornado_openapi3.responses import ResponseValidator
|
|
|
|
|
|
class AsyncOpenAPITestCase(tornado.testing.AsyncHTTPTestCase):
|
|
"""A test case that starts up an HTTP server.
|
|
|
|
An async test case extending :class:`tornado.testing.AsyncHTTPTestCase`,
|
|
providing OpenAPI spec validation on the responses from your application and
|
|
raising errors in tests.
|
|
|
|
"""
|
|
|
|
@property
|
|
def spec_dict(self) -> dict:
|
|
"""The OpenAPI 3 specification
|
|
|
|
Override this in your test cases to load or define your OpenAPI 3 spec.
|
|
|
|
:rtype: dict
|
|
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
@property
|
|
def spec(self) -> SpecPath:
|
|
"""The OpenAPI 3 specification.
|
|
|
|
Override this in your test cases to customize how your OpenAPI 3 spec is
|
|
loaded and validated.
|
|
|
|
:rtype: :class:`openapi_core.schema.specs.model.Spec`
|
|
|
|
"""
|
|
return create_spec(self.spec_dict)
|
|
|
|
@property
|
|
def custom_formatters(self) -> dict:
|
|
"""A dictionary mapping value formats to formatter objects.
|
|
|
|
A formatter object must provide:
|
|
- validate(self, value) -> bool
|
|
- unmarshal(self, value) -> Any
|
|
"""
|
|
|
|
return dict()
|
|
|
|
@property
|
|
def custom_media_type_deserializers(self) -> dict:
|
|
"""A dictionary mapping media types to deserializing functions.
|
|
|
|
If your endpoints make use of content types beyond ``application/json``,
|
|
you must add them to this dictionary with a deserializing method that
|
|
converts the raw body (as ``bytes`` or ``str``) to Python objects.
|
|
|
|
"""
|
|
return dict()
|
|
|
|
def setUp(self) -> None:
|
|
"""Hook method for setting up the test fixture before exercising it.
|
|
|
|
Instantiates the :class:`~tornado_openapi3.responses.ResponseValidator`
|
|
for this test case.
|
|
|
|
"""
|
|
super().setUp()
|
|
self.validator = ResponseValidator(
|
|
self.spec,
|
|
custom_formatters=self.custom_formatters,
|
|
custom_media_type_deserializers=self.custom_media_type_deserializers,
|
|
)
|
|
|
|
def fetch(
|
|
self, path: str, raise_error: bool = False, **kwargs: Any
|
|
) -> tornado.httpclient.HTTPResponse:
|
|
"""Convenience methiod to synchronously fetch a URL.
|
|
|
|
Extends the fetch method in Tornado's
|
|
:class:``tornado.testing.AsyncHTTPTestCase`` to perform OpenAPI 3
|
|
validation on the response received before returning it. If validation
|
|
fails, an :class:`openapi_core.exceptions.OpenAPIError` will be raised
|
|
describing the failure.
|
|
|
|
If the path begins with http:// or https://, it will be treated as a
|
|
full URL and will be fetched as-is, and no validation will occur.
|
|
|
|
"""
|
|
if path.lower().startswith(("http://", "https://")):
|
|
return super().fetch(path, raise_error=raise_error, **kwargs)
|
|
|
|
response = super().fetch(path, raise_error=False, **kwargs)
|
|
result = self.validator.validate(response)
|
|
result.raise_for_errors()
|
|
if raise_error:
|
|
response.rethrow()
|
|
return response
|