Merge pull request #981 from sgsmob/indicator_runner

Change logging scheme for validation

Author: krivard

_delphi_utils_python/delphi_utils/runner.py

@@ -3,6 +3,7 @@
 import importlib
 from typing import Any, Callable, Dict, Optional
 from .archive import ArchiveDiffer, archiver_from_params
+from .logger import get_structured_logger
 from .utils import read_params
 from .validator.validate import Validator
 from .validator.run import validator_from_params
@@ -40,6 +41,7 @@ def run_indicator_pipeline(indicator_fn:  Callable[[Params], None],
     archiver = archiver_fn(params)
     if validator:
         validation_report = validator.validate()
+        validation_report.log(get_structured_logger(params["common"].get("log_filename", None)))
     if archiver and (not validator or validation_report.success()):
         archiver.archive()
 

_delphi_utils_python/delphi_utils/validator/report.py

@@ -4,8 +4,6 @@
 from ..logger import get_structured_logger
 from .errors import ValidationFailure
 
-logger = get_structured_logger(__name__)
-
 class ValidationReport:
     """Class for reporting the results of validation."""
 
@@ -83,14 +81,17 @@ def summary(self):
         out_str += f"{len(self.raised_warnings)} warnings\n"
         return out_str
 
-    def log(self):
+    def log(self, logger=None):
         """Log errors and warnings."""
+        if logger is None:
+            logger = get_structured_logger(__name__)
+
         for error in self.unsuppressed_errors:
             logger.critical(str(error))
         for warning in self.raised_warnings:
             logger.warning(str(warning))
 
-    def print_and_exit(self, die_on_failures=True):
+    def print_and_exit(self, logger=None, die_on_failures=True):
         """Print results and exit.
 
         Arguments
@@ -99,7 +100,7 @@ def print_and_exit(self, die_on_failures=True):
             Whether to return non-zero status if any failures were encountered.
         """
         print(self.summary())
-        self.log()
+        self.log(logger)
         if self.success():
             sys.exit(0)
         elif die_on_failures:

_delphi_utils_python/delphi_utils/validator/run.py

@@ -5,7 +5,7 @@
 when the module is run with `python -m delphi_utils.validator`.
 """
 import argparse as ap
-from .. import read_params
+from .. import read_params, get_structured_logger
 from .validate import Validator
 
 
@@ -15,8 +15,12 @@ def run_module():
     parser.add_argument("--dry_run", action="store_true", help="When provided, return zero exit"
                         " status irrespective of the number of failures")
     args = parser.parse_args()
-    validator = Validator(read_params())
-    validator.validate().print_and_exit(not args.dry_run)
+    params = read_params()
+    validator = Validator(params)
+    validator.validate().print_and_exit(
+        get_structured_logger(__name__,
+                              params["common"].get("log_filename", None),
+                              not args.dry_run))
 
 
 def validator_from_params(params):

_delphi_utils_python/tests/test_runner.py

@@ -35,6 +35,7 @@ class TestRunIndicator:
     """Fixture for running indicators."""
     # arbitrary params to pass to function generators
     PARAMS = {
+        "common": {},
         "indicator": {"a": 1},
         "validation": {"b": 2},
         "archive": {"c": 3}

_delphi_utils_python/tests/validator/test_report.py

@@ -44,9 +44,9 @@ def test_str(self):
         assert report.summary() ==\
             "3 checks run\n1 checks failed\n1 checks suppressed\n2 warnings\n"
 
-    @mock.patch("delphi_utils.validator.report.logger")
-    def test_log(self, mock_logger):
+    def test_log(self):
         """Test that the logs contain all failures and warnings."""
+        mock_logger = mock.Mock()
         report = ValidationReport([self.ERROR_1])
         report.increment_total_checks()
         report.increment_total_checks()
@@ -56,7 +56,7 @@ def test_log(self, mock_logger):
         report.add_raised_error(self.ERROR_1)
         report.add_raised_error(self.ERROR_2)
 
-        report.log()
+        report.log(mock_logger)
         mock_logger.critical.assert_called_once_with(
             "bad failed for sig2 at resolution county on 2020-11-07: msg 2")
         mock_logger.warning.assert_has_calls([mock.call("wrong import"), mock.call("right import")])