import socket
import StringIO
-
from time import time, sleep
from paramiko import RSAKey, SSHClient, AutoAddPolicy
from robot.api import logger
from scp import SCPClient, SCPException
+from resources.libraries.python.OptionString import OptionString
+from resources.libraries.python.PythonThree import raise_from
__all__ = ["exec_cmd", "exec_cmd_no_error"]
peer=self._ssh.get_transport().getpeername(),
total=(time() - start),
ssh=self._ssh))
- except SSHException:
- raise IOError('Cannot connect to {host}'.
- format(host=node['host']))
+ except SSHException as exc:
+ raise_from(IOError('Cannot connect to {host}'.format(
+ host=node['host'])), exc)
except NoValidConnectionsError as err:
- logger.error(repr(err))
- raise IOError('Unable to connect to port {port} on {host}'.
- format(port=node['port'], host=node['host']))
+ raise_from(IOError(
+ 'Unable to connect to port {port} on {host}'.format(
+ port=node['port'], host=node['host'])), err)
def disconnect(self, node=None):
"""Close SSH connection to the node.
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.
+ 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.
"""
+ if isinstance(cmd, (list, tuple)):
+ cmd = OptionString(cmd)
cmd = str(cmd)
stdout = StringIO.StringIO()
stderr = StringIO.StringIO()
try:
chan = self._ssh.get_transport().open_session(timeout=5)
peer = self._ssh.get_transport().getpeername()
- except AttributeError:
- self._reconnect()
- chan = self._ssh.get_transport().open_session(timeout=5)
- peer = self._ssh.get_transport().getpeername()
- except SSHException:
+ except (AttributeError, SSHException):
self._reconnect()
chan = self._ssh.get_transport().open_session(timeout=5)
peer = self._ssh.get_transport().getpeername()
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:
>>> # Execute command with input (sudo -S cmd <<< "input")
>>> ssh.exec_command_sudo("vpp_api_test", "dump_interface_table")
"""
+ if isinstance(cmd, (list, tuple)):
+ cmd = OptionString(cmd)
if cmd_input is None:
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):
if chan.exit_status_ready():
logger.error('Channel exit status ready')
break
- except socket.timeout:
- logger.error('Socket timeout: {0}'.format(buf))
- raise Exception('Socket timeout: {0}'.format(buf))
+ except socket.timeout as exc:
+ raise_from(Exception('Socket timeout: {0}'.format(buf)), exc)
return chan
def interactive_terminal_exec_command(self, chan, cmd, prompt):
if chan.exit_status_ready():
logger.error('Channel exit status ready')
break
- except socket.timeout:
- logger.error('Socket timeout during execution of command: '
- '{0}\nBuffer content:\n{1}'.format(cmd, buf))
- raise Exception('Socket timeout during execution of command: '
- '{0}\nBuffer content:\n{1}'.format(cmd, buf))
+ except socket.timeout as exc:
+ raise_from(Exception(
+ 'Socket timeout during execution of command: '
+ '{0}\nBuffer content:\n{1}'.format(cmd, buf)), exc)
tmp = buf.replace(cmd.replace('\n', ''), '')
for item in prompt:
tmp.replace(item, '')
def exec_cmd_no_error(
node, cmd, timeout=600, sudo=False, message=None, disconnect=False,
- retries=0):
+ retries=0, include_reason=False):
"""Convenience function to ssh/exec/return out & err.
Verifies that return code is zero.
: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.
+ :param include_reason: Whether default info should be appended to message.
:type node: dict
:type cmd: str or OptionString
:type timeout: int
:type message: str
:type disconnect: bool
:type retries: int
+ :type include_reason: bool
:returns: Stdout, Stderr.
:rtype: tuple(str, str)
:raises RuntimeError: If bash return code is not 0.
break
sleep(1)
else:
- msg = ('Command execution failed: "{cmd}"\n{stderr}'.
- format(cmd=cmd, stderr=stderr) if message is None else message)
+ msg = 'Command execution failed: "{cmd}"\nRC: {rc}\n{stderr}'.format(
+ cmd=cmd, rc=ret_code, stderr=stderr)
+ logger.info(msg)
+ if message:
+ if include_reason:
+ msg = message + '\n' + msg
+ else:
+ msg = message
raise RuntimeError(msg)
return stdout, stderr
+
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.
try:
ssh.connect(node)
- except SSHException:
- raise RuntimeError('Failed to connect to {host}!'
- .format(host=node['host']))
+ except SSHException as exc:
+ raise_from(RuntimeError(
+ 'Failed to connect to {host}!'.format(host=node['host'])), exc)
try:
ssh.scp(local_path, remote_path, get, timeout)
- except SCPException:
- raise RuntimeError('SCP execution failed on {host}!'
- .format(host=node['host']))
+ except SCPException as exc:
+ raise_from(RuntimeError(
+ 'SCP execution failed on {host}!'.format(host=node['host'])), exc)
finally:
if disconnect:
ssh.disconnect()