-# Copyright (c) 2016 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:
import json
-from robot.api import logger
+from os import remove
-from resources.libraries.python.ssh import SSH
-from resources.libraries.python.constants import Constants
-from resources.libraries.python.VatHistory import VatHistory
+from paramiko.ssh_exception import SSHException
+from robot.api import logger
+from resources.libraries.python.Constants import Constants
+from resources.libraries.python.PapiHistory import PapiHistory
+from resources.libraries.python.ssh import SSH, SSHTimeout
-__all__ = ['VatExecutor']
+__all__ = [u"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.
+ :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']
+ clutter = [u"vat#", u"dump_interface_table error: Misc"]
+ if vat_name:
+ remote_file_path = f"{Constants.REMOTE_FW_DIR}/" \
+ f"{Constants.RESOURCES_TPL_VAT}/{vat_name}"
+ clutter.append(f"{remote_file_path}(2):")
for garbage in clutter:
- retval = retval.replace(garbage, '')
+ retval = retval.replace(garbage, u"")
return retval
-class VatExecutor(object):
+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
+ """
+ # pylint: disable=import-outside-toplevel
+ import resources.libraries.python.DUTSetup as PidLib
+ pid = PidLib.DUTSetup.get_vpp_pid(node)
+ return pid
+
+
+class VatExecutor:
"""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, history=True):
+ """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.
- :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.
- """
-
- 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"
-
- cmd = "sudo -S {vat} {json} < {input}".format(
- vat=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)
- self._ret_code = ret_code
- self._stdout = stdout
- self._stderr = stderr
-
- 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))
-
- # TODO: download vpp_api_test output file
- # self._delete_files(node, remote_file_path, remote_file_out)
-
- def scp_and_execute_script(self, vat_name, node, timeout=10, json_out=True):
- """Copy vat_name script to node, execute it and return result.
-
- :param vat_name: Name of the vat script file.
- Full path and name of the script is required.
+ 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.
+ :param copy_on_execute: If true, copy the file from local host to remote
+ before executing.
+ :param history: If true, add command to history.
:type vat_name: str
:type node: dict
:type timeout: int
:type json_out: bool
- :returns: Status code, stdout and stderr of executed script
- :rtype: tuple
+ :type copy_on_execute: bool
+ :type history: 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)
+ try:
+ ssh.connect(node)
+ except:
+ raise SSHException(
+ f"Cannot open SSH connection to execute VAT command(s) "
+ f"from vat script {vat_name}"
+ )
+
+ if copy_on_execute:
+ ssh.scp(vat_name, vat_name)
+ remote_file_path = vat_name
+ if history:
+ with open(vat_name, "r") as vat_file:
+ for line in vat_file:
+ PapiHistory.add_to_papi_history(
+ node, line.replace(u"\n", u""), papi=False
+ )
+ else:
+ remote_file_path = f"{Constants.REMOTE_FW_DIR}/" \
+ f"{Constants.RESOURCES_TPL_VAT}/{vat_name}"
- ssh.scp(vat_name, vat_name)
+ cmd = f"{Constants.VAT_BIN_NAME}" \
+ f"{u' json' if json_out is True else u''} " \
+ f"in {remote_file_path} script"
+ try:
+ ret_code, stdout, stderr = ssh.exec_command_sudo(
+ cmd=cmd, timeout=timeout
+ )
+ except SSHTimeout:
+ logger.error(f"VAT script execution timeout: {cmd}")
+ raise
+ except Exception:
+ raise RuntimeError(f"VAT script execution failed: {cmd}")
- cmd = "sudo -S {vat} {json} < {input}".format(
- json="json" if json_out is True else "",
- vat=Constants.VAT_BIN_NAME,
- input=vat_name)
- (ret_code, stdout, stderr) = ssh.exec_command(cmd, timeout)
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))
-
- self._delete_files(node, vat_name)
+ 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.
- def scp_and_execute_cli_script(self, fname, node, timeout=10,
- json_out=True):
- """Copy vat_name script to node, execute it and return result.
-
- :param fname: Name of the VPP script file.
- Full path and name of the script is required.
- :param node: Node to execute the VPP script on.
+ :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 vat_name: str
:type node: dict
+ :type tmp_fn: str
+ :type commands: list
:type timeout: int
:type json_out: bool
- :returns: Status code, stdout and stderr of executed script
- :rtype: tuple
"""
+ with open(tmp_fn, "w") as tmp_f:
+ tmp_f.writelines(commands)
- ssh = SSH()
- ssh.connect(node)
-
- ssh.scp(fname, fname)
-
- cmd = "{vat} {json}".format(json="json" if json_out is True else "",
- vat=Constants.VAT_BIN_NAME)
- cmd_input = "exec exec {0}".format(fname)
- (ret_code, stdout, stderr) = ssh.exec_command_sudo(cmd, cmd_input,
- timeout)
- self._ret_code = ret_code
- self._stdout = stdout
- self._stderr = stderr
-
- 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))
+ self.execute_script(
+ tmp_fn, node, timeout=timeout, json_out=json_out,
+ copy_on_execute=True
+ )
+ remove(tmp_fn)
- self._delete_files(node, fname)
-
- def execute_script_json_out(self, vat_name, node, timeout=10):
+ def execute_script_json_out(self, vat_name, node, timeout=120):
"""Pass all arguments to 'execute_script' method, then cleanup returned
- json output."""
- self.execute_script(vat_name, node, timeout, json_out=True)
- self._stdout = cleanup_vat_json_output(self._stdout)
+ json output.
- @staticmethod
- def _delete_files(node, *files):
- """Use SSH to delete the specified files on node.
-
- :param node: Node in topology.
- :param files: Files to delete.
+ :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 files: iterable
+ :type timeout: int
"""
-
- ssh = SSH()
- ssh.connect(node)
- files = " ".join([str(x) for x in files])
- ssh.exec_command("rm {0}".format(files))
+ 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!")
+ raise Exception(u"First execute the script!")
if self._ret_code == 0:
raise AssertionError(
- "Script execution passed, but failure was expected")
+ f"VAT Script execution passed, but failure was expected: "
+ f"{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!")
+ raise Exception(u"First execute the script!")
if self._ret_code != 0:
raise AssertionError(
- "Script execution failed, but success was expected")
+ f"VAT Script execution failed, but success was expected: "
+ f"{self._script_name}"
+ )
def get_script_stdout(self):
"""Returns value of stdout 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 json_param: Require JSON mode.
: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:
- return vat.vat_terminal_exec_cmd_from_template(vat_template_file,
- **vat_args)
+ with VatTerminal(node, json_param=json_param) as vat:
+ return vat.vat_terminal_exec_cmd_from_template(
+ vat_template_file, **vat_args
+ )
-class VatTerminal(object):
+class VatTerminal:
"""VAT interactive terminal.
: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 = (u"vat# ", )
+ __LINUX_PROMPT = (u":~# ", u":~$ ", u"~]$ ", u"~]# ")
def __init__(self, node, json_param=True):
- json_text = ' json' if json_param else ''
+ json_text = u" json" if json_param else u""
self.json = json_param
self._node = node
self._ssh = SSH()
self._ssh.connect(self._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)
+ try:
+ self._tty = self._ssh.interactive_terminal_open()
+ except Exception:
+ raise RuntimeError(
+ f"Cannot open interactive terminal on node {self._node}"
+ )
+
+ for _ in range(3):
+ try:
+ self._ssh.interactive_terminal_exec_command(
+ self._tty, f"sudo -S {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(f"VPP running on node {self._node[u'host']}")
+ else:
+ logger.error(
+ f"More instances of VPP running "
+ f"on node {self._node[u'host']}."
+ )
+ else:
+ logger.error(f"VPP not running on node {self._node[u'host']}.")
+ raise RuntimeError(
+ f"Failed to open VAT console on node {self._node[u'host']}"
+ )
+
self._exec_failure = False
self.vat_stdout = None
: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.
"""
- VatHistory.add_to_vat_history(self._node, cmd)
- logger.debug("Executing command in VAT terminal: {}".format(cmd))
+ PapiHistory.add_to_papi_history(self._node, cmd, papi=False)
+ logger.debug(f"Executing command in VAT terminal: {cmd}")
try:
- out = self._ssh.interactive_terminal_exec_command(self._tty, cmd,
- self.__VAT_PROMPT)
+ out = self._ssh.interactive_terminal_exec_command(
+ self._tty, cmd, self.__VAT_PROMPT
+ )
self.vat_stdout = out
- except:
+ except Exception:
self._exec_failure = True
- raise
+ vpp_pid = get_vpp_pid(self._node)
+ if vpp_pid:
+ if isinstance(vpp_pid, int):
+ msg = f"VPP running on node {self._node[u'host']} " \
+ f"but VAT command {cmd} execution failed."
+ else:
+ msg = f"More instances of VPP running on node " \
+ f"{self._node[u'host']}. VAT command {cmd} " \
+ f"execution failed."
+ else:
+ msg = f"VPP not running on node {self._node[u'host']}. " \
+ f"VAT command {cmd} execution failed."
+ raise RuntimeError(msg)
- logger.debug("VAT output: {}".format(out))
+ logger.debug(f"VAT output: {out}")
if self.json:
- obj_start = out.find('{')
- obj_end = out.rfind('}')
- array_start = out.find('[')
- array_end = out.rfind(']')
+ obj_start = out.find(u"{")
+ obj_end = out.rfind(u"}")
+ array_start = out.find(u"[")
+ array_end = out.rfind(u"]")
if obj_start == -1 and array_start == -1:
- raise RuntimeError("VAT: no JSON data.")
+ raise RuntimeError(f"VAT command {cmd}: no JSON data.")
if obj_start < array_start or array_start == -1:
start = obj_start
out = out[start:end]
json_out = json.loads(out)
return json_out
- else:
- return None
+
+ return None
def vat_terminal_close(self):
"""Close VAT terminal."""
# interactive terminal is dead, we only need to close session
if not self._exec_failure:
- self._ssh.interactive_terminal_exec_command(self._tty,
- 'quit',
- self.__LINUX_PROMPT)
- self._ssh.interactive_terminal_close(self._tty)
+ try:
+ self._ssh.interactive_terminal_exec_command(
+ self._tty, u"quit", self.__LINUX_PROMPT
+ )
+ except Exception:
+ vpp_pid = get_vpp_pid(self._node)
+ if vpp_pid:
+ if isinstance(vpp_pid, int):
+ logger.trace(
+ f"VPP running on node {self._node[u'host']}."
+ )
+ else:
+ logger.error(
+ f"More instances of VPP running "
+ f"on node {self._node[u'host']}."
+ )
+ else:
+ logger.error(
+ f"VPP not running on node {self._node[u'host']}."
+ )
+ raise RuntimeError(
+ f"Failed to close VAT console "
+ f"on node {self._node[u'host']}"
+ )
+ try:
+ self._ssh.interactive_terminal_close(self._tty)
+ except Exception:
+ raise RuntimeError(
+ f"Cannot close interactive terminal "
+ f"on node {self._node[u'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)
- with open(file_path, 'r') as template_file:
+ file_path = f"{Constants.RESOURCES_TPL_VAT}/{vat_template_file}"
+
+ with open(file_path, "r") as template_file:
cmd_template = template_file.readlines()
- ret = []
+ ret = list()
for line_tmpl in cmd_template:
vat_cmd = line_tmpl.format(**args)
- ret.append(self.vat_terminal_exec_cmd(vat_cmd.replace('\n', '')))
+ ret.append(self.vat_terminal_exec_cmd(vat_cmd.replace(u"\n", u"")))
return ret
Code Review / csit.git / blobdiff