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
  15 import json
  16 from six import string_types
  17 from robot.api.deco import keyword
  18 from jsonpath_rw import parse
  19
  20
  21 class JSONPathKeywords(object):
  22     """JSONPATH is common resource for json path keywords.
  23     """
  24
  25     def __init__(self):
  26         super(JSONPathKeywords, self).__init__()
  27
  28     @keyword
  29     def json_search(self, expression, target):
  30         """JSON Search takes in two params, the first is the jsonpath expression and the second is the json target
  31         which is converted into string if needed and then compares them, returning the matches."""
  32
  33         jsonpath_expr = parse(expression)
  34         if isinstance(target, string_types):
  35             search_json = json.dumps(target)
  36         else:
  37             search_json = target
  38
  39         results = jsonpath_expr.find(search_json)
  40         return results