"""Return interface dictionary from interface_list by MAC address.
Extracts interface dictionary from all of the interfaces in interfaces
- list parsed from json according to mac_address of the interface.
+ list parsed from JSON according to mac_address of the interface.
:param interfaces_list: Interfaces parsed from JSON.
:param mac_address: MAC address of interface we are looking for.
@staticmethod
def update_vpp_interface_data_from_json(node, interface_dump_json):
- """Update vpp node data in node__DICT from json interface dump.
+ """Update vpp node data in node__DICT from JSON interface dump.
This method updates vpp interface names and sw if indexes according to
interface MAC addresses found in interface_dump_json.
interface_dict = VatJsonUtil.get_vpp_interface_by_mac(
interface_list, if_mac)
if not interface_dict:
- raise Exception('Interface {0} not found by MAC {1}'
- .format(ifc, if_mac))
+ logger.trace('Interface {0} not found by MAC {1}'
+ .format(ifc, if_mac))
+ continue
ifc['name'] = interface_dict["interface_name"]
ifc['vpp_sw_index'] = interface_dict["sw_if_index"]
ifc['mtu'] = interface_dict["mtu"]
+
+ @staticmethod
+ def get_interface_sw_index_from_json(interface_dump_json, interface_name):
+ """Get sw_if_index from given JSON output by interface name.
+
+ :param interface_dump_json: JSON output from dump_interface_list VAT
+ command.
+ :param interface_name: Interface name.
+ :type interface_dump_json: str
+ :type interface_name: str
+ :return: SW interface index.
+ :rtype: int
+ :raises ValueError: If interface not found in interface_dump_json.
+ """
+ logger.trace(interface_dump_json)
+ interface_list = JsonParser().parse_data(interface_dump_json)
+ for interface in interface_list:
+ try:
+ if interface['interface_name'] == interface_name:
+ index = interface['sw_if_index']
+ logger.debug('Interface with name {} has sw_if_index {}.'
+ .format(interface_name, index))
+ return index
+ except KeyError:
+ pass
+ raise ValueError('Interface with name {} not found.'
+ .format(interface_name))
+
+ @staticmethod
+ def get_interface_name_from_json(interface_dump_json, sw_if_index):
+ """Get interface name from given JSON output by sw_if_index.
+
+ :param interface_dump_json: JSON output from dump_interface_list VAT
+ command.
+ :param sw_if_index: SW interface index.
+ :type interface_dump_json: str
+ :type sw_if_index: int
+ :return: Interface name.
+ :rtype: str
+ :raises ValueError: If interface not found in interface_dump_json.
+ """
+ logger.trace(interface_dump_json)
+ interface_list = JsonParser().parse_data(interface_dump_json)
+ for interface in interface_list:
+ try:
+ if interface['sw_if_index'] == sw_if_index:
+ interface_name = interface['interface_name']
+ logger.debug('Interface with name {} has sw_if_index {}.'
+ .format(interface_name, sw_if_index))
+ return interface_name
+ except KeyError:
+ pass
+ raise ValueError('Interface with sw_if_index {} not found.'
+ .format(sw_if_index))
+
+ @staticmethod
+ def verify_vat_retval(vat_out, exp_retval=0, err_msg='VAT cmd failed'):
+ """Verify return value of VAT command.
+
+ VAT command JSON output should be object (dict in python) or array. We
+ are looking for something like this: { "retval": 0 }. Verification is
+ skipped if VAT output does not contain return value element or root
+ elemet is array.
+
+ :param vat_out: VAT command output in python representation of JSON.
+ :param exp_retval: Expected return value (default 0).
+ :err_msg: Message to be displayed in case of error (optional).
+ :type vat_out: dict or list
+ :type exp_retval: int
+ :type err_msg: str
+ :raises RuntimeError: If VAT command return value is incorrect.
+ """
+ if isinstance(vat_out, dict):
+ retval = vat_out.get('retval')
+ if retval is not None:
+ if retval != exp_retval:
+ raise RuntimeError(err_msg)