: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.
+ running on the DUT node.
:rtype: int or list
"""
import resources.libraries.python.DUTSetup as PidLib
self._ret_code = None
self._script_name = None
- def execute_script(self, vat_name, node, timeout=120, json_out=True):
- """Execute local_path script on node, and store 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.
+ :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
- :raises RuntimeError: If VAT script execution failed.
+ :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()
try:
"command(s) from vat script {name}"
.format(name=vat_name))
- remote_file_path = '{0}/{1}/{2}'.format(Constants.REMOTE_FW_DIR,
- Constants.RESOURCES_TPL_VAT,
- vat_name)
+ if copy_on_execute:
+ ssh.scp(vat_name, vat_name)
+ remote_file_path = vat_name
+ else:
+ remote_file_path = '{0}/{1}/{2}'.format(Constants.REMOTE_FW_DIR,
+ Constants.RESOURCES_TPL_VAT,
+ vat_name)
cmd = "{vat_bin} {json} in {vat_path} script".format(
vat_bin=Constants.VAT_BIN_NAME,
self._stderr = stderr
self._script_name = vat_name
- def scp_and_execute_script(self, vat_name, node, timeout=120,
- json_out=True):
- """Copy vat_name script to node, execute it and return result.
- Store the content of vat script in VAT history.
-
- :param vat_name: Name of the vat script file.
- Full path and name of the script is required.
- :param node: Node to execute the VAT script on.
- :param timeout: Seconds to allow the script to run.
- :param json_out: Require JSON output.
- :type vat_name: str
- :type node: dict
- :type timeout: int
- :type json_out: bool
- :raises RuntimeError: If VAT script execution failed.
- """
- ssh = SSH()
- try:
- ssh.connect(node)
- except:
- raise SSHException("Cannot open SSH connection to execute VAT "
- "command(s) from vat script {name}"
- .format(name=vat_name))
-
- ssh.scp(vat_name, vat_name)
-
- cmd = "{vat_bin} {json} in {vat_path} script".format(
- vat_bin=Constants.VAT_BIN_NAME,
- json="json" if json_out is True else "",
- vat_path=vat_name)
-
- with open(vat_name, 'r') as tmp_f:
- VatHistory.add_to_vat_history(node, tmp_f.read())
-
- try:
- ret_code, stdout, stderr = ssh.exec_command_sudo(cmd=cmd,
- timeout=timeout)
- except SSHTimeout:
- logger.error("VAT script execution timeout: {cmd}".format(cmd=cmd))
- raise
- except:
- raise RuntimeError("VAT script execution failed: {cmd}"
- .format(cmd=cmd))
-
- self._ret_code = ret_code
- self._stdout = stdout
- self._stderr = stderr
- self._script_name = vat_name
-
- self._delete_files(node, vat_name)
-
- def scp_and_execute_cli_script(self, vat_name, node, timeout=120,
- json_out=True):
- """Copy vat_name script to node, execute it and return result.
- Store the content of vat script in VAT history.
-
- :param vat_name: 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 timeout: Seconds to allow the script to run.
- :param json_out: Require JSON output.
- :type vat_name: str
- :type node: dict
- :type timeout: int
- :type json_out: bool
- :raises RuntimeError: If CLI script execution failed.
- """
- ssh = SSH()
- try:
- ssh.connect(node)
- except:
- raise SSHException("Cannot open SSH connection to execute VAT "
- "command(s) from vat script {name}"
- .format(name=vat_name))
-
- ssh.scp(vat_name, vat_name)
-
- cmd = "{vat_bin} {json}".format(vat_bin=Constants.VAT_BIN_NAME,
- json="json" if json_out is True else "")
- cmd_input = "exec exec {vat_path}".format(vat_path=vat_name)
-
- VatHistory.add_to_vat_history(node, cmd_input)
- with open(vat_name, 'r') as tmp_f:
- VatHistory.add_to_vat_history(node, tmp_f.read())
-
- try:
- ret_code, stdout, stderr = ssh.exec_command_sudo(cmd, cmd_input,
- timeout)
- except SSHTimeout:
- logger.error("CLI script execution timeout: {0}{1}".
- format(cmd, "<<< " + cmd_input if cmd_input else ""))
- raise
- except:
- raise RuntimeError("CLI script execution failed: {0}{1}".format(
- cmd, "<<< " + cmd_input if cmd_input else ""))
-
- self._ret_code = ret_code
- self._stdout = stdout
- self._stderr = stderr
- self._script_name = cmd_input
-
- self._delete_files(node, vat_name)
-
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 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
self.execute_script(vat_name, node, timeout, json_out=True)
self._stdout = cleanup_vat_json_output(self._stdout, vat_name=vat_name)
- @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.
- :type node: dict
- :type files: iterable
- """
-
- ssh = SSH()
- ssh.connect(node)
- files = " ".join([str(x) for x in files])
- ssh.exec_command("rm {files}".format(files=files))
-
def script_should_have_failed(self):
"""Read return code from last executed script and raise exception if the
script didn't fail."""
: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:
return vat.vat_terminal_exec_cmd_from_template(vat_template_file,
: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
__LINUX_PROMPT = (":~$ ", "~]$ ", "~]# ")
def __init__(self, node, json_param=True):
+ """TODO: Should we document this constructor can raise RuntimeError?"""
json_text = ' json' if json_param else ''
self.json = json_param
self._node = node
self._ssh.connect(self._node)
try:
self._tty = self._ssh.interactive_terminal_open()
- except Exception:
+ except IOError:
raise RuntimeError("Cannot open interactive terminal on node {0}".
format(self._node))
self._tty,
'sudo -S {0}{1}'.format(Constants.VAT_BIN_NAME, json_text),
self.__VAT_PROMPT)
- except Exception:
+ except IOError:
continue
else:
break
"""Execute command on the opened VAT terminal.
: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.
+ :raise RuntimeError: If VAT command execution fails.
"""
VatHistory.add_to_vat_history(self._node, cmd)
logger.debug("Executing command in VAT terminal: {0}".format(cmd))
out = self._ssh.interactive_terminal_exec_command(self._tty, cmd,
self.__VAT_PROMPT)
self.vat_stdout = out
- except Exception:
+ except IOError:
self._exec_failure = True
vpp_pid = get_vpp_pid(self._node)
if vpp_pid:
: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)
Code Review / csit.git / blobdiff