Merge pull request #1130 from cmu-delphi/validator-summary-alert

Modify summary for alerts

Author: krivard

_delphi_utils_python/delphi_utils/validator/report.py

@@ -7,18 +7,22 @@
 class ValidationReport:
     """Class for reporting the results of validation."""
 
-    def __init__(self, errors_to_suppress: List[ValidationFailure]):
+    def __init__(self, errors_to_suppress: List[ValidationFailure], data_source: str = ""):
         """Initialize a ValidationReport.
 
         Parameters
         ----------
         errors_to_suppress: List[ValidationFailure]
             List of ValidationFailures to ignore.
+        data_source: str
+            Name of data source as obtained from params
 
         Attributes
         ----------
         errors_to_suppress: List[ValidationFailure]
             See above
+        data_source: str
+            See above
         num_suppressed: int
             Number of errors suppressed
         total_checks: int
@@ -31,12 +35,12 @@ def __init__(self, errors_to_suppress: List[ValidationFailure]):
             Errors raised from validation failures not found in `self.errors_to_suppress`
         """
         self.errors_to_suppress = errors_to_suppress
+        self.data_source = data_source
         self.num_suppressed = 0
         self.total_checks = 0
         self.raised_errors = []
         self.raised_warnings = []
         self.unsuppressed_errors = []
-        self.summary = ""
 
     def add_raised_error(self, error):
         """Add an error to the report.
@@ -74,21 +78,25 @@ def add_raised_warning(self, warning):
         """
         self.raised_warnings.append(warning)
 
-    def set_summary(self):
-        """Represent summary of report as a string."""
-        out_str = f"{self.total_checks} checks run\n"
-        out_str += f"{len(self.unsuppressed_errors)} checks failed\n"
-        out_str += f"{self.num_suppressed} checks suppressed\n"
-        out_str += f"{len(self.raised_warnings)} warnings\n"
-        self.summary = out_str
-
     def log(self, logger=None):
         """Log errors and warnings."""
         if logger is None:
             logger = get_structured_logger(__name__)
 
-        self.set_summary()
-        logger.info(self.summary)
+        if self.success():
+            logger.info("Validation run successful",
+                data_source = self.data_source,
+                checks_run = self.total_checks,
+                checks_failed = len(self.unsuppressed_errors),
+                checks_suppressed = self.num_suppressed,
+                warnings = len(self.raised_warnings))
+        else:
+            logger.info("Validation run unsuccessful",
+                data_source = self.data_source,
+                checks_run = self.total_checks,
+                checks_failed = len(self.unsuppressed_errors),
+                checks_suppressed = self.num_suppressed,
+                warnings = len(self.raised_warnings))
         for error in self.unsuppressed_errors:
             logger.critical(str(error))
         for warning in self.raised_warnings:

_delphi_utils_python/delphi_utils/validator/validate.py

@@ -37,6 +37,7 @@ def __init__(self, params):
         # Date/time settings
         self.time_window = TimeWindow.from_params(validation_params["common"]["end_date"],
                                                   validation_params["common"]["span_length"])
+        self.data_source = validation_params["common"].get("data_source", "")
 
         self.static_validation = StaticValidator(validation_params)
         self.dynamic_validation = DynamicValidator(validation_params)
@@ -51,7 +52,7 @@ def validate(self):
         Returns:
             - ValidationReport collating the validation outcomes
         """
-        report = ValidationReport(self.suppressed_errors)
+        report = ValidationReport(self.suppressed_errors, self.data_source)
         frames_list = load_all_files(self.export_dir, self.time_window.start_date,
                                      self.time_window.end_date)
         self.static_validation.validate(frames_list, report)

_delphi_utils_python/tests/validator/test_report.py

@@ -40,10 +40,6 @@ def test_str(self):
         report.add_raised_warning(ImportWarning("right import"))
         report.add_raised_error(self.ERROR_1)
         report.add_raised_error(self.ERROR_2)
-        report.set_summary()
-
-        assert report.summary ==\
-            "3 checks run\n1 checks failed\n1 checks suppressed\n2 warnings\n"
 
     def test_log(self):
         """Test that the logs contain all failures and warnings."""