ELI-150: campaign config validation (#264)

* validations - wip

* iteration validation

* iteration rules

* campaign config validation

* made BUC tests bit more clear

* Renaming for clarity.

* lint and formatting fixes.

* wip

* Integration Rules Test

* Actions mapper validator

* Iterations BUC

* available_actions tests

* lint fixes

* lint fixes

* Bump asgiref from 3.8.1 to 3.9.1

Bumps [asgiref](https://github.com/django/asgiref) from 3.8.1 to 3.9.1.
- [Changelog](https://github.com/django/asgiref/blob/main/CHANGELOG.txt)
- [Commits](django/asgiref@3.8.1...3.9.1)

---
updated-dependencies:
- dependency-name: asgiref
  dependency-version: 3.9.1
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump gitpython from 3.1.44 to 3.1.45

Bumps [gitpython](https://github.com/gitpython-developers/GitPython) from 3.1.44 to 3.1.45.
- [Release notes](https://github.com/gitpython-developers/GitPython/releases)
- [Changelog](https://github.com/gitpython-developers/GitPython/blob/main/CHANGES)
- [Commits](gitpython-developers/GitPython@3.1.44...3.1.45)

---
updated-dependencies:
- dependency-name: gitpython
  dependency-version: 3.1.45
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump pyright from 1.1.402 to 1.1.403

Bumps [pyright](https://github.com/RobertCraigie/pyright-python) from 1.1.402 to 1.1.403.
- [Release notes](https://github.com/RobertCraigie/pyright-python/releases)
- [Commits](RobertCraigie/pyright-python@v1.1.402...v1.1.403)

---
updated-dependencies:
- dependency-name: pyright
  dependency-version: 1.1.403
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* ELI-351: Moves/deletes tests after refactoring (#265)

* ELI-351: Moves/deletes tests after refactoring

* ELI-351: Extracts EligibilityResultBuilder and adds tests

* ELI-351: De-extracts EligibilityResultBuilder and moves tests to Eligibility Calculator tests

* ELI-351: Removes duplicated tests

* ELI-351: Removes duplicated tests #2

* ELI-351: Adds validation and audit layer to Readme

* wip - has failing tests

* test fixed and lint error fixed

* warning fixed

* rules validation added

* test commit

* tests updated w.r.t to datatype changes from main

* updated output message

* arguments added to app.py

* sonar fix

* sonar fix

* sonar fix

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: karthikeyannhs <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Shweta <[email protected]>

Author: 4 people

src/rules_validation_api/README.md

@@ -0,0 +1,26 @@
+# 🧪 Campaign-config Validation
+
+This Python script is designed to validate a campaign configuration JSON file.
+
+## 🛠 Requirements
+
+- Python 3.13
+- `rules_validation_api` must be installed and accessible
+- Campaign configuration JSON file to verify
+
+## Steps to verify
+
+- Get to the `rules_validation_api` folder
+- Run `python app.py --config_path <path_to_config>`
+
+## Results
+
+- `On success`:
+
+  ```text
+  "Valid config" is printed
+
+- `On Failure`:
+
+  ```text
+  "Errors" is printed

src/rules_validation_api/__init__.py

@@ -0,0 +1,29 @@
+import argparse
+import json
+import sys
+from pathlib import Path
+
+from rules_validation_api.validators.rules_validator import RulesValidation
+
+GREEN = "\033[92m"  # pragma: no cover
+RESET = "\033[0m"  # pragma: no cover
+YELLOW = "\033[93m"  # pragma: no cover
+RED = "\033[91m"  # pragma: no cover
+
+
+def main() -> None:  # pragma: no cover
+    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()
+
+    try:
+        with Path(args.config_path).open() as file:
+            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")
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

src/rules_validation_api/app.py

@@ -0,0 +1,13 @@
+from pydantic import model_validator
+
+from eligibility_signposting_api.model.campaign_config import ActionsMapper
+
+
+class ActionsMapperValidator(ActionsMapper):
+    @model_validator(mode="after")
+    def validate_keys(self) -> "ActionsMapperValidator":
+        invalid_keys = [key for key in self.root if key is None or key == ""]
+        if invalid_keys:
+            msg = f"Invalid keys found in ActionsMapper: {invalid_keys}"
+            raise ValueError(msg)
+        return self

src/rules_validation_api/validators/__init__.py

@@ -0,0 +1,5 @@
+from eligibility_signposting_api.model.campaign_config import AvailableAction
+
+
+class AvailableActionValidation(AvailableAction):
+    pass

src/rules_validation_api/validators/actions_mapper_validator.py

@@ -0,0 +1,11 @@
+from pydantic import field_validator
+
+from eligibility_signposting_api.model.campaign_config import CampaignConfig, Iteration
+from rules_validation_api.validators.iteration_validator import IterationValidation
+
+
+class CampaignConfigValidation(CampaignConfig):
+    @classmethod
+    @field_validator("iterations")
+    def validate_iterations(cls, iterations: list[Iteration]) -> list[IterationValidation]:
+        return [IterationValidation(**i.model_dump()) for i in iterations]

src/rules_validation_api/validators/available_action_validator.py

@@ -0,0 +1,5 @@
+from eligibility_signposting_api.model.campaign_config import IterationRule
+
+
+class IterationRuleValidation(IterationRule):
+    pass

src/rules_validation_api/validators/campaign_config_validator.py

@@ -0,0 +1,37 @@
+import typing
+
+from pydantic import ValidationError, field_validator, model_validator
+from pydantic_core import InitErrorDetails
+
+from eligibility_signposting_api.model.campaign_config import ActionsMapper, Iteration, IterationRule
+from rules_validation_api.validators.actions_mapper_validator import ActionsMapperValidator
+from rules_validation_api.validators.iteration_rules_validator import IterationRuleValidation
+
+
+class IterationValidation(Iteration):
+    @classmethod
+    @field_validator("iteration_rules")
+    def validate_iterations(cls, iteration_rules: list[IterationRule]) -> list[IterationRuleValidation]:
+        return [IterationRuleValidation(**i.model_dump()) for i in iteration_rules]
+
+    @classmethod
+    @field_validator("actions_mapper", mode="after")
+    def transform_actions_mapper(cls, action_mapper: ActionsMapper) -> ActionsMapper:
+        ActionsMapperValidator.model_validate(action_mapper.model_dump())
+        return action_mapper
+
+    @model_validator(mode="after")
+    def validate_default_comms_routing_in_actions_mapper(self) -> typing.Self:
+        default_routing = self.default_comms_routing
+        actions_mapper = self.actions_mapper.root.keys()
+
+        if default_routing and (not actions_mapper or default_routing not in actions_mapper):
+            error = InitErrorDetails(
+                type="value_error",
+                loc=("actions_mapper",),
+                input=actions_mapper,
+                ctx={"error": f"Missing entry for DefaultCommsRouting '{default_routing}' in ActionsMapper"},
+            )
+            raise ValidationError.from_exception_data(title="IterationValidation", line_errors=[error])
+
+        return self

src/rules_validation_api/validators/iteration_rules_validator.py

@@ -0,0 +1,11 @@
+from pydantic import field_validator
+
+from eligibility_signposting_api.model.campaign_config import CampaignConfig, Rules
+from rules_validation_api.validators.campaign_config_validator import CampaignConfigValidation
+
+
+class RulesValidation(Rules):
+    @classmethod
+    @field_validator("campaign_config")
+    def validate_campaign_config(cls, campaign_config: CampaignConfig) -> CampaignConfig:
+        return CampaignConfigValidation(**campaign_config.model_dump())