openlp/tests/openlp_plugins/bibles/test_osisimport.py

# -*- coding: utf-8 -*-

##########################################################################
# OpenLP - Open Source Lyrics Projection                                 #
# ---------------------------------------------------------------------- #
# Copyright (c) 2008-2024 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/>. #
##########################################################################
"""
This module contains tests for the OSIS Bible importer.
"""
from unittest.mock import MagicMock, call, patch

import pytest

from openlp.core.common.registry import Registry
from openlp.core.common.settings import Settings
from openlp.plugins.bibles.lib.db import BibleDB
from openlp.plugins.bibles.lib.importers.osis import OSISBible
from tests.utils import load_external_result_data
from tests.utils.constants import RESOURCE_PATH


TEST_PATH = RESOURCE_PATH / 'bibles'


@pytest.fixture
def importer(registry: Registry, settings: Settings) -> OSISBible:
    yield OSISBible(MagicMock(), path='.', name='.', file_path=None)


# @patch('openlp.plugins.bibles.lib.importers.osis.etree')
# @patch('openlp.plugins.bibles.lib.db.BibleDB.create_verse')
# @patch.object(BibleImport, 'find_and_create_book')
# @patch('openlp.plugins.bibles.lib.bibleimport.Registry')
# @patch('openlp.plugins.bibles.lib.db.DBManager')


def test_create_importer(importer: OSISBible):
    """
    Test creating an instance of the OSIS file importer
    """
    # GIVEN: A mocked out "manager"
    # WHEN: An importer object is created
    # THEN: The importer should be an instance of BibleDB
    assert isinstance(importer, BibleDB)


def test_process_books_stop_import(importer):
    """
    Test process_books when stop_import is set to True
    """
    # GIVEN: An instance of OSISBible adn some mocked data
    mocked_data = MagicMock(**{'xpath.return_value': ['Book']})

    # WHEN: stop_import_flag is set to True and process_books is called
    with patch.object(importer, 'find_and_create_book') as mocked_find_and_create_book:
        importer.stop_import_flag = True
        importer.process_books(mocked_data)

    # THEN: find_and_create_book should not have been called
    assert mocked_find_and_create_book.called is False


@patch('openlp.plugins.bibles.lib.importers.osis.etree')
def test_process_books_completes(mocked_etree: MagicMock, importer: OSISBible):
    """
    Test process_books when it processes all books
    """
    # GIVEN: An instance of OSISBible Importer and two mocked books
    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
    with patch.object(importer, 'find_and_create_book') as mocked_find_and_create_book, \
            patch.object(importer, 'process_chapters') as mocked_process_chapters:
        mocked_find_and_create_book.side_effect = ['db_book1', 'db_book2']
        importer.process_books(mocked_data)

    # THEN: find_and_create_book and process_books should be called with the details from the mocked books
    assert 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


@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)
def test_process_chapters_verse_in_chapter_verse_text(mocked_verse_in_chapter: MagicMock,
                                                      mocked_text_in_verse: MagicMock, importer: OSISBible):
    """
    Test process_chapters when supplied with an etree element with a verse element nested in it
    """

    # 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)

    # WHEN: Calling process_chapters
    with patch.object(importer, 'set_current_chapter') as mocked_set_current_chapter, \
            patch.object(importer, 'process_verse') as mocked_process_verse:
        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)


@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=False)
def test_process_chapters_verse_in_chapter_verse_milestone(mocked_text_in_verse: MagicMock,
                                                           mocked_verse_in_chapter: MagicMock, importer: OSISBible):
    """
    Test process_chapters when supplied with an etree element with a verse element nested, when the verse system is
    based on milestones
    """
    # 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)

    # WHEN: Calling process_chapters
    with patch.object(importer, 'set_current_chapter') as mocked_set_current_chapter, \
            patch.object(importer, 'process_verse') as mocked_process_verse:
        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, use_milestones=True)


@patch('openlp.plugins.bibles.lib.importers.osis.verse_in_chapter', return_value=False)
def test_process_chapters_milestones_chapter_no_sid(mocked_verse_in_chapter: MagicMock, importer: OSISBible):
    """
    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)
    """
    # 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
    with patch.object(OSISBible, 'set_current_chapter') as mocked_set_current_chapter, \
            patch.object(OSISBible, 'process_verse') as mocked_process_verse:
        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


@patch('openlp.plugins.bibles.lib.importers.osis.verse_in_chapter', return_value=False)
def test_process_chapters_milestones_chapter_sid(mocked_verse_in_chapter: MagicMock, importer: OSISBible):
    """
    Test process_chapters when supplied with an etree element with a chapter and verse element in the milestone
    configuration, where the chapter is the "opening" milestone. (Has the sID attribute)
    """
    # 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', 'sID': '999'}.get(x)

    # WHEN: Calling process_chapters
    with patch.object(OSISBible, 'set_current_chapter') as mocked_set_current_chapter, \
            patch.object(OSISBible, 'process_verse') as mocked_process_verse:
        importer.process_chapters(test_book, [test_chapter])

    # THEN: set_current_chapter should have been called with the test data
    mocked_set_current_chapter.assert_called_once_with(test_book.name, 2)
    assert mocked_process_verse.called is False


@patch('openlp.plugins.bibles.lib.importers.osis.verse_in_chapter', return_value=False)
def test_process_chapters_milestones_verse_tag(mocked_verse_in_chapter: MagicMock, importer: OSISBible):
    """
    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)
    """
    # 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
    with patch.object(OSISBible, 'set_current_chapter') as mocked_set_current_chapter, \
            patch.object(OSISBible, 'process_verse') as mocked_process_verse:
        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_verse_no_osis_id(importer: OSISBible):
    """
    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

    # WHEN: Calling process_verse with the test data
    with patch.object(importer, 'create_verse') as mocked_create_verse:
        importer.process_verse(test_book, 2, test_verse)

    # THEN: create_verse should not have been called
    assert mocked_create_verse.called is False


def test_process_verse_use_milestones_no_s_id(importer: OSISBible):
    """
    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

    # WHEN: Calling process_verse with the test data
    with patch.object(importer, 'create_verse') as mocked_create_verse:
        importer.process_verse(test_book, 2, test_verse)

    # THEN: create_verse should not have been called
    assert mocked_create_verse.called is False


def test_process_verse_use_milestones_no_tail(importer: OSISBible):
    """
    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)

    # WHEN: Calling process_verse with the test data
    with patch.object(importer, 'create_verse') as mocked_create_verse:
        importer.process_verse(test_book, 2, test_verse, use_milestones=True)

    # THEN: create_verse should not have been called
    assert mocked_create_verse.called is False


def test_process_verse_use_milestones_success(importer: OSISBible):
    """
    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)

    # WHEN: Calling process_verse with the test data
    with patch.object(importer, 'create_verse') as mocked_create_verse:
        importer.process_verse(test_book, 2, test_verse, use_milestones=True)

    # THEN: create_verse should have been called with the test data
    mocked_create_verse.assert_called_once_with(1, 2, 4, 'Verse Text')


def test_process_verse_no_text(importer: OSISBible):
    """
    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)

    # WHEN: Calling process_verse with the test data
    with patch.object(importer, 'create_verse') as mocked_create_verse:
        importer.process_verse(test_book, 2, test_verse)

    # THEN: create_verse should not have been called
    assert mocked_create_verse.called is False


def test_process_verse_success(importer: OSISBible):
    """
    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)

    # WHEN: Calling process_verse with the test data
    with patch.object(importer, 'create_verse') as mocked_create_verse:
        importer.process_verse(test_book, 2, test_verse)

    # THEN: create_verse should have been called with the test data
    mocked_create_verse.assert_called_once_with(1, 2, 4, 'Verse Text')


def test_do_import_parse_xml_fails(importer: OSISBible):
    """
    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(importer, 'log_debug'), \
            patch.object(importer, 'validate_xml_file'), \
            patch.object(importer, 'parse_xml', return_value=None), \
            patch.object(importer, 'get_language_id') as mocked_language_id:

        # WHEN: Calling do_import
        result = importer.do_import()

    # THEN: do_import should return False and get_language_id should have not been called
    assert result is False
    assert mocked_language_id.called is False


def test_do_import_no_language(importer: OSISBible):
    """
    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(importer, 'log_debug'), \
            patch.object(importer, 'validate_xml_file'), \
            patch.object(importer, 'parse_xml'), \
            patch.object(importer, 'get_language_id', **{'return_value': False}), \
            patch.object(importer, 'process_books') as mocked_process_books:

        # WHEN: Calling do_import
        result = importer.do_import()

    # THEN: do_import should return False and process_books should have not been called
    assert result is False
    assert mocked_process_books.called is False


def test_do_import_completes(importer: OSISBible):
    """
    Test do_import when it completes successfully
    """
    # GIVEN: An instance of OpenSongBible
    with patch.object(importer, 'log_debug'), \
            patch.object(importer, 'validate_xml_file'), \
            patch.object(importer, 'parse_xml'), \
            patch.object(importer, 'get_language_id', **{'return_value': 10}), \
            patch.object(importer, 'process_books'):

        # WHEN: Calling do_import
        result = importer.do_import()

    # THEN: do_import should return True
    assert result is True


def test_file_import_nested_tags(importer: OSISBible):
    """
    Test the actual import of OSIS Bible file, with nested 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.
    test_data = load_external_result_data(TEST_PATH / 'dk1933.json')
    bible_file = 'osis-dk1933.xml'
    mocked_import_wizard = MagicMock()
    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'
    importer.get_language_id = MagicMock()
    importer.get_language_id.return_value = 'dk'

    # 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_mixed_tags(importer: OSISBible):
    """
    Test the actual import of OSIS Bible file, with chapter tags containing milestone 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 / 'kjv.json')
    bible_file = 'osis-kjv.xml'
    mocked_import_wizard = MagicMock()
    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'
    importer.get_language_id = MagicMock()
    importer.get_language_id.return_value = 'en'

    # 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(importer: OSISBible):
    """
    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.
    test_data = load_external_result_data(TEST_PATH / 'web.json')
    bible_file = 'osis-web.xml'
    mocked_import_wizard = MagicMock()
    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'
    importer.get_language_id = MagicMock()
    importer.get_language_id.return_value = 'en'

    # 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
    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_empty_verse_tags(importer: OSISBible):
    """
    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'
    mocked_import_wizard = MagicMock()
    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'
    importer.get_language_id = MagicMock()
    importer.get_language_id.return_value = 'dk'

    # 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)