3
ܓi A @ sZ d dl Z d dlZd dlZd dlmZ d dlZd dlmZmZ d dl m
Z
G dd dZ dS ) N)quote)ConnectionExceptionCommandTimeoutException)boldc @ s
e Zd ZdZdZdZdd Zdd Zdd Zd
d Z d d
Z
e dd Z e dd Z
e dd Zedd Zedd Zdd Zdd Zd d Zd d Zd d! Ze d"d# Zd=d'd(Zd)d* Zd+d, Zd-d. Zd/d0 Z d1d2 Z d3d4 Z d5d6 Z d7d8 Z d9d: Z!d;d< Z"dS )>RemoteTransportaO The base class used for defining supported remote transports to connect
to remote nodes in conjunction with `sos collect`.
This abstraction is used to manage the backend connections to nodes so that
SoSNode() objects can be leveraged generically to connect to nodes, inspect
those nodes, and run commands on them.
Z undefinedNc C sF || _ |d | _|d | _|d | _d | _tjd| _tjd| _d S )NZ cmdlineoptstmpdir need_sudoZsosZsos_ui) addressoptsr r _hostnameloggingZ getLoggersoslogZui_log)selfr Zcommons r /usr/lib/python3.6/__init__.py__init__# s
zRemoteTransport.__init__c C s d}t j|d|S )zUAttempts to obfuscate sensitive information in log messages such as
passwordsz>(?P(pass|key|secret|PASS|KEY|SECRET).*?=)(?P.*?\s)z\g****** )resub)r msgZregr r r _sanitize_log_msg, s z!RemoteTransport._sanitize_log_msgc C s8 t j d d }d| j d| d| }| jj| dS )z#Used to print and log info messages [:z] N)inspectstackhostnamer
info)r r callerlmsgr r r log_info2 s zRemoteTransport.log_infoc C s8 t j d d }d| j d| d| }| jj| dS )z$Used to print and log error messagesr r r r z] N)r r r r
error)r r r r r r r log_error8 s zRemoteTransport.log_errorc C sB | j |}tj d d }d| j d| d| }| jj| dS )z$Used to print and log debug messagesr r r r z] N)r r r r r
debug)r r r r r r log_debug> s
zRemoteTransport.log_debugc C s | j rd| j kr| j S | jS )NZ localhost)r r )r r r r r E s zRemoteTransport.hostnamec C s dS )zIs the transport __currently__ connected to the node, or otherwise
capable of seamlessly running a command or similar on the node?
Fr )r r r r connectedK s zRemoteTransport.connectedc C s dS )a This is the command string needed to leverage the remote transport
when executing commands. For example, for an SSH transport this would
be the `ssh ` string prepended to any command so that the
command is executed by the ssh binary.
This is also referenced by the `remote_exec` parameter for policies
when loading a policy for a remote node
Nr )r r r r remote_execR s
zRemoteTransport.remote_execc C s^ | t kr| j|S |j| jj jdd d | jrP| jt jk rP|j| j n
|jd d S )N_ z Transport Detailed Helpz5Detailed information not available for this transport)r display_self_help set_titlenametitlereplace__doc__add_text)clssectionr r r display_help^ s
z RemoteTransport.display_helpc C s |j d |jdtd d |jdtd d |jd d d
lm} xJ|D ]B}td | }d |j d
}|jdd|d|ddd qRW d S )NzSoS Remote Transport Helpzb
Transports define how SoS connects to nodes and executes commands on them for the purposes of an z sos collectz run. Generally, this means transports define how commands are wrapped locally so that they are executed on the remote node(s) instead.zTransports are generally selected by the cluster profile loaded for a given execution, however users may explicitly set one using 'z--transport=$transport_namezI'. Note that not all transports will function for all cluster/node types.zBy default, OpenSSH Control Persist is attempted. Additional information for each supported transport is available in the following help sections:
r )
TRANSPORTSzcollect.transports.zThe 'z ' transportr( z>8z<45z<30F)newline)r* r/ r Zsos.collector.sosnoder3 lower)r0 r1 r3 Z transportZ_secZ_descr r r r) l s
z!RemoteTransport.display_self_helpc C s | j |r | js| j dS dS )zPerform the connection steps in order to ensure that we are able to
connect to the node for all future operations. Note that this should
not provide an interactive shell at this time.
TF)_connectr
_get_hostname)r passwordr r r connect s
zRemoteTransport.connectc C s t d| j ddS )zActually perform the connection requirements. Should be overridden
by specific transports that subclass RemoteTransport
z
Transport z does not define connectN)NotImplementedErrorr+ )r r8 r r r r6 s zRemoteTransport._connectc C s d}d}xv|dk r~| j d| d y| j|r4dS W n< tk
rr } z | j d| d| |}W Y d d }~X nX |d7 }q
W | jd
td | d S ) zAttempts to reconnect to the node using the standard connect()
but does not do so indefinitely. This imposes a strict number of retry
attempts before failing out
r unknown zAttempting reconnect (#z ) to nodeTz Attempt #z exception: Nz7Unable to reconnect to node after 5 attempts, aborting.z last exception from transport: )r$ r9 Exceptionr" r )r r8 attemptsZlast_errerrr r r reconnect s
zRemoteTransport.reconnectc C sZ y"| j r| jd n
| jd W n2 tk
rT } z| jd| W Y dd}~X nX dS )zfPerform whatever steps are necessary, if any, to terminate any
connection to the node
z#Successfully disconnected from nodez;Unable to successfully disconnect, see log for more detailszFailed to disconnect: N) _disconnectr$ r" r= )r r? r r r
disconnect s zRemoteTransport.disconnectc C s t d| j dd S )Nz
Transport z does not define disconnect)r: r+ )r r r r rA s zRemoteTransport._disconnectc C s dS )z
Transports may override this to control when/if commands executed over
the transport needs to utilize a shell on the remote host.
Fr )r r r r _need_shell s zRemoteTransport._need_shell Fautoc C sX | j d| |dks*|dkr&| jndrHdt| }| j d| | j||||S )a Run a command on the node, returning its output and exit code.
This should return the exit code of the command being executed, not the
exit code of whatever mechanism the transport uses to execute that
command
:param cmd: The command to run
:type cmd: ``str``
:param timeout: The maximum time in seconds to allow the cmd to run
:type timeout: ``int```
:param need_root: Does ``cmd`` require root privileges?
:type need_root: ``bool``
:param env: Specify env vars to be passed to the ``cmd``
:type env: ``dict``
:param use_shell: Does ``cmd`` require execution within a shell?
:type use_shell: ``bool`` or ``auto`` for transport-determined
:returns: Output of ``cmd`` and the exit code
:rtype: ``dict`` with keys ``output`` and ``status``
zRunning command TrE Fz
/bin/bash -c z Shell requested, command is now )r$ rC r _run_command_with_pexpect)r cmdtimeout need_rootenvZ use_shellr r r run_command s zRemoteTransport.run_commandc C s | j dt| }|j }|S )a Format the command in the way needed for the remote transport to
successfully execute it as one would when manually executing it
:param cmd: The command being executed, as formatted by SoSNode
:type cmd: ``str``
:returns: The command further formatted as needed by this
transport
:rtype: ``str``
r( )r& r lstrip)r rG r r r _format_cmd_for_exec s z$RemoteTransport._format_cmd_for_execc
C s
| j |}|sd}ytj|d|d}W n6 tjjk
r\ } z| j|j dddS d}~X nX tjtjg}|r| j j
dkr|j dd g |j ||d
}|dkr| j
|| |j ||d
}|d
kr|j} |j |j| dS |dkrt|| jd| d| dddS )a Execute the command using pexpect, which allows us to more easily
handle prompts and timeouts compared to directly leveraging the
subprocess.Popen() method.
:param cmd: The command to execute. This will be automatically
formatted to use the transport.
:type cmd: ``str``
:param timeout: The maximum time in seconds to run ``cmd``
:type timeout: ``int``
:param need_root: Does ``cmd`` need to run as root or with sudo?
:type need_root: ``bool``
:param env: Any env vars that ``cmd`` should be run with
:type env: ``dict``
Nzutf-8)encodingrJ )statusoutputrootz\[sudo\] password for .*:z Password:)rH r r r zUnexpected index z from pexpect: i )rT r )rM pexpectZspawn
exceptionsZExceptionPexpectr$ valueZEOFZTIMEOUTr
Zssh_userextendexpect_send_pexpect_passwordZbeforecloseZ
exitstatusr )
r rG rH rI rJ resultr? Z_expectsindexoutr r r rF s2
z)RemoteTransport._run_command_with_pexpectc C sz |dkrB| j j r2| j j r2d}| j| t||j| j j n4|dkrv| j jshd}| j| t||j| j j dS )a` Handle password prompts for sudo and su usage for non-root SSH users
:param index: The index pexpect.spawn returned to match against
either a sudo or su prompt
:type index: ``int``
:param result: The spawn running the command
:type result: ``pexpect.spawn``
rT z>Unable to run command: sudo password required but not providedr z5Unable to run command as root: no root password givenN)r
Zsudo_pwZ
nopasswd_sudor" r= ZsendlineZ
root_password)r r] r\ r r r r rZ ; s
z&RemoteTransport._send_pexpect_passwordc C sJ | j d}|d dkr$|d j | _| js2| j| _| jd| j | jS )zDetermine the hostname of the node and set that for future reference
and logging
:returns: The hostname of the system, per the `hostname` command
:rtype: ``str``
r rQ r rR zHostname set to )rK stripr r r )r Z_outr r r r7 S s
z RemoteTransport._get_hostnamec C s d}yJx:|dk r@|d7 }| j ||}|r,dS | jd| d qW | jd dS tk
r } z&| jd | d
| d | |W Y d d }~X nX d S )
aZ Copy a local file, fname, to dest on the remote node
:param fname: The name of the file to copy
:type fname: ``str``
:param dest: Where to save the file to remotely
:type dest: ``str``
:returns: True if file was successfully copied to remote, or False
:rtype: ``bool``
r r r TzFile copy attempt z failedz!File copy failed after 3 attemptsFz1Exception encountered during config copy attempt z for z: N)_copy_file_to_remoter r= r" )r fnamedestr> retr? r r r copy_file_to_remotec s
z#RemoteTransport.copy_file_to_remotec C s t d| j dd S )Nz
Transport z does not support file copying)r: r+ )r ra rb r r r r` ~ s z$RemoteTransport._copy_file_to_remotec C s d}yJx:|dk r@|d7 }| j ||}|r,dS | jd| d qW | jd dS tk
r } z&| jd | d
| d | |W Y d d }~X nX d S )
a_ Copy a remote file, fname, to dest on the local node
:param fname: The name of the file to retrieve
:type fname: ``str``
:param dest: Where to save the file to locally
:type dest: ``str``
:returns: True if file was successfully copied from remote, or False
:rtype: ``bool``
r r< r TzFile retrieval attempt z failedz&File retrieval failed after 5 attemptsFz/Exception encountered during retrieval attempt z for z: N)_retrieve_filer r= r" )r ra rb r> rc r? r r r
retrieve_file s
z RemoteTransport.retrieve_filec C s t d| j dd S )Nz
Transport z does not support file copying)r: r+ )r ra rb r r r re s z RemoteTransport._retrieve_filec C s | j d| | j|S )zRead the given file fname and return its contents
:param fname: The name of the file to read
:type fname: ``str``
:returns: The content of the file
:rtype: ``str``
z
Reading file )r$
_read_file)r ra r r r read_file s zRemoteTransport.read_filec C st | j d| dd}|d dkr(|d S d|d krH| jd| d n(| jd
| d |d jd d
d dS )Nzcat
)rH rQ r rR z No such filezFile z does not exist on nodezError reading z: r r rP )rK r$ r" split)r ra resr r r rg s (zRemoteTransport._read_file)rD FNrE )#__name__
__module__ __qualname__r. r+ Z default_userr r r r" r$ propertyr r% r& classmethodr2 r) r9 r6 r@ rB rA rC rK rM rF rZ r7 rd r` rf re rh rg r r r r r s> !
%9 r ) r r r Zshlexr rU Zsos.collector.exceptionsr r Z
sos.utilitiesr r r r r r s