def build_service_item(self, item=None, xml_version=False, remote=False, context=ServiceItemContext.Live): """ Common method for generating a service item """ service_item = ServiceItem(self.plugin) service_item.add_icon(self.plugin.icon_path) if self.generate_slide_data(service_item, item, xml_version, remote, context): return service_item else: return None
def serviceitem_load_image_from_local_service_test(self): """ Test the Service Item - adding an image from a saved local service """ # GIVEN: A new service item and a mocked add icon function image_name1 = 'image_1.jpg' image_name2 = 'image_2.jpg' test_file1 = os.path.join('/home/openlp', image_name1) test_file2 = os.path.join('/home/openlp', image_name2) frame_array1 = {'path': test_file1, 'title': image_name1} frame_array2 = {'path': test_file2, 'title': image_name2} 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 = self.convert_file_service_item('serviceitem_image_2.osj') line2 = self.convert_file_service_item('serviceitem_image_2.osj', 1) with patch('openlp.core.ui.servicemanager.os.path.exists') as mocked_exists: mocked_exists.return_value = True service_item2.set_from_service(line2) service_item.set_from_service(line) # THEN: We should get back a valid service item # This test is copied from service_item.py, but is changed since to conform to # new layout of service item. The layout use in serviceitem_image_2.osd is actually invalid now. 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' assert service_item.get_rendered_frame(0) == test_file1, 'The first frame should match the path to the image' assert service_item2.get_rendered_frame(0) == test_file2, 'The Second frame should match the path to the image' assert service_item.get_frames()[0] == frame_array1, 'The return should match the frame array1' assert service_item2.get_frames()[0] == frame_array2, 'The return should match the frame array2' assert service_item.get_frame_path(0) == test_file1, 'The frame path should match the full path to the image' assert service_item2.get_frame_path(0) == test_file2, 'The frame path should match the full path to the image' assert service_item.get_frame_title(0) == image_name1, 'The 1st frame title should match the image name' assert service_item2.get_frame_title(0) == image_name2, 'The 2nd frame title should match the image name' assert service_item.title.lower() == service_item.name, \ '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 build_service_item(self, item=None, xml_version=False, remote=False, context=ServiceItemContext.Live): """ Common method for generating a service item :param item: Service Item to be built. :param xml_version: version of XML (False) :param remote: Remote triggered (False) :param context: The context on which this is called """ service_item = ServiceItem(self.plugin) service_item.add_icon(self.plugin.icon_path) if self.generate_slide_data(service_item, item, xml_version, remote, context): return service_item else: return None
def service_item_load_custom_from_service_test(self): """ 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() # WHEN: We add a custom from a saved service 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 self.assertTrue(service_item.is_valid, 'The new service item should be valid') assert_length(0, service_item._display_frames, 'The service item should have no display frames') assert_length(5, service_item.capabilities, 'There should be 5 default custom item capabilities') # WHEN: We render the frames of the service item service_item.render(True) # THEN: The frames should also be valid self.assertEqual('Test Custom', service_item.get_display_title(), 'The title should be "Test Custom"') self.assertEqual(VERSE[:-1], service_item.get_frames()[0]['text'], 'The returned text matches the input, except the last line feed') self.assertEqual(VERSE.split('\n', 1)[0], service_item.get_rendered_frame(1), 'The first line has been returned') self.assertEqual('Slide 1', service_item.get_frame_title(0), '"Slide 1" has been returned as the title') self.assertEqual('Slide 2', service_item.get_frame_title(1), '"Slide 2" has been returned as the title') self.assertEqual('', service_item.get_frame_title(2), 'Blank has been returned as the title of slide 3')
def service_item_load_song_and_audio_from_service_test(self): """ 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() # 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, '/test/') # THEN: We should get back a valid service item self.assertTrue(service_item.is_valid, 'The new service item should be valid') assert_length(0, service_item._display_frames, 'The service item should have no display frames') assert_length(7, service_item.capabilities, 'There should be 7 default custom item capabilities') # WHEN: We render the frames of the service item service_item.render(True) # THEN: The frames should also be valid self.assertEqual('Amazing Grace', service_item.get_display_title(), 'The title should be "Amazing Grace"') self.assertEqual(VERSE[:-1], service_item.get_frames()[0]['text'], 'The returned text matches the input, except the last line feed') self.assertEqual(VERSE.split('\n', 1)[0], service_item.get_rendered_frame(1), 'The first line has been returned') self.assertEqual('Amazing Grace! how sweet the s', service_item.get_frame_title(0), '"Amazing Grace! how sweet the s" has been returned as the title') self.assertEqual('’Twas grace that taught my hea', service_item.get_frame_title(1), '"’Twas grace that taught my hea" has been returned as the title') self.assertEqual('/test/amazing_grace.mp3', service_item.background_audio[0], '"/test/amazing_grace.mp3" should be in the background_audio list')
def serviceitem_load_image_from_service_test(self): """ Test the Service Item - adding an image from a saved service """ # GIVEN: A new service item and a mocked add icon function image_name = 'image_1.jpg' test_file = os.path.join(TEST_PATH, image_name) frame_array = {'path': test_file, 'title': image_name} service_item = ServiceItem(None) service_item.add_icon = MagicMock() # WHEN: adding an image from a saved Service and mocked exists line = self.convert_file_service_item('serviceitem_image_1.osj') with patch('openlp.core.ui.servicemanager.os.path.exists') as mocked_exists: mocked_exists.return_value = True 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 service_item.get_rendered_frame(0) == test_file, 'The first frame should match the path to the image' assert service_item.get_frames()[0] == frame_array, 'The return should match frame array1' assert service_item.get_frame_path(0) == test_file, 'The frame path should match the full path to the image' assert service_item.get_frame_title(0) == image_name, 'The frame title should match the image name' assert service_item.get_display_title() == image_name, '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'
def build_service_item(self, item=None, xml_version=False, remote=False, context=ServiceItemContext.Live): """ Common method for generating a service item :param item: Service Item to be built. :param xml_version: version of XML (False) :param remote: Remote triggered (False) :param context: The context on which this is called """ service_item = ServiceItem(self.plugin) service_item.add_icon(self.plugin.icon_path) if self.generate_slide_data(service_item, item, xml_version, remote, context): return service_item else: return None
def serviceitem_load_image_from_service_test(self): """ Test the Service Item - adding an image from a saved service """ # GIVEN: A new service item and a mocked add icon function service_item = ServiceItem(None) mocked_add_icon = MagicMock() service_item.add_icon = mocked_add_icon # WHEN: adding a custom from a saved Service # THEN: We should get back a valid service item assert service_item.is_valid is True, u'The new service item should be valid'
def test_service_item_load_image_from_service(self): """ Test the Service Item - adding an image from a saved service """ # GIVEN: A new service item and a mocked add icon function image_name = 'image_1.jpg' test_file = os.path.join(TEST_PATH, image_name) frame_array = {'path': test_file, 'title': image_name} 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,\ patch('openlp.core.lib.serviceitem.AppLocation.get_section_data_path') as \ mocked_get_section_data_path: mocked_exists.return_value = True mocked_get_section_data_path.return_value = os.path.normpath( '/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 os.path.normpath(test_file) == os.path.normpath(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 test_file == service_item.get_frame_path( 0), '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'
def service_item_load_image_from_service_test(self): """ Test the Service Item - adding an image from a saved service """ # GIVEN: A new service item and a mocked add icon function image_name = 'image_1.jpg' test_file = os.path.join(TEST_PATH, image_name) frame_array = {'path': test_file, 'title': image_name} 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,\ patch('openlp.core.lib.serviceitem.create_thumb') as mocked_create_thumb,\ patch('openlp.core.lib.serviceitem.AppLocation.get_section_data_path') as \ mocked_get_section_data_path: mocked_exists.return_value = True mocked_get_section_data_path.return_value = os.path.normpath('/path/') service_item.set_from_service(line, TEST_PATH) # THEN: We should get back a valid service item self.assertTrue(service_item.is_valid, 'The new service item should be valid') self.assertEqual(os.path.normpath(test_file), os.path.normpath(service_item.get_rendered_frame(0)), 'The first frame should match the path to the image') self.assertEqual(frame_array, service_item.get_frames()[0], 'The return should match frame array1') self.assertEqual(test_file, service_item.get_frame_path(0), 'The frame path should match the full path to the image') self.assertEqual(image_name, service_item.get_frame_title(0), 'The frame title should match the image name') self.assertEqual(image_name, service_item.get_display_title(), 'The display title should match the first image name') self.assertTrue(service_item.is_image(), 'This service item should be of an "image" type') self.assertTrue(service_item.is_capable(ItemCapabilities.CanMaintain), 'This service item should be able to be Maintained') self.assertTrue(service_item.is_capable(ItemCapabilities.CanPreview), 'This service item should be able to be be Previewed') self.assertTrue(service_item.is_capable(ItemCapabilities.CanLoop), 'This service item should be able to be run in a can be made to Loop') self.assertTrue(service_item.is_capable(ItemCapabilities.CanAppend), 'This service item should be able to have new items added to it')
def serviceitem_load_custom_from_service_test(self): """ 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) mocked_add_icon = MagicMock() service_item.add_icon = mocked_add_icon # WHEN: adding a custom from a saved Service line = self.convert_file_service_item(u'serviceitem_custom1.osd') service_item.set_from_service(line) # THEN: We should get back a valid service item assert service_item.is_valid is True, u'The new service item should be valid' assert len(service_item._display_frames) == 0, u'The service item has no display frames' assert len(service_item.capabilities) == 5, u'There are 5 default custom item capabilities' service_item.render(True) assert (service_item.get_display_title()) == u'Test Custom', u'The custom title should be correct'
def service_item_load_optical_media_from_service_test(self): """ 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') with patch('openlp.core.ui.servicemanager.os.path.exists') as mocked_exists: mocked_exists.return_value = True service_item.set_from_service(line) # THEN: We should get back a valid service item with optical media info self.assertTrue(service_item.is_valid, 'The service item should be valid') self.assertTrue(service_item.is_capable(ItemCapabilities.IsOptical), 'The item should be Optical') self.assertEqual(service_item.start_time, 654.375, 'Start time should be 654.375') self.assertEqual(service_item.end_time, 672.069, 'End time should be 672.069') self.assertEqual(service_item.media_length, 17.694, 'Media length should be 17.694')
def test_service_item_load_song_and_audio_from_service(self): """ 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, '/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 0 == len(service_item._display_frames ), 'The service item should have no display frames' assert 7 == len(service_item.capabilities ), 'There should be 7 default custom item capabilities' # WHEN: We render the frames of the service item service_item.render(True) # THEN: The frames should also be valid 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 RENDERED_VERSE.split('\n', 1)[0] == service_item.get_rendered_frame(1), \ 'The first line has been returned' 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 serviceitem_load_custom_from_service_test(self): """ 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() # WHEN: adding a custom from a saved Service line = self.convert_file_service_item('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._display_frames) == 0, 'The service item should have no display frames' assert len(service_item.capabilities) == 5, 'There should be 5 default custom item capabilities' service_item.render(True) assert service_item.get_display_title() == 'Test Custom', 'The title should be "Test Custom"' assert service_item.get_frames()[0]['text'] == VERSE[:-1], \ 'The returned text matches the input, except the last line feed' assert service_item.get_rendered_frame(1) == VERSE.split('\n', 1)[0], 'The first line has been returned' assert service_item.get_frame_title(0) == 'Slide 1', '"Slide 1" has been returned as the title' assert service_item.get_frame_title(1) == 'Slide 2', '"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'
def test_service_item_load_image_from_local_service(self): """ Test the Service Item - adding an image from a saved local service """ # GIVEN: A new service item and a mocked add icon function image_name1 = 'image_1.jpg' image_name2 = 'image_2.jpg' test_file1 = os.path.normpath(os.path.join('/home/openlp', image_name1)) test_file2 = os.path.normpath(os.path.join('/home/openlp', image_name2)) frame_array1 = {'path': test_file1, 'title': image_name1} frame_array2 = {'path': test_file2, 'title': image_name2} 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) 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: mocked_exists.return_value = True mocked_get_section_data_path.return_value = os.path.normpath( '/path/') service_item2.set_from_service(line2) service_item.set_from_service(line) # THEN: We should get back a valid service item # This test is copied from service_item.py, but is changed since to conform to # new layout of service item. The layout use in serviceitem_image_2.osd is actually invalid now. 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), \ 'The frame path should match the full path to the image' assert test_file2 == service_item2.get_frame_path(0), \ 'The frame path should match the full path to the image' 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 service_item_load_image_from_local_service_test(self): """ Test the Service Item - adding an image from a saved local service """ # GIVEN: A new service item and a mocked add icon function image_name1 = 'image_1.jpg' image_name2 = 'image_2.jpg' test_file1 = os.path.normpath(os.path.join('/home/openlp', image_name1)) test_file2 = os.path.normpath(os.path.join('/home/openlp', image_name2)) frame_array1 = {'path': test_file1, 'title': image_name1} frame_array2 = {'path': test_file2, 'title': image_name2} 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) with patch('openlp.core.ui.servicemanager.os.path.exists') as mocked_exists, \ patch('openlp.core.lib.serviceitem.create_thumb') as mocked_create_thumb, \ patch('openlp.core.lib.serviceitem.AppLocation.get_section_data_path') as \ mocked_get_section_data_path: mocked_exists.return_value = True mocked_get_section_data_path.return_value = os.path.normpath('/path/') service_item2.set_from_service(line2) service_item.set_from_service(line) # THEN: We should get back a valid service item # This test is copied from service_item.py, but is changed since to conform to # new layout of service item. The layout use in serviceitem_image_2.osd is actually invalid now. self.assertTrue(service_item.is_valid, 'The first service item should be valid') self.assertTrue(service_item2.is_valid, 'The second service item should be valid') # These test will fail on windows due to the difference in folder seperators if os.name != 'nt': self.assertEqual(test_file1, service_item.get_rendered_frame(0), 'The first frame should match the path to the image') self.assertEqual(test_file2, service_item2.get_rendered_frame(0), 'The Second frame should match the path to the image') self.assertEqual(frame_array1, service_item.get_frames()[0], 'The return should match the frame array1') self.assertEqual(frame_array2, service_item2.get_frames()[0], 'The return should match the frame array2') self.assertEqual(test_file1, service_item.get_frame_path(0), 'The frame path should match the full path to the image') self.assertEqual(test_file2, service_item2.get_frame_path(0), 'The frame path should match the full path to the image') self.assertEqual(image_name1, service_item.get_frame_title(0), 'The 1st frame title should match the image name') self.assertEqual(image_name2, service_item2.get_frame_title(0), 'The 2nd frame title should match the image name') self.assertEqual(service_item.name, service_item.title.lower(), 'The plugin name should match the display title, as there are > 1 Images') self.assertTrue(service_item.is_image(), 'This service item should be of an "image" type') self.assertTrue(service_item.is_capable(ItemCapabilities.CanMaintain), 'This service item should be able to be Maintained') self.assertTrue(service_item.is_capable(ItemCapabilities.CanPreview), 'This service item should be able to be be Previewed') self.assertTrue(service_item.is_capable(ItemCapabilities.CanLoop), 'This service item should be able to be run in a can be made to Loop') self.assertTrue(service_item.is_capable(ItemCapabilities.CanAppend), 'This service item should be able to have new items added to it')