# -*- coding: utf-8 -*- ''' :codeauthor: :email:`Rahul Handay ` ''' # Import Python Libs from __future__ import absolute_import # Import Salt Testing Libs from tests.support.mixins import LoaderModuleMockMixin from tests.support.unit import TestCase, skipIf from tests.support.mock import ( MagicMock, patch, NO_MOCK, NO_MOCK_REASON ) # Import Salt Libs import salt.modules.win_service as win_service # Import 3rd Party Libs try: WINAPI = True import win32serviceutil except ImportError: WINAPI = False @skipIf(NO_MOCK, NO_MOCK_REASON) class WinServiceTestCase(TestCase, LoaderModuleMockMixin): ''' Test cases for salt.modules.win_service ''' def setup_loader_modules(self): return {win_service: {}} def test_get_enabled(self): ''' Test to return the enabled services ''' mock = MagicMock(return_value=[{'ServiceName': 'spongebob'}, {'ServiceName': 'squarepants'}, {'ServiceName': 'patrick'}]) with patch.object(win_service, '_get_services', mock): mock_info = MagicMock(side_effect=[{'StartType': 'Auto'}, {'StartType': 'Manual'}, {'StartType': 'Disabled'}]) with patch.object(win_service, 'info', mock_info): self.assertListEqual(win_service.get_enabled(), ['spongebob']) def test_get_disabled(self): ''' Test to return the disabled services ''' mock = MagicMock(return_value=[{'ServiceName': 'spongebob'}, {'ServiceName': 'squarepants'}, {'ServiceName': 'patrick'}]) with patch.object(win_service, '_get_services', mock): mock_info = MagicMock(side_effect=[{'StartType': 'Auto'}, {'StartType': 'Manual'}, {'StartType': 'Disabled'}]) with patch.object(win_service, 'info', mock_info): self.assertListEqual(win_service.get_disabled(), ['patrick', 'squarepants']) def test_available(self): ''' Test to Returns ``True`` if the specified service is available, otherwise returns ``False`` ''' mock = MagicMock(return_value=['c', 'a', 'b']) with patch.object(win_service, 'get_all', mock): self.assertTrue(win_service.available("a")) def test_missing(self): ''' Test to the inverse of service.available ''' mock = MagicMock(return_value=['c', 'a', 'b']) with patch.object(win_service, 'get_all', mock): self.assertTrue(win_service.missing("d")) def test_get_all(self): ''' Test to return all installed services ''' mock = MagicMock(return_value=[{'ServiceName': 'spongebob'}, {'ServiceName': 'squarepants'}, {'ServiceName': 'patrick'}]) with patch.object(win_service, '_get_services', mock): self.assertListEqual(win_service.get_all(), ['patrick', 'spongebob', 'squarepants']) def test_get_service_name(self): ''' Test to the Display Name is what is displayed in Windows when services.msc is executed. ''' mock = MagicMock(return_value=[{'ServiceName': 'spongebob', 'DisplayName': 'Sponge Bob'}, {'ServiceName': 'squarepants', 'DisplayName': 'Square Pants'}, {'ServiceName': 'patrick', 'DisplayName': 'Patrick the Starfish'}]) with patch.object(win_service, '_get_services', mock): self.assertDictEqual(win_service.get_service_name(), {'Patrick the Starfish': 'patrick', 'Sponge Bob': 'spongebob', 'Square Pants': 'squarepants'}) self.assertDictEqual(win_service.get_service_name('patrick'), {'Patrick the Starfish': 'patrick'}) @skipIf(not WINAPI, 'win32serviceutil not available') def test_start(self): ''' Test to start the specified service ''' mock_true = MagicMock(return_value=True) mock_false = MagicMock(return_value=False) mock_info = MagicMock(side_effect=[{'Status': 'Stopped'}, {'Status': 'Start Pending'}, {'Status': 'Running'}]) with patch.object(win_service, 'status', mock_true): self.assertTrue(win_service.start('spongebob')) with patch.object(win_service, 'status', mock_false): with patch.object(win32serviceutil, 'StartService', mock_true): with patch.object(win_service, 'info', mock_info): with patch.object(win_service, 'status', mock_true): self.assertTrue(win_service.start('spongebob')) @skipIf(not WINAPI, 'win32serviceutil not available') def test_stop(self): ''' Test to stop the specified service ''' mock_true = MagicMock(return_value=True) mock_false = MagicMock(return_value=False) mock_info = MagicMock(side_effect=[{'Status': 'Running'}, {'Status': 'Stop Pending'}, {'Status': 'Stopped'}]) with patch.dict(win_service.__salt__, {'cmd.run': MagicMock(return_value="service was stopped")}): self.assertTrue(win_service.stop('spongebob')) with patch.dict(win_service.__salt__, {'cmd.run': MagicMock(return_value="service was stopped")}), \ patch.object(win32serviceutil, 'StopService', mock_true), \ patch.object(win_service, 'info', mock_info), \ patch.object(win_service, 'status', mock_false): self.assertTrue(win_service.stop('spongebob')) def test_restart(self): ''' Test to restart the named service ''' mock_true = MagicMock(return_value=True) with patch.object(win_service, 'create_win_salt_restart_task', mock_true): with patch.object(win_service, 'execute_salt_restart_task', mock_true): self.assertTrue(win_service.restart("salt-minion")) with patch.object(win_service, 'stop', mock_true): with patch.object(win_service, 'start', mock_true): self.assertTrue(win_service.restart("salt")) def test_createwin_saltrestart_task(self): ''' Test to create a task in Windows task scheduler to enable restarting the salt-minion ''' mock_true = MagicMock(return_value=True) with patch.dict(win_service.__salt__, {'task.create_task': mock_true}): self.assertTrue(win_service.create_win_salt_restart_task()) def test_execute_salt_restart_task(self): ''' Test to run the Windows Salt restart task ''' mock_true = MagicMock(return_value=True) with patch.dict(win_service.__salt__, {'task.run': mock_true}): self.assertTrue(win_service.execute_salt_restart_task()) def test_status(self): ''' Test to return the status for a service ''' mock_info = MagicMock(side_effect=[{'Status': 'Running'}, {'Status': 'Stop Pending'}, {'Status': 'Stopped'}]) with patch.object(win_service, 'info', mock_info): self.assertTrue(win_service.status('spongebob')) self.assertTrue(win_service.status('patrick')) self.assertFalse(win_service.status('squidward')) def test_getsid(self): ''' Test to return the sid for this windows service ''' mock_info = MagicMock(side_effect=[{'sid': 'S-1-5-80-1956725871...'}, {'sid': None}]) with patch.object(win_service, 'info', mock_info): self.assertEqual(win_service.getsid('spongebob'), 'S-1-5-80-1956725871...') self.assertEqual(win_service.getsid('plankton'), None) def test_enable(self): ''' Test to enable the named service to start at boot ''' mock_modify = MagicMock(return_value=True) mock_info = MagicMock(return_value={'StartType': 'Auto'}) with patch.object(win_service, 'modify', mock_modify): with patch.object(win_service, 'info', mock_info): self.assertTrue(win_service.enable('spongebob')) def test_disable(self): ''' Test to disable the named service to start at boot ''' mock_modify = MagicMock(return_value=True) mock_info = MagicMock(return_value={'StartType': 'Disabled'}) with patch.object(win_service, 'modify', mock_modify): with patch.object(win_service, 'info', mock_info): self.assertTrue(win_service.disable('spongebob')) def test_enabled(self): ''' Test to check to see if the named service is enabled to start on boot ''' mock = MagicMock(side_effect=[{'StartType': 'Auto'}, {'StartType': 'Disabled'}]) with patch.object(win_service, 'info', mock): self.assertTrue(win_service.enabled('spongebob')) self.assertFalse(win_service.enabled('squarepants')) def test_disabled(self): ''' Test to check to see if the named service is disabled to start on boot ''' mock = MagicMock(side_effect=[False, True]) with patch.object(win_service, 'enabled', mock): self.assertTrue(win_service.disabled('spongebob')) self.assertFalse(win_service.disabled('squarepants'))