Merge pull request #35 from elrandira/master

Fixes for #5, #6, #25, #26, #29, #30

Author: elrandira

.gitignore

@@ -7,3 +7,17 @@ dist
 build
 htmlcov
 result
+
+# PyDev/RED
+.settings
+.project
+.pydevproject
+__pycache__
+red.xml
+/libspecs/
+/Results/
+
+#pipenv/virtualenv
+.venv
+Pipfile
+Pipfile.lock

.travis.yml

@@ -1,6 +1,6 @@
 language: python
 python:
-  - "2.7"
+  - "3.7"
 install: "pip install -r requirements.txt"
 script: make clean coverage docs dist
 deploy:

JSONLibrary/JSONLibraryKeywords.py

@@ -1,10 +1,12 @@
 # -*- coding: utf-8 -*-
+import io
 import json
 import os.path
 from robot.api import logger
 from robot.api.deco import keyword
-from jsonpath_rw import Index, Fields
-from jsonpath_rw_ext import parse
+from robot.utils.asserts import assert_true, fail
+from jsonpath_ng import Index, Fields
+from jsonpath_ng.ext import parse
 from .version import VERSION
 
 __author__ = 'Traitanit Huangsri'
@@ -16,13 +18,14 @@ class JSONLibraryKeywords(object):
     ROBOT_EXIT_ON_FAILURE = True
 
     @keyword('Load JSON From File')
-    def load_json_from_file(self, file_name):
+    def load_json_from_file(self, file_name, encoding=None):
         """Load JSON from file.
 
         Return json as a dictionary object.
 
         Arguments:
             - file_name: absolute json file name
+            - encoding: encoding of the file
 
         Return json object (list or dictionary)
 
@@ -33,7 +36,7 @@ def load_json_from_file(self, file_name):
         if os.path.isfile(file_name) is False:
             logger.error("JSON file: " + file_name + " not found")
             raise IOError
-        with open(file_name) as json_file:
+        with io.open(file_name,mode='r',encoding=encoding) as json_file:
             data = json.load(json_file)
         return data
 
@@ -53,11 +56,23 @@ def add_object_to_json(self, json_object, json_path, object_to_add):
             | ${json}=  |  Add Object To Json  | ${json}          | $..address         |  ${dict} |
             """
         json_path_expr = parse(json_path)
-        for match in json_path_expr.find(json_object):
-            if type(match.value) is dict:
-                match.value.update(object_to_add)
-            if type(match.value) is list:
-                match.value.append(object_to_add)
+        rv=json_path_expr.find(json_object)
+        if len(rv):
+            for match in rv:
+                if type(match.value) is dict:
+                    match.value.update(object_to_add)
+                if type(match.value) is list:
+                    match.value.append(object_to_add)
+        else:
+            parent_json_path='.'.join(json_path.split('.')[:-1])
+            child_name=json_path.split('.')[-1]
+            json_path_expr = parse(parent_json_path)
+            rv=json_path_expr.find(json_object)
+            if len(rv):
+                for match in rv:
+                    match.value.update({child_name:object_to_add})
+            else:
+                fail(f"no match found for parent {parent_json_path}")
 
         return json_object
 
@@ -75,7 +90,11 @@ def get_value_from_json(self, json_object, json_path):
         | ${values}=  |  Get Value From Json  | ${json} |  $..phone_number |
         """
         json_path_expr = parse(json_path)
-        return [match.value for match in json_path_expr.find(json_object)]
+        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}")
+        return [match.value for match in rv]
 
     @keyword('Update Value To Json')
     def update_value_to_json(self, json_object, json_path, new_value):
@@ -114,7 +133,7 @@ def delete_object_from_json(self, json_object, json_path):
         | ${json_object}=  |  Delete Object From Json | ${json} |  $..address.streetAddress  |
         """
         json_path_expr = parse(json_path)
-        for match in json_path_expr.find(json_object):
+        for match in reversed(json_path_expr.find(json_object)):
             path = match.path
             if isinstance(path, Index):
                 del(match.context.value[match.path.index])
@@ -136,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
 
@@ -150,3 +169,60 @@ def convert_string_to_json(self, json_string):
         """
         return json.loads(json_string)
 
+    @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,12 +37,20 @@ ${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:
 
 https://robotframework-thailand.github.io/robotframework-jsonlibrary/
 
+For an example of JSONPath expressions. Go to this link:
+
+https://goessner.net/articles/JsonPath/index.html#e3
+
 #Help & Issues
 Mention me on Twitter [@nottyo](https://twitter.com/nottyo) 
 

acceptance/JSONLibrary.robot

@@ -2,6 +2,7 @@
 Library         JSONLibrary
 Library         Collections
 Library         String
+Library         OperatingSystem    
 Test Setup      SetUp Test
 Default Tags    JSONLibrary
 
@@ -17,24 +18,54 @@ TestAddJSONObjectByJSONPath
     ${json_obj}=    Add Object To Json     ${json_obj}    $..address    ${object_to_add}
     Dictionary Should Contain Sub Dictionary    ${json_obj['address']}    ${object_to_add}
 
+    ${json_obj}=    Add Object To Json     ${json_obj}    $.friends    ${None}
+    Dictionary Should Contain Key    ${json_obj}    friends
+
 TestGetValueByJSONPath
     [Documentation]  Get some json object using JSONPath
     ${values}=     Get Value From Json    ${json_obj}    $..address.postalCode
     Should Be Equal As Strings    ${values[0]}    630-0192
 
+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
+
 TestUpdateValueByJSONPath
     [Documentation]  Update value to json object using JSONPath
     ${json_obj}=    Update Value To Json    ${json_obj}    $..address.city    Bangkok
     ${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
     Dictionary Should Not Contain Key    ${json_obj}    isMarried
 
+TestDeleteArrayElementsByJSONPath
+    [Documentation]  Delete array elements from json object using JSONPath
+    ${json_obj}=    Delete Object From Json    ${json_obj}    $..phoneNumbers[0]
+    Length Should Be    ${json_obj['phoneNumbers']}    2
+    ${json_obj}=    Delete Object From Json    ${json_obj}    $..phoneNumbers[*]
+    Length Should Be    ${json_obj['phoneNumbers']}    0
+
 TestConvertJSONToString
     [Documentation]  Convert JSON To String
     ${json_str}=    Convert JSON To String    ${json_obj}
     Should Be String    ${json_str}
 
+TestDumpJSONToFile
+    [Documentation]    Dumps JSON to file
+    Dump JSON to file    ${TEMPDIR}/sample_dump.json    ${json_obj}
+    File Should Exist    ${TEMPDIR}/sample_dump.json

requirements.txt

@@ -1,4 +1,3 @@
 robotframework>=3.0
-jsonpath-rw==1.4.0
-jsonpath-rw-ext>=0.1.9
+jsonpath-ng>=1.4.3
 coverage==4.2

setup.py

@@ -14,11 +14,10 @@
     VERSION='0.1' #
 
 requirements = [
-    'tox==3.0.0',
+    'tox>=3.0.0',
     'coverage',
     'robotframework>=3.0',
-    'jsonpath-rw==1.4.0',
-    'jsonpath-rw-ext>=0.1.9'
+    'jsonpath-ng>=1.4.3'
 ]
 
 test_requirements = [

tests/json/example.json

@@ -12,11 +12,18 @@
 		"city": "Nara",
 		"postalCode": "630-0192"
 	},
-	"phoneNumbers": [{
-		"type": "iPhone",
-		"number": "0123-4567-8888"
-	}, {
-		"type": "home",
-		"number": "0123-4567-8910"
-	}]
+	"phoneNumbers": [
+		{
+			"type": "iPhone",
+			"number": "0123-4567-8888"
+		}, {
+			"type": "home",
+			"number": "0123-4567-8910"
+		}, {
+			"type": "car",
+			"number": "0123-4567-8999"
+		}
+	],
+	"siblings": [],
+	"occupation": null
 }