2013-09-19 21:02:28 +00:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
|
|
|
|
|
|
|
|
###############################################################################
|
|
|
|
# OpenLP - Open Source Lyrics Projection #
|
|
|
|
# --------------------------------------------------------------------------- #
|
2015-12-31 22:46:06 +00:00
|
|
|
# Copyright (c) 2008-2016 OpenLP Developers #
|
2013-09-19 21:02:28 +00:00
|
|
|
# --------------------------------------------------------------------------- #
|
|
|
|
# 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-02-11 18:08:32 +00:00
|
|
|
"""
|
2013-09-19 21:02:28 +00:00
|
|
|
Package to test the openlp.core.lib.settings package.
|
2013-02-11 18:08:32 +00:00
|
|
|
"""
|
2013-09-08 10:30:14 +00:00
|
|
|
from unittest import TestCase
|
2013-02-11 18:08:32 +00:00
|
|
|
|
2013-10-13 20:36:42 +00:00
|
|
|
from openlp.core.common import Settings
|
2015-02-21 13:08:56 +00:00
|
|
|
from openlp.core.common.settings import recent_files_conv
|
2015-02-12 20:44:34 +00:00
|
|
|
from tests.functional import patch
|
2014-03-14 22:08:44 +00:00
|
|
|
from tests.helpers.testmixin import TestMixin
|
2013-09-08 10:30:14 +00:00
|
|
|
|
2013-02-12 16:42:09 +00:00
|
|
|
|
2014-03-14 22:08:44 +00:00
|
|
|
class TestSettings(TestCase, TestMixin):
|
2013-03-13 19:51:56 +00:00
|
|
|
"""
|
|
|
|
Test the functions in the Settings module
|
|
|
|
"""
|
2013-02-11 19:20:08 +00:00
|
|
|
def setUp(self):
|
|
|
|
"""
|
|
|
|
Create the UI
|
|
|
|
"""
|
2014-10-22 20:43:05 +00:00
|
|
|
self.setup_application()
|
2014-03-14 22:08:44 +00:00
|
|
|
self.build_settings()
|
2013-02-11 19:20:08 +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-02-11 19:20:08 +00:00
|
|
|
|
2016-05-31 21:40:13 +00:00
|
|
|
def test_recent_files_conv(self):
|
2015-02-21 13:08:56 +00:00
|
|
|
"""
|
|
|
|
Test that recent_files_conv, converts various possible types of values correctly.
|
|
|
|
"""
|
|
|
|
# GIVEN: A list of possible value types and the expected results
|
|
|
|
possible_values = [(['multiple', 'values'], ['multiple', 'values']),
|
|
|
|
(['single value'], ['single value']),
|
|
|
|
('string value', ['string value']),
|
|
|
|
(b'bytes value', ['bytes value']),
|
|
|
|
([], []),
|
|
|
|
(None, [])]
|
|
|
|
|
|
|
|
# WHEN: Calling recent_files_conv with the possible values
|
|
|
|
for value, expected_result in possible_values:
|
|
|
|
actual_result = recent_files_conv(value)
|
|
|
|
|
|
|
|
# THEN: The actual result should be the same as the expected result
|
|
|
|
self.assertEqual(actual_result, expected_result)
|
|
|
|
|
2016-05-31 21:40:13 +00:00
|
|
|
def test_settings_basic(self):
|
2013-02-11 18:08:32 +00:00
|
|
|
"""
|
2013-02-11 19:20:08 +00:00
|
|
|
Test the Settings creation and its default usage
|
2013-02-11 18:08:32 +00:00
|
|
|
"""
|
2013-02-11 19:20:08 +00:00
|
|
|
# GIVEN: A new Settings setup
|
|
|
|
|
|
|
|
# WHEN reading a setting for the first time
|
2013-08-31 18:17:38 +00:00
|
|
|
default_value = Settings().value('core/has run wizard')
|
2013-02-11 19:20:08 +00:00
|
|
|
|
|
|
|
# THEN the default value is returned
|
2013-09-22 21:11:03 +00:00
|
|
|
self.assertFalse(default_value, 'The default value should be False')
|
2013-02-11 19:20:08 +00:00
|
|
|
|
|
|
|
# WHEN a new value is saved into config
|
2013-08-31 18:17:38 +00:00
|
|
|
Settings().setValue('core/has run wizard', True)
|
2013-02-11 19:20:08 +00:00
|
|
|
|
|
|
|
# THEN the new value is returned when re-read
|
2013-09-22 21:11:03 +00:00
|
|
|
self.assertTrue(Settings().value('core/has run wizard'), 'The saved value should have been returned')
|
2013-02-11 19:20:08 +00:00
|
|
|
|
2016-05-31 21:40:13 +00:00
|
|
|
def test_settings_override(self):
|
2013-02-11 19:48:38 +00:00
|
|
|
"""
|
|
|
|
Test the Settings creation and its override usage
|
|
|
|
"""
|
|
|
|
# GIVEN: an override for the settings
|
|
|
|
screen_settings = {
|
2013-08-31 18:17:38 +00:00
|
|
|
'test/extend': 'very wide',
|
2013-02-11 19:48:38 +00:00
|
|
|
}
|
|
|
|
Settings().extend_default_settings(screen_settings)
|
|
|
|
|
|
|
|
# WHEN reading a setting for the first time
|
2013-08-31 18:17:38 +00:00
|
|
|
extend = Settings().value('test/extend')
|
2013-02-11 19:48:38 +00:00
|
|
|
|
|
|
|
# THEN the default value is returned
|
2013-09-22 21:11:03 +00:00
|
|
|
self.assertEqual('very wide', extend, 'The default value of "very wide" should be returned')
|
2013-02-11 19:48:38 +00:00
|
|
|
|
|
|
|
# WHEN a new value is saved into config
|
2013-08-31 18:17:38 +00:00
|
|
|
Settings().setValue('test/extend', 'very short')
|
2013-02-11 19:48:38 +00:00
|
|
|
|
|
|
|
# THEN the new value is returned when re-read
|
2013-09-22 21:11:03 +00:00
|
|
|
self.assertEqual('very short', Settings().value('test/extend'), 'The saved value should be returned')
|
2013-02-11 19:48:38 +00:00
|
|
|
|
2016-05-31 21:40:13 +00:00
|
|
|
def test_settings_override_with_group(self):
|
2013-02-11 19:48:38 +00:00
|
|
|
"""
|
|
|
|
Test the Settings creation and its override usage - with groups
|
|
|
|
"""
|
|
|
|
# GIVEN: an override for the settings
|
|
|
|
screen_settings = {
|
2013-08-31 18:17:38 +00:00
|
|
|
'test/extend': 'very wide',
|
2013-02-12 16:42:09 +00:00
|
|
|
}
|
2013-02-11 19:48:38 +00:00
|
|
|
Settings.extend_default_settings(screen_settings)
|
|
|
|
|
|
|
|
# WHEN reading a setting for the first time
|
|
|
|
settings = Settings()
|
2013-08-31 18:17:38 +00:00
|
|
|
settings.beginGroup('test')
|
|
|
|
extend = settings.value('extend')
|
2013-02-11 19:48:38 +00:00
|
|
|
|
|
|
|
# THEN the default value is returned
|
2013-09-22 21:11:03 +00:00
|
|
|
self.assertEqual('very wide', extend, 'The default value defined should be returned')
|
2013-02-11 19:48:38 +00:00
|
|
|
|
|
|
|
# WHEN a new value is saved into config
|
2013-08-31 18:17:38 +00:00
|
|
|
Settings().setValue('test/extend', 'very short')
|
2013-02-11 19:48:38 +00:00
|
|
|
|
|
|
|
# THEN the new value is returned when re-read
|
2013-09-22 21:11:03 +00:00
|
|
|
self.assertEqual('very short', Settings().value('test/extend'), 'The saved value should be returned')
|
2014-11-10 10:51:03 +00:00
|
|
|
|
2016-05-31 21:40:13 +00:00
|
|
|
def test_settings_nonexisting(self):
|
2014-11-10 10:51:03 +00:00
|
|
|
"""
|
|
|
|
Test the Settings on query for non-existing value
|
|
|
|
"""
|
|
|
|
# GIVEN: A new Settings setup
|
2014-11-13 20:15:43 +00:00
|
|
|
with self.assertRaises(KeyError) as cm:
|
|
|
|
# WHEN reading a setting that doesn't exists
|
|
|
|
does_not_exist_value = Settings().value('core/does not exists')
|
2014-11-10 10:51:03 +00:00
|
|
|
|
2014-11-13 20:15:43 +00:00
|
|
|
# THEN: An exception with the non-existing key should be thrown
|
|
|
|
self.assertEqual(str(cm.exception), "'core/does not exists'", 'We should get an exception')
|
2015-02-12 20:44:34 +00:00
|
|
|
|
2016-05-31 21:40:13 +00:00
|
|
|
def test_extend_default_settings(self):
|
2015-02-13 20:41:34 +00:00
|
|
|
"""
|
|
|
|
Test that the extend_default_settings method extends the default settings
|
|
|
|
"""
|
|
|
|
# GIVEN: A patched __default_settings__ dictionary
|
|
|
|
with patch.dict(Settings.__default_settings__,
|
2015-02-19 22:04:54 +00:00
|
|
|
{'test/setting 1': 1, 'test/setting 2': 2, 'test/setting 3': 3}, True):
|
2015-02-12 20:44:34 +00:00
|
|
|
|
2015-02-13 20:41:34 +00:00
|
|
|
# WHEN: Calling extend_default_settings
|
|
|
|
Settings.extend_default_settings({'test/setting 3': 4, 'test/extended 1': 1, 'test/extended 2': 2})
|
2015-02-12 20:44:34 +00:00
|
|
|
|
2015-02-13 20:41:34 +00:00
|
|
|
# THEN: The _default_settings__ dictionary_ should have the new keys
|
|
|
|
self.assertEqual(
|
|
|
|
Settings.__default_settings__, {'test/setting 1': 1, 'test/setting 2': 2, 'test/setting 3': 4,
|
|
|
|
'test/extended 1': 1, 'test/extended 2': 2})
|