mirror of
https://github.com/correl/tornado-openapi3.git
synced 2024-11-23 11:09:56 +00:00
Correl Roush
8b243ee565
Add a unittest test case class based on Tornado's AsyncHTTPTestCase which validates responses against an OpenAPI 3 specification.
107 lines
3.1 KiB
Python
107 lines
3.1 KiB
Python
import json
|
|
from openapi_core.schema.responses.exceptions import InvalidResponse # type: ignore
|
|
import tornado.web
|
|
|
|
from tornado_openapi3.handler import OpenAPIRequestHandler
|
|
from tornado_openapi3.testing import AsyncOpenAPITestCase
|
|
|
|
|
|
def spec(responses: dict = dict()) -> dict:
|
|
return {
|
|
"openapi": "3.0.0",
|
|
"info": {
|
|
"title": "Test API",
|
|
"version": "1.0.0",
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"resource": {
|
|
"type": "object",
|
|
"properties": {"name": {"type": "string"}},
|
|
"required": ["name"],
|
|
},
|
|
},
|
|
},
|
|
"paths": {
|
|
"/resource": {
|
|
"get": {
|
|
"responses": responses,
|
|
}
|
|
}
|
|
},
|
|
}
|
|
|
|
|
|
class BaseTestCase(AsyncOpenAPITestCase):
|
|
spec = spec()
|
|
custom_media_type_deserializers = {
|
|
"application/vnd.example.resource+json": json.loads,
|
|
}
|
|
|
|
def get_app(self) -> tornado.web.Application:
|
|
testcase = self
|
|
|
|
class ResourceHandler(OpenAPIRequestHandler):
|
|
spec = self.spec
|
|
custom_media_type_deserializers = self.custom_media_type_deserializers
|
|
|
|
async def get(self) -> None:
|
|
await testcase.get(self)
|
|
|
|
return tornado.web.Application([(r"/resource", ResourceHandler)])
|
|
|
|
async def get(self, handler: tornado.web.RequestHandler) -> None:
|
|
...
|
|
|
|
|
|
class SuccessTests(BaseTestCase):
|
|
spec = spec(
|
|
responses={
|
|
"200": {
|
|
"description": "Success",
|
|
"content": {
|
|
"application/vnd.example.resource+json": {
|
|
"schema": {"$ref": "#/components/schemas/resource"}
|
|
}
|
|
},
|
|
}
|
|
}
|
|
)
|
|
|
|
async def get(self, handler: tornado.web.RequestHandler) -> None:
|
|
handler.set_header("Content-Type", "application/vnd.example.resource+json")
|
|
handler.finish(json.dumps({"name": "Name"}))
|
|
|
|
def test_success(self) -> None:
|
|
response = self.fetch("/resource")
|
|
self.assertEqual(200, response.code)
|
|
|
|
|
|
class IncorrectResponseTests(BaseTestCase):
|
|
spec = spec(responses={"200": {"description": "Success"}})
|
|
|
|
async def get(self, handler: tornado.web.RequestHandler) -> None:
|
|
handler.set_status(418)
|
|
|
|
def test_unexpected_response_code(self) -> None:
|
|
with self.assertRaises(InvalidResponse) as context:
|
|
self.fetch("/resource")
|
|
self.assertEqual("418", context.exception.http_status)
|
|
|
|
|
|
class RaiseErrorTests(BaseTestCase):
|
|
spec = spec(
|
|
responses={
|
|
"418": {
|
|
"description": "I'm a teapot",
|
|
}
|
|
}
|
|
)
|
|
|
|
async def get(self, handler: tornado.web.RequestHandler) -> None:
|
|
handler.set_status(418)
|
|
|
|
def test_fetch_throws_error_on_expected_failure(self) -> None:
|
|
with self.assertRaises(tornado.httpclient.HTTPError) as context:
|
|
self.fetch("/resource", raise_error=True)
|
|
self.assertEqual(418, context.exception.code)
|