PapiExecutor always verifies

Do not support returning unverified replies anymore.
Basically, ".get_replies().verify_replies()" is now just ".get_replies()".
This allows fairly large simplifications both at call sites
and in PapiExecutor.py

+ Rename get_dumps to get_details.
+ Introduce get_reply and get_sw_if_index.
+ Rename variables holding get_*() value,
  + e.g. get_stats() value is stored to variable named "stats".
  + Rename "item" of subsequent loop to hint the type instead.
  + Rename "details" function argument to "verbose".
+ Process reply details in place, instead of building new list.
  - Except hybrid blocks which can return both list or single item.
  - Except human readable text building blocks.
+ Rename most similar names to sw_if_index.
  - Except "vpp_sw_index" and some function names.
+ Use single run_cli_cmd from PapiExecutor.
+ Do not chain methods over multiple lines.
  + Small space gain is not worth readability loss.
+ Include minor code and docstrings improvement.
+ Add some TODOs.

Change-Id: Ib2110a3d2101a74d5837baab3a58dc46aafc6ce3
Signed-off-by: Vratko Polak <vrpolak@cisco.com>

1 files changed, 34 insertions, 41 deletions

diff --git a/resources/libraries/python/Memif.py b/resources/libraries/python/Memif.py
index 53fbcef404..5c38ec46f5 100644
--- a/resources/libraries/python/Memif.py
+++ b/resources/libraries/python/Memif.py
@@ -35,8 +35,8 @@ class Memif(object):
         pass
 
     @staticmethod
-    def _memif_dump(node):
-        """Get the memif dump on the given node.
+    def _memif_details(node):
+        """Get the memif dump details on the given node.
 
         :param node: Given node to get Memif dump from.
         :type node: dict
@@ -44,19 +44,15 @@ class Memif(object):
         :rtype: list
         """
         with PapiExecutor(node) as papi_exec:
-            dump = papi_exec.add("memif_dump").get_dump()
+            details = papi_exec.add("memif_dump").get_details()
 
-        data = list()
-        for item in dump.reply[0]["api_reply"]:
-            item["memif_details"]["if_name"] = \
-                item["memif_details"]["if_name"].rstrip('\x00')
-            item["memif_details"]["hw_addr"] = \
-                L2Util.bin_to_mac(item["memif_details"]["hw_addr"])
-            data.append(item)
+        for memif in details:
+            memif["if_name"] = memif["if_name"].rstrip('\x00')
+            memif["hw_addr"] = L2Util.bin_to_mac(memif["hw_addr"])
 
-        logger.debug("MEMIF data:\n{data}".format(data=data))
+        logger.debug("MEMIF details:\n{details}".format(details=details))
 
-        return data
+        return details
 
     @staticmethod
     def _memif_socket_filename_add_del(node, is_add, filename, sid):
@@ -83,13 +79,11 @@ class Memif(object):
             socket_filename=str('/tmp/' + filename)
         )
         with PapiExecutor(node) as papi_exec:
-            data = papi_exec.add(cmd, **args).get_replies(err_msg).\
-                verify_reply(err_msg=err_msg)
-        return data
+            return papi_exec.add(cmd, **args).get_reply(err_msg)
 
     @staticmethod
     def _memif_create(node, mid, sid, rxq=1, txq=1, role=1):
-        """Create Memif interface on the given node.
+        """Create Memif interface on the given node, return its sw_if_index.
 
         :param node: Given node to create Memif interface on.
         :param mid: Memif interface ID.
@@ -103,8 +97,8 @@ class Memif(object):
         :type rxq: int
         :type txq: int
         :type role: int
-        :returns: Verified data from PAPI response.
-        :rtype: dict
+        :returns: sw_if_index
+        :rtype: int
         """
         cmd = 'memif_create'
         err_msg = 'Failed to create memif interface on host {host}'.format(
@@ -117,9 +111,7 @@ class Memif(object):
             id=int(mid)
         )
         with PapiExecutor(node) as papi_exec:
-            data = papi_exec.add(cmd, **args).get_replies(err_msg).\
-                verify_reply(err_msg=err_msg)
-        return data
+            return papi_exec.add(cmd, **args).get_sw_if_index(err_msg)
 
     @staticmethod
     def create_memif_interface(node, filename, mid, sid, rxq=1, txq=1,
@@ -151,23 +143,24 @@ class Memif(object):
         Memif._memif_socket_filename_add_del(node, True, filename, sid)
 
         # Create memif
-        rsp = Memif._memif_create(node, mid, sid, rxq=rxq, txq=txq, role=role)
+        sw_if_index = Memif._memif_create(
+            node, mid, sid, rxq=rxq, txq=txq, role=role)
 
         # Update Topology
         if_key = Topology.add_new_port(node, 'memif')
-        Topology.update_interface_sw_if_index(node, if_key, rsp["sw_if_index"])
+        Topology.update_interface_sw_if_index(node, if_key, sw_if_index)
 
-        ifc_name = Memif.vpp_get_memif_interface_name(node, rsp["sw_if_index"])
+        ifc_name = Memif.vpp_get_memif_interface_name(node, sw_if_index)
         Topology.update_interface_name(node, if_key, ifc_name)
 
-        ifc_mac = Memif.vpp_get_memif_interface_mac(node, rsp["sw_if_index"])
+        ifc_mac = Memif.vpp_get_memif_interface_mac(node, sw_if_index)
         Topology.update_interface_mac_address(node, if_key, ifc_mac)
 
         Topology.update_interface_memif_socket(node, if_key, '/tmp/' + filename)
         Topology.update_interface_memif_id(node, if_key, mid)
         Topology.update_interface_memif_role(node, if_key, str(role))
 
-        return rsp["sw_if_index"]
+        return sw_if_index
 
     @staticmethod
     def show_memif(node):
@@ -177,7 +170,7 @@ class Memif(object):
         :type node: dict
         """
 
-        Memif._memif_dump(node)
+        Memif._memif_details(node)
 
     @staticmethod
     def show_memif_on_all_duts(nodes):
@@ -191,39 +184,39 @@ class Memif(object):
                 Memif.show_memif(node)
 
     @staticmethod
-    def vpp_get_memif_interface_name(node, sw_if_idx):
+    def vpp_get_memif_interface_name(node, sw_if_index):
         """Get Memif interface name from Memif interfaces dump.
 
         :param node: DUT node.
-        :param sw_if_idx: DUT node.
+        :param sw_if_index: DUT node.
         :type node: dict
-        :type sw_if_idx: int
+        :type sw_if_index: int
         :returns: Memif interface name, or None if not found.
         :rtype: str
         """
 
-        dump = Memif._memif_dump(node)
+        details = Memif._memif_details(node)
 
-        for item in dump:
-            if item["memif_details"]["sw_if_index"] == sw_if_idx:
-                return item["memif_details"]["if_name"]
+        for memif in details:
+            if memif["sw_if_index"] == sw_if_index:
+                return memif["if_name"]
         return None
 
     @staticmethod
-    def vpp_get_memif_interface_mac(node, sw_if_idx):
+    def vpp_get_memif_interface_mac(node, sw_if_index):
         """Get Memif interface MAC address from Memif interfaces dump.
 
         :param node: DUT node.
-        :param sw_if_idx: DUT node.
+        :param sw_if_index: DUT node.
         :type node: dict
-        :type sw_if_idx: int
+        :type sw_if_index: int
         :returns: Memif interface MAC address, or None if not found.
         :rtype: str
         """
 
-        dump = Memif._memif_dump(node)
+        details = Memif._memif_details(node)
 
-        for item in dump:
-            if item["memif_details"]["sw_if_index"] == sw_if_idx:
-                return item["memif_details"]["hw_addr"]
+        for memif in details:
+            if memif["sw_if_index"] == sw_if_index:
+                return memif["hw_addr"]
         return None