Add scale ipsec tunnel tests 40K, 60K
[csit.git] / resources / libraries / python / VatExecutor.py
index d27e067..8197b5e 100644 (file)
 """VAT executor library."""
 
 import json
 """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 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']
 
 
 __all__ = ['VatExecutor']
 
@@ -73,7 +74,7 @@ class VatExecutor(object):
         self._script_name = None
 
     def execute_script(self, vat_name, node, timeout=120, json_out=True,
         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.
         """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.
@@ -86,11 +87,13 @@ class VatExecutor(object):
         :param json_out: Require JSON output.
         :param copy_on_execute: If true, copy the file from local host to remote
             before executing.
         :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 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.
         :raises SSHException: If cannot open connection for VAT.
         :raises SSHTimeout: If VAT execution is timed out.
         :raises RuntimeError: If VAT script execution fails.
@@ -106,6 +109,12 @@ class VatExecutor(object):
         if copy_on_execute:
             ssh.scp(vat_name, vat_name)
             remote_file_path = 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('\n', ''),
+                                                        papi=False)
         else:
             remote_file_path = '{0}/{1}/{2}'.format(Constants.REMOTE_FW_DIR,
                                                     Constants.RESOURCES_TPL_VAT,
         else:
             remote_file_path = '{0}/{1}/{2}'.format(Constants.REMOTE_FW_DIR,
                                                     Constants.RESOURCES_TPL_VAT,
@@ -130,6 +139,28 @@ class VatExecutor(object):
         self._stderr = stderr
         self._script_name = vat_name
 
         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.
     def execute_script_json_out(self, vat_name, node, timeout=120):
         """Pass all arguments to 'execute_script' method, then cleanup returned
         json output.
@@ -175,7 +206,7 @@ class VatExecutor(object):
         return self._stderr
 
     @staticmethod
         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.
 
         """Execute VAT script on specified node. This method supports
         script templates with parameters.
 
@@ -184,7 +215,7 @@ class VatExecutor(object):
         :param vat_args: Arguments to the template file.
         :returns: List of JSON objects returned by VAT.
         """
         :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)
 
             return vat.vat_terminal_exec_cmd_from_template(vat_template_file,
                                                            **vat_args)
 
@@ -201,10 +232,9 @@ class VatTerminal(object):
     """
 
     __VAT_PROMPT = ("vat# ", )
     """
 
     __VAT_PROMPT = ("vat# ", )
-    __LINUX_PROMPT = (":~$ ", "~]$ ", "~]# ")
+    __LINUX_PROMPT = (":~# ", ":~$ ", "~]$ ", "~]# ")
 
     def __init__(self, node, json_param=True):
 
     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
         json_text = ' json' if json_param else ''
         self.json = json_param
         self._node = node
@@ -212,7 +242,7 @@ class VatTerminal(object):
         self._ssh.connect(self._node)
         try:
             self._tty = self._ssh.interactive_terminal_open()
         self._ssh.connect(self._node)
         try:
             self._tty = self._ssh.interactive_terminal_open()
-        except IOError:
+        except Exception:
             raise RuntimeError("Cannot open interactive terminal on node {0}".
                                format(self._node))
 
             raise RuntimeError("Cannot open interactive terminal on node {0}".
                                format(self._node))
 
@@ -222,7 +252,7 @@ class VatTerminal(object):
                     self._tty,
                     'sudo -S {0}{1}'.format(Constants.VAT_BIN_NAME, json_text),
                     self.__VAT_PROMPT)
                     self._tty,
                     'sudo -S {0}{1}'.format(Constants.VAT_BIN_NAME, json_text),
                     self.__VAT_PROMPT)
-            except IOError:
+            except Exception:
                 continue
             else:
                 break
                 continue
             else:
                 break
@@ -254,17 +284,17 @@ class VatTerminal(object):
         """Execute command on the opened VAT terminal.
 
         :param cmd: Command to be executed.
         """Execute command on the opened VAT terminal.
 
         :param cmd: Command to be executed.
+
         :returns: 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)
+        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
         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 IOError:
+        except Exception:
             self._exec_failure = True
             vpp_pid = get_vpp_pid(self._node)
             if vpp_pid:
             self._exec_failure = True
             vpp_pid = get_vpp_pid(self._node)
             if vpp_pid: