# -*- 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 # ############################################################################### """ Package to test the openlp.core.lib package. """ import os from unittest import TestCase from sqlalchemy.pool import NullPool from sqlalchemy.orm.scoping import ScopedSession from sqlalchemy import MetaData from openlp.core.lib.db import init_db, get_upgrade_op, delete_database from tests.functional import patch, MagicMock class TestDB(TestCase): """ A test case for all the tests for the :mod:`~openlp.core.lib.db` module. """ def init_db_calls_correct_functions_test(self): """ Test that the init_db function makes the correct function calls """ # GIVEN: Mocked out SQLAlchemy calls and return objects, and an in-memory SQLite database URL with patch('openlp.core.lib.db.create_engine') as mocked_create_engine, \ patch('openlp.core.lib.db.MetaData') as MockedMetaData, \ patch('openlp.core.lib.db.sessionmaker') as mocked_sessionmaker, \ patch('openlp.core.lib.db.scoped_session') as mocked_scoped_session: mocked_engine = MagicMock() mocked_metadata = MagicMock() mocked_sessionmaker_object = MagicMock() mocked_scoped_session_object = MagicMock() mocked_create_engine.return_value = mocked_engine MockedMetaData.return_value = mocked_metadata mocked_sessionmaker.return_value = mocked_sessionmaker_object mocked_scoped_session.return_value = mocked_scoped_session_object db_url = 'sqlite://' # WHEN: We try to initialise the db session, metadata = init_db(db_url) # THEN: We should see the correct function calls mocked_create_engine.assert_called_with(db_url, poolclass=NullPool) MockedMetaData.assert_called_with(bind=mocked_engine) mocked_sessionmaker.assert_called_with(autoflush=True, autocommit=False, bind=mocked_engine) mocked_scoped_session.assert_called_with(mocked_sessionmaker_object) self.assertIs(session, mocked_scoped_session_object, 'The ``session`` object should be the mock') self.assertIs(metadata, mocked_metadata, 'The ``metadata`` object should be the mock') def init_db_defaults_test(self): """ Test that initialising an in-memory SQLite database via ``init_db`` uses the defaults """ # GIVEN: An in-memory SQLite URL db_url = 'sqlite://' # WHEN: The database is initialised through init_db session, metadata = init_db(db_url) # THEN: Valid session and metadata objects should be returned self.assertIsInstance(session, ScopedSession, 'The ``session`` object should be a ``ScopedSession`` instance') self.assertIsInstance(metadata, MetaData, 'The ``metadata`` object should be a ``MetaData`` instance') def get_upgrade_op_test(self): """ Test that the ``get_upgrade_op`` function creates a MigrationContext and an Operations object """ # GIVEN: Mocked out alembic classes and a mocked out SQLAlchemy session object with patch('openlp.core.lib.db.MigrationContext') as MockedMigrationContext, \ patch('openlp.core.lib.db.Operations') as MockedOperations: mocked_context = MagicMock() mocked_op = MagicMock() mocked_connection = MagicMock() MockedMigrationContext.configure.return_value = mocked_context MockedOperations.return_value = mocked_op mocked_session = MagicMock() mocked_session.bind.connect.return_value = mocked_connection # WHEN: get_upgrade_op is executed with the mocked session object op = get_upgrade_op(mocked_session) # THEN: The op object should be mocked_op, and the correction function calls should have been made self.assertIs(op, mocked_op, 'The return value should be the mocked object') mocked_session.bind.connect.assert_called_with() MockedMigrationContext.configure.assert_called_with(mocked_connection) MockedOperations.assert_called_with(mocked_context) def delete_database_without_db_file_name_test(self): """ Test that the ``delete_database`` function removes a database file, without the file name parameter """ # GIVEN: Mocked out AppLocation class and delete_file method, a test plugin name and a db location with patch('openlp.core.lib.db.AppLocation') as MockedAppLocation, \ patch('openlp.core.lib.db.delete_file') as mocked_delete_file: MockedAppLocation.get_section_data_path.return_value = 'test-dir' mocked_delete_file.return_value = True test_plugin = 'test' test_location = os.path.join('test-dir', test_plugin) # WHEN: delete_database is run without a database file result = delete_database(test_plugin) # THEN: The AppLocation.get_section_data_path and delete_file methods should have been called MockedAppLocation.get_section_data_path.assert_called_with(test_plugin) mocked_delete_file.assert_called_with(test_location) self.assertTrue(result, 'The result of delete_file should be True (was rigged that way)') def delete_database_with_db_file_name_test(self): """ Test that the ``delete_database`` function removes a database file, with the file name supplied """ # GIVEN: Mocked out AppLocation class and delete_file method, a test plugin name and a db location with patch('openlp.core.lib.db.AppLocation') as MockedAppLocation, \ patch('openlp.core.lib.db.delete_file') as mocked_delete_file: MockedAppLocation.get_section_data_path.return_value = 'test-dir' mocked_delete_file.return_value = False test_plugin = 'test' test_db_file = 'mydb.sqlite' test_location = os.path.join('test-dir', test_db_file) # WHEN: delete_database is run without a database file result = delete_database(test_plugin, test_db_file) # THEN: The AppLocation.get_section_data_path and delete_file methods should have been called MockedAppLocation.get_section_data_path.assert_called_with(test_plugin) mocked_delete_file.assert_called_with(test_location) self.assertFalse(result, 'The result of delete_file should be False (was rigged that way)')