Add Aluminium releases to comparestream lib

[integration/test.git] / csit / libraries / norm_json.py

diff --git a/csit/libraries/norm_json.py b/csit/libraries/norm_json.py
index 8a84fc27d3df5ca99d12a635c700c6f64f12f988..cc208277d8e15dd4853cbd160f131c0174510e0f 100644 (file)
--- a/csit/libraries/norm_json.py
+++ b/csit/libraries/norm_json.py
@@ -6,6 +6,7 @@
 # and is available at http://www.eclipse.org/legal/epl-v10.html
 
 import collections as _collections
+import jmespath
 try:
     import simplejson as _json
 except ImportError:  # Python2.7 calls it json.
@@ -84,6 +85,7 @@ class _Decoder(_json.JSONDecoder):
 
     Based on: http://stackoverflow.com/questions/10885238/
     python-change-list-type-for-json-decoding"""
+
     def __init__(self, **kwargs):
         """Initialize decoder with special array implementation."""
         _json.JSONDecoder.__init__(self, **kwargs)
@@ -104,11 +106,12 @@ def loads_sorted(text, strict=False):
 
 def dumps_indented(obj, indent=1):
     """
-    Wrapper for json.dumps with default indentation level. Adds newline.
+    Wrapper for json.dumps with default indentation level.
 
     The main value is that BuiltIn.Evaluate cannot easily accept Python object
     as part of its argument.
     Also, allows to use something different from RequestsLibrary.To_Json
+
     """
     pretty_json = _json.dumps(obj, separators=(',', ': '), indent=indent)
     return pretty_json + '\n'  # to avoid diff "no newline" warning line
@@ -151,15 +154,54 @@ def sort_bits(obj, keys_with_bits=[]):
     return obj
 
 
-def normalize_json_text(text, strict=False, indent=1, keys_with_bits=[]):
+def hide_volatile(obj, keys_with_volatiles=[]):
+    """
+    Takes list of keys with volatile values, and replaces them with generic "*"
+
+    :param obj: python dict from json
+    :param keys_with_volatiles: list of volatile keys
+    :return: corrected
+    """
+    if isinstance(obj, dict):
+        for key, value in obj.iteritems():
+            # Unicode is not str and vice versa, isinstance has to check for both.
+            # Luckily, "in" recognizes equivalent strings in different encodings.
+            # Type "bytes" is added for Python 3 compatibility.
+            if key in keys_with_volatiles and isinstance(value, (unicode, str, bytes, int, bool)):
+                obj[key] = "*"
+            else:
+                hide_volatile(value, keys_with_volatiles)
+    # A string is not a list, so there is no risk of recursion over characters.
+    elif isinstance(obj, list):
+        for item in obj:
+            hide_volatile(item, keys_with_volatiles)
+    return obj
+
+
+def normalize_json_text(text, strict=False, indent=1, keys_with_bits=[], keys_with_volatiles=[], jmes_path=None):
     """
     Attempt to return sorted indented JSON string.
 
+    If jmes_path is set the related subset of JSON data is returned as
+    indented JSON string if the subset exists. Empty string is returned if the
+    subset doesn't exist.
+    Empty string is returned if text is not passed.
     If parse error happens:
     If strict is true, raise the exception.
     If strict is not true, return original text with error message.
     If keys_with_bits is non-empty, run sort_bits on intermediate Python object.
     """
+
+    if not text:
+        return ""
+
+    if jmes_path:
+        json_obj = _json.loads(text)
+        subset = jmespath.search(jmes_path, json_obj)
+        if not subset:
+            return ""
+        text = _json.dumps(subset)
+
     try:
         object_decoded = loads_sorted(text)
     except ValueError as err:
@@ -169,5 +211,9 @@ def normalize_json_text(text, strict=False, indent=1, keys_with_bits=[]):
             return str(err) + '\n' + text
     if keys_with_bits:
         sort_bits(object_decoded, keys_with_bits)
+    if keys_with_volatiles:
+        hide_volatile(object_decoded, keys_with_volatiles)
+
     pretty_json = dumps_indented(object_decoded, indent=indent)
+
     return pretty_json