openlp/tests/functional/openlp_core/test_app.py

390 lines
16 KiB
Python
Raw Normal View History

2017-10-10 07:08:44 +00:00
# -*- coding: utf-8 -*-
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2019-04-13 13:00:22 +00:00
##########################################################################
# 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/>. #
##########################################################################
2017-10-10 07:08:44 +00:00
import sys
from unittest import TestCase, skip
from unittest.mock import MagicMock, patch
from PyQt5 import QtCore, QtWidgets
2018-10-30 20:12:16 +00:00
# Mock QtWebEngineWidgets
sys.modules['PyQt5.QtWebEngineWidgets'] = MagicMock()
2017-10-10 07:08:44 +00:00
from openlp.core.app import OpenLP, parse_options
2019-05-01 19:19:21 +00:00
from openlp.core.common import is_win
2017-10-10 07:08:44 +00:00
from openlp.core.common.settings import Settings
2017-12-22 22:21:38 +00:00
from tests.utils.constants import RESOURCE_PATH
2017-10-10 07:08:44 +00:00
def test_parse_options_basic():
"""
Test the parse options process works
"""
# GIVEN: a a set of system arguments.
sys.argv[1:] = []
2018-01-07 05:24:55 +00:00
2017-10-10 07:08:44 +00:00
# WHEN: We we parse them to expand to options
2018-01-07 05:24:55 +00:00
args = parse_options()
2017-10-10 07:08:44 +00:00
# THEN: the following fields will have been extracted.
assert args.loglevel == 'warning', 'The log level should be set to warning'
assert args.no_error_form is False, 'The no_error_form should be set to False'
assert args.portable is False, 'The portable flag should be set to false'
assert args.rargs == [], 'The service file should be blank'
def test_parse_options_debug():
"""
Test the parse options process works for debug only
"""
# GIVEN: a a set of system arguments.
sys.argv[1:] = ['-l debug']
2018-01-07 05:24:55 +00:00
2017-10-10 07:08:44 +00:00
# WHEN: We we parse them to expand to options
2018-01-07 05:24:55 +00:00
args = parse_options()
2017-10-10 07:08:44 +00:00
# THEN: the following fields will have been extracted.
assert args.loglevel == ' debug', 'The log level should be set to debug'
assert args.no_error_form is False, 'The no_error_form should be set to False'
assert args.portable is False, 'The portable flag should be set to false'
assert args.rargs == [], 'The service file should be blank'
def test_parse_options_debug_and_portable():
"""
Test the parse options process works for debug and portable
"""
# GIVEN: a a set of system arguments.
sys.argv[1:] = ['--portable']
2018-01-07 05:24:55 +00:00
2017-10-10 07:08:44 +00:00
# WHEN: We we parse them to expand to options
2018-01-07 05:24:55 +00:00
args = parse_options()
2017-10-10 07:08:44 +00:00
# THEN: the following fields will have been extracted.
assert args.loglevel == 'warning', 'The log level should be set to warning'
assert args.no_error_form is False, 'The no_error_form should be set to False'
assert args.portable is True, 'The portable flag should be set to true'
assert args.rargs == [], 'The service file should be blank'
def test_parse_options_portable_and_portable_path():
"""
Test the parse options process works portable and portable-path
"""
# GIVEN: a a set of system arguments.
2019-05-01 19:19:21 +00:00
if is_win():
data_path = 'c:\\temp\\openlp-data'
else:
data_path = '/tmp/openlp-data'
sys.argv[1:] = ['--portable', '--portable-path', '{datapath}'.format(datapath=data_path)]
# WHEN: We we parse them to expand to options
args = parse_options()
# THEN: the following fields will have been extracted.
assert args.loglevel == 'warning', 'The log level should be set to warning'
assert args.no_error_form is False, 'The no_error_form should be set to False'
assert args.portable is True, 'The portable flag should be set to true'
2019-05-01 19:19:21 +00:00
assert args.portablepath == data_path, 'The portable path should be set as expected'
assert args.rargs == [], 'The service file should be blank'
2017-10-10 07:08:44 +00:00
def test_parse_options_all_no_file():
"""
Test the parse options process works with two options
"""
# GIVEN: a a set of system arguments.
sys.argv[1:] = ['-l debug', '-p']
2018-01-07 05:24:55 +00:00
2017-10-10 07:08:44 +00:00
# WHEN: We we parse them to expand to options
2018-01-07 05:24:55 +00:00
args = parse_options()
2017-10-10 07:08:44 +00:00
# THEN: the following fields will have been extracted.
assert args.loglevel == ' debug', 'The log level should be set to debug'
assert args.no_error_form is False, 'The no_error_form should be set to False'
2018-04-05 16:29:34 +00:00
assert args.portable is True, 'The portable flag should be set to false'
2017-10-10 07:08:44 +00:00
assert args.rargs == [], 'The service file should be blank'
def test_parse_options_file():
"""
Test the parse options process works with a file
"""
# GIVEN: a a set of system arguments.
sys.argv[1:] = ['dummy_temp']
2018-01-07 05:24:55 +00:00
2017-10-10 07:08:44 +00:00
# WHEN: We we parse them to expand to options
2018-01-07 05:24:55 +00:00
args = parse_options()
2017-10-10 07:08:44 +00:00
# THEN: the following fields will have been extracted.
assert args.loglevel == 'warning', 'The log level should be set to warning'
assert args.no_error_form is False, 'The no_error_form should be set to False'
assert args.portable is False, 'The portable flag should be set to false'
2019-05-04 12:05:53 +00:00
assert args.rargs == ['dummy_temp'], 'The service file should not be blank'
2017-10-10 07:08:44 +00:00
def test_parse_options_file_and_debug():
"""
Test the parse options process works with a file and the debug log level
"""
# GIVEN: a a set of system arguments.
sys.argv[1:] = ['-l debug', 'dummy_temp']
2018-01-07 05:24:55 +00:00
2017-10-10 07:08:44 +00:00
# WHEN: We we parse them to expand to options
2018-01-07 05:24:55 +00:00
args = parse_options()
2017-10-10 07:08:44 +00:00
# THEN: the following fields will have been extracted.
assert args.loglevel == ' debug', 'The log level should be set to debug'
assert args.no_error_form is False, 'The no_error_form should be set to False'
assert args.portable is False, 'The portable flag should be set to false'
2019-05-04 12:05:53 +00:00
assert args.rargs == ['dummy_temp'], 'The service file should not be blank'
2017-10-10 07:08:44 +00:00
2018-04-05 16:29:34 +00:00
@skip('Figure out why this is causing a segfault')
class TestOpenLP(TestCase):
2017-10-10 07:08:44 +00:00
"""
Test the OpenLP app class
"""
2017-10-23 22:09:57 +00:00
def setUp(self):
self.build_settings()
2018-04-05 16:29:34 +00:00
self.qapplication_patcher = patch('openlp.core.app.QtGui.QApplication')
self.mocked_qapplication = self.qapplication_patcher.start()
2017-10-23 22:09:57 +00:00
self.openlp = OpenLP([])
def tearDown(self):
2018-04-05 16:29:34 +00:00
self.qapplication_patcher.stop()
2017-10-23 22:09:57 +00:00
self.destroy_settings()
del self.openlp
self.openlp = None
def test_exec(self):
2017-10-10 07:08:44 +00:00
"""
Test the exec method
"""
# GIVEN: An app
2018-04-05 16:29:34 +00:00
self.openlp.shared_memory = MagicMock()
2017-10-23 22:09:57 +00:00
self.mocked_qapplication.exec.return_value = False
2017-10-10 07:08:44 +00:00
# WHEN: exec() is called
2017-10-23 22:09:57 +00:00
result = self.openlp.exec()
2017-10-10 07:08:44 +00:00
# THEN: The right things should be called
2017-10-23 22:09:57 +00:00
assert self.openlp.is_event_loop_active is True
self.mocked_qapplication.exec.assert_called_once_with()
2018-04-05 16:29:34 +00:00
self.openlp.shared_memory.detach.assert_called_once_with()
assert result is False
@patch('openlp.core.app.QtCore.QSharedMemory')
def test_is_already_running_not_running(self, MockedSharedMemory):
"""
Test the is_already_running() method when OpenLP is NOT running
"""
# GIVEN: An OpenLP app and some mocks
mocked_shared_memory = MagicMock()
mocked_shared_memory.attach.return_value = False
MockedSharedMemory.return_value = mocked_shared_memory
# WHEN: is_already_running() is called
result = self.openlp.is_already_running()
# THEN: The result should be false
MockedSharedMemory.assert_called_once_with('OpenLP')
mocked_shared_memory.attach.assert_called_once_with()
mocked_shared_memory.create.assert_called_once_with(1)
2017-10-10 07:08:44 +00:00
assert result is False
@patch('openlp.core.app.QtWidgets.QMessageBox.critical')
@patch('openlp.core.app.QtWidgets.QMessageBox.StandardButtons')
2018-04-05 16:29:34 +00:00
@patch('openlp.core.app.QtCore.QSharedMemory')
def test_is_already_running_is_running_continue(self, MockedSharedMemory, MockedStandardButtons, mocked_critical):
2017-10-10 07:08:44 +00:00
"""
Test the is_already_running() method when OpenLP IS running and the user chooses to continue
"""
# GIVEN: An OpenLP app and some mocks
2018-04-05 16:29:34 +00:00
mocked_shared_memory = MagicMock()
mocked_shared_memory.attach.return_value = True
MockedSharedMemory.return_value = mocked_shared_memory
MockedStandardButtons.return_value = 0
mocked_critical.return_value = QtWidgets.QMessageBox.Yes
# WHEN: is_already_running() is called
result = self.openlp.is_already_running()
# THEN: The result should be false
MockedSharedMemory.assert_called_once_with('OpenLP')
mocked_shared_memory.attach.assert_called_once_with()
MockedStandardButtons.assert_called_once_with(QtWidgets.QMessageBox.Yes | QtWidgets.QMessageBox.No)
mocked_critical.assert_called_once_with(None, 'Error', 'OpenLP is already running. Do you wish to continue?', 0)
assert result is False
@patch('openlp.core.app.QtWidgets.QMessageBox.critical')
@patch('openlp.core.app.QtWidgets.QMessageBox.StandardButtons')
@patch('openlp.core.app.QtCore.QSharedMemory')
def test_is_already_running_is_running_stop(self, MockedSharedMemory, MockedStandardButtons, mocked_critical):
"""
Test the is_already_running() method when OpenLP IS running and the user chooses to stop
"""
# GIVEN: An OpenLP app and some mocks
mocked_shared_memory = MagicMock()
mocked_shared_memory.attach.return_value = True
MockedSharedMemory.return_value = mocked_shared_memory
2017-10-10 07:08:44 +00:00
MockedStandardButtons.return_value = 0
2018-04-05 16:29:34 +00:00
mocked_critical.return_value = QtWidgets.QMessageBox.No
2017-10-10 07:08:44 +00:00
# WHEN: is_already_running() is called
2018-04-05 16:29:34 +00:00
result = self.openlp.is_already_running()
2017-10-10 07:08:44 +00:00
# THEN: The result should be false
2018-04-05 16:29:34 +00:00
MockedSharedMemory.assert_called_once_with('OpenLP')
mocked_shared_memory.attach.assert_called_once_with()
MockedStandardButtons.assert_called_once_with(QtWidgets.QMessageBox.Yes | QtWidgets.QMessageBox.No)
mocked_critical.assert_called_once_with(None, 'Error', 'OpenLP is already running. Do you wish to continue?', 0)
assert result is True
2017-10-10 07:08:44 +00:00
def test_process_events(self):
"""
Test that the app.process_events() method simply calls the Qt method
"""
# GIVEN: An app
# WHEN: process_events() is called
2017-10-23 22:09:57 +00:00
with patch.object(self.openlp, 'processEvents') as mocked_processEvents:
self.openlp.process_events()
2017-10-10 07:08:44 +00:00
# THEN: processEvents was called
mocked_processEvents.assert_called_once_with()
def test_set_busy_cursor(self):
"""
Test that the set_busy_cursor() method sets the cursor
"""
# GIVEN: An app
# WHEN: set_busy_cursor() is called
2017-10-23 22:09:57 +00:00
with patch.object(self.openlp, 'setOverrideCursor') as mocked_setOverrideCursor, \
patch.object(self.openlp, 'processEvents') as mocked_processEvents:
self.openlp.set_busy_cursor()
2017-10-10 07:08:44 +00:00
# THEN: The cursor should have been set
mocked_setOverrideCursor.assert_called_once_with(QtCore.Qt.BusyCursor)
mocked_processEvents.assert_called_once_with()
def test_set_normal_cursor(self):
"""
Test that the set_normal_cursor() method resets the cursor
"""
# GIVEN: An app
# WHEN: set_normal_cursor() is called
2017-10-23 22:09:57 +00:00
with patch.object(self.openlp, 'restoreOverrideCursor') as mocked_restoreOverrideCursor, \
patch.object(self.openlp, 'processEvents') as mocked_processEvents:
self.openlp.set_normal_cursor()
2017-10-10 07:08:44 +00:00
# THEN: The cursor should have been set
mocked_restoreOverrideCursor.assert_called_once_with()
mocked_processEvents.assert_called_once_with()
def test_event(self):
"""
Test the reimplemented event method
"""
# GIVEN: A file path and a QEvent.
2017-12-22 22:21:38 +00:00
file_path = str(RESOURCE_PATH / 'church.jpg')
2017-10-10 07:08:44 +00:00
mocked_file_method = MagicMock(return_value=file_path)
event = QtCore.QEvent(QtCore.QEvent.FileOpen)
event.file = mocked_file_method
# WHEN: Call the vent method.
result = self.openlp.event(event)
# THEN: The path should be inserted.
2017-12-19 19:22:47 +00:00
assert result is True, "The method should have returned True."
2017-10-10 07:08:44 +00:00
mocked_file_method.assert_called_once_with()
2017-12-19 19:22:47 +00:00
assert self.openlp.args[0] == file_path, "The path should be in args."
2017-10-10 07:08:44 +00:00
@patch('openlp.core.app.is_macosx')
def test_application_activate_event(self, mocked_is_macosx):
"""
Test that clicking on the dock icon on Mac OS X restores the main window if it is minimized
"""
# GIVEN: Mac OS X and an ApplicationActivate event
mocked_is_macosx.return_value = True
event = MagicMock()
event.type.return_value = QtCore.QEvent.ApplicationActivate
mocked_main_window = MagicMock()
self.openlp.main_window = mocked_main_window
# WHEN: The icon in the dock is clicked
result = self.openlp.event(event)
# THEN:
2017-12-19 19:22:47 +00:00
assert result is True, "The method should have returned True."
2017-12-22 15:50:45 +00:00
# assert self.openlp.main_window.isMinimized() is False
2017-10-10 07:08:44 +00:00
@patch('openlp.core.app.get_version')
@patch('openlp.core.app.QtWidgets.QMessageBox.question')
def test_backup_on_upgrade_first_install(self, mocked_question, mocked_get_version):
"""
Test that we don't try to backup on a new install
"""
# GIVEN: Mocked data version and OpenLP version which are the same
old_install = False
MOCKED_VERSION = {
2017-12-19 19:22:47 +00:00
'full': '2.4.0-bzr000',
'version': '2.4.0',
2017-10-10 07:08:44 +00:00
'build': 'bzr000'
}
2017-12-19 19:22:47 +00:00
Settings().setValue('core/application version', '2.4.0')
2017-10-10 07:08:44 +00:00
mocked_get_version.return_value = MOCKED_VERSION
mocked_question.return_value = QtWidgets.QMessageBox.No
# WHEN: We check if a backup should be created
self.openlp.backup_on_upgrade(old_install, False)
# THEN: It should not ask if we want to create a backup
2017-12-19 19:22:47 +00:00
assert Settings().value('core/application version') == '2.4.0', 'Version should be the same!'
assert mocked_question.call_count == 0, 'No question should have been asked!'
2017-10-10 07:08:44 +00:00
@patch('openlp.core.app.get_version')
@patch('openlp.core.app.QtWidgets.QMessageBox.question')
def test_backup_on_upgrade(self, mocked_question, mocked_get_version):
"""
Test that we try to backup on a new install
"""
# GIVEN: Mocked data version and OpenLP version which are different
old_install = True
MOCKED_VERSION = {
2017-12-19 19:22:47 +00:00
'full': '2.4.0-bzr000',
'version': '2.4.0',
2017-10-10 07:08:44 +00:00
'build': 'bzr000'
}
Settings().setValue('core/application version', '2.0.5')
self.openlp.splash = MagicMock()
self.openlp.splash.isVisible.return_value = True
mocked_get_version.return_value = MOCKED_VERSION
mocked_question.return_value = QtWidgets.QMessageBox.No
# WHEN: We check if a backup should be created
self.openlp.backup_on_upgrade(old_install, True)
# THEN: It should ask if we want to create a backup
2017-12-19 19:22:47 +00:00
assert Settings().value('core/application version') == '2.4.0', 'Version should be upgraded!'
assert mocked_question.call_count == 1, 'A question should have been asked!'
2017-10-10 07:08:44 +00:00
self.openlp.splash.hide.assert_called_once_with()
self.openlp.splash.show.assert_called_once_with()