openlp/tests/interfaces/openlp_plugins/bibles/test_lib_parse_reference.py

196 lines
9.9 KiB
Python
Raw Normal View History

2014-03-11 20:11:04 +00:00
# -*- coding: utf-8 -*-
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/>. #
##########################################################################
2014-03-11 20:11:04 +00:00
"""
This module contains tests for the lib submodule of the Bibles plugin.
"""
from unittest import TestCase
from unittest.mock import MagicMock, patch
2014-03-11 20:11:04 +00:00
from openlp.core.common.enum import LanguageSelection
2017-10-07 07:05:07 +00:00
from openlp.core.common.registry import Registry
from openlp.core.common.settings import Settings
from openlp.plugins.bibles.lib import parse_reference
from openlp.plugins.bibles.lib.manager import BibleManager
2014-03-15 06:29:41 +00:00
from tests.helpers.testmixin import TestMixin
2017-12-28 08:27:44 +00:00
from tests.utils.constants import TEST_RESOURCES_PATH
2014-03-11 20:11:04 +00:00
2014-03-15 06:29:41 +00:00
class TestBibleManager(TestCase, TestMixin):
2014-03-11 20:11:04 +00:00
def setUp(self):
"""
Set up the environment for testing bible parse reference
"""
2017-06-03 23:27:19 +00:00
self.setup_application()
2014-03-15 06:29:41 +00:00
self.build_settings()
2014-03-11 20:11:04 +00:00
Registry.create()
Registry().register('service_list', MagicMock())
Registry().register('application', MagicMock())
bible_settings = {
'bibles/proxy name': '',
'bibles/db type': 'sqlite',
'bibles/book name language': LanguageSelection.Bible,
'bibles/verse separator': '',
'bibles/range separator': '',
'bibles/list separator': '',
'bibles/end separator': '',
}
Settings().extend_default_settings(bible_settings)
with patch('openlp.core.common.applocation.Settings') as mocked_class, \
2017-10-07 07:05:07 +00:00
patch('openlp.core.common.applocation.AppLocation.get_section_data_path') as mocked_get_data_path, \
patch('openlp.core.common.applocation.AppLocation.get_files') as mocked_get_files:
2014-03-11 20:11:04 +00:00
# GIVEN: A mocked out Settings class and a mocked out AppLocation.get_files()
mocked_settings = mocked_class.return_value
mocked_settings.contains.return_value = False
mocked_get_files.return_value = ["tests.sqlite"]
2017-10-07 07:05:07 +00:00
mocked_get_data_path.return_value = TEST_RESOURCES_PATH + "/bibles"
2014-03-11 20:11:04 +00:00
self.manager = BibleManager(MagicMock())
def tearDown(self):
"""
Delete all the C++ objects at the end so that we don't have a segfault
"""
del self.manager
2014-03-15 06:29:41 +00:00
self.destroy_settings()
2014-03-11 20:11:04 +00:00
def test_parse_reference_numbered_book_single_chapter_no_verse_reference(self):
2014-03-11 20:11:04 +00:00
"""
Test the parse_reference method with 1 Timothy 1
"""
# GIVEN given a bible in the bible manager
# WHEN asking to parse the bible reference
results = parse_reference('1 Timothy 1', self.manager.db_cache['tests'], MagicMock(), 54)
# THEN a one tuple verse array should be returned
assert [(54, 1, 1, -1)] == results, "The bible verses should match the expected results"
2014-03-11 20:11:04 +00:00
def test_parse_reference_numbered_book_single_range_single_chapter_multiple_verses(self):
2014-03-11 20:11:04 +00:00
"""
Test the parse_reference method with 1 Timothy 1:1-2
"""
# GIVEN given a bible in the bible manager
# WHEN asking to parse the bible reference
results = parse_reference('1 Timothy 1:1-2', self.manager.db_cache['tests'], MagicMock(), 54)
# THEN a one tuple verse array should be returned
assert [(54, 1, 1, 2)] == results, "The bible verses should match the expected results"
2014-03-11 20:11:04 +00:00
def test_parse_reference_numbered_book_single_range_multiple_chapters_specific_verses(self):
2014-03-11 20:11:04 +00:00
"""
Test the parse_reference method with 1 Timothy 1:1-2
"""
# GIVEN given a bible in the bible manager
# WHEN asking to parse the bible reference
results = parse_reference('1 Timothy 1:1-2:1', self.manager.db_cache['tests'], MagicMock(), 54)
# THEN a two tuple verse array should be returned
2017-12-23 09:09:45 +00:00
assert [(54, 1, 1, -1), (54, 2, 1, 1)] == results, \
"The bible verses should match the expected results"
def test_parse_reference_invalid_book(self):
"""
Test the parse_reference method with non existent book
"""
# GIVEN given a bible in the bible manager
# WHEN asking to parse the bible reference
results = parse_reference('Raoul 1', self.manager.db_cache['tests'], MagicMock())
# THEN an empty verse array should be returned
assert [] == results, "The bible search should return an empty list"
2015-01-29 20:54:06 +00:00
def test_parse_reference_numbered_book_single_range_single_chapter_with_end_reference(self):
2015-01-29 20:54:06 +00:00
"""
Test the parse_reference method with 1 Timothy 1:3-end
"""
# GIVEN given a bible in the bible manager
# WHEN asking to parse the bible reference
results = parse_reference('1 Timothy 1:3-end', self.manager.db_cache['tests'], MagicMock(), 54)
# THEN a one tuple verse array should be returned
assert [(54, 1, 3, -1)] == results, "The bible verses should match the expected results"
def test_parse_reference_numbered_book_single_range_single_chapter_with_end_reference_no_bible_ref_id(self):
"""
Test the parse_reference method with 1 Timothy 1:3-end without a bible ref id to match
how the GUI does the search. This is logged in issue #282
"""
# GIVEN given a bible in the bible manager
# WHEN asking to parse the bible reference in Language 0 (english)
results = parse_reference('1 Timothy 1:3-end', self.manager.db_cache['tests'], 0)
# THEN a one tuple verse array should be returned
assert [(54, 1, 3, -1)] == results, "The bible verses should match the expected results"
def test_parse_reference_book_ref_id_invalid(self):
"""
Test the parse_reference method with 1 Timothy 1:1 with an invalid bible ref id
"""
# GIVEN given a bible in the bible manager
# WHEN asking to parse the bible reference with an invalid bible reference id
results = parse_reference('1 Timothy 1:1', self.manager.db_cache['tests'], MagicMock(), -666)
# THEN an empty verse array should be returned
assert [] == results, "The bible verse list should be empty"
def test_parse_reference_no_from_chapter_in_second_range(self):
"""
Test the parse_reference method with 1 Timothy 1:1,3
"""
# GIVEN given a bible in the bible manager
# WHEN asking to parse the bible reference that has no from_chapter in the second range
results = parse_reference('1 Timothy 1:1,3', self.manager.db_cache['tests'], MagicMock(), 54)
# THEN a two tuple verse array should be returned
assert [(54, 1, 1, 1), (54, 1, 3, 3)] == results, "The bible verses should match the expected results"
def test_parse_reference_to_chapter_less_than_from_chapter(self):
"""
Test the parse_reference method with 1 Timothy 2:1-1:1
"""
# GIVEN given a bible in the bible manager
# WHEN asking to parse the bible reference with a to_chapter less than the from_chapter
results = parse_reference('1 Timothy 2:1-1:1', self.manager.db_cache['tests'], MagicMock(), 54)
# THEN an empty verse array should be returned
assert [] == results, "The bible verse list should be empty"
def test_parse_reference_no_from_chapter_specified(self):
"""
Test the parse_reference method with 1 Timothy :1-2
"""
# GIVEN given a bible in the bible manager
# WHEN asking to parse the bible reference with no from_chapter specified
results = parse_reference('1 Timothy :1-2', self.manager.db_cache['tests'], MagicMock(), 54)
# THEN a two tuple verse array should be returned with the bible verse references treated as chapter references
assert [(54, 1, 1, -1), (54, 2, 1, -1)] == results, "The bible verses should match the expected results"
def test_parse_reference_three_chapters(self):
"""
Test the parse_reference method with 1 Timothy 1-3
"""
# GIVEN given a bible in the bible manager
# WHEN asking to parse the bible reference with three chapters
results = parse_reference('1 Timothy 1-3', self.manager.db_cache['tests'], MagicMock(), 54)
# THEN a three tuple verse array should be returned
assert [(54, 1, 1, -1), (54, 2, 1, -1), (54, 3, 1, -1)] == results, \
"The bible verses should match the expected results"
def test_parse_reference_non_regexp_matching_reference(self):
"""
Test the parse_reference method with 1 Timothy
"""
# GIVEN given a bible in the bible manager
# WHEN asking to parse the bible reference that fails the regexp matching
results = parse_reference('1 Timothy', self.manager.db_cache['tests'], MagicMock(), 54)
# THEN an empty verse array should be returned
assert [] == results, "The bible verse list should be empty"