X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2Fssh.py;h=e89daf291528e45825aafcf65846e8a8b8f49614;hp=60f62561be1f453f7bb400a36a3392160d897f0a;hb=72ae46cda69c2f12efdbe731e37dce200a48f424;hpb=390cb24b3945442fba9f84dc292b6a4138d4835e diff --git a/resources/libraries/python/ssh.py b/resources/libraries/python/ssh.py index 60f62561be..e89daf2915 100644 --- a/resources/libraries/python/ssh.py +++ b/resources/libraries/python/ssh.py @@ -111,12 +111,16 @@ class SSH(object): raise IOError('Unable to connect to port {port} on {host}'. format(port=node['port'], host=node['host'])) - def disconnect(self, node): + def disconnect(self, node=None): """Close SSH connection to the node. - :param node: The node to disconnect from. - :type node: dict + :param node: The node to disconnect from. None means last connected. + :type node: dict or None """ + if node is None: + node = self._node + if node is None: + return node_hash = self._node_hash(node) if node_hash in SSH.__existing_connections: logger.debug('Disconnecting peer: {host}, {port}'. @@ -136,18 +140,23 @@ class SSH(object): logger.debug('Reconnecting peer done: {host}, {port}'. format(host=node['host'], port=node['port'])) - def exec_command(self, cmd, timeout=10): + def exec_command(self, cmd, timeout=10, log_stdout_err=True): """Execute SSH command on a new channel on the connected Node. :param cmd: Command to run on the Node. :param timeout: Maximal time in seconds to wait until the command is - done. If set to None then wait forever. - :type cmd: str + done. If set to None then wait forever. + :param log_stdout_err: If True, stdout and stderr are logged. stdout + and stderr are logged also if the return code is not zero + independently of the value of log_stdout_err. + :type cmd: str or OptionString :type timeout: int - :return return_code, stdout, stderr + :type log_stdout_err: bool + :returns: return_code, stdout, stderr :rtype: tuple(int, str, str) - :raise SSHTimeout: If command is not finished in timeout time. + :raises SSHTimeout: If command is not finished in timeout time. """ + cmd = str(cmd) stdout = StringIO.StringIO() stderr = StringIO.StringIO() try: @@ -198,17 +207,27 @@ class SSH(object): format(peer=peer, total=end-start)) logger.trace('return RC {rc}'.format(rc=return_code)) - logger.trace('return STDOUT {stdout}'.format(stdout=stdout.getvalue())) - logger.trace('return STDERR {stderr}'.format(stderr=stderr.getvalue())) + if log_stdout_err or int(return_code): + logger.trace('return STDOUT {stdout}'. + format(stdout=stdout.getvalue())) + logger.trace('return STDERR {stderr}'. + format(stderr=stderr.getvalue())) return return_code, stdout.getvalue(), stderr.getvalue() - def exec_command_sudo(self, cmd, cmd_input=None, timeout=30): + def exec_command_sudo(self, cmd, cmd_input=None, timeout=30, + log_stdout_err=True): """Execute SSH command with sudo on a new channel on the connected Node. :param cmd: Command to be executed. :param cmd_input: Input redirected to the command. :param timeout: Timeout. + :param log_stdout_err: If True, stdout and stderr are logged. + :type cmd: str + :type cmd_input: str + :type timeout: int + :type log_stdout_err: bool :returns: return_code, stdout, stderr + :rtype: tuple(int, str, str) :Example: @@ -224,7 +243,8 @@ class SSH(object): command = 'sudo -S {c}'.format(c=cmd) else: command = 'sudo -S {c} <<< "{i}"'.format(c=cmd, i=cmd_input) - return self.exec_command(command, timeout) + return self.exec_command(command, timeout, + log_stdout_err=log_stdout_err) def exec_command_lxc(self, lxc_cmd, lxc_name, lxc_params='', sudo=True, timeout=30): @@ -373,7 +393,7 @@ class SSH(object): logger.trace('SCP took {0} seconds'.format(end-start)) -def exec_cmd(node, cmd, timeout=600, sudo=False): +def exec_cmd(node, cmd, timeout=600, sudo=False, disconnect=False): """Convenience function to ssh/exec/return rc, out & err. Returns (rc, stdout, stderr). @@ -382,10 +402,12 @@ def exec_cmd(node, cmd, timeout=600, sudo=False): :param cmd: Command to execute. :param timeout: Timeout value in seconds. Default: 600. :param sudo: Sudo privilege execution flag. Default: False. + :param disconnect: Close the opened SSH connection if True. :type node: dict - :type cmd: str + :type cmd: str or OptionString :type timeout: int :type sudo: bool + :type disconnect: bool :returns: RC, Stdout, Stderr. :rtype: tuple(int, str, str) """ @@ -437,38 +459,56 @@ def exec_cmd(node, cmd, timeout=600, sudo=False): except SSHException as err: logger.error(repr(err)) return None, None, None + finally: + if disconnect: + ssh.disconnect() return ret_code, stdout, stderr -def exec_cmd_no_error(node, cmd, timeout=600, sudo=False, message=None): +def exec_cmd_no_error( + node, cmd, timeout=600, sudo=False, message=None, disconnect=False, + retries=0): """Convenience function to ssh/exec/return out & err. Verifies that return code is zero. + Supports retries, timeout is related to each try separately then. There is + sleep(1) before each retry. + Disconnect (if enabled) is applied after each try. :param node: DUT node. :param cmd: Command to be executed. :param timeout: Timeout value in seconds. Default: 600. :param sudo: Sudo privilege execution flag. Default: False. :param message: Error message in case of failure. Default: None. + :param disconnect: Close the opened SSH connection if True. + :param retries: How many times to retry on failure. :type node: dict - :type cmd: str + :type cmd: str or OptionString :type timeout: int :type sudo: bool :type message: str + :type disconnect: bool + :type retries: int :returns: Stdout, Stderr. :rtype: tuple(str, str) :raises RuntimeError: If bash return code is not 0. """ - ret_code, stdout, stderr = exec_cmd(node, cmd, timeout=timeout, sudo=sudo) - msg = ('Command execution failed: "{cmd}"\n{stderr}'. - format(cmd=cmd, stderr=stderr) if message is None else message) - if ret_code != 0: + for _ in range(retries + 1): + ret_code, stdout, stderr = exec_cmd( + node, cmd, timeout=timeout, sudo=sudo, disconnect=disconnect) + if ret_code == 0: + break + sleep(1) + else: + msg = ('Command execution failed: "{cmd}"\n{stderr}'. + format(cmd=cmd, stderr=stderr) if message is None else message) raise RuntimeError(msg) return stdout, stderr -def scp_node(node, local_path, remote_path, get=False, timeout=30): +def scp_node( + node, local_path, remote_path, get=False, timeout=30, disconnect=False): """Copy files from local_path to remote_path or vice versa. :param node: SUT node. @@ -478,11 +518,13 @@ def scp_node(node, local_path, remote_path, get=False, timeout=30): path to remote file which should be downloaded. :param get: scp operation to perform. Default is put. :param timeout: Timeout value in seconds. + :param disconnect: Close the opened SSH connection if True. :type node: dict :type local_path: str :type remote_path: str :type get: bool :type timeout: int + :type disconnect: bool :raises RuntimeError: If SSH connection failed or SCP transfer failed. """ ssh = SSH() @@ -497,3 +539,6 @@ def scp_node(node, local_path, remote_path, get=False, timeout=30): except SCPException: raise RuntimeError('SCP execution failed on {host}!' .format(host=node['host'])) + finally: + if disconnect: + ssh.disconnect()