Move SSHClient to separate file
Moved from helpers to ssh_client Fixed imports Found deprecated helpers marked for static analyzer Change-Id: Ib2dd534e9e0ed82d50df8445018dc1bdcdb7f1cd blueprint: sshmanager-integration
This commit is contained in:
Alexey Stepanov
parent
5d0df07841
commit
070f1e8386
|
|
@ -15,11 +15,8 @@
|
|||
# pylint: disable=redefined-builtin
|
||||
from functools import reduce
|
||||
# pylint: enable=redefined-builtin
|
||||
import logging
|
||||
import os
|
||||
import posixpath
|
||||
import socket
|
||||
import stat
|
||||
import time
|
||||
from warnings import warn
|
||||
|
||||
|
|
@ -31,10 +28,9 @@ from six.moves import xmlrpc_client
|
|||
|
||||
|
||||
from devops.error import AuthenticationError
|
||||
from devops.error import DevopsCalledProcessError
|
||||
from devops.error import DevopsError
|
||||
from devops.error import TimeoutError
|
||||
from devops.helpers.retry import retry
|
||||
from devops.helpers.ssh_client import SSHClient
|
||||
from devops import logger
|
||||
from devops.settings import KEYSTONE_CREDS
|
||||
from devops.settings import SSH_CREDENTIALS
|
||||
|
|
@ -231,250 +227,24 @@ def get_keys(ip, mask, gw, hostname, nat_interface, dns1, showmenu,
|
|||
|
||||
|
||||
class KeyPolicy(paramiko.WarningPolicy):
|
||||
def __init__(self):
|
||||
warn(
|
||||
'devops.helpers.KeyPolicy is deprecated '
|
||||
'and will be removed soon', DeprecationWarning)
|
||||
logger.warning(
|
||||
'devops.helpers.KeyPolicy is deprecated '
|
||||
'and will be removed soon'
|
||||
)
|
||||
super(KeyPolicy, self).__init__()
|
||||
|
||||
def missing_host_key(self, client, hostname, key):
|
||||
return
|
||||
|
||||
|
||||
class SSHClient(object):
|
||||
class get_sudo(object):
|
||||
def __init__(self, ssh):
|
||||
self.ssh = ssh
|
||||
|
||||
def __enter__(self):
|
||||
self.ssh.sudo_mode = True
|
||||
|
||||
def __exit__(self, exc_type, value, traceback):
|
||||
self.ssh.sudo_mode = False
|
||||
|
||||
def __init__(self, host, port=22, username=None, password=None,
|
||||
private_keys=None):
|
||||
self.host = str(host)
|
||||
self.port = int(port)
|
||||
self.username = username
|
||||
self.password = password
|
||||
if not private_keys:
|
||||
private_keys = []
|
||||
self.private_keys = private_keys
|
||||
|
||||
self.sudo_mode = False
|
||||
self.sudo = self.get_sudo(self)
|
||||
self._ssh = None
|
||||
self.__sftp = None
|
||||
|
||||
self.reconnect()
|
||||
|
||||
@property
|
||||
def _sftp(self):
|
||||
if self.__sftp is not None:
|
||||
return self.__sftp
|
||||
logger.warning('SFTP is not connected, try to reconnect')
|
||||
self._connect_sftp()
|
||||
if self.__sftp is not None:
|
||||
return self.__sftp
|
||||
raise paramiko.SSHException('SFTP connection failed')
|
||||
|
||||
def clear(self):
|
||||
try:
|
||||
self.__sftp.close()
|
||||
except Exception:
|
||||
logger.exception("Could not close sftp connection")
|
||||
try:
|
||||
self._ssh.close()
|
||||
except Exception:
|
||||
logger.exception("Could not close ssh connection")
|
||||
|
||||
def __del__(self):
|
||||
self.clear()
|
||||
|
||||
def __enter__(self):
|
||||
return self
|
||||
|
||||
def __exit__(self, *err):
|
||||
self.clear()
|
||||
|
||||
@retry(count=3, delay=3)
|
||||
def connect(self):
|
||||
logging.debug(
|
||||
"Connect to '{0}:{1}' as '{2}:{3}'".format(
|
||||
self.host, self.port, self.username, self.password))
|
||||
for private_key in self.private_keys:
|
||||
try:
|
||||
return self._ssh.connect(
|
||||
self.host, port=self.port, username=self.username,
|
||||
password=self.password, pkey=private_key)
|
||||
except paramiko.AuthenticationException:
|
||||
continue
|
||||
if self.private_keys:
|
||||
logging.error("Authentication with keys failed")
|
||||
|
||||
return self._ssh.connect(
|
||||
self.host, port=self.port, username=self.username,
|
||||
password=self.password)
|
||||
|
||||
def _connect_sftp(self):
|
||||
try:
|
||||
self.__sftp = self._ssh.open_sftp()
|
||||
except paramiko.SSHException:
|
||||
logger.warning('SFTP enable failed! SSH only is accessible.')
|
||||
|
||||
def reconnect(self):
|
||||
self._ssh = paramiko.SSHClient()
|
||||
self._ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
|
||||
self.connect()
|
||||
self._connect_sftp()
|
||||
|
||||
def check_call(self, command, verbose=False):
|
||||
ret = self.execute(command, verbose)
|
||||
if ret['exit_code'] != 0:
|
||||
raise DevopsCalledProcessError(command, ret['exit_code'],
|
||||
ret['stdout'] + ret['stderr'])
|
||||
return ret
|
||||
|
||||
def check_stderr(self, command, verbose=False):
|
||||
ret = self.check_call(command, verbose)
|
||||
if ret['stderr']:
|
||||
raise DevopsCalledProcessError(command, ret['exit_code'],
|
||||
ret['stdout'] + ret['stderr'])
|
||||
return ret
|
||||
|
||||
@classmethod
|
||||
def execute_together(cls, remotes, command):
|
||||
futures = {}
|
||||
errors = {}
|
||||
for remote in remotes:
|
||||
cmd = "%s\n" % command
|
||||
if remote.sudo_mode:
|
||||
cmd = 'sudo -S bash -c "%s"' % cmd.replace('"', '\\"')
|
||||
chan = remote._ssh.get_transport().open_session()
|
||||
chan.exec_command(cmd)
|
||||
futures[remote] = chan
|
||||
for remote, chan in futures.items():
|
||||
ret = chan.recv_exit_status()
|
||||
if ret != 0:
|
||||
errors[remote.host] = ret
|
||||
if errors:
|
||||
raise DevopsCalledProcessError(command, errors)
|
||||
|
||||
def execute(self, command, verbose=False):
|
||||
chan, _, stderr, stdout = self.execute_async(command)
|
||||
result = {
|
||||
'stdout': [],
|
||||
'stderr': [],
|
||||
'exit_code': 0
|
||||
}
|
||||
for line in stdout:
|
||||
result['stdout'].append(line)
|
||||
if verbose:
|
||||
logger.info(line)
|
||||
for line in stderr:
|
||||
result['stderr'].append(line)
|
||||
if verbose:
|
||||
logger.info(line)
|
||||
result['exit_code'] = chan.recv_exit_status()
|
||||
chan.close()
|
||||
return result
|
||||
|
||||
def execute_async(self, command):
|
||||
logging.debug("Executing command: '{}'".format(command.rstrip()))
|
||||
chan = self._ssh.get_transport().open_session()
|
||||
stdin = chan.makefile('wb')
|
||||
stdout = chan.makefile('rb')
|
||||
stderr = chan.makefile_stderr('rb')
|
||||
cmd = "%s\n" % command
|
||||
if self.sudo_mode:
|
||||
cmd = 'sudo -S bash -c "%s"' % cmd.replace('"', '\\"')
|
||||
chan.exec_command(cmd)
|
||||
if stdout.channel.closed is False:
|
||||
stdin.write('%s\n' % self.password)
|
||||
stdin.flush()
|
||||
else:
|
||||
chan.exec_command(cmd)
|
||||
return chan, stdin, stderr, stdout
|
||||
|
||||
def mkdir(self, path):
|
||||
if self.exists(path):
|
||||
return
|
||||
logger.debug("Creating directory: %s", path)
|
||||
self.execute("mkdir -p %s\n" % path)
|
||||
|
||||
def rm_rf(self, path):
|
||||
logger.debug("Removing directory: %s", path)
|
||||
self.execute("rm -rf %s" % path)
|
||||
|
||||
def open(self, path, mode='r'):
|
||||
return self._sftp.open(path, mode)
|
||||
|
||||
def upload(self, source, target):
|
||||
logger.debug("Copying '%s' -> '%s'", source, target)
|
||||
|
||||
if self.isdir(target):
|
||||
target = posixpath.join(target, os.path.basename(source))
|
||||
|
||||
source = os.path.expanduser(source)
|
||||
if not os.path.isdir(source):
|
||||
self._sftp.put(source, target)
|
||||
return
|
||||
|
||||
for rootdir, _, files in os.walk(source):
|
||||
targetdir = os.path.normpath(
|
||||
os.path.join(
|
||||
target,
|
||||
os.path.relpath(rootdir, source))).replace("\\", "/")
|
||||
|
||||
self.mkdir(targetdir)
|
||||
|
||||
for entry in files:
|
||||
local_path = os.path.join(rootdir, entry)
|
||||
remote_path = posixpath.join(targetdir, entry)
|
||||
if self.exists(remote_path):
|
||||
self._sftp.unlink(remote_path)
|
||||
self._sftp.put(local_path, remote_path)
|
||||
|
||||
def download(self, destination, target):
|
||||
logger.debug(
|
||||
"Copying '%s' -> '%s' from remote to local host",
|
||||
destination, target
|
||||
)
|
||||
|
||||
if os.path.isdir(target):
|
||||
target = posixpath.join(target, os.path.basename(destination))
|
||||
|
||||
if not self.isdir(destination):
|
||||
if self.exists(destination):
|
||||
self._sftp.get(destination, target)
|
||||
else:
|
||||
logger.debug(
|
||||
"Can't download %s because it doesn't exist", destination
|
||||
)
|
||||
else:
|
||||
logger.debug(
|
||||
"Can't download %s because it is a directory", destination
|
||||
)
|
||||
return os.path.exists(target)
|
||||
|
||||
def exists(self, path):
|
||||
try:
|
||||
self._sftp.lstat(path)
|
||||
return True
|
||||
except IOError:
|
||||
return False
|
||||
|
||||
def isfile(self, path):
|
||||
try:
|
||||
attrs = self._sftp.lstat(path)
|
||||
return attrs.st_mode & stat.S_IFREG != 0
|
||||
except IOError:
|
||||
return False
|
||||
|
||||
def isdir(self, path):
|
||||
try:
|
||||
attrs = self._sftp.lstat(path)
|
||||
return attrs.st_mode & stat.S_IFDIR != 0
|
||||
except IOError:
|
||||
return False
|
||||
|
||||
|
||||
def ssh(*args, **kwargs):
|
||||
warn(
|
||||
'devops.helpers.ssh is deprecated '
|
||||
'and will be removed soon', DeprecationWarning)
|
||||
return SSHClient(*args, **kwargs)
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,265 @@
|
|||
# Copyright 2013 - 2016 Mirantis, Inc.
|
||||
#
|
||||
# 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
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS, 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.
|
||||
|
||||
|
||||
import logging
|
||||
import os
|
||||
import posixpath
|
||||
import stat
|
||||
|
||||
import paramiko
|
||||
|
||||
from devops.error import DevopsCalledProcessError
|
||||
from devops.helpers.retry import retry
|
||||
from devops import logger
|
||||
|
||||
|
||||
class SSHClient(object):
|
||||
class get_sudo(object):
|
||||
def __init__(self, ssh):
|
||||
self.ssh = ssh
|
||||
|
||||
def __enter__(self):
|
||||
self.ssh.sudo_mode = True
|
||||
|
||||
def __exit__(self, exc_type, value, traceback):
|
||||
self.ssh.sudo_mode = False
|
||||
|
||||
def __init__(self, host, port=22, username=None, password=None,
|
||||
private_keys=None):
|
||||
self.host = str(host)
|
||||
self.port = int(port)
|
||||
self.username = username
|
||||
self.password = password
|
||||
if not private_keys:
|
||||
private_keys = []
|
||||
self.private_keys = private_keys
|
||||
|
||||
self.sudo_mode = False
|
||||
self.sudo = self.get_sudo(self)
|
||||
self._ssh = None
|
||||
self.__sftp = None
|
||||
|
||||
self.reconnect()
|
||||
|
||||
@property
|
||||
def _sftp(self):
|
||||
if self.__sftp is not None:
|
||||
return self.__sftp
|
||||
logger.warning('SFTP is not connected, try to reconnect')
|
||||
self._connect_sftp()
|
||||
if self.__sftp is not None:
|
||||
return self.__sftp
|
||||
raise paramiko.SSHException('SFTP connection failed')
|
||||
|
||||
def clear(self):
|
||||
if self.__sftp is not None:
|
||||
try:
|
||||
self.__sftp.close()
|
||||
except Exception:
|
||||
logger.exception("Could not close sftp connection")
|
||||
try:
|
||||
self._ssh.close()
|
||||
except Exception:
|
||||
logger.exception("Could not close ssh connection")
|
||||
|
||||
def __del__(self):
|
||||
self.clear()
|
||||
|
||||
def __enter__(self):
|
||||
return self
|
||||
|
||||
def __exit__(self, *err):
|
||||
self.clear()
|
||||
|
||||
@retry(count=3, delay=3)
|
||||
def connect(self):
|
||||
logging.debug(
|
||||
"Connect to '{0}:{1}' as '{2}:{3}'".format(
|
||||
self.host, self.port, self.username, self.password))
|
||||
for private_key in self.private_keys:
|
||||
try:
|
||||
return self._ssh.connect(
|
||||
self.host, port=self.port, username=self.username,
|
||||
password=self.password, pkey=private_key)
|
||||
except paramiko.AuthenticationException:
|
||||
continue
|
||||
if self.private_keys:
|
||||
logging.error("Authentication with keys failed")
|
||||
|
||||
return self._ssh.connect(
|
||||
self.host, port=self.port, username=self.username,
|
||||
password=self.password)
|
||||
|
||||
def _connect_sftp(self):
|
||||
try:
|
||||
self.__sftp = self._ssh.open_sftp()
|
||||
except paramiko.SSHException:
|
||||
logger.warning('SFTP enable failed! SSH only is accessible.')
|
||||
|
||||
def reconnect(self):
|
||||
self._ssh = paramiko.SSHClient()
|
||||
self._ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
|
||||
self.connect()
|
||||
self._connect_sftp()
|
||||
|
||||
def check_call(self, command, verbose=False):
|
||||
ret = self.execute(command, verbose)
|
||||
if ret['exit_code'] != 0:
|
||||
raise DevopsCalledProcessError(command, ret['exit_code'],
|
||||
ret['stdout'] + ret['stderr'])
|
||||
return ret
|
||||
|
||||
def check_stderr(self, command, verbose=False):
|
||||
ret = self.check_call(command, verbose)
|
||||
if ret['stderr']:
|
||||
raise DevopsCalledProcessError(command, ret['exit_code'],
|
||||
ret['stdout'] + ret['stderr'])
|
||||
return ret
|
||||
|
||||
@classmethod
|
||||
def execute_together(cls, remotes, command):
|
||||
futures = {}
|
||||
errors = {}
|
||||
for remote in remotes:
|
||||
cmd = "%s\n" % command
|
||||
if remote.sudo_mode:
|
||||
cmd = 'sudo -S bash -c "%s"' % cmd.replace('"', '\\"')
|
||||
chan = remote._ssh.get_transport().open_session()
|
||||
chan.exec_command(cmd)
|
||||
futures[remote] = chan
|
||||
for remote, chan in futures.items():
|
||||
ret = chan.recv_exit_status()
|
||||
if ret != 0:
|
||||
errors[remote.host] = ret
|
||||
if errors:
|
||||
raise DevopsCalledProcessError(command, errors)
|
||||
|
||||
def execute(self, command, verbose=False):
|
||||
chan, _, stderr, stdout = self.execute_async(command)
|
||||
result = {
|
||||
'stdout': [],
|
||||
'stderr': [],
|
||||
'exit_code': 0
|
||||
}
|
||||
for line in stdout:
|
||||
result['stdout'].append(line)
|
||||
if verbose:
|
||||
logger.info(line)
|
||||
for line in stderr:
|
||||
result['stderr'].append(line)
|
||||
if verbose:
|
||||
logger.info(line)
|
||||
result['exit_code'] = chan.recv_exit_status()
|
||||
chan.close()
|
||||
return result
|
||||
|
||||
def execute_async(self, command):
|
||||
logging.debug("Executing command: '{}'".format(command.rstrip()))
|
||||
chan = self._ssh.get_transport().open_session()
|
||||
stdin = chan.makefile('wb')
|
||||
stdout = chan.makefile('rb')
|
||||
stderr = chan.makefile_stderr('rb')
|
||||
cmd = "%s\n" % command
|
||||
if self.sudo_mode:
|
||||
cmd = 'sudo -S bash -c "%s"' % cmd.replace('"', '\\"')
|
||||
chan.exec_command(cmd)
|
||||
if stdout.channel.closed is False:
|
||||
stdin.write('%s\n' % self.password)
|
||||
stdin.flush()
|
||||
else:
|
||||
chan.exec_command(cmd)
|
||||
return chan, stdin, stderr, stdout
|
||||
|
||||
def mkdir(self, path):
|
||||
if self.exists(path):
|
||||
return
|
||||
logger.debug("Creating directory: %s", path)
|
||||
self.execute("mkdir -p %s\n" % path)
|
||||
|
||||
def rm_rf(self, path):
|
||||
logger.debug("Removing directory: %s", path)
|
||||
self.execute("rm -rf %s" % path)
|
||||
|
||||
def open(self, path, mode='r'):
|
||||
return self._sftp.open(path, mode)
|
||||
|
||||
def upload(self, source, target):
|
||||
logger.debug("Copying '%s' -> '%s'", source, target)
|
||||
|
||||
if self.isdir(target):
|
||||
target = posixpath.join(target, os.path.basename(source))
|
||||
|
||||
source = os.path.expanduser(source)
|
||||
if not os.path.isdir(source):
|
||||
self._sftp.put(source, target)
|
||||
return
|
||||
|
||||
for rootdir, _, files in os.walk(source):
|
||||
targetdir = os.path.normpath(
|
||||
os.path.join(
|
||||
target,
|
||||
os.path.relpath(rootdir, source))).replace("\\", "/")
|
||||
|
||||
self.mkdir(targetdir)
|
||||
|
||||
for entry in files:
|
||||
local_path = os.path.join(rootdir, entry)
|
||||
remote_path = posixpath.join(targetdir, entry)
|
||||
if self.exists(remote_path):
|
||||
self._sftp.unlink(remote_path)
|
||||
self._sftp.put(local_path, remote_path)
|
||||
|
||||
def download(self, destination, target):
|
||||
logger.debug(
|
||||
"Copying '%s' -> '%s' from remote to local host",
|
||||
destination, target
|
||||
)
|
||||
|
||||
if os.path.isdir(target):
|
||||
target = posixpath.join(target, os.path.basename(destination))
|
||||
|
||||
if not self.isdir(destination):
|
||||
if self.exists(destination):
|
||||
self._sftp.get(destination, target)
|
||||
else:
|
||||
logger.debug(
|
||||
"Can't download %s because it doesn't exist", destination
|
||||
)
|
||||
else:
|
||||
logger.debug(
|
||||
"Can't download %s because it is a directory", destination
|
||||
)
|
||||
return os.path.exists(target)
|
||||
|
||||
def exists(self, path):
|
||||
try:
|
||||
self._sftp.lstat(path)
|
||||
return True
|
||||
except IOError:
|
||||
return False
|
||||
|
||||
def isfile(self, path):
|
||||
try:
|
||||
attrs = self._sftp.lstat(path)
|
||||
return attrs.st_mode & stat.S_IFREG != 0
|
||||
except IOError:
|
||||
return False
|
||||
|
||||
def isdir(self, path):
|
||||
try:
|
||||
attrs = self._sftp.lstat(path)
|
||||
return attrs.st_mode & stat.S_IFDIR != 0
|
||||
except IOError:
|
||||
return False
|
||||
|
|
@ -13,6 +13,7 @@
|
|||
# under the License.
|
||||
|
||||
import time
|
||||
from warnings import warn
|
||||
|
||||
from django.conf import settings
|
||||
from django.db import models
|
||||
|
|
@ -20,8 +21,8 @@ from netaddr import IPNetwork
|
|||
from paramiko import Agent
|
||||
from paramiko import RSAKey
|
||||
|
||||
from devops.helpers.helpers import SSHClient
|
||||
from devops.helpers.network import IpNetworksPool
|
||||
from devops.helpers.ssh_client import SSHClient
|
||||
from devops.helpers.templates import create_devops_config
|
||||
from devops.helpers.templates import get_devops_config
|
||||
from devops import logger
|
||||
|
|
@ -217,6 +218,9 @@ class Environment(BaseModel):
|
|||
Reserved for backward compatibility only.
|
||||
Please use self.create_environment() instead.
|
||||
"""
|
||||
warn(
|
||||
'describe_environment is deprecated in favor of'
|
||||
' create_environment', DeprecationWarning)
|
||||
if settings.DEVOPS_SETTINGS_TEMPLATE:
|
||||
config = get_devops_config(
|
||||
settings.DEVOPS_SETTINGS_TEMPLATE)
|
||||
|
|
@ -314,7 +318,11 @@ class Environment(BaseModel):
|
|||
|
||||
:rtype : SSHClient
|
||||
"""
|
||||
return self.nodes().admin.remote(
|
||||
admin = sorted(
|
||||
list(self.get_nodes(role='fuel_master')),
|
||||
key=lambda node: node.name
|
||||
)[0]
|
||||
return admin.remote(
|
||||
self.admin_net,
|
||||
login=login,
|
||||
password=password)
|
||||
|
|
@ -347,7 +355,11 @@ class Environment(BaseModel):
|
|||
|
||||
# LEGACY, TO REMOVE (for fuel-qa compatibility)
|
||||
def nodes(self): # migrated from EnvironmentModel.nodes()
|
||||
warn(
|
||||
'environment.nodes is deprecated in favor of'
|
||||
' environment.get_nodes', DeprecationWarning)
|
||||
# DEPRECATED. Please use environment.get_nodes() instead.
|
||||
|
||||
class Nodes(object):
|
||||
def __init__(self, environment):
|
||||
self.admins = sorted(
|
||||
|
|
|
|||
|
|
@ -15,10 +15,10 @@
|
|||
from django.db import models
|
||||
from django.utils.functional import cached_property
|
||||
|
||||
from devops.helpers.helpers import SSHClient
|
||||
from devops.helpers.helpers import tcp_ping_
|
||||
from devops.helpers.helpers import wait_pass
|
||||
from devops.helpers import loader
|
||||
from devops.helpers.ssh_client import SSHClient
|
||||
from devops.models.base import BaseModel
|
||||
from devops.models.base import ParamedModel
|
||||
from devops.models.network import Interface
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
|
||||
from netaddr import IPNetwork
|
||||
|
||||
from devops.helpers.helpers import SSHClient
|
||||
from devops.helpers.ssh_client import SSHClient
|
||||
from devops.models import DiskDevice
|
||||
from devops.models import Environment
|
||||
from devops.models import Interface
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
|
||||
from netaddr import IPNetwork
|
||||
|
||||
from devops.helpers.helpers import SSHClient
|
||||
from devops.helpers.ssh_client import SSHClient
|
||||
from devops.models import DiskDevice
|
||||
from devops.models import Environment
|
||||
from devops.models import Interface
|
||||
|
|
|
|||
Loading…
Reference in New Issue