refactor - use ValitationError exception subclass to handle & format list of errors in message

Signed-off-by: David Martin <[email protected]>

Author: David Martin

chaoslib/exceptions.py

@@ -3,7 +3,7 @@
 __all__ = ["ChaosException", "InvalidExperiment", "InvalidActivity",
            "ActivityFailed", "DiscoveryFailed", "InvalidSource",
            "InterruptExecution", "ControlPythonFunctionLoadingError",
-           "InvalidControl"]
+           "InvalidControl", "ValidationError"]
 
 
 class ChaosException(Exception):
@@ -44,3 +44,30 @@ class InterruptExecution(ChaosException):
 
 class InvalidControl(ChaosException):
     pass
+
+
+class ValidationError(ChaosException):
+    def __init__(self, msg, errors, *args, **kwargs):
+        """
+        :param msg: exception message
+        :param errors: single error as string or list of errors/exceptions
+        """
+        if isinstance(errors, str):
+            errors = [errors]
+        self.errors = errors
+        super().__init__(msg, *args, **kwargs)
+
+    def __str__(self) -> str:
+        errors = self.errors
+        nb_errors = len(errors)
+        err_msg = super().__str__()
+        return (
+            "{msg}{dot} {nb} validation error{plural}:\n"
+            " - {errors}".format(
+                msg=err_msg,
+                dot="" if err_msg.endswith(".") else ".",
+                nb=nb_errors,
+                plural="" if nb_errors == 1 else "s",
+                errors="\n - ".join([str(err) for err in errors])
+            )
+        )

chaoslib/experiment.py

@@ -15,7 +15,7 @@
     cleanup_global_controls
 from chaoslib.deprecation import warn_about_deprecated_features
 from chaoslib.exceptions import ActivityFailed, ChaosException, \
-    InterruptExecution, InvalidActivity, InvalidExperiment
+    InterruptExecution, InvalidActivity, InvalidExperiment, ValidationError
 from chaoslib.extension import validate_extensions
 from chaoslib.configuration import load_configuration
 from chaoslib.hypothesis import ensure_hypothesis_is_valid, \
@@ -55,10 +55,14 @@ def ensure_experiment_is_valid(experiment: Experiment):
     """
     logger.info("Validating the experiment's syntax")
 
+    full_validation_msg = 'Experiment is not valid, ' \
+                          'please fix the following errors'
     errors = []
 
     if not experiment:
-        raise InvalidExperiment("an empty experiment is not an experiment")
+        # empty experiment, cannot continue validation any further
+        raise ValidationError(full_validation_msg,
+                              "an empty experiment is not an experiment")
 
     if not experiment.get("title"):
         errors.append(InvalidExperiment("experiment requires a title"))
@@ -103,11 +107,7 @@ def ensure_experiment_is_valid(experiment: Experiment):
     errors.extend(validate_controls(experiment))
 
     if errors:
-        full_validation_msg = 'Experiment is not valid, ' \
-                              'please fix the following errors:'
-        for error in errors:
-            full_validation_msg += '\n- {}'.format(error)
-        raise InvalidExperiment(full_validation_msg)
+        raise ValidationError(full_validation_msg, errors)
 
     logger.info("Experiment looks valid")
 

tests/test_experiment.py

@@ -12,7 +12,7 @@
 import yaml
 
 from chaoslib.exceptions import ActivityFailed, InvalidActivity, \
-    InvalidExperiment, InterruptExecution
+    InvalidExperiment, InterruptExecution, ValidationError
 from chaoslib.experiment import ensure_experiment_is_valid, load_experiment, \
     run_experiment, run_activities
 from chaoslib.types import Experiment
@@ -21,7 +21,7 @@
 
 
 def test_empty_experiment_is_invalid():
-    with pytest.raises(InvalidExperiment) as exc:
+    with pytest.raises(ValidationError) as exc:
         ensure_experiment_is_valid(experiments.EmptyExperiment)
     assert "an empty experiment is not an experiment" in str(exc.value)
 
@@ -65,27 +65,27 @@ def test_unknown_extension():
 
 
 def test_experiment_must_have_a_method():
-    with pytest.raises(InvalidExperiment) as exc:
+    with pytest.raises(ValidationError) as exc:
         ensure_experiment_is_valid(experiments.MissingMethodExperiment)
     assert "an experiment requires a method with "\
            "at least one activity" in str(exc.value)
 
 
 def test_experiment_must_have_at_least_one_step():
-    with pytest.raises(InvalidExperiment) as exc:
+    with pytest.raises(ValidationError) as exc:
         ensure_experiment_is_valid(experiments.NoStepsMethodExperiment)
     assert "an experiment requires a method with "\
            "at least one activity" in str(exc.value)
 
 
 def test_experiment_must_have_a_title():
-    with pytest.raises(InvalidExperiment) as exc:
+    with pytest.raises(ValidationError) as exc:
         ensure_experiment_is_valid(experiments.MissingTitleExperiment)
     assert "experiment requires a title" in str(exc.value)
 
 
 def test_experiment_must_have_a_description():
-    with pytest.raises(InvalidExperiment) as exc:
+    with pytest.raises(ValidationError) as exc:
         ensure_experiment_is_valid(experiments.MissingDescriptionExperiment)
     assert "experiment requires a description" in str(exc.value)
 
@@ -96,13 +96,13 @@ def test_experiment_may_not_have_a_hypothesis():
 
 
 def test_experiment_hypothesis_must_have_a_title():
-    with pytest.raises(InvalidExperiment) as exc:
+    with pytest.raises(ValidationError) as exc:
         ensure_experiment_is_valid(experiments.MissingHypothesisTitleExperiment)
     assert "hypothesis requires a title" in str(exc.value)
 
 
 def test_experiment_hypothesis_must_have_a_valid_probe():
-    with pytest.raises(InvalidExperiment) as exc:
+    with pytest.raises(ValidationError) as exc:
         ensure_experiment_is_valid(experiments.ExperimentWithInvalidHypoProbe)
     assert "required argument 'path' is missing from activity" in str(exc.value)