openlp/tests/functional/openlp_core_common/test_applocation.py

192 lines
9.8 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
###############################################################################
# OpenLP - Open Source Lyrics Projection #
# --------------------------------------------------------------------------- #
2016-12-31 11:01:36 +00:00
# Copyright (c) 2008-2017 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 #
###############################################################################
"""
Functional tests to test the AppLocation class and related methods.
"""
2014-03-13 20:59:10 +00:00
import os
from unittest import TestCase
2017-08-01 20:59:41 +00:00
from unittest.mock import MagicMock, patch
2013-10-13 17:02:12 +00:00
from openlp.core.common import AppLocation, get_frozen_path
from openlp.core.common.path import Path
2013-02-27 12:03:17 +00:00
2013-08-31 18:17:38 +00:00
FILE_LIST = ['file1', 'file2', 'file3.txt', 'file4.txt', 'file5.mp3', 'file6.mp3']
2013-02-27 12:03:17 +00:00
class TestAppLocation(TestCase):
"""
A test suite to test out various methods around the AppLocation class.
"""
2016-05-31 21:40:13 +00:00
def test_get_data_path(self):
2012-12-05 20:44:42 +00:00
"""
Test the AppLocation.get_data_path() method
"""
2013-10-14 05:01:01 +00:00
with patch('openlp.core.common.applocation.Settings') as mocked_class, \
2013-10-13 17:02:12 +00:00
patch('openlp.core.common.AppLocation.get_directory') as mocked_get_directory, \
patch('openlp.core.common.applocation.check_directory_exists') as mocked_check_directory_exists, \
patch('openlp.core.common.applocation.os') as mocked_os:
2012-12-05 20:44:42 +00:00
# GIVEN: A mocked out Settings class and a mocked out AppLocation.get_directory()
mocked_settings = mocked_class.return_value
mocked_settings.contains.return_value = False
mocked_get_directory.return_value = os.path.join('test', 'dir')
2012-12-05 20:44:42 +00:00
mocked_check_directory_exists.return_value = True
mocked_os.path.normpath.return_value = os.path.join('test', 'dir')
2013-04-05 19:37:15 +00:00
2012-12-05 20:44:42 +00:00
# WHEN: we call AppLocation.get_data_path()
data_path = AppLocation.get_data_path()
2013-04-05 19:37:15 +00:00
2012-12-05 20:44:42 +00:00
# THEN: check that all the correct methods were called, and the result is correct
2013-08-31 18:17:38 +00:00
mocked_settings.contains.assert_called_with('advanced/data path')
2012-12-05 20:44:42 +00:00
mocked_get_directory.assert_called_with(AppLocation.DataDir)
mocked_check_directory_exists.assert_called_with(os.path.join('test', 'dir'))
self.assertEqual(os.path.join('test', 'dir'), data_path, 'Result should be "test/dir"')
2012-12-05 20:44:42 +00:00
2016-05-31 21:40:13 +00:00
def test_get_data_path_with_custom_location(self):
"""
Test the AppLocation.get_data_path() method when a custom location is set in the settings
"""
2017-08-01 20:59:41 +00:00
# GIVEN: A mocked out Settings class which returns a custom data location
mocked_settings_instance = MagicMock(
**{'contains.return_value': True, 'value.return_value': Path('custom', 'dir')})
with patch('openlp.core.common.applocation.Settings', return_value=mocked_settings_instance):
2013-04-05 19:37:15 +00:00
2012-12-05 20:44:42 +00:00
# WHEN: we call AppLocation.get_data_path()
data_path = AppLocation.get_data_path()
2013-04-05 19:37:15 +00:00
2012-12-05 20:44:42 +00:00
# THEN: the mocked Settings methods were called and the value returned was our set up value
2017-08-01 20:59:41 +00:00
mocked_settings_instance.contains.assert_called_with('advanced/data path')
mocked_settings_instance.value.assert_called_with('advanced/data path')
self.assertEqual(Path('custom', 'dir'), data_path, 'Result should be "custom/dir"')
2012-12-06 10:55:12 +00:00
2016-05-31 21:40:13 +00:00
def test_get_files_no_section_no_extension(self):
2013-02-27 12:03:17 +00:00
"""
Test the AppLocation.get_files() method with no parameters passed.
"""
2017-08-01 20:59:41 +00:00
# GIVEN: Our mocked modules/methods.
with patch.object(Path, 'glob', return_value=[Path('/dir/file5.mp3'), Path('/dir/file6.mp3')]) as mocked_glob, \
patch('openlp.core.common.AppLocation.get_data_path', return_value=Path('/dir')):
2013-02-27 12:03:17 +00:00
# When: Get the list of files.
result = AppLocation.get_files()
2017-08-01 20:59:41 +00:00
# Then: Check if the section parameter was used correctly, and the glob argument was passed.
mocked_glob.assert_called_once_with('*')
2013-02-27 21:40:55 +00:00
# Then: check if the file lists are identical.
2017-08-01 20:59:41 +00:00
self.assertListEqual([Path('file5.mp3'), Path('file6.mp3')], result, 'The file lists should be identical.')
2013-02-27 12:03:17 +00:00
2016-05-31 21:40:13 +00:00
def test_get_files(self):
2013-02-27 12:03:17 +00:00
"""
Test the AppLocation.get_files() method with all parameters passed.
"""
2017-08-01 20:59:41 +00:00
# GIVEN: Our mocked modules/methods.
with patch.object(Path, 'glob', return_value=[Path('/dir/section/file5.mp3'), Path('/dir/section/file6.mp3')]) \
as mocked_glob, \
patch('openlp.core.common.AppLocation.get_data_path', return_value=Path('/dir')):
2013-02-27 12:03:17 +00:00
# When: Get the list of files.
2013-08-31 18:17:38 +00:00
result = AppLocation.get_files('section', '.mp3')
2013-03-01 16:18:50 +00:00
2017-08-01 20:59:41 +00:00
# Then: The section parameter was used correctly, and the glob argument was passed..
mocked_glob.assert_called_once_with('*.mp3')
self.assertListEqual([Path('file5.mp3'), Path('file6.mp3')], result, 'The file lists should be identical.')
2013-02-27 12:03:17 +00:00
2016-05-31 21:40:13 +00:00
def test_get_section_data_path(self):
2012-12-06 10:55:12 +00:00
"""
Test the AppLocation.get_section_data_path() method
"""
2013-10-13 17:02:12 +00:00
with patch('openlp.core.common.AppLocation.get_data_path') as mocked_get_data_path, \
patch('openlp.core.common.applocation.check_directory_exists') as mocked_check_directory_exists:
2012-12-06 10:55:12 +00:00
# GIVEN: A mocked out AppLocation.get_data_path()
2017-08-01 20:59:41 +00:00
mocked_get_data_path.return_value = Path('test', 'dir')
2012-12-06 10:55:12 +00:00
mocked_check_directory_exists.return_value = True
2013-04-05 19:37:15 +00:00
2012-12-06 10:55:12 +00:00
# WHEN: we call AppLocation.get_data_path()
2013-08-31 18:17:38 +00:00
data_path = AppLocation.get_section_data_path('section')
2013-04-05 19:37:15 +00:00
2012-12-06 10:55:12 +00:00
# THEN: check that all the correct methods were called, and the result is correct
mocked_check_directory_exists.assert_called_with(Path('test', 'dir', 'section'))
2017-08-01 20:59:41 +00:00
self.assertEqual(Path('test', 'dir', 'section'), data_path, 'Result should be "test/dir/section"')
2012-12-06 10:55:12 +00:00
2016-05-31 21:40:13 +00:00
def test_get_directory_for_app_dir(self):
2012-12-06 10:55:12 +00:00
"""
Test the AppLocation.get_directory() method for AppLocation.AppDir
"""
# GIVEN: A mocked out _get_frozen_path function
2013-10-13 17:02:12 +00:00
with patch('openlp.core.common.applocation.get_frozen_path') as mocked_get_frozen_path:
2017-08-01 20:59:41 +00:00
mocked_get_frozen_path.return_value = Path('app', 'dir')
2013-04-05 19:37:15 +00:00
2012-12-06 10:55:12 +00:00
# WHEN: We call AppLocation.get_directory
directory = AppLocation.get_directory(AppLocation.AppDir)
2013-04-05 19:37:15 +00:00
# THEN: check that the correct directory is returned
2017-08-01 20:59:41 +00:00
self.assertEqual(Path('app', 'dir'), directory, 'Directory should be "app/dir"')
2013-01-30 18:42:22 +00:00
2016-05-31 21:40:13 +00:00
def test_get_directory_for_plugins_dir(self):
2012-12-06 10:55:12 +00:00
"""
Test the AppLocation.get_directory() method for AppLocation.PluginsDir
"""
# GIVEN: _get_frozen_path, abspath, split and sys are mocked out
2013-10-13 17:02:12 +00:00
with patch('openlp.core.common.applocation.get_frozen_path') as mocked_get_frozen_path, \
patch('openlp.core.common.applocation.os.path.abspath') as mocked_abspath, \
patch('openlp.core.common.applocation.os.path.split') as mocked_split, \
patch('openlp.core.common.applocation.sys') as mocked_sys:
2014-07-11 13:35:44 +00:00
mocked_abspath.return_value = os.path.join('plugins', 'dir')
2013-08-31 18:17:38 +00:00
mocked_split.return_value = ['openlp']
2017-08-01 20:59:41 +00:00
mocked_get_frozen_path.return_value = Path('dir')
2012-12-06 10:55:12 +00:00
mocked_sys.frozen = 1
mocked_sys.argv = ['openlp']
2013-04-05 19:37:15 +00:00
2012-12-06 10:55:12 +00:00
# WHEN: We call AppLocation.get_directory
directory = AppLocation.get_directory(AppLocation.PluginsDir)
2013-04-05 19:37:15 +00:00
# THEN: The correct directory should be returned
2017-08-01 20:59:41 +00:00
self.assertEqual(Path('dir', 'plugins'), directory, 'Directory should be "dir/plugins"')
2013-10-13 17:02:12 +00:00
2016-05-31 21:40:13 +00:00
def test_get_frozen_path_in_unfrozen_app(self):
2013-10-13 17:02:12 +00:00
"""
Test the _get_frozen_path() function when the application is not frozen (compiled by PyInstaller)
"""
2016-04-05 18:44:50 +00:00
with patch('openlp.core.common.sys') as mocked_sys:
2013-10-13 17:02:12 +00:00
# GIVEN: The sys module "without" a "frozen" attribute
mocked_sys.frozen = None
# WHEN: We call _get_frozen_path() with two parameters
frozen_path = get_frozen_path('frozen', 'not frozen')
# THEN: The non-frozen parameter is returned
self.assertEqual('not frozen', frozen_path, '_get_frozen_path should return "not frozen"')
2016-05-31 21:40:13 +00:00
def test_get_frozen_path_in_frozen_app(self):
2013-10-13 17:02:12 +00:00
"""
Test the get_frozen_path() function when the application is frozen (compiled by PyInstaller)
"""
with patch('openlp.core.common.sys') as mocked_sys:
# GIVEN: The sys module *with* a "frozen" attribute
mocked_sys.frozen = 1
# WHEN: We call _get_frozen_path() with two parameters
frozen_path = get_frozen_path('frozen', 'not frozen')
# THEN: The frozen parameter is returned
2013-10-14 05:01:01 +00:00
self.assertEqual('frozen', frozen_path, 'Should return "frozen"')