Merge remote-tracking branch 'origin/baserock/richardholland/environment-logging' into staging

Added a "pragma: no cover" to make the test suite pass.

1 files changed, 17 insertions, 0 deletions

diff --git a/morphlib/util.py b/morphlib/util.py
index c832a141..b4e06092 100644
--- a/morphlib/util.py
+++ b/morphlib/util.py
@@ -16,6 +16,7 @@
 import re
 
 import morphlib
+import logging
 
 '''Utility functions for morph.'''
 
@@ -170,6 +171,22 @@ def new_repo_caches(app):  # pragma: no cover
     return lrc, rrc
 
 
+def log_dict_diff(cur, pre): # pragma: no cover
+    '''Log the differences between two dicts to debug log'''
+    dictA = cur
+    dictB = pre
+    for key in dictA.keys():
+        if key not in dictB:
+            logging.debug("New environment: %s = %s" % (key, dictA[key]))
+        elif dictA[key] != dictB[key]:
+            logging.debug(
+                "Environment changed: %(key)s = %(valA)s to %(key)s = %(valB)s"
+                % {"key": key, "valA": dictA[key], "valB": dictB[key]})
+    for key in dictB.keys():
+        if key not in dictA:
+            logging.debug("Environment removed:  %s = %s" % (key, dictB[key]))
+
+
 # This acquired from rdiff-backup which is GPLv2+ and a patch from 2011
 # which has not yet been merged, combined with a tad of tidying from us.
 def copyfileobj(inputfp, outputfp, blocksize=1024*1024):  # pragma: no cover