Added tests.

openlp/plugins/bibles/lib/sword.py

@@ -21,8 +21,7 @@
 ###############################################################################
 
 import logging
-from lxml import etree, objectify
-from pysword import modules, bible
+from pysword import modules
 
 from openlp.core.common import translate
 from openlp.core.lib.ui import critical_error_message_box
@@ -48,7 +47,7 @@ class SwordBible(BibleDB):
         if self.sword_path == '':
             self.sword_path = None
 
-    def do_import(self, bible_name=None):
+    def do_import(self):
         """
         Loads a Bible from SWORD module.
         """
@@ -92,7 +91,7 @@ class SwordBible(BibleDB):
             critical_error_message_box(
                 message=translate('BiblesPlugin.SwordImport', 'An unexpected error happened while importing the SWORD '
                                                               'bible, please report this to the OpenLP developers.\n'
-                                                              '%s' % e.msg))
+                                                              '%s' % e))
             log.exception(str(e))
             success = False
         if self.stop_import_flag:

tests/functional/openlp_plugins/bibles/test_swordimport.py

@@ -0,0 +1,106 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection                                      #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2016 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; 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                          #
+###############################################################################
+"""
+This module contains tests for the SWORD Bible importer.
+"""
+
+import os
+import json
+from unittest import TestCase
+
+from tests.functional import MagicMock, patch
+from openlp.plugins.bibles.lib.sword import SwordBible
+from openlp.plugins.bibles.lib.db import BibleDB
+
+TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__),
+                                         '..', '..', '..', 'resources', 'bibles'))
+
+
+class TestSwordImport(TestCase):
+    """
+    Test the functions in the :mod:`swordimport` module.
+    """
+
+    def setUp(self):
+        self.registry_patcher = patch('openlp.plugins.bibles.lib.db.Registry')
+        self.registry_patcher.start()
+        self.manager_patcher = patch('openlp.plugins.bibles.lib.db.Manager')
+        self.manager_patcher.start()
+
+    def tearDown(self):
+        self.registry_patcher.stop()
+        self.manager_patcher.stop()
+
+    def create_importer_test(self):
+        """
+        Test creating an instance of the Sword file importer
+        """
+        # GIVEN: A mocked out "manager"
+        mocked_manager = MagicMock()
+
+        # WHEN: An importer object is created
+        importer = SwordBible(mocked_manager, path='.', name='.', filename='', sword_key='', sword_path='')
+
+        # THEN: The importer should be an instance of BibleDB
+        self.assertIsInstance(importer, BibleDB)
+
+    @patch('openlp.plugins.bibles.lib.sword.SwordBible.application')
+    @patch('openlp.plugins.bibles.lib.sword.modules')
+    @patch('openlp.plugins.bibles.lib.db.BiblesResourcesDB')
+    def simple_import_test(self, mocked_bible_res_db, mocked_pysword_modules, mocked_application):
+        """
+        Test that a simple SWORD import works
+        """
+        # 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.
+        #       Also mocked pysword structures
+        mocked_manager = MagicMock()
+        mocked_import_wizard = MagicMock()
+        importer = SwordBible(mocked_manager, path='.', name='.', filename='', sword_key='', sword_path='')
+        result_file = open(os.path.join(TEST_PATH, 'dk1933.json'), 'rb')
+        test_data = json.loads(result_file.read().decode())
+        importer.wizard = mocked_import_wizard
+        importer.get_book_ref_id_by_name = MagicMock()
+        importer.create_verse = MagicMock()
+        importer.create_book = MagicMock()
+        importer.session = MagicMock()
+        mocked_bible_res_db.get_language.return_value = 'Danish'
+        mocked_bible = MagicMock()
+        mocked_genesis = MagicMock()
+        mocked_genesis.name = 'Genesis'
+        mocked_genesis.num_chapters = 1
+        books = {'ot': [mocked_genesis]}
+        mocked_structure = MagicMock()
+        mocked_structure.get_books.return_value = books
+        mocked_bible.get_structure.return_value = mocked_structure
+        mocked_bible.get_iter.return_value = [verse[1] for verse in test_data['verses']]
+        mocked_module = MagicMock()
+        mocked_module.get_bible_from_module.return_value = mocked_bible
+        mocked_pysword_modules.SwordModules.return_value = mocked_module
+
+        # WHEN: Importing 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, int(verse_tag), verse_text)

tests/interfaces/openlp_plugins/bibles/forms/test_bibleimportform.py

@@ -27,7 +27,7 @@ from unittest import TestCase
 from PyQt5 import QtWidgets
 
 from openlp.core.common import Registry
-from openlp.plugins.bibles.forms.bibleimportform import BibleImportForm, WebDownload
+import openlp.plugins.bibles.forms.bibleimportform as bibleimportform
 
 from tests.helpers.testmixin import TestMixin
 from tests.functional import MagicMock, patch
@@ -46,7 +46,8 @@ class TestBibleImportForm(TestCase, TestMixin):
         self.setup_application()
         self.main_window = QtWidgets.QMainWindow()
         Registry().register('main_window', self.main_window)
-        self.form = BibleImportForm(self.main_window, MagicMock(), MagicMock())
+        bibleimportform.PYSWORD_AVAILABLE = False
+        self.form = bibleimportform.BibleImportForm(self.main_window, MagicMock(), MagicMock())
 
     def tearDown(self):
         """
@@ -76,3 +77,16 @@ class TestBibleImportForm(TestCase, TestMixin):
 
         # THEN: The webbible list should still be empty
         self.assertEqual(self.form.web_bible_list, {}, 'The webbible list should be empty')
+
+    def custom_init_test(self):
+        """
+        Test that custom_init works as expected if pysword is unavailable
+        """
+        # GIVEN: A mocked sword_tab_widget
+        self.form.sword_tab_widget = MagicMock()
+
+        # WHEN: Running custom_init
+        self.form.custom_init()
+
+        # THEN: sword_tab_widget.setDisabled(True) should have been called
+        self.form.sword_tab_widget.setDisabled.assert_called_with(True)