openlp/tests/functional/openlp_plugins/remotes/test_router.py

171 lines
7.3 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
###############################################################################
# OpenLP - Open Source Lyrics Projection #
# --------------------------------------------------------------------------- #
2013-12-24 08:56:50 +00:00
# Copyright (c) 2008-2014 Raoul Snyman #
# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
# --------------------------------------------------------------------------- #
# 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 #
###############################################################################
2013-03-29 08:25:33 +00:00
"""
This module contains tests for the lib submodule of the Remotes plugin.
"""
import os
from unittest import TestCase
2013-10-13 20:36:42 +00:00
from openlp.core.common import Settings
2013-09-14 21:00:58 +00:00
from openlp.plugins.remotes.lib.httpserver import HttpRouter
2013-12-18 21:54:56 +00:00
from tests.functional import MagicMock, patch, mock_open
2014-03-14 22:08:44 +00:00
from tests.helpers.testmixin import TestMixin
2013-03-29 08:25:33 +00:00
__default_settings__ = {
2013-08-31 18:17:38 +00:00
'remotes/twelve hour': True,
'remotes/port': 4316,
'remotes/https port': 4317,
'remotes/https enabled': False,
'remotes/user id': 'openlp',
'remotes/password': 'password',
'remotes/authentication enabled': False,
'remotes/ip address': '0.0.0.0'
2013-03-29 08:25:33 +00:00
}
TEST_PATH = os.path.abspath(os.path.dirname(__file__))
2013-03-29 08:25:33 +00:00
2013-12-18 21:54:56 +00:00
2014-03-14 22:08:44 +00:00
class TestRouter(TestCase, TestMixin):
2013-03-29 08:25:33 +00:00
"""
Test the functions in the :mod:`lib` module.
"""
def setUp(self):
"""
Create the UI
"""
2014-03-14 22:08:44 +00:00
self.get_application()
self.build_settings()
2013-03-29 08:25:33 +00:00
Settings().extend_default_settings(__default_settings__)
2013-03-29 09:06:43 +00:00
self.router = HttpRouter()
2013-03-29 08:25:33 +00:00
def tearDown(self):
"""
Delete all the C++ objects at the end so that we don't have a segfault
"""
2014-03-14 22:08:44 +00:00
self.destroy_settings()
2013-03-29 08:25:33 +00:00
2013-09-14 21:00:58 +00:00
def password_encrypter_test(self):
2013-03-29 09:32:46 +00:00
"""
2013-09-14 21:00:58 +00:00
Test hash userid and password function
2013-03-29 09:32:46 +00:00
"""
# GIVEN: A default configuration
2013-09-14 21:00:58 +00:00
Settings().setValue('remotes/user id', 'openlp')
Settings().setValue('remotes/password', 'password')
2013-03-29 09:32:46 +00:00
# WHEN: called with the defined userid
2013-09-14 21:00:58 +00:00
router = HttpRouter()
router.initialise()
test_value = 'b3BlbmxwOnBhc3N3b3Jk'
2013-03-29 09:32:46 +00:00
# THEN: the function should return the correct password
2013-09-14 21:00:58 +00:00
self.assertEqual(router.auth, test_value,
2013-12-18 21:54:56 +00:00
'The result for make_sha_hash should return the correct encrypted password')
2013-03-29 09:32:46 +00:00
2013-03-29 08:25:33 +00:00
def process_http_request_test(self):
"""
2013-03-29 09:06:43 +00:00
Test the router control functionality
2013-03-29 08:25:33 +00:00
"""
2013-03-29 09:06:43 +00:00
# GIVEN: A testing set of Routes
2013-09-14 21:00:58 +00:00
router = HttpRouter()
2013-03-29 09:06:43 +00:00
mocked_function = MagicMock()
test_route = [
2013-09-14 21:00:58 +00:00
(r'^/stage/api/poll$', {'function': mocked_function, 'secure': False}),
2013-03-29 09:06:43 +00:00
]
2013-09-14 21:00:58 +00:00
router.routes = test_route
2013-03-29 09:06:43 +00:00
# WHEN: called with a poll route
2013-09-14 21:00:58 +00:00
function, args = router.process_http_request('/stage/api/poll', None)
2013-03-29 08:25:33 +00:00
2013-03-29 09:06:43 +00:00
# THEN: the function should have been called only once
2013-12-18 21:54:56 +00:00
self.assertEqual(mocked_function, function['function'], 'The mocked function should match defined value.')
self.assertFalse(function['secure'], 'The mocked function should not require any security.')
def get_content_type_test(self):
"""
Test the get_content_type logic
"""
2013-11-11 00:55:06 +00:00
# GIVEN: a set of files and their corresponding types
2014-04-02 19:35:09 +00:00
headers = [
['test.html', 'text/html'], ['test.css', 'text/css'],
['test.js', 'application/javascript'], ['test.jpg', 'image/jpeg'],
['test.gif', 'image/gif'], ['test.ico', 'image/x-icon'],
['test.png', 'image/png'], ['test.whatever', 'text/plain'],
['test', 'text/plain'], ['', 'text/plain'],
2013-12-18 21:54:56 +00:00
[os.path.join(TEST_PATH, 'test.html'), 'text/html']]
2013-11-11 00:55:06 +00:00
# WHEN: calling each file type
for header in headers:
ext, content_type = self.router.get_content_type(header[0])
2013-12-18 21:54:56 +00:00
2013-11-11 00:55:06 +00:00
# THEN: all types should match
self.assertEqual(content_type, header[1], 'Mismatch of content type')
2013-11-11 00:55:06 +00:00
def serve_file_without_params_test(self):
"""
Test the serve_file method without params
"""
# GIVEN: mocked environment
self.router.send_response = MagicMock()
self.router.send_header = MagicMock()
self.router.end_headers = MagicMock()
self.router.wfile = MagicMock()
self.router.html_dir = os.path.normpath('test/dir')
self.router.template_vars = MagicMock()
2013-12-18 21:54:56 +00:00
2013-11-11 00:55:06 +00:00
# WHEN: call serve_file with no file_name
self.router.serve_file()
2013-12-18 21:54:56 +00:00
2013-11-11 00:55:06 +00:00
# THEN: it should return a 404
self.router.send_response.assert_called_once_with(404)
2014-04-02 19:35:09 +00:00
self.router.send_header.assert_called_once_with('Content-type', 'text/html')
2013-12-18 21:54:56 +00:00
self.assertEqual(self.router.end_headers.call_count, 1, 'end_headers called once')
2013-11-11 00:55:06 +00:00
def serve_file_with_valid_params_test(self):
"""
Test the serve_file method with an existing file
"""
# GIVEN: mocked environment
self.router.send_response = MagicMock()
self.router.send_header = MagicMock()
self.router.end_headers = MagicMock()
self.router.wfile = MagicMock()
self.router.html_dir = os.path.normpath('test/dir')
self.router.template_vars = MagicMock()
with patch('openlp.core.lib.os.path.exists') as mocked_exists, \
2013-12-18 21:54:56 +00:00
patch('builtins.open', mock_open(read_data='123')):
2013-11-11 00:55:06 +00:00
mocked_exists.return_value = True
2013-12-18 21:54:56 +00:00
2013-11-11 00:55:06 +00:00
# WHEN: call serve_file with an existing html file
self.router.serve_file(os.path.normpath('test/dir/test.html'))
2013-11-11 00:55:06 +00:00
# THEN: it should return a 200 and the file
self.router.send_response.assert_called_once_with(200)
2013-12-18 21:54:56 +00:00
self.router.send_header.assert_called_once_with('Content-type', 'text/html')
self.assertEqual(self.router.end_headers.call_count, 1, 'end_headers called once')