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

# -*- coding: utf-8 -*-
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4

###############################################################################
# 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; version 2 of the License.                              #
#                                                                             #
# 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, write to the Free Software Foundation, Inc., 59  #
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
###############################################################################
"""
Functional tests to test the Http Server Class.
"""
from unittest import TestCase
from unittest.mock import MagicMock, patch

from openlp.core.api.http.server import HttpServer
from openlp.core.common.registry import Registry


class TestHttpServer(TestCase):
    """
    A test suite to test starting the http server
    """

    def setUp(self):
        """
        Create the UI
        """
        Registry().create()
        Registry().register('service_list', MagicMock())

    @patch('openlp.core.api.http.server.HttpWorker')
    @patch('openlp.core.api.http.server.run_thread')
    def test_server_start(self, mocked_run_thread, MockHttpWorker):
        """
        Test the starting of the Waitress Server with the disable flag set off
        """
        # GIVEN: A new httpserver
        # WHEN: I start the server
        Registry().set_flag('no_web_server', False)
        HttpServer()

        # THEN: the api environment should have been created
        assert mocked_run_thread.call_count == 1, 'The qthread should have been called once'
        assert MockHttpWorker.call_count == 1, 'The http thread should have been called once'

    @patch('openlp.core.api.http.server.HttpWorker')
    @patch('openlp.core.api.http.server.run_thread')
    def test_server_start_not_required(self, mocked_run_thread, MockHttpWorker):
        """
        Test the starting of the Waitress Server with the disable flag set off
        """
        # GIVEN: A new httpserver
        # WHEN: I start the server
        Registry().set_flag('no_web_server', True)
        HttpServer()

        # THEN: the api environment should have been created
        assert mocked_run_thread.call_count == 0, 'The qthread should not have have been called'
        assert MockHttpWorker.call_count == 0, 'The http thread should not have been called'