Files
connexion/tests/test_resolver3.py
Ruwann 7c862e1ba8 Feature/relative resolver (#1419)
* Add a relative resolver

* Fix super() usage

* Apply suggestions from code review

* Allow root_path to be a Python module

* Expand documentation for RelativeResolver

* Add tests for relative resolver
2021-10-06 11:34:07 +02:00

260 lines
7.3 KiB
Python

from connexion.operations import OpenAPIOperation
from connexion.resolver import RelativeResolver, Resolver, RestyResolver
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_relative_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=RelativeResolver('root_path')
)
assert operation.operation_id == 'fakeapi.hello.post_greeting'
def test_relative_resolve_operation_id():
operation = OpenAPIOperation(
api=None,
method='GET',
path='endpoint',
path_parameters=[],
operation={
'operationId': 'hello.post_greeting',
},
app_security=[],
components=COMPONENTS,
resolver=RelativeResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.hello.post_greeting'
def test_relative_resolve_operation_id_with_module():
import fakeapi
operation = OpenAPIOperation(
api=None,
method='GET',
path='endpoint',
path_parameters=[],
operation={
'operationId': 'hello.post_greeting',
},
app_security=[],
components=COMPONENTS,
resolver=RelativeResolver(fakeapi)
)
assert operation.operation_id == 'fakeapi.hello.post_greeting'
def test_resty_resolve_operation_id():
operation = OpenAPIOperation(
api=None,
method='GET',
path='endpoint',
path_parameters=[],
operation={
'operationId': 'fakeapi.hello.post_greeting',
},
app_security=[],
components=COMPONENTS,
resolver=RestyResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.hello.post_greeting'
def test_resty_resolve_x_router_controller_with_operation_id():
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=RestyResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.hello.post_greeting'
def test_resty_resolve_x_router_controller_without_operation_id():
operation = OpenAPIOperation(
api=None,
method='GET',
path='/hello/{id}',
path_parameters=[],
operation={'x-openapi-router-controller': 'fakeapi.hello'},
app_security=[],
components=COMPONENTS,
resolver=RestyResolver('fakeapi'))
assert operation.operation_id == 'fakeapi.hello.get'
def test_resty_resolve_with_default_module_name():
operation = OpenAPIOperation(
api=None,
method='GET',
path='/hello/{id}',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
resolver=RestyResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.hello.get'
def test_resty_resolve_with_default_module_name():
operation = OpenAPIOperation(
api=None,
method='GET',
path='/hello/{id}/world',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
resolver=RestyResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.hello.world.search'
def test_resty_resolve_with_default_module_name_lowercase_verb():
operation = OpenAPIOperation(
api=None,
method='get',
path='/hello/{id}',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
resolver=RestyResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.hello.get'
def test_resty_resolve_with_default_module_name_lowercase_verb_nested():
operation = OpenAPIOperation(
api=None,
method='get',
path='/hello/world/{id}',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
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 = OpenAPIOperation(
api=None,
method='GET',
path='/foo-bar',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
resolver=RestyResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.foo_bar.search'
def test_resty_resolve_with_default_module_name_can_resolve_api_root():
operation = OpenAPIOperation(
api=None,
method='GET',
path='/',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
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 = OpenAPIOperation(
api=None,
method='GET',
path='/hello',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
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 = OpenAPIOperation(
api=None,
method='GET',
path='/hello',
path_parameters=[],
operation={
'x-openapi-router-controller': 'fakeapi.hello',
},
app_security=[],
components=COMPONENTS,
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 = OpenAPIOperation(
api=None,
method='GET',
path='/hello',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
resolver=RestyResolver('fakeapi', '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 = OpenAPIOperation(
api=None,
method='POST',
path='/hello',
path_parameters=[],
operation={},
app_security=[],
components=COMPONENTS,
resolver=RestyResolver('fakeapi')
)
assert operation.operation_id == 'fakeapi.hello.post'