Files
connexion/tests/test_resolver_methodview.py
Simon 92867452a2 Added MethodViewResolver (#847)
* Added MethodViewResolver

By subclassing RestyResolver and modifying its `resolve_function_from_operation_id` method, it is now possible to use automatic routing functionality with Flask's MethodView together with MethodViewResolver.

* Add MethodView example

* Add tests for methodview

* add documentation on how to use MethodViewResolver
2019-02-04 08:25:27 +01:00

180 lines
5.6 KiB
Python

from connexion.operations import OpenAPIOperation
from connexion.resolver import MethodViewResolver, Resolver
COMPONENTS = {'parameters': {'myparam': {'in': 'path', 'schema': {'type': 'integer'}}}}
def test_standard_resolve_x_router_controller():
operation = OpenAPIOperation(
api=None,
method='GET',
path='endpoint',
path_parameters=[],
operation={
'x-openapi-router-controller': 'fakeapi.hello',
'operationId': 'post_greeting',
},
app_security=[],
components=COMPONENTS,
resolver=Resolver()
)
assert operation.operation_id == 'fakeapi.hello.post_greeting'
def test_methodview_resolve_operation_id():
operation = OpenAPIOperation(
api=None,
method='GET',
path='endpoint',
path_parameters=[],
operation={
'operationId': 'fakeapi.hello.post_greeting',
},
app_security=[],
components=COMPONENTS,
resolver=MethodViewResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.hello.post_greeting'
def test_methodview_resolve_x_router_controller_with_operation_id():
operation = OpenAPIOperation(
api=None,
method='GET',
path='endpoint',
path_parameters=[],
operation={
'x-openapi-router-controller': 'fakeapi.Example_methodView',
'operationId': 'post_greeting',
},
app_security=[],
components=COMPONENTS,
resolver=MethodViewResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.Example_methodView.post_greeting'
def test_methodview_resolve_x_router_controller_without_operation_id():
operation = OpenAPIOperation(api=None,
method='GET',
path='/hello/{id}',
path_parameters=[],
operation={'x-openapi-router-controller': 'fakeapi.Example_method'},
app_security=[],
components=COMPONENTS,
resolver=MethodViewResolver('fakeapi'))
assert operation.operation_id == 'fakeapi.Example_methodView.get'
def test_methodview_resolve_with_default_module_name():
operation = OpenAPIOperation(
api=None,
method='GET',
path='/example_method/{id}',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
resolver=MethodViewResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.Example_methodView.get'
def test_methodview_resolve_with_default_module_name_lowercase_verb():
operation = OpenAPIOperation(
api=None,
method='get',
path='/example_method/{id}',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
resolver=MethodViewResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.Example_methodView.get'
def test_methodview_resolve_with_default_module_name_will_translate_dashes_in_resource_name():
operation = OpenAPIOperation(
api=None,
method='GET',
path='/example-method',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
resolver=MethodViewResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.Example_methodView.search'
def test_methodview_resolve_with_default_module_name_can_resolve_api_root():
operation = OpenAPIOperation(
api=None,
method='GET',
path='/',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
resolver=MethodViewResolver('fakeapi.Example_method',)
)
assert operation.operation_id == 'fakeapi.Example_methodView.get'
def test_methodview_resolve_with_default_module_name_will_resolve_resource_root_get_as_search():
operation = OpenAPIOperation(
api=None,
method='GET',
path='/example_method',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
resolver=MethodViewResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.Example_methodView.search'
def test_methodview_resolve_with_default_module_name_and_x_router_controller_will_resolve_resource_root_get_as_search():
operation = OpenAPIOperation(
api=None,
method='GET',
path='/hello',
path_parameters=[],
operation={
'x-openapi-router-controller': 'fakeapi.example_method',
},
app_security=[],
components=COMPONENTS,
resolver=MethodViewResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.Example_methodView.search'
def test_methodview_resolve_with_default_module_name_will_resolve_resource_root_as_configured():
operation = OpenAPIOperation(
api=None,
method='GET',
path='/example_method',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
resolver=MethodViewResolver('fakeapi', 'api_list')
)
assert operation.operation_id == 'fakeapi.Example_methodView.api_list'
def test_methodview_resolve_with_default_module_name_will_resolve_resource_root_post_as_post():
operation = OpenAPIOperation(
api=None,
method='POST',
path='/example_method',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
resolver=MethodViewResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.Example_methodView.post'