| from io import StringIO |
| import logging |
| import select |
| import utils |
| import paramiko |
| import time |
| import os |
| |
| logger = logging.getLogger(__name__) |
| |
| # Suppress paramiko logging |
| logging.getLogger("paramiko").setLevel(logging.WARNING) |
| |
| |
| class SSHTransport(object): |
| def __init__(self, address, username, password=None, |
| private_key=None, look_for_keys=False, *args, **kwargs): |
| |
| self.address = address |
| self.username = username |
| self.password = password |
| if private_key is not None: |
| self.private_key = paramiko.RSAKey.from_private_key( |
| StringIO(private_key)) |
| else: |
| self.private_key = None |
| |
| self.look_for_keys = look_for_keys |
| self.buf_size = 1024 |
| self.channel_timeout = 10.0 |
| |
| def _get_ssh_connection(self): |
| ssh = paramiko.SSHClient() |
| ssh.set_missing_host_key_policy( |
| paramiko.AutoAddPolicy()) |
| ssh.connect(self.address, username=self.username, |
| password=self.password, pkey=self.private_key, |
| timeout=self.channel_timeout) |
| logger.debug("Successfully connected to: {0}".format(self.address)) |
| return ssh |
| |
| def _get_sftp_connection(self): |
| transport = paramiko.Transport((self.address, 22)) |
| transport.connect(username=self.username, |
| password=self.password, |
| pkey=self.private_key) |
| |
| return paramiko.SFTPClient.from_transport(transport) |
| |
| def exec_sync(self, cmd): |
| logger.debug("Executing {0} on host {1}".format(cmd, self.address)) |
| ssh = self._get_ssh_connection() |
| transport = ssh.get_transport() |
| channel = transport.open_session() |
| channel.fileno() |
| channel.exec_command(cmd) |
| channel.shutdown_write() |
| out_data = [] |
| err_data = [] |
| poll = select.poll() |
| poll.register(channel, select.POLLIN) |
| |
| while True: |
| ready = poll.poll(self.channel_timeout) |
| if not any(ready): |
| continue |
| if not ready[0]: |
| continue |
| out_chunk = err_chunk = None |
| if channel.recv_ready(): |
| out_chunk = channel.recv(self.buf_size) |
| out_data += out_chunk, |
| if channel.recv_stderr_ready(): |
| err_chunk = channel.recv_stderr(self.buf_size) |
| err_data += err_chunk, |
| if channel.closed and not err_chunk and not out_chunk: |
| break |
| exit_status = channel.recv_exit_status() |
| logger.debug("Command {0} executed with status: {1}" |
| .format(cmd, exit_status)) |
| return (exit_status, b" ".join(out_data).strip(), |
| b" ".join(err_data).strip()) |
| |
| def exec_command(self, cmd): |
| exit_status, stdout, stderr = self.exec_sync(cmd) |
| return stdout |
| |
| def check_call(self, command, error_info=None, expected=None, |
| raise_on_err=True): |
| """Execute command and check for return code |
| :type command: str |
| :type error_info: str |
| :type expected: list |
| :type raise_on_err: bool |
| :rtype: ExecResult |
| :raises: DevopsCalledProcessError |
| """ |
| if expected is None: |
| expected = [0] |
| ret = self.exec_sync(command) |
| exit_code, stdout_str, stderr_str = ret |
| if exit_code not in expected: |
| message = ( |
| "{append}Command '{cmd}' returned exit code {code} while " |
| "expected {expected}\n" |
| "\tSTDOUT:\n" |
| "{stdout}" |
| "\n\tSTDERR:\n" |
| "{stderr}".format( |
| append=error_info + '\n' if error_info else '', |
| cmd=command, |
| code=exit_code, |
| expected=expected, |
| stdout=stdout_str, |
| stderr=stderr_str |
| )) |
| logger.error(message) |
| if raise_on_err: |
| exit() |
| return ret |
| |
| def put_file(self, source_path, destination_path): |
| sftp = self._get_sftp_connection() |
| sftp.put(source_path, destination_path) |
| sftp.close() |
| |
| def put_iperf3_deb_packages_at_vms(self, source_directory, |
| destination_directory): |
| iperf_deb_files = [f for f in os.listdir(source_directory) |
| if "deb" in f] |
| if not iperf_deb_files: |
| raise BaseException( |
| "iperf3 *.deb packages are not found locally at path {}. " |
| "Please recheck 'iperf_deb_package_dir_path' variable in " |
| "global_config.yaml and check *.deb packages are manually " |
| "copied there.".format(source_directory)) |
| for f in iperf_deb_files: |
| source_abs_path = "{}/{}".format(source_directory, f) |
| dest_abs_path = "{}/{}".format(destination_directory, f) |
| self.put_file(source_abs_path, dest_abs_path) |
| |
| def get_file(self, source_path, destination_path): |
| sftp = self._get_sftp_connection() |
| sftp.get(source_path, destination_path) |
| sftp.close() |
| |
| def _is_timed_out(self, start_time, timeout): |
| return (time.time() - timeout) > start_time |
| |
| def check_vm_is_reachable_ssh(self, floating_ip, timeout=500, sleep=5): |
| bsleep = sleep |
| ssh = paramiko.SSHClient() |
| ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy()) |
| _start_time = time.time() |
| attempts = 0 |
| while True: |
| try: |
| ssh.connect(floating_ip, username=self.username, |
| password=self.password, pkey=self.private_key, |
| timeout=self.channel_timeout) |
| logger.info("VM with FIP {} is reachable via SSH. Success!" |
| "".format(floating_ip)) |
| return True |
| except Exception as e: |
| ssh.close() |
| if self._is_timed_out(_start_time, timeout): |
| logger.info("VM with FIP {} is not reachable via SSH. " |
| "See details: {}".format(floating_ip, e)) |
| raise TimeoutError( |
| "\nFailed to establish authenticated ssh connection " |
| "to {} after {} attempts during {} seconds.\n{}" |
| "".format(floating_ip, attempts, timeout, e)) |
| attempts += 1 |
| logger.info("Failed to establish authenticated ssh connection " |
| "to {}. Number attempts: {}. Retry after {} " |
| "seconds.".format(floating_ip, attempts, bsleep)) |
| time.sleep(bsleep) |
| |
| |
| class prepare_iperf(object): |
| |
| def __init__(self, fip, user='ubuntu', password='password', |
| private_key=None): |
| |
| transport = SSHTransport(fip, user, password, private_key) |
| config = utils.get_configuration() |
| |
| # Install iperf3 using apt or downloaded deb package |
| internet_at_vms = utils.get_configuration().get("internet_at_vms") |
| if internet_at_vms.lower() == 'false': |
| logger.info("Copying offline iperf3 deb packages, installing...") |
| path_to_iperf_deb = (config.get('iperf_deb_package_dir_path') or |
| "/artifacts/mos-spt/") |
| home_ubuntu = "/home/ubuntu/" |
| transport.put_iperf3_deb_packages_at_vms(path_to_iperf_deb, |
| home_ubuntu) |
| transport.exec_command('sudo dpkg -i {}*.deb'.format(home_ubuntu)) |
| else: |
| logger.info("Installing iperf3 using apt") |
| preparation_cmd = config.get('iperf_prep_string') or [''] |
| transport.exec_command(preparation_cmd) |
| transport.exec_command('sudo apt-get update;' |
| 'sudo apt-get install -y iperf3') |
| |
| # Log whether iperf is installed with version |
| check = transport.exec_command('dpkg -l | grep iperf3') |
| logger.debug(check.decode('utf-8')) |
| |
| # Staring iperf server |
| transport.exec_command('nohup iperf3 -s > file 2>&1 &') |