added a tracker to let know what validations are done

Author: Karthikeyannhs

src/eligibility_signposting_api/model/campaign_config.py

@@ -269,6 +269,12 @@ class Iteration(BaseModel):
 
     model_config = {"populate_by_name": True, "arbitrary_types_allowed": True, "extra": "ignore"}
 
+    def __init__(self, **data: dict[str, typing.Any]) -> None:
+        super().__init__(**data)
+        # Ensure each rule knows its parent iteration
+        for rule in self.iteration_rules:
+            rule.set_parent(self)
+
     @field_validator("iteration_date", mode="before")
     @classmethod
     def parse_dates(cls, v: str | date) -> date:
@@ -292,12 +298,6 @@ def parse_dates(cls, v: str | date) -> date:
     def serialize_dates(v: date, _info: SerializationInfo) -> str:
         return v.strftime("%Y%m%d")
 
-    @model_validator(mode="after")
-    def attach_rule_parents(self) -> Iteration:
-        for rule in self.iteration_rules:
-            rule.set_parent(self)
-        return self
-
     def __str__(self) -> str:
         return json.dumps(self.model_dump(by_alias=True), indent=2)
 

src/rules_validation_api/app.py

@@ -2,23 +2,30 @@
 import json
 import logging
 import sys
+from collections import defaultdict
 from pathlib import Path
 
+from rules_validation_api.decorators.tracker import VALIDATORS_CALLED
 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"
 
+# ANSI color codes
+LEFT_COLOR = "\033[34m"  # Blue for class name
+COLON_COLOR = "\033[33m"  # Yellow for colon
+RIGHT_COLOR = "\033[92m"  # Milk green for validator
 
-def main() -> None:  # pragma: no cover
+
+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 +35,22 @@ def main() -> None:  # pragma: no cover
             json_data = json.load(file)
             RulesValidation(**json_data)
             sys.stdout.write(f"{GREEN}Valid Config{RESET}\n")
+
+            # --- Group by class ---
+            grouped = defaultdict(list)
+            for v in VALIDATORS_CALLED:
+                cls, method = v.split(":", 1)
+                grouped[cls].append(method.strip())
+
+            # --- Sort classes descending, methods ascending ---
+            for cls_name in sorted(grouped.keys(), reverse=True):
+                for method_name in sorted(grouped[cls_name]):
+                    colored = f"{LEFT_COLOR}{cls_name}{RESET}{COLON_COLOR}:{RESET}{RIGHT_COLOR}{method_name}{RESET}"
+                    sys.stdout.write(f"{colored}\n")
+
     except ValueError as e:
         sys.stderr.write(f"{YELLOW}Validation Error:{RESET} {RED}{e}{RESET}\n")
 
 
-if __name__ == "__main__":  # pragma: no cover
+if __name__ == "__main__":
     main()

src/rules_validation_api/decorators/__init__.py

@@ -0,0 +1,28 @@
+from typing import Self
+
+from pydantic import model_validator
+
+VALIDATORS_CALLED: list[str] = []
+
+
+# --- Mixin and decorator to track validators ---
+class TrackValidatorsMixin:
+    """
+    Mixin to track all validator names in a Pydantic model.
+    """
+
+    @model_validator(mode="after")
+    def _track_validators(self) -> Self:
+        for name in dir(self):
+            if name.startswith(("validate_", "check_")) and callable(getattr(self, name)):
+                full_name = f"{self.__class__.__name__}:{name}"
+                if full_name not in VALIDATORS_CALLED:
+                    VALIDATORS_CALLED.append(full_name)
+        return self
+
+
+def track_validators(cls) -> type:  # noqa:ANN001
+    """
+    Decorator to add the tracking mixin to a Pydantic model.
+    """
+    return type(cls.__name__, (TrackValidatorsMixin, cls), {})

src/rules_validation_api/decorators/tracker.py

@@ -1,9 +1,11 @@
 from pydantic import ValidationError, model_validator
 
 from eligibility_signposting_api.model.campaign_config import ActionsMapper
+from rules_validation_api.decorators.tracker import track_validators
 from rules_validation_api.validators.available_action_validator import AvailableActionValidation
 
 
+@track_validators
 class ActionsMapperValidation(ActionsMapper):
     @model_validator(mode="after")
     def validate_keys(self) -> "ActionsMapperValidation":
@@ -16,17 +18,14 @@ def validate_keys(self) -> "ActionsMapperValidation":
     @model_validator(mode="after")
     def validate_values(self) -> "ActionsMapperValidation":
         error_report = []
-
         for key, value in self.root.items():
             try:
                 AvailableActionValidation.model_validate(value.model_dump())
             except ValidationError as e:
                 for err in e.errors():
                     msg = err.get("msg", "Unknown error").replace("Value error, ", "")
                     error_report.append(f"\n Action '{key}': {msg}")
-
         if error_report:
             final_msg = "Markdown Validation Issues:".join(error_report)
             raise ValueError(final_msg)
-
         return self

src/rules_validation_api/validators/actions_mapper_validator.py

@@ -3,8 +3,10 @@
 from pydantic import field_validator
 
 from eligibility_signposting_api.model.campaign_config import AvailableAction
+from rules_validation_api.decorators.tracker import track_validators
 
 
+@track_validators
 class AvailableActionValidation(AvailableAction):
     @field_validator("action_description")
     @classmethod

src/rules_validation_api/validators/available_action_validator.py

@@ -5,9 +5,11 @@
 from pydantic import field_validator, model_validator
 
 from eligibility_signposting_api.model.campaign_config import CampaignConfig, Iteration
+from rules_validation_api.decorators.tracker import track_validators
 from rules_validation_api.validators.iteration_validator import IterationValidation
 
 
+@track_validators
 class CampaignConfigValidation(CampaignConfig):
     @field_validator("iterations")
     @classmethod

src/rules_validation_api/validators/campaign_config_validator.py

@@ -1,5 +1,7 @@
 from eligibility_signposting_api.model.campaign_config import IterationCohort
+from rules_validation_api.decorators.tracker import track_validators
 
 
+@track_validators
 class IterationCohortValidation(IterationCohort):
     pass

src/rules_validation_api/validators/iteration_cohort_validator.py

@@ -8,8 +8,10 @@
     RuleAttributeName,
     RuleType,
 )
+from rules_validation_api.decorators.tracker import track_validators
 
 
+@track_validators
 class IterationRuleValidation(IterationRule):
     @model_validator(mode="after")
     def check_cohort_attribute_name(self) -> typing.Self:

src/rules_validation_api/validators/iteration_rules_validator.py

@@ -11,12 +11,14 @@
     IterationRule,
     RuleType,
 )
+from rules_validation_api.decorators.tracker import track_validators
 from rules_validation_api.validators.actions_mapper_validator import ActionsMapperValidation
 from rules_validation_api.validators.available_action_validator import AvailableActionValidation
 from rules_validation_api.validators.iteration_cohort_validator import IterationCohortValidation
 from rules_validation_api.validators.iteration_rules_validator import IterationRuleValidation
 
 
+@track_validators
 class IterationValidation(Iteration):
     @field_validator("iteration_rules")
     @classmethod