openlp/tests/openlp_core/common/test_utils.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/>. #
##########################################################################
"""
Interface tests to test the themeManager class and related methods.
"""
from unittest.mock import MagicMock

from openlp.core.common import is_not_image_file
from openlp.core.common.registry import Registry
from openlp.core.common.utils import wait_for, is_uuid

from tests.utils.constants import RESOURCE_PATH


def test_wait_for(registry):
    """
    Test the wait_for function
    """
    # GIVEN: Mocked app and Registry
    mock_app = MagicMock()
    Registry().register('application', mock_app)
    mock_func = MagicMock()
    mock_func.side_effect = [False, True]

    # WHEN: wait_for is run
    wait_for(mock_func)

    # THEN: the functions got called
    assert mock_func.call_count == 2


def test_uuid_not_str():
    """Test that a non-string UUID returns False"""
    assert not is_uuid(10), 'is_uuid() should return False when given something that is not a string'


def test_uuid_not_valid():
    """Test that an invalid string UUID returns False"""
    assert not is_uuid('this is a string'), 'is_uuid() should return False when given an invalid string'


def test_uuid_valid():
    """Test that an valid string UUID returns True"""
    assert is_uuid('2596ac84-9735-11ea-a665-8fa61362d04a'), 'is_uuid() should return True when given a valid UUID'


def test_is_not_image_empty():
    """
    Test the method handles an empty string
    """
    # Given and empty string
    file_name = ""

    # WHEN testing for it
    result = is_not_image_file(file_name)

    # THEN the result is false
    assert result is True, 'The missing file test should return True'


def test_is_not_image_with_image_file():
    """
    Test the method handles an image file
    """
    # Given and empty string
    file_path = RESOURCE_PATH / 'church.jpg'

    # WHEN testing for it
    result = is_not_image_file(file_path)

    # THEN the result is false
    assert result is False, 'The file is present so the test should return False'


def test_is_not_image_with_none_image_file():
    """
    Test the method handles a non image file
    """
    # Given and empty string
    file_path = RESOURCE_PATH / 'presentations' / 'test.ppt'

    # WHEN testing for it
    result = is_not_image_file(file_path)

    # THEN the result is false
    assert result is True, 'The file is not an image file so the test should return True'