forked from openlp/openlp
Refactor of OpenSong Bible importer + 100% test coverage
This commit is contained in:
Philip Ridout
parent
46b6d041cd
commit
7c77d7e8bd
@ -36,7 +36,8 @@ class OpenSongBible(BibleImport):
|
||||
"""
|
||||
OpenSong Bible format importer class. This class is used to import Bibles from OpenSong's XML format.
|
||||
"""
|
||||
def get_text(self, element):
|
||||
@staticmethod
|
||||
def get_text(element):
|
||||
"""
|
||||
Recursively get all text in an objectify element and its child elements.
|
||||
|
||||
@ -46,15 +47,15 @@ class OpenSongBible(BibleImport):
|
||||
if element.text:
|
||||
verse_text = element.text
|
||||
for sub_element in element.iterchildren():
|
||||
verse_text += self.get_text(sub_element)
|
||||
verse_text += OpenSongBible.get_text(sub_element)
|
||||
if element.tail:
|
||||
verse_text += element.tail
|
||||
return verse_text
|
||||
|
||||
@staticmethod
|
||||
def process_chapter_no(number, previous_number):
|
||||
def parse_chapter_number(number, previous_number):
|
||||
"""
|
||||
Process the chapter number
|
||||
Parse the chapter number
|
||||
|
||||
:param number: The raw data from the xml
|
||||
:param previous_number: The previous chapter number
|
||||
@ -65,9 +66,9 @@ class OpenSongBible(BibleImport):
|
||||
return previous_number + 1
|
||||
|
||||
@staticmethod
|
||||
def process_verse_no(number, previous_number):
|
||||
def parse_verse_number(number, previous_number):
|
||||
"""
|
||||
Process the verse number retrieved from the xml
|
||||
Parse the verse number retrieved from the xml
|
||||
|
||||
:param number: The raw data from the xml
|
||||
:param previous_number: The previous verse number
|
||||
@ -94,7 +95,7 @@ class OpenSongBible(BibleImport):
|
||||
:param filename: The supplied file
|
||||
:return: True if valid. ValidationError is raised otherwise.
|
||||
"""
|
||||
if BibleImport.is_compressed():
|
||||
if BibleImport.is_compressed(filename):
|
||||
raise ValidationError(msg='Compressed file')
|
||||
bible = BibleImport.parse_xml(filename, use_objectify=True)
|
||||
root_tag = bible.tag.lower()
|
||||
@ -108,44 +109,47 @@ class OpenSongBible(BibleImport):
|
||||
raise ValidationError(msg='Invalid xml.')
|
||||
return True
|
||||
|
||||
def process_books(self, books):
|
||||
for book in books:
|
||||
if self.stop_import_flag:
|
||||
break
|
||||
db_book = self.find_and_create_book(str(book.attrib['n']), len(books), self.language_id)
|
||||
self.process_chapters(db_book, book.c)
|
||||
self.session.commit()
|
||||
|
||||
def process_chapters(self, book, chapters):
|
||||
chapter_number = 0
|
||||
for chapter in chapters:
|
||||
if self.stop_import_flag:
|
||||
break
|
||||
chapter_number = self.parse_chapter_number(chapter.attrib['n'], chapter_number)
|
||||
self.process_verses(book, chapter_number, chapter.v)
|
||||
self.wizard.increment_progress_bar(translate('BiblesPlugin.Opensong',
|
||||
'Importing {name} {chapter}...'
|
||||
).format(name=book.name, chapter=chapter_number))
|
||||
|
||||
def process_verses(self, book, chapter_number, verses):
|
||||
verse_number = 0
|
||||
for verse in verses:
|
||||
if self.stop_import_flag:
|
||||
break
|
||||
verse_number = self.parse_verse_number(verse.attrib['n'], verse_number)
|
||||
self.create_verse(book.id, chapter_number, verse_number, self.get_text(verse))
|
||||
|
||||
def do_import(self, bible_name=None):
|
||||
"""
|
||||
Loads a Bible from file.
|
||||
Loads an Open Song Bible from a file.
|
||||
"""
|
||||
self.validate_file(self.filename)
|
||||
log.debug('Starting OpenSong import from "{name}"'.format(name=self.filename))
|
||||
try:
|
||||
self.validate_file(self.filename)
|
||||
bible = self.parse_xml(self.filename, use_objectify=True)
|
||||
# Check that we're not trying to import a Zefania XML bible, it is sometimes refered to as 'OpenSong'
|
||||
if bible.tag.upper() == 'XMLBIBLE':
|
||||
critical_error_message_box(
|
||||
message=translate('BiblesPlugin.OpenSongImport',
|
||||
'Incorrect Bible file type supplied. This looks like a Zefania XML bible, '
|
||||
'please use the Zefania import option.'))
|
||||
return False
|
||||
# No language info in the opensong format, so ask the user
|
||||
language_id = self.get_language_id(bible_name=self.filename)
|
||||
if not language_id:
|
||||
self.language_id = self.get_language_id(bible_name=self.filename)
|
||||
if not self.language_id:
|
||||
return False
|
||||
for book in bible.b:
|
||||
if self.stop_import_flag:
|
||||
break
|
||||
db_book = self.find_and_create_book(str(book.attrib['n']), len(bible.b), language_id)
|
||||
chapter_number = 0
|
||||
for chapter in book.c:
|
||||
if self.stop_import_flag:
|
||||
break
|
||||
chapter_number = self.process_chapter_no(chapter.attrib['n'], chapter_number)
|
||||
verse_number = 0
|
||||
for verse in chapter.v:
|
||||
if self.stop_import_flag:
|
||||
break
|
||||
verse_number = self.process_verse_no(verse.attrib['n'], verse_number)
|
||||
self.create_verse(db_book.id, chapter_number, verse_number, self.get_text(verse))
|
||||
self.wizard.increment_progress_bar(translate('BiblesPlugin.Opensong',
|
||||
'Importing {name} {chapter}...'
|
||||
).format(name=db_book.name, chapter=chapter_number))
|
||||
self.session.commit()
|
||||
self.process_books(bible.b)
|
||||
self.application.process_events()
|
||||
except (AttributeError, ValidationError, etree.XMLSyntaxError):
|
||||
log.exception('Loading Bible from OpenSong file failed')
|
||||
@ -153,3 +157,4 @@ class OpenSongBible(BibleImport):
|
||||
return False
|
||||
if self.stop_import_flag:
|
||||
return False
|
||||
return True
|
||||
|
||||
@ -24,18 +24,13 @@ Package to test the openlp.core.ui.exeptionform package.
|
||||
"""
|
||||
|
||||
import os
|
||||
import socket
|
||||
import tempfile
|
||||
import urllib
|
||||
from unittest import TestCase
|
||||
from unittest.mock import mock_open
|
||||
|
||||
from PyQt5.QtCore import QUrlQuery
|
||||
|
||||
from openlp.core.common import Registry
|
||||
from openlp.core.ui.firsttimeform import FirstTimeForm
|
||||
|
||||
from tests.functional import MagicMock, patch
|
||||
from tests.functional import patch
|
||||
from tests.helpers.testmixin import TestMixin
|
||||
|
||||
from openlp.core.ui import exceptionform
|
||||
|
||||
@ -23,14 +23,15 @@
|
||||
This module contains tests for the OpenSong Bible importer.
|
||||
"""
|
||||
|
||||
import os
|
||||
import json
|
||||
import os
|
||||
from unittest import TestCase
|
||||
|
||||
from lxml import etree, objectify
|
||||
|
||||
from lxml import objectify
|
||||
|
||||
from tests.functional import MagicMock, patch
|
||||
from tests.functional import MagicMock, patch, call
|
||||
from tests.helpers.testmixin import TestMixin
|
||||
from openlp.core.common import Registry
|
||||
from openlp.core.lib.exceptions import ValidationError
|
||||
from openlp.plugins.bibles.lib.importers.opensong import OpenSongBible
|
||||
from openlp.plugins.bibles.lib.bibleimport import BibleImport
|
||||
@ -39,7 +40,7 @@ TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__),
|
||||
'..', '..', '..', 'resources', 'bibles'))
|
||||
|
||||
|
||||
class TestOpenSongImport(TestCase):
|
||||
class TestOpenSongImport(TestCase, TestMixin):
|
||||
"""
|
||||
Test the functions in the :mod:`opensongimport` module.
|
||||
"""
|
||||
@ -48,9 +49,10 @@ class TestOpenSongImport(TestCase):
|
||||
self.manager_patcher = patch('openlp.plugins.bibles.lib.db.Manager')
|
||||
self.addCleanup(self.manager_patcher.stop)
|
||||
self.manager_patcher.start()
|
||||
self.registry_patcher = patch('openlp.plugins.bibles.lib.db.Registry')
|
||||
self.addCleanup(self.registry_patcher.stop)
|
||||
self.registry_patcher.start()
|
||||
self.setup_application()
|
||||
self.app.process_events = MagicMock()
|
||||
Registry.create()
|
||||
Registry().register('application', self.app)
|
||||
|
||||
def test_create_importer(self):
|
||||
"""
|
||||
@ -65,133 +67,444 @@ class TestOpenSongImport(TestCase):
|
||||
# THEN: The importer should be an instance of BibleDB
|
||||
self.assertIsInstance(importer, BibleImport)
|
||||
|
||||
def process_chapter_no_test(self):
|
||||
def get_text_no_text_test(self):
|
||||
"""
|
||||
Test process_chapter_no when supplied with chapter number and an instance of OpenSongBible
|
||||
Test that get_text handles elements containing text in a combination of text and tail attributes
|
||||
"""
|
||||
# GIVEN: Some test data which contains an empty element and an instance of OpenSongBible
|
||||
test_data = objectify.fromstring('<element></element>')
|
||||
|
||||
# WHEN: Calling get_text
|
||||
result = OpenSongBible.get_text(test_data)
|
||||
|
||||
# THEN: A blank string should be returned
|
||||
self.assertEqual(result, '')
|
||||
|
||||
def get_text_text_test(self):
|
||||
"""
|
||||
Test that get_text handles elements containing text in a combination of text and tail attributes
|
||||
"""
|
||||
# GIVEN: Some test data which contains all possible permutation of text and tail text possible and an instance
|
||||
# of OpenSongBible
|
||||
test_data = objectify.fromstring('<element>Element text '
|
||||
'<sub_text_tail>sub_text_tail text </sub_text_tail>sub_text_tail tail '
|
||||
'<sub_text>sub_text text </sub_text>'
|
||||
'<sub_tail></sub_tail>sub_tail tail</element>')
|
||||
|
||||
# WHEN: Calling get_text
|
||||
result = OpenSongBible.get_text(test_data)
|
||||
|
||||
# THEN: The text returned should be as expected
|
||||
self.assertEqual(result, 'Element text sub_text_tail text sub_text_tail tail sub_text text sub_tail tail')
|
||||
|
||||
def parse_chapter_number_test(self):
|
||||
"""
|
||||
Test parse_chapter_number when supplied with chapter number and an instance of OpenSongBible
|
||||
"""
|
||||
# GIVEN: The number 10 represented as a string
|
||||
# WHEN: Calling process_chapter_no
|
||||
result = OpenSongBible.process_chapter_no('10', 0)
|
||||
# WHEN: Calling parse_chapter_nnumber
|
||||
result = OpenSongBible.parse_chapter_number('10', 0)
|
||||
|
||||
# THEN: The 10 should be returned as an Int
|
||||
self.assertEqual(result, 10)
|
||||
|
||||
def process_chapter_no_empty_attribute_test(self):
|
||||
def parse_chapter_number_empty_attribute_test(self):
|
||||
"""
|
||||
Test process_chapter_no when the chapter number is an empty string. (Bug #1074727)
|
||||
Testparse_chapter_number when the chapter number is an empty string. (Bug #1074727)
|
||||
"""
|
||||
# GIVEN: An empty string, and the previous chapter number set as 12 and an instance of OpenSongBible
|
||||
# WHEN: Calling process_chapter_no
|
||||
result = OpenSongBible.process_chapter_no('', 12)
|
||||
# WHEN: Calling parse_chapter_number
|
||||
result = OpenSongBible.parse_chapter_number('', 12)
|
||||
|
||||
# THEN: process_chapter_no should increment the previous verse number
|
||||
# THEN: parse_chapter_number should increment the previous verse number
|
||||
self.assertEqual(result, 13)
|
||||
|
||||
def process_verse_no_valid_verse_no_test(self):
|
||||
def parse_verse_number_valid_verse_no_test(self):
|
||||
"""
|
||||
Test process_verse_no when supplied with a valid verse number
|
||||
Test parse_verse_number when supplied with a valid verse number
|
||||
"""
|
||||
# GIVEN: The number 15 represented as a string and an instance of OpenSongBible
|
||||
# WHEN: Calling process_verse_no
|
||||
result = OpenSongBible.process_verse_no('15', 0)
|
||||
# WHEN: Calling parse_verse_number
|
||||
result = OpenSongBible.parse_verse_number('15', 0)
|
||||
|
||||
# THEN: process_verse_no should return the verse number
|
||||
# THEN: parse_verse_number should return the verse number
|
||||
self.assertEqual(result, 15)
|
||||
|
||||
def process_verse_no_verse_range_test(self):
|
||||
def parse_verse_number_verse_range_test(self):
|
||||
"""
|
||||
Test process_verse_no when supplied with a verse range
|
||||
Test parse_verse_number when supplied with a verse range
|
||||
"""
|
||||
# GIVEN: The range 24-26 represented as a string
|
||||
# WHEN: Calling process_verse_no
|
||||
result = OpenSongBible.process_verse_no('24-26', 0)
|
||||
# WHEN: Calling parse_verse_number
|
||||
result = OpenSongBible.parse_verse_number('24-26', 0)
|
||||
|
||||
# THEN: process_verse_no should return the first verse number in the range
|
||||
# THEN: parse_verse_number should return the first verse number in the range
|
||||
self.assertEqual(result, 24)
|
||||
|
||||
def process_verse_no_invalid_verse_no_test(self):
|
||||
def parse_verse_number_invalid_verse_no_test(self):
|
||||
"""
|
||||
Test process_verse_no when supplied with a invalid verse number
|
||||
Test parse_verse_number when supplied with a invalid verse number
|
||||
"""
|
||||
# GIVEN: An non numeric string represented as a string
|
||||
# WHEN: Calling process_verse_no
|
||||
result = OpenSongBible.process_verse_no('invalid', 41)
|
||||
# WHEN: Calling parse_verse_number
|
||||
result = OpenSongBible.parse_verse_number('invalid', 41)
|
||||
|
||||
# THEN: process_verse_no should increment the previous verse number
|
||||
# THEN: parse_verse_number should increment the previous verse number
|
||||
self.assertEqual(result, 42)
|
||||
|
||||
def process_verse_no_empty_attribute_test(self):
|
||||
def parse_verse_number_empty_attribute_test(self):
|
||||
"""
|
||||
Test process_verse_no when the verse number is an empty string. (Bug #1074727)
|
||||
Test parse_verse_number when the verse number is an empty string. (Bug #1074727)
|
||||
"""
|
||||
# GIVEN: An empty string, and the previous verse number set as 14
|
||||
# WHEN: Calling process_verse_no
|
||||
result = OpenSongBible.process_verse_no('', 14)
|
||||
# WHEN: Calling parse_verse_number
|
||||
result = OpenSongBible.parse_verse_number('', 14)
|
||||
|
||||
# THEN: process_verse_no should increment the previous verse number
|
||||
# THEN: parse_verse_number should increment the previous verse number
|
||||
self.assertEqual(result, 15)
|
||||
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.log')
|
||||
def process_verse_no_invalid_type_test(self, mocked_log):
|
||||
def parse_verse_number_invalid_type_test(self, mocked_log):
|
||||
"""
|
||||
Test process_verse_no when the verse number is an invalid type)
|
||||
Test parse_verse_number when the verse number is an invalid type)
|
||||
"""
|
||||
# GIVEN: A mocked out log, a Tuple, and the previous verse number set as 12
|
||||
# WHEN: Calling process_verse_no
|
||||
result = OpenSongBible.process_verse_no((1,2,3), 12)
|
||||
# WHEN: Calling parse_verse_number
|
||||
result = OpenSongBible.parse_verse_number((1, 2, 3), 12)
|
||||
|
||||
# THEN: process_verse_no should log the verse number it was called with increment the previous verse number
|
||||
# THEN: parse_verse_number should log the verse number it was called with increment the previous verse number
|
||||
mocked_log.warning.assert_called_once_with('Illegal verse number: (1, 2, 3)')
|
||||
self.assertEqual(result, 13)
|
||||
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.BibleImport')
|
||||
def validate_xml_bible_test(self, mocked_bible_import):
|
||||
@patch('openlp.plugins.bibles.lib.bibleimport.BibleImport.find_and_create_book')
|
||||
def process_books_stop_import_test(self, mocked_find_and_create_book):
|
||||
"""
|
||||
Test that validate_xml returns True with valid XML
|
||||
Test process_books when stop_import is set to True
|
||||
"""
|
||||
# GIVEN: An isntance of OpenSongBible
|
||||
importer = OpenSongBible(MagicMock(), path='.', name='.', filename='')
|
||||
|
||||
# WHEN: stop_import_flag is set to True
|
||||
importer.stop_import_flag = True
|
||||
importer.process_books(['Book'])
|
||||
|
||||
# THEN: find_and_create_book should not have been called
|
||||
self.assertFalse(mocked_find_and_create_book.called)
|
||||
|
||||
@patch('openlp.plugins.bibles.lib.bibleimport.BibleImport.find_and_create_book',
|
||||
**{'side_effect': ['db_book1', 'db_book2']})
|
||||
def process_books_completes_test(self, mocked_find_and_create_book):
|
||||
"""
|
||||
Test process_books when it processes all books
|
||||
"""
|
||||
# GIVEN: An instance of OpenSongBible Importer and two mocked books
|
||||
importer = OpenSongBible(MagicMock(), path='.', name='.', filename='')
|
||||
|
||||
book1 = MagicMock()
|
||||
book1.attrib = {'n': 'Name1'}
|
||||
book1.c = 'Chapter1'
|
||||
book2 = MagicMock()
|
||||
book2.attrib = {'n': 'Name2'}
|
||||
book2.c = 'Chapter2'
|
||||
importer.language_id = 10
|
||||
importer.process_chapters = MagicMock()
|
||||
importer.session = MagicMock()
|
||||
importer.stop_import_flag = False
|
||||
|
||||
# WHEN: Calling process_books with the two books
|
||||
importer.process_books([book1, book2])
|
||||
|
||||
# THEN: find_and_create_book and process_books should be called with the details from the mocked books
|
||||
self.assertEqual(mocked_find_and_create_book.call_args_list, [call('Name1', 2, 10), call('Name2', 2, 10)])
|
||||
self.assertEqual(importer.process_chapters.call_args_list,
|
||||
[call('db_book1', 'Chapter1'), call('db_book2', 'Chapter2')])
|
||||
self.assertEqual(importer.session.commit.call_count, 2)
|
||||
|
||||
def process_chapters_stop_import_test(self):
|
||||
"""
|
||||
Test process_chapters when stop_import is set to True
|
||||
"""
|
||||
# GIVEN: An isntance of OpenSongBible
|
||||
importer = OpenSongBible(MagicMock(), path='.', name='.', filename='')
|
||||
importer.parse_chapter_number = MagicMock()
|
||||
|
||||
# WHEN: stop_import_flag is set to True
|
||||
importer.stop_import_flag = True
|
||||
importer.process_chapters('Book', ['Chapter1'])
|
||||
|
||||
# THEN: importer.parse_chapter_number not have been called
|
||||
self.assertFalse(importer.parse_chapter_number.called)
|
||||
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.translate', **{'side_effect': lambda x, y: y})
|
||||
def process_chapters_completes_test(self, mocked_translate):
|
||||
"""
|
||||
Test process_chapters when it completes
|
||||
"""
|
||||
# GIVEN: An instance of OpenSongBible
|
||||
importer = OpenSongBible(MagicMock(), path='.', name='.', filename='')
|
||||
importer.parse_chapter_number = MagicMock()
|
||||
importer.parse_chapter_number.side_effect = [1, 2]
|
||||
importer.wizard = MagicMock()
|
||||
|
||||
# WHEN: called with some valid data
|
||||
book = MagicMock()
|
||||
book.name = "Book"
|
||||
chapter1 = MagicMock()
|
||||
chapter1.attrib = {'n': '1'}
|
||||
chapter1.c = 'Chapter1'
|
||||
chapter1.v = ['Chapter1 Verses']
|
||||
chapter2 = MagicMock()
|
||||
chapter2.attrib = {'n': '2'}
|
||||
chapter2.c = 'Chapter2'
|
||||
chapter2.v = ['Chapter2 Verses']
|
||||
|
||||
importer.process_verses = MagicMock()
|
||||
importer.stop_import_flag = False
|
||||
importer.process_chapters(book, [chapter1, chapter2])
|
||||
|
||||
# THEN: parse_chapter_number, process_verses and increment_process_bar should have been called
|
||||
self.assertEqual(importer.parse_chapter_number.call_args_list, [call('1', 0), call('2', 1)])
|
||||
self.assertEqual(
|
||||
importer.process_verses.call_args_list,
|
||||
[call(book, 1, ['Chapter1 Verses']), call(book, 2, ['Chapter2 Verses'])])
|
||||
self.assertEqual(importer.wizard.increment_progress_bar.call_args_list,
|
||||
[call('Importing Book 1...'), call('Importing Book 2...')])
|
||||
|
||||
def process_verses_stop_import_test(self):
|
||||
"""
|
||||
Test process_verses when stop_import is set to True
|
||||
"""
|
||||
# GIVEN: An isntance of OpenSongBible
|
||||
importer = OpenSongBible(MagicMock(), path='.', name='.', filename='')
|
||||
importer.parse_verse_number = MagicMock()
|
||||
|
||||
# WHEN: stop_import_flag is set to True
|
||||
importer.stop_import_flag = True
|
||||
importer.process_verses('Book', 1, 'Verses')
|
||||
|
||||
# THEN: importer.parse_verse_number not have been called
|
||||
self.assertFalse(importer.parse_verse_number.called)
|
||||
|
||||
def process_verses_completes_test(self):
|
||||
"""
|
||||
Test process_verses when it completes
|
||||
"""
|
||||
# GIVEN: An instance of OpenSongBible
|
||||
importer = OpenSongBible(MagicMock(), path='.', name='.', filename='')
|
||||
importer.get_text = MagicMock()
|
||||
importer.get_text.side_effect = ['Verse1 Text', 'Verse2 Text']
|
||||
importer.parse_verse_number = MagicMock()
|
||||
importer.parse_verse_number.side_effect = [1, 2]
|
||||
importer.wizard = MagicMock()
|
||||
|
||||
# WHEN: called with some valid data
|
||||
book = MagicMock()
|
||||
book.id = 1
|
||||
verse1 = MagicMock()
|
||||
verse1.attrib = {'n': '1'}
|
||||
verse1.c = 'Chapter1'
|
||||
verse1.v = ['Chapter1 Verses']
|
||||
verse2 = MagicMock()
|
||||
verse2.attrib = {'n': '2'}
|
||||
verse2.c = 'Chapter2'
|
||||
verse2.v = ['Chapter2 Verses']
|
||||
|
||||
importer.create_verse = MagicMock()
|
||||
importer.stop_import_flag = False
|
||||
importer.process_verses(book, 1, [verse1, verse2])
|
||||
|
||||
# THEN: parse_chapter_number, process_verses and increment_process_bar should have been called
|
||||
self.assertEqual(importer.parse_verse_number.call_args_list, [call('1', 0), call('2', 1)])
|
||||
self.assertEqual(importer.get_text.call_args_list, [call(verse1), call(verse2)])
|
||||
self.assertEqual(
|
||||
importer.create_verse.call_args_list,
|
||||
[call(1, 1, 1, 'Verse1 Text'), call(1, 1, 2, 'Verse2 Text')])
|
||||
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.BibleImport.is_compressed')
|
||||
def validate_file_compressed_test(self, mocked_is_compressed):
|
||||
"""
|
||||
Test that validate_file raises a ValidationError when supplied with a compressed file
|
||||
"""
|
||||
# GIVEN: A mocked is_compressed method which returns True
|
||||
mocked_is_compressed.return_value = True
|
||||
|
||||
# WHEN: Calling validate_file
|
||||
# THEN: ValidationError should be raised
|
||||
with self.assertRaises(ValidationError) as context:
|
||||
OpenSongBible.validate_file('file.name')
|
||||
self.assertEqual(context.exception.msg, 'Compressed file')
|
||||
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.BibleImport.parse_xml')
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.BibleImport.is_compressed', **{'return_value': False})
|
||||
def validate_file_bible_test(self, mocked_is_compressed, mocked_parse_xml):
|
||||
"""
|
||||
Test that validate_file returns True with valid XML
|
||||
"""
|
||||
# GIVEN: Some test data with an OpenSong Bible "bible" root tag
|
||||
mocked_bible_import.parse_xml.return_value = objectify.fromstring('<bible></bible>')
|
||||
mocked_parse_xml.return_value = objectify.fromstring('<bible></bible>')
|
||||
|
||||
# WHEN: Calling validate_xml
|
||||
# WHEN: Calling validate_file
|
||||
result = OpenSongBible.validate_file('file.name')
|
||||
|
||||
# THEN: A True should be returned
|
||||
self.assertTrue(result)
|
||||
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.critical_error_message_box')
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.BibleImport')
|
||||
def validate_xml_zefania_root_test(self, mocked_bible_import, mocked_message_box):
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.BibleImport.parse_xml')
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.BibleImport.is_compressed', **{'return_value': False})
|
||||
def validate_file_zefania_root_test(self, mocked_is_compressed, mocked_parse_xml, mocked_message_box):
|
||||
"""
|
||||
Test that validate_xml raises a ValidationError with a Zefinia root tag
|
||||
Test that validate_file raises a ValidationError with a Zefinia root tag
|
||||
"""
|
||||
# GIVEN: Some test data with a Zefinia "XMLBIBLE" root tag
|
||||
mocked_bible_import.parse_xml.return_value = objectify.fromstring('<XMLBIBLE></XMLBIBLE>')
|
||||
mocked_parse_xml.return_value = objectify.fromstring('<XMLBIBLE></XMLBIBLE>')
|
||||
|
||||
# WHEN: Calling validate_xml
|
||||
# WHEN: Calling validate_file
|
||||
# THEN: critical_error_message_box should be called and an ValidationError should be raised
|
||||
with self.assertRaises(ValidationError) as context:
|
||||
OpenSongBible.validate_file('file.name')
|
||||
self.assertEqual(context.exception.msg, 'Invalid xml.')
|
||||
self.assertEqual(context.exception.msg, 'Invalid xml.')
|
||||
mocked_message_box.assert_called_once_with(
|
||||
message='Incorrect Bible file type supplied. This looks like a Zefania XML bible, please use the '
|
||||
'Zefania import option.')
|
||||
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.critical_error_message_box')
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.BibleImport')
|
||||
def validate_xml_invalid_root_test(self, mocked_bible_import, mocked_message_box):
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.BibleImport.parse_xml')
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.BibleImport.is_compressed', **{'return_value': False})
|
||||
def validate_file_invalid_root_test(self, mocked_is_compressed, mocked_parse_xml, mocked_message_box):
|
||||
"""
|
||||
Test that validate_xml raises a ValidationError with an invalid root tag
|
||||
Test that validate_file raises a ValidationError with an invalid root tag
|
||||
"""
|
||||
# GIVEN: Some test data with an invalid root tag and an instance of OpenSongBible
|
||||
mocked_bible_import.parse_xml.return_value = objectify.fromstring('<song></song>')
|
||||
mocked_parse_xml.return_value = objectify.fromstring('<song></song>')
|
||||
|
||||
# WHEN: Calling validate_xml
|
||||
# WHEN: Calling validate_file
|
||||
# THEN: ValidationError should be raised, and the critical error message box should not have been called
|
||||
with self.assertRaises(ValidationError) as context:
|
||||
OpenSongBible.validate_file('file.name')
|
||||
self.assertEqual(context.exception.msg, 'Invalid xml.')
|
||||
self.assertEqual(context.exception.msg, 'Invalid xml.')
|
||||
self.assertFalse(mocked_message_box.called)
|
||||
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.log')
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.trace_error_handler')
|
||||
def do_import_attribute_error_test(self, mocked_trace_error_handler, mocked_log):
|
||||
"""
|
||||
Test do_import when an AttributeError exception is raised
|
||||
"""
|
||||
# GIVEN: An instance of OpenSongBible and a mocked validate_file which raises an AttributeError
|
||||
importer = OpenSongBible(MagicMock(), path='.', name='.', filename='')
|
||||
importer.validate_file = MagicMock(**{'side_effect': AttributeError()})
|
||||
importer.parse_xml = MagicMock()
|
||||
|
||||
# WHEN: Calling do_import
|
||||
result = importer.do_import()
|
||||
|
||||
# THEN: do_import should return False after logging the exception
|
||||
mocked_log.exception.assert_called_once_with('Loading Bible from OpenSong file failed')
|
||||
mocked_trace_error_handler.assert_called_once_with(mocked_log)
|
||||
self.assertFalse(result)
|
||||
self.assertFalse(importer.parse_xml.called)
|
||||
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.log')
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.trace_error_handler')
|
||||
def do_import_validation_error_test(self, mocked_trace_error_handler, mocked_log):
|
||||
"""
|
||||
Test do_import when an ValidationError exception is raised
|
||||
"""
|
||||
# GIVEN: An instance of OpenSongBible and a mocked validate_file which raises an ValidationError
|
||||
importer = OpenSongBible(MagicMock(), path='.', name='.', filename='')
|
||||
importer.validate_file = MagicMock(**{'side_effect': ValidationError()})
|
||||
importer.parse_xml = MagicMock()
|
||||
|
||||
# WHEN: Calling do_import
|
||||
result = importer.do_import()
|
||||
|
||||
# THEN: do_import should return False after logging the exception. parse_xml should not be called.
|
||||
mocked_log.exception.assert_called_once_with('Loading Bible from OpenSong file failed')
|
||||
mocked_trace_error_handler.assert_called_once_with(mocked_log)
|
||||
self.assertFalse(result)
|
||||
self.assertFalse(importer.parse_xml.called)
|
||||
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.log')
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.trace_error_handler')
|
||||
def do_import_xml_syntax_error_test(self, mocked_trace_error_handler, mocked_log):
|
||||
"""
|
||||
Test do_import when an etree.XMLSyntaxError exception is raised
|
||||
"""
|
||||
# GIVEN: An instance of OpenSongBible and a mocked validate_file which raises an etree.XMLSyntaxError
|
||||
importer = OpenSongBible(MagicMock(), path='.', name='.', filename='')
|
||||
importer.validate_file = MagicMock(**{'side_effect': etree.XMLSyntaxError(None, None, None, None)})
|
||||
importer.parse_xml = MagicMock()
|
||||
|
||||
# WHEN: Calling do_import
|
||||
result = importer.do_import()
|
||||
|
||||
# THEN: do_import should return False after logging the exception. parse_xml should not be called.
|
||||
mocked_log.exception.assert_called_once_with('Loading Bible from OpenSong file failed')
|
||||
mocked_trace_error_handler.assert_called_once_with(mocked_log)
|
||||
self.assertFalse(result)
|
||||
self.assertFalse(importer.parse_xml.called)
|
||||
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.log')
|
||||
def do_import_no_language_test(self, mocked_log):
|
||||
"""
|
||||
Test do_import when the user cancels the language selection dialog
|
||||
"""
|
||||
# GIVEN: An instance of OpenSongBible and a mocked get_language which returns False
|
||||
importer = OpenSongBible(MagicMock(), path='.', name='.', filename='')
|
||||
importer.validate_file = MagicMock()
|
||||
importer.parse_xml = MagicMock()
|
||||
importer.get_language_id = MagicMock(**{'return_value': False})
|
||||
importer.process_books = MagicMock()
|
||||
|
||||
# WHEN: Calling do_import
|
||||
result = importer.do_import()
|
||||
|
||||
# THEN: do_import should return False and process_books should have not been called
|
||||
self.assertFalse(result)
|
||||
self.assertFalse(importer.process_books.called)
|
||||
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.log')
|
||||
def do_import_stop_import_test(self, mocked_log):
|
||||
"""
|
||||
Test do_import when the stop_import_flag is set to True
|
||||
"""
|
||||
# GIVEN: An instance of OpenSongBible and stop_import_flag set to True
|
||||
importer = OpenSongBible(MagicMock(), path='.', name='.', filename='')
|
||||
importer.validate_file = MagicMock()
|
||||
importer.parse_xml = MagicMock()
|
||||
importer.get_language_id = MagicMock(**{'return_value': 10})
|
||||
importer.process_books = MagicMock()
|
||||
importer.stop_import_flag = True
|
||||
|
||||
# WHEN: Calling do_import
|
||||
result = importer.do_import()
|
||||
|
||||
# THEN: do_import should return False and process_books should have not been called
|
||||
self.assertFalse(result)
|
||||
self.assertTrue(importer.application.process_events.called)
|
||||
|
||||
self.assertTrue(importer.application.process_events.called)
|
||||
|
||||
@patch('openlp.plugins.bibles.lib.importers.opensong.log')
|
||||
def do_import_completes_test(self, mocked_log):
|
||||
"""
|
||||
Test do_import when it completes successfully
|
||||
"""
|
||||
# GIVEN: An instance of OpenSongBible and stop_import_flag set to True
|
||||
importer = OpenSongBible(MagicMock(), path='.', name='.', filename='')
|
||||
importer.validate_file = MagicMock()
|
||||
importer.parse_xml = MagicMock()
|
||||
importer.get_language_id = MagicMock(**{'return_value': 10})
|
||||
importer.process_books = MagicMock()
|
||||
importer.stop_import_flag = False
|
||||
|
||||
# WHEN: Calling do_import
|
||||
result = importer.do_import()
|
||||
|
||||
# THEN: do_import should return True
|
||||
self.assertTrue(result)
|
||||
|
||||
def test_file_import(self):
|
||||
"""
|
||||
Test the actual import of OpenSong Bible file
|
||||
|
||||
Loading…
Reference in New Issue
Block a user