openlp/tests/functional/openlp_plugins/bibles/test_manager.py

# -*- coding: utf-8 -*-
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4

##########################################################################
# 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/>. #
##########################################################################
"""
This module contains tests for the manager submodule of the Bibles plugin.
"""
from pathlib import Path
from unittest import TestCase
from unittest.mock import MagicMock, patch

from openlp.plugins.bibles.lib.manager import BibleManager


class TestManager(TestCase):
    """
    Test the functions in the :mod:`manager` module.
    """

    def setUp(self):
        app_location_patcher = patch('openlp.plugins.bibles.lib.manager.AppLocation')
        self.addCleanup(app_location_patcher.stop)
        app_location_patcher.start()
        log_patcher = patch('openlp.plugins.bibles.lib.manager.log')
        self.addCleanup(log_patcher.stop)
        self.mocked_log = log_patcher.start()
        settings_patcher = patch('openlp.plugins.bibles.lib.manager.Settings')
        self.addCleanup(settings_patcher.stop)
        settings_patcher.start()

    def test_delete_bible(self):
        """
        Test the BibleManager delete_bible method
        """
        # GIVEN: An instance of BibleManager and a mocked bible
        with patch.object(BibleManager, 'reload_bibles'), \
                patch('openlp.plugins.bibles.lib.manager.delete_file', return_value=True) as mocked_delete_file:
            instance = BibleManager(MagicMock())
            # We need to keep a reference to the mock for close_all as it gets set to None later on!
            mocked_close_all = MagicMock()
            mocked_bible = MagicMock(file_path='KJV.sqlite', path=Path('bibles'),
                                     **{'session.close_all': mocked_close_all})
            instance.db_cache = {'KJV': mocked_bible}

            # WHEN: Calling delete_bible with 'KJV'
            result = instance.delete_bible('KJV')

            # THEN: The session should have been closed and set to None, the bible should be deleted, and the result of
            #       the deletion returned.
            assert result is True
            mocked_close_all.assert_called_once_with()
            assert mocked_bible.session is None
            mocked_delete_file.assert_called_once_with(Path('bibles') / 'KJV.sqlite')