diff options
Diffstat (limited to 'resources/libraries/python/PapiExecutor.py')
| -rw-r--r-- | resources/libraries/python/PapiExecutor.py | 674 |
1 files changed, 436 insertions, 238 deletions
diff --git a/resources/libraries/python/PapiExecutor.py b/resources/libraries/python/PapiExecutor.py index 9ca34d88ae..0a009b3720 100644 --- a/resources/libraries/python/PapiExecutor.py +++ b/resources/libraries/python/PapiExecutor.py @@ -15,32 +15,90 @@ """ import binascii +import glob import json +import shutil +import subprocess +import sys +import tempfile +import time from pprint import pformat from robot.api import logger from resources.libraries.python.Constants import Constants -from resources.libraries.python.PapiHistory import PapiHistory +from resources.libraries.python.LocalExecution import run +from resources.libraries.python.FilteredLogger import FilteredLogger from resources.libraries.python.PythonThree import raise_from -from resources.libraries.python.ssh import SSH, SSHTimeout +from resources.libraries.python.PapiHistory import PapiHistory +from resources.libraries.python.ssh import ( + SSH, SSHTimeout, exec_cmd_no_error, scp_node) -__all__ = ["PapiExecutor"] +__all__ = ["PapiExecutor", "PapiSocketExecutor"] -class PapiExecutor(object): - """Contains methods for executing VPP Python API commands on DUTs. +def dictize(obj): + """A helper method, to make namedtuple-like object accessible as dict. + + If the object is namedtuple-like, its _asdict() form is returned, + but in the returned object __getitem__ method is wrapped + to dictize also any items returned. + If the object does not have _asdict, it will be returned without any change. + Integer keys still access the object as tuple. + + A more useful version would be to keep obj mostly as a namedtuple, + just add getitem for string keys. Unfortunately, namedtuple inherits + from tuple, including its read-only __getitem__ attribute, + so we cannot monkey-patch it. + + TODO: Create a proxy for namedtuple to allow that. + + :param obj: Arbitrary object to dictize. + :type obj: object + :returns: Dictized object. + :rtype: same as obj type or collections.OrderedDict + """ + if not hasattr(obj, "_asdict"): + return obj + ret = obj._asdict() + old_get = ret.__getitem__ + new_get = lambda self, key: dictize(old_get(self, key)) + ret.__getitem__ = new_get + return ret + +class PapiSocketExecutor(object): + """Methods for executing VPP Python API commands on forwarded socket. + + The current implementation connects for the duration of resource manager. + Delay for accepting connection is 10s, and disconnect is explicit. + TODO: Decrease 10s to value that is long enough for creating connection + and short enough to not affect performance. + + The current implementation downloads and parses .api.json files only once + and stores a VPPApiClient instance (disconnected) as a class variable. + Accessing multiple nodes with different APIs is therefore not supported. + + The current implementation seems to run into read error occasionally. + Not sure if the error is in Python code on Robot side, ssh forwarding, + or socket handling at VPP side. Anyway, reconnect after some sleep + seems to help, hoping repeated command execution does not lead to surprises. + The reconnection is logged at WARN level, so it is prominently shown + in log.html, so we can see how frequently it happens. + + TODO: Support sockets in NFs somehow. + TODO: Support handling of retval!=0 without try/except in caller. Note: Use only with "with" statement, e.g.: - with PapiExecutor(node) as papi_exec: - replies = papi_exec.add('show_version').get_replies(err_msg) + with PapiSocketExecutor(node) as papi_exec: + reply = papi_exec.add('show_version').get_reply(err_msg) - This class processes three classes of VPP PAPI methods: - 1. simple request / reply: method='request', - 2. dump functions: method='dump', - 3. vpp-stats: method='stats'. + This class processes two classes of VPP PAPI methods: + 1. Simple request / reply: method='request'. + 2. Dump functions: method='dump'. + + Note that access to VPP stats over socket is not supported yet. The recommended ways of use are (examples): @@ -48,88 +106,214 @@ class PapiExecutor(object): a. One request with no arguments: - with PapiExecutor(node) as papi_exec: - reply = papi_exec.add('show_version').get_reply() + with PapiSocketExecutor(node) as papi_exec: + reply = papi_exec.add('show_version').get_reply(err_msg) b. Three requests with arguments, the second and the third ones are the same but with different arguments. - with PapiExecutor(node) as papi_exec: + with PapiSocketExecutor(node) as papi_exec: replies = papi_exec.add(cmd1, **args1).add(cmd2, **args2).\ add(cmd2, **args3).get_replies(err_msg) 2. Dump functions cmd = 'sw_interface_rx_placement_dump' - with PapiExecutor(node) as papi_exec: + with PapiSocketExecutor(node) as papi_exec: details = papi_exec.add(cmd, sw_if_index=ifc['vpp_sw_index']).\ get_details(err_msg) + """ - 3. vpp-stats - - path = ['^/if', '/err/ip4-input', '/sys/node/ip4-input'] - - with PapiExecutor(node) as papi_exec: - stats = papi_exec.add(api_name='vpp-stats', path=path).get_stats() - - print('RX interface core 0, sw_if_index 0:\n{0}'.\ - format(stats[0]['/if/rx'][0][0])) + # Class cache for reuse between instances. + cached_vpp_instance = None - or + def __init__(self, node, remote_vpp_socket="/run/vpp-api.sock"): + """Store the given arguments, declare managed variables. - path_1 = ['^/if', ] - path_2 = ['^/if', '/err/ip4-input', '/sys/node/ip4-input'] + :param node: Node to connect to and forward unix domain socket from. + :param remote_vpp_socket: Path to remote socket to tunnel to. + :type node: dict + :type remote_vpp_socket: str + """ + self._node = node + self._remote_vpp_socket = remote_vpp_socket + # The list of PAPI commands to be executed on the node. + self._api_command_list = list() + # The following values are set on enter, reset on exit. + self._temp_dir = None + self._ssh_control_socket = None + self._local_vpp_socket = None - with PapiExecutor(node) as papi_exec: - stats = papi_exec.add('vpp-stats', path=path_1).\ - add('vpp-stats', path=path_2).get_stats() + @property + def vpp_instance(self): + """Return VPP instance with bindings to all API calls. - print('RX interface core 0, sw_if_index 0:\n{0}'.\ - format(stats[1]['/if/rx'][0][0])) + The returned instance is initialized for unix domain socket access, + it has initialized all the bindings, but it is not connected + (to local socket) yet. - Note: In this case, when PapiExecutor method 'add' is used: - - its parameter 'csit_papi_command' is used only to keep information - that vpp-stats are requested. It is not further processed but it is - included in the PAPI history this way: - vpp-stats(path=['^/if', '/err/ip4-input', '/sys/node/ip4-input']) - Always use csit_papi_command="vpp-stats" if the VPP PAPI method - is "stats". - - the second parameter must be 'path' as it is used by PapiExecutor - method 'add'. - """ + First invocation downloads .api.json files from self._node + into a temporary directory. - def __init__(self, node): - """Initialization. + After first invocation, the result is cached, so other calls are quick. + Class variable is used as the cache, but this property is defined as + an instance method, so that _node (for api files) is known. - :param node: Node to run command(s) on. - :type node: dict + :returns: Initialized but not connected VPP instance. + :rtype: vpp_papi.VPPApiClient """ + cls = self.__class__ + if cls.cached_vpp_instance is not None: + return cls.cached_vpp_instance + tmp_dir = tempfile.mkdtemp(dir="/tmp") + package_path = "Not set yet." + try: + # Pack, copy and unpack Python part of VPP installation from _node. + # TODO: Use rsync or recursive version of ssh.scp_node instead? + node = self._node + exec_cmd_no_error(node, ["rm", "-rf", "/tmp/papi.txz"]) + # Papi python version depends on OS (and time). + # Python 2.7 or 3.4, site-packages or dist-packages. + installed_papi_glob = "/usr/lib/python*/*-packages/vpp_papi" + # We need to wrap this command in bash, in order to expand globs, + # and as ssh does join, the inner command has to be quoted. + inner_cmd = " ".join([ + "tar", "cJf", "/tmp/papi.txz", "--exclude=*.pyc", + installed_papi_glob, "/usr/share/vpp/api"]) + exec_cmd_no_error(node, ["bash", "-c", "'" + inner_cmd + "'"]) + scp_node(node, tmp_dir + "/papi.txz", "/tmp/papi.txz", get=True) + run(["tar", "xf", tmp_dir + "/papi.txz", "-C", tmp_dir]) + # When present locally, we finally can find the installation path. + package_path = glob.glob(tmp_dir + installed_papi_glob)[0] + # Package path has to be one level above the vpp_papi directory. + package_path = package_path.rsplit('/', 1)[0] + sys.path.append(package_path) + from vpp_papi.vpp_papi import VPPApiClient as vpp_class + vpp_class.apidir = tmp_dir + "/usr/share/vpp/api" + # We need to create instance before removing from sys.path. + cls.cached_vpp_instance = vpp_class( + use_socket=True, server_address="TBD", async_thread=False, + read_timeout=6, logger=FilteredLogger(logger, "INFO")) + # Cannot use loglevel parameter, robot.api.logger lacks support. + # TODO: Stop overriding read_timeout when VPP-1722 is fixed. + finally: + shutil.rmtree(tmp_dir) + if sys.path[-1] == package_path: + sys.path.pop() + return cls.cached_vpp_instance - # Node to run command(s) on. - self._node = node - - # The list of PAPI commands to be executed on the node. - self._api_command_list = list() + def __enter__(self): + """Create a tunnel, connect VPP instance. - self._ssh = SSH() + Only at this point a local socket names are created + in a temporary directory, because VIRL runs 3 pybots at once, + so harcoding local filenames does not work. - def __enter__(self): - try: - self._ssh.connect(self._node) - except IOError: - raise RuntimeError("Cannot open SSH connection to host {host} to " - "execute PAPI command(s)". - format(host=self._node["host"])) + :returns: self + :rtype: PapiSocketExecutor + """ + # Parsing takes longer than connecting, prepare instance before tunnel. + vpp_instance = self.vpp_instance + node = self._node + self._temp_dir = tempfile.mkdtemp(dir="/tmp") + self._local_vpp_socket = self._temp_dir + "/vpp-api.sock" + self._ssh_control_socket = self._temp_dir + "/ssh.sock" + ssh_socket = self._ssh_control_socket + # Cleanup possibilities. + ret_code, _ = run(["ls", ssh_socket], check=False) + if ret_code != 2: + # This branch never seems to be hit in CI, + # but may be useful when testing manually. + run(["ssh", "-S", ssh_socket, "-O", "exit", "0.0.0.0"], + check=False, log=True) + # TODO: Is any sleep necessary? How to prove if not? + run(["sleep", "0.1"]) + run(["rm", "-vrf", ssh_socket]) + # Even if ssh can perhaps reuse this file, + # we need to remove it for readiness detection to work correctly. + run(["rm", "-rvf", self._local_vpp_socket]) + # On VIRL, the ssh user is not added to "vpp" group, + # so we need to change remote socket file access rights. + exec_cmd_no_error( + node, "chmod o+rwx " + self._remote_vpp_socket, sudo=True) + # We use sleep command. The ssh command will exit in 10 second, + # unless a local socket connection is established, + # in which case the ssh command will exit only when + # the ssh connection is closed again (via control socket). + # The log level is to supress "Warning: Permanently added" messages. + ssh_cmd = [ + "ssh", "-S", ssh_socket, "-M", + "-o", "LogLevel=ERROR", "-o", "UserKnownHostsFile=/dev/null", + "-o", "StrictHostKeyChecking=no", "-o", "ExitOnForwardFailure=yes", + "-L", self._local_vpp_socket + ':' + self._remote_vpp_socket, + "-p", str(node['port']), node['username'] + "@" + node['host'], + "sleep", "10"] + priv_key = node.get("priv_key") + if priv_key: + # This is tricky. We need a file to pass the value to ssh command. + # And we need ssh command, because paramiko does not suport sockets + # (neither ssh_socket, nor _remote_vpp_socket). + key_file = tempfile.NamedTemporaryFile() + key_file.write(priv_key) + # Make sure the content is written, but do not close yet. + key_file.flush() + ssh_cmd[1:1] = ["-i", key_file.name] + password = node.get("password") + if password: + # Prepend sshpass command to set password. + ssh_cmd[:0] = ["sshpass", "-p", password] + time_stop = time.time() + 10.0 + # subprocess.Popen seems to be the best way to run commands + # on background. Other ways (shell=True with "&" and ssh with -f) + # seem to be too dependent on shell behavior. + # In particular, -f does NOT return values for run(). + subprocess.Popen(ssh_cmd) + # Check socket presence on local side. + while time.time() < time_stop: + # It can take a moment for ssh to create the socket file. + ret_code, _ = run(["ls", "-l", self._local_vpp_socket], check=False) + if not ret_code: + break + time.sleep(0.1) + else: + raise RuntimeError("Local side socket has not appeared.") + if priv_key: + # Socket up means the key has been read. Delete file by closing it. + key_file.close() + # Everything is ready, set the local socket address and connect. + vpp_instance.transport.server_address = self._local_vpp_socket + # It seems we can get read error even if every preceding check passed. + # Single retry seems to help. + for _ in xrange(2): + try: + vpp_instance.connect_sync("csit_socket") + except IOError as err: + logger.warn("Got initial connect error {err!r}".format(err=err)) + vpp_instance.disconnect() + else: + break + else: + raise RuntimeError("Failed to connect to VPP over a socket.") return self def __exit__(self, exc_type, exc_val, exc_tb): - self._ssh.disconnect(self._node) + """Disconnect the vpp instance, tear down the SHH tunnel. - def add(self, csit_papi_command="vpp-stats", history=True, **kwargs): + Also remove the local sockets by deleting the temporary directory. + Arguments related to possible exception are entirely ignored. + """ + self.vpp_instance.disconnect() + run(["ssh", "-S", self._ssh_control_socket, "-O", "exit", "0.0.0.0"], + check=False) + shutil.rmtree(self._temp_dir) + return + + def add(self, csit_papi_command, history=True, **kwargs): """Add next command to internal command list; return self. The argument name 'csit_papi_command' must be unique enough as it cannot be repeated in kwargs. + Unless disabled, new entry to papi history is also added at this point. :param csit_papi_command: VPP API command. :param history: Enable/disable adding command to PAPI command history. @@ -138,51 +322,30 @@ class PapiExecutor(object): :type history: bool :type kwargs: dict :returns: self, so that method chaining is possible. - :rtype: PapiExecutor + :rtype: PapiSocketExecutor """ if history: PapiHistory.add_to_papi_history( self._node, csit_papi_command, **kwargs) - self._api_command_list.append(dict(api_name=csit_papi_command, - api_args=kwargs)) + self._api_command_list.append( + dict(api_name=csit_papi_command, api_args=kwargs)) return self - def get_stats(self, err_msg="Failed to get statistics.", timeout=120): - """Get VPP Stats from VPP Python API. - - :param err_msg: The message used if the PAPI command(s) execution fails. - :param timeout: Timeout in seconds. - :type err_msg: str - :type timeout: int - :returns: Requested VPP statistics. - :rtype: list of dict - """ - - paths = [cmd['api_args']['path'] for cmd in self._api_command_list] - self._api_command_list = list() - - stdout = self._execute_papi( - paths, method='stats', err_msg=err_msg, timeout=timeout) - - return json.loads(stdout) - - def get_replies(self, err_msg="Failed to get replies.", timeout=120): + def get_replies(self, err_msg="Failed to get replies."): """Get replies from VPP Python API. The replies are parsed into dict-like objects, "retval" field is guaranteed to be zero on success. :param err_msg: The message used if the PAPI command(s) execution fails. - :param timeout: Timeout in seconds. :type err_msg: str - :type timeout: int :returns: Responses, dict objects with fields due to API and "retval". :rtype: list of dict :raises RuntimeError: If retval is nonzero, parsing or ssh error. """ - return self._execute(method='request', err_msg=err_msg, timeout=timeout) + return self._execute(err_msg=err_msg) - def get_reply(self, err_msg="Failed to get reply.", timeout=120): + def get_reply(self, err_msg="Failed to get reply."): """Get reply from VPP Python API. The reply is parsed into dict-like object, @@ -191,20 +354,18 @@ class PapiExecutor(object): TODO: Discuss exception types to raise, unify with inner methods. :param err_msg: The message used if the PAPI command(s) execution fails. - :param timeout: Timeout in seconds. :type err_msg: str - :type timeout: int :returns: Response, dict object with fields due to API and "retval". :rtype: dict :raises AssertionError: If retval is nonzero, parsing or ssh error. """ - replies = self.get_replies(err_msg=err_msg, timeout=timeout) + replies = self.get_replies(err_msg=err_msg) if len(replies) != 1: raise RuntimeError("Expected single reply, got {replies!r}".format( replies=replies)) return replies[0] - def get_sw_if_index(self, err_msg="Failed to get reply.", timeout=120): + def get_sw_if_index(self, err_msg="Failed to get reply."): """Get sw_if_index from reply from VPP Python API. Frequently, the caller is only interested in sw_if_index field @@ -213,16 +374,16 @@ class PapiExecutor(object): TODO: Discuss exception types to raise, unify with inner methods. :param err_msg: The message used if the PAPI command(s) execution fails. - :param timeout: Timeout in seconds. :type err_msg: str - :type timeout: int :returns: Response, sw_if_index value of the reply. :rtype: int :raises AssertionError: If retval is nonzero, parsing or ssh error. """ - return self.get_reply(err_msg=err_msg, timeout=timeout)["sw_if_index"] + reply = self.get_reply(err_msg=err_msg) + logger.info("Getting index from {reply!r}".format(reply=reply)) + return reply["sw_if_index"] - def get_details(self, err_msg="Failed to get dump details.", timeout=120): + def get_details(self, err_msg="Failed to get dump details."): """Get dump details from VPP Python API. The details are parsed into dict-like objects. @@ -233,28 +394,11 @@ class PapiExecutor(object): it is recommended to call get_details for each dump (type) separately. :param err_msg: The message used if the PAPI command(s) execution fails. - :param timeout: Timeout in seconds. :type err_msg: str - :type timeout: int :returns: Details, dict objects with fields due to API without "retval". :rtype: list of dict """ - return self._execute(method='dump', err_msg=err_msg, timeout=timeout) - - @staticmethod - def dump_and_log(node, cmds): - """Dump and log requested information, return None. - - :param node: DUT node. - :param cmds: Dump commands to be executed. - :type node: dict - :type cmds: list of str - """ - with PapiExecutor(node) as papi_exec: - for cmd in cmds: - details = papi_exec.add(cmd).get_details() - logger.debug("{cmd}:\n{details}".format( - cmd=cmd, details=pformat(details))) + return self._execute(err_msg) @staticmethod def run_cli_cmd(node, cmd, log=True): @@ -271,21 +415,194 @@ class PapiExecutor(object): :returns: CLI output. :rtype: str """ - cli = 'cli_inband' args = dict(cmd=cmd) err_msg = "Failed to run 'cli_inband {cmd}' PAPI command on host " \ "{host}".format(host=node['host'], cmd=cmd) - - with PapiExecutor(node) as papi_exec: + with PapiSocketExecutor(node) as papi_exec: reply = papi_exec.add(cli, **args).get_reply(err_msg)["reply"] - if log: logger.info("{cmd}:\n{reply}".format(cmd=cmd, reply=reply)) - return reply @staticmethod + def dump_and_log(node, cmds): + """Dump and log requested information, return None. + + :param node: DUT node. + :param cmds: Dump commands to be executed. + :type node: dict + :type cmds: list of str + """ + with PapiSocketExecutor(node) as papi_exec: + for cmd in cmds: + dump = papi_exec.add(cmd).get_details() + logger.debug("{cmd}:\n{data}".format( + cmd=cmd, data=pformat(dump))) + + def _execute(self, err_msg="Undefined error message"): + """Turn internal command list into data and execute; return replies. + + This method also clears the internal command list. + + IMPORTANT! + Do not use this method in L1 keywords. Use: + - get_replies() + - get_reply() + - get_sw_if_index() + - get_details() + + :param err_msg: The message used if the PAPI command(s) execution fails. + :type err_msg: str + :returns: Papi responses parsed into a dict-like object, + with fields due to API (possibly including retval). + :rtype: list of dict + :raises RuntimeError: If the replies are not all correct. + """ + vpp_instance = self.vpp_instance + local_list = self._api_command_list + # Clear first as execution may fail. + self._api_command_list = list() + replies = list() + for command in local_list: + api_name = command["api_name"] + papi_fn = getattr(vpp_instance.api, api_name) + try: + reply = papi_fn(**command["api_args"]) + except IOError as err: + # Ocassionally an error happens, try reconnect. + logger.warn("Reconnect after error: {err!r}".format(err=err)) + self.vpp_instance.disconnect() + # Testing showes immediate reconnect fails. + time.sleep(1) + self.vpp_instance.connect_sync("csit_socket") + logger.trace("Reconnected.") + reply = papi_fn(**command["api_args"]) + # *_dump commands return list of objects, convert, ordinary reply. + if not isinstance(reply, list): + reply = [reply] + for item in reply: + dict_item = dictize(item) + if "retval" in dict_item.keys(): + # *_details messages do not contain retval. + retval = dict_item["retval"] + if retval != 0: + # TODO: What exactly to log and raise here? + err = AssertionError("Retval {rv!r}".format(rv=retval)) + # Lowering log level, some retval!=0 calls are expected. + # TODO: Expose level argument so callers can decide? + raise_from(AssertionError(err_msg), err, level="DEBUG") + replies.append(dict_item) + return replies + + +class PapiExecutor(object): + """Contains methods for executing VPP Python API commands on DUTs. + + TODO: Remove .add step, make get_stats accept paths directly. + + This class processes only one type of VPP PAPI methods: vpp-stats. + + The recommended ways of use are (examples): + + path = ['^/if', '/err/ip4-input', '/sys/node/ip4-input'] + with PapiExecutor(node) as papi_exec: + stats = papi_exec.add(api_name='vpp-stats', path=path).get_stats() + + print('RX interface core 0, sw_if_index 0:\n{0}'.\ + format(stats[0]['/if/rx'][0][0])) + + or + + path_1 = ['^/if', ] + path_2 = ['^/if', '/err/ip4-input', '/sys/node/ip4-input'] + with PapiExecutor(node) as papi_exec: + stats = papi_exec.add('vpp-stats', path=path_1).\ + add('vpp-stats', path=path_2).get_stats() + + print('RX interface core 0, sw_if_index 0:\n{0}'.\ + format(stats[1]['/if/rx'][0][0])) + + Note: In this case, when PapiExecutor method 'add' is used: + - its parameter 'csit_papi_command' is used only to keep information + that vpp-stats are requested. It is not further processed but it is + included in the PAPI history this way: + vpp-stats(path=['^/if', '/err/ip4-input', '/sys/node/ip4-input']) + Always use csit_papi_command="vpp-stats" if the VPP PAPI method + is "stats". + - the second parameter must be 'path' as it is used by PapiExecutor + method 'add'. + """ + + def __init__(self, node): + """Initialization. + + :param node: Node to run command(s) on. + :type node: dict + """ + + # Node to run command(s) on. + self._node = node + + # The list of PAPI commands to be executed on the node. + self._api_command_list = list() + + self._ssh = SSH() + + def __enter__(self): + try: + self._ssh.connect(self._node) + except IOError: + raise RuntimeError("Cannot open SSH connection to host {host} to " + "execute PAPI command(s)". + format(host=self._node["host"])) + return self + + def __exit__(self, exc_type, exc_val, exc_tb): + self._ssh.disconnect(self._node) + + def add(self, csit_papi_command="vpp-stats", history=True, **kwargs): + """Add next command to internal command list; return self. + + The argument name 'csit_papi_command' must be unique enough as it cannot + be repeated in kwargs. + + :param csit_papi_command: VPP API command. + :param history: Enable/disable adding command to PAPI command history. + :param kwargs: Optional key-value arguments. + :type csit_papi_command: str + :type history: bool + :type kwargs: dict + :returns: self, so that method chaining is possible. + :rtype: PapiExecutor + """ + if history: + PapiHistory.add_to_papi_history( + self._node, csit_papi_command, **kwargs) + self._api_command_list.append(dict(api_name=csit_papi_command, + api_args=kwargs)) + return self + + def get_stats(self, err_msg="Failed to get statistics.", timeout=120): + """Get VPP Stats from VPP Python API. + + :param err_msg: The message used if the PAPI command(s) execution fails. + :param timeout: Timeout in seconds. + :type err_msg: str + :type timeout: int + :returns: Requested VPP statistics. + :rtype: list of dict + """ + + paths = [cmd['api_args']['path'] for cmd in self._api_command_list] + self._api_command_list = list() + + stdout = self._execute_papi( + paths, method='stats', err_msg=err_msg, timeout=timeout) + + return json.loads(stdout) + + @staticmethod def _process_api_data(api_d): """Process API data for smooth converting to JSON string. @@ -325,62 +642,6 @@ class PapiExecutor(object): api_args=api_args_processed)) return api_data_processed - @staticmethod - def _revert_api_reply(api_r): - """Process API reply / a part of API reply. - - Apply binascii.unhexlify() method for unicode values. - - TODO: Implement complex solution to process of replies. - - :param api_r: API reply. - :type api_r: dict - :returns: Processed API reply / a part of API reply. - :rtype: dict - """ - def process_value(val): - """Process value. - - :param val: Value to be processed. - :type val: object - :returns: Processed value. - :rtype: dict or str or int - """ - if isinstance(val, dict): - for val_k, val_v in val.iteritems(): - val[str(val_k)] = process_value(val_v) - return val - elif isinstance(val, list): - for idx, val_l in enumerate(val): - val[idx] = process_value(val_l) - return val - elif isinstance(val, unicode): - return binascii.unhexlify(val) - else: - return val - - reply_dict = dict() - reply_value = dict() - for reply_key, reply_v in api_r.iteritems(): - for a_k, a_v in reply_v.iteritems(): - reply_value[a_k] = process_value(a_v) - reply_dict[reply_key] = reply_value - return reply_dict - - def _process_reply(self, api_reply): - """Process API reply. - - :param api_reply: API reply. - :type api_reply: dict or list of dict - :returns: Processed API reply. - :rtype: list or dict - """ - if isinstance(api_reply, list): - reverted_reply = [self._revert_api_reply(a_r) for a_r in api_reply] - else: - reverted_reply = self._revert_api_reply(api_reply) - return reverted_reply - def _execute_papi(self, api_data, method='request', err_msg="", timeout=120): """Execute PAPI command(s) on remote node and store the result. @@ -430,66 +691,3 @@ class PapiExecutor(object): raise AssertionError(err_msg) return stdout - - def _execute(self, method='request', err_msg="", timeout=120): - """Turn internal command list into data and execute; return replies. - - This method also clears the internal command list. - - IMPORTANT! - Do not use this method in L1 keywords. Use: - - get_stats() - - get_replies() - - get_details() - - :param method: VPP Python API method. Supported methods are: 'request', - 'dump' and 'stats'. - :param err_msg: The message used if the PAPI command(s) execution fails. - :param timeout: Timeout in seconds. - :type method: str - :type err_msg: str - :type timeout: int - :returns: Papi responses parsed into a dict-like object, - with field due to API or stats hierarchy. - :rtype: list of dict - :raises KeyError: If the reply is not correct. - """ - - local_list = self._api_command_list - - # Clear first as execution may fail. - self._api_command_list = list() - - stdout = self._execute_papi( - local_list, method=method, err_msg=err_msg, timeout=timeout) - replies = list() - try: - json_data = json.loads(stdout) - except ValueError as err: - raise_from(RuntimeError(err_msg), err) - for data in json_data: - if method == "request": - api_reply = self._process_reply(data["api_reply"]) - # api_reply contains single key, *_reply. - obj = api_reply.values()[0] - retval = obj["retval"] - if retval != 0: - # TODO: What exactly to log and raise here? - err = AssertionError("Got retval {rv!r}".format(rv=retval)) - raise_from(AssertionError(err_msg), err, level="INFO") - replies.append(obj) - elif method == "dump": - api_reply = self._process_reply(data["api_reply"]) - # api_reply is a list where item contas single key, *_details. - for item in api_reply: - obj = item.values()[0] - replies.append(obj) - else: - # TODO: Implement support for stats. - raise RuntimeError("Unsuported method {method}".format( - method=method)) - - # TODO: Make logging optional? - logger.debug("PAPI replies: {replies}".format(replies=replies)) - - return replies |