refactor to code and src to use enums

Author: Akol125

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

@@ -1,11 +1,15 @@
 # all error Levels
-CRITICAL_ERROR = 0
-WARNING = 1
-NOTIFICATION = 2
+from enum import IntEnum
+
+
+class ErrorLevels(IntEnum):
+    CRITICAL_ERROR = 0
+    WARNING = 1
+    NOTIFICATION = 2
 
 
 MESSAGES = {
-    CRITICAL_ERROR: "Critical Validation Error [%s]: %s",
-    WARNING: "Non-Critical Validation Error [%s]: %s",
-    NOTIFICATION: "Quality Issue Found [%s]: %s",
+    ErrorLevels.CRITICAL_ERROR: "Critical Validation Error [%s]: %s",
+    ErrorLevels.WARNING: "Non-Critical Validation Error [%s]: %s",
+    ErrorLevels.NOTIFICATION: "Quality Issue Found [%s]: %s",
 }

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

@@ -1,30 +1,35 @@
 # all exceptions and messgaes
-UNEXPECTED_EXCEPTION = 0
-VALUE_CHECK_FAILED = 1
-HEADER_CHECK_FAILED = 2
-RECORD_LENGTH_CHECK_FAILED = 3
-VALUE_PREDICATE_FALSE = 4
-RECORD_CHECK_FAILED = 5
-RECORD_PREDICATE_FALSE = 6
-UNIQUE_CHECK_FAILED = 7
-ASSERT_CHECK_FAILED = 8
-FINALLY_ASSERT_CHECK_FAILED = 9
-PARSING_ERROR = 10
-PARENT_FAILED = 11
-KEY_CHECK_FAILED = 12
+from enum import IntEnum
+
+
+class ExceptionLevels(IntEnum):
+    UNEXPECTED_EXCEPTION = 0
+    VALUE_CHECK_FAILED = 1
+    HEADER_CHECK_FAILED = 2
+    RECORD_LENGTH_CHECK_FAILED = 3
+    VALUE_PREDICATE_FALSE = 4
+    RECORD_CHECK_FAILED = 5
+    RECORD_PREDICATE_FALSE = 6
+    UNIQUE_CHECK_FAILED = 7
+    ASSERT_CHECK_FAILED = 8
+    FINALLY_ASSERT_CHECK_FAILED = 9
+    PARSING_ERROR = 10
+    PARENT_FAILED = 11
+    KEY_CHECK_FAILED = 12
+
 
 MESSAGES = {
-    UNEXPECTED_EXCEPTION: "Unexpected exception [%s]: %s",
-    VALUE_CHECK_FAILED: "Value check failed.",
-    HEADER_CHECK_FAILED: "Header check failed.",
-    RECORD_LENGTH_CHECK_FAILED: "Record length check failed.",
-    RECORD_CHECK_FAILED: "Record check failed.",
-    VALUE_PREDICATE_FALSE: "Value predicate returned false.",
-    RECORD_PREDICATE_FALSE: "Record predicate returned false.",
-    UNIQUE_CHECK_FAILED: "Unique check failed.",
-    ASSERT_CHECK_FAILED: "Assertion check failed.",
-    FINALLY_ASSERT_CHECK_FAILED: "Final assertion check failed.",
-    PARSING_ERROR: "Failed to parse data correctly.",
-    PARENT_FAILED: "The parent expression failed to validate",
-    KEY_CHECK_FAILED: "Value could not be found in the Key list",
+    ExceptionLevels.UNEXPECTED_EXCEPTION: "Unexpected exception [%s]: %s",
+    ExceptionLevels.VALUE_CHECK_FAILED: "Value Check Failed [%s]: %s",
+    ExceptionLevels.HEADER_CHECK_FAILED: "Header Check Failed [%s]: %s",
+    ExceptionLevels.RECORD_LENGTH_CHECK_FAILED: "Record Length Check Failed [%s]: %s",
+    ExceptionLevels.RECORD_CHECK_FAILED: "Record Check Failed [%s]: %s",
+    ExceptionLevels.VALUE_PREDICATE_FALSE: "Value Predicate False [%s]: %s",
+    ExceptionLevels.RECORD_PREDICATE_FALSE: "Record Predicate False [%s]: %s",
+    ExceptionLevels.UNIQUE_CHECK_FAILED: "Unique Check Failed [%s]: %s",
+    ExceptionLevels.ASSERT_CHECK_FAILED: "Assert Check Failed [%s]: %s",
+    ExceptionLevels.FINALLY_ASSERT_CHECK_FAILED: "Finally Assert Check Failed [%s]: %s",
+    ExceptionLevels.PARSING_ERROR: "Parsing Error [%s]: %s",
+    ExceptionLevels.PARENT_FAILED: "Parent Failed [%s]: %s",
+    ExceptionLevels.KEY_CHECK_FAILED: "Key Check Failed [%s]: %s",
 }

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

@@ -1,5 +1,7 @@
 """
 A parser for navigating and extracting data from FHIR JSON resources.
+
+Identifiy a path to a node using '|' to separate levels and
 """
 
 import json

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

@@ -3,7 +3,7 @@
 
 from dateutil import parser
 
-import common.validator.enums.error_levels as ErrorLevels
+from common.validator.enums.error_levels import ErrorLevels
 from common.validator.record_error import ErrorReport
 
 

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

@@ -2,8 +2,9 @@
 
 from enum import Enum
 
-import common.validator.enums.error_levels as ErrorLevels
-import common.validator.enums.exception_messages as ExceptionMessages
+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.expression_checker import ExpressionChecker
 from common.validator.parsers.csv_line_parser import CSVLineParser
 from common.validator.parsers.csv_parser import CSVParser
@@ -98,10 +99,8 @@ def _validate_expression(
             parent_expression = expression["parentExpression"]
             if self._check_error_record_for_fail(parent_expression):
                 error_record = {
-                    "code": ExceptionMessages.PARENT_FAILED,
-                    "message": ExceptionMessages.MESSAGES[ExceptionMessages.PARENT_FAILED]
-                    + ", Parent ID: "
-                    + parent_expression,
+                    "code": ExceptionLevels.PARENT_FAILED,
+                    "message": MESSAGES[ExceptionLevels.PARENT_FAILED] + ", Parent ID: " + parent_expression,
                 }
                 self._add_error_record(
                     error_record, expression_error_group, expression_name, expression_id, error_level
@@ -112,7 +111,7 @@ def _validate_expression(
             expression_values = self.data_parser.get_key_value(expression_fieldname)
         except Exception as e:
             message = f"Data get values Unexpected exception [{e.__class__.__name__}]: {e}"
-            error_report = ErrorReport(code=ExceptionMessages.PARSING_ERROR, message=message)
+            error_report = ErrorReport(code=ExceptionLevels.PARSING_ERROR, message=message)
             # original code had self.CriticalErrorLevel. Replaced with error_level
             self._add_error_record(error_report, expression_error_group, expression_name, expression_id, error_level)
             return error_report

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

@@ -2,7 +2,7 @@
 from unittest.mock import MagicMock
 from unittest.mock import patch
 
-import common.validator.enums.exception_messages as ExceptionMessages
+from common.validator.enums.exception_messages import ExceptionLevels
 from common.validator.expression_checker import ExpressionChecker
 
 # TODO this needs to be expanded to cover all expression types
@@ -29,9 +29,10 @@ def test_validate_datetime_valid(self):
             "DATETIME", rule="", field_name="timestamp", field_value="2022-01-01T12:00:00", row={}
         )
         self.assertEqual(
-            result.message, "Unexpected exception [ValueError]: Invalid isoformat string: '2022-01-01T12:00:00'"
+            result.message,
+            "Unexpected exception [ValueError]: Invalid isoformat string: '2022-01-01T12:00:00'",
         )
-        self.assertEqual(result.code, ExceptionMessages.UNEXPECTED_EXCEPTION)
+        self.assertEqual(result.code, ExceptionLevels.UNEXPECTED_EXCEPTION)
         self.assertEqual(result.field, "timestamp")
 
     def test_validate_uuid_valid(self):
@@ -44,7 +45,7 @@ def test_validate_integer_invalid(self):
         result = self.expression_checker.validate_expression(
             "INT", rule="", field_name="age", field_value="hello world", row={}
         )
-        self.assertEqual(result.code, ExceptionMessages.UNEXPECTED_EXCEPTION)
+        self.assertEqual(result.code, ExceptionLevels.UNEXPECTED_EXCEPTION)
         self.assertEqual(result.field, "age")
         self.assertIn("invalid literal for int()", result.message)
 

lambdas/shared/tests/test_common/validator/test_expression_checker.py

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