"""VAT executor library."""
import json
+from os import remove
from paramiko.ssh_exception import SSHException
from robot.api import logger
: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
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.
+ before executing.
:type vat_name: str
:type node: dict
:type timeout: int
:type json_out: bool
:type copy_on_execute: bool
- :raises RuntimeError: If VAT script execution failed.
+ :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:
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:
+ VatHistory.add_to_vat_history(node, line.replace('\n', ''))
else:
remote_file_path = '{0}/{1}/{2}'.format(Constants.REMOTE_FW_DIR,
Constants.RESOURCES_TPL_VAT,
self._stderr = stderr
self._script_name = 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.
+
+ :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)
+
+ self.execute_script(tmp_fn, node, timeout=timeout, json_out=json_out,
+ copy_on_execute=True)
+ remove(tmp_fn)
+
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
: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
"""
__VAT_PROMPT = ("vat# ", )
- __LINUX_PROMPT = (":~$ ", "~]$ ", "~]# ")
+ __LINUX_PROMPT = (":~# ", ":~$ ", "~]$ ", "~]# ")
def __init__(self, node, json_param=True):
json_text = ' json' if json_param else ''
: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: {0}".format(cmd))
: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)