2013-10-13 17:02:12 +00:00
|
|
|
# -*- 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-10-13 17:02:12 +00:00
|
|
|
"""
|
|
|
|
Package to test the openlp.core.lib.theme package.
|
|
|
|
"""
|
2017-09-26 16:39:13 +00:00
|
|
|
from pathlib import Path
|
|
|
|
from unittest import TestCase
|
2013-10-13 17:02:12 +00:00
|
|
|
|
2019-07-18 19:14:58 +00:00
|
|
|
from openlp.core.lib.theme import BackgroundType, Theme
|
2019-07-03 13:23:23 +00:00
|
|
|
|
|
|
|
|
|
|
|
class TestBackgroundType(TestCase):
|
|
|
|
"""
|
|
|
|
Test the BackgroundType enum methods.
|
|
|
|
"""
|
|
|
|
def test_solid_to_string(self):
|
|
|
|
"""
|
|
|
|
Test the to_string method of :class:`BackgroundType`
|
|
|
|
"""
|
|
|
|
# GIVEN: A BackgroundType member
|
|
|
|
background_type = BackgroundType.Solid
|
|
|
|
|
|
|
|
# WHEN: Calling BackgroundType.to_string
|
|
|
|
# THEN: The string equivalent should have been returned
|
|
|
|
assert BackgroundType.to_string(background_type) == 'solid'
|
|
|
|
|
|
|
|
def test_gradient_to_string(self):
|
|
|
|
"""
|
|
|
|
Test the to_string method of :class:`BackgroundType`
|
|
|
|
"""
|
|
|
|
# GIVEN: A BackgroundType member
|
|
|
|
background_type = BackgroundType.Gradient
|
|
|
|
|
|
|
|
# WHEN: Calling BackgroundType.to_string
|
|
|
|
# THEN: The string equivalent should have been returned
|
|
|
|
assert BackgroundType.to_string(background_type) == 'gradient'
|
|
|
|
|
|
|
|
def test_image_to_string(self):
|
|
|
|
"""
|
|
|
|
Test the to_string method of :class:`BackgroundType`
|
|
|
|
"""
|
|
|
|
# GIVEN: A BackgroundType member
|
|
|
|
background_type = BackgroundType.Image
|
|
|
|
|
|
|
|
# WHEN: Calling BackgroundType.to_string
|
|
|
|
# THEN: The string equivalent should have been returned
|
|
|
|
assert BackgroundType.to_string(background_type) == 'image'
|
|
|
|
|
|
|
|
def test_transparent_to_string(self):
|
|
|
|
"""
|
|
|
|
Test the to_string method of :class:`BackgroundType`
|
|
|
|
"""
|
|
|
|
# GIVEN: A BackgroundType member
|
|
|
|
background_type = BackgroundType.Transparent
|
|
|
|
|
|
|
|
# WHEN: Calling BackgroundType.to_string
|
|
|
|
# THEN: The string equivalent should have been returned
|
|
|
|
assert BackgroundType.to_string(background_type) == 'transparent'
|
|
|
|
|
|
|
|
def test_video_to_string(self):
|
|
|
|
"""
|
|
|
|
Test the to_string method of :class:`BackgroundType`
|
|
|
|
"""
|
|
|
|
# GIVEN: A BackgroundType member
|
|
|
|
background_type = BackgroundType.Video
|
|
|
|
|
|
|
|
# WHEN: Calling BackgroundType.to_string
|
|
|
|
# THEN: The string equivalent should have been returned
|
|
|
|
assert BackgroundType.to_string(background_type) == 'video'
|
|
|
|
|
|
|
|
def test_stream_to_string(self):
|
|
|
|
"""
|
|
|
|
Test the to_string method of :class:`BackgroundType`
|
|
|
|
"""
|
|
|
|
# GIVEN: A BackgroundType member
|
|
|
|
background_type = BackgroundType.Stream
|
|
|
|
|
|
|
|
# WHEN: Calling BackgroundType.to_string
|
|
|
|
# THEN: The string equivalent should have been returned
|
|
|
|
assert BackgroundType.to_string(background_type) == 'stream'
|
2013-10-13 17:02:12 +00:00
|
|
|
|
|
|
|
|
2017-05-13 07:47:22 +00:00
|
|
|
class TestTheme(TestCase):
|
2013-10-13 17:02:12 +00:00
|
|
|
"""
|
2017-05-21 16:06:40 +00:00
|
|
|
Test the Theme class
|
2013-10-13 17:02:12 +00:00
|
|
|
"""
|
2016-07-24 20:41:27 +00:00
|
|
|
def test_new_theme(self):
|
2013-10-13 17:02:12 +00:00
|
|
|
"""
|
2017-05-13 07:47:22 +00:00
|
|
|
Test the Theme constructor
|
2013-10-13 17:02:12 +00:00
|
|
|
"""
|
2017-05-21 16:02:02 +00:00
|
|
|
# GIVEN: The Theme class
|
2016-07-24 20:41:27 +00:00
|
|
|
# WHEN: A theme object is created
|
2017-05-13 07:47:22 +00:00
|
|
|
default_theme = Theme()
|
2013-10-13 17:02:12 +00:00
|
|
|
|
2016-07-24 20:41:27 +00:00
|
|
|
# THEN: The default values should be correct
|
2017-05-13 07:47:22 +00:00
|
|
|
self.check_theme(default_theme)
|
2016-07-24 20:41:27 +00:00
|
|
|
|
|
|
|
def test_expand_json(self):
|
2013-10-13 17:02:12 +00:00
|
|
|
"""
|
2016-07-24 20:41:27 +00:00
|
|
|
Test the expand_json method
|
2013-10-13 17:02:12 +00:00
|
|
|
"""
|
2017-05-21 16:02:02 +00:00
|
|
|
# GIVEN: A Theme object and some JSON to "expand"
|
2017-05-13 07:47:22 +00:00
|
|
|
theme = Theme()
|
2016-07-24 20:41:27 +00:00
|
|
|
theme_json = {
|
|
|
|
'background': {
|
|
|
|
'border_color': '#000000',
|
|
|
|
'type': 'solid'
|
|
|
|
},
|
|
|
|
'display': {
|
|
|
|
'vertical_align': 0
|
|
|
|
},
|
|
|
|
'font': {
|
|
|
|
'footer': {
|
|
|
|
'bold': False
|
|
|
|
},
|
|
|
|
'main': {
|
|
|
|
'name': 'Arial'
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2013-10-13 17:02:12 +00:00
|
|
|
|
2017-05-21 16:02:02 +00:00
|
|
|
# WHEN: Theme.expand_json() is run
|
2016-07-24 20:41:27 +00:00
|
|
|
theme.expand_json(theme_json)
|
|
|
|
|
|
|
|
# THEN: The attributes should be set on the object
|
2017-05-13 07:47:22 +00:00
|
|
|
self.check_theme(theme)
|
2016-07-24 20:41:27 +00:00
|
|
|
|
|
|
|
def test_extend_image_filename(self):
|
2013-10-13 17:02:12 +00:00
|
|
|
"""
|
2016-07-24 20:41:27 +00:00
|
|
|
Test the extend_image_filename method
|
2013-10-13 17:02:12 +00:00
|
|
|
"""
|
2016-07-24 20:41:27 +00:00
|
|
|
# GIVEN: A theme object
|
2017-05-13 07:47:22 +00:00
|
|
|
theme = Theme()
|
2017-09-26 16:39:13 +00:00
|
|
|
theme.theme_name = 'MyBeautifulTheme'
|
|
|
|
theme.background_filename = Path('video.mp4')
|
2016-07-24 20:41:27 +00:00
|
|
|
theme.background_type = 'video'
|
2017-09-26 16:39:13 +00:00
|
|
|
path = Path.home()
|
2013-10-13 17:02:12 +00:00
|
|
|
|
2017-05-21 16:02:02 +00:00
|
|
|
# WHEN: Theme.extend_image_filename is run
|
2016-07-24 20:41:27 +00:00
|
|
|
theme.extend_image_filename(path)
|
|
|
|
|
|
|
|
# THEN: The filename of the background should be correct
|
2017-09-26 16:39:13 +00:00
|
|
|
expected_filename = path / 'MyBeautifulTheme' / 'video.mp4'
|
2017-12-17 17:52:17 +00:00
|
|
|
assert expected_filename == theme.background_filename
|
|
|
|
assert 'MyBeautifulTheme' == theme.theme_name
|
2017-05-13 07:47:22 +00:00
|
|
|
|
|
|
|
def test_save_retrieve(self):
|
|
|
|
"""
|
|
|
|
Load a dummy theme, save it and reload it
|
|
|
|
"""
|
|
|
|
# GIVEN: The default Theme class
|
|
|
|
# WHEN: A theme object is created
|
|
|
|
default_theme = Theme()
|
|
|
|
# THEN: The default values should be correct
|
2017-05-24 19:31:48 +00:00
|
|
|
save_theme_json = default_theme.export_theme()
|
2017-05-13 07:47:22 +00:00
|
|
|
lt = Theme()
|
|
|
|
lt.load_theme(save_theme_json)
|
|
|
|
self.check_theme(lt)
|
|
|
|
|
|
|
|
def check_theme(self, theme):
|
2017-12-17 17:52:17 +00:00
|
|
|
assert '#000000' == theme.background_border_color, 'background_border_color should be "#000000"'
|
|
|
|
assert 'solid' == theme.background_type, 'background_type should be "solid"'
|
|
|
|
assert 0 == theme.display_vertical_align, 'display_vertical_align should be 0'
|
|
|
|
assert theme.font_footer_bold is False, 'font_footer_bold should be False'
|
|
|
|
assert 'Arial' == theme.font_main_name, 'font_main_name should be "Arial"'
|
2019-08-06 21:33:43 +00:00
|
|
|
assert 48 == len(theme.__dict__), 'The theme should have 48 attributes'
|