mirror of
https://github.com/LukeHagar/connexion.git
synced 2025-12-06 04:19:26 +00:00
abc1da750e
Works towards #1531 Some parts of the old outing docs will need to be included on the `parameters` and `swagger-ui` pages which we still need to add.
310 lines
9.6 KiB
Python
310 lines
9.6 KiB
Python
import connexion.apps
|
|
import pytest
|
|
from connexion.exceptions import ResolverError
|
|
from connexion.operations import Swagger2Operation
|
|
from connexion.resolver import RelativeResolver, Resolver, RestyResolver
|
|
|
|
|
|
def test_standard_get_function():
|
|
function = Resolver().resolve_function_from_operation_id(
|
|
"connexion.FlaskApp.add_error_handler"
|
|
)
|
|
assert function == connexion.FlaskApp.add_error_handler
|
|
|
|
|
|
def test_relative_get_function():
|
|
function = RelativeResolver("connexion").resolve_function_from_operation_id(
|
|
"connexion.FlaskApp.add_error_handler"
|
|
)
|
|
assert function == connexion.FlaskApp.add_error_handler
|
|
|
|
|
|
def test_resty_get_function():
|
|
function = RestyResolver("connexion").resolve_function_from_operation_id(
|
|
"connexion.FlaskApp.add_error_handler"
|
|
)
|
|
assert function == connexion.FlaskApp.add_error_handler
|
|
|
|
|
|
def test_missing_operation_id():
|
|
# Missing operationIDs should result in a well-defined error that can
|
|
# be handled upstream.
|
|
with pytest.raises(ResolverError):
|
|
Resolver().resolve_function_from_operation_id(None)
|
|
with pytest.raises(ResolverError):
|
|
RelativeResolver("connexion").resolve_function_from_operation_id(None)
|
|
with pytest.raises(ResolverError):
|
|
RestyResolver("connexion").resolve_function_from_operation_id(None)
|
|
|
|
|
|
def test_bad_operation_id():
|
|
# Unresolvable operationIDs should result in a well-defined error that can
|
|
# be handled upstream.
|
|
with pytest.raises(ResolverError):
|
|
Resolver().resolve_function_from_operation_id("ohai.I.do.not.exist")
|
|
with pytest.raises(ResolverError):
|
|
RelativeResolver("connexion").resolve_function_from_operation_id(
|
|
"ohai.I.do.not.exist"
|
|
)
|
|
with pytest.raises(ResolverError):
|
|
RestyResolver("connexion").resolve_function_from_operation_id(
|
|
"ohai.I.do.not.exist"
|
|
)
|
|
|
|
|
|
def test_standard_resolve_x_router_controller():
|
|
operation = Swagger2Operation(
|
|
method="GET",
|
|
path="endpoint",
|
|
path_parameters=[],
|
|
operation={
|
|
"x-swagger-router-controller": "fakeapi.hello",
|
|
"operationId": "post_greeting",
|
|
},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=Resolver(),
|
|
)
|
|
assert operation.operation_id == "fakeapi.hello.post_greeting"
|
|
|
|
|
|
def test_relative_resolve_x_router_controller():
|
|
operation = Swagger2Operation(
|
|
method="GET",
|
|
path="endpoint",
|
|
path_parameters=[],
|
|
operation={
|
|
"x-swagger-router-controller": "fakeapi.hello",
|
|
"operationId": "post_greeting",
|
|
},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RelativeResolver("root_path"),
|
|
)
|
|
assert operation.operation_id == "fakeapi.hello.post_greeting"
|
|
|
|
|
|
def test_relative_resolve_operation_id():
|
|
operation = Swagger2Operation(
|
|
method="GET",
|
|
path="endpoint",
|
|
path_parameters=[],
|
|
operation={
|
|
"operationId": "hello.post_greeting",
|
|
},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RelativeResolver("fakeapi"),
|
|
)
|
|
assert operation.operation_id == "fakeapi.hello.post_greeting"
|
|
|
|
|
|
def test_relative_resolve_operation_id_with_module():
|
|
import fakeapi
|
|
|
|
operation = Swagger2Operation(
|
|
method="GET",
|
|
path="endpoint",
|
|
path_parameters=[],
|
|
operation={
|
|
"operationId": "hello.post_greeting",
|
|
},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RelativeResolver(fakeapi),
|
|
)
|
|
assert operation.operation_id == "fakeapi.hello.post_greeting"
|
|
|
|
|
|
def test_resty_resolve_operation_id():
|
|
operation = Swagger2Operation(
|
|
method="GET",
|
|
path="endpoint",
|
|
path_parameters=[],
|
|
operation={
|
|
"operationId": "fakeapi.hello.post_greeting",
|
|
},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RestyResolver("fakeapi"),
|
|
)
|
|
assert operation.operation_id == "fakeapi.hello.post_greeting"
|
|
|
|
|
|
def test_resty_resolve_x_router_controller_with_operation_id():
|
|
operation = Swagger2Operation(
|
|
method="GET",
|
|
path="endpoint",
|
|
path_parameters=[],
|
|
operation={
|
|
"x-swagger-router-controller": "fakeapi.hello",
|
|
"operationId": "post_greeting",
|
|
},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RestyResolver("fakeapi"),
|
|
)
|
|
assert operation.operation_id == "fakeapi.hello.post_greeting"
|
|
|
|
|
|
def test_resty_resolve_x_router_controller_without_operation_id():
|
|
operation = Swagger2Operation(
|
|
method="GET",
|
|
path="/hello/{id}",
|
|
path_parameters=[],
|
|
operation={"x-swagger-router-controller": "fakeapi.hello"},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RestyResolver("fakeapi"),
|
|
)
|
|
assert operation.operation_id == "fakeapi.hello.get"
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name():
|
|
operation = Swagger2Operation(
|
|
method="GET",
|
|
path="/hello/{id}",
|
|
path_parameters=[],
|
|
operation={},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RestyResolver("fakeapi"),
|
|
)
|
|
assert operation.operation_id == "fakeapi.hello.get"
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_nested():
|
|
operation = Swagger2Operation(
|
|
method="GET",
|
|
path="/hello/{id}/world",
|
|
path_parameters=[],
|
|
operation={},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RestyResolver("fakeapi"),
|
|
)
|
|
assert operation.operation_id == "fakeapi.hello.world.search"
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_lowercase_verb():
|
|
operation = Swagger2Operation(
|
|
method="get",
|
|
path="/hello/{id}",
|
|
path_parameters=[],
|
|
operation={},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RestyResolver("fakeapi"),
|
|
)
|
|
assert operation.operation_id == "fakeapi.hello.get"
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_lowercase_verb_nested():
|
|
operation = Swagger2Operation(
|
|
method="get",
|
|
path="/hello/world/{id}",
|
|
path_parameters=[],
|
|
operation={},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RestyResolver("fakeapi"),
|
|
)
|
|
assert operation.operation_id == "fakeapi.hello.world.get"
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_will_translate_dashes_in_resource_name():
|
|
operation = Swagger2Operation(
|
|
method="GET",
|
|
path="/foo-bar",
|
|
path_parameters=[],
|
|
operation={},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RestyResolver("fakeapi"),
|
|
)
|
|
assert operation.operation_id == "fakeapi.foo_bar.search"
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_can_resolve_api_root():
|
|
operation = Swagger2Operation(
|
|
method="GET",
|
|
path="/",
|
|
path_parameters=[],
|
|
operation={},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RestyResolver("fakeapi"),
|
|
)
|
|
assert operation.operation_id == "fakeapi.get"
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_will_resolve_resource_root_get_as_search():
|
|
operation = Swagger2Operation(
|
|
method="GET",
|
|
path="/hello",
|
|
path_parameters=[],
|
|
operation={},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RestyResolver("fakeapi"),
|
|
)
|
|
assert operation.operation_id == "fakeapi.hello.search"
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_and_x_router_controller_will_resolve_resource_root_get_as_search():
|
|
operation = Swagger2Operation(
|
|
method="GET",
|
|
path="/hello",
|
|
path_parameters=[],
|
|
operation={
|
|
"x-swagger-router-controller": "fakeapi.hello",
|
|
},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RestyResolver("fakeapi"),
|
|
)
|
|
assert operation.operation_id == "fakeapi.hello.search"
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_will_resolve_resource_root_as_configured():
|
|
operation = Swagger2Operation(
|
|
method="GET",
|
|
path="/hello",
|
|
path_parameters=[],
|
|
operation={},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RestyResolver("fakeapi", collection_endpoint_name="api_list"),
|
|
)
|
|
assert operation.operation_id == "fakeapi.hello.api_list"
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_will_resolve_resource_root_post_as_post():
|
|
operation = Swagger2Operation(
|
|
method="POST",
|
|
path="/hello",
|
|
path_parameters=[],
|
|
operation={},
|
|
app_produces=["application/json"],
|
|
app_consumes=["application/json"],
|
|
definitions={},
|
|
resolver=RestyResolver("fakeapi"),
|
|
)
|
|
assert operation.operation_id == "fakeapi.hello.post"
|