forked from openlp/openlp
231 lines
11 KiB
Python
231 lines
11 KiB
Python
# -*- 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 #
|
|
###############################################################################
|
|
"""
|
|
Package to test the openlp.core.ui.thememanager package.
|
|
"""
|
|
import os
|
|
import shutil
|
|
from tempfile import mkdtemp
|
|
from unittest import TestCase
|
|
from unittest.mock import ANY, MagicMock, patch
|
|
|
|
from PyQt5 import QtWidgets
|
|
|
|
from openlp.core.common.path import Path
|
|
from openlp.core.common.registry import Registry
|
|
from openlp.core.ui.thememanager import ThemeManager
|
|
from tests.utils.constants import RESOURCE_PATH
|
|
|
|
|
|
class TestThemeManager(TestCase):
|
|
|
|
def setUp(self):
|
|
"""
|
|
Set up the tests
|
|
"""
|
|
Registry.create()
|
|
self.temp_folder = mkdtemp()
|
|
|
|
def tearDown(self):
|
|
"""
|
|
Clean up
|
|
"""
|
|
shutil.rmtree(self.temp_folder)
|
|
|
|
@patch('openlp.core.ui.thememanager.zipfile.ZipFile.__init__')
|
|
@patch('openlp.core.ui.thememanager.zipfile.ZipFile.write')
|
|
def test_export_theme(self, mocked_zipfile_write, mocked_zipfile_init):
|
|
"""
|
|
Test exporting a theme .
|
|
"""
|
|
# GIVEN: A new ThemeManager instance.
|
|
theme_manager = ThemeManager()
|
|
theme_manager.theme_path = RESOURCE_PATH / 'themes'
|
|
mocked_zipfile_init.return_value = None
|
|
|
|
# WHEN: The theme is exported
|
|
theme_manager._export_theme(Path('some', 'path', 'Default.otz'), 'Default')
|
|
|
|
# THEN: The zipfile should be created at the given path
|
|
mocked_zipfile_init.assert_called_with(Path('some', 'path', 'Default.otz'), 'w')
|
|
mocked_zipfile_write.assert_called_with(RESOURCE_PATH / 'themes' / 'Default' / 'Default.xml',
|
|
Path('Default', 'Default.xml'))
|
|
|
|
def test_initial_theme_manager(self):
|
|
"""
|
|
Test the instantiation of theme manager.
|
|
"""
|
|
# GIVEN: A new service manager instance.
|
|
ThemeManager(None)
|
|
|
|
# WHEN: the default theme manager is built.
|
|
# THEN: The the controller should be registered in the registry.
|
|
assert Registry().get('theme_manager') is not None, 'The base theme manager should be registered'
|
|
|
|
@patch('openlp.core.ui.thememanager.copyfile')
|
|
@patch('openlp.core.ui.thememanager.create_paths')
|
|
def test_write_theme_same_image(self, mocked_create_paths, mocked_copyfile):
|
|
"""
|
|
Test that we don't try to overwrite a theme background image with itself
|
|
"""
|
|
# GIVEN: A new theme manager instance, with mocked builtins.open, copyfile,
|
|
# theme, create_paths and thememanager-attributes.
|
|
theme_manager = ThemeManager(None)
|
|
theme_manager.old_background_image = None
|
|
theme_manager.generate_and_save_image = MagicMock()
|
|
theme_manager.theme_path = MagicMock()
|
|
mocked_theme = MagicMock()
|
|
mocked_theme.theme_name = 'themename'
|
|
mocked_theme.extract_formatted_xml = MagicMock()
|
|
mocked_theme.extract_formatted_xml.return_value = 'fake_theme_xml'.encode()
|
|
|
|
# WHEN: Calling _write_theme with path to the same image, but the path written slightly different
|
|
file_path_1 = RESOURCE_PATH / 'church.jpg'
|
|
theme_manager._write_theme(mocked_theme, file_path_1, file_path_1)
|
|
|
|
# THEN: The mocked_copyfile should not have been called
|
|
assert mocked_copyfile.called is False, 'copyfile should not be called'
|
|
|
|
@patch('openlp.core.ui.thememanager.copyfile')
|
|
@patch('openlp.core.ui.thememanager.create_paths')
|
|
def test_write_theme_diff_images(self, mocked_create_paths, mocked_copyfile):
|
|
"""
|
|
Test that we do overwrite a theme background image when a new is submitted
|
|
"""
|
|
# GIVEN: A new theme manager instance, with mocked builtins.open, copyfile,
|
|
# theme, create_paths and thememanager-attributes.
|
|
theme_manager = ThemeManager(None)
|
|
theme_manager.old_background_image = None
|
|
theme_manager.generate_and_save_image = MagicMock()
|
|
theme_manager.theme_path = MagicMock()
|
|
mocked_theme = MagicMock()
|
|
mocked_theme.theme_name = 'themename'
|
|
mocked_theme.filename = "filename"
|
|
|
|
# WHEN: Calling _write_theme with path to different images
|
|
file_path_1 = RESOURCE_PATH / 'church.jpg'
|
|
file_path_2 = RESOURCE_PATH / 'church2.jpg'
|
|
theme_manager._write_theme(mocked_theme, file_path_1, file_path_2)
|
|
|
|
# THEN: The mocked_copyfile should not have been called
|
|
assert mocked_copyfile.called is True, 'copyfile should be called'
|
|
|
|
def test_write_theme_special_char_name(self):
|
|
"""
|
|
Test that we can save themes with special characters in the name
|
|
"""
|
|
# GIVEN: A new theme manager instance, with mocked theme and thememanager-attributes.
|
|
theme_manager = ThemeManager(None)
|
|
theme_manager.old_background_image = None
|
|
theme_manager.generate_and_save_image = MagicMock()
|
|
theme_manager.theme_path = Path(self.temp_folder)
|
|
mocked_theme = MagicMock()
|
|
mocked_theme.theme_name = 'theme 愛 name'
|
|
mocked_theme.export_theme.return_value = "{}"
|
|
|
|
# WHEN: Calling _write_theme with a theme with a name with special characters in it
|
|
theme_manager._write_theme(mocked_theme, None, None)
|
|
|
|
# THEN: It should have been created
|
|
assert os.path.exists(os.path.join(self.temp_folder, 'theme 愛 name', 'theme 愛 name.json')) is True, \
|
|
'Theme with special characters should have been created!'
|
|
|
|
@patch('openlp.core.ui.thememanager.QtWidgets.QMessageBox.question', return_value=QtWidgets.QMessageBox.Yes)
|
|
@patch('openlp.core.ui.thememanager.translate')
|
|
def test_over_write_message_box_yes(self, mocked_translate, mocked_qmessagebox_question):
|
|
"""
|
|
Test that theme_manager.over_write_message_box returns True when the user clicks yes.
|
|
"""
|
|
# GIVEN: A patched QMessageBox.question and an instance of ThemeManager
|
|
mocked_translate.side_effect = lambda context, text: text
|
|
theme_manager = ThemeManager(None)
|
|
|
|
# WHEN: Calling over_write_message_box with 'Theme Name'
|
|
result = theme_manager.over_write_message_box('Theme Name')
|
|
|
|
# THEN: over_write_message_box should return True and the message box should contain the theme name
|
|
assert result is True
|
|
mocked_qmessagebox_question.assert_called_once_with(
|
|
theme_manager, 'Theme Already Exists', 'Theme Theme Name already exists. Do you want to replace it?',
|
|
defaultButton=ANY)
|
|
|
|
@patch('openlp.core.ui.thememanager.QtWidgets.QMessageBox.question', return_value=QtWidgets.QMessageBox.No)
|
|
@patch('openlp.core.ui.thememanager.translate')
|
|
def test_over_write_message_box_no(self, mocked_translate, mocked_qmessagebox_question):
|
|
"""
|
|
Test that theme_manager.over_write_message_box returns False when the user clicks no.
|
|
"""
|
|
# GIVEN: A patched QMessageBox.question and an instance of ThemeManager
|
|
mocked_translate.side_effect = lambda context, text: text
|
|
theme_manager = ThemeManager(None)
|
|
|
|
# WHEN: Calling over_write_message_box with 'Theme Name'
|
|
result = theme_manager.over_write_message_box('Theme Name')
|
|
|
|
# THEN: over_write_message_box should return False and the message box should contain the theme name
|
|
assert result is False
|
|
mocked_qmessagebox_question.assert_called_once_with(
|
|
theme_manager, 'Theme Already Exists', 'Theme Theme Name already exists. Do you want to replace it?',
|
|
defaultButton=ANY)
|
|
|
|
def test_unzip_theme(self):
|
|
"""
|
|
Test that unzipping of themes works
|
|
"""
|
|
# GIVEN: A theme file, a output folder and some mocked out internal functions
|
|
with patch('openlp.core.ui.thememanager.critical_error_message_box') \
|
|
as mocked_critical_error_message_box:
|
|
theme_manager = ThemeManager(None)
|
|
theme_manager._create_theme_from_xml = MagicMock()
|
|
theme_manager.generate_and_save_image = MagicMock()
|
|
theme_manager.theme_path = None
|
|
folder_path = Path(mkdtemp())
|
|
theme_file_path = RESOURCE_PATH / 'themes' / 'Moss_on_tree.otz'
|
|
|
|
# WHEN: We try to unzip it
|
|
theme_manager.unzip_theme(theme_file_path, folder_path)
|
|
|
|
# THEN: Files should be unpacked
|
|
assert (folder_path / 'Moss on tree' / 'Moss on tree.xml').exists() is True
|
|
assert mocked_critical_error_message_box.call_count == 0, 'No errors should have happened'
|
|
folder_path.rmtree()
|
|
|
|
def test_unzip_theme_invalid_version(self):
|
|
"""
|
|
Test that themes with invalid (< 2.0) or with no version attributes are rejected
|
|
"""
|
|
# GIVEN: An instance of ThemeManager whilst mocking a theme that returns a theme with no version attribute
|
|
with patch('openlp.core.ui.thememanager.zipfile.ZipFile') as mocked_zip_file,\
|
|
patch('openlp.core.ui.thememanager.ElementTree.getroot') as mocked_getroot,\
|
|
patch('openlp.core.ui.thememanager.XML'),\
|
|
patch('openlp.core.ui.thememanager.critical_error_message_box') as mocked_critical_error_message_box:
|
|
|
|
mocked_zip_file.return_value = MagicMock(**{'namelist.return_value': [os.path.join('theme', 'theme.xml')]})
|
|
mocked_getroot.return_value = MagicMock(**{'get.return_value': None})
|
|
theme_manager = ThemeManager(None)
|
|
|
|
# WHEN: unzip_theme is called
|
|
theme_manager.unzip_theme('theme.file', 'folder')
|
|
|
|
# THEN: The critical_error_message_box should have been called
|
|
assert mocked_critical_error_message_box.call_count == 1, 'Should have been called once'
|