refined the error messages

Author: Karthikeyannhs

src/rules_validation_api/app.py

@@ -4,21 +4,37 @@
 import sys
 from pathlib import Path
 
+from pydantic import ValidationError
+
 from rules_validation_api.validators.rules_validator import RulesValidation
 
 logging.basicConfig(
-    level=logging.INFO,  # or DEBUG for more detail
+    level=logging.INFO,
     format="%(asctime)s | %(levelname)s | %(name)s | %(message)s",
     force=True,
 )
 
-GREEN = "\033[92m"  # pragma: no cover
-RESET = "\033[0m"  # pragma: no cover
-YELLOW = "\033[93m"  # pragma: no cover
-RED = "\033[91m"  # pragma: no cover
+GREEN = "\033[92m"
+RESET = "\033[0m"
+YELLOW = "\033[93m"
+RED = "\033[91m"
+
+
+def refine_error(e: ValidationError) -> str:
+    """Return a very short, single-line error message."""
+    lines = [f"Validation Error: {len(e.errors())} validation error(s)"]
+
+    for err in e.errors():
+        loc = ".".join(str(x) for x in err["loc"])
+        msg = err["msg"]
+        type_ = err["type"]
 
+        lines.append(f"{loc} : {msg} [type={type_}]")
 
-def main() -> None:  # pragma: no cover
+    return "\n".join(lines)
+
+
+def main() -> None:
     parser = argparse.ArgumentParser(description="Validate campaign configuration.")
     parser.add_argument("--config_path", required=True, help="Path to the campaign config JSON file")
     args = parser.parse_args()
@@ -28,9 +44,11 @@ def main() -> None:  # pragma: no cover
             json_data = json.load(file)
             RulesValidation(**json_data)
             sys.stdout.write(f"{GREEN}Valid Config{RESET}\n")
-    except ValueError as e:
-        sys.stderr.write(f"{YELLOW}Validation Error:{RESET} {RED}{e}{RESET}\n")
+
+    except ValidationError as e:
+        clean = refine_error(e)
+        sys.stderr.write(f"{YELLOW}{clean}{RESET}\n")
 
 
-if __name__ == "__main__":  # pragma: no cover
+if __name__ == "__main__":
     main()

src/rules_validation_api/validators/campaign_config_validator.py

@@ -37,16 +37,20 @@ def validate_campaign_has_iteration_within_schedule(self) -> typing.Self:
         errors: list[str] = []
         iterations_by_date = sorted(self.iterations, key=attrgetter("iteration_date"))
 
-        for iteration in iterations_by_date:
+        for idx, iteration in enumerate(iterations_by_date):
             if iteration.iteration_date < self.start_date:
                 errors.append(
-                    f"\nIteration {iteration.id} starts before campaign {self.id} start date {self.start_date}."
+                    f"CampaignConfig.Iterations.{idx}.IterationDate : "
+                    f"Starts before campaign start date {self.start_date} [type=invalid]"
                 )
             if iteration.iteration_date > self.end_date:
-                errors.append(f"\nIteration {iteration.id} starts after campaign {self.id} end date {self.end_date}.")
+                errors.append(
+                    f"CampaignConfig.Iterations.{idx}.IterationDate : "
+                    f"Starts after campaign end date {self.end_date} [type=invalid]"
+                )
 
         if errors:
-            # Raise one exception with all messages joined
-            raise ValueError("".join(errors))
+            # Raise one exception with all messages joined by newlines
+            raise ValueError("\n".join(errors))
 
         return self

tests/unit/validation/test_campaign_config_validator.py

@@ -244,8 +244,8 @@ def test_invalid_end_dates_and_iteration_dates_relation(
             CampaignConfigValidation(**data)
 
         errors = exc_info.value.errors()
-        assert "Iteration ITER001 starts after" in errors[0]["msg"]
-        assert "Iteration ITER002 starts after" in errors[0]["msg"]
+        assert "Starts after" in errors[0]["msg"]
+        assert "Starts after" in errors[0]["msg"]
 
     @pytest.mark.parametrize(
         ("start_date", "end_date"),
@@ -265,8 +265,8 @@ def test_invalid_start_date_and_iteration_dates_relation(
             CampaignConfigValidation(**data)
 
         errors = exc_info.value.errors()
-        assert "Iteration ITER001 starts before" in errors[0]["msg"]
-        assert "Iteration ITER002 starts before" in errors[0]["msg"]
+        assert "Starts before" in errors[0]["msg"]
+        assert "Starts before" in errors[0]["msg"]
 
     # Iteration
     def test_validate_iterations_non_empty(self, valid_campaign_config_with_only_mandatory_fields):