def test_process_chapters_verse_in_chapter_verse_text(self): """ Test process_chapters when supplied with an etree element with a verse element nested in it """ with patch('openlp.plugins.bibles.lib.importers.osis.verse_in_chapter', return_value=True), \ patch('openlp.plugins.bibles.lib.importers.osis.text_in_verse', return_value=True), \ patch.object(OSISBible, 'set_current_chapter') as mocked_set_current_chapter, \ patch.object(OSISBible, 'process_verse') as mocked_process_verse: # GIVEN: Some test data and an instance of OSISBible test_book = MagicMock() test_verse = MagicMock() test_verse.tail = '\n ' # Whitespace test_verse.text = 'Verse Text' test_chapter = MagicMock() test_chapter.__iter__.return_value = [test_verse] test_chapter.get.side_effect = lambda x: { 'osisID': '1.2.4', 'sID': '999' }.get(x) importer = OSISBible(MagicMock(), path='.', name='.', file_path=None) # WHEN: Calling process_chapters importer.process_chapters(test_book, [test_chapter]) # THEN: set_current_chapter and process_verse should have been called with the test data mocked_set_current_chapter.assert_called_once_with( test_book.name, 2) mocked_process_verse.assert_called_once_with( test_book, 2, test_verse)
def test_process_chapters_milestones_verse_tag(self): """ Test process_chapters when supplied with an etree element with a chapter and verse element in the milestone configuration, where the verse is the "opening" milestone. (Has the sID attribute) """ with patch('openlp.plugins.bibles.lib.importers.osis.verse_in_chapter', return_value=False), \ patch.object(OSISBible, 'set_current_chapter') as mocked_set_current_chapter, \ patch.object(OSISBible, 'process_verse') as mocked_process_verse: # GIVEN: Some test data and an instance of OSISBible test_book = MagicMock() test_verse = MagicMock() test_verse.get.side_effect = lambda x: { 'osisID': '1.2.4', 'sID': '999' }.get(x) test_verse.tag = '{http://www.bibletechnologies.net/2003/OSIS/namespace}verse' test_verse.tail = '\n ' # Whitespace test_verse.text = 'Verse Text' # WHEN: Calling process_chapters importer = OSISBible(MagicMock(), path='.', name='.', file_path=None) importer.process_chapters(test_book, [test_verse]) # THEN: process_verse should have been called with the test data assert mocked_set_current_chapter.called is False mocked_process_verse.assert_called_once_with(test_book, 0, test_verse, use_milestones=True)
def test_process_chapters_milestones_chapter_no_sid(self): """ Test process_chapters when supplied with an etree element with a chapter and verse element in the milestone configuration, where the chapter is the "closing" milestone. (Missing the sID attribute) """ with patch('openlp.plugins.bibles.lib.importers.osis.verse_in_chapter', return_value=False), \ patch.object(OSISBible, 'set_current_chapter') as mocked_set_current_chapter, \ patch.object(OSISBible, 'process_verse') as mocked_process_verse: # GIVEN: Some test data and an instance of OSISBible test_book = MagicMock() test_chapter = MagicMock() test_chapter.tag = '{http://www.bibletechnologies.net/2003/OSIS/namespace}chapter' test_chapter.get.side_effect = lambda x: {'osisID': '1.2.4'}.get(x) # WHEN: Calling process_chapters importer = OSISBible(MagicMock(), path='.', name='.', file_path=None) importer.process_chapters(test_book, [test_chapter]) # THEN: neither set_current_chapter or process_verse should have been called assert mocked_set_current_chapter.called is False assert mocked_process_verse.called is False
def test_process_books_stop_import(self): """ Test process_books when stop_import is set to True """ # GIVEN: An instance of OSISBible adn some mocked data importer = OSISBible(MagicMock(), path='.', name='.', file_path=None) mocked_data = MagicMock(**{'xpath.return_value': ['Book']}) # WHEN: stop_import_flag is set to True and process_books is called importer.stop_import_flag = True importer.process_books(mocked_data) # THEN: find_and_create_book should not have been called assert self.mocked_find_and_create_book.called is False
def test_process_verse_no_osis_id(self): """ Test process_verse when the element supplied does not have and osisID attribute """ # GIVEN: An instance of OSISBible, and some mocked test data test_book = MagicMock() test_verse = MagicMock() test_verse.get.side_effect = lambda x: {}.get(x) test_verse.tail = 'Verse Text' test_verse.text = None importer = OSISBible(MagicMock(), path='.', name='.', file_path=None) # WHEN: Calling process_verse with the test data importer.process_verse(test_book, 2, test_verse) # THEN: create_verse should not have been called assert self.mocked_create_verse.called is False
def do_import_completes_test(self): """ Test do_import when it completes successfully """ # GIVEN: An instance of OpenSongBible with patch.object(OSISBible, 'log_debug'), \ patch.object(OSISBible, 'validate_xml_file'), \ patch.object(OSISBible, 'parse_xml'), \ patch.object(OSISBible, 'get_language_id', **{'return_value': 10}), \ patch.object(OSISBible, 'process_books'): importer = OSISBible(MagicMock(), path='.', name='.', filename='') # WHEN: Calling do_import result = importer.do_import() # THEN: do_import should return True self.assertTrue(result)
def do_import_parse_xml_fails_test(self): """ Test do_import when parse_xml fails (returns None) """ # GIVEN: An instance of OpenSongBible and a mocked parse_xml which returns False with patch.object(OSISBible, 'log_debug'), \ patch.object(OSISBible, 'validate_xml_file'), \ patch.object(OSISBible, 'parse_xml', return_value=None), \ patch.object(OSISBible, 'get_language_id') as mocked_language_id: importer = OSISBible(MagicMock(), path='.', name='.', filename='') # WHEN: Calling do_import result = importer.do_import() # THEN: do_import should return False and get_language_id should have not been called self.assertFalse(result) self.assertFalse(mocked_language_id.called)
def test_process_books_completes(self): """ Test process_books when it processes all books """ # GIVEN: An instance of OSISBible Importer and two mocked books self.mocked_find_and_create_book.side_effect = ['db_book1', 'db_book2'] with patch.object(OSISBible, 'process_chapters') as mocked_process_chapters: importer = OSISBible(MagicMock(), path='.', name='.', file_path=None) book1 = MagicMock() book1.get.return_value = 'Name1' book2 = MagicMock() book2.get.return_value = 'Name2' mocked_data = MagicMock(**{'xpath.return_value': [book1, book2]}) importer.language_id = 10 importer.session = MagicMock() importer.stop_import_flag = False # WHEN: Calling process_books with the two books importer.process_books(mocked_data) # THEN: find_and_create_book and process_books should be called with the details from the mocked books assert self.mocked_find_and_create_book.call_args_list == [ call('Name1', 2, 10), call('Name2', 2, 10) ] assert mocked_process_chapters.call_args_list == [ call('db_book1', book1), call('db_book2', book2) ] assert importer.session.commit.call_count == 2
def do_import_no_language_test(self): """ Test do_import when the user cancels the language selection dialog """ # GIVEN: An instance of OpenSongBible and a mocked get_language which returns False with patch.object(OSISBible, 'log_debug'), \ patch.object(OSISBible, 'validate_xml_file'), \ patch.object(OSISBible, 'parse_xml'), \ patch.object(OSISBible, 'get_language_id', **{'return_value': False}), \ patch.object(OSISBible, 'process_books') as mocked_process_books: importer = OSISBible(MagicMock(), path='.', name='.', filename='') # 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(mocked_process_books.called)
def process_verse_use_milestones_no_s_id_test(self): """ Test process_verse when called with use_milestones set to True, but the element supplied does not have and sID attribute """ # GIVEN: An instance of OSISBible, and some mocked test data test_book = MagicMock() test_verse = MagicMock() test_verse.get.side_effect = lambda x: {}.get(x) test_verse.tail = 'Verse Text' test_verse.text = None importer = OSISBible(MagicMock(), path='.', name='.', filename='') # WHEN: Calling process_verse with the test data importer.process_verse(test_book, 2, test_verse) # THEN: create_verse should not have been called self.assertFalse(self.mocked_create_verse.called)
def test_process_verse_use_milestones_no_tail(self): """ Test process_verse when called with use_milestones set to True, but the element supplied does not have a 'tail' """ # GIVEN: An instance of OSISBible, and some mocked test data test_book = MagicMock() test_verse = MagicMock() test_verse.tail = None test_verse.text = None test_verse.get.side_effect = lambda x: { 'osisID': '1.2.4', 'sID': '999' }.get(x) importer = OSISBible(MagicMock(), path='.', name='.', file_path=None) # WHEN: Calling process_verse with the test data importer.process_verse(test_book, 2, test_verse, use_milestones=True) # THEN: create_verse should not have been called assert self.mocked_create_verse.called is False
def test_process_verse_success(self): """ Test process_verse when called with an element with text set """ # GIVEN: An instance of OSISBible, and some mocked test data test_book = MagicMock() test_book.id = 1 test_verse = MagicMock() test_verse.tail = '\n ' # Whitespace test_verse.text = 'Verse Text' test_verse.get.side_effect = lambda x: { 'osisID': '1.2.4', 'sID': '999' }.get(x) importer = OSISBible(MagicMock(), path='.', name='.', file_path=None) # WHEN: Calling process_verse with the test data importer.process_verse(test_book, 2, test_verse) # THEN: create_verse should have been called with the test data self.mocked_create_verse.assert_called_once_with(1, 2, 4, 'Verse Text')
def test_process_verse_no_text(self): """ Test process_verse when called with an empty verse element """ # GIVEN: An instance of OSISBible, and some mocked test data test_book = MagicMock() test_book.id = 1 test_verse = MagicMock() test_verse.tail = '\n ' # Whitespace test_verse.text = None test_verse.get.side_effect = lambda x: { 'osisID': '1.2.4', 'sID': '999' }.get(x) importer = OSISBible(MagicMock(), path='.', name='.', file_path=None) # WHEN: Calling process_verse with the test data importer.process_verse(test_book, 2, test_verse) # THEN: create_verse should not have been called assert self.mocked_create_verse.called is False
def test_create_importer(self): """ Test creating an instance of the OSIS file importer """ # GIVEN: A mocked out "manager" mocked_manager = MagicMock() # WHEN: An importer object is created importer = OSISBible(mocked_manager, path='.', name='.', filename='') # THEN: The importer should be an instance of BibleDB self.assertIsInstance(importer, BibleDB)
def process_verse_use_milestones_success_test(self): """ Test process_verse when called with use_milestones set to True, and the verse element successfully imports """ # GIVEN: An instance of OSISBible, and some mocked test data test_book = MagicMock() test_book.id = 1 test_verse = MagicMock() test_verse.tail = 'Verse Text' test_verse.text = None test_verse.get.side_effect = lambda x: { 'osisID': '1.2.4', 'sID': '999' }.get(x) importer = OSISBible(MagicMock(), path='.', name='.', filename='') # WHEN: Calling process_verse with the test data importer.process_verse(test_book, 2, test_verse, use_milestones=True) # THEN: create_verse should have been called with the test data self.mocked_create_verse.assert_called_once_with(1, 2, 4, 'Verse Text')
def test_file_import_empty_verse_tags(self): """ Test the actual import of OSIS Bible file, with an empty verse tags. """ # GIVEN: Test files with a mocked out "manager", "import_wizard", and mocked functions # get_book_ref_id_by_name, create_verse, create_book, session and get_language. test_data = load_external_result_data(TEST_PATH / 'dk1933.json') bible_file = 'osis-dk1933-empty-verse.xml' with patch( 'openlp.plugins.bibles.lib.importers.osis.OSISBible.application' ): mocked_manager = MagicMock() mocked_import_wizard = MagicMock() importer = OSISBible(mocked_manager, path='.', name='.', file_path=None) importer.wizard = mocked_import_wizard importer.get_book_ref_id_by_name = MagicMock() importer.create_verse = MagicMock() importer.create_book = MagicMock() importer.session = MagicMock() importer.get_language = MagicMock() importer.get_language.return_value = 'Danish' # WHEN: Importing bible file importer.file_path = TEST_PATH / bible_file importer.do_import() # THEN: The create_verse() method should have been called with each verse in the file. assert importer.create_verse.called is True for verse_tag, verse_text in test_data['verses']: importer.create_verse.assert_any_call( importer.create_book().id, 1, verse_tag, verse_text)
def test_file_import_milestone_tags(self): """ Test the actual import of OSIS Bible file, with milestone chapter and verse tags. """ # GIVEN: Test files with a mocked out "manager", "import_wizard", and mocked functions # get_book_ref_id_by_name, create_verse, create_book, session and get_language. result_file = open(os.path.join(TEST_PATH, 'web.json'), 'rb') test_data = json.loads(result_file.read().decode()) bible_file = 'osis-web.xml' with patch( 'openlp.plugins.bibles.lib.importers.osis.OSISBible.application' ): mocked_manager = MagicMock() mocked_import_wizard = MagicMock() importer = OSISBible(mocked_manager, path='.', name='.', filename='') importer.wizard = mocked_import_wizard importer.get_book_ref_id_by_name = MagicMock() importer.create_verse = MagicMock() importer.create_book = MagicMock() importer.session = MagicMock() importer.get_language = MagicMock() importer.get_language.return_value = 'English' # WHEN: Importing bible file importer.filename = os.path.join(TEST_PATH, bible_file) importer.do_import() # THEN: The create_verse() method should have been called with each verse in the file. self.assertTrue(importer.create_verse.called) for verse_tag, verse_text in test_data['verses']: importer.create_verse.assert_any_call( importer.create_book().id, 1, verse_tag, verse_text)