add 'Should (not) Have Value in JSON' keywords

Author: Laurent Pinson

JSONLibrary/JSONLibraryKeywords.py

@@ -155,7 +155,7 @@ def convert_json_to_string(self, json_object):
         """
         return json.dumps(json_object)
 
-    @keyword('Convert String to JSON')
+    @keyword('Convert String To JSON')
     def convert_string_to_json(self, json_string):
         """Convert String to JSON object
 
@@ -169,10 +169,60 @@ def convert_string_to_json(self, json_string):
         """
         return json.loads(json_string)
 
-    @keyword('Dump JSON to file')
+    @keyword('Dump JSON To File')
     def dump_json_to_file(self, dest_file, json_object):
+        """Dump JSON to file
+
+        Arguments:
+            - dest_file: destination file
+            - json_object: json as a dictionary object.
+
+        Export the JSON object to a file
+
+        Examples:
+        |  Dump JSON To File  | ${OUTPUTID)${/}output.json | ${json} |
+        """
         json_str = self.convert_json_to_string(json_object)
         with open(dest_file, "w") as json_file:
             json_file.write(json_str)
         return str(dest_file)
 
+    @keyword('Should Have Value In Json')
+    def should_have_value_in_json(self, json_object, json_path):
+        """Should Have Value In JSON using JSONPath
+
+        Arguments:
+            - json_object: json as a dictionary object.
+            - json_path: jsonpath expression
+
+        Fail if no value is found
+
+        Examples:
+        |  Should Have Value In Json  | ${json} |  $..id_card_number |
+        """
+        try:
+            self.get_value_from_json(json_object, json_path)
+        except AssertionError:
+            fail(f"No value found for path {json_path}")
+
+
+    @keyword('Should Not Have Value In Json')
+    def should_not_have_value_in_json(self, json_object, json_path):
+        """Should Not Have Value In JSON using JSONPath
+
+        Arguments:
+            - json_object: json as a dictionary object.
+            - json_path: jsonpath expression
+
+        Fail if at least one value is found
+
+        Examples:
+        |  Should Not Have Value In Json  | ${json} |  $..id_card_number |
+        """
+        try:
+            rv=self.get_value_from_json(json_object, json_path)
+        except AssertionError:
+            pass
+        else:
+            fail(f"Match found for parent {json_path}: {rv}")
+

README.md

@@ -37,6 +37,10 @@ ${value}=         | Get Value From Json | ${json_obj}      | $..country |
 |${value_to_update}=| Set Variable     | Japan             |            |                  |
 |${json_obj}=     | Update Value To Json | ${json_obj}     | $..country | ${value_to_update}|
 |Should Be Equal As Strings | ${json_obj['country'] | ${value_to_update} |   |             |
+|Should Have Value In Json  | ${json_obj} |  $..isMarried |
+|Should Not Have Value In Json  | ${json_obj} |  $..hasSiblings |
+|Dump JSON To File  | ${OUTPUTID)${/}output.json | ${json} |
+
 
 # Documentation
 For the detail keyword documentation. Go to this following link:

acceptance/JSONLibrary.robot

@@ -36,6 +36,18 @@ TestUpdateValueByJSONPath
     ${updated_city}=    Get Value From Json    ${json_obj}    $..address.city
     Should Be Equal As Strings    ${updated_city[0]}    Bangkok
 
+TestShouldHaveValueByJSONPath
+    [Documentation]  Check a value can be found in json object using JSONPath
+    Should Have Value In Json    ${json_obj}    $..isMarried
+
+    Run Keyword And Expect Error  *No value found*  Should Have Value In Json    ${json_obj}    $..hasSiblings
+
+TestShouldNotHaveValueByJSONPath
+    [Documentation]  Check a value cannot be found in json object using JSONPath
+    Should Not Have Value In Json    ${json_obj}    $..hasSiblings
+
+    Run Keyword And Expect Error  *Match found*  Should Not Have Value In Json    ${json_obj}    $..isMarried
+
 TestDeleteObjectByJSONPath
     [Documentation]  Delete object from json object using JSONPath
     ${json_obj}=    Delete Object From Json    ${json_obj}    $..isMarried

tests/test_JSONLibrary.py

@@ -55,6 +55,22 @@ 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)
 
+    def test_has_value_from_json_path_passed(self):
+        json_path = '$..isMarried'
+        self.test.should_have_value_in_json(self.json, json_path)
+
+    def test_has_value_from_json_path_failed(self):
+        json_path = '$..hasSiblings'
+        self.assertRaises(AssertionError, self.test.should_have_value_in_json, self.json, json_path)
+
+    def test_has_no_value_from_json_path_passed(self):
+        json_path = '$..hasSiblings'
+        self.test.should_not_have_value_in_json(self.json, json_path)
+
+    def test_has_no_value_from_json_path_failed(self):
+        json_path = '$..isMarried'
+        self.assertRaises(AssertionError, self.test.should_not_have_value_in_json, self.json, json_path)
+
     def test_update_value_to_json(self):
         json_path = '$..address.streetAddress'
         value_to_update = 'Ratchadapisek Road'