X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FVatExecutor.py;h=03b73210200fea22f3ed5d89e51dcd65305a3438;hp=136b7cc0ef3ebb1494bf7580e64047dbc4f2f574;hb=868380b0204758ef34c6be5bae0c9bdb00c4107f;hpb=799c246c1783b534df0ce7731c9078463be33bdd diff --git a/resources/libraries/python/VatExecutor.py b/resources/libraries/python/VatExecutor.py index 136b7cc0ef..03b7321020 100644 --- a/resources/libraries/python/VatExecutor.py +++ b/resources/libraries/python/VatExecutor.py @@ -10,20 +10,27 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. -from ssh import SSH -from robot.api import logger -from constants import Constants + +"""VAT executor library.""" + import json +from robot.api import logger + +from resources.libraries.python.ssh import SSH +from resources.libraries.python.constants import Constants + + __all__ = ['VatExecutor'] def cleanup_vat_json_output(json_output): - """Return VAT json output cleaned from VAT clutter. + """Return VAT JSON output cleaned from VAT clutter. + + Clean up VAT JSON output from clutter like vat# prompts and such. - Clean up VAT json output from clutter like vat# prompts and such - :param json_output: cluttered json output. - :return: cleaned up output json string + :param json_output: Cluttered JSON output. + :return: Cleaned up output JSON string. """ retval = json_output @@ -34,6 +41,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 @@ -42,12 +50,11 @@ class VatExecutor(object): def execute_script(self, vat_name, node, timeout=10, json_out=True): """Copy local_path script to node, execute it and return result. - :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. - :param json_out: require 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 node: Node to execute the VAT script on. + :param timeout: Seconds to allow the script to run. + :param json_out: Require JSON output. :return: (rc, stdout, stderr) tuple. """ @@ -58,7 +65,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, @@ -77,17 +84,29 @@ class VatExecutor(object): # self._delete_files(node, remote_file_path, remote_file_out) 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: @@ -95,6 +114,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: @@ -102,59 +123,53 @@ 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 def cmd_from_template(node, vat_template_file, **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 - :return: list of json objects returned by VAT + 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. """ with VatTerminal(node) as vat: return vat.vat_terminal_exec_cmd_from_template(vat_template_file, **vat_args) - @staticmethod - def copy_config_to_remote(node, local_path, remote_path): - # TODO: will be removed once v4 is merged to master. - """Copies vat configuration file to node - - :param node: Remote node on which to copy the VAT configuration file - :param local_path: path of the VAT script on local device that launches - test cases. - :param remote_path: path on remote node where to copy the VAT - configuration script file - """ - ssh = SSH() - ssh.connect(node) - logger.trace("Removing old file {}".format(remote_path)) - ssh.exec_command_sudo("rm -f {}".format(remote_path)) - ssh.scp(local_path, remote_path) - class VatTerminal(object): - """VAT interactive terminal + """VAT interactive terminal. + + :param node: Node to open VAT terminal on. + :param json_param: Defines if outputs from VAT are in JSON format. + Default is True. + :type node: dict + :type json_param: bool - :param node: Node to open VAT terminal on. """ __VAT_PROMPT = "vat# " __LINUX_PROMPT = ":~$ " - def __init__(self, node): + def __init__(self, node, json_param=True): + json_text = ' json' if json_param else '' + self.json = json_param self._ssh = SSH() self._ssh.connect(node) self._tty = self._ssh.interactive_terminal_open() self._ssh.interactive_terminal_exec_command( self._tty, - 'sudo -S {vat} json'.format(vat=Constants.VAT_BIN_NAME), + 'sudo -S {}{}'.format(Constants.VAT_BIN_NAME, json_text), self.__VAT_PROMPT) + self._exec_failure = False def __enter__(self): return self @@ -165,30 +180,57 @@ class VatTerminal(object): def vat_terminal_exec_cmd(self, cmd): """Execute command on the opened VAT terminal. - :param cmd: Command to be executed. + :param cmd: Command to be executed. - :return: Command output in python representation of JSON format. + :return: Command output in python representation of JSON format or + None if not in JSON mode. """ logger.debug("Executing command in VAT terminal: {}".format(cmd)) - out = self._ssh.interactive_terminal_exec_command(self._tty, + try: + out = self._ssh.interactive_terminal_exec_command(self._tty, cmd, self.__VAT_PROMPT) + except: + self._exec_failure = True + raise + logger.debug("VAT output: {}".format(out)) - json_out = json.loads(out) - return json_out + if self.json: + obj_start = out.find('{') + obj_end = out.rfind('}') + array_start = out.find('[') + array_end = out.rfind(']') + + if -1 == obj_start and -1 == array_start: + raise RuntimeError("VAT: no JSON data.") + + if obj_start < array_start or -1 == array_start: + start = obj_start + end = obj_end + 1 + else: + start = array_start + end = array_end + 1 + out = out[start:end] + json_out = json.loads(out) + return json_out + else: + return None def vat_terminal_close(self): """Close VAT terminal.""" - self._ssh.interactive_terminal_exec_command(self._tty, - 'quit', - self.__LINUX_PROMPT) + #interactive terminal is dead, we only need to close session + if not self._exec_failure: + self._ssh.interactive_terminal_exec_command(self._tty, + 'quit', + self.__LINUX_PROMPT) self._ssh.interactive_terminal_close(self._tty) def vat_terminal_exec_cmd_from_template(self, vat_template_file, **args): """Execute VAT script from a file. - :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 + + :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. """ file_path = '{}/{}'.format(Constants.RESOURCES_TPL_VAT, vat_template_file)