1 # Copyright (c) 2018 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """Utilities to work with JSON data format from VAT."""
16 from robot.api import logger
18 from resources.libraries.python.parsers.JsonParser import JsonParser
21 class VatJsonUtil(object):
22 """Utilities to work with JSON data format from VAT."""
25 def _convert_mac_to_number_list(mac_address):
26 """Convert MAC address string to list of decimal numbers.
28 Converts a ":" separated MAC address to decimal number list as used
29 in JSON interface dump.
31 :param mac_address: MAC address.
32 :type mac_address: str
33 :returns: List representation of MAC address.
37 for num in mac_address.split(":"):
38 list_mac.append(int(num, 16))
42 def get_vpp_interface_by_mac(interfaces_list, mac_address):
43 """Return interface dictionary from interface_list by MAC address.
45 Extracts interface dictionary from all of the interfaces in interfaces
46 list parsed from JSON according to mac_address of the interface.
48 :param interfaces_list: Interfaces parsed from JSON.
49 :param mac_address: MAC address of interface we are looking for.
50 :type interfaces_list: dict
51 :type mac_address: str
52 :returns: Interface from JSON.
56 list_mac_address = VatJsonUtil._convert_mac_to_number_list(mac_address)
57 logger.trace("MAC address {0} converted to list {1}."
58 .format(mac_address, list_mac_address))
59 for interface in interfaces_list:
60 # TODO: create vat json integrity checking and move there
61 if "l2_address" not in interface:
63 "key l2_address not found in interface dict."
64 "Probably input list is not parsed from correct VAT "
66 if "l2_address_length" not in interface:
68 "key l2_address_length not found in interface "
69 "dict. Probably input list is not parsed from correct "
71 mac_from_json = interface["l2_address"][:6]
72 if mac_from_json == list_mac_address:
73 if interface["l2_address_length"] != 6:
74 raise ValueError("l2_address_length value is not 6.")
75 interface_dict = interface
80 def update_vpp_interface_data_from_json(node, interface_dump_json):
81 """Update vpp node data in node__DICT from JSON interface dump.
83 This method updates vpp interface names and sw if indexes according to
84 interface MAC addresses found in interface_dump_json.
86 :param node: Node dictionary.
87 :param interface_dump_json: JSON output from dump_interface_list VAT
90 :type interface_dump_json: str
92 interface_list = JsonParser().parse_data(interface_dump_json)
93 for ifc in node['interfaces'].values():
94 if_mac = ifc['mac_address']
95 interface_dict = VatJsonUtil.get_vpp_interface_by_mac(
96 interface_list, if_mac)
97 if not interface_dict:
98 logger.trace('Interface {0} not found by MAC {1}'
100 ifc['vpp_sw_index'] = None
102 ifc['name'] = interface_dict["interface_name"]
103 ifc['vpp_sw_index'] = interface_dict["sw_if_index"]
104 ifc['mtu'] = interface_dict["mtu"]
107 def get_interface_sw_index_from_json(interface_dump_json, interface_name):
108 """Get sw_if_index from given JSON output by interface name.
110 :param interface_dump_json: JSON output from dump_interface_list VAT
112 :param interface_name: Interface name.
113 :type interface_dump_json: str
114 :type interface_name: str
115 :returns: SW interface index.
117 :raises ValueError: If interface not found in interface_dump_json.
119 logger.trace(interface_dump_json)
120 interface_list = JsonParser().parse_data(interface_dump_json)
121 for interface in interface_list:
123 if interface['interface_name'] == interface_name:
124 index = interface['sw_if_index']
125 logger.debug('Interface with name {} has sw_if_index {}.'
126 .format(interface_name, index))
130 raise ValueError('Interface with name {} not found.'
131 .format(interface_name))
134 def get_interface_name_from_json(interface_dump_json, sw_if_index):
135 """Get interface name from given JSON output by sw_if_index.
137 :param interface_dump_json: JSON output from dump_interface_list VAT
139 :param sw_if_index: SW interface index.
140 :type interface_dump_json: str
141 :type sw_if_index: int
142 :returns: Interface name.
144 :raises ValueError: If interface not found in interface_dump_json.
146 logger.trace(interface_dump_json)
147 interface_list = JsonParser().parse_data(interface_dump_json)
148 for interface in interface_list:
150 if interface['sw_if_index'] == sw_if_index:
151 interface_name = interface['interface_name']
152 logger.debug('Interface with sw_if_index {idx} has name'
153 ' {name}.'.format(idx=sw_if_index,
154 name=interface_name))
155 return interface_name
158 raise ValueError('Interface with sw_if_index {} not found.'
159 .format(sw_if_index))
162 def get_interface_mac_from_json(interface_dump_json, sw_if_index):
163 """Get interface MAC address from given JSON output by sw_if_index.
165 :param interface_dump_json: JSON output from dump_interface_list VAT
167 :param sw_if_index: SW interface index.
168 :type interface_dump_json: str
169 :type sw_if_index: int
170 :returns: Interface MAC address.
172 :raises ValueError: If interface not found in interface_dump_json.
174 logger.trace(interface_dump_json)
175 interface_list = JsonParser().parse_data(interface_dump_json)
176 for interface in interface_list:
178 if interface['sw_if_index'] == sw_if_index:
179 mac_from_json = interface['l2_address'][:6] \
180 if 'l2_address' in interface.keys() else ''
181 mac_address = ':'.join('{:02x}'.format(item)
182 for item in mac_from_json)
183 logger.debug('Interface with sw_if_index {idx} has MAC'
184 ' address {addr}.'.format(idx=sw_if_index,
189 raise ValueError('Interface with sw_if_index {idx} not found.'
190 .format(idx=sw_if_index))
193 def verify_vat_retval(vat_out, exp_retval=0, err_msg='VAT cmd failed'):
194 """Verify return value of VAT command.
196 VAT command JSON output should be object (dict in python) or array. We
197 are looking for something like this: { "retval": 0 }. Verification is
198 skipped if VAT output does not contain return value element or root
201 :param vat_out: VAT command output in python representation of JSON.
202 :param exp_retval: Expected return value (default 0).
203 :err_msg: Message to be displayed in case of error (optional).
204 :type vat_out: dict or list
205 :type exp_retval: int
207 :raises RuntimeError: If VAT command return value is incorrect.
209 if isinstance(vat_out, dict):
210 retval = vat_out.get('retval')
211 if retval is not None:
212 if retval != exp_retval:
213 raise RuntimeError(err_msg)