1 # Copyright 2013: Mirantis Inc.
4 # Licensed under the Apache License, Version 2.0 (the "License"); you may
5 # not use this file except in compliance with the License. You may obtain
6 # a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 # License for the specific language governing permissions and limitations
16 # yardstick comment: this is a modified copy of rally/rally/common/sshutils.py
18 """High level ssh library.
22 Execute command and get output:
24 ssh = sshclient.SSH("root", "example.com", port=33)
25 status, stdout, stderr = ssh.execute("ps ax")
27 raise Exception("Command failed with non-zero status.")
28 print stdout.splitlines()
30 Execute command with huge output:
32 class PseudoFile(object):
37 ssh = sshclient.SSH("root", "example.com")
38 ssh.run("tail -f /var/log/syslog", stdout=PseudoFile(), timeout=False)
40 Execute local script on remote side:
42 ssh = sshclient.SSH("user", "example.com")
43 status, out, err = ssh.execute("/bin/sh -s arg1 arg2",
44 stdin=open("~/myscript.sh", "r"))
48 ssh = sshclient.SSH("user", "example.com")
49 ssh.run("cat > ~/upload/file.gz", stdin=open("/store/file.gz", "rb"))
53 eventlet.monkey_patch(select=True, time=True)
55 eventlet.monkey_patch()
57 sshclient = eventlet.import_patched("opentstack.common.sshclient")
66 from scp import SCPClient
70 LOG = logging.getLogger(__name__)
75 class SSHError(Exception):
79 class SSHTimeout(SSHError):
84 """Represent ssh connection."""
86 def __init__(self, user, host, port=DEFAULT_PORT, pkey=None,
87 key_filename=None, password=None):
88 """Initialize SSH client.
90 :param user: ssh username
91 :param host: hostname or ip address of remote ssh server
92 :param port: remote ssh port
93 :param pkey: RSA or DSS private key string or file object
94 :param key_filename: private key filename
95 :param password: password
100 # we may get text port from YAML, convert to int
101 self.port = int(port)
102 self.pkey = self._get_pkey(pkey) if pkey else None
103 self.password = password
104 self.key_filename = key_filename
107 def _get_pkey(self, key):
108 if isinstance(key, six.string_types):
109 key = six.moves.StringIO(key)
111 for key_class in (paramiko.rsakey.RSAKey, paramiko.dsskey.DSSKey):
113 return key_class.from_private_key(key)
114 except paramiko.SSHException as e:
116 raise SSHError("Invalid pkey: %s" % (errors))
118 def _get_client(self):
122 self._client = paramiko.SSHClient()
123 self._client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
124 self._client.connect(self.host, username=self.user,
125 port=self.port, pkey=self.pkey,
126 key_filename=self.key_filename,
127 password=self.password,
128 allow_agent=False, look_for_keys=False,
131 except Exception as e:
132 message = ("Exception %(exception_type)s was raised "
133 "during connect. Exception value is: %(exception)r")
135 raise SSHError(message % {"exception": e,
136 "exception_type": type(e)})
142 def run(self, cmd, stdin=None, stdout=None, stderr=None,
143 raise_on_error=True, timeout=3600):
144 """Execute specified command on the server.
146 :param cmd: Command to be executed.
147 :param stdin: Open file or string to pass to stdin.
148 :param stdout: Open file to connect to stdout.
149 :param stderr: Open file to connect to stderr.
150 :param raise_on_error: If False then exit code will be return. If True
151 then exception will be raized if non-zero code.
152 :param timeout: Timeout in seconds for command execution.
153 Default 1 hour. No timeout if set to 0.
156 client = self._get_client()
158 if isinstance(stdin, six.string_types):
159 stdin = six.moves.StringIO(stdin)
161 return self._run(client, cmd, stdin=stdin, stdout=stdout,
162 stderr=stderr, raise_on_error=raise_on_error,
165 def _run(self, client, cmd, stdin=None, stdout=None, stderr=None,
166 raise_on_error=True, timeout=3600):
168 transport = client.get_transport()
169 session = transport.open_session()
170 session.exec_command(cmd)
171 start_time = time.time()
176 # If we have data to be sent to stdin then `select' should also
177 # check for stdin availability.
178 if stdin and not stdin.closed:
184 # Block until data can be read/write.
185 r, w, e = select.select([session], writes, [session], 1)
187 if session.recv_ready():
188 data = session.recv(4096)
189 LOG.debug("stdout: %r" % data)
190 if stdout is not None:
194 if session.recv_stderr_ready():
195 stderr_data = session.recv_stderr(4096)
196 LOG.debug("stderr: %r" % stderr_data)
197 if stderr is not None:
198 stderr.write(stderr_data)
201 if session.send_ready():
202 if stdin is not None and not stdin.closed:
204 data_to_send = stdin.read(4096)
207 session.shutdown_write()
210 sent_bytes = session.send(data_to_send)
211 # LOG.debug("sent: %s" % data_to_send[:sent_bytes])
212 data_to_send = data_to_send[sent_bytes:]
214 if session.exit_status_ready():
217 if timeout and (time.time() - timeout) > start_time:
218 args = {"cmd": cmd, "host": self.host}
219 raise SSHTimeout("Timeout executing command "
220 "'%(cmd)s' on host %(host)s" % args)
222 raise SSHError("Socket error.")
224 exit_status = session.recv_exit_status()
225 if 0 != exit_status and raise_on_error:
226 fmt = "Command '%(cmd)s' failed with exit_status %(status)d."
227 details = fmt % {"cmd": cmd, "status": exit_status}
229 details += " Last stderr data: '%s'." % stderr_data
230 raise SSHError(details)
233 def execute(self, cmd, stdin=None, timeout=3600):
234 """Execute the specified command on the server.
236 :param cmd: Command to be executed.
237 :param stdin: Open file to be sent on process stdin.
238 :param timeout: Timeout for execution of the command.
240 :returns: tuple (exit_status, stdout, stderr)
242 stdout = six.moves.StringIO()
243 stderr = six.moves.StringIO()
245 exit_status = self.run(cmd, stderr=stderr,
246 stdout=stdout, stdin=stdin,
247 timeout=timeout, raise_on_error=False)
250 return (exit_status, stdout.read(), stderr.read())
252 def wait(self, timeout=120, interval=1):
253 """Wait for the host will be available via ssh."""
254 start_time = time.time()
257 return self.execute("uname")
258 except (socket.error, SSHError) as e:
259 LOG.debug("Ssh is still unavailable: %r" % e)
261 if time.time() > (start_time + timeout):
262 raise SSHTimeout("Timeout waiting for '%s'" % self.host)
264 def put(self, files, remote_path=b'.', recursive=False):
265 client = self._get_client()
267 with SCPClient(client.get_transport()) as scp:
268 scp.put(files, remote_path, recursive)
270 # keep shell running in the background, e.g. screen
271 def send_command(self, command):
272 client = self._get_client()
273 client.exec_command(command, get_pty=True)