X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FPapiExecutor.py;h=a3f2479cfff40efec6a8945e292fb49622f1d557;hp=75bdde0ddf4724c6ece7f1da479bf397009cac7c;hb=c788beaecccfa253fafd4708af45c28594704aab;hpb=4f9509d2dae42c99f5a5ece8b730bc322d31c948 diff --git a/resources/libraries/python/PapiExecutor.py b/resources/libraries/python/PapiExecutor.py index 75bdde0ddf..a3f2479cff 100644 --- a/resources/libraries/python/PapiExecutor.py +++ b/resources/libraries/python/PapiExecutor.py @@ -1,4 +1,4 @@ -# Copyright (c) 2018 Cisco and/or its affiliates. +# Copyright (c) 2019 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: @@ -11,214 +11,687 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Python API executor library.""" +"""Python API executor library. +""" import binascii +import glob import json +import shutil +import subprocess +import sys +import tempfile +import time -from paramiko.ssh_exception import SSHException +from pprint import pformat from robot.api import logger -from resources.libraries.python.constants import Constants -from resources.libraries.python.PapiErrors import PapiInitError, \ - PapiJsonFileError, PapiCommandError, PapiCommandInputError -# TODO: from resources.libraries.python.PapiHistory import PapiHistory -from resources.libraries.python.ssh import SSH, SSHTimeout +from resources.libraries.python.Constants import Constants +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.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 Python API commands on DUTs.""" - def __init__(self, node): - self._stdout = None - self._stderr = None - self._ret_code = None - self._node = node - self._json_data = None - self._api_reply = list() - self._api_data = None +def dictize(obj): + """A helper method, to make namedtuple-like object accessible as dict. - self._ssh = SSH() + 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 PapiSocketExecutor(node) as papi_exec: + reply = papi_exec.add('show_version').get_reply(err_msg) + + 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): + + 1. Simple request / reply + + a. One request with no arguments: + + 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 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 PapiSocketExecutor(node) as papi_exec: + details = papi_exec.add(cmd, sw_if_index=ifc['vpp_sw_index']).\ + get_details(err_msg) + """ + + # Class cache for reuse between instances. + cached_vpp_instance = None + + def __init__(self, node, remote_vpp_socket="/run/vpp-api.sock"): + """Store the given arguments, declare managed variables. + + :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 + + @property + def vpp_instance(self): + """Return VPP instance with bindings to all API calls. + + 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. + + First invocation downloads .api.json files from self._node + into a temporary directory. + + 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. + + :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: - self._ssh.connect(node) - except: - raise SSHException('Cannot open SSH connection to host {host} to ' - 'execute PAPI command(s)'. - format(host=self._node['host'])) + # 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=14, 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 def __enter__(self): + """Create a tunnel, connect VPP instance. + + 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. + + :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): - pass + """Disconnect the vpp instance, tear down the SHH tunnel. - @staticmethod - def _process_api_data(api_d): - """Process API data for smooth converting to JSON string. + 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. + :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: 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)) + return self - Apply binascii.hexlify() method for string values. + def get_replies(self, err_msg="Failed to get replies."): + """Get replies from VPP Python API. - :param api_d: List of APIs with their arguments. - :type api_d: list - :returns: List of APIs with arguments pre-processed for JSON. - :rtype: list + 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. + :type err_msg: str + :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(err_msg=err_msg) - api_data_processed = list() - for api in api_d: - api_name = api['api_name'] - api_args = api['api_args'] - api_processed = dict(api_name=api_name) - api_args_processed = dict() - for a_k, a_v in api_args.iteritems(): - value = binascii.hexlify(a_v) if isinstance(a_v, str) else a_v - api_args_processed[str(a_k)] = value - api_processed['api_args'] = api_args_processed - api_data_processed.append(api_processed) - return api_data_processed + def get_reply(self, err_msg="Failed to get reply."): + """Get reply from VPP Python API. - @staticmethod - def _revert_api_reply(api_r): - """Process API reply / a part of API reply. + The reply is parsed into dict-like object, + "retval" field is guaranteed to be zero on success. - Apply binascii.unhexlify() method for unicode values. + TODO: Discuss exception types to raise, unify with inner methods. - :param api_r: API reply. - :type api_r: dict - :returns: Processed API reply / a part of API reply. + :param err_msg: The message used if the PAPI command(s) execution fails. + :type err_msg: str + :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) + 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."): + """Get sw_if_index from reply from VPP Python API. - reply_dict = dict() - reply_value = dict() - for reply_key, reply_v in api_r.iteritems(): - for a_k, a_v in reply_v.iteritems(): - # value = binascii.unhexlify(a_v) if isinstance(a_v, unicode) \ - # else a_v - # reply_value[a_k] = value - reply_value[a_k] = a_v - reply_dict[reply_key] = reply_value - return reply_dict + Frequently, the caller is only interested in sw_if_index field + of the reply, this wrapper makes such call sites shorter. - def _process_reply(self, api_reply): - """Process API reply. + TODO: Discuss exception types to raise, unify with inner methods. - :param api_reply: API reply. - :type api_reply: dict or list of dict - :returns: Processed API reply. - :rtype: list or dict + :param err_msg: The message used if the PAPI command(s) execution fails. + :type err_msg: str + :returns: Response, sw_if_index value of the reply. + :rtype: int + :raises AssertionError: If retval is nonzero, parsing or ssh error. """ + 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."): + """Get dump details from VPP Python API. + + The details are parsed into dict-like objects. + The number of details per single dump command can vary, + and all association between details and dumps is lost, + so if you care about the association (as opposed to + logging everything at once for debugging purposes), + 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. + :type err_msg: str + :returns: Details, dict objects with fields due to API without "retval". + :rtype: list of dict + """ + return self._execute(err_msg) - if isinstance(api_reply, list): - reverted_reply = list() - for a_r in api_reply: - reverted_reply.append(self._revert_api_reply(a_r)) - else: - reverted_reply = self._revert_api_reply(api_reply) - return reverted_reply + @staticmethod + def run_cli_cmd(node, cmd, log=True): + """Run a CLI command as cli_inband, return the "reply" field of reply. + + Optionally, log the field value. + + :param node: Node to run command on. + :param cmd: The CLI command to be run on the node. + :param log: If True, the response is logged. + :type node: dict + :type cmd: str + :type log: bool + :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 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 - def _process_json_data(self): - """Process received JSON data.""" + @staticmethod + def dump_and_log(node, cmds): + """Dump and log requested information, return None. - for data in self._json_data: - api_name = data['api_name'] - api_reply = data['api_reply'] - api_reply_processed = dict( - api_name=api_name, api_reply=self._process_reply(api_reply)) - self._api_reply.append(api_reply_processed) + :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: + 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"]) + except (AttributeError, IOError) as err: + raise_from(AssertionError(err_msg), err, level="INFO") + # *_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 - def execute_papi(self, api_data, timeout=120): - """Execute PAPI command(s) on remote node and store the result. - :param api_data: List of APIs with their arguments. - :param timeout: Timeout in seconds. - :type api_data: list - :type timeout: int - :raises SSHTimeout: If PAPI command(s) execution is timed out. - :raises PapiInitError: If PAPI initialization failed. - :raises PapiJsonFileError: If no api.json file found. - :raises PapiCommandError: If PAPI command(s) execution failed. - :raises PapiCommandInputError: If invalid attribute name or invalid - value is used in API call. - :raises RuntimeError: If PAPI executor failed due to another reason. +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 """ - self._api_data = api_data - api_data_processed = self._process_api_data(api_data) - json_data = json.dumps(api_data_processed) - cmd = "python {fw_dir}/{papi_provider} --json_data '{json}'".format( - fw_dir=Constants.REMOTE_FW_DIR, - papi_provider=Constants.RESOURCES_PAPI_PROVIDER, - json=json_data) + # 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: - ret_code, stdout, stderr = self._ssh.exec_command_sudo( - cmd=cmd, timeout=timeout) - except SSHTimeout: - logger.error('PAPI command(s) execution timeout on host {host}:' - '\n{apis}'.format(host=self._node['host'], - apis=self._api_data)) - raise - except (PapiInitError, PapiJsonFileError, PapiCommandError, - PapiCommandInputError): - logger.error('PAPI command(s) execution failed on host {host}'. - format(host=self._node['host'])) - raise - except: - raise RuntimeError('PAPI command(s) execution on host {host} ' - 'failed: {apis}'.format(host=self._node['host'], - apis=self._api_data)) + 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 - self._ret_code = ret_code - self._stdout = stdout - self._stderr = stderr + 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 papi_should_have_failed(self): - """Read return code from last executed script and raise exception if the - PAPI command(s) didn't fail. + def get_stats(self, err_msg="Failed to get statistics.", timeout=120): + """Get VPP Stats from VPP Python API. - :raises RuntimeError: When no PAPI command executed. - :raises AssertionError: If PAPI command(s) execution passed. + :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 """ - if self._ret_code is None: - raise RuntimeError("First execute the PAPI command(s)!") - if self._ret_code == 0: - raise AssertionError( - "PAPI command(s) execution passed, but failure was expected: " - "{apis}".format(apis=self._api_data)) + paths = [cmd['api_args']['path'] for cmd in self._api_command_list] + self._api_command_list = list() - def papi_should_have_passed(self): - """Read return code from last executed script and raise exception if the - PAPI command(s) failed. + stdout = self._execute_papi( + paths, method='stats', err_msg=err_msg, timeout=timeout) - :raises RuntimeError: When no PAPI command executed. - :raises AssertionError: If PAPI command(s) execution failed. - """ + return json.loads(stdout) - if self._ret_code is None: - raise RuntimeError("First execute the PAPI command(s)!") - if self._ret_code != 0: - raise AssertionError( - "PAPI command(s) execution failed, but success was expected: " - "{apis}".format(apis=self._api_data)) + @staticmethod + def _process_api_data(api_d): + """Process API data for smooth converting to JSON string. - def get_papi_stdout(self): - """Returns value of stdout from last executed PAPI command(s).""" + Apply binascii.hexlify() method for string values. - return self._stdout + :param api_d: List of APIs with their arguments. + :type api_d: list + :returns: List of APIs with arguments pre-processed for JSON. + :rtype: list + """ - def get_papi_stderr(self): - """Returns value of stderr from last executed PAPI command(s).""" + 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 + else: + return binascii.hexlify(val) if isinstance(val, str) else val - return self._stderr + api_data_processed = list() + for api in api_d: + api_args_processed = dict() + for a_k, a_v in api["api_args"].iteritems(): + api_args_processed[str(a_k)] = process_value(a_v) + api_data_processed.append(dict(api_name=api["api_name"], + api_args=api_args_processed)) + return api_data_processed + + def _execute_papi(self, api_data, method='request', err_msg="", + timeout=120): + """Execute PAPI command(s) on remote node and store the result. + + :param api_data: List of APIs with their arguments. + :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 api_data: list + :type method: str + :type err_msg: str + :type timeout: int + :returns: Stdout from remote python utility, to be parsed by caller. + :rtype: str + :raises SSHTimeout: If PAPI command(s) execution has timed out. + :raises RuntimeError: If PAPI executor failed due to another reason. + :raises AssertionError: If PAPI command(s) execution has failed. + """ - def get_papi_reply(self): - """Returns api reply from last executed PAPI command(s).""" + if not api_data: + raise RuntimeError("No API data provided.") - self._json_data = json.loads(self._stdout) - self._process_json_data() + json_data = json.dumps(api_data) \ + if method in ("stats", "stats_request") \ + else json.dumps(self._process_api_data(api_data)) - return self._api_reply + cmd = "{fw_dir}/{papi_provider} --method {method} --data '{json}'".\ + format( + fw_dir=Constants.REMOTE_FW_DIR, method=method, json=json_data, + papi_provider=Constants.RESOURCES_PAPI_PROVIDER) + try: + ret_code, stdout, _ = self._ssh.exec_command_sudo( + cmd=cmd, timeout=timeout, log_stdout_err=False) + # TODO: Fail on non-empty stderr? + except SSHTimeout: + logger.error("PAPI command(s) execution timeout on host {host}:" + "\n{apis}".format(host=self._node["host"], + apis=api_data)) + raise + except Exception as exc: + raise_from(RuntimeError( + "PAPI command(s) execution on host {host} " + "failed: {apis}".format( + host=self._node["host"], apis=api_data)), exc) + if ret_code != 0: + raise AssertionError(err_msg) + + return stdout