[option] Add validate string to {Numeric, Path}Option

Author: salkinium

README.md

@@ -752,6 +752,7 @@ option = PathOption(name="option-name",
                     default="path/to/folder/or/file",
                     empty_ok=False, # is an empty path considered valid?
                     absolute=False, # is the path relative to the config file?
+                    validate=validate_path,
                     dependencies=add_option_dependencies)
 ```
 
@@ -774,14 +775,15 @@ option = BooleanOption(name="option-name",
 This option allows a number from [-Inf, +Inf]. You can limit this to the
 range [minimum, maximum]. When using floating point numbers here, please be
 aware that not all floating point numbers can be represented as a string
-(like "1/3"). The dependency handler is passed a numeric value.
+(like "1/3"). The validation and dependency handlers are passed a numeric value.
 
 ```python
 option = NumericOption(name="option-name",
                        description="numeric",
                        minimum=0,
                        maximum=100,
                        default=50,
+                       validate=validate_number,
                        dependencies=add_option_dependencies)
 ```
 

lbuild/main.py

@@ -22,7 +22,7 @@
 
 from lbuild.api import Builder
 
-__version__ = '1.16.1'
+__version__ = '1.17.0'
 
 
 class InitAction:

lbuild/option.py

@@ -25,7 +25,7 @@
 
 class Option(BaseNode):
 
-    def __init__(self, name, description, default=None, dependencies=None,
+    def __init__(self, name, description, default=None, dependencies=None, validate=None,
                  convert_input=None, convert_output=None):
         BaseNode.__init__(self, name, BaseNode.Type.OPTION)
         self._dependency_handler = dependencies
@@ -35,6 +35,7 @@ def __init__(self, name, description, default=None, dependencies=None,
         self._input = None
         self._output = None
         self._default = None
+        self._validate = validate
         self._filename = os.path.join(os.getcwd(), "dummy")
         self._set_default(default)
 
@@ -93,24 +94,24 @@ def format_values(self):
 class StringOption(Option):
 
     def __init__(self, name, description, default=None, dependencies=None, validate=None):
-        Option.__init__(self, name, description, None, dependencies,
+        Option.__init__(self, name, description, None, dependencies, validate,
                         convert_input=self._validate_string)
-        self._validate = validate
         self._set_default(default)
 
     def _validate_string(self, value):
         value = str(value)
-        if self._validate:
+        if self._validate is not None:
             self._validate(value)
         return value
 
 
 class PathOption(Option):
 
-    def __init__(self, name, description, default=None, dependencies=None, empty_ok=False, absolute=False):
+    def __init__(self, name, description, default=None, empty_ok=False,
+                 absolute=False, dependencies=None, validate=None):
         self._empty_ok = empty_ok
         self._absolute = absolute
-        Option.__init__(self, name, description, default, dependencies,
+        Option.__init__(self, name, description, default, dependencies, validate,
                         convert_input=self._validate_path,
                         convert_output=self._relocate_path)
 
@@ -132,6 +133,8 @@ def _validate_path(self, path):
         # Relocate path to be relative to the user's perspective
         if self._relocate(path):
             path = os.path.relpath(self._relocate_path(path))
+        if self._validate is not None:
+            self._validate(path)
         return path
 
     @staticmethod
@@ -191,8 +194,8 @@ def as_boolean(value):
 class NumericOption(Option):
 
     def __init__(self, name, description, minimum=None, maximum=None,
-                 default=None, dependencies=None):
-        Option.__init__(self, name, description, default, dependencies,
+                 default=None, dependencies=None, validate=None):
+        Option.__init__(self, name, description, default, dependencies, validate,
                         convert_input=str,
                         convert_output=self.as_numeric_value)
         self.minimum_input = str(minimum)
@@ -227,6 +230,8 @@ def value(self, value):
                 raise ValueError("Input must be greater or equal to '{}'".format(self.minimum))
             if self.maximum is not None and numeric_value > self.maximum:
                 raise ValueError("Input must be smaller or equal to '{}'".format(self.maximum))
+            if self._validate is not None:
+                self._validate(numeric_value)
         except (TypeError, ValueError) as error:
             raise le.LbuildOptionInputException(self, value, error)
         self._set_value(value)

test/option_test.py

@@ -121,7 +121,11 @@ def validate_string(value):
                          validate=validate_string)
 
     def test_should_be_constructable_from_path(self):
-        option = PathOption("test", "description", default="filename.txt")
+        def validate_path(path):
+            if path.startswith(".."):
+                raise ValueError("Path must be local.")
+
+        option = PathOption("test", "description", default="filename.txt", validate=validate_path)
         self.assertIn("test  [PathOption]", option.description)
         self.assertEqual("filename.txt", option.value)
         option.value = "filename.txt.in"
@@ -147,6 +151,8 @@ def test_should_be_constructable_from_path(self):
             option.value = "/folder//"
         with self.assertRaises(le.LbuildOptionInputException):
             option.value = "//folder/"
+        with self.assertRaises(le.LbuildOptionInputException):
+            option.value = "../folder"
 
         option = PathOption("test", "description", default="", empty_ok=True)
         self.assertEqual("", option.value)
@@ -190,8 +196,11 @@ def test_should_be_constructable_from_boolean(self):
             option.value = "hello"
 
     def test_should_be_constructable_from_number(self):
+        def validate_number(number):
+            if number == 69:
+                raise ValueError("Only clean numbers allowed")
         option = NumericOption("test", "description", default=1,
-                               minimum=0, maximum=100)
+                               minimum=0, maximum=100, validate=validate_number)
         self.assertIn("test  [NumericOption]", option.description)
         self.assertEqual(1, option.value)
         option.value = 2
@@ -215,6 +224,8 @@ def test_should_be_constructable_from_number(self):
             option.value = 1000
         with self.assertRaises(le.LbuildOptionInputException):
             option.value = "hello"
+        with self.assertRaises(le.LbuildOptionInputException):
+            option.value = 69
 
         with self.assertRaises(le.LbuildOptionConstructionException):
             NumericOption("test", "description", minimum=0, maximum=0)