Merge pull request #49720 from cstarke/2018.3

Seperate prlctl and prlsrvctl checks into each requiring function

salt/modules/parallels.py

@@ -6,6 +6,9 @@ not all of the options may have been provided yet.  For a complete reference,
 see the `Parallels Desktop Reference Guide
 <http://download.parallels.com/desktop/v9/ga/docs/en_US/Parallels%20Command%20Line%20Reference%20Guide.pdf>`_.
 
+This module requires the prlctl binary to be installed to run most functions.
+To run parallels.prlsrvctl, the prlsrvctl binary is required.
+
 What has not been implemented yet can be accessed through ``parallels.prlctl``
 and ``parallels.prlsrvctl`` (note the preceding double dash ``--`` as
 necessary):
@@ -29,7 +32,7 @@ import shlex
 import salt.utils.locales
 import salt.utils.path
 import salt.utils.yaml
-from salt.exceptions import SaltInvocationError
+from salt.exceptions import SaltInvocationError, CommandExecutionError
 
 # Import 3rd party libs
 from salt.ext import six
@@ -43,17 +46,6 @@ log = logging.getLogger(__name__)
 GUID_REGEX = re.compile(r'{?([0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12})}?', re.I)
 
 
-def __virtual__():
-    '''
-    Load this module if prlctl is available
-    '''
-    if not salt.utils.path.which('prlctl'):
-        return (False, 'prlctl utility not available')
-    if not salt.utils.path.which('prlsrvctl'):
-        return (False, 'prlsrvctl utility not available')
-    return __virtualname__
-
-
 def _normalize_args(args):
     '''
     Return args as a list of strings
@@ -111,6 +103,9 @@ def prlsrvctl(sub_cmd, args=None, runas=None):
         salt '*' parallels.prlsrvctl usb list runas=macdev
         salt -- '*' parallels.prlsrvctl set '--mem-limit auto' runas=macdev
     '''
+    if not salt.utils.path.which('prlsrvctl'):
+        raise CommandExecutionError('prlsrvctl utility not available')
+
     # Construct command
     cmd = ['prlsrvctl', sub_cmd]
     if args:
@@ -141,6 +136,9 @@ def prlctl(sub_cmd, args=None, runas=None):
         salt '*' parallels.prlctl exec 'macvm uname' runas=macdev
         salt -- '*' parallels.prlctl capture 'macvm --file macvm.display.png' runas=macdev
     '''
+    if not salt.utils.path.which('prlctl'):
+        raise CommandExecutionError('prlctl utility not available')
+
     # Construct command
     cmd = ['prlctl', sub_cmd]
     if args:

tests/unit/modules/test_parallels.py

@@ -6,7 +6,7 @@ import textwrap
 
 # Import Salt Libs
 import salt.modules.parallels as parallels
-from salt.exceptions import SaltInvocationError
+from salt.exceptions import SaltInvocationError, CommandExecutionError
 
 # Import Salt Testing Libs
 from tests.support.mixins import LoaderModuleMockMixin
@@ -25,27 +25,6 @@ class ParallelsTestCase(TestCase, LoaderModuleMockMixin):
     def setup_loader_modules(self):
         return {parallels: {}}
 
-    def test___virtual__(self):
-        '''
-        Test parallels.__virtual__
-        '''
-        mock_true = MagicMock(return_value=True)
-        mock_false = MagicMock(return_value=False)
-
-        # Validate false return
-        with patch('salt.utils.path.which', mock_false):
-            ret = parallels.__virtual__()
-            self.assertTrue(isinstance(ret, tuple))
-            self.assertEqual(len(ret), 2)
-            self.assertFalse(ret[0])
-            self.assertTrue(isinstance(ret[1], six.string_types))
-
-        # Validate true return
-        with patch('salt.utils.path.which', mock_true):
-            ret = parallels.__virtual__()
-            self.assertTrue(ret)
-            self.assertEqual(ret, 'parallels')
-
     def test__normalize_args(self):
         '''
         Test parallels._normalize_args
@@ -94,6 +73,14 @@ class ParallelsTestCase(TestCase, LoaderModuleMockMixin):
         '''
         runas = 'macdev'
 
+        # Test missing prlsrvctl binary
+        with patch('salt.utils.path.which', MagicMock(return_value=False)):
+            with self.assertRaises(CommandExecutionError):
+                parallels.prlsrvctl('info', runas=runas)
+
+        # Simulate the existence of prlsrvctl
+        with patch('salt.utils.path.which', MagicMock(return_value="/usr/bin/prlsrvctl")):
+
             # Validate 'prlsrvctl info'
             info_cmd = ['prlsrvctl', 'info']
             info_fcn = MagicMock()
@@ -121,6 +108,14 @@ class ParallelsTestCase(TestCase, LoaderModuleMockMixin):
         '''
         runas = 'macdev'
 
+        # Test missing prlctl binary
+        with patch('salt.utils.path.which', MagicMock(return_value=False)):
+            with self.assertRaises(CommandExecutionError):
+                parallels.prlctl('info', runas=runas)
+
+        # Simulate the existence of prlctl
+        with patch('salt.utils.path.which', MagicMock(return_value="/usr/bin/prlctl")):
+
             # Validate 'prlctl user list'
             user_cmd = ['prlctl', 'user', 'list']
             user_fcn = MagicMock()