VAT-to-PAPI: VPPCounters

[csit.git] / resources / libraries / python / VatJsonUtil.py

diff --git a/resources/libraries/python/VatJsonUtil.py b/resources/libraries/python/VatJsonUtil.py
index 05c93a1..ef92a24 100644 (file)
--- a/resources/libraries/python/VatJsonUtil.py
+++ b/resources/libraries/python/VatJsonUtil.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2018 Cisco and/or its affiliates.
 # 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:
@@ -30,7 +30,7 @@ class VatJsonUtil(object):
 
         :param mac_address: MAC address.
         :type mac_address: str
-        :return: List representation of MAC address.
+        :returns: List representation of MAC address.
         :rtype: list
         """
         list_mac = []
@@ -49,7 +49,7 @@ class VatJsonUtil(object):
         :param mac_address: MAC address of interface we are looking for.
         :type interfaces_list: dict
         :type mac_address: str
-        :return: Interface from JSON.
+        :returns: Interface from JSON.
         :rtype: dict
         """
         interface_dict = {}
@@ -85,7 +85,7 @@ class VatJsonUtil(object):
 
         :param node: Node dictionary.
         :param interface_dump_json: JSON output from dump_interface_list VAT
-        command.
+            command.
         :type node: dict
         :type interface_dump_json: str
         """
@@ -95,12 +95,100 @@ class VatJsonUtil(object):
             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))
+                ifc['vpp_sw_index'] = None
+                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
+        :returns: 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
+        :returns: 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 sw_if_index {idx} has name'
+                                 ' {name}.'.format(idx=sw_if_index,
+                                                   name=interface_name))
+                    return interface_name
+            except KeyError:
+                pass
+        raise ValueError('Interface with sw_if_index {} not found.'
+                         .format(sw_if_index))
+
+    @staticmethod
+    def get_interface_mac_from_json(interface_dump_json, sw_if_index):
+        """Get interface MAC address 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
+        :returns: Interface MAC address.
+        :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:
+                    mac_from_json = interface['l2_address'][:6] \
+                        if 'l2_address' in interface.keys() else ''
+                    mac_address = ':'.join('{:02x}'.format(item)
+                                           for item in mac_from_json)
+                    logger.debug('Interface with sw_if_index {idx} has MAC'
+                                 ' address {addr}.'.format(idx=sw_if_index,
+                                                           addr=mac_address))
+                    return mac_address
+            except KeyError:
+                pass
+        raise ValueError('Interface with sw_if_index {idx} not found.'
+                         .format(idx=sw_if_index))
+
     @staticmethod
     def verify_vat_retval(vat_out, exp_retval=0, err_msg='VAT cmd failed'):
         """Verify return value of VAT command.
@@ -118,7 +206,7 @@ class VatJsonUtil(object):
         :type err_msg: str
         :raises RuntimeError: If VAT command return value is incorrect.
         """
-        if type(vat_out) is dict:
+        if isinstance(vat_out, dict):
             retval = vat_out.get('retval')
             if retval is not None:
                 if retval != exp_retval: