add constants and refactor dq_reporter.py

Author: Akol125

…d/src/common/validator/enums/__init__.py …c/common/validator/constants/__init__.pylambdas/shared/src/common/validator/enums/__init__.py renamed to lambdas/shared/src/common/validator/constants/__init__.py lambdas/shared/src/common/validator/enums/__init__.py renamed to lambdas/shared/src/common/validator/constants/__init__.py

@@ -1,5 +1,26 @@
-# all exceptions and messgaes
 from enum import IntEnum
+from enum import StrEnum
+
+
+# Used for error report messages in DQ Reporter to categorize error levels
+class ErrorLevels(IntEnum):
+    CRITICAL_ERROR = 0
+    WARNING = 1
+    NOTIFICATION = 2
+
+
+MESSAGES = {
+    ErrorLevels.CRITICAL_ERROR: "Critical Validation Error [%s]: %s",
+    ErrorLevels.WARNING: "Non-Critical Validation Error [%s]: %s",
+    ErrorLevels.NOTIFICATION: "Quality Issue Found [%s]: %s",
+}
+
+
+# Constants for error report messages used in Expression Checker
+class MessageLabel(StrEnum):
+    EXPECTED_LABEL = "Expected- "
+    FOUND_LABEL = "Found- "
+    VALUE_MISMATCH_MSG = "Value does not equal expected value, "
 
 
 class ExceptionLevels(IntEnum):

…on/validator/enums/exception_messages.py …/src/common/validator/constants/enums.pylambdas/shared/src/common/validator/enums/exception_messages.py renamed to lambdas/shared/src/common/validator/constants/enums.py lambdas/shared/src/common/validator/enums/exception_messages.py renamed to lambdas/shared/src/common/validator/constants/enums.py

@@ -0,0 +1,12 @@
+error_report = {
+    "eventId": "",
+    "validationDate": "",
+    "validated": "true",
+    "results": {
+        "totalErrors": 0,
+        "completeness": {"errors": 0, "fields": []},
+        "consistency": {"errors": 0, "fields": []},
+        "validity": {"errors": 0, "fields": []},
+        "timeliness_processed": 0,
+    },
+}

lambdas/shared/src/common/validator/constants/error_report.py

@@ -2,46 +2,16 @@
 import datetime
 import re
 import uuid
-from enum import Enum
 from enum import StrEnum
 
-from common.validator.enums.exception_messages import MESSAGES
-from common.validator.enums.exception_messages import ExceptionLevels
+from common.validator.constants.enums import MESSAGES
+from common.validator.constants.enums import ExceptionLevels
 from common.validator.lookup_expressions.key_data import KeyData
 from common.validator.lookup_expressions.lookup_data import LookUpData
 from common.validator.record_error import ErrorReport
 from common.validator.record_error import RecordError
 
 
-class ExpressionType(Enum):
-    DATETIME = "DATETIME"
-    DATE = "DATE"
-    UUID = "UUID"
-    INT = "INT"
-    FLOAT = "FLOAT"
-    REGEX = "REGEX"
-    EQUAL = "EQUAL"
-    NOTEQUAL = "NOTEQUAL"
-    IN = "IN"
-    NRANGE = "NRANGE"
-    INARRAY = "INARRAY"
-    UPPER = "UPPER"
-    LOWER = "LOWER"
-    LENGTH = "LENGTH"
-    STARTSWITH = "STARTSWITH"
-    ENDSWITH = "ENDSWITH"
-    EMPTY = "EMPTY"
-    NOTEMPTY = "NOTEMPTY"
-    POSITIVE = "POSITIVE"
-    GENDER = "GENDER"
-    NHSNUMBER = "NHSNUMBER"
-    MAXOBJECTS = "MAXOBJECTS"
-    POSTCODE = "POSTCODE"
-    ONLYIF = "ONLYIF"
-    LOOKUP = "LOOKUP"
-    KEYCHECK = "KEYCHECK"
-
-
 class MessageLabel(StrEnum):
     EXPECTED_LABEL = "Expected- "
     FOUND_LABEL = "Found- "

lambdas/shared/src/common/validator/enums/error_levels.py

@@ -3,35 +3,31 @@
 
 from dateutil import parser
 
-from common.validator.enums.error_levels import ErrorLevels
+from common.validator.constants.enums import ErrorLevels
+from common.validator.constants.error_report import error_report
 from common.validator.record_error import ErrorReport
 
 
 class DQReporter:
+    """
+    Generates error reports based on validation results.
+    It uses cumulates all error records, assigns them to the appropriate error levels,
+    checks the time difference between event occurrence and validation time,
+    and builds a structured error report in JSON format.
+    """
+
     def __init__(self):
         # parser variables
-        self.error_report = {
-            "eventId": "",
-            "validationDate": "",
-            "validated": "true",
-            "results": {
-                "totalErrors": 0,
-                "completeness": {"errors": 0, "fields": []},
-                "consistency": {"errors": 0, "fields": []},
-                "validity": {"errors": 0, "fields": []},
-                "timeliness_processed": 0,
-            },
-        }
+        self.error_report = error_report
 
     # create the date difference for the report in minutes
-    def diff_dates(self, date1, date2):
-        diff_seconds = abs(date2 - date1).total_seconds()
+    def diff_dates(self, fhir_event_date, current_date):
+        diff_seconds = abs(current_date - fhir_event_date).total_seconds()
         diff_minutes = diff_seconds / 60
         return diff_minutes
 
-    def generate_error_report(self, event_id, occurrence, error_records: list[ErrorReport]):
-        occurrence_date = occurrence
-        occurrence_date = parser.parse(occurrence_date, ignoretz=True)
+    def generate_error_report(self, event_id, occurrence_date_time, error_records: list[ErrorReport]):
+        occurrence_date = parser.parse(occurrence_date_time, ignoretz=True)
         validation_date = datetime.datetime.now(tz=None)
 
         time_taken = self.diff_dates(occurrence_date, validation_date)

lambdas/shared/src/common/validator/expression_checker.py

@@ -6,9 +6,9 @@
 
 from enum import Enum
 
-from common.validator.enums.error_levels import ErrorLevels
-from common.validator.enums.exception_messages import MESSAGES
-from common.validator.enums.exception_messages import ExceptionLevels
+from common.validator.constants.enums import MESSAGES
+from common.validator.constants.enums import ErrorLevels
+from common.validator.constants.enums import ExceptionLevels
 from common.validator.expression_checker import ExpressionChecker
 from common.validator.parsers.csv_line_parser import CSVLineParser
 from common.validator.parsers.csv_parser import CSVParser

lambdas/shared/src/common/validator/reporter/dq_reporter.py

@@ -2,7 +2,7 @@
 from unittest.mock import MagicMock
 from unittest.mock import patch
 
-from common.validator.enums.exception_messages import ExceptionLevels
+from common.validator.constants.enums import ExceptionLevels
 from common.validator.expression_checker import ExpressionChecker
 from common.validator.record_error import ErrorReport
 
@@ -31,8 +31,7 @@ def make_checker(self, mock_data=None, summarise=False, report=True):
         """Helper to create an ExpressionChecker with mock parser data."""
         return ExpressionChecker(MockParser(mock_data), summarise, report)
 
-    # --- DATETIME & UUID -------------------------------------------------
-
+    # Date Time Check
     def test_datetime_valid(self):
         """Valid ISO date should pass without error."""
         checker = self.make_checker({"date_field": "2025-01-01"})
@@ -52,8 +51,7 @@ def test_uuid_valid_and_invalid(self):
         self.assertIsNone(checker.validate_expression("UUID", None, "uuid_field", valid_uuid, 1))
         self.assertIsInstance(checker.validate_expression("UUID", None, "uuid_field", "not-a-uuid", 1), ErrorReport)
 
-    # --- NUMERIC, LENGTH, REGEX ------------------------------------------
-
+    # Numeric Length and Regex
     def test_integer_length_and_regex_rules(self):
         """Test integer, length, and regex-based validations."""
         checker = self.make_checker()
@@ -67,8 +65,7 @@ def test_integer_length_and_regex_rules(self):
         # REGEX mismatch -> Error
         self.assertIsInstance(checker.validate_expression("REGEX", r"^abc$", "regex_field", "abcd", 1), ErrorReport)
 
-    # --- CASE & STRING POSITION RULES ------------------------------------
-
+    # Case & String Position Rules
     def test_upper_lower_startswith_endswith_rules(self):
         """Validate case and string boundary conditions."""
         checker = self.make_checker()

lambdas/shared/src/common/validator/validator.py

@@ -2,7 +2,7 @@
 from unittest.mock import MagicMock
 from unittest.mock import patch
 
-from common.validator.enums.error_levels import ErrorLevels
+from common.validator.constants.enums import ErrorLevels
 from common.validator.record_error import ErrorReport
 from common.validator.validator import DataType
 from common.validator.validator import Validator