Add test for deleting columns in a db

openlp/core/utils/db.py

@@ -69,5 +69,5 @@ def drop_columns(op, tablename, columns):
     op.rename_table(new_tablename, tablename)
 
 
-def drop_column(tablename, columnname):
-    drop_column(tablename, [columnname])
+def drop_column(op, tablename, columnname):
+    drop_columns(op, tablename, [columnname])

tests/functional/openlp_core_utils/test_db.py

@@ -0,0 +1,96 @@
+# -*- 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.utils.db package.
+"""
+import os
+import shutil
+import sqlalchemy
+from unittest import TestCase
+from tempfile import mkdtemp
+
+from openlp.core.utils.db import drop_column, drop_columns
+from openlp.core.lib.db import init_db, get_upgrade_op
+from tests.utils.constants import TEST_RESOURCES_PATH
+
+
+class TestUtilsDBFunctions(TestCase):
+
+    def setUp(self):
+        """
+        Create temp folder for keeping db file
+        """
+        self.tmp_folder = mkdtemp()
+
+    def tearDown(self):
+        """
+        Clean up
+        """
+        shutil.rmtree(self.tmp_folder)
+
+    def delete_column_test(self):
+        """
+        Test deleting a single column in a table
+        """
+        # GIVEN: A temporary song db
+        db_path = os.path.join(TEST_RESOURCES_PATH, 'songs', 'songs-1.9.7.sqlite')
+        db_tmp_path = os.path.join(self.tmp_folder, 'songs-1.9.7.sqlite')
+        shutil.copyfile(db_path, db_tmp_path)
+        db_url = 'sqlite:///' + db_tmp_path
+        session, metadata = init_db(db_url)
+        op = get_upgrade_op(session)
+
+        # WHEN: Deleting a columns in a table
+        drop_column(op, 'songs', 'song_book_id')
+
+        # THEN: The column should have been deleted
+        meta = sqlalchemy.MetaData(bind=op.get_bind())
+        meta.reflect()
+        columns = meta.tables['songs'].columns
+
+        for column in columns:
+            if column.name == 'song_book_id':
+                self.fail("The column 'song_book_id' should have been deleted.")
+
+    def delete_columns_test(self):
+        """
+        Test deleting multiple columns in a table
+        """
+        # GIVEN: A temporary song db
+        db_path = os.path.join(TEST_RESOURCES_PATH, 'songs', 'songs-1.9.7.sqlite')
+        db_tmp_path = os.path.join(self.tmp_folder, 'songs-1.9.7.sqlite')
+        shutil.copyfile(db_path, db_tmp_path)
+        db_url = 'sqlite:///' + db_tmp_path
+        session, metadata = init_db(db_url)
+        op = get_upgrade_op(session)
+
+        # WHEN: Deleting a columns in a table
+        drop_columns(op, 'songs', ['song_book_id', 'song_number'])
+
+        # THEN: The columns should have been deleted
+        meta = sqlalchemy.MetaData(bind=op.get_bind())
+        meta.reflect()
+        columns = meta.tables['songs'].columns
+
+        for column in columns:
+            if column.name == 'song_book_id' or column.name == 'song_number':
+                self.fail("The column '%s' should have been deleted." % column.name)

tests/functional/openlp_plugins/songs/test_db.py

@@ -209,7 +209,7 @@ class TestDB(TestCase):
         # WHEN: upgrading the db
         updated_to_version, latest_version = upgrade_db(db_url, upgrade)
 
-        # Then the song db should have been upgraded to the latest version
+        # THEN: the song db should have been upgraded to the latest version
         self.assertEqual(updated_to_version, latest_version,
                          'The song DB should have been upgrade to the latest version')
 
@@ -226,6 +226,6 @@ class TestDB(TestCase):
         # WHEN: upgrading the db
         updated_to_version, latest_version = upgrade_db(db_url, upgrade)
 
-        # Then the song db should have been upgraded to the latest version without errors
+        # THEN: the song db should have been upgraded to the latest version without errors
         self.assertEqual(updated_to_version, latest_version,
                          'The song DB should have been upgrade to the latest version')