openlp
/
openlp
mirror of https://gitlab.com/openlp/openlp.git
1
0
Fork 1
Code Issues Projects Releases Wiki Activity
openlp/tests/openlp_core/test_app.py

362 lines
14 KiB
Python
Raw Blame History

# -*- coding: utf-8 -*-
##########################################################################
# OpenLP - Open Source Lyrics Projection #
# ---------------------------------------------------------------------- #
# Copyright (c) 2008-2023 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/>. #
##########################################################################
import sys
import pytest
from pathlib import Path
from tempfile import mkdtemp
from unittest.mock import MagicMock, patch
from PyQt5 import QtCore, QtWidgets
# Mock QtWebEngineWidgets
sys.modules['PyQt5.QtWebEngineWidgets'] = MagicMock()
from openlp.core.app import parse_options, backup_if_version_changed, main as app_main
from openlp.core.common.platform import is_win
@pytest.fixture
def app_main_env():
with patch('openlp.core.app.Settings') as mock_settings, \
patch('openlp.core.app.Registry') as mock_registry, \
patch('openlp.core.app.AppLocation') as mock_apploc, \
patch('openlp.core.app.LanguageManager'), \
patch('openlp.core.app.qInitResources'), \
patch('openlp.core.app.parse_options'), \
patch('openlp.core.app.QtWidgets.QApplication'), \
patch('openlp.core.app.QtWidgets.QMessageBox.warning') as mock_warn, \
patch('openlp.core.app.QtWidgets.QMessageBox.information'), \
patch('openlp.core.app.OpenLP') as mock_openlp, \
patch('openlp.core.app.Server') as mock_server, \
patch('openlp.core.app.sys'):
mock_registry.return_value = MagicMock()
mock_settings.return_value = MagicMock()
openlp_server = MagicMock()
mock_server.return_value = openlp_server
openlp_server.is_another_instance_running.return_value = False
mock_apploc.get_data_path.return_value = Path()
mock_apploc.get_directory.return_value = Path()
mock_warn.return_value = True
openlp_instance = MagicMock()
mock_openlp.return_value = openlp_instance
openlp_instance.is_data_path_missing.return_value = False
yield
def test_parse_options_basic():
"""
Test the parse options process works
"""
# GIVEN: a a set of system arguments.
sys.argv[1:] = []
# 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 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']
# WHEN: We we parse them to expand to options
args = parse_options()
# 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']
# 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'
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.
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'
assert args.portablepath == data_path, 'The portable path should be set as expected'
assert args.rargs == [], 'The service file should be blank'
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']
# WHEN: We we parse them to expand to options
args = parse_options()
# 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 True, 'The portable flag should be set to false'
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']
# 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 False, 'The portable flag should be set to false'
assert args.rargs == ['dummy_temp'], 'The service file should not be blank'
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']
# WHEN: We we parse them to expand to options
args = parse_options()
# 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 == ['dummy_temp'], 'The service file should not be blank'
@patch('openlp.core.app.QtWidgets.QMessageBox.critical')
@patch('openlp.core.app.QtWidgets.QMessageBox.StandardButtons')
def test_is_already_running_is_running_continue(MockedStandardButtons, mocked_critical, qapp):
"""
Test the is_already_running() method when OpenLP IS running and the user chooses to continue
"""
# GIVEN: An OpenLP app and some mocks
MockedStandardButtons.return_value = 0
mocked_critical.return_value = QtWidgets.QMessageBox.Yes
# WHEN: is_already_running() is called
qapp.is_already_running()
# THEN: The result should be false
MockedStandardButtons.assert_called_once_with(QtWidgets.QMessageBox.Ok)
mocked_critical.assert_called_once_with(None, 'Error',
'OpenLP is already running on this machine. \nClosing this instance', 0)
@patch('openlp.core.app.QtWidgets.QApplication.processEvents')
def test_process_events(mocked_processEvents, qapp):
"""
Test that the app.process_events() method simply calls the Qt method
"""
# GIVEN: An app
# WHEN: process_events() is called
qapp.process_events()
# THEN: processEvents was called
mocked_processEvents.assert_called_once_with()
@patch('openlp.core.app.QtWidgets.QApplication.setOverrideCursor')
@patch('openlp.core.app.QtWidgets.QApplication.processEvents')
def test_set_busy_cursor(mocked_processEvents, mocked_setOverrideCursor, qapp):
"""
Test that the set_busy_cursor() method sets the cursor
"""
# GIVEN: An app
# WHEN: set_busy_cursor() is called
qapp.set_busy_cursor()
# THEN: The cursor should have been set
mocked_setOverrideCursor.assert_called_once_with(QtCore.Qt.BusyCursor)
mocked_processEvents.assert_called_once_with()
@patch('openlp.core.app.QtWidgets.QApplication.restoreOverrideCursor')
@patch('openlp.core.app.QtWidgets.QApplication.processEvents')
def test_set_normal_cursor(mocked_restoreOverrideCursor, mocked_processEvents, qapp):
"""
Test that the set_normal_cursor() method resets the cursor
"""
# GIVEN: An app
# WHEN: set_normal_cursor() is called
qapp.set_normal_cursor()
# THEN: The cursor should have been set
mocked_restoreOverrideCursor.assert_called_once_with()
mocked_processEvents.assert_called_once_with()
@patch('openlp.core.app.get_version')
@patch('openlp.core.app.QtWidgets.QMessageBox.question')
def test_backup_on_upgrade_first_install(mocked_question, mocked_get_version, qapp, settings):
"""
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 = {
'full': '2.4.0',
'version': '2.4.0',
'build': None
}
settings.setValue('core/application version', '2.4.0')
mocked_get_version.return_value = MOCKED_VERSION
mocked_question.return_value = QtWidgets.QMessageBox.No
# WHEN: We check if a backup should be created
qapp.backup_on_upgrade(old_install, False)
# THEN: It should not ask if we want to create a backup
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!'
@patch('openlp.core.app.get_version')
@patch('openlp.core.app.QtWidgets.QMessageBox.question')
def test_backup_on_upgrade(mocked_question, mocked_get_version, qapp, settings):
"""
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 = {
'full': '2.9.0.dev2963+97ba02d1f',
'version': '2.9.0',
'build': '97ba02d1f'
}
settings.setValue('core/application version', '2.4.6')
qapp.splash = MagicMock()
qapp.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
qapp.backup_on_upgrade(old_install, True)
# THEN: It should ask if we want to create a backup
assert settings.value('core/application version') == '2.9.0', 'Version should be upgraded!'
assert mocked_question.call_count == 1, 'A question should have been asked!'
qapp.splash.hide.assert_called_once_with()
qapp.splash.show.assert_called_once_with()
@patch('openlp.core.app.OpenLP')
@patch('openlp.core.app.sys')
@patch('openlp.core.app.backup_if_version_changed')
@patch('openlp.core.app.set_up_web_engine_cache')
@patch('openlp.core.app.set_up_logging')
def test_main(mock_logging, mock_web_cache, mock_backup, mock_sys, mock_openlp, app_main_env):
"""
Test the main method performs primary actions
"""
# GIVEN: A mocked openlp instance
openlp_instance = MagicMock()
mock_openlp.return_value = openlp_instance
openlp_instance.is_data_path_missing.return_value = False
mock_backup.return_value = True
# WHEN: the main method is run
app_main()
# THEN: Check the application is run and exited with logging and web cache path set
openlp_instance.run.assert_called_once()
mock_logging.assert_called_once()
mock_web_cache.assert_called_once()
mock_sys.exit.assert_called_once()
@patch('openlp.core.app.QtWidgets.QMessageBox.warning')
@patch('openlp.core.app.get_version')
@patch('openlp.core.app.AppLocation.get_data_path')
@patch('openlp.core.app.move')
def test_main_future_settings(mock_move, mock_get_path, mock_version, mock_warn, app_main_env, settings):
"""
Test the backup_if_version_changed method backs up data if version from the future and user consents
"""
# GIVEN: A mocked openlp instance with mocked future settings
settings.from_future = MagicMock(return_value=True)
settings.version_mismatched = MagicMock(return_value=True)
settings.clear = MagicMock()
settings.setValue('core/application version', '3.0.1')
mock_warn.return_value = QtWidgets.QMessageBox.Yes
MOCKED_VERSION = {
'full': '2.9.3',
'version': '2.9.3',
'build': 'None'
}
mock_version.return_value = MOCKED_VERSION
temp_folder = Path(mkdtemp())
mock_get_path.return_value = temp_folder
# WHEN: the main method is run
result = backup_if_version_changed(settings)
# THEN: Check everything was backed up, the settings were cleared and the warn prompt was shown
assert result is True
mock_move.assert_called_once()
settings.clear.assert_called_once_with()
mock_warn.assert_called_once()
Reference in New Issue View Git Blame Copy Permalink