Added testing for correct error message

Author: LeanderCS

README.rst

@@ -1,9 +1,10 @@
 flask-inputfilter
 =================
 
-The ``InputFilter`` class is used to validate and filter input data in Flask applications.
-It provides a modular way to clean and ensure that incoming data meets expected format
-and type requirements before being processed.
+This library is a Flask extension that provides a simple way to validate and filter input data.
+It allows you to define a set of rules for each field in your input data, including filters and validators.
+The library also supports conditions that can be used to enforce complex validation rules.
+It is designed to be easy to use and flexible, allowing you to create custom filters and validators as needed.
 
 Thank you for using ``flask-inputfilter``!
 ==========================================

flask_inputfilter/validators/array_element_validator.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from copy import deepcopy
-from typing import TYPE_CHECKING, Any, Optional
+from typing import TYPE_CHECKING, Any, Dict, Optional
 
 from flask_inputfilter.exceptions import ValidationError
 from flask_inputfilter.validators import BaseValidator
@@ -31,6 +31,9 @@ def validate(self, value: Any) -> None:
 
         for i, element in enumerate(value):
             try:
+                if not isinstance(element, Dict):
+                    raise ValidationError
+
                 value[i] = deepcopy(self.elementFilter.validateData(element))
 
             except ValidationError:

flask_inputfilter/validators/is_horizontal_image_validator.py

@@ -39,7 +39,7 @@ def validate(self, value):
             if value.width < value.height:
                 raise ValidationError
 
-        except (binascii.Error, OSError):
+        except (ValidationError, binascii.Error, OSError):
             raise ValidationError(
                 self.error_message or "The image is not horizontally oriented."
             )

flask_inputfilter/validators/is_vertical_image_validator.py

@@ -40,7 +40,7 @@ def validate(self, value: Any) -> None:
             if value.width > value.height:
                 raise ValidationError
 
-        except (binascii.Error, OSError):
+        except (ValidationError, binascii.Error, OSError):
             raise ValidationError(
                 self.error_message or "The image is not vertically oriented."
             )

tests/validators/__init__.py

@@ -0,0 +1 @@
+from .base_validator_test import BaseValidatorTest

tests/validators/base_validator_test.py

@@ -0,0 +1,43 @@
+import unittest
+from typing import Any, Optional
+
+from flask_inputfilter import InputFilter
+from flask_inputfilter.exceptions import ValidationError
+
+
+class BaseValidatorTest(unittest.TestCase):
+    """
+    Base class for all validator tests.
+
+    Provides common setup logic and helper methods that can be used
+    in all validator test classes.
+    """
+
+    def setUp(self) -> None:
+        """Initialize an InputFilter for each test."""
+        self.input_filter = InputFilter()
+
+    def assertValidationError(
+        self,
+        field_name: str,
+        invalid_value: Any,
+        expected_message: Optional[str] = None,
+    ) -> None:
+        """
+        Helper method to check if an invalid value raises a ValidationError.
+
+        Args:
+            field_name (str): Name of the field to validate
+            invalid_value (Any): The invalid value that should trigger a
+                ValidationError
+            expected_message (Optional[str]): Optional expected error message
+        """
+        with self.assertRaises(ValidationError) as context:
+            self.input_filter.validateData({field_name: invalid_value})
+
+        errors = context.exception.args[0]
+
+        self.assertIn(field_name, errors, expected_message)
+
+        if expected_message:
+            self.assertEqual(errors[field_name], expected_message)

tests/validators/test_and_validator.py

@@ -1,18 +1,13 @@
-import unittest
-
-from flask_inputfilter import InputFilter
 from flask_inputfilter.exceptions import ValidationError
 from flask_inputfilter.validators import (
     AndValidator,
     IsIntegerValidator,
     RangeValidator,
 )
+from tests.validators import BaseValidatorTest
 
 
-class TestAndValidator(unittest.TestCase):
-    def setUp(self) -> None:
-        self.input_filter = InputFilter()
-
+class TestAndValidator(BaseValidatorTest):
     def test_valid_when_all_validators_pass(self) -> None:
         self.input_filter.add(
             "age",
@@ -58,5 +53,6 @@ def test_custom_error_message(self) -> None:
                 )
             ],
         )
-        with self.assertRaises(ValidationError):
-            self.input_filter.validateData({"age": "not a number"})
+        self.assertValidationError(
+            "age", "not a number", "Custom error message"
+        )

tests/validators/test_array_element_validator.py

@@ -1,17 +1,16 @@
-import unittest
-
 from flask_inputfilter import InputFilter
 from flask_inputfilter.exceptions import ValidationError
 from flask_inputfilter.filters import ToIntegerFilter
 from flask_inputfilter.validators import (
     ArrayElementValidator,
     IsIntegerValidator,
 )
+from tests.validators import BaseValidatorTest
 
 
-class TestArrayElementValidator(unittest.TestCase):
+class TestArrayElementValidator(BaseValidatorTest):
     def setUp(self) -> None:
-        self.input_filter = InputFilter()
+        super().setUp()
         self.element_filter = InputFilter()
         self.element_filter.add(
             "id",
@@ -41,5 +40,19 @@ def test_invalid_non_array_input(self) -> None:
         self.input_filter.add(
             "items", validators=[ArrayElementValidator(self.element_filter)]
         )
-        with self.assertRaises(ValidationError):
-            self.input_filter.validateData({"items": "not an array"})
+        self.assertValidationError(
+            "items", "not an array", "Value 'not an array' is not an array"
+        )
+
+    def test_custom_error_message(self) -> None:
+        self.input_filter.add(
+            "items",
+            validators=[
+                ArrayElementValidator(
+                    self.element_filter, error_message="Custom error message"
+                )
+            ],
+        )
+        self.assertValidationError(
+            "items", ["not an array"], "Custom error message"
+        )

tests/validators/test_array_length_validator.py

@@ -1,13 +1,11 @@
-import unittest
-
-from flask_inputfilter import InputFilter
 from flask_inputfilter.exceptions import ValidationError
 from flask_inputfilter.validators import ArrayLengthValidator
+from tests.validators import BaseValidatorTest
 
 
-class TestArrayLengthValidator(unittest.TestCase):
+class TestArrayLengthValidator(BaseValidatorTest):
     def setUp(self) -> None:
-        self.input_filter = InputFilter()
+        super().setUp()
 
     def test_valid_array_length(self) -> None:
         self.input_filter.add(
@@ -37,5 +35,21 @@ def test_invalid_non_array_input(self) -> None:
             "items",
             validators=[ArrayLengthValidator(min_length=2, max_length=5)],
         )
-        with self.assertRaises(ValidationError):
-            self.input_filter.validateData({"items": "not an array"})
+        self.assertValidationError(
+            "items", "not an array", "Value 'not an array' must be a list."
+        )
+
+    def test_custom_error_message(self) -> None:
+        self.input_filter.add(
+            "items",
+            validators=[
+                ArrayLengthValidator(
+                    min_length=2,
+                    max_length=5,
+                    error_message="Custom error message",
+                )
+            ],
+        )
+        self.assertValidationError(
+            "items", ["not an array"], "Custom error message"
+        )

tests/validators/test_custom_json_validator.py

@@ -1,13 +1,11 @@
-import unittest
-
-from flask_inputfilter import InputFilter
 from flask_inputfilter.exceptions import ValidationError
 from flask_inputfilter.validators import CustomJsonValidator
+from tests.validators import BaseValidatorTest
 
 
-class TestCustomJsonValidator(unittest.TestCase):
+class TestCustomJsonValidator(BaseValidatorTest):
     def setUp(self) -> None:
-        self.input_filter = InputFilter()
+        super().setUp()
 
     def test_valid_json_structure(self) -> None:
         self.input_filter.add(
@@ -59,3 +57,18 @@ def test_invalid_not_json(self) -> None:
         )
         with self.assertRaises(ValidationError):
             self.input_filter.validateData({"data": "not a json"})
+
+    def test_custom_error_message(self) -> None:
+        self.input_filter.add(
+            "data",
+            validators=[
+                CustomJsonValidator(
+                    required_fields=["age"],
+                    schema={"age": int},
+                    error_message="Custom error message",
+                )
+            ],
+        )
+        self.assertValidationError(
+            "data", {"age": "invalid"}, "Custom error message"
+        )