issue #43 backward compability for issue #5

Author: Laurent Pinson

JSONLibrary/JSONLibraryKeywords.py

@@ -86,23 +86,25 @@ def add_object_to_json(self, json_object, json_path, object_to_add):
         return json_object
 
     @keyword("Get Value From Json")
-    def get_value_from_json(self, json_object, json_path):
+    def get_value_from_json(self, json_object, json_path, fail_on_empty=False):
         """Get Value From JSON using JSONPath
 
         Arguments:
             - json_object: json as a dictionary object.
             - json_path: jsonpath expression
+            - fail_on_empty: fail the testcases if nothing is returned
 
         Return array of values
 
         Examples:
         | ${values}=  |  Get Value From Json  | ${json} |  $..phone_number |
+        | ${values}=  |  Get Value From Json  | ${json} |  $..missing | fail_on_empty=${True} |
         """
         json_path_expr = parse(json_path)
         rv=json_path_expr.find(json_object)
-        # make the keyword fails if nothing was return
-        assert_true(rv is not None and len(rv)!=0, 
-            f"Get Value From Json keyword failed to find a value for {json_path}")
+        # optional: make the keyword fails if nothing was return
+        if fail_on_empty is True and (rv is None or len(rv)==0):
+            fail(f"Get Value From Json keyword failed to find a value for {json_path}")
         return [match.value for match in rv]
 
     @keyword("Update Value To Json")
@@ -210,7 +212,7 @@ def should_have_value_in_json(self, json_object, json_path):
         |  Should Have Value In Json  | ${json} |  $..id_card_number |
         """
         try:
-            self.get_value_from_json(json_object, json_path)
+            self.get_value_from_json(json_object, json_path, fail_on_empty=True)
         except AssertionError:
             fail(f"No value found for path {json_path}")
 
@@ -229,7 +231,7 @@ def should_not_have_value_in_json(self, json_object, json_path):
         |  Should Not Have Value In Json  | ${json} |  $..id_card_number |
         """
         try:
-            rv=self.get_value_from_json(json_object, json_path)
+            rv=self.get_value_from_json(json_object, json_path, fail_on_empty=True)
         except AssertionError:
             pass
         else:

JSONLibrary/version.py

@@ -1,4 +1,4 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-VERSION = "0.4"
+VERSION = "0.4.1"

acceptance/JSONLibrary.robot

@@ -26,9 +26,13 @@ TestGetValueByJSONPath
     ${values}=     Get Value From Json    ${json_obj}    $..address.postalCode
     Should Be Equal As Strings    ${values[0]}    630-0192
 
+    ${values}=     Get Value From Json    ${json_obj}    $..errorField
+    ${size}=  Get Length  ${values}
+    Should Be Equal As Integers    ${size}    0
+
 TestErrorGetValueByJSONPath
     [Documentation]  Check Get Value From JSON can fail if no match is found
-    Run Keyword And Expect Error    *failed to find*    Get Value From Json    ${json_obj}    $..errorField
+    Run Keyword And Expect Error    *failed to find*    Get Value From Json    ${json_obj}    $..errorField  fail_on_empty=${True}
 
 TestUpdateValueByJSONPath
     [Documentation]  Update value to json object using JSONPath

docs/JSONLibrary.html

@@ -53,7 +53,12 @@ def test_get_empty_list_from_json_path(self):
 
     def test_get_value_from_json_path_not_found(self):
         json_path = '$..notfound'
-        self.assertRaises(AssertionError, self.test.get_value_from_json, self.json, json_path)
+        self.assertRaises(AssertionError, self.test.get_value_from_json, self.json, json_path, fail_on_empty=True)
+
+        # backward-compatilibity, fail_on_empty is False by default
+        values = self.test.get_value_from_json(self.json, json_path)
+        expected_result = []
+        self.assertListEqual(values, expected_result)
 
     def test_has_value_from_json_path_passed(self):
         json_path = '$..isMarried'