openlp/tests/openlp_core/lib/test_serviceitem.py

947 lines
44 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
2019-04-13 13:00:22 +00:00
##########################################################################
# OpenLP - Open Source Lyrics Projection #
# ---------------------------------------------------------------------- #
2020-12-30 21:42:49 +00:00
# Copyright (c) 2008-2021 OpenLP Developers #
2019-04-13 13:00:22 +00:00
# ---------------------------------------------------------------------- #
# 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/>. #
##########################################################################
2012-12-08 08:50:21 +00:00
"""
Package to test the openlp.core.lib package.
2012-12-08 08:50:21 +00:00
"""
2013-01-19 20:46:11 +00:00
import os
2020-02-15 21:04:17 +00:00
import pytest
from pathlib import Path
from unittest.mock import Mock, MagicMock, patch
2012-12-08 11:21:57 +00:00
2020-08-18 06:47:02 +00:00
from openlp.core.common import ThemeLevel, is_win
from openlp.core.common.enum import ServiceItemType
2017-10-07 07:05:07 +00:00
from openlp.core.common.registry import Registry
from openlp.core.lib.formattingtags import FormattingTags
from openlp.core.lib.serviceitem import ItemCapabilities, ServiceItem
from openlp.core.lib.theme import TransitionSpeed
2018-11-16 04:34:49 +00:00
from tests.utils import convert_file_service_item
2017-12-22 22:21:38 +00:00
from tests.utils.constants import RESOURCE_PATH
2018-10-02 04:39:42 +00:00
2013-08-31 18:17:38 +00:00
VERSE = 'The Lord said to {r}Noah{/r}: \n'\
2012-12-08 11:21:57 +00:00
'There\'s gonna be a {su}floody{/su}, {sb}floody{/sb}\n'\
'The Lord said to {g}Noah{/g}:\n'\
'There\'s gonna be a {st}floody{/st}, {it}floody{/it}\n'\
'Get those children out of the muddy, muddy \n'\
'{r}C{/r}{b}h{/b}{bl}i{/bl}{y}l{/y}{g}d{/g}{pk}'\
'r{/pk}{o}e{/o}{pp}n{/pp} of the Lord\n'
2018-12-01 05:52:49 +00:00
CLEANED_VERSE = 'Amazing Grace! how sweet the sound\n'\
'That saved a wretch like me;\n'\
'I once was lost, but now am found,\n'\
'Was blind, but now I see.\n'
2017-04-19 19:37:08 +00:00
RENDERED_VERSE = 'The Lord said to <span style="-webkit-text-fill-color:red">Noah</span>: \n'\
'There&#x27;s gonna be a <sup>floody</sup>, <sub>floody</sub>\n'\
'The Lord said to <span style="-webkit-text-fill-color:green">Noah</span>:\n'\
'There&#x27;s gonna be a <strong>floody</strong>, <em>floody</em>\n'\
'Get those children out of the muddy, muddy \n'\
'<span style="-webkit-text-fill-color:red">C</span><span style="-webkit-text-fill-color:black">h' \
'</span><span style="-webkit-text-fill-color:blue">i</span>'\
'<span style="-webkit-text-fill-color:yellow">l</span><span style="-webkit-text-fill-color:green">d'\
'</span><span style="-webkit-text-fill-color:#FFC0CB">r</span>'\
'<span style="-webkit-text-fill-color:#FFA500">e</span><span style="-webkit-text-fill-color:#800080">'\
'n</span> of the Lord\n'
2013-08-31 18:17:38 +00:00
FOOTER = ['Arky Arky (Unknown)', 'Public Domain', 'CCLI 123456']
2018-12-01 05:52:49 +00:00
TEST_PATH = RESOURCE_PATH / 'service'
2013-01-20 10:01:51 +00:00
2020-02-15 21:04:17 +00:00
@pytest.fixture()
def service_item_env(state):
# Mock the renderer and its format_slide method
mocked_renderer = MagicMock()
def side_effect_return_arg(arg1, arg2):
return [arg1]
mocked_slide_formater = MagicMock(side_effect=side_effect_return_arg)
mocked_renderer.format_slide = mocked_slide_formater
Registry().register('renderer', mocked_renderer)
2020-05-07 05:18:37 +00:00
def test_service_item_basic(settings):
2020-02-15 21:04:17 +00:00
"""
Test creating a new Service Item without a plugin
2020-02-15 21:04:17 +00:00
"""
# GIVEN: A new service item
# WHEN: A service item is created (without a plugin)
service_item = ServiceItem(None)
# THEN: We should get back a valid service item
assert service_item.is_valid is True, 'The new service item should be valid'
assert service_item.missing_frames() is True, 'There should not be any frames in the service item'
def test_service_item_with_plugin(settings):
"""
Test creating a new Service Item with a plugin
"""
# GIVEN: A new service item
mocked_plugin = MagicMock()
mocked_plugin.name = 'songs'
# WHEN: A service item is created (with a plugin)
service_item = ServiceItem(mocked_plugin)
# THEN: We should get back a valid service item
assert service_item.name == 'songs', 'The service item name should be the same as the plugin name'
assert service_item.is_valid is True, 'The new service item should be valid'
assert service_item.missing_frames() is True, 'There should not be any frames in the service item'
2020-03-11 21:53:41 +00:00
def test_service_item_load_custom_from_service(state_media, settings, service_item_env):
2020-02-15 21:04:17 +00:00
"""
Test the Service Item - adding a custom slide from a saved service
"""
# GIVEN: A new service item and a mocked add icon function
service_item = ServiceItem(None)
service_item.add_icon = MagicMock()
FormattingTags.load_tags()
# WHEN: We add a custom from a saved serviceand set the media state
line = convert_file_service_item(TEST_PATH, 'serviceitem_custom_1.osj')
service_item.set_from_service(line)
# THEN: We should get back a valid service item
assert service_item.is_valid is True, 'The new service item should be valid'
assert len(service_item.get_frames()) == 2, 'The service item should have 2 display frames'
assert len(service_item.capabilities) == 5, 'There should be 5 default custom item capabilities'
# THEN: The frames should also be valid
assert 'Test Custom' == service_item.get_display_title(), 'The title should be "Test Custom"'
assert 'Slide 1' == service_item.get_frames()[0]['text']
assert 'Slide 2' == service_item.get_rendered_frame(1)
assert 'Slide 1' == service_item.get_frame_title(0), '"Slide 1" has been returned as the title'
assert 'Slide 2' == service_item.get_frame_title(1), '"Slide 2" has been returned as the title'
assert '' == service_item.get_frame_title(2), 'Blank has been returned as the title of slide 3'
2020-03-11 21:53:41 +00:00
def test_service_item_load_image_from_service(state_media, settings):
2020-02-15 21:04:17 +00:00
"""
Test the Service Item - adding an image from a saved service
tests a version 3 service file serviceitem (openlp-servicefile-version == 3)
"""
# GIVEN: A new service item (pre encoded from the json format) and a mocked add icon function
2021-02-06 15:48:08 +00:00
image_name1 = 'BrightDots.png'
fake_hash1 = 'abcd'
image_name2 = 'DullDots.png'
fake_hash2 = 'asdf'
extracted_file = Path(TEST_PATH) / '{base}{ext}'.format(base=fake_hash1, ext=os.path.splitext(image_name1)[1])
frame_array = {'path': extracted_file, 'title': image_name1, 'file_hash': fake_hash1,
'thumbnail': Path("/path/images/thumbnails/abcd.png")}
service_item = ServiceItem(None)
service_item.add_icon = MagicMock()
2021-02-06 15:48:08 +00:00
item = {'serviceitem': {'header': {'name': 'images', 'plugin': 'images', 'theme': -1, 'title': 'My Images',
'footer': [], 'type': 2, 'audit': '', 'notes': '', 'from_plugin': False,
'capabilities': [3, 1, 5, 6, 17, 21], 'search': '', 'data': '',
'xml_version': None, 'auto_play_slides_once': False,
'auto_play_slides_loop': False, 'timed_slide_interval': 0, 'start_time': 0,
'end_time': 0, 'media_length': 0, 'background_audio': [],
'theme_overwritten': False, 'will_auto_start': False, 'processor': None,
'metadata': [], 'sha256_file_hash': None, 'stored_filename': None},
2021-02-06 15:48:08 +00:00
'data': [{'title': image_name1,
'image': Path('images/thumbnails/{}.png'.format(fake_hash1)),
'file_hash': fake_hash1},
{'title': image_name2,
'image': None,
'file_hash': fake_hash2}]}}
# WHEN: adding an image from a saved Service and mocked exists
with patch('openlp.core.ui.servicemanager.os.path.exists') as mocked_exists,\
patch('openlp.core.lib.serviceitem.AppLocation.get_section_data_path') as mocked_get_section_data_path,\
patch('openlp.core.lib.serviceitem.AppLocation.get_data_path') as mocked_get_data_path,\
patch('openlp.core.lib.serviceitem.sha256_file_hash') as mocked_sha256_file_hash,\
patch('openlp.core.lib.serviceitem.copy'),\
patch('openlp.core.lib.serviceitem.move'):
2021-02-06 15:48:08 +00:00
mocked_sha256_file_hash.side_effect = [fake_hash1, fake_hash2]
mocked_exists.return_value = True
mocked_get_section_data_path.return_value = Path('/path/')
mocked_get_data_path.return_value = Path('/path/')
service_item.set_from_service(item, TEST_PATH, 3)
2021-02-06 15:48:08 +00:00
# THEN: We should get back a valid service item,
# and the second item with no preview image should not have crashed the program
assert service_item.is_valid is True, 'The new service item should be valid'
assert extracted_file == service_item.get_rendered_frame(0), 'The first frame should match the path to the image'
assert frame_array == service_item.get_frames()[0], 'The return should match frame array1'
assert extracted_file == service_item.get_frame_path(0), \
'The frame path should match the full path to the image'
2021-02-06 15:48:08 +00:00
assert image_name1 == service_item.get_frame_title(0), 'The frame title should match the image name'
assert image_name2 == service_item.get_frame_title(1), 'The 2nd frame title should match the image name'
assert 'My Images' == service_item.get_display_title(), 'The display title should match the provided title'
assert service_item.is_image() is True, 'This service item should be of an "image" type'
def test_old_service_item_load_image_from_service(state_media, settings):
"""
Test the Service Item - adding an image from a saved service
tests a old service file serviceitem (openlp-servicefile-version < 3)
2020-02-15 21:04:17 +00:00
"""
# GIVEN: A new service item and a mocked add icon function
image_name = 'image_1.jpg'
fake_hash = 'abcd'
extracted_file = Path(TEST_PATH) / '{base}{ext}'.format(base=fake_hash, ext=os.path.splitext(image_name)[1])
frame_array = {'path': extracted_file, 'title': image_name, 'file_hash': fake_hash}
2020-02-15 21:04:17 +00:00
service_item = ServiceItem(None)
service_item.add_icon = MagicMock()
# WHEN: adding an image from a saved Service and mocked exists
line = convert_file_service_item(TEST_PATH, 'serviceitem_image_1.osj')
with patch('openlp.core.ui.servicemanager.os.path.exists') as mocked_exists,\
2020-05-07 05:18:37 +00:00
patch('openlp.core.lib.serviceitem.AppLocation.get_section_data_path') as mocked_get_section_data_path,\
patch('openlp.core.lib.serviceitem.sha256_file_hash') as mocked_sha256_file_hash,\
patch('openlp.core.lib.serviceitem.move'):
mocked_sha256_file_hash.return_value = fake_hash
2020-02-15 21:04:17 +00:00
mocked_exists.return_value = True
mocked_get_section_data_path.return_value = Path('/path/')
service_item.set_from_service(line, TEST_PATH)
# THEN: We should get back a valid service item
assert service_item.is_valid is True, 'The new service item should be valid'
assert extracted_file == service_item.get_rendered_frame(0), 'The first frame should match the path to the image'
2020-02-15 21:04:17 +00:00
assert frame_array == service_item.get_frames()[0], 'The return should match frame array1'
assert extracted_file == service_item.get_frame_path(0), \
2020-02-15 21:04:17 +00:00
'The frame path should match the full path to the image'
assert image_name == service_item.get_frame_title(0), 'The frame title should match the image name'
assert image_name == service_item.get_display_title(), 'The display title should match the first image name'
assert service_item.is_image() is True, 'This service item should be of an "image" type'
assert service_item.is_capable(ItemCapabilities.CanMaintain) is True, \
'This service item should be able to be Maintained'
assert service_item.is_capable(ItemCapabilities.CanPreview) is True, \
'This service item should be able to be be Previewed'
assert service_item.is_capable(ItemCapabilities.CanLoop) is True, \
'This service item should be able to be run in a can be made to Loop'
assert service_item.is_capable(ItemCapabilities.CanAppend) is True, \
'This service item should be able to have new items added to it'
@patch('openlp.core.lib.serviceitem.os.path.exists')
@patch('openlp.core.lib.serviceitem.AppLocation.get_section_data_path')
2020-03-11 21:53:41 +00:00
def test_service_item_load_image_from_local_service(mocked_get_section_data_path, mocked_exists, settings, state_media):
2020-02-15 21:04:17 +00:00
"""
Test the Service Item - adding an image from a saved local service
"""
# GIVEN: A new service item and a mocked add icon function
mocked_get_section_data_path.return_value = Path('/path')
mocked_exists.return_value = True
image_name1 = 'image_1.jpg'
image_name2 = 'image_2.jpg'
test_file1 = Path('/home/openlp') / image_name1
test_file2 = Path('/home/openlp') / image_name2
2020-05-07 05:18:37 +00:00
frame_array1 = {'path': test_file1, 'title': image_name1, 'file_hash': 'abcd'}
frame_array2 = {'path': test_file2, 'title': image_name2, 'file_hash': 'abcd'}
2020-02-15 21:04:17 +00:00
service_item = ServiceItem(None)
service_item.add_icon = MagicMock()
service_item2 = ServiceItem(None)
service_item2.add_icon = MagicMock()
# WHEN: adding an image from a saved Service and mocked exists
line = convert_file_service_item(TEST_PATH, 'serviceitem_image_2.osj')
line2 = convert_file_service_item(TEST_PATH, 'serviceitem_image_2.osj', 1)
2020-05-07 05:18:37 +00:00
with patch('openlp.core.lib.serviceitem.sha256_file_hash') as mocked_sha256_file_hash:
mocked_sha256_file_hash.return_value = 'abcd'
service_item2.set_from_service(line2)
service_item.set_from_service(line)
2020-02-15 21:04:17 +00:00
# THEN: We should get back a valid service item
assert service_item.is_valid is True, 'The first service item should be valid'
assert service_item2.is_valid is True, 'The second service item should be valid'
# These test will fail on windows due to the difference in folder seperators
if os.name != 'nt':
assert test_file1 == service_item.get_rendered_frame(0), \
'The first frame should match the path to the image'
assert test_file2 == service_item2.get_rendered_frame(0), \
'The Second frame should match the path to the image'
assert frame_array1 == service_item.get_frames()[0], 'The return should match the frame array1'
assert frame_array2 == service_item2.get_frames()[0], 'The return should match the frame array2'
assert test_file1 == service_item.get_frame_path(0), \
2020-02-15 21:04:17 +00:00
'The frame path should match the full path to the image'
assert test_file2 == service_item2.get_frame_path(0), \
2018-12-11 20:39:56 +00:00
'The frame path should match the full path to the image'
2020-02-15 21:04:17 +00:00
assert image_name1 == service_item.get_frame_title(0), 'The 1st frame title should match the image name'
assert image_name2 == service_item2.get_frame_title(0), 'The 2nd frame title should match the image name'
assert service_item.name == service_item.title.lower(), \
'The plugin name should match the display title, as there are > 1 Images'
assert service_item.is_image() is True, 'This service item should be of an "image" type'
assert service_item.is_capable(ItemCapabilities.CanMaintain) is True, \
'This service item should be able to be Maintained'
assert service_item.is_capable(ItemCapabilities.CanPreview) is True, \
'This service item should be able to be be Previewed'
assert service_item.is_capable(ItemCapabilities.CanLoop) is True, \
'This service item should be able to be run in a can be made to Loop'
assert service_item.is_capable(ItemCapabilities.CanAppend) is True, \
'This service item should be able to have new items added to it'
def test_add_from_text_no_verse_tag():
"""
Test the Service Item - adding text slides with no verse tag
"""
# GIVEN: A service item and two slides
service_item = ServiceItem(None)
slide1 = "This is the first slide"
slide2 = "This is the second slide"
# WHEN: adding text slides to service_item
service_item.add_from_text(slide1)
service_item.add_from_text(slide2)
# THEN: Slides should be added with correctly numbered verse tags (Should start at 1)
assert service_item.slides == [
{'text': 'This is the first slide', 'title': 'This is the first slide', 'verse': '1'},
{'text': 'This is the second slide', 'title': 'This is the second slide', 'verse': '2'}
]
2020-02-15 21:04:17 +00:00
def test_add_from_command_for_a_presentation():
"""
Test the Service Item - adding a presentation
"""
# GIVEN: A service item, a mocked icon and presentation data
service_item = ServiceItem(None)
service_item.name = 'presentations'
2020-02-15 21:04:17 +00:00
presentation_name = 'test.pptx'
image = Path('thumbnails/abcd/slide1.png')
2020-02-15 21:04:17 +00:00
display_title = 'DisplayTitle'
notes = 'Note1\nNote2\n'
frame = {'title': presentation_name, 'image': image, 'path': TEST_PATH,
'display_title': display_title, 'notes': notes, 'thumbnail': image}
# WHEN: adding presentation to service_item
with patch('openlp.core.lib.serviceitem.sha256_file_hash') as mocked_sha256_file_hash,\
patch('openlp.core.lib.serviceitem.AppLocation.get_section_data_path') as mocked_get_section_data_path:
2020-05-07 05:18:37 +00:00
mocked_sha256_file_hash.return_value = 'abcd'
mocked_get_section_data_path.return_value = Path('.')
2020-05-07 05:18:37 +00:00
service_item.add_from_command(TEST_PATH, presentation_name, image, display_title, notes)
2020-02-15 21:04:17 +00:00
# THEN: verify that it is setup as a Command and that the frame data matches
assert service_item.service_item_type == ServiceItemType.Command, 'It should be a Command'
assert service_item.get_frames()[0] == frame, 'Frames should match'
def test_add_from_command_without_display_title_and_notes():
"""
Test the Service Item - add from command, but not presentation
"""
# GIVEN: A new service item, a mocked icon and image data
service_item = ServiceItem(None)
service_item.name = 'presentations'
2020-02-15 21:04:17 +00:00
image_name = 'test.img'
image = Path('thumbnails/abcd/slide1.png')
2020-02-15 21:04:17 +00:00
frame = {'title': image_name, 'image': image, 'path': TEST_PATH,
'display_title': None, 'notes': None, 'thumbnail': image}
# WHEN: adding image to service_item
with patch('openlp.core.lib.serviceitem.sha256_file_hash') as mocked_sha256_file_hash,\
patch('openlp.core.lib.serviceitem.AppLocation.get_section_data_path') as mocked_get_section_data_path:
2020-05-07 05:18:37 +00:00
mocked_sha256_file_hash.return_value = 'abcd'
mocked_get_section_data_path.return_value = Path('.')
2020-05-07 05:18:37 +00:00
service_item.add_from_command(TEST_PATH, image_name, image)
2020-02-15 21:04:17 +00:00
# THEN: verify that it is setup as a Command and that the frame data matches
assert service_item.service_item_type == ServiceItemType.Command, 'It should be a Command'
assert service_item.get_frames()[0] == frame, 'Frames should match'
@patch('openlp.core.lib.serviceitem.AppLocation.get_section_data_path')
def test_add_from_command_for_a_presentation_thumb(mocked_get_section_data_path):
2020-02-15 21:04:17 +00:00
"""
Test the Service Item - adding a presentation, updating the thumb path & adding the thumb
2020-02-15 21:04:17 +00:00
"""
# GIVEN: A service item, a mocked AppLocation and presentation data
mocked_get_section_data_path.return_value = Path('mocked') / 'section' / 'path'
service_item = ServiceItem(None)
service_item.add_capability(ItemCapabilities.HasThumbnails)
service_item.has_original_files = False
service_item.name = 'presentations'
presentation_name = 'test.pptx'
thumb = Path('tmp') / 'test' / 'thumb.png'
display_title = 'DisplayTitle'
notes = 'Note1\nNote2\n'
2020-05-07 05:18:37 +00:00
expected_thumb_path = Path('mocked') / 'section' / 'path' / 'thumbnails' / 'abcd' / 'thumb.png'
frame = {'title': presentation_name, 'image': expected_thumb_path, 'path': str(TEST_PATH),
'display_title': display_title, 'notes': notes, 'thumbnail': expected_thumb_path}
2020-02-15 21:04:17 +00:00
# WHEN: adding presentation to service_item
2020-05-07 05:18:37 +00:00
with patch('openlp.core.lib.serviceitem.sha256_file_hash') as mocked_sha256_file_hash:
mocked_sha256_file_hash.return_value = 'abcd'
service_item.add_from_command(str(TEST_PATH), presentation_name, thumb, display_title, notes)
2020-02-15 21:04:17 +00:00
# THEN: verify that it is setup as a Command and that the frame data matches
assert service_item.service_item_type == ServiceItemType.Command, 'It should be a Command'
assert service_item.get_frames()[0] == frame, 'Frames should match'
2020-03-11 21:53:41 +00:00
def test_service_item_load_optical_media_from_service(state_media):
2020-02-15 21:04:17 +00:00
"""
Test the Service Item - load an optical media item
"""
# GIVEN: A new service item and a mocked add icon function
service_item = ServiceItem(None)
service_item.add_icon = MagicMock()
# WHEN: We load a serviceitem with optical media
line = convert_file_service_item(TEST_PATH, 'serviceitem-dvd.osj')
2020-05-07 05:18:37 +00:00
with patch('openlp.core.ui.servicemanager.os.path.exists') as mocked_exists,\
patch('openlp.core.lib.serviceitem.sha256_file_hash') as mocked_sha256_file_hash:
mocked_sha256_file_hash.return_value = 'abcd'
2018-12-01 05:52:49 +00:00
mocked_exists.return_value = True
service_item.set_from_service(line)
2020-02-15 21:04:17 +00:00
# THEN: We should get back a valid service item with optical media info
assert service_item.is_valid is True, 'The service item should be valid'
assert service_item.is_capable(ItemCapabilities.IsOptical) is True, 'The item should be Optical'
assert service_item.start_time == 654.375, 'Start time should be 654.375'
assert service_item.end_time == 672.069, 'End time should be 672.069'
assert service_item.media_length == 17.694, 'Media length should be 17.694'
2020-03-11 21:53:41 +00:00
def test_service_item_load_song_and_audio_from_service(state_media, settings, service_item_env):
2020-02-15 21:04:17 +00:00
"""
Test the Service Item - adding a song slide from a saved service
"""
# GIVEN: A new service item and a mocked add icon function
service_item = ServiceItem(None)
service_item.add_icon = MagicMock()
FormattingTags.load_tags()
# WHEN: We add a custom from a saved service
line = convert_file_service_item(TEST_PATH, 'serviceitem-song-linked-audio.osj')
service_item.set_from_service(line, Path('/test/'))
# THEN: We should get back a valid service item
assert service_item.is_valid is True, 'The new service item should be valid'
assert len(service_item.display_slides) == 6, 'The service item should have 6 display slides'
assert len(service_item.capabilities) == 7, 'There should be 7 default custom item capabilities'
assert 'Amazing Grace' == service_item.get_display_title(), 'The title should be "Amazing Grace"'
assert CLEANED_VERSE[:-1] == service_item.get_frames()[0]['text'], \
'The returned text matches the input, except the last line feed'
assert 'Amazing Grace! how sweet the s' == service_item.get_frame_title(0), \
'"Amazing Grace! how sweet the s" has been returned as the title'
assert 'Twas grace that taught my hea' == service_item.get_frame_title(1), \
'"Twas grace that taught my hea" has been returned as the title'
assert Path('/test/amazing_grace.mp3') == service_item.background_audio[0], \
'"/test/amazing_grace.mp3" should be in the background_audio list'
def test_service_item_get_theme_data_global_level(settings):
"""
Test the service item - get theme data when set to global theme level
"""
# GIVEN: A service item with a theme and theme level set to global
service_item = ServiceItem(None)
service_item.theme = 'song_theme'
mocked_theme_manager = MagicMock()
mocked_theme_manager.global_theme = 'global_theme'
mocked_theme_manager.get_theme_data = Mock(side_effect=lambda value: value)
Registry().register('theme_manager', mocked_theme_manager)
settings.setValue('servicemanager/service theme', 'service_theme')
settings.setValue('themes/theme level', ThemeLevel.Global)
# WHEN: Get theme data is run
theme = service_item.get_theme_data()
# THEN: theme should be the global theme
assert theme == mocked_theme_manager.global_theme
def test_service_item_get_theme_data_service_level_service_undefined(settings):
"""
Test the service item - get theme data when set to service theme level
"""
# GIVEN: A service item with a theme and theme level set to service
service_item = ServiceItem(None)
service_item.theme = 'song_theme'
mocked_theme_manager = MagicMock()
mocked_theme_manager.global_theme = 'global_theme'
mocked_theme_manager.get_theme_data = Mock(side_effect=lambda value: value)
Registry().register('theme_manager', mocked_theme_manager)
settings.setValue('servicemanager/service theme', 'service_theme')
settings.setValue('themes/theme level', ThemeLevel.Service)
# WHEN: Get theme data is run
theme = service_item.get_theme_data()
# THEN: theme should be the global theme
assert theme == mocked_theme_manager.global_theme
def test_service_item_get_theme_data_service_level_service_defined(settings):
"""
Test the service item - get theme data when set to service theme level
"""
# GIVEN: A service item with a theme and theme level set to service
service_item = ServiceItem(None)
service_item.theme = 'song_theme'
service_item.from_service = True
mocked_theme_manager = MagicMock()
mocked_theme_manager.global_theme = 'global_theme'
mocked_theme_manager.get_theme_data = Mock(side_effect=lambda value: value)
Registry().register('theme_manager', mocked_theme_manager)
settings.setValue('servicemanager/service theme', 'service_theme')
settings.setValue('themes/theme level', ThemeLevel.Service)
# WHEN: Get theme data is run
theme = service_item.get_theme_data()
# THEN: theme should be the service theme
assert theme == settings.value('servicemanager/service theme')
def test_service_item_get_theme_data_song_level(settings):
"""
Test the service item - get theme data when set to song theme level
"""
# GIVEN: A service item with a theme and theme level set to song
service_item = ServiceItem(None)
service_item.theme = 'song_theme'
mocked_theme_manager = MagicMock()
mocked_theme_manager.global_theme = 'global_theme'
mocked_theme_manager.get_theme_data = Mock(side_effect=lambda value: value)
Registry().register('theme_manager', mocked_theme_manager)
settings.setValue('servicemanager/service theme', 'service_theme')
settings.setValue('themes/theme level', ThemeLevel.Song)
# WHEN: Get theme data is run
theme = service_item.get_theme_data()
# THEN: theme should be the song theme
assert theme == service_item.theme
def test_service_item_get_theme_data_song_level_service_fallback(settings):
"""
Test the service item - get theme data when set to song theme level
but the song theme doesn't exist
"""
# GIVEN: A service item with no theme and theme level set to song
2020-02-15 21:04:17 +00:00
service_item = ServiceItem(None)
service_item.from_service = True
mocked_theme_manager = MagicMock()
mocked_theme_manager.global_theme = 'global_theme'
mocked_theme_manager.get_theme_data = Mock(side_effect=lambda value: value)
Registry().register('theme_manager', mocked_theme_manager)
settings.setValue('servicemanager/service theme', 'service_theme')
settings.setValue('themes/theme level', ThemeLevel.Song)
# WHEN: Get theme data is run
theme = service_item.get_theme_data()
# THEN: theme should be the serice theme
assert theme == settings.value('servicemanager/service theme')
def test_service_item_get_theme_data_song_level_global_fallback(settings):
"""
Test the service item - get theme data when set to song theme level
but the song and service theme don't exist
"""
# GIVEN: A service item with no theme and theme level set to song
2020-02-15 21:04:17 +00:00
service_item = ServiceItem(None)
mocked_theme_manager = MagicMock()
mocked_theme_manager.global_theme = 'global_theme'
mocked_theme_manager.get_theme_data = Mock(side_effect=lambda value: value)
Registry().register('theme_manager', mocked_theme_manager)
settings.setValue('servicemanager/service theme', 'service_theme')
settings.setValue('themes/theme level', ThemeLevel.Song)
# WHEN: Get theme data is run
theme = service_item.get_theme_data()
# THEN: theme should be the global theme
assert theme == mocked_theme_manager.global_theme
def test_service_item_get_theme_data_theme_override(settings):
"""
Test the service item - get theme data when set to global theme level
but the service item has the `ProvidesOwnTheme`
capability overriding the global theme
"""
# GIVEN: A service item with a theme and theme level set to global
service_item = ServiceItem(None)
service_item.theme = 'item_theme'
service_item.add_capability(ItemCapabilities.ProvidesOwnTheme)
mocked_theme_manager = MagicMock()
mocked_theme_manager.global_theme = 'global_theme'
mocked_theme_manager.get_theme_data = Mock(side_effect=lambda value: value)
Registry().register('theme_manager', mocked_theme_manager)
settings.setValue('servicemanager/service theme', 'service_theme')
settings.setValue('themes/theme level', ThemeLevel.Global)
# WHEN: Get theme data is run
theme = service_item.get_theme_data()
# THEN: theme should be the service item's theme
assert theme == service_item.theme
def test_remove_capability(settings):
# GIVEN: A service item with a capability
service_item = ServiceItem(None)
service_item.add_capability(ItemCapabilities.CanEdit)
assert ItemCapabilities.CanEdit in service_item.capabilities
# WHEN: A capability is removed
service_item.remove_capability(ItemCapabilities.CanEdit)
# THEN: The capability should no longer be there
assert ItemCapabilities.CanEdit not in service_item.capabilities, 'The capability should not be in the list'
def test_get_transition_delay_own_display(settings):
"""
Test the service item - get approx transition delay from theme
"""
# GIVEN: A service item with a theme and theme level set to global
service_item = ServiceItem(None)
service_item.add_capability(ItemCapabilities.ProvidesOwnDisplay)
service_item.theme = 'song_theme'
mocked_theme_manager = MagicMock()
mocked_theme_manager.global_theme = 'global_theme'
Registry().register('theme_manager', mocked_theme_manager)
settings.setValue('servicemanager/service theme', 'service_theme')
settings.setValue('themes/theme level', ThemeLevel.Global)
# WHEN: Get theme data is run
delay = service_item.get_transition_delay()
# THEN: theme should be 0.5s
assert delay == 0.5
def test_get_transition_delay_no_transition(settings):
"""
Test the service item - get approx transition delay from theme
"""
# GIVEN: A service item with a theme and theme level set to global
service_item = ServiceItem(None)
mocked_theme_manager = MagicMock()
mocked_theme_manager.global_theme = 'global_theme'
mocked_theme_manager.get_theme_data = Mock(return_value=MagicMock(**{
'display_slide_transition': False,
'display_slide_transition_speed': TransitionSpeed.Normal
}))
Registry().register('theme_manager', mocked_theme_manager)
settings.setValue('themes/theme level', ThemeLevel.Global)
# WHEN: Get theme data is run
delay = service_item.get_transition_delay()
# THEN: theme should be 0.5s
assert delay == 0.5
def test_get_transition_delay_normal(settings):
"""
Test the service item - get approx transition delay from theme
"""
# GIVEN: A service item with a theme and theme level set to global
service_item = ServiceItem(None)
mocked_theme_manager = MagicMock()
mocked_theme_manager.global_theme = 'global_theme'
mocked_theme_manager.get_theme_data = Mock(return_value=MagicMock(**{
'display_slide_transition': True,
'display_slide_transition_speed': TransitionSpeed.Normal
}))
Registry().register('theme_manager', mocked_theme_manager)
settings.setValue('themes/theme level', ThemeLevel.Global)
# WHEN: Get theme data is run
delay = service_item.get_transition_delay()
# THEN: theme should be 1s
assert delay == 1
def test_get_transition_delay_slow(settings):
"""
Test the service item - get approx transition delay from theme
"""
# GIVEN: A service item with a theme and theme level set to global
service_item = ServiceItem(None)
mocked_theme_manager = MagicMock()
mocked_theme_manager.global_theme = 'global_theme'
mocked_theme_manager.get_theme_data = Mock(return_value=MagicMock(**{
'display_slide_transition': True,
'display_slide_transition_speed': TransitionSpeed.Slow
}))
Registry().register('theme_manager', mocked_theme_manager)
settings.setValue('themes/theme level', ThemeLevel.Global)
# WHEN: Get theme data is run
delay = service_item.get_transition_delay()
# THEN: theme should be 2s
assert delay == 2
def test_to_dict_text_item(state_media, settings, service_item_env):
"""
Test that the to_dict() method returns the correct data for the service item
"""
# GIVEN: A ServiceItem with a service loaded from file
mocked_plugin = MagicMock()
mocked_plugin.name = 'songs'
service_item = ServiceItem(mocked_plugin)
service_item.add_icon = MagicMock()
FormattingTags.load_tags()
line = convert_file_service_item(TEST_PATH, 'serviceitem-song-linked-audio.osj')
2020-08-18 06:47:02 +00:00
if is_win():
fake_path = Path('c:\\test\\')
else:
fake_path = Path('/test/')
service_item.set_from_service(line, fake_path)
# WHEN: to_dict() is called
result = service_item.to_dict()
# THEN: The correct dictionary should be returned
2020-08-18 06:47:02 +00:00
expected_fake_path = str(fake_path / 'amazing_grace.mp3')
expected_dict = {
'audit': ['Amazing Grace', ['John Newton'], '', ''],
2020-08-18 06:47:02 +00:00
'backgroundAudio': [expected_fake_path],
'capabilities': [2, 1, 5, 8, 9, 13, 15],
'footer': ['Amazing Grace', 'Written by: John Newton'],
'fromPlugin': False,
'isThemeOverwritten': False,
'name': 'songs',
'notes': '',
'slides': [
{
2021-07-04 16:12:19 +00:00
'chords': '<span class="nochordline">'
'Amazing Grace! how sweet the sound\n'
'That saved a wretch like me;\n'
'I once was lost, but now am found,\n'
2021-07-04 16:12:19 +00:00
'Was blind, but now I see.</span>',
'html': 'Amazing Grace! how sweet the sound\n'
'That saved a wretch like me;\n'
'I once was lost, but now am found,\n'
'Was blind, but now I see.',
'selected': False,
'tag': 'V1',
'text': 'Amazing Grace! how sweet the sound\n'
'That saved a wretch like me;\n'
'I once was lost, but now am found,\n'
'Was blind, but now I see.',
'title': 'Amazing Grace',
'footer': 'Amazing Grace<br>Written by: John Newton'
},
{
2021-07-04 16:12:19 +00:00
'chords': '<span class="nochordline">'
'Twas grace that taught my heart to fear,\n'
'And grace my fears relieved;\n'
'How precious did that grace appear,\n'
2021-07-04 16:12:19 +00:00
'The hour I first believed!</span>',
'html': 'Twas grace that taught my heart to fear,\n'
'And grace my fears relieved;\n'
'How precious did that grace appear,\n'
'The hour I first believed!',
'selected': False,
'tag': 'V2',
'text': 'Twas grace that taught my heart to fear,\n'
'And grace my fears relieved;\n'
'How precious did that grace appear,\n'
'The hour I first believed!',
'title': 'Amazing Grace',
'footer': 'Amazing Grace<br>Written by: John Newton'
},
{
2021-07-04 16:12:19 +00:00
'chords': '<span class="nochordline">'
'Through many dangers, toils and snares\n'
'I have already come;\n'
'Tis grace that brought me safe thus far,\n'
2021-07-04 16:12:19 +00:00
'And grace will lead me home.</span>',
'html': 'Through many dangers, toils and snares\n'
'I have already come;\n'
'Tis grace that brought me safe thus far,\n'
'And grace will lead me home.',
'selected': False,
'tag': 'V3',
'text': 'Through many dangers, toils and snares\n'
'I have already come;\n'
'Tis grace that brought me safe thus far,\n'
'And grace will lead me home.',
'title': 'Amazing Grace',
'footer': 'Amazing Grace<br>Written by: John Newton'
},
{
2021-07-04 16:12:19 +00:00
'chords': '<span class="nochordline">'
'The Lord has promised good to me,\n'
'His word my hope secures;\n'
'He will my shield and portion be\n'
2021-07-04 16:12:19 +00:00
'As long as life endures.</span>',
'html': 'The Lord has promised good to me,\n'
'His word my hope secures;\n'
'He will my shield and portion be\n'
'As long as life endures.',
'selected': False,
'tag': 'V4',
'text': 'The Lord has promised good to me,\n'
'His word my hope secures;\n'
'He will my shield and portion be\n'
'As long as life endures.',
'title': 'Amazing Grace',
'footer': 'Amazing Grace<br>Written by: John Newton'
},
{
2021-07-04 16:12:19 +00:00
'chords': '<span class="nochordline">'
'Yes, when this heart and flesh shall fail,\n'
'And mortal life shall cease,\n'
'I shall possess within the veil\n'
2021-07-04 16:12:19 +00:00
'A life of joy and peace.</span>',
'html': 'Yes, when this heart and flesh shall fail,\n'
'And mortal life shall cease,\n'
'I shall possess within the veil\n'
'A life of joy and peace.',
'selected': False,
'tag': 'V5',
'text': 'Yes, when this heart and flesh shall fail,\n'
'And mortal life shall cease,\n'
'I shall possess within the veil\n'
'A life of joy and peace.',
'title': 'Amazing Grace',
'footer': 'Amazing Grace<br>Written by: John Newton'
},
{
2021-07-04 16:12:19 +00:00
'chords': '<span class="nochordline">'
'When weve been there a thousand years,\n'
'Bright shining as the sun,\n'
'Weve no less days to sing Gods praise\n'
2021-07-04 16:12:19 +00:00
'Than when we first begun.</span>',
'html': 'When weve been there a thousand years,\n'
'Bright shining as the sun,\n'
'Weve no less days to sing Gods praise\n'
'Than when we first begun.',
'selected': False,
'tag': 'V6',
'text': 'When weve been there a thousand years,\n'
'Bright shining as the sun,\n'
'Weve no less days to sing Gods praise\n'
'Than when we first begun.',
'title': 'Amazing Grace',
'footer': 'Amazing Grace<br>Written by: John Newton'
}
],
'theme': None,
'title': 'Amazing Grace',
2020-10-19 07:18:00 +00:00
'type': 'ServiceItemType.Text',
'data': {'authors': 'John Newton', 'title': 'amazing grace@'}
}
assert result == expected_dict
2021-02-02 09:28:20 +00:00
def test_to_dict_image_item(state_media, settings, service_item_env):
"""
Test that the to_dict() method returns the correct data for the service item
"""
# GIVEN: A ServiceItem with a service loaded from file
mocked_plugin = MagicMock()
mocked_plugin.name = 'image'
service_item = ServiceItem(mocked_plugin)
service_item.add_icon = MagicMock()
FormattingTags.load_tags()
line = convert_file_service_item(TEST_PATH, 'serviceitem_image_2.osj')
2021-02-02 09:28:20 +00:00
service_item.set_from_service(line)
# WHEN: to_dict() is called
result = service_item.to_dict()
# THEN: The correct dictionary should be returned
expected_dict = {
'audit': '',
'backgroundAudio': [],
'capabilities': [3, 1, 5, 6],
'footer': [],
'fromPlugin': False,
'isThemeOverwritten': False,
'name': 'images',
'notes': '',
'slides': [
{
'html': 'image_1.jpg',
'selected': False,
'tag': 1,
'text': 'image_1.jpg',
'title': 'Images'
}
],
'theme': -1,
'title': 'Images',
2020-10-19 07:18:00 +00:00
'type': 'ServiceItemType.Image',
'data': {}
}
assert result == expected_dict
@patch('openlp.core.lib.serviceitem.AppLocation.get_data_path')
@patch('openlp.core.lib.serviceitem.image_to_data_uri')
def test_to_dict_presentation_item(mocked_image_uri, mocked_get_data_path, state_media, settings, service_item_env):
"""
Test that the to_dict() method returns the correct data for the service item
"""
# GIVEN: A ServiceItem with a service loaded from file
mocked_plugin = MagicMock()
mocked_plugin.name = 'presentations'
service_item = ServiceItem(mocked_plugin)
service_item.capabilities = [ItemCapabilities.HasThumbnails]
presentation_name = 'test.pptx'
mocked_get_data_path.return_value = Path('/path/to/')
image = Path('thumbnails/abcd/slide1.png')
display_title = 'DisplayTitle'
notes = 'Note1\nNote2\n'
mocked_image_uri.side_effect = lambda x: 'your img uri at: {}'.format(x.as_posix())
# WHEN: adding presentation to service_item
with patch('openlp.core.lib.serviceitem.sha256_file_hash') as mocked_sha256_file_hash,\
patch('openlp.core.lib.serviceitem.AppLocation.get_section_data_path') as mocked_get_section_data_path:
mocked_sha256_file_hash.return_value = '4a067fed6834ea2bc4b8819f11636365'
mocked_get_section_data_path.return_value = Path('/path/to/presentations/')
service_item.add_from_command(TEST_PATH, presentation_name, image, display_title, notes)
# WHEN: to_dict() is called
result = service_item.to_dict()
# THEN: The correct dictionary should be returned
expected_dict = {
'audit': '',
'backgroundAudio': [],
'capabilities': [21],
'footer': [],
'fromPlugin': False,
'isThemeOverwritten': False,
'name': 'presentations',
'notes': '',
'slides': [
{
'html': 'test.pptx',
'selected': False,
'tag': 1,
'text': 'test.pptx',
'title': '',
'img': 'your img uri at: /path/to/presentations/thumbnails/4a067fed6834ea2bc4b8819f11636365/slide1.png'
}
],
'theme': None,
'title': '',
2020-10-19 07:18:00 +00:00
'type': 'ServiceItemType.Command',
'data': {}
}
assert result == expected_dict