Why Gemfury? Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Debian packages RPM packages NuGet packages

Repository URL to install this package:

Details    
doctor / test / test_routing.py
Size: Mime:
import inspect

from flask_restful import Resource

from doctor.flask import handle_http
from doctor.routing import (
    create_routes, delete, get, get_handler_name, post, put, HTTPMethod, Route)
from doctor.utils import Params

from .types import Age, Foo, FooId, FooInstance, Foos, IsAlive, Name


def delete_foo(foo_id: FooId):
    pass


def get_foo(name: Name, age: Age, is_alive: IsAlive=True) -> Foo:
    return ''


def get_foos(is_alive: IsAlive=True) -> Foos:
    return ''


def create_foo(name: Name) -> Foo:
    return ''


def update_foo(foo_id: FooId, name: Name, is_alive: IsAlive=True) -> Foo:
    return ''


class TestRouting(object):

    def test_httpmethod(self):
        m = HTTPMethod('get', get_foo, allowed_exceptions=[ValueError],
                       title='Retrieve')
        assert 'get' == m.method
        assert inspect.signature(get_foo) == m.logic._doctor_signature
        expected = Params(
            all=['name', 'age', 'is_alive'],
            optional=['is_alive'],
            required=['name', 'age'],
            logic=['name', 'age', 'is_alive'])
        assert expected == m.logic._doctor_params
        assert [ValueError] == m.logic._doctor_allowed_exceptions
        assert 'Retrieve' == m.logic._doctor_title
        assert m.logic._doctor_req_obj_type is None

    def test_httpmethod_with_req_obj_type(self):
        m = HTTPMethod('get', get_foo, allowed_exceptions=[ValueError],
                       title='Retrieve', req_obj_type=FooInstance)
        assert 'get' == m.method
        assert inspect.signature(get_foo) == m.logic._doctor_signature
        expected = Params(
            all=['foo', 'foo_id'],
            optional=['foo'],
            required=['foo_id'],
            logic=['foo', 'foo_id'])
        assert expected == m.logic._doctor_params
        assert [ValueError] == m.logic._doctor_allowed_exceptions
        assert 'Retrieve' == m.logic._doctor_title
        assert FooInstance == m.logic._doctor_req_obj_type

    def test_delete(self):
        expected = HTTPMethod('delete', get_foo,
                              allowed_exceptions=[ValueError], title='Title')
        a = delete(get_foo, allowed_exceptions=[ValueError], title='Title')
        assert a.method == expected.method
        assert a.logic._doctor_title == 'Title'
        assert a.logic._doctor_allowed_exceptions == [ValueError]

    def test_get(self):
        expected = HTTPMethod('get', get_foo, allowed_exceptions=[ValueError],
                              title='Title')
        actual = get(get_foo, allowed_exceptions=[ValueError], title='Title')
        assert actual.method == expected.method
        assert actual.logic._doctor_title == 'Title'
        assert actual.logic._doctor_allowed_exceptions == [ValueError]

    def test_post(self):
        expected = HTTPMethod('post', get_foo, allowed_exceptions=[ValueError],
                              title='Title')
        actual = post(get_foo, allowed_exceptions=[ValueError], title='Title')
        assert actual.method == expected.method
        assert actual.logic._doctor_title == 'Title'
        assert actual.logic._doctor_allowed_exceptions == [ValueError]

    def test_put(self):
        expected = HTTPMethod('put', get_foo, allowed_exceptions=[ValueError],
                              title='Title')
        actual = put(get_foo, allowed_exceptions=[ValueError], title='Title')
        assert actual.method == expected.method
        assert actual.logic._doctor_title == 'Title'
        assert actual.logic._doctor_allowed_exceptions == [ValueError]

    def test_create_routes(self):
        class MyHandler(Resource):
            pass

        routes = (
            Route('^/foo/?$', (
                get(get_foos, title='Retrieve List'),
                post(create_foo)), base_handler_class=MyHandler,
                handler_name='MyHandler', heading='Foo'),
            Route('^/foo/<int:foo_id>/?$', (
                delete(delete_foo),
                get(get_foo),
                put(update_foo)), heading='Foo'),
            Route('^/foos/?$', (
                put(lambda: 'put'),), heading='Foo'),
        )
        actual = create_routes(routes, handle_http, Resource)

        # 2 routes created
        assert 3 == len(actual)

        # verify the first route
        route, handler = actual[0]
        assert r'^/foo/?$' == route

        # verify it's an instance of our base handler class.
        assert issubclass(handler, MyHandler)
        # verify it used our custom handler name
        assert 'MyHandler' == handler.__name__

        # verify each http method was added
        assert hasattr(handler, 'get')
        assert hasattr(handler, 'post')

        # verify heading attr was added to handler
        assert handler._doctor_heading == 'Foo'

        # verify params for get
        params = handler.get._doctor_params
        expected = Params(
            all=['is_alive'], required=[], optional=['is_alive'],
            logic=['is_alive'])
        assert expected == params

        # verify signature
        sig = handler.get._doctor_signature
        expected = inspect.signature(get_foos)
        assert expected == sig

        # verify custom title
        assert 'Retrieve List' == handler.get._doctor_title

        # verify params for post
        params = handler.post._doctor_params
        expected = Params(
            all=['name'], required=['name'], optional=[], logic=['name'])
        assert expected == params

        # verify signature
        sig = handler.post._doctor_signature
        expected = inspect.signature(create_foo)
        assert expected == sig

        # verify the second route
        route, handler = actual[1]
        assert '^/foo/<int:foo_id>/?$' == route
        # verify each http method was added
        assert hasattr(handler, 'get')
        assert hasattr(handler, 'delete')
        assert hasattr(handler, 'put')
        # verify it generated an appropriate class handler name
        assert 'FooHandler' == handler.__name__

        # Verify the 3rd handler which would have had a conflicting handler
        # name has a number appended to the end of it.
        route, handler = actual[2]
        assert 'FooHandler2' == handler.__name__

    def test_create_routes_reuse_logic_different_title(self):
        """
        This tests that if we want to reuse a logic function with a different
        route, and give it a unique title that it persists.  Previously if you
        defined a title for 2 different routes using the same logic function,
        it would use the last defined title on both routes.
        """
        routes = (
            Route('^/foo/?$', methods=[
                get(get_foos, title='Retrieve List')],
                heading='Foo'
            ),
            Route('^/bar/?$', methods=[
                get(get_foos, title='Retrieve Other List')],
                heading='Foo'
            ),
        )
        actual = create_routes(routes, handle_http, Resource)

        # verify the first route
        route, handler = actual[0]
        assert r'^/foo/?$' == route
        assert 'Retrieve List' == handler.get._doctor_title

        # verify the second route
        route, handler = actual[1]
        assert r'^/bar/?$' == route
        assert 'Retrieve Other List' == handler.get._doctor_title

    def test_get_handler_name_route_has_handler_name(self):
        """Tests handler name comes from one defined on Route"""
        route = Route('/', (get(get_foos),), handler_name='FooFooHandler')
        assert 'FooFooHandler' == get_handler_name(route, get_foos)

    def test_get_handler_name_from_logic_function_name(self):
        """Tests handler names is generated from logic func name."""
        route = Route('/', (get(get_foos),))
        assert 'GetFoosHandler' == get_handler_name(route, get_foos)

    def test_get_handler_name_heading_list_handler(self):
        """
        Tests that we get the handler name from the defined heading and
        http methods.  Since post is included it infers it's a list endpoint.
        """
        route = Route('/', (post(create_foo),), heading='Dinosaur (v1)')
        assert 'DinosaurV1ListHandler' == get_handler_name(route, create_foo)

    def test_get_handler_name_list_handler(self):
        """
        Tests that we get the handler name using the logic function and also
        including List in the name since it contains a post method.
        """
        route = Route('/', (post(create_foo),))
        assert 'CreateFooListHandler' == get_handler_name(route, create_foo)

    def test_get_handler_name_route_heading(self):
        """
        Tests that we get the handler name using the route heading for a non
        list endpoint.
        """
        route = Route('/', (put(update_foo),), heading='Dinosaur (v1)')
        assert 'DinosaurV1Handler' == get_handler_name(route, update_foo)