X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FVatExecutor.py;h=a3f12bf46f7a59eac56502d41cc5ffa8bad5e5f8;hb=08e35e37f7ad3394cea86c22ab7ffd990651c112;hp=a0f9634d8c2bedbdc29f36859297b44645560ddf;hpb=5dc98f39c227fb09ce59caa38d28f0dba8558e4b;p=csit.git diff --git a/resources/libraries/python/VatExecutor.py b/resources/libraries/python/VatExecutor.py index a0f9634d8c..a3f12bf46f 100644 --- a/resources/libraries/python/VatExecutor.py +++ b/resources/libraries/python/VatExecutor.py @@ -11,12 +11,15 @@ # See the License for the specific language governing permissions and # limitations under the License. +"""VAT executor library.""" + import json 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'] @@ -28,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 @@ -39,6 +42,7 @@ def cleanup_vat_json_output(json_output): class VatExecutor(object): + """Contains methods for executing VAT commands on DUTs.""" def __init__(self): self._stdout = None self._stderr = None @@ -62,7 +66,7 @@ class VatExecutor(object): Constants.RESOURCES_TPL_VAT, vat_name) # TODO this overwrites the output if the vat script has been used twice - remote_file_out = remote_file_path + ".out" + # remote_file_out = remote_file_path + ".out" cmd = "sudo -S {vat} {json} < {input}".format( vat=Constants.VAT_BIN_NAME, @@ -80,18 +84,103 @@ 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.""" self.execute_script(vat_name, node, timeout, json_out=True) self._stdout = cleanup_vat_json_output(self._stdout) @staticmethod def _delete_files(node, *files): + """Use SSH to delete the specified files on node. + + :param node: Node in topology. + :param files: Files to delete. + :type node: dict + :type files: iterable + """ + ssh = SSH() ssh.connect(node) files = " ".join([str(x) for x in files]) ssh.exec_command("rm {0}".format(files)) def script_should_have_failed(self): + """Read return code from last executed script and raise exception if the + script didn't fail.""" if self._ret_code is None: raise Exception("First execute the script!") if self._ret_code == 0: @@ -99,6 +188,8 @@ class VatExecutor(object): "Script execution passed, but failure was expected") def script_should_have_passed(self): + """Read return code from last executed script and raise exception if the + script failed.""" if self._ret_code is None: raise Exception("First execute the script!") if self._ret_code != 0: @@ -106,9 +197,11 @@ class VatExecutor(object): "Script execution failed, but success was expected") def get_script_stdout(self): + """Returns value of stdout from last executed script.""" return self._stdout def get_script_stderr(self): + """Returns value of stderr from last executed script.""" return self._stderr @staticmethod @@ -137,20 +230,22 @@ 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, 'sudo -S {}{}'.format(Constants.VAT_BIN_NAME, json_text), self.__VAT_PROMPT) self._exec_failure = False + self.vat_stdout = None def __enter__(self): return self @@ -166,11 +261,12 @@ 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) + self.vat_stdout = out except: self._exec_failure = True raise @@ -182,10 +278,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: @@ -199,7 +295,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',