# -*- coding: utf-8 -*- # vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4 ############################################################################### # OpenLP - Open Source Lyrics Projection # # --------------------------------------------------------------------------- # # Copyright (c) 2008-2016 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. """ from unittest import TestCase from openlp.core.common import add_actions, get_uno_instance, get_uno_command from tests.functional import MagicMock, patch from tests.helpers.testmixin import TestMixin class TestInit(TestCase, TestMixin): """ A test suite to test out various methods around the common __init__ class. """ def setUp(self): """ Create an instance and a few example actions. """ self.build_settings() def tearDown(self): """ Clean up """ self.destroy_settings() def add_actions_empty_list_test(self): """ Test that no actions are added when the list is empty """ # GIVEN: a mocked action list, and an empty list mocked_target = MagicMock() empty_list = [] # WHEN: The empty list is added to the mocked target add_actions(mocked_target, empty_list) # THEN: The add method on the mocked target is never called self.assertEqual(0, mocked_target.addSeparator.call_count, 'addSeparator method should not have been called') self.assertEqual(0, mocked_target.addAction.call_count, 'addAction method should not have been called') def add_actions_none_action_test(self): """ Test that a separator is added when a None action is in the list """ # GIVEN: a mocked action list, and a list with None in it mocked_target = MagicMock() separator_list = [None] # WHEN: The list is added to the mocked target add_actions(mocked_target, separator_list) # THEN: The addSeparator method is called, but the addAction method is never called mocked_target.addSeparator.assert_called_with() self.assertEqual(0, mocked_target.addAction.call_count, 'addAction method should not have been called') def add_actions_add_action_test(self): """ Test that an action is added when a valid action is in the list """ # GIVEN: a mocked action list, and a list with an action in it mocked_target = MagicMock() action_list = ['action'] # WHEN: The list is added to the mocked target add_actions(mocked_target, action_list) # THEN: The addSeparator method is not called, and the addAction method is called self.assertEqual(0, mocked_target.addSeparator.call_count, 'addSeparator method should not have been called') mocked_target.addAction.assert_called_with('action') def add_actions_action_and_none_test(self): """ Test that an action and a separator are added when a valid action and None are in the list """ # GIVEN: a mocked action list, and a list with an action and None in it mocked_target = MagicMock() action_list = ['action', None] # WHEN: The list is added to the mocked target add_actions(mocked_target, action_list) # THEN: The addSeparator method is called, and the addAction method is called mocked_target.addSeparator.assert_called_with() mocked_target.addAction.assert_called_with('action') def get_uno_instance_pipe_test(self): """ Test that when the UNO connection type is "pipe" the resolver is given the "pipe" URI """ # GIVEN: A mock resolver object and UNO_CONNECTION_TYPE is "pipe" mock_resolver = MagicMock() # WHEN: get_uno_instance() is called get_uno_instance(mock_resolver) # THEN: the resolve method is called with the correct argument mock_resolver.resolve.assert_called_with('uno:pipe,name=openlp_pipe;urp;StarOffice.ComponentContext') def get_uno_instance_socket_test(self): """ Test that when the UNO connection type is other than "pipe" the resolver is given the "socket" URI """ # GIVEN: A mock resolver object and UNO_CONNECTION_TYPE is "socket" mock_resolver = MagicMock() # WHEN: get_uno_instance() is called get_uno_instance(mock_resolver, 'socket') # THEN: the resolve method is called with the correct argument mock_resolver.resolve.assert_called_with('uno:socket,host=localhost,port=2002;urp;StarOffice.ComponentContext') def get_uno_command_libreoffice_command_exists_test(self): """ Test the ``get_uno_command`` function uses the libreoffice command when available. :return: """ # GIVEN: A patched 'which' method which returns a path when called with 'libreoffice' with patch('openlp.core.utils.which', **{'side_effect': lambda command: {'libreoffice': '/usr/bin/libreoffice'}[command]}): # WHEN: Calling get_uno_command result = get_uno_command() # THEN: The command 'libreoffice' should be called with the appropriate parameters self.assertEquals(result, 'libreoffice --nologo --norestore --minimized --nodefault --nofirststartwizard' ' "--accept=pipe,name=openlp_pipe;urp;"') def get_uno_command_only_soffice_command_exists_test(self): """ Test the ``get_uno_command`` function uses the soffice command when the libreoffice command is not available. :return: """ # GIVEN: A patched 'which' method which returns None when called with 'libreoffice' and a path when called with # 'soffice' with patch('openlp.core.utils.which', **{'side_effect': lambda command: {'libreoffice': None, 'soffice': '/usr/bin/soffice'}[ command]}): # WHEN: Calling get_uno_command result = get_uno_command() # THEN: The command 'soffice' should be called with the appropriate parameters self.assertEquals(result, 'soffice --nologo --norestore --minimized --nodefault --nofirststartwizard' ' "--accept=pipe,name=openlp_pipe;urp;"') def get_uno_command_when_no_command_exists_test(self): """ Test the ``get_uno_command`` function raises an FileNotFoundError when neither the libreoffice or soffice commands are available. :return: """ # GIVEN: A patched 'which' method which returns None with patch('openlp.core.utils.which', **{'return_value': None}): # WHEN: Calling get_uno_command # THEN: a FileNotFoundError exception should be raised self.assertRaises(FileNotFoundError, get_uno_command) def get_uno_command_connection_type_test(self): """ Test the ``get_uno_command`` function when the connection type is anything other than pipe. :return: """ # GIVEN: A patched 'which' method which returns 'libreoffice' with patch('openlp.core.utils.which', **{'return_value': 'libreoffice'}): # WHEN: Calling get_uno_command with a connection type other than pipe result = get_uno_command('socket') # THEN: The connection parameters should be set for socket self.assertEqual(result, 'libreoffice --nologo --norestore --minimized --nodefault --nofirststartwizard' ' "--accept=socket,host=localhost,port=2002;urp;"')