openlp/tests/functional/openlp_plugins/songs/test_songshowplusimport.py

174 lines
9.0 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2019-04-13 13:00:22 +00:00
##########################################################################
# 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/>. #
##########################################################################
2013-03-24 11:32:03 +00:00
"""
This module contains tests for the SongShow Plus song importer.
2013-03-24 11:32:03 +00:00
"""
from unittest import TestCase
2018-10-02 04:39:42 +00:00
from unittest.mock import MagicMock, patch
2013-03-24 11:32:03 +00:00
from openlp.plugins.songs.lib import VerseType
2014-07-04 09:31:06 +00:00
from openlp.plugins.songs.lib.importers.songshowplus import SongShowPlusImport
from tests.helpers.songfileimport import SongImportTestHelper
2017-12-22 22:21:38 +00:00
from tests.utils.constants import RESOURCE_PATH
2013-03-24 11:32:03 +00:00
2018-10-02 04:39:42 +00:00
TEST_PATH = RESOURCE_PATH / 'songs' / 'songshowplus'
2014-03-05 18:58:22 +00:00
class TestSongShowPlusFileImport(SongImportTestHelper):
2014-03-06 20:40:08 +00:00
def __init__(self, *args, **kwargs):
self.importer_class_name = 'SongShowPlusImport'
2014-07-04 09:31:06 +00:00
self.importer_module_name = 'songshowplus'
2013-09-17 20:31:19 +00:00
super(TestSongShowPlusFileImport, self).__init__(*args, **kwargs)
def test_song_import(self):
"""
Test that loading a SongShow Plus file works correctly on various files
"""
2017-12-22 22:21:38 +00:00
self.file_import([TEST_PATH / 'Amazing Grace.sbsong'],
self.load_external_result_data(TEST_PATH / 'Amazing Grace.json'))
self.file_import([TEST_PATH / 'Beautiful Garden Of Prayer.sbsong'],
self.load_external_result_data(TEST_PATH / 'Beautiful Garden Of Prayer.json'))
self.file_import([TEST_PATH / 'a mighty fortress is our god.sbsong'],
self.load_external_result_data(TEST_PATH / 'a mighty fortress is our god.json'))
self.file_import([TEST_PATH / 'cleanse-me.sbsong'],
self.load_external_result_data(TEST_PATH / 'cleanse-me.json'))
class TestSongShowPlusImport(TestCase):
2013-03-24 11:32:03 +00:00
"""
Test the functions in the :mod:`songshowplusimport` module.
2013-03-24 11:32:03 +00:00
"""
2016-05-31 21:40:13 +00:00
def test_create_importer(self):
2013-03-24 11:32:03 +00:00
"""
Test creating an instance of the SongShow Plus file importer
"""
# GIVEN: A mocked out SongImport class, and a mocked out "manager"
2014-07-04 09:31:06 +00:00
with patch('openlp.plugins.songs.lib.importers.songshowplus.SongImport'):
2013-03-24 11:32:03 +00:00
mocked_manager = MagicMock()
# WHEN: An importer object is created
2017-09-30 20:16:30 +00:00
importer = SongShowPlusImport(mocked_manager, file_paths=[])
2013-03-24 11:32:03 +00:00
# THEN: The importer object should not be None
2017-12-22 22:20:04 +00:00
assert importer is not None, 'Import should not be none'
2013-03-24 11:32:03 +00:00
2016-05-31 21:40:13 +00:00
def test_invalid_import_source(self):
"""
2014-03-06 20:40:08 +00:00
Test SongShowPlusImport.do_import handles different invalid import_source values
"""
# GIVEN: A mocked out SongImport class, and a mocked out "manager"
2014-07-04 09:31:06 +00:00
with patch('openlp.plugins.songs.lib.importers.songshowplus.SongImport'):
mocked_manager = MagicMock()
mocked_import_wizard = MagicMock()
2017-09-30 20:16:30 +00:00
importer = SongShowPlusImport(mocked_manager, file_paths=[])
importer.import_wizard = mocked_import_wizard
importer.stop_import_flag = True
2013-03-31 10:55:58 +00:00
# WHEN: Import source is not a list
2013-08-31 18:17:38 +00:00
for source in ['not a list', 0]:
2013-03-31 10:55:58 +00:00
importer.import_source = source
2014-03-06 20:40:08 +00:00
# THEN: do_import should return none and the progress bar maximum should not be set.
2017-12-22 22:20:04 +00:00
assert importer.do_import() is None, 'do_import should return None when import_source is not a list'
assert mocked_import_wizard.progress_bar.setMaximum.called is False, \
'setMaximum on import_wizard.progress_bar should not have been called'
2013-03-28 19:50:06 +00:00
2016-05-31 21:40:13 +00:00
def test_valid_import_source(self):
2013-03-31 10:55:58 +00:00
"""
2014-03-06 20:40:08 +00:00
Test SongShowPlusImport.do_import handles different invalid import_source values
2013-03-31 10:55:58 +00:00
"""
2013-03-28 19:56:50 +00:00
# GIVEN: A mocked out SongImport class, and a mocked out "manager"
2014-07-04 09:31:06 +00:00
with patch('openlp.plugins.songs.lib.importers.songshowplus.SongImport'):
2013-03-28 19:50:06 +00:00
mocked_manager = MagicMock()
mocked_import_wizard = MagicMock()
2017-09-30 20:16:30 +00:00
importer = SongShowPlusImport(mocked_manager, file_paths=[])
2013-03-28 19:50:06 +00:00
importer.import_wizard = mocked_import_wizard
importer.stop_import_flag = True
# WHEN: Import source is a list
2013-08-31 18:17:38 +00:00
importer.import_source = ['List', 'of', 'files']
2014-03-06 20:40:08 +00:00
# THEN: do_import should return none and the progress bar setMaximum should be called with the length of
# import_source.
2017-12-22 22:20:04 +00:00
assert importer.do_import() is None, \
'do_import should return None when import_source is a list and stop_import_flag is True'
mocked_import_wizard.progress_bar.setMaximum.assert_called_with(len(importer.import_source))
2016-05-31 21:40:13 +00:00
def test_to_openlp_verse_tag(self):
2013-03-24 11:32:03 +00:00
"""
Test to_openlp_verse_tag method by simulating adding a verse
2013-03-24 11:32:03 +00:00
"""
# GIVEN: A mocked out SongImport class, and a mocked out "manager"
2014-07-04 09:31:06 +00:00
with patch('openlp.plugins.songs.lib.importers.songshowplus.SongImport'):
2013-03-24 11:32:03 +00:00
mocked_manager = MagicMock()
2017-09-30 20:16:30 +00:00
importer = SongShowPlusImport(mocked_manager, file_paths=[])
2013-03-24 11:32:03 +00:00
# WHEN: Supplied with the following arguments replicating verses being added
2014-04-02 19:35:09 +00:00
test_values = [
('Verse 1', VerseType.tags[VerseType.Verse] + '1'),
2013-08-31 18:17:38 +00:00
('Verse 2', VerseType.tags[VerseType.Verse] + '2'),
('verse1', VerseType.tags[VerseType.Verse] + '1'),
('Verse', VerseType.tags[VerseType.Verse] + '1'),
('Verse1', VerseType.tags[VerseType.Verse] + '1'),
('chorus 1', VerseType.tags[VerseType.Chorus] + '1'),
('bridge 1', VerseType.tags[VerseType.Bridge] + '1'),
('pre-chorus 1', VerseType.tags[VerseType.PreChorus] + '1'),
('different 1', VerseType.tags[VerseType.Other] + '1'),
('random 1', VerseType.tags[VerseType.Other] + '2')]
2013-03-24 11:32:03 +00:00
# THEN: The returned value should should correlate with the input arguments
for original_tag, openlp_tag in test_values:
2017-12-22 22:20:04 +00:00
assert importer.to_openlp_verse_tag(original_tag) == openlp_tag, \
'SongShowPlusImport.to_openlp_verse_tag should return "%s" when called with "%s"' % \
(openlp_tag, original_tag)
2013-03-24 11:32:03 +00:00
2016-05-31 21:40:13 +00:00
def test_to_openlp_verse_tag_verse_order(self):
"""
Test to_openlp_verse_tag method by simulating adding a verse to the verse order
"""
2013-03-28 19:50:06 +00:00
# GIVEN: A mocked out SongImport class, and a mocked out "manager"
2014-07-04 09:31:06 +00:00
with patch('openlp.plugins.songs.lib.importers.songshowplus.SongImport'):
2013-03-28 19:50:06 +00:00
mocked_manager = MagicMock()
2017-09-30 20:16:30 +00:00
importer = SongShowPlusImport(mocked_manager, file_paths=[])
2013-03-28 19:50:06 +00:00
2013-03-24 11:32:03 +00:00
# WHEN: Supplied with the following arguments replicating a verse order being added
2014-04-02 19:35:09 +00:00
test_values = [
('Verse 1', VerseType.tags[VerseType.Verse] + '1'),
2013-08-31 18:17:38 +00:00
('Verse 2', VerseType.tags[VerseType.Verse] + '2'),
('verse1', VerseType.tags[VerseType.Verse] + '1'),
('Verse', VerseType.tags[VerseType.Verse] + '1'),
('Verse1', VerseType.tags[VerseType.Verse] + '1'),
('chorus 1', VerseType.tags[VerseType.Chorus] + '1'),
('bridge 1', VerseType.tags[VerseType.Bridge] + '1'),
('pre-chorus 1', VerseType.tags[VerseType.PreChorus] + '1'),
('different 1', VerseType.tags[VerseType.Other] + '1'),
('random 1', VerseType.tags[VerseType.Other] + '2'),
('unused 2', None)]
2013-03-24 11:32:03 +00:00
# THEN: The returned value should should correlate with the input arguments
for original_tag, openlp_tag in test_values:
2017-12-22 22:20:04 +00:00
assert importer.to_openlp_verse_tag(original_tag, ignore_unique=True) == openlp_tag, \
'SongShowPlusImport.to_openlp_verse_tag should return "%s" when called with "%s"' % \
(openlp_tag, original_tag)