Revert "Disable CRC checking at runtime"
[csit.git] / resources / libraries / python / VatExecutor.py
index 7d03fcd..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']
 
@@ -56,7 +57,7 @@ def get_vpp_pid(node):
     :param node: DUT node.
     :type node: dict
     :returns: PID of VPP process / List of PIDs if more VPP processes are
     :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
     :rtype: int or list
     """
     import resources.libraries.python.DUTSetup as PidLib
@@ -73,24 +74,29 @@ 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.
 
         :param vat_name: Name of the vat script file. Only the file name of
         """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
         :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.
+        :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
-        :raises RuntimeError: If VAT script execution failed.
+        :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()
         try:
         """
         ssh = SSH()
         try:
@@ -103,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,
@@ -127,12 +139,35 @@ 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.
 
-         :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 to execute the VAT script on.
         :param timeout: Seconds to allow the script to run.
         :type vat_name: str
@@ -171,16 +206,16 @@ 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.
 
         :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.
         """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 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:
+        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)
 
@@ -190,14 +225,14 @@ class VatTerminal(object):
 
     :param node: Node to open VAT terminal on.
     :param json_param: Defines if outputs from VAT are in JSON format.
 
     :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# ", )
     :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 ''
 
     def __init__(self, node, json_param=True):
         json_text = ' json' if json_param else ''
@@ -250,10 +285,10 @@ class VatTerminal(object):
 
         :param cmd: Command to be executed.
 
 
         :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)
+        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,
         logger.debug("Executing command in VAT terminal: {0}".format(cmd))
         try:
             out = self._ssh.interactive_terminal_exec_command(self._tty, cmd,
@@ -331,7 +366,7 @@ class VatTerminal(object):
 
         :param vat_template_file: Template file name of a VAT script.
         :param args: Dictionary of parameters for VAT script.
 
         :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)
         """
         file_path = '{}/{}'.format(Constants.RESOURCES_TPL_VAT,
                                    vat_template_file)