HC Test: update routing test keyword due to namespace changes
[csit.git] / resources / libraries / python / VatExecutor.py
index 03b7321..bfb7fce 100644 (file)
@@ -19,6 +19,7 @@ from robot.api import logger
 
 from resources.libraries.python.ssh import SSH
 from resources.libraries.python.constants import Constants
+from resources.libraries.python.VatHistory import VatHistory
 
 
 __all__ = ['VatExecutor']
@@ -30,7 +31,7 @@ def cleanup_vat_json_output(json_output):
     Clean up VAT JSON output from clutter like vat# prompts and such.
 
     :param json_output: Cluttered JSON output.
-    :return: Cleaned up output JSON string.
+    :returns: Cleaned up output JSON string.
     """
 
     retval = json_output
@@ -83,6 +84,79 @@ class VatExecutor(object):
         # TODO: download vpp_api_test output file
         # self._delete_files(node, remote_file_path, remote_file_out)
 
+    def scp_and_execute_script(self, vat_name, node, timeout=10, json_out=True):
+        """Copy vat_name script to node, execute it and return result.
+
+        :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
+        :returns: Status code, stdout and stderr of executed script
+        :rtype: tuple
+        """
+
+        ssh = SSH()
+        ssh.connect(node)
+
+        ssh.scp(vat_name, vat_name)
+
+        cmd = "sudo -S {vat} {json} < {input}".format(
+            json="json" if json_out is True else "",
+            vat=Constants.VAT_BIN_NAME,
+            input=vat_name)
+        (ret_code, stdout, stderr) = ssh.exec_command(cmd, timeout)
+        self._ret_code = ret_code
+        self._stdout = stdout
+        self._stderr = stderr
+
+        logger.trace("Command '{0}' returned {1}'".format(cmd, self._ret_code))
+        logger.trace("stdout: '{0}'".format(self._stdout))
+        logger.trace("stderr: '{0}'".format(self._stderr))
+
+        self._delete_files(node, vat_name)
+
+    def scp_and_execute_cli_script(self, fname, node, timeout=10,
+                                   json_out=True):
+        """Copy vat_name script to node, execute it and return result.
+
+        :param fname: 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
+        :returns: Status code, stdout and stderr of executed script
+        :rtype: tuple
+        """
+
+        ssh = SSH()
+        ssh.connect(node)
+
+        ssh.scp(fname, fname)
+
+        cmd = "{vat} {json}".format(json="json" if json_out is True else "",
+                                    vat=Constants.VAT_BIN_NAME)
+        cmd_input = "exec exec {0}".format(fname)
+        (ret_code, stdout, stderr) = ssh.exec_command_sudo(cmd, cmd_input,
+                                                           timeout)
+        self._ret_code = ret_code
+        self._stdout = stdout
+        self._stderr = stderr
+
+        logger.trace("Command '{0}' returned {1}'".format(cmd, self._ret_code))
+        logger.trace("stdout: '{0}'".format(self._stdout))
+        logger.trace("stderr: '{0}'".format(self._stderr))
+
+        self._delete_files(node, fname)
+
     def execute_script_json_out(self, vat_name, node, timeout=10):
         """Pass all arguments to 'execute_script' method, then cleanup returned
         json output."""
@@ -156,14 +230,15 @@ class VatTerminal(object):
 
     """
 
-    __VAT_PROMPT = "vat# "
-    __LINUX_PROMPT = ":~$ "
+    __VAT_PROMPT = ("vat# ", )
+    __LINUX_PROMPT = (":~$ ", "~]$ ")
 
     def __init__(self, node, json_param=True):
         json_text = ' json' if json_param else ''
         self.json = json_param
+        self._node = node
         self._ssh = SSH()
-        self._ssh.connect(node)
+        self._ssh.connect(self._node)
         self._tty = self._ssh.interactive_terminal_open()
         self._ssh.interactive_terminal_exec_command(
             self._tty,
@@ -185,11 +260,11 @@ class VatTerminal(object):
         :return: 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: {}".format(cmd))
         try:
-            out = self._ssh.interactive_terminal_exec_command(self._tty,
-                                                          cmd,
-                                                          self.__VAT_PROMPT)
+            out = self._ssh.interactive_terminal_exec_command(self._tty, cmd,
+                                                              self.__VAT_PROMPT)
         except:
             self._exec_failure = True
             raise
@@ -201,10 +276,10 @@ class VatTerminal(object):
             array_start = out.find('[')
             array_end = out.rfind(']')
 
-            if -1 == obj_start and -1 == array_start:
+            if obj_start == -1 and array_start == -1:
                 raise RuntimeError("VAT: no JSON data.")
 
-            if obj_start < array_start or -1 == array_start:
+            if obj_start < array_start or array_start == -1:
                 start = obj_start
                 end = obj_end + 1
             else:
@@ -218,7 +293,7 @@ class VatTerminal(object):
 
     def vat_terminal_close(self):
         """Close VAT terminal."""
-        #interactive terminal is dead, we only need to close session
+        # interactive terminal is dead, we only need to close session
         if not self._exec_failure:
             self._ssh.interactive_terminal_exec_command(self._tty,
                                                         'quit',