robotframework-onap/ONAPLibrary/JSONPathKeywords.py

   1 # Copyright 2019 AT&T Intellectual Property. All rights reserved.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #         http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14 import json
  15
  16 from robot.api.deco import keyword
  17 from jsonpath_rw import parse
  18
  19
  20 class JSONPathKeywords(object):
  21     """JSONPATH is common resource for json path keywords.
  22     """
  23
  24     def __init__(self):
  25         super(JSONPathKeywords, self).__init__()
  26
  27     @keyword
  28     def json_search(self, expression, target):
  29         """JSON Search takes in two params, the first is the jsonpath expression and the second is the json target
  30         which is converted into string if needed and then compares them, returning the matches."""
  31
  32         jsonpath_expr = parse(expression)
  33         if isinstance(target, str) or isinstance(target, unicode):
  34             search_json = json.dumps(target)
  35         else:
  36             search_json = target
  37
  38         results = jsonpath_expr.find(search_json)
  39         return results