-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2022 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
"""Library for SSH connection management."""
-import StringIO
-from time import time, sleep
import socket
-import paramiko
-from paramiko import RSAKey
-from paramiko.ssh_exception import SSHException
-from scp import SCPClient
+
+from io import StringIO
+from time import monotonic, sleep
+
+from paramiko import RSAKey, SSHClient, AutoAddPolicy
+from paramiko.ssh_exception import SSHException, NoValidConnectionsError
from robot.api import logger
-from robot.utils.asserts import assert_equal
+from scp import SCPClient, SCPException
-__all__ = ["exec_cmd", "exec_cmd_no_error"]
+from resources.libraries.python.OptionString import OptionString
+
+__all__ = [
+ u"exec_cmd", u"exec_cmd_no_error", u"SSH", u"SSHTimeout", u"scp_node"
+]
# TODO: load priv key
class SSHTimeout(Exception):
"""This exception is raised when a timeout occurs."""
- pass
-class SSH(object):
+class SSH:
"""Contains methods for managing and using SSH connections."""
- __MAX_RECV_BUF = 10*1024*1024
- __existing_connections = {}
+ __MAX_RECV_BUF = 10 * 1024 * 1024
+ __existing_connections = dict()
def __init__(self):
self._ssh = None
:param node: Node in topology.
:type node: dict
- :return: IP address and port for the specified node.
+ :returns: IP address and port for the specified node.
:rtype: int
"""
-
- return hash(frozenset([node['host'], node['port']]))
+ return hash(frozenset([node[u"host"], node[u"port"]]))
def connect(self, node, attempts=5):
"""Connect to node prior to running exec_command or scp.
If there already is a connection to the node, this method reuses it.
+
+ :param node: Node in topology.
+ :param attempts: Number of reconnect attempts.
+ :type node: dict
+ :type attempts: int
+ :raises IOError: If cannot connect to host.
"""
- try:
- self._node = node
- node_hash = self._node_hash(node)
- if node_hash in SSH.__existing_connections:
- self._ssh = SSH.__existing_connections[node_hash]
- logger.debug('reusing ssh: {0}'.format(self._ssh))
+ self._node = node
+ node_hash = self._node_hash(node)
+ if node_hash in SSH.__existing_connections:
+ self._ssh = SSH.__existing_connections[node_hash]
+ if self._ssh.get_transport().is_active():
+ logger.debug(f"Reusing SSH: {self._ssh}")
else:
- start = time()
+ if attempts > 0:
+ self._reconnect(attempts-1)
+ else:
+ raise IOError(f"Cannot connect to {node['host']}")
+ else:
+ try:
+ start = monotonic()
pkey = None
- if 'priv_key' in node:
- pkey = RSAKey.from_private_key(
- StringIO.StringIO(node['priv_key']))
+ if u"priv_key" in node:
+ pkey = RSAKey.from_private_key(StringIO(node[u"priv_key"]))
- self._ssh = paramiko.SSHClient()
- self._ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
+ self._ssh = SSHClient()
+ self._ssh.set_missing_host_key_policy(AutoAddPolicy())
- self._ssh.connect(node['host'], username=node['username'],
- password=node.get('password'), pkey=pkey,
- port=node['port'])
+ self._ssh.connect(
+ node[u"host"], username=node[u"username"],
+ password=node.get(u"password"), pkey=pkey,
+ port=node[u"port"]
+ )
self._ssh.get_transport().set_keepalive(10)
SSH.__existing_connections[node_hash] = self._ssh
-
- logger.trace('connect took {} seconds'.format(time() - start))
- logger.debug('new ssh: {0}'.format(self._ssh))
-
- logger.debug('Connect peer: {0}'.
- format(self._ssh.get_transport().getpeername()))
- logger.debug('Connections: {0}'.
- format(str(SSH.__existing_connections)))
- except:
- if attempts > 0:
- self._reconnect(attempts-1)
- else:
- raise
-
- def disconnect(self, node):
+ logger.debug(
+ f"New SSH to {self._ssh.get_transport().getpeername()} "
+ f"took {monotonic() - start} seconds: {self._ssh}"
+ )
+ except SSHException as exc:
+ raise IOError(f"Cannot connect to {node[u'host']}") from exc
+ except NoValidConnectionsError as err:
+ raise IOError(
+ f"Unable to connect to port {node[u'port']} on "
+ f"{node[u'host']}"
+ ) from err
+
+ 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: {}, {}'.
- format(node['host'], node['port']))
+ logger.debug(
+ f"Disconnecting peer: {node[u'host']}, {node[u'port']}"
+ )
ssh = SSH.__existing_connections.pop(node_hash)
ssh.close()
def _reconnect(self, attempts=0):
- """Close the SSH connection and open it again."""
+ """Close the SSH connection and open it again.
+ :param attempts: Number of reconnect attempts.
+ :type attempts: int
+ """
node = self._node
self.disconnect(node)
self.connect(node, attempts)
- logger.debug('Reconnecting peer done: {}'.
- format(self._ssh.get_transport().getpeername()))
+ logger.debug(
+ f"Reconnecting peer done: {node[u'host']}, {node[u'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.
+ Needed for calls outside Robot (e.g. from reservation script).
+ :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.
"""
- start = time()
- stdout = StringIO.StringIO()
- stderr = StringIO.StringIO()
+ if isinstance(cmd, (list, tuple)):
+ cmd = OptionString(cmd)
+ cmd = str(cmd)
+ stdout = u""
+ stderr = u""
try:
chan = self._ssh.get_transport().open_session(timeout=5)
- except AttributeError:
- self._reconnect()
- chan = self._ssh.get_transport().open_session(timeout=5)
- except SSHException:
+ peer = self._ssh.get_transport().getpeername()
+ except (AttributeError, SSHException):
self._reconnect()
chan = self._ssh.get_transport().open_session(timeout=5)
+ peer = self._ssh.get_transport().getpeername()
chan.settimeout(timeout)
- logger.trace('exec_command on {0}: {1}'
- .format(self._ssh.get_transport().getpeername(), cmd))
+ logger.trace(f"exec_command on {peer} with timeout {timeout}: {cmd}")
+
+ start = monotonic()
chan.exec_command(cmd)
while not chan.exit_status_ready() and timeout is not None:
if chan.recv_ready():
- stdout.write(chan.recv(self.__MAX_RECV_BUF))
+ s_out = chan.recv(self.__MAX_RECV_BUF)
+ stdout += s_out.decode(encoding=u'utf-8', errors=u'ignore') \
+ if isinstance(s_out, bytes) else s_out
if chan.recv_stderr_ready():
- stderr.write(chan.recv_stderr(self.__MAX_RECV_BUF))
+ s_err = chan.recv_stderr(self.__MAX_RECV_BUF)
+ stderr += s_err.decode(encoding=u'utf-8', errors=u'ignore') \
+ if isinstance(s_err, bytes) else s_err
- if time() - start > timeout:
+ duration = monotonic() - start
+ if duration > timeout:
raise SSHTimeout(
- 'Timeout exception.\n'
- 'Current contents of stdout buffer: {0}\n'
- 'Current contents of stderr buffer: {1}\n'
- .format(stdout.getvalue(), stderr.getvalue())
+ f"Timeout exception during execution of command: {cmd}\n"
+ f"Current contents of stdout buffer: "
+ f"{stdout}\n"
+ f"Current contents of stderr buffer: "
+ f"{stderr}\n"
)
sleep(0.1)
return_code = chan.recv_exit_status()
while chan.recv_ready():
- stdout.write(chan.recv(self.__MAX_RECV_BUF))
+ s_out = chan.recv(self.__MAX_RECV_BUF)
+ stdout += s_out.decode(encoding=u'utf-8', errors=u'ignore') \
+ if isinstance(s_out, bytes) else s_out
while chan.recv_stderr_ready():
- stderr.write(chan.recv_stderr(self.__MAX_RECV_BUF))
-
- end = time()
- logger.trace('exec_command on {0} took {1} seconds'.format(
- self._ssh.get_transport().getpeername(), end-start))
-
- logger.trace('chan_recv/_stderr took {} seconds'.format(time()-end))
-
- logger.trace('return RC {}'.format(return_code))
- logger.trace('return STDOUT {}'.format(stdout.getvalue()))
- logger.trace('return STDERR {}'.format(stderr.getvalue()))
- return return_code, stdout.getvalue(), stderr.getvalue()
-
- def exec_command_sudo(self, cmd, cmd_input=None, timeout=30):
+ s_err = chan.recv_stderr(self.__MAX_RECV_BUF)
+ stderr += s_err.decode(encoding=u'utf-8', errors=u'ignore') \
+ if isinstance(s_err, bytes) else s_err
+
+ duration = monotonic() - start
+ logger.trace(f"exec_command on {peer} took {duration} seconds")
+
+ logger.trace(f"return RC {return_code}")
+ if log_stdout_err or int(return_code):
+ logger.trace(
+ f"return STDOUT {stdout}"
+ )
+ logger.trace(
+ f"return STDERR {stderr}"
+ )
+ return return_code, stdout, stderr
+
+ 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.
- :return: return_code, stdout, stderr
+ :param log_stdout_err: If True, stdout and stderr are logged.
+ Needed for calls outside Robot (e.g. from reservation script).
+ :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:
>>> ssh = SSH()
>>> ssh.connect(node)
>>> # Execute command without input (sudo -S cmd)
- >>> ssh.exec_command_sudo("ifconfig eth0 down")
- >>> # Execute command with input (sudo -S cmd <<< "input")
- >>> ssh.exec_command_sudo("vpp_api_test", "dump_interface_table")
+ >>> ssh.exec_command_sudo(u"ifconfig eth0 down")
+ >>> # Execute command with input (sudo -S cmd <<< 'input')
+ >>> ssh.exec_command_sudo(u"vpp_api_test", u"dump_interface_table")
"""
+ if isinstance(cmd, (list, tuple)):
+ cmd = OptionString(cmd)
if cmd_input is None:
- command = 'sudo -S {c}'.format(c=cmd)
+ command = f"sudo -E -S {cmd}"
else:
- command = 'sudo -S {c} <<< "{i}"'.format(c=cmd, i=cmd_input)
- return self.exec_command(command, timeout)
+ command = f"sudo -E -S {cmd} <<< \"{cmd_input}\""
+ 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):
+ def exec_command_lxc(
+ self, lxc_cmd, lxc_name, lxc_params=u"", sudo=True, timeout=30):
"""Execute command in LXC on a new SSH channel on the connected Node.
:param lxc_cmd: Command to be executed.
:type lxc_params: str
:type sudo: bool
:type timeout: int
- :return: return_code, stdout, stderr
+ :returns: return_code, stdout, stderr
"""
- command = "lxc-attach {p} --name {n} -- /bin/sh -c '{c}'"\
- .format(p=lxc_params, n=lxc_name, c=lxc_cmd)
+ command = f"lxc-attach {lxc_params} --name {lxc_name} -- /bin/sh " \
+ f"-c \"{lxc_cmd}\""
if sudo:
- command = 'sudo -S {c}'.format(c=command)
+ command = f"sudo -E -S {command}"
return self.exec_command(command, timeout)
- def interactive_terminal_open(self, time_out=30):
+ def interactive_terminal_open(self, time_out=45):
"""Open interactive terminal on a new channel on the connected Node.
:param time_out: Timeout in seconds.
- :return: SSH channel with opened terminal.
+ :returns: SSH channel with opened terminal.
.. warning:: Interruptingcow is used here, and it uses
signal(SIGALRM) to let the operating system interrupt program
chan.settimeout(int(time_out))
chan.set_combine_stderr(True)
- buf = ''
- while not buf.endswith((":~$ ", "~]$ ")):
+ buf = u""
+ while not buf.endswith((u":~# ", u":~$ ", u"~]$ ", u"~]# ")):
try:
- chunk = chan.recv(self.__MAX_RECV_BUF)
- if not chunk:
+ s_out = chan.recv(self.__MAX_RECV_BUF)
+ if not s_out:
break
- buf += chunk
+ buf += s_out.decode(encoding=u'utf-8', errors=u'ignore') \
+ if isinstance(s_out, bytes) else s_out
if chan.exit_status_ready():
- logger.error('Channel exit status ready')
+ logger.error(u"Channel exit status ready")
break
- except socket.timeout:
- raise Exception('Socket timeout: {0}'.format(buf))
+ except socket.timeout as exc:
+ raise Exception(f"Socket timeout: {buf}") from exc
return chan
def interactive_terminal_exec_command(self, chan, cmd, prompt):
:param chan: SSH channel with opened terminal.
:param cmd: Command to be executed.
:param prompt: Command prompt, sequence of characters used to
- indicate readiness to accept commands.
- :return: Command output.
+ indicate readiness to accept commands.
+ :returns: Command output.
.. warning:: Interruptingcow is used here, and it uses
signal(SIGALRM) to let the operating system interrupt program
from other threads. You must not use this in a program that
uses SIGALRM itself (this includes certain profilers)
"""
- chan.sendall('{c}\n'.format(c=cmd))
- buf = ''
+ chan.sendall(f"{cmd}\n")
+ buf = u""
while not buf.endswith(prompt):
try:
- chunk = chan.recv(self.__MAX_RECV_BUF)
- if not chunk:
+ s_out = chan.recv(self.__MAX_RECV_BUF)
+ if not s_out:
break
- buf += chunk
+ buf += s_out.decode(encoding=u'utf-8', errors=u'ignore') \
+ if isinstance(s_out, bytes) else s_out
if chan.exit_status_ready():
- logger.error('Channel exit status ready')
+ logger.error(u"Channel exit status ready")
break
- except socket.timeout:
- raise Exception('Socket timeout: {0}'.format(buf))
- tmp = buf.replace(cmd.replace('\n', ''), '')
+ except socket.timeout as exc:
+ raise Exception(
+ f"Socket timeout during execution of command: {cmd}\n"
+ f"Buffer content:\n{buf}"
+ ) from exc
+ tmp = buf.replace(cmd.replace(u"\n", u""), u"")
for item in prompt:
- tmp.replace(item, '')
+ tmp.replace(item, u"")
return tmp
@staticmethod
def interactive_terminal_close(chan):
"""Close interactive terminal SSH channel.
- :param: chan: SSH channel to be closed.
+ :param chan: SSH channel to be closed.
"""
chan.close()
- def scp(self, local_path, remote_path, get=False):
+ def scp(
+ self, local_path, remote_path, get=False, timeout=30,
+ wildcard=False):
"""Copy files from local_path to remote_path or vice versa.
connect() method has to be called first!
:param local_path: Path to local file that should be uploaded; or
- path where to save remote file.
+ path where to save remote file.
:param remote_path: Remote path where to place uploaded file; or
- path to remote file which should be downloaded.
+ path to remote file which should be downloaded.
:param get: scp operation to perform. Default is put.
+ :param timeout: Timeout value in seconds.
+ :param wildcard: If path has wildcard characters. Default is false.
:type local_path: str
:type remote_path: str
:type get: bool
+ :type timeout: int
+ :type wildcard: bool
"""
if not get:
- logger.trace('SCP {0} to {1}:{2}'.format(
- local_path, self._ssh.get_transport().getpeername(),
- remote_path))
+ logger.trace(
+ f"SCP {local_path} to "
+ f"{self._ssh.get_transport().getpeername()}:{remote_path}"
+ )
else:
- logger.trace('SCP {0}:{1} to {2}'.format(
- self._ssh.get_transport().getpeername(), remote_path,
- local_path))
+ logger.trace(
+ f"SCP {self._ssh.get_transport().getpeername()}:{remote_path} "
+ f"to {local_path}"
+ )
# SCPCLient takes a paramiko transport as its only argument
- scp = SCPClient(self._ssh.get_transport(), socket_timeout=10)
- start = time()
+ if not wildcard:
+ scp = SCPClient(self._ssh.get_transport(), socket_timeout=timeout)
+ else:
+ scp = SCPClient(
+ self._ssh.get_transport(), sanitize=lambda x: x,
+ socket_timeout=timeout
+ )
+ start = monotonic()
if not get:
scp.put(local_path, remote_path)
else:
scp.get(remote_path, local_path)
scp.close()
- end = time()
- logger.trace('SCP took {0} seconds'.format(end-start))
+ duration = monotonic() - start
+ logger.trace(f"SCP took {duration} seconds")
-def exec_cmd(node, cmd, timeout=600, sudo=False):
+def exec_cmd(
+ node, cmd, timeout=600, sudo=False, disconnect=False,
+ log_stdout_err=True
+ ):
"""Convenience function to ssh/exec/return rc, out & err.
Returns (rc, stdout, stderr).
+
+ :param node: The node to execute command on.
+ :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.
+ :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.
+ Needed for calls outside Robot (e.g. from reservation script).
+ :type node: dict
+ :type cmd: str or OptionString
+ :type timeout: int
+ :type sudo: bool
+ :type disconnect: bool
+ :type log_stdout_err: bool
+ :returns: RC, Stdout, Stderr.
+ :rtype: Tuple[int, str, str]
"""
if node is None:
- raise TypeError('Node parameter is None')
+ raise TypeError(u"Node parameter is None")
if cmd is None:
- raise TypeError('Command parameter is None')
- if len(cmd) == 0:
- raise ValueError('Empty command parameter')
+ raise TypeError(u"Command parameter is None")
+ if not cmd:
+ raise ValueError(u"Empty command parameter")
ssh = SSH()
+
try:
ssh.connect(node)
except SSHException as err:
- logger.error("Failed to connect to node" + str(err))
+ logger.error(f"Failed to connect to node {node[u'host']}\n{err!r}")
return None, None, None
try:
if not sudo:
- (ret_code, stdout, stderr) = ssh.exec_command(cmd, timeout=timeout)
+ ret_code, stdout, stderr = ssh.exec_command(
+ cmd, timeout=timeout, log_stdout_err=log_stdout_err
+ )
else:
- (ret_code, stdout, stderr) = ssh.exec_command_sudo(cmd,
- timeout=timeout)
+ ret_code, stdout, stderr = ssh.exec_command_sudo(
+ cmd, timeout=timeout, log_stdout_err=log_stdout_err
+ )
except SSHException as err:
- logger.error(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):
+def exec_cmd_no_error(
+ node, cmd, timeout=600, sudo=False, message=None, disconnect=False,
+ retries=0, include_reason=False, log_stdout_err=True
+ ):
"""Convenience function to ssh/exec/return out & err.
Verifies that return code is zero.
-
- Returns (stdout, stderr).
+ 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.
+ :param include_reason: Whether default info should be appended to message.
+ :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.
+ Needed for calls outside Robot thread (e.g. parallel framework setup).
+ :type node: dict
+ :type cmd: str or OptionString
+ :type timeout: int
+ :type sudo: bool
+ :type message: str
+ :type disconnect: bool
+ :type retries: int
+ :type include_reason: bool
+ :type log_stdout_err: bool
+ :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)
- assert_equal(ret_code, 0, 'Command execution failed: "{}"\n{}'.
- format(cmd, stderr))
+ for _ in range(retries + 1):
+ ret_code, stdout, stderr = exec_cmd(
+ node, cmd, timeout=timeout, sudo=sudo, disconnect=disconnect,
+ log_stdout_err=log_stdout_err
+ )
+ if ret_code == 0:
+ break
+ sleep(1)
+ else:
+ msg = f"Command execution failed: '{cmd}'\nRC: {ret_code}\n{stderr}"
+ logger.info(msg)
+ if message:
+ msg = f"{message}\n{msg}" if include_reason else 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.
+
+ :param node: SUT node.
+ :param local_path: Path to local file that should be uploaded; or
+ path where to save remote file.
+ :param remote_path: Remote path where to place uploaded file; or
+ 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()
+
+ try:
+ ssh.connect(node)
+ except SSHException as exc:
+ raise RuntimeError(f"Failed to connect to {node[u'host']}!") from exc
+ try:
+ ssh.scp(local_path, remote_path, get, timeout)
+ except SCPException as exc:
+ raise RuntimeError(f"SCP execution failed on {node[u'host']}!") from exc
+ finally:
+ if disconnect:
+ ssh.disconnect()
Code Review / csit.git / blobdiff