resources/libraries/python/VatJsonUtil.py

   1 # Copyright (c) 2016 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:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   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.
  13
  14 """Utilities to work with JSON data format from VAT."""
  15
  16 from robot.api import logger
  17
  18 from resources.libraries.python.parsers.JsonParser import JsonParser
  19
  20
  21 class VatJsonUtil(object):
  22     """Utilities to work with JSON data format from VAT."""
  23
  24     @staticmethod
  25     def _convert_mac_to_number_list(mac_address):
  26         """Convert MAC address string to list of decimal numbers.
  27
  28         Converts a ":" separated MAC address to decimal number list as used
  29         in JSON interface dump.
  30
  31         :param mac_address: MAC address.
  32         :type mac_address: str
  33         :return: List representation of MAC address.
  34         :rtype: list
  35         """
  36         list_mac = []
  37         for num in mac_address.split(":"):
  38             list_mac.append(int(num, 16))
  39         return list_mac
  40
  41     @staticmethod
  42     def get_vpp_interface_by_mac(interfaces_list, mac_address):
  43         """Return interface dictionary from interface_list by MAC address.
  44
  45         Extracts interface dictionary from all of the interfaces in interfaces
  46         list parsed from json according to mac_address of the interface.
  47
  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         :return: Interface from JSON.
  53         :rtype: dict
  54         """
  55         interface_dict = {}
  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:
  62                 raise KeyError(
  63                     "key l2_address not found in interface dict."
  64                     "Probably input list is not parsed from correct VAT "
  65                     "json output.")
  66             if "l2_address_length" not in interface:
  67                 raise KeyError(
  68                     "key l2_address_length not found in interface "
  69                     "dict. Probably input list is not parsed from correct "
  70                     "VAT json output.")
  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
  76                 break
  77         return interface_dict
  78
  79     @staticmethod
  80     def update_vpp_interface_data_from_json(node, interface_dump_json):
  81         """Update vpp node data in node__DICT from json interface dump.
  82
  83         This method updates vpp interface names and sw if indexes according to
  84         interface MAC addresses found in interface_dump_json.
  85
  86         :param node: Node dictionary.
  87         :param interface_dump_json: JSON output from dump_interface_list VAT
  88         command.
  89         :type node: dict
  90         :type interface_dump_json: str
  91         """
  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                 raise Exception('Interface {0} not found by MAC {1}'
  99                                 .format(ifc, if_mac))
 100             ifc['name'] = interface_dict["interface_name"]
 101             ifc['vpp_sw_index'] = interface_dict["sw_if_index"]
 102             ifc['mtu'] = interface_dict["mtu"]