Framework.ClassUtils package¶

Subpackages¶

Submodules¶

Framework.ClassUtils.configuration_element_class module¶

Copyright 2017, Fujitsu Network Communications, Inc. Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class Framework.ClassUtils.configuration_element_class.ConfigurationElement(name='base', start_pat='${', end_pat='}')[source]¶

Bases: object

Configuration element to support arbitrary xml object depth

expand_variables(string)[source]¶

Replaces embedded variables in the string with their values. Works with $(var) or ${var}. These can be nested to any level

Parameters:	string –
Returns:

get_dictionary_of_values(*args)[source]¶

Looks up all values requested and returns a dictionary of key value pairs

Parameters:	args –
Returns:

get_list(string)[source]¶

entry function for __get_list

Parameters: string –

Returns:

a dictionary if nothing wrong with list range

return a dict with orignal list/range as key “1..4,5,6..7:0.5” parsed list as value [1,2,3,4,5,6,6.5,7]

if invalid range found: return a dict {‘Error’:False}
if no list/range found: return a dict {‘False’:False}

get_list_direct(string)[source]¶

entry function for __get_list

Parameters: string –

Returns:

a dictionary if nothing wrong with list range

return a dict with orignal list/range as key “1..4,5,6..7:0.5” parsed list as value [1,2,3,4,5,6,6.5,7]

if invalid range found: return a dict {‘Error’:False}
if no list/range found: return a dict {‘False’:False}

get_list_of_values(*args)[source]¶

Looks up all values requested and returns a list in the order requested

Parameters:	args –
Returns:

get_node(value)[source]¶

Returns a ConfigurationElement that is the tree rooted at the requested node

Parameters:	value –
Returns:

get_value(value)[source]¶

Returns requested value or None if not found and prints an error

Parameters:	value –
Returns:

parse_data(*arg, **kwargs)[source]¶

parse_data constructs a tree of ConfigurationElements from a list of xml files or a list of ElementTrees. The name attribute is the primary key for each node, so if there is any repetition of names at the same tree level, the two nodes will be merged with the second occurrence over writing the first when there is conflict. This is also true across files if two files/ElementTrees passed in share the same node name structure second file will over write any shared values. The attribute xml_tag comes from the xml structure so any attribute named xml_tag will be over written by the xml structure tag name

Parameters:	arg – kwargs – root is a bool default is True this drives filepath(True) or ElementTree(False) parsing
Returns:

parse_tree(node)[source]¶

Method to parse ElementTree to ConfigurationElement Tree

Parameters:	node –
Returns:

print_me(depth=0)[source]¶

To String implementation

Parameters:	depth –
Returns:

set_value(key, value)[source]¶

Adds or changes the key value pair in the tree

Parameters:	key – value –
Returns:

Framework.ClassUtils.database_utils_class module¶

Copyright 2017, Fujitsu Network Communications, Inc. Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class Framework.ClassUtils.database_utils_class.WMongodb(details_dict=False)[source]¶

Bases: object

Class to handle mongodb operations to add html results

add_html_result_to_mongodb(input_xml)[source]¶: To add case/suite/project results as a document to MongoDB database collections, here collection names are case/suite/project

add_xml_result_to_mongodb(input_xml)[source]¶: To add case xml results as a document to the MongoDB database collection - ‘case’

close_connection()[source]¶: To close database connection

connect_mongodb(details_dict)[source]¶: Establish connection with the mongodb server. URI or IP/port combination is supported in mongodb config file, URI will have higher precedence over IP/Port

convert_tddict_to_xmlobj(root, tddict)[source]¶

To Convert the testdata dictionary into a xml object.

Testdata dictionary can have following combinations :

dict within dict
list within dict
dict within list

get_details_from_case_element(case_elem)[source]¶: To get the details from JUnit case element(xml)

get_details_from_case_xml_element(case_xml_elem)[source]¶: To get the details from testcase xml element

get_details_from_project_element(proj_elem)[source]¶: To get the details from JUnit project element(xml)

get_details_from_suite_element(suite_elem)[source]¶: To get the details from JUnit suite element(xml)

get_doc_from_db(collection_name, document_name)[source]¶: To get the document from the database by matching document_name with ‘_id’ field of each document. It will return False if the document doesn’t exist

get_file_type(root)[source]¶: To get the type of warrior execution file - case/suite/project

get_globalblock_as_xmlobj(db_details)[source]¶: To get the global block from the database as xml object

get_html_results(file_type, root)[source]¶: To get the results from the junit root element

get_tdblock_as_xmlobj(db_details)[source]¶: To get the testdata blocks from the database as xml object

get_varblock_as_xmlobj(db_details)[source]¶: To get the variable config details from the database as xml object

Framework.ClassUtils.database_utils_class.create_database_connection(server_type='resultservers', dbsystem=None)[source]¶: To create object for the database class based on the dbsystem:dbtype value of server_type in Tools/database/database_config.xml

Framework.ClassUtils.database_utils_class.get_database_details(config_file, server_type, system_name, info_list)[source]¶: To get the database system details from database config file

Framework.ClassUtils.json_utils_class module¶

Copyright 2017, Fujitsu Network Communications, Inc. Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class Framework.ClassUtils.json_utils_class.JsonUtils[source]¶

Bases: object

class for json utils

case_conversion_json(json_object, convert_to_lower=False)[source]¶

Takes json object and converts to upper by default and if user selects convert_to_lower as True, then converts json object to lower

Returns:: Returns json object by converting either to lower or upper case.

compare_json_files(json_file1, json_file2)[source]¶: Compares two json files and returns true or false This method recursively sorts all the lists and dictionaries in the json files into a sorted json object and then performs the comparison

compare_json_objects(json_object1, json_object2, case_conversion=False, write_diff_to_console=True, check_for_subset=False)[source]¶: Compares two json objects and returns true or false This method recursively sorts all the lists and dictionaries in the json objects and then performs the comparison If user selects check_for_subset as True, then checks whether json_object2 is a subset of json_object1 or not by recursively sorting the json objects

compare_json_using_jsonpath(response, list_of_jsonpath, list_of_expected_api_responses)[source]¶: Will get each json_path in list of jsonpath and get the value of that jsonpath in json response Compares the value with the expected_api_response If all values matches returns True else False

diff_json_files(json_file1, json_file2)[source]¶

Takes two json files as inputs and calculates the difference between them. :Note: This method does an unsorted (or raw) comparison of the input json files

For a sorted comparison use compare_json_files.

Returns:

Returns a status and a comparison result(tuple or None) 1. No difference between two json objects.

status = True

comparison result = None.

Difference found between two json objects. - status=False - comparison result = a tuple of two lists

list1= items in json1 but not json2

list2= items in json2 but not json1
If any exception encountered during comparison:
- status=False
- comaprison result = None

diff_json_objects(json_object1, json_object2, case_conversion=False)[source]¶

Takes two json objects as inputs and calculates the difference between them. :Returns:

Returns a status and a comparison result(tuple or None) 1. No difference between two json objects.

status = True

comparison result = None.

Difference found between two json objects. - status=False - comparison result = a tuple of two lists

list1= items in json1 but not json2

list2= items in json2 but not json1

If any exception encountered during comparison:

status=False

comaprison result = None

get_value_for_nested_key(json_response, json_path)[source]¶

Returns the value of the nested key in the dictionary Arguments:

json_response = dictionary from which we get the value of the

nested key

json_path = nested key to which we need to get the value For example: json_response = {“1”:{“2”:{“3”:{“4”:”5”}}}} If we wish to get the value of key ‘4’, you need to give the json_path as “1.2.3.4”

Returns:: returns the value of the nested key

load_path_json(path_login_testdata)[source]¶: Retrieves data from json file. Returns None if exception occurs.

nested_json_object(json_object)[source]¶: Param: Takes json_object as input json_object can be a dictionary or nested dictionary. Returns: It returns a frozenset which has a list and it contains tuples ((key,value) pairs in json_object)

pretty_print_json(json_object, indent=4)[source]¶: Prints the input json object in readable format to the terminal, default indent=4

retrieve_data_from_json(json_file, search_pattern)[source]¶: Retrieves and returns data from input json file which matches with search pattern

sort_json_object(json_object)[source]¶: Recursively sort any lists/dictionaries in a json into (key, value) pairs so that they’re sorted

write_json_diff_to_file(json_object1, json_object2, output_file)[source]¶: Compares two json objects and if they does not match writes the difference into the output file

write_json_to_file(json_object, file_path)[source]¶: Writes the given json object to the provided file

Framework.ClassUtils.netconf module¶

Copyright 2017, Fujitsu Network Communications, Inc. Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class Framework.ClassUtils.netconf.client[source]¶

Bases: threading.Thread

#netconf client class

cancel_commit(persist_id=None)[source]¶

#send cancel-commit rpc: persist_id = persist-id string

capability_data¶: netconf capabilities

clear_notification_buffer()[source]¶: clear the notification buffer

clear_notification_print_buffer()[source]¶: clear the notification buffer for print

close()[source]¶: #session close

close_session()[source]¶: #send close-session rpc

commit(confirmed=None, confirm_timeout=None, persist=None, persist_id=None)[source]¶

#send commit rpc: confirmed = any string if using confirmed commit confirm_timeout = timeout value in sec. when confirmed commit persist = string of persist-id persist_id = persist-id if specified in previous commit

connect(host, port, username, password, hostkey_verify=False, protocol_version='')[source]¶: #ssh connect # host = hostname or ip (string) # port = port number (integer) # username = login user name (string) # password = password (string) # hostkey_verify = True/False(default) # protocol_version = 1.0/1.1/null (string)

copy_config(target, source)[source]¶

#send copy-config rpc: target = destination datastore source = source datastore

create_subscription(stream_from=None, filter_string=None, filter_type=None, start_time=None, stop_time=None)[source]¶

#send create-subscription rpc (RFC-5277): stream = stream name (NETCONF/SNMP/syslog…) filterString = xml string or xpath string filterType = subtree or xpath startTime = Start time to replay stopTime = Stop time to replay

current_protocol_version¶: protocol version

delete_config(target)[source]¶

#send delete-config rpc: target = target datastore

discard_changes()[source]¶: #send discard-changes rpc

edit_config(target, config_string, default_operation=None, test_option=None, error_option=None)[source]¶

#send edit-config rpc: target = datastore name (candidate/running) configString = xml string default_operation = merge(default)/replace/none test_option = test-then-set(default)/set/test-only error_option = stop-on-error(default)/continue-on-error/rollback-on-error

error_message¶: error message

get(filter_string=None, filter_type=None)[source]¶

#send get rpc: filterString = filter string, xml string or xpath string

get_config(source, filter_string=None, filter_type='subtree')[source]¶

#send get-config rpc: source = datastore name (candidate/running/startup) filter_string = filter string, xml string or xpath string filter_type = filter type (subtree or xpath)

get_schema(identifier, version_number=None, format_type=None)[source]¶: get-schama rpc

isCOMPLD¶: whether rpc comannd gets ok

isOpen¶: whether port is opened

kill_session(session_id)[source]¶

#send kill-session rpc

session_id = session-id to be killed: ! not current session !

lock(target)[source]¶

#send lock rpc: target = target datastore

notification_data¶: netconf notification data

response_data¶: netconf reply data

rpc(xml)[source]¶

#send a rpc: xml = xml string to send returns: response data

run()[source]¶: #start receiving thread

send_data¶: previous send data

send_hello()[source]¶: #send hello # just send, no wait

session_id¶: session-id

unlock(target)[source]¶

#send unlock rpc: target = target datastore

validate(source='candidate', config=None)[source]¶

#send validate rpc: source = datastore

waitfor_subscription(wait_string, timeout=600)[source]¶

waitfor a notification event report :ARGUMENTS:

wait_string(tuple) = tuple of xpath string and namespace dict(

key - prefix value - namespace string)

timeout(integer) = timeout in sec.

Returns:	True: if successful False: if unsuccessful

Framework.ClassUtils.netconf.connect(host, port, username, password, hostkey_verify=False, protocol_version='')[source]¶: #creates client instance and returns it if connection success

Framework.ClassUtils.netconf_utils_class module¶

Copyright 2017, Fujitsu Network Communications, Inc. Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class Framework.ClassUtils.netconf_utils_class.WNetConf[source]¶

Bases: object

WNetConf class has methods required to interact with NetConf interfaces

ErrorMessage¶: error message when rpc command gets rpc-error

cancel_commit(persist_id=None)[source]¶

cancel commit :Arguments:

persist_id = persist-id which specifed in confirmed commit operation

Returns:	rpc_reply

clear_notification_buffer()[source]¶

clear notification buffer :Arguments:

None

Returns:	always true

clear_notification_buffer_for_print()[source]¶: clear the notification print buffer

close()[source]¶

Closes Netconf SSH session :Arguments:

None

Returns:	rpc_reply

commit(confirmed=False, timeout=None, persist=None, persist_id=None)[source]¶

Commit the candidate datastore as the device’s new current configuration :Arguments:

confirmed(bool) = Commit is reverted if there is no followup commit

within the timeout interval.

timeout(int seconds) = The confirm timeout (Default=600 seconds)

persist = string to persistance

persist-id = persist string when if specified in previous commit

Returns:	rpc_reply

copy_config(source, target)[source]¶

Create or replace an entire configuration datastore: with the contents of another complete configuration datastore

Arguments:	source = name of the configuration datastore to use as the source of the copy operation or config element containing the configuration subtree to copy. target = name of the configuration datastore to use as the destination of the copy operation
Returns:	rpc_reply

create_subscription(stream_from='NETCONF', filter_type=None, filter_string=None, start_time=None, stop_time=None)[source]¶

create subscription to receive event notification :Arguments:

stream_from = NETCONF/SNMP/syslog etc.

filter_type = filter type xpath or subtree

filter_string = filter string, xml string or xpath string

start_time = start time

stop_time = stop time

Returns:	rpc_reply

delete_config(datastore)[source]¶

Delete a configuration datastore

Arguments:	datastore = name of the configuration datastore to be deleted
Returns:	rpc_reply

discard_changes()[source]¶

discard current modify to candidate datasotre :Arguments:

None

Returns:	rpc_reply

edit_config(datastore, config, default_operation=None, test_option=None, error_option=None)[source]¶

Load config to the datastore :Arguments:

datastore = Name of datastore being edited

config = The configuration data.

default_operation = [merger | replace | none (default)]

test_option = [test_then_set | set | none (default)]

error_option = [stop-on-error | continue-on-error

rollback-on-error | none (default)]

rollback-on-error depends on :rollback-on-error capability

Returns:	rpc_reply

get(filter_string=None, filter_type=None)[source]¶

Retrieve running configuration and device state information.

Arguments:	filter = specifies the portion of the configuration to retrieve (by default entire configuration is retrieved) xpath string or xml string
Returns:	rpc_reply

get_config(datastore, filter_string=None, filter_type='subtree')[source]¶

Get configuration data from datastore :Arguments:

datastore = name of datastore being queried

filter_string = portion of the configuration to retrieve. None = Everything

Returns:	rpc_reply

get_notification_buffer(notification_type=None)[source]¶

get specified notification type from buffer notification_type = Event | Alarm | DB-Change |

any product specific notification type

och-notif, dhcpv6-client-event etc..

get_schema(identifier, version_number=None, format_type=None)[source]¶

get-schema rpc :Arguments:

identifier(string) = schema id (name of yang module)

version_number(string) = schema version (e.g. 1.0)

format_type(string) = format name (e.g. yang)

Returns:	rpc reply

isCOMPLD¶: indicates whether rpc-reply = ok (True/False)

kill_session(session_id)[source]¶

Force the termination of a NETCONF session (not the current one!) :Arguments:

session_id = is the session identifier of the NETCONF session

to be terminated as a string

Returns:	rpc_reply

lock(datastore)[source]¶

Lock the configuration system

Arguments:	datastore = name of the configuration datastore to be locked
Returns:	rpc_reply

notification_data¶: received event notification data

open(session_kwds)[source]¶

Opens a SSH connection to a Netconf system

Arguments:

The following keywords are allowed in session_kwds: <ip> = IP address of the system (Required) <nc_port> = use this tag to provide ssh port to connect to (default = 830) <username> = username for the ssh session (default = None) <password> = password for the ssh session (default = None) <hostkey_verify> = enables hostkey verification from ~/.ssh/known_hosts (default = True) belows are not used. <timeout> = use if you want to set timeout while connecting (default = None) <allow_agent> = enables querying SSH agent (default = True) <look_for_keys> = enables looking in the usual locations for ssh keys (default = True) <unknown_host_cb> = called when the server host key is not recognized (default = None) <key_filename> = where the private key can be found (default = None) <ssh_config> = enables parsing of OpenSSH configuration file (default = None) <device_params> = ncclient device name (default = ‘default’)

Returns:	connected(bool)= True / False

request_rpc(request)[source]¶

Send RPC command :Arguments:

request = command to be sent as xml string

Returns:	rpc_reply

response_data¶: rpc-reply data

send_data¶: previous send data

session_id¶: netconf session-id which is in hello message

unlock(datastore)[source]¶

Release the configuration lock

Arguments:	datastore = name of the configuration datastore to be unlocked
Returns:	rpc_reply

validate(datastore)[source]¶

Validate the contents of the specified configuration. :Arguments:

datastore = the name of the configuration datastore being validated

Returns:	rpc_reply

waitfor_subscription(wait_string, timeout=600)[source]¶

wait for specified notification event :Arguments:

waitString(tuple) = tuple of xpath string and namespace dict

prefix and namespace string).

e.g. wait_string = (“//ns:event[./ns:eventClass/text()=’fault’]”,

{‘ns’:’urn:ietf:params:xml:ns:netconf:notification:1.0’})

*xpath string must include namespace prefix

timeout(integer) = timeout value in second

Returns:	result(bool)

Framework.ClassUtils.rest_server_class module¶

Copyright 2017, Fujitsu Network Communications, Inc. Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class Framework.ClassUtils.rest_server_class.RestServer[source]¶

Bases: object

A Rest server that is powered by the Python Bottle framework

async_response(response_val, async, async_response_value, async_status)[source]¶: Bottle framework support async response using yield simulate a semi-async response :param:

response_val: the original response value async: time between original response and 2nd response async_response_value: async response value async_status: the async status code

build_route(route, method, specific_res_list, general_res)[source]¶: Take in route, method and its request/response build a route with the corresponded method loaded with request/response condition return the route method :param:

route: the route name, eg. /att /verizon method: the route method type, eg. GET POST specific_res_list: a list of tuple (verify info, response) general_res: the general response if no specific response is present

build_server(datafile, system_name)[source]¶

Take in a system and read all its routes Load the routes into Bottle server object Start a thread with the bottle server

return the bottle server adapter and server thread

form_response(res_obj, status=True)[source]¶: Take in a response object and generate response based on its status :param:

res_obj: object that contains all the response info

verify_forms(incoming_forms, respond_obj)[source]¶

Verify all items in form/dict match the expect param :param:

incoming_forms: the incoming form in a list of tuple form

eg. [(key1, value1), (key2, value2)]

respond_obj: contains the verification detail from datafile

Returns:	True if all items in form/dict match the veri param False if any of the items fail to match

verify_json(incoming_json, respond_obj, file=False)[source]¶

Verify the incoming_json data with either a. whole json file b. key value pairs :param:

incoming_json: a json string/json obj respond_obj: contains the verification detail from datafile file: indicate if comparing whole file or just pairs

Returns:	True if whole file match/all pairs match False if not match

verify_param(incoming_params, respond_obj)[source]¶

Verify all request param matched with the expect param :param:

incoming_params: the incoming params in a list of tuple form

eg. [(key1, value1), (key2, value2)]

respond_obj: contains the verification detail from datafile

Returns:	True if all incoming params match the veri param False if any incoming params fail to match

verify_xml(incoming_xml, respond_obj, file=False)[source]¶

Verify the incoming_xml data with either a. whole xml file b. tag text pairs :param:

incoming_xml: an xml string respond_obj: contains the verification detail from datafile file: indicate if comparing whole file or just pairs

Returns:	True if whole file match/all pairs match False if not match

class Framework.ClassUtils.rest_server_class.ServerHandler(host='127.0.0.1', port=8080, **options)[source]¶

Bases: Framework.OSS.bottle.ServerAdapter

A wsgiref server that can be shutdown manually so the bottle server can be terminated peacefully Once bottle is capable of terminating itself this can go away

run(app)[source]¶

server = None¶

stop()[source]¶

Framework.ClassUtils.rest_utils_class module¶

Copyright 2017, Fujitsu Network Communications, Inc. Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class Framework.ClassUtils.rest_utils_class.WRest[source]¶

Bases: object

WRest class has methods required to interact with REST interfaces

catch_expection_return_error(exception_name, url)[source]¶: Function for catching expections thrown by REST operations

check_connection(url, auth=None, **kwargs)[source]¶

Internally uses the http options to check connection status. i.e.

If connection is successfull return a true

if any ConnectionError is detected returns a False.

cmp_content_response(datafile, system_name, response, expected_api_response, expected_response_type, comparison_mode)[source]¶

Performs the comparison between api response and expected_api_response

arguments:

datafile: Datafile of the test case
system_name: Name of the system from the datafile

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Other Restrictions: Should be valid system name from the datafile eg: http_system_1
response: API response getting from the data repository
expected_api_response : expected response which needs to be compared given by the user.
expected_response_type: The type of the expected response. It can be xml or json or text.
comparison_mode: This is the mode in which you wish to compare The supported comparison modes are file, string, regex=expression, jsonpath=path, xpath=path If you have given comparison_mode as file or string then whole comparison will take place If you wish to check content of expected response and if it is only one value_check pass it in either data file or test case file If it is more than one value_check then pass it in data file in comparison_mode and expected_api_response tags under system If it is xml response then you need to give xpath=path to it If it is string response then you can pass regex=expressions and you can leave expected_api_response empty Ex for passing values in data file if it is json response <comparison_mode>

<response_path>jsonpath=1.2.3</response_path> <response_path>jsonpath=1.2</response_path>

</comparison_mode> <expected_api_response>

<response_value>4</response_value> <response_value>5</response_value>

</expected_api_response>

returns:

Returns True if the response matches with the expected response else False.

cmp_response(response, expected_api_response, expected_response_type, output_file, generate_output_diff_file=True)[source]¶

Performs the comparison between api response and expected_api_response

arguments:: 1.response: API response getting from the data repository 2.expected_api_response : expected response which needs to be compared given by the user. 3.expected_response_type: The type of the expected response. It can be xml or json or text. 4.output_file: The file in which the difference will be written if the responses are not equal. 5.generate_output_diff_file: If the responses does not match, then generates an output file by writing the difference to the file by default and if it set to False then doesnot generate any file.
returns:: Returns True if the response matches with the expected response else False.

delete(url, expected_response=None, auth=None, **kwargs)[source]¶

performs a http delete method Please refer to the python-requests docs for parameter type support. api reference: https://github.com/kennethreitz/requests/blob/master/requests/api.py