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

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

##########################################################################
# OpenLP - Open Source Lyrics Projection                                 #
# ---------------------------------------------------------------------- #
# Copyright (c) 2008-2020 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 OpenSong song importer.
"""
from openlp.core.common.registry import Registry
from tests.helpers.songfileimport import SongImportTestHelper
from tests.utils.constants import RESOURCE_PATH


TEST_PATH = RESOURCE_PATH / 'songs' / 'chordpro'


def test_chordpro(mock_settings):

    class TestChordProFileImport(SongImportTestHelper):

        def __init__(self, *args, **kwargs):
            self.importer_class_name = 'ChordProImport'
            self.importer_module_name = 'chordpro'
            super().__init__(*args, **kwargs)

        def test_song_import(self):
            """
            Test that loading an ChordPro file works correctly on various files
            """
            # Mock out the settings - always return False
            Registry().get('settings').value.side_effect = lambda value: True \
                if value == 'songs/enable chords' else False
            # Do the test import
            self.file_import([TEST_PATH / 'swing-low.chordpro'],
                             self.load_external_result_data(TEST_PATH / 'swing-low.json'))

    test_file_import = TestChordProFileImport()
    test_file_import.setUp()
    test_file_import.test_song_import()
    test_file_import.tearDown()