openlp/tests/openlp_plugins/planningcenter/test_planningcenterplugin.py

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

##########################################################################
# OpenLP - Open Source Lyrics Projection                                 #
# ---------------------------------------------------------------------- #
# Copyright (c) 2008-2022 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/>. #
##########################################################################
"""
Package to test the openlp.plugins.planningcenter.planningcenterplugin package.
"""
import pytest
from unittest.mock import MagicMock, patch

from PyQt5 import QtWidgets

from openlp.core.common.settings import Settings
from openlp.core.state import State
from openlp.core.ui.icons import UiIcons
from openlp.core.ui.settingsform import SettingsForm
from openlp.plugins.planningcenter.planningcenterplugin import PlanningCenterPlugin


@pytest.fixture
def plugin_env(qapp, settings, state):
    """An instance of the PlanningcenterPlugin"""
    plugin = PlanningCenterPlugin()
    settings_form = SettingsForm()
    return plugin, settings_form


def test_class_init_defaults(plugin_env):
    """
    Test that the plugin class is instantiated with the correct defaults
    """
    plugin = plugin_env[0]
    # GIVEN: A PlanningcenterPlugin Class
    # WHEN:  the class has been through __init__
    # THEN:
    # planningcenter form is set to None
    assert plugin.planningcenter_form is None, "Init plugin set to None"
    # icon is set correctly
    assert plugin.icon == UiIcons().planning_center, "Init icon set to planning_center icon"
    # weight is -1
    assert plugin.weight == -1, "Init weight set to -1"
    # the planning_center module is registered active
    assert State().is_module_active('planning_center') is True, "Init State() is active"


def test_initialise(plugin_env):
    """
    Test that the initialise function can be called and it passes a call along
    to its parent class
    """
    plugin = plugin_env[0]
    # GIVEN: A PlanningcenterPlugin Class
    # WHEN:  initialise has been called on the class
    with patch('openlp.plugins.planningcenter.planningcenterplugin.PlanningCenterPlugin.import_planning_center',
               create=True):
        return_value = plugin.initialise()
    # THEN:
    # the function returns and does not fail... it doesn't do much at this point, so this
    # is mainly to improve test coverage
    assert return_value is None, "Initialise was called on the class and it didn't crash"


def test_import_menu_item_added(plugin_env):
    """
    Test that the add_import_menu_item function adds the menu item
    """
    plugin = plugin_env[0]
    # GIVEN: A PlanningcenterPlugin Class
    # WHEN:  add_import_menu_item is called
    import_menu = QtWidgets.QMenu()
    plugin.add_import_menu_item(import_menu)
    plugin.import_planning_center.setVisible(True)
    # THEN:
    # the menu should not be empty
    assert import_menu.isEmpty() is False, "Menu Item is populated"


@patch('openlp.plugins.planningcenter.forms.selectplanform.SelectPlanForm.exec')
@patch('openlp.core.ui.settingsform.SettingsForm.exec')
def test_on_import_planning_center_triggered_with_auth_settings(mock_editauth_exec, mock_selectplan_exec, plugin_env):
    """
    Test that the on_import_planning_center_triggered function correctly returns
    the correct form to display.
    """
    plugin = plugin_env[0]
    # GIVEN: A PlanningCenterPlugin Class with mocked exec calls on both
    # PlanningCenter forms and settings set
    application_id = 'abc'
    secret = '123'
    Settings().setValue('planningcenter/application_id', application_id)
    Settings().setValue('planningcenter/secret', secret)
    # init the planning center plugin so we have default values defined for Settings()
    # WHEN:  on_import_planning_center_triggered is called
    plugin.on_import_planning_center_triggered()
    # THEN:
    assert mock_selectplan_exec.call_count == 1, "Select Plan Form was shown"
    assert mock_editauth_exec.call_count == 0, "Edit Auth Form was not shown"


@patch('openlp.plugins.planningcenter.forms.selectplanform.SelectPlanForm.exec')
@patch('openlp.core.ui.settingsform.SettingsForm.exec')
def test_on_import_planning_center_triggered_without_auth_settings(mock_editauth_exec,
                                                                   mock_selectplan_exec, plugin_env):
    """
    Test that the on_import_planning_center_triggered function correctly returns
    the correct form to display.
    """
    plugin = plugin_env[0]
    # GIVEN: A PlanningCenterPlugin Class with mocked exec calls on both
    # PlanningCenter forms and settings set
    application_id = ''
    secret = ''
    Settings().setValue('planningcenter/application_id', application_id)
    Settings().setValue('planningcenter/secret', secret)
    # init the planning center plugin so we have default values defined for Settings()
    # WHEN:  on_import_planning_center_triggered is called
    plugin.on_import_planning_center_triggered()
    # THEN:
    assert mock_selectplan_exec.call_count == 0, "Select Plan Form was not shown"
    assert mock_editauth_exec.call_count == 1, "Edit Auth Form was shown"


def test_finalise(plugin_env):
    """
    Test that the finalise function cleans up after the plugin
    """
    plugin = plugin_env[0]
    # GIVEN: A PlanningcenterPlugin Class with a bunch of mocks
    plugin.import_planning_center = MagicMock()

    # WHEN: finalise has been called on the class
    plugin.finalise()

    # THEN: it cleans up after itself
    plugin.import_planning_center.setVisible.assert_called_once_with(False)


def test_about(plugin_env):
    plugin = plugin_env[0]
    result = plugin.about()

    assert result == (
        '<strong>PlanningCenter Plugin</strong>'
        '<br />The planningcenter plugin provides an interface to import '
        'service plans from the Planning Center Online v2 API.'
    )