mirror of
https://github.com/LukeHagar/connexion.git
synced 2025-12-07 04:19:28 +00:00
edb0381af3
This PR adds an interface for the ConnexionMiddleware, similar to the
interface of the Connexion Apps.
The Connexion Apps are now a simple wrapper around the
ConnexionMiddleware and framework app, delegating the work to the
middleware. This enables a similar interface and behavior for users when
using either the middleware or apps.
The arguments are repeated everywhere there is a user interface, but are
parsed in a central place. Repeating the arguments is not DRY, but
needed to provide users with IDE autocomplete, typing, etc. They are
parsed in a single `_Options` class, which also provides a mechanism to
set default options on an App level, and override them on the more
granular API level.
This makes the long list of provided parameters a lot more manageable,
so I would like to use it for the `Jsonifier` as well, and re-add the
`debug` and `extra_files` arguments which I have dropped in previous
PRs. I'll submit a separate PR for this.
I renamed the `options` parameter to `swagger_ui_options` since it only
contains swagger UI options. This is a breaking change though, and we'll
need to highlight this upon release.
We still have quite a lot of `App`, `MiddlewareApp`, and abstract
classes. It would be great if we could find a way to reduce those
further, or at least find better naming to make it more clear what each
one does 🙂 .
Finally, I added examples on how the middleware can be used with third
party frameworks under `examples/frameworks`. Currently there's an
example for Starlette and Quart, but this should be easy to extend. They
also show how the `ASGIDecorator` and `StarletteDecorator` from my
previous PR can be used.
102 lines
4.3 KiB
Python
102 lines
4.3 KiB
Python
import json
|
|
|
|
import flask
|
|
|
|
|
|
def fix_data(data):
|
|
return data.replace(b'\\"', b'"')
|
|
|
|
|
|
def test_errors(problem_app):
|
|
app_client = problem_app.test_client()
|
|
|
|
greeting404 = app_client.get("/v1.0/greeting") # type: flask.Response
|
|
assert greeting404.content_type == "application/problem+json"
|
|
assert greeting404.status_code == 404
|
|
error404 = flask.json.loads(fix_data(greeting404.data))
|
|
assert error404["type"] == "about:blank"
|
|
assert error404["title"] == "Not Found"
|
|
assert (
|
|
error404["detail"] == "The requested URL was not found on the server. "
|
|
"If you entered the URL manually please check your spelling and try again."
|
|
)
|
|
assert error404["status"] == 404
|
|
assert "instance" not in error404
|
|
|
|
get_greeting = app_client.get("/v1.0/greeting/jsantos") # type: flask.Response
|
|
assert get_greeting.content_type == "application/problem+json"
|
|
assert get_greeting.status_code == 405
|
|
error405 = json.loads(get_greeting.data.decode("utf-8", "replace"))
|
|
assert error405["type"] == "about:blank"
|
|
assert error405["title"] == "Method Not Allowed"
|
|
assert error405["status"] == 405
|
|
assert "instance" not in error405
|
|
|
|
get500 = app_client.get("/v1.0/except") # type: flask.Response
|
|
assert get500.content_type == "application/problem+json"
|
|
assert get500.status_code == 500
|
|
error500 = json.loads(get500.data.decode("utf-8", "replace"))
|
|
assert error500["type"] == "about:blank"
|
|
assert error500["title"] == "Internal Server Error"
|
|
assert (
|
|
error500["detail"]
|
|
== "The server encountered an internal error and was unable to complete your request. "
|
|
"Either the server is overloaded or there is an error in the application."
|
|
)
|
|
assert error500["status"] == 500
|
|
assert "instance" not in error500
|
|
|
|
get_problem = app_client.get("/v1.0/problem") # type: flask.Response
|
|
assert get_problem.content_type == "application/problem+json"
|
|
assert get_problem.status_code == 402
|
|
assert get_problem.headers["x-Test-Header"] == "In Test"
|
|
error_problem = json.loads(get_problem.data.decode("utf-8", "replace"))
|
|
assert error_problem["type"] == "http://www.example.com/error"
|
|
assert error_problem["title"] == "Some Error"
|
|
assert error_problem["detail"] == "Something went wrong somewhere"
|
|
assert error_problem["status"] == 402
|
|
assert error_problem["instance"] == "instance1"
|
|
|
|
get_problem2 = app_client.get("/v1.0/other_problem") # type: flask.Response
|
|
assert get_problem2.content_type == "application/problem+json"
|
|
assert get_problem2.status_code == 402
|
|
error_problem2 = json.loads(get_problem2.data.decode("utf-8", "replace"))
|
|
assert error_problem2["type"] == "about:blank"
|
|
assert error_problem2["title"] == "Some Error"
|
|
assert error_problem2["detail"] == "Something went wrong somewhere"
|
|
assert error_problem2["status"] == 402
|
|
assert error_problem2["instance"] == "instance1"
|
|
|
|
problematic_json = app_client.get(
|
|
"/v1.0/json_response_with_undefined_value_to_serialize"
|
|
) # type: flask.Response
|
|
assert problematic_json.status_code == 500
|
|
|
|
custom_problem = app_client.get("/v1.0/customized_problem_response")
|
|
assert custom_problem.status_code == 403
|
|
problem_body = json.loads(custom_problem.data.decode("utf-8", "replace"))
|
|
assert "amount" in problem_body
|
|
assert problem_body["amount"] == 23.0
|
|
|
|
problem_as_exception = app_client.get("/v1.0/problem_exception_with_extra_args")
|
|
assert problem_as_exception.status_code == 400
|
|
problem_as_exception_body = json.loads(
|
|
problem_as_exception.data.decode("utf-8", "replace")
|
|
)
|
|
assert "age" in problem_as_exception_body
|
|
assert problem_as_exception_body["age"] == 30
|
|
|
|
unsupported_media_type = app_client.post(
|
|
"/v1.0/post_wrong_content_type", data="<html></html>", content_type="text/html"
|
|
)
|
|
assert unsupported_media_type.status_code == 415
|
|
unsupported_media_type_body = json.loads(
|
|
unsupported_media_type.data.decode("utf-8", "replace")
|
|
)
|
|
assert unsupported_media_type_body["type"] == "about:blank"
|
|
assert unsupported_media_type_body["title"] == "Unsupported Media Type"
|
|
assert unsupported_media_type_body["detail"].startswith(
|
|
"Invalid Content-type (text/html)"
|
|
)
|
|
assert unsupported_media_type_body["status"] == 415
|