Merge pull request #3124 from ihenyene/ou_path_required

Adding ou_path_required config to saltworker

src/watchmaker/exceptions/__init__.py

@@ -29,6 +29,11 @@ class InvalidProviderError(WatchmakerError):
     """Invalid Provider Error."""
 
 
+class OuPathRequiredError(Exception):
+    """Exception raised when the OU path is required but not provided."""
+
+
 # Deprecated/renamed exceptions
 WatchmakerException = WatchmakerError
 InvalidValue = InvalidValueError
+OuPathRequired = OuPathRequiredError

src/watchmaker/workers/salt.py

@@ -21,7 +21,11 @@
 
 import watchmaker.utils
 from watchmaker import static
-from watchmaker.exceptions import InvalidValueError, WatchmakerError
+from watchmaker.exceptions import (
+    InvalidValueError,
+    OuPathRequiredError,
+    WatchmakerError,
+)
 from watchmaker.managers.platform import (
     LinuxPlatformManager,
     PlatformManagerBase,
@@ -131,6 +135,7 @@ def __init__(self, *args, **kwargs):
         self.salt_debug_log = kwargs.pop('salt_debug_log', None) or ''
         self.salt_content = kwargs.pop('salt_content', None) or ''
         self.salt_content_path = kwargs.pop('salt_content_path', None) or ''
+        self.ou_path_required = kwargs.pop('ou_path_required', None) or False
         self.ou_path = kwargs.pop('ou_path', None) or ''
         self.admin_groups = kwargs.pop('admin_groups', None) or ''
         self.admin_users = kwargs.pop('admin_users', None) or ''
@@ -188,6 +193,11 @@ def before_install(self):
             self.log.critical(msg)
             raise InvalidValueError(msg)
 
+        if self.ou_path_required and not self.ou_path:
+            raise OuPathRequiredError(
+                "The 'ou_path' option is required, but not provided."
+            )
+
     def install(self):
         """Install Salt."""
         pass

tests/test_saltworker.py

@@ -14,7 +14,7 @@
 
 import pytest
 
-from watchmaker.exceptions import InvalidValue
+from watchmaker.exceptions import InvalidValue, OuPathRequired
 from watchmaker.workers.salt import SaltBase, SaltLinux, SaltWindows
 
 # Supports Python2 and Python3 test mocks
@@ -123,6 +123,21 @@ def test_bogus_environment(saltworker_client):
         saltworker_client.before_install()
 
 
+def test_ou_path_required(saltworker_client):
+    """
+    Ensure that ou_path is required and raises OuPathRequiredError.
+
+    Args:
+        saltworker_client: (:obj:`src.workers.SaltBase`)
+
+    """
+    saltworker_client.ou_path_required = True  # Set ou_path_required to True
+    saltworker_client.ou_path = None  # Don't provide ou_path
+
+    with pytest.raises(OuPathRequired):
+        saltworker_client.before_install()
+
+
 def test_valid_environment(saltworker_client):
     """
     Ensure that an environment within valid_environments works as expected.