openlp/tests/functional/openlp_core/api/http/test_wsgiapp.py

# -*- coding: utf-8 -*-

##########################################################################
# OpenLP - Open Source Lyrics Projection                                 #
# ---------------------------------------------------------------------- #
# Copyright (c) 2008-2019 OpenLP Developers                              #
# ---------------------------------------------------------------------- #
# This program is free software: you can redistribute it and/or modify   #
# it under the terms of the GNU General Public License as published by   #
# the Free Software Foundation, either version 3 of the License, or      #
# (at your option) any later version.                                    #
#                                                                        #
# This program is distributed in the hope that it will be useful,        #
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
# GNU General Public License for more details.                           #
#                                                                        #
# You should have received a copy of the GNU General Public License      #
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
##########################################################################
"""
Functional test the routing code.
"""
import os
from unittest import TestCase
from unittest.mock import MagicMock

from openlp.core.api.http import register_endpoint, application
from openlp.core.api.http.endpoint import Endpoint
from openlp.core.api.http.errors import NotFound


ROOT_DIR = os.path.dirname(os.path.realpath(__file__))

test_endpoint = Endpoint('test', template_dir=ROOT_DIR, static_dir=ROOT_DIR)


class TestRouting(TestCase):
    """
    Test the HTTP routing
    """
    def setUp(self):
        """
        Convert the application to a test application
        :return:
        """
        for route, views in application.route_map.items():
            application.route_map[route]['GET'] = MagicMock()

    def test_routing(self):
        """
        Test the Routing in the new application via dispatch
        :return:
        """
        # GIVE: I try to request and
        # WHEN: when the URL is not correct and dispatch called
        rqst = MagicMock()
        rqst.path = '/test/api'
        rqst.method = 'GET'
        with self.assertRaises(NotFound) as context:
            application.dispatch(rqst)

        # THEN: the not found returned
        assert context.exception.args[0] == 'Not Found', 'URL not found in dispatcher'

        # WHEN: when the URL is correct and dispatch called
        rqst = MagicMock()
        rqst.path = '/test/image'
        rqst.method = 'GET'
        application.dispatch(rqst)
        # THEN: the not found id called
        route_key = next(iter(application.route_map))
        assert '/image' in route_key
        assert 1 == application.route_map[route_key]['GET'].call_count, \
            'main_index function should have been called'


@test_endpoint.route('image')
def image(request):
    pass


@test_endpoint.route('')
def index(request):
    pass


register_endpoint(test_endpoint)