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, 19 insertions, 27 deletions

diff --git a/resources/libraries/python/VPPUtil.py b/resources/libraries/python/VPPUtil.py
index 03d39d3e23..676671f15e 100644
--- a/resources/libraries/python/VPPUtil.py
+++ b/resources/libraries/python/VPPUtil.py
@@ -19,6 +19,7 @@ from robot.api import logger
 
 from resources.libraries.python.Constants import Constants
 from resources.libraries.python.DUTSetup import DUTSetup
+from resources.libraries.python.L2Util import L2Util
 from resources.libraries.python.PapiExecutor import PapiExecutor
 from resources.libraries.python.ssh import exec_cmd_no_error
 from resources.libraries.python.topology import NodeType
@@ -162,16 +163,16 @@ class VPPUtil(object):
         :rtype: str
         """
         with PapiExecutor(node) as papi_exec:
-            data = papi_exec.add('show_version').get_replies().verify_reply()
-        version = ('VPP version:      {ver}\n'.
-                   format(ver=data['version'].rstrip('\0x00')))
+            reply = papi_exec.add('show_version').get_reply()
+        return_version = reply['version'].rstrip('\0x00')
+        version = 'VPP version:      {ver}\n'.format(ver=return_version)
         if verbose:
             version += ('Compile date:     {date}\n'
-                        'Compile location: {cl}\n '.
-                        format(date=data['build_date'].rstrip('\0x00'),
-                               cl=data['build_directory'].rstrip('\0x00')))
+                        'Compile location: {cl}\n'.
+                        format(date=reply['build_date'].rstrip('\0x00'),
+                               cl=reply['build_directory'].rstrip('\0x00')))
         logger.info(version)
-        return data['version'].rstrip('\0x00')
+        return return_version
 
     @staticmethod
     def show_vpp_version_on_all_duts(nodes):
@@ -193,27 +194,19 @@ class VPPUtil(object):
         """
 
         cmd = 'sw_interface_dump'
-        cmd_reply = 'sw_interface_details'
         args = dict(name_filter_valid=0, name_filter='')
         err_msg = 'Failed to get interface dump on host {host}'.format(
             host=node['host'])
         with PapiExecutor(node) as papi_exec:
-            papi_resp = papi_exec.add(cmd, **args).get_replies(err_msg)
-
-        papi_if_dump = papi_resp.reply[0]['api_reply']
-
-        if_data = list()
-        for item in papi_if_dump:
-            data = item[cmd_reply]
-            data['interface_name'] = data['interface_name'].rstrip('\x00')
-            data['tag'] = data['tag'].rstrip('\x00')
-            data['l2_address'] = str(':'.join(binascii.hexlify(
-                data['l2_address'])[i:i + 2] for i in range(0, 12, 2)).
-                                     decode('ascii'))
-            if_data.append(data)
+            details = papi_exec.add(cmd, **args).get_details(err_msg)
+
+        for if_dump in details:
+            if_dump['interface_name'] = if_dump['interface_name'].rstrip('\x00')
+            if_dump['tag'] = if_dump['tag'].rstrip('\x00')
+            if_dump['l2_address'] = L2Util.bin_to_mac(if_dump['l2_address'])
         # TODO: return only base data
-        logger.trace('Interface data of host {host}:\n{if_data}'.format(
-            host=node['host'], if_data=if_data))
+        logger.trace('Interface data of host {host}:\n{details}'.format(
+            host=node['host'], details=details))
 
     @staticmethod
     def vpp_enable_traces_on_dut(node, fail_on_error=False):
@@ -301,7 +294,7 @@ class VPPUtil(object):
         :returns: VPP log data.
         :rtype: list
         """
-        return PapiExecutor.run_cli_cmd(node, "show log")["reply"]
+        return PapiExecutor.run_cli_cmd(node, "show log")
 
     @staticmethod
     def vpp_show_threads(node):
@@ -313,11 +306,10 @@ class VPPUtil(object):
         :rtype: list
         """
         with PapiExecutor(node) as papi_exec:
-            data = papi_exec.add('show_threads').get_replies().\
-                verify_reply()["thread_data"]
+            reply = papi_exec.add('show_threads').get_reply()
 
         threads_data = list()
-        for thread in data:
+        for thread in reply["thread_data"]:
             thread_data = list()
             for item in thread:
                 if isinstance(item, unicode):