forked from openlp/openlp
278 lines
13 KiB
Python
278 lines
13 KiB
Python
# -*- coding: utf-8 -*-
|
|
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
|
|
|
|
###############################################################################
|
|
# OpenLP - Open Source Lyrics Projection #
|
|
# --------------------------------------------------------------------------- #
|
|
# Copyright (c) 2008-2018 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; version 2 of the License. #
|
|
# #
|
|
# 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, write to the Free Software Foundation, Inc., 59 #
|
|
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
|
|
###############################################################################
|
|
"""
|
|
Package to test the openlp.core.ui.media package.
|
|
"""
|
|
from unittest import TestCase
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
from openlp.core.common.registry import Registry
|
|
from openlp.core.ui.media.mediacontroller import MediaController
|
|
from openlp.core.ui.media.mediaplayer import MediaPlayer
|
|
from tests.helpers.testmixin import TestMixin
|
|
|
|
from tests.utils.constants import RESOURCE_PATH
|
|
|
|
|
|
TEST_PATH = RESOURCE_PATH / 'media'
|
|
TEST_MEDIA = [['avi_file.avi', 61495], ['mp3_file.mp3', 134426], ['mpg_file.mpg', 9404], ['mp4_file.mp4', 188336]]
|
|
|
|
|
|
class TestMediaController(TestCase, TestMixin):
|
|
|
|
def setUp(self):
|
|
Registry.create()
|
|
Registry().register('service_manager', MagicMock())
|
|
|
|
def test_generate_extensions_lists(self):
|
|
"""
|
|
Test that the extensions are create correctly
|
|
"""
|
|
# GIVEN: A MediaController and an active player with audio and video extensions
|
|
media_controller = MediaController()
|
|
media_player = MediaPlayer(None)
|
|
media_player.is_active = True
|
|
media_player.audio_extensions_list = ['*.mp3', '*.wav', '*.wma', '*.ogg']
|
|
media_player.video_extensions_list = ['*.mp4', '*.mov', '*.avi', '*.ogm']
|
|
media_controller.register_players(media_player)
|
|
|
|
# WHEN: calling _generate_extensions_lists
|
|
media_controller._generate_extensions_lists()
|
|
|
|
# THEN: extensions list should have been copied from the player to the mediacontroller
|
|
assert media_player.video_extensions_list == media_controller.video_extensions_list, \
|
|
'Video extensions should be the same'
|
|
assert media_player.audio_extensions_list == media_controller.audio_extensions_list, \
|
|
'Audio extensions should be the same'
|
|
|
|
def test_resize(self):
|
|
"""
|
|
Test that the resize method is called correctly
|
|
"""
|
|
# GIVEN: A media controller, a player and a display
|
|
media_controller = MediaController()
|
|
mocked_player = MagicMock()
|
|
mocked_display = MagicMock()
|
|
|
|
# WHEN: resize() is called
|
|
media_controller.resize(mocked_display, mocked_player)
|
|
|
|
# THEN: The player's resize method should be called correctly
|
|
mocked_player.resize.assert_called_with(mocked_display)
|
|
|
|
def test_check_file_type_no_players(self):
|
|
"""
|
|
Test that we don't try to play media when no players available
|
|
"""
|
|
# GIVEN: A mocked UiStrings, get_used_players, controller, display and service_item
|
|
with patch('openlp.core.ui.media.mediacontroller.MediaController._get_used_players') as \
|
|
mocked_get_used_players,\
|
|
patch('openlp.core.ui.media.mediacontroller.UiStrings') as mocked_uistrings:
|
|
mocked_get_used_players.return_value = ([])
|
|
mocked_ret_uistrings = MagicMock()
|
|
mocked_ret_uistrings.Automatic = 1
|
|
mocked_uistrings.return_value = mocked_ret_uistrings
|
|
media_controller = MediaController()
|
|
mocked_controller = MagicMock()
|
|
mocked_display = MagicMock()
|
|
mocked_service_item = MagicMock()
|
|
mocked_service_item.processor = 1
|
|
|
|
# WHEN: calling _check_file_type when no players exists
|
|
ret = media_controller._check_file_type(mocked_controller, mocked_display, mocked_service_item)
|
|
|
|
# THEN: it should return False
|
|
assert ret is False, '_check_file_type should return False when no mediaplayers are available.'
|
|
|
|
@patch('openlp.core.ui.media.mediacontroller.MediaController._get_used_players')
|
|
@patch('openlp.core.ui.media.mediacontroller.UiStrings')
|
|
def test_check_file_type_no_processor(self, mocked_uistrings, mocked_get_used_players):
|
|
"""
|
|
Test that we don't try to play media when the processor for the service item is None
|
|
"""
|
|
# GIVEN: A mocked UiStrings, get_media_players, controller, display and service_item
|
|
mocked_get_used_players.return_value = ([], '')
|
|
mocked_ret_uistrings = MagicMock()
|
|
mocked_ret_uistrings.Automatic = 1
|
|
mocked_uistrings.return_value = mocked_ret_uistrings
|
|
media_controller = MediaController()
|
|
mocked_controller = MagicMock()
|
|
mocked_display = MagicMock()
|
|
mocked_service_item = MagicMock()
|
|
mocked_service_item.processor = None
|
|
|
|
# WHEN: calling _check_file_type when the processor for the service item is None
|
|
ret = media_controller._check_file_type(mocked_controller, mocked_display, mocked_service_item)
|
|
|
|
# THEN: it should return False
|
|
assert ret is False, '_check_file_type should return False when the processor for service_item is None.'
|
|
|
|
@patch('openlp.core.ui.media.mediacontroller.MediaController._get_used_players')
|
|
@patch('openlp.core.ui.media.mediacontroller.UiStrings')
|
|
def test_check_file_type_automatic_processor(self, mocked_uistrings, mocked_get_used_players):
|
|
"""
|
|
Test that we can play media when players are available and we have a automatic processor from the service item
|
|
"""
|
|
# GIVEN: A mocked UiStrings, get_media_players, controller, display and service_item
|
|
mocked_get_used_players.return_value = (['vlc', 'webkit'])
|
|
mocked_ret_uistrings = MagicMock()
|
|
mocked_ret_uistrings.Automatic = 1
|
|
mocked_uistrings.return_value = mocked_ret_uistrings
|
|
media_controller = MediaController()
|
|
mocked_vlc = MagicMock()
|
|
mocked_vlc.video_extensions_list = ['*.mp4']
|
|
media_controller.media_players = {'vlc': mocked_vlc, 'webkit': MagicMock()}
|
|
mocked_controller = MagicMock()
|
|
mocked_suffix = MagicMock()
|
|
mocked_suffix.return_value = 'mp4'
|
|
mocked_controller.media_info.file_info.suffix = mocked_suffix
|
|
mocked_display = MagicMock()
|
|
mocked_service_item = MagicMock()
|
|
mocked_service_item.processor = 1
|
|
|
|
# WHEN: calling _check_file_type when the processor for the service item is None
|
|
ret = media_controller._check_file_type(mocked_controller, mocked_display, mocked_service_item)
|
|
|
|
# THEN: it should return True
|
|
assert ret is True, '_check_file_type should return True when mediaplayers are available and ' \
|
|
'the service item has an automatic processor.'
|
|
|
|
@patch('openlp.core.ui.media.mediacontroller.MediaController._get_used_players')
|
|
@patch('openlp.core.ui.media.mediacontroller.UiStrings')
|
|
def test_check_file_type_processor_different_from_available(self, mocked_uistrings, mocked_get_used_players):
|
|
"""
|
|
Test that we can play media when players available are different from the processor from the service item
|
|
"""
|
|
# GIVEN: A mocked UiStrings, get_media_players, controller, display and service_item
|
|
mocked_get_used_players.return_value = (['system'])
|
|
mocked_ret_uistrings = MagicMock()
|
|
mocked_ret_uistrings.Automatic = 'automatic'
|
|
mocked_uistrings.return_value = mocked_ret_uistrings
|
|
media_controller = MediaController()
|
|
mocked_phonon = MagicMock()
|
|
mocked_phonon.video_extensions_list = ['*.mp4']
|
|
media_controller.media_players = {'system': mocked_phonon}
|
|
mocked_controller = MagicMock()
|
|
mocked_suffix = MagicMock()
|
|
mocked_suffix.return_value = 'mp4'
|
|
mocked_controller.media_info.file_info.suffix = mocked_suffix
|
|
mocked_display = MagicMock()
|
|
mocked_service_item = MagicMock()
|
|
mocked_service_item.processor = 'vlc'
|
|
|
|
# WHEN: calling _check_file_type when the processor for the service item is None
|
|
ret = media_controller._check_file_type(mocked_controller, mocked_display, mocked_service_item)
|
|
|
|
# THEN: it should return True
|
|
assert ret is True, '_check_file_type should return True when the players available are different' \
|
|
'from the processor from the service item.'
|
|
|
|
def test_media_play_msg(self):
|
|
"""
|
|
Test that the media controller responds to the request to play a loaded video
|
|
"""
|
|
# GIVEN: A media controller and a message with two elements
|
|
media_controller = MediaController()
|
|
message = (1, 2)
|
|
|
|
# WHEN: media_play_msg() is called
|
|
with patch.object(media_controller, u'media_play') as mocked_media_play:
|
|
media_controller.media_play_msg(message, False)
|
|
|
|
# THEN: The underlying method is called
|
|
mocked_media_play.assert_called_with(1, False)
|
|
|
|
def test_media_pause_msg(self):
|
|
"""
|
|
Test that the media controller responds to the request to pause a loaded video
|
|
"""
|
|
# GIVEN: A media controller and a message with two elements
|
|
media_controller = MediaController()
|
|
message = (1, 2)
|
|
|
|
# WHEN: media_play_msg() is called
|
|
with patch.object(media_controller, u'media_pause') as mocked_media_pause:
|
|
media_controller.media_pause_msg(message)
|
|
|
|
# THEN: The underlying method is called
|
|
mocked_media_pause.assert_called_with(1)
|
|
|
|
def test_media_stop_msg(self):
|
|
"""
|
|
Test that the media controller responds to the request to stop a loaded video
|
|
"""
|
|
# GIVEN: A media controller and a message with two elements
|
|
media_controller = MediaController()
|
|
message = (1, 2)
|
|
|
|
# WHEN: media_play_msg() is called
|
|
with patch.object(media_controller, u'media_stop') as mocked_media_stop:
|
|
media_controller.media_stop_msg(message)
|
|
|
|
# THEN: The underlying method is called
|
|
mocked_media_stop.assert_called_with(1)
|
|
|
|
def test_media_volume_msg(self):
|
|
"""
|
|
Test that the media controller responds to the request to change the volume
|
|
"""
|
|
# GIVEN: A media controller and a message with two elements
|
|
media_controller = MediaController()
|
|
message = (1, [50])
|
|
|
|
# WHEN: media_play_msg() is called
|
|
with patch.object(media_controller, u'media_volume') as mocked_media_volume:
|
|
media_controller.media_volume_msg(message)
|
|
|
|
# THEN: The underlying method is called
|
|
mocked_media_volume.assert_called_with(1, 50)
|
|
|
|
def test_media_seek_msg(self):
|
|
"""
|
|
Test that the media controller responds to the request to seek to a particular position
|
|
"""
|
|
# GIVEN: A media controller and a message with two elements
|
|
media_controller = MediaController()
|
|
message = (1, [800])
|
|
|
|
# WHEN: media_play_msg() is called
|
|
with patch.object(media_controller, u'media_seek') as mocked_media_seek:
|
|
media_controller.media_seek_msg(message)
|
|
|
|
# THEN: The underlying method is called
|
|
mocked_media_seek.assert_called_with(1, 800)
|
|
|
|
def test_media_length(self):
|
|
"""
|
|
Test the Media Info basic functionality
|
|
"""
|
|
for test_data in TEST_MEDIA:
|
|
# GIVEN: a media file
|
|
full_path = str(TEST_PATH / test_data[0])
|
|
media_controller = MediaController()
|
|
|
|
# WHEN the media data is retrieved
|
|
results = media_controller.media_length(full_path)
|
|
|
|
# THEN you can determine the run time
|
|
assert results.tracks[0].duration == test_data[1], 'The correct duration is returned for ' + test_data[0]
|