"""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, SSHTimeout
-from resources.libraries.python.constants import Constants
-from resources.libraries.python.VatHistory import VatHistory
+from resources.libraries.python.Constants import Constants
+from resources.libraries.python.PapiHistory import PapiHistory
__all__ = ['VatExecutor']
self._script_name = None
def execute_script(self, vat_name, node, timeout=120, json_out=True,
- copy_on_execute=False):
+ 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 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
: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.
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('\n', ''),
+ papi=False)
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.
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 vat_args: Arguments to the template file.
: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)
:returns: Command output in python representation of JSON format or
None if not in JSON mode.
"""
- VatHistory.add_to_vat_history(self._node, cmd)
+ 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,