forked from openlp/openlp
156 lines
7.7 KiB
Python
156 lines
7.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
|
|
|
|
###############################################################################
|
|
# OpenLP - Open Source Lyrics Projection #
|
|
# --------------------------------------------------------------------------- #
|
|
# Copyright (c) 2008-2013 Raoul Snyman #
|
|
# Portions copyright (c) 2008-2013 Tim Bentley, Gerald Britton, Jonathan #
|
|
# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
|
|
# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
|
|
# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
|
|
# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
|
|
# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
|
|
# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
|
|
# --------------------------------------------------------------------------- #
|
|
# 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.
|
|
"""
|
|
from unittest import TestCase
|
|
|
|
from openlp.core.utils import clean_filename, get_filesystem_encoding, get_locale_key, \
|
|
get_natural_key, split_filename
|
|
from tests.functional import patch
|
|
|
|
|
|
class TestUtils(TestCase):
|
|
"""
|
|
A test suite to test out various methods around the AppLocation class.
|
|
"""
|
|
def get_filesystem_encoding_sys_function_not_called_test(self):
|
|
"""
|
|
Test the get_filesystem_encoding() function does not call the sys.getdefaultencoding() function
|
|
"""
|
|
# GIVEN: sys.getfilesystemencoding returns "cp1252"
|
|
with patch('openlp.core.utils.sys.getfilesystemencoding') as mocked_getfilesystemencoding, \
|
|
patch('openlp.core.utils.sys.getdefaultencoding') as mocked_getdefaultencoding:
|
|
mocked_getfilesystemencoding.return_value = 'cp1252'
|
|
|
|
# WHEN: get_filesystem_encoding() is called
|
|
result = get_filesystem_encoding()
|
|
|
|
# THEN: getdefaultencoding should have been called
|
|
mocked_getfilesystemencoding.assert_called_with()
|
|
self.assertEqual(0, mocked_getdefaultencoding.called, 'getdefaultencoding should not have been called')
|
|
self.assertEqual('cp1252', result, 'The result should be "cp1252"')
|
|
|
|
def get_filesystem_encoding_sys_function_is_called_test(self):
|
|
"""
|
|
Test the get_filesystem_encoding() function calls the sys.getdefaultencoding() function
|
|
"""
|
|
# GIVEN: sys.getfilesystemencoding returns None and sys.getdefaultencoding returns "utf-8"
|
|
with patch('openlp.core.utils.sys.getfilesystemencoding') as mocked_getfilesystemencoding, \
|
|
patch('openlp.core.utils.sys.getdefaultencoding') as mocked_getdefaultencoding:
|
|
mocked_getfilesystemencoding.return_value = None
|
|
mocked_getdefaultencoding.return_value = 'utf-8'
|
|
|
|
# WHEN: get_filesystem_encoding() is called
|
|
result = get_filesystem_encoding()
|
|
|
|
# THEN: getdefaultencoding should have been called
|
|
mocked_getfilesystemencoding.assert_called_with()
|
|
mocked_getdefaultencoding.assert_called_with()
|
|
self.assertEqual('utf-8', result, 'The result should be "utf-8"')
|
|
|
|
def split_filename_with_file_path_test(self):
|
|
"""
|
|
Test the split_filename() function with a path to a file
|
|
"""
|
|
# GIVEN: A path to a file.
|
|
file_path = '/home/user/myfile.txt'
|
|
wanted_result = ('/home/user', 'myfile.txt')
|
|
with patch('openlp.core.utils.os.path.isfile') as mocked_is_file:
|
|
mocked_is_file.return_value = True
|
|
|
|
# WHEN: Split the file name.
|
|
result = split_filename(file_path)
|
|
|
|
# THEN: A tuple should be returned.
|
|
self.assertEqual(wanted_result, result, 'A tuple with the dir and file name should have been returned')
|
|
|
|
def split_filename_with_dir_path_test(self):
|
|
"""
|
|
Test the split_filename() function with a path to a directory
|
|
"""
|
|
# GIVEN: A path to a dir.
|
|
file_path = '/home/user/mydir'
|
|
wanted_result = ('/home/user/mydir', '')
|
|
with patch('openlp.core.utils.os.path.isfile') as mocked_is_file:
|
|
mocked_is_file.return_value = False
|
|
|
|
# WHEN: Split the file name.
|
|
result = split_filename(file_path)
|
|
|
|
# THEN: A tuple should be returned.
|
|
self.assertEqual(wanted_result, result,
|
|
'A two-entry tuple with the directory and file name (empty) should have been returned.')
|
|
|
|
def clean_filename_test(self):
|
|
"""
|
|
Test the clean_filename() function
|
|
"""
|
|
# GIVEN: A invalid file name and the valid file name.
|
|
invalid_name = 'A_file_with_invalid_characters_[\\/:\*\?"<>\|\+\[\]%].py'
|
|
wanted_name = 'A_file_with_invalid_characters______________________.py'
|
|
|
|
# WHEN: Clean the name.
|
|
result = clean_filename(invalid_name)
|
|
|
|
# THEN: The file name should be cleaned.
|
|
self.assertEqual(wanted_name, result, 'The file name should not contain any special characters.')
|
|
|
|
def get_locale_key_test(self):
|
|
"""
|
|
Test the get_locale_key(string) function
|
|
"""
|
|
with patch('openlp.core.utils.languagemanager.LanguageManager.get_language') as mocked_get_language:
|
|
# GIVEN: The language is German
|
|
# 0x00C3 (A with diaresis) should be sorted as "A". 0x00DF (sharp s) should be sorted as "ss".
|
|
mocked_get_language.return_value = 'de'
|
|
unsorted_list = ['Auszug', 'Aushang', '\u00C4u\u00DFerung']
|
|
|
|
# WHEN: We sort the list and use get_locale_key() to generate the sorting keys
|
|
sorted_list = sorted(unsorted_list, key=get_locale_key)
|
|
|
|
# THEN: We get a properly sorted list
|
|
self.assertEqual(['Aushang', '\u00C4u\u00DFerung', 'Auszug'], sorted_list,
|
|
'Strings should be sorted properly')
|
|
|
|
def get_natural_key_test(self):
|
|
"""
|
|
Test the get_natural_key(string) function
|
|
"""
|
|
with patch('openlp.core.utils.languagemanager.LanguageManager.get_language') as mocked_get_language:
|
|
# GIVEN: The language is English (a language, which sorts digits before letters)
|
|
mocked_get_language.return_value = 'en'
|
|
unsorted_list = ['item 10a', 'item 3b', '1st item']
|
|
|
|
# WHEN: We sort the list and use get_natural_key() to generate the sorting keys
|
|
sorted_list = sorted(unsorted_list, key=get_natural_key)
|
|
|
|
# THEN: We get a properly sorted list
|
|
self.assertEqual(['1st item', 'item 3b', 'item 10a'], sorted_list, 'Numbers should be sorted naturally')
|