X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FVatExecutor.py;h=c13e990b634c949b5e3aa0b684545517c2dedaa3;hp=f0e28a1ae1efae4677a4c6d316c54868db3a57d2;hb=3c863def2096b573832499985e3a12bbccf82ea8;hpb=8c12ff59f1a5e750151f5eb0e806dcc80e91c3c2 diff --git a/resources/libraries/python/VatExecutor.py b/resources/libraries/python/VatExecutor.py index f0e28a1ae1..c13e990b63 100644 --- a/resources/libraries/python/VatExecutor.py +++ b/resources/libraries/python/VatExecutor.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: @@ -11,117 +11,208 @@ # See the License for the specific language governing permissions and # limitations under the License. +"""VAT executor library.""" + import json +from os import remove +from paramiko.ssh_exception import SSHException from robot.api import logger -from resources.libraries.python.ssh import SSH -from resources.libraries.python.constants import Constants - +from resources.libraries.python.ssh import SSH, SSHTimeout +from resources.libraries.python.Constants import Constants +from resources.libraries.python.PapiHistory import PapiHistory __all__ = ['VatExecutor'] -def cleanup_vat_json_output(json_output): +def cleanup_vat_json_output(json_output, vat_name=None): """Return VAT JSON output cleaned from VAT clutter. Clean up VAT JSON output from clutter like vat# prompts and such. :param json_output: Cluttered JSON output. - :return: Cleaned up output JSON string. + :param vat_name: Name of the VAT script. + :type json_output: JSON + :type vat_name: str + :returns: Cleaned up output JSON string. + :rtype: JSON """ retval = json_output clutter = ['vat#', 'dump_interface_table error: Misc'] + if vat_name: + remote_file_path = '{0}/{1}/{2}'.format(Constants.REMOTE_FW_DIR, + Constants.RESOURCES_TPL_VAT, + vat_name) + clutter.append("{0}(2):".format(remote_file_path)) for garbage in clutter: retval = retval.replace(garbage, '') return retval +def get_vpp_pid(node): + """Get PID of running VPP process. + + :param node: DUT node. + :type node: dict + :returns: PID of VPP process / List of PIDs if more VPP processes are + running on the DUT node. + :rtype: int or list + """ + import resources.libraries.python.DUTSetup as PidLib + pid = PidLib.DUTSetup.get_vpp_pid(node) + return pid + + class VatExecutor(object): + """Contains methods for executing VAT commands on DUTs.""" def __init__(self): self._stdout = None self._stderr = None self._ret_code = None + self._script_name = None - def execute_script(self, vat_name, node, timeout=10, json_out=True): - """Copy local_path script to node, execute it and return result. + def execute_script(self, vat_name, node, timeout=120, json_out=True, + copy_on_execute=False): + """Execute VAT script on remote node, and store the result. There is an + option to copy script from local host to remote host before execution. + Path is defined automatically. :param vat_name: Name of the vat script file. Only the file name of - the script is required, the resources path is prepended automatically. + the script is required, the resources path is prepended + automatically. :param node: Node to execute the VAT script on. :param timeout: Seconds to allow the script to run. :param json_out: Require JSON output. - :return: (rc, stdout, stderr) tuple. + :param copy_on_execute: If true, copy the file from local host to remote + before executing. + :type vat_name: str + :type node: dict + :type timeout: int + :type json_out: bool + :type copy_on_execute: bool + :raises SSHException: If cannot open connection for VAT. + :raises SSHTimeout: If VAT execution is timed out. + :raises RuntimeError: If VAT script execution fails. """ - ssh = SSH() - ssh.connect(node) - - remote_file_path = '{0}/{1}/{2}'.format(Constants.REMOTE_FW_DIR, - Constants.RESOURCES_TPL_VAT, - vat_name) - # TODO this overwrites the output if the vat script has been used twice - remote_file_out = remote_file_path + ".out" + try: + ssh.connect(node) + except: + raise SSHException("Cannot open SSH connection to execute VAT " + "command(s) from vat script {name}" + .format(name=vat_name)) + + if copy_on_execute: + ssh.scp(vat_name, vat_name) + remote_file_path = vat_name + with open(vat_name, 'r') as vat_file: + for line in vat_file: + PapiHistory.add_to_papi_history(node, + line.replace('\n', ''), + papi=False) + else: + remote_file_path = '{0}/{1}/{2}'.format(Constants.REMOTE_FW_DIR, + Constants.RESOURCES_TPL_VAT, + vat_name) - cmd = "sudo -S {vat} {json} < {input}".format( - vat=Constants.VAT_BIN_NAME, + cmd = "{vat_bin} {json} in {vat_path} script".format( + vat_bin=Constants.VAT_BIN_NAME, json="json" if json_out is True else "", - input=remote_file_path) - (ret_code, stdout, stderr) = ssh.exec_command(cmd, timeout) + vat_path=remote_file_path) + + try: + ret_code, stdout, stderr = ssh.exec_command_sudo(cmd=cmd, + timeout=timeout) + except SSHTimeout: + logger.error("VAT script execution timeout: {0}".format(cmd)) + raise + except: + raise RuntimeError("VAT script execution failed: {0}".format(cmd)) + self._ret_code = ret_code self._stdout = stdout self._stderr = stderr + self._script_name = vat_name - logger.trace("Command '{0}' returned {1}'".format(cmd, self._ret_code)) - logger.trace("stdout: '{0}'".format(self._stdout)) - logger.trace("stderr: '{0}'".format(self._stderr)) + def write_and_execute_script(self, node, tmp_fn, commands, timeout=300, + json_out=False): + """Write VAT commands to the script, copy it to node and execute it. - # TODO: download vpp_api_test output file - # self._delete_files(node, remote_file_path, remote_file_out) + :param node: VPP node. + :param tmp_fn: Path to temporary file script. + :param commands: VAT command list. + :param timeout: Seconds to allow the script to run. + :param json_out: Require JSON output. + :type node: dict + :type tmp_fn: str + :type commands: list + :type timeout: int + :type json_out: bool + """ + with open(tmp_fn, 'w') as tmp_f: + tmp_f.writelines(commands) - def execute_script_json_out(self, vat_name, node, timeout=10): - self.execute_script(vat_name, node, timeout, json_out=True) - self._stdout = cleanup_vat_json_output(self._stdout) + self.execute_script(tmp_fn, node, timeout=timeout, json_out=json_out, + copy_on_execute=True) + remove(tmp_fn) - @staticmethod - def _delete_files(node, *files): - ssh = SSH() - ssh.connect(node) - files = " ".join([str(x) for x in files]) - ssh.exec_command("rm {0}".format(files)) + def execute_script_json_out(self, vat_name, node, timeout=120): + """Pass all arguments to 'execute_script' method, then cleanup returned + json output. + + :param vat_name: Name of the vat script file. Only the file name of + the script is required, the resources path is prepended + automatically. + :param node: Node to execute the VAT script on. + :param timeout: Seconds to allow the script to run. + :type vat_name: str + :type node: dict + :type timeout: int + """ + self.execute_script(vat_name, node, timeout, json_out=True) + self._stdout = cleanup_vat_json_output(self._stdout, vat_name=vat_name) def script_should_have_failed(self): + """Read return code from last executed script and raise exception if the + script didn't fail.""" if self._ret_code is None: raise Exception("First execute the script!") if self._ret_code == 0: raise AssertionError( - "Script execution passed, but failure was expected") + "VAT Script execution passed, but failure was expected: {cmd}" + .format(cmd=self._script_name)) def script_should_have_passed(self): + """Read return code from last executed script and raise exception if the + script failed.""" if self._ret_code is None: raise Exception("First execute the script!") if self._ret_code != 0: raise AssertionError( - "Script execution failed, but success was expected") + "VAT Script execution failed, but success was expected: {cmd}" + .format(cmd=self._script_name)) def get_script_stdout(self): + """Returns value of stdout from last executed script.""" return self._stdout def get_script_stderr(self): + """Returns value of stderr from last executed script.""" return self._stderr @staticmethod - def cmd_from_template(node, vat_template_file, **vat_args): + def cmd_from_template(node, vat_template_file, json_param=True, **vat_args): """Execute VAT script on specified node. This method supports script templates with parameters. :param node: Node in topology on witch the script is executed. :param vat_template_file: Template file of VAT script. :param vat_args: Arguments to the template file. - :return: List of JSON objects returned by VAT. + :returns: List of JSON objects returned by VAT. """ - with VatTerminal(node) as vat: + with VatTerminal(node, json_param=json_param) as vat: return vat.vat_terminal_exec_cmd_from_template(vat_template_file, **vat_args) @@ -131,25 +222,54 @@ class VatTerminal(object): :param node: Node to open VAT terminal on. :param json_param: Defines if outputs from VAT are in JSON format. - Default is True. + Default is True. :type node: dict :type json_param: bool """ - __VAT_PROMPT = "vat# " - __LINUX_PROMPT = ":~$ " + __VAT_PROMPT = ("vat# ", ) + __LINUX_PROMPT = (":~# ", ":~$ ", "~]$ ", "~]# ") def __init__(self, node, json_param=True): json_text = ' json' if json_param else '' self.json = json_param + self._node = node self._ssh = SSH() - self._ssh.connect(node) - self._tty = self._ssh.interactive_terminal_open() - self._ssh.interactive_terminal_exec_command( - self._tty, - 'sudo -S {}{}'.format(Constants.VAT_BIN_NAME, json_text), - self.__VAT_PROMPT) + self._ssh.connect(self._node) + try: + self._tty = self._ssh.interactive_terminal_open() + except Exception: + raise RuntimeError("Cannot open interactive terminal on node {0}". + format(self._node)) + + for _ in range(3): + try: + self._ssh.interactive_terminal_exec_command( + self._tty, + 'sudo -S {0}{1}'.format(Constants.VAT_BIN_NAME, json_text), + self.__VAT_PROMPT) + except Exception: + continue + else: + break + else: + vpp_pid = get_vpp_pid(self._node) + if vpp_pid: + if isinstance(vpp_pid, int): + logger.trace("VPP running on node {0}". + format(self._node['host'])) + else: + logger.error("More instances of VPP running on node {0}.". + format(self._node['host'])) + else: + logger.error("VPP not running on node {0}.". + format(self._node['host'])) + raise RuntimeError("Failed to open VAT console on node {0}". + format(self._node['host'])) + + self._exec_failure = False + self.vat_stdout = None def __enter__(self): return self @@ -162,24 +282,43 @@ class VatTerminal(object): :param cmd: Command to be executed. - :return: Command output in python representation of JSON format or - None if not in JSON mode. + :returns: Command output in python representation of JSON format or + None if not in JSON mode. """ - logger.debug("Executing command in VAT terminal: {}".format(cmd)) - out = self._ssh.interactive_terminal_exec_command(self._tty, - cmd, - self.__VAT_PROMPT) - logger.debug("VAT output: {}".format(out)) + PapiHistory.add_to_papi_history(self._node, cmd, papi=False) + logger.debug("Executing command in VAT terminal: {0}".format(cmd)) + try: + out = self._ssh.interactive_terminal_exec_command(self._tty, cmd, + self.__VAT_PROMPT) + self.vat_stdout = out + except Exception: + self._exec_failure = True + vpp_pid = get_vpp_pid(self._node) + if vpp_pid: + if isinstance(vpp_pid, int): + raise RuntimeError("VPP running on node {0} but VAT command" + " {1} execution failed.". + format(self._node['host'], cmd)) + else: + raise RuntimeError("More instances of VPP running on node " + "{0}. VAT command {1} execution failed.". + format(self._node['host'], cmd)) + else: + raise RuntimeError("VPP not running on node {0}. VAT command " + "{1} execution failed.". + format(self._node['host'], cmd)) + + logger.debug("VAT output: {0}".format(out)) if self.json: obj_start = out.find('{') obj_end = out.rfind('}') array_start = out.find('[') array_end = out.rfind(']') - if -1 == obj_start and -1 == array_start: - raise RuntimeError("No JSON data.") + if obj_start == -1 and array_start == -1: + raise RuntimeError("VAT command {0}: no JSON data.".format(cmd)) - if obj_start < array_start or -1 == array_start: + if obj_start < array_start or array_start == -1: start = obj_start end = obj_end + 1 else: @@ -193,17 +332,38 @@ class VatTerminal(object): def vat_terminal_close(self): """Close VAT terminal.""" - self._ssh.interactive_terminal_exec_command(self._tty, - 'quit', - self.__LINUX_PROMPT) - self._ssh.interactive_terminal_close(self._tty) + # interactive terminal is dead, we only need to close session + if not self._exec_failure: + try: + self._ssh.interactive_terminal_exec_command(self._tty, + 'quit', + self.__LINUX_PROMPT) + except Exception: + vpp_pid = get_vpp_pid(self._node) + if vpp_pid: + if isinstance(vpp_pid, int): + logger.trace("VPP running on node {0}.". + format(self._node['host'])) + else: + logger.error("More instances of VPP running on node " + "{0}.".format(self._node['host'])) + else: + logger.error("VPP not running on node {0}.". + format(self._node['host'])) + raise RuntimeError("Failed to close VAT console on node {0}". + format(self._node['host'])) + try: + self._ssh.interactive_terminal_close(self._tty) + except: + raise RuntimeError("Cannot close interactive terminal on node {0}". + format(self._node['host'])) def vat_terminal_exec_cmd_from_template(self, vat_template_file, **args): """Execute VAT script from a file. :param vat_template_file: Template file name of a VAT script. :param args: Dictionary of parameters for VAT script. - :return: List of JSON objects returned by VAT. + :returns: List of JSON objects returned by VAT. """ file_path = '{}/{}'.format(Constants.RESOURCES_TPL_VAT, vat_template_file)