3
ܓiR @ s d dl Z d dlZd dlZd dlZd dlZd dlZd dlmZ d dlm Z d dl
m
Z
d dl m Z d dl m
Z
d dlmZ d dlmZ d d lmZ d d
lmZ d d lmZmZ G d d
d
ZG dd dZdS ) N)fill)SUPPRESS)datetime)getpass)rmtree)Path) __version__)TarFileArchive)
SoSOptions) TempFileUtil shell_outc
@ s e Zd ZdZdZi ZdZdZdZdZ dddddddddd dd
d Z
d d
dddgZ dd Z dd Z
dd Zdd Zd9ddZdd Zd d Zed d Zd!d" Zd#d$ Zd%d& Zd'd( Zd)d* Zd:d+d,Zd-d. Zd/d0 Z d1d2 Z d3d4 Z d5d6 Z d7d8 Z dS ); SoSComponenta Any sub-command that sos supports needs to subclass SoSComponent in
order to be properly supported by the sos binary.
This class contains the standardized entrypoint for subcommands, as well as
building out supported options from both globally shared option lists, and
options supported by that specific subcommand.
When sos initializes, it will load an unintialized instance of each class
found within one recursion of the module root directory that subclasses
SoSComponent.
If sos is able to match the user-specified subcommand to one that exists
locally, then that SoSComponent is initialized, logging is setup, and a
policy is loaded. From there, the component's execute() method takes over.
Added in 4.0
ZunsetTFautoz/etc/sos/sos.confN r ) batchcompression_type config_filedebugencrypt encrypt_key encrypt_passquietthreadstmp_dirsysroot verbosityzsos_logs/sos.logzsos_reports/manifest.jsonzsos_commands/process/ps_*zsos_commands/selinux/ps_*z+sos_commands/systemd/systemctl_status_--allc C s || _ || _|| _d| _d | _d | _d | _d | _y dd l}|j|j | j
W n6 t k
r } zt j
jd| d W Y d d }~X nX t| jd| _| jr| j | jj| j | j | _| jrH| j }t | _tjj | stj |tj r d| d}|d7 }t j j| | j d || _!t"j#d
| j!d | _t$| j| _| j% | jd k r| jj&d t' | jj&d
dj(| j | jj&dt)j* | jj&dd | jj&dd | jj&dd | jj&d| j | jj&d| j+ | jj&d| j,j- | jj.d d S )NFr z'Notice: Could not set SIGTERM handler:
) arg_defaultsztemporary directory z"does not exist or is not writable
zsos.)prefixdirversioncmdlineZ
start_timeZend_timer Zrun_timeZ compressiontmpdirZtmpdir_fs_typepolicyZ
components)/parserargsr$ exit_processarchiver%
tempfile_utilmanifestsignalSIGTERMget_exit_handler Exceptionsysstdoutwriter
_arg_defaultsopts load_policyload_local_policyupdater load_optionsconfigure_loggingget_tmpdir_default SoSMetadataospathisdiraccessW_OKstderr_exitZsys_tmptempfileZmkdtempr _setup_logging add_fieldr joinr Znow tmpfstyper& Zos_release_name add_section)selfr' Z parsed_argsZ cmdline_argsr- errr% msg rM /usr/lib/python3.6/component.py__init__R sT &
zSoSComponent.__init__c C s^ y.dd l }|jj| jj| jd| _| jj| _W n tk
rL | jd Y nX | jj | _
d S )Nr )r Z
probe_runtime) Z sos.policiesZpoliciesloadr5 r
load_prober& KeyboardInterruptrC Zis_rootZ_is_root)rJ sosrM rM rN r7 s z SoSComponent.load_local_policyc C s t d S )N)NotImplementedError)rJ rM rM rN execute s zSoSComponent.executec s fdd}|S )Nc s d _ j d S )NT)r) rC )Zsignumframe)rJ rM rN exit_handler s z3SoSComponent.get_exit_handler..exit_handlerrM )rJ rW rM )rJ rN r/ s z SoSComponent.get_exit_handlerc C s( |r | j jd | j j| t|d S )Nr )ui_logerror
SystemExit)rJ rY rL rM rM rN rC s zSoSComponent._exitc C sf | j jrtjj| j j}ntjddp0| jjd}td| j | _
| j
dkrbt d t j
d |S )zIf --tmp-dir is not specified, provide a default location.
Normally this is /var/tmp, but if we detect we are in a container, then
use a standardized env var to redirect to the host's filesystem instead
ZTMPDIRNz stat --file-system --format=%T ZtmpfszWARNING: tmp-dir is set to a tmpfs filesystem. This may increase memory pressure and cause instability on low memory systems, or when using --all-logs. )r5 r r= r> abspathgetenvr& Z get_tmp_dirr striprH printtimeZsleep)rJ r% rM rM rN r; s
z SoSComponent.get_tmpdir_defaultc s6 dd j j j D }|r2t fdd|D S dS )Nc S s g | ]}|j d r|qS )list)
startswith).0orM rM rN
s z6SoSComponent.check_listing_options..c 3 s | ]}t j|V qd S )N)getattrr5 )rc opt)rJ rM rN s z5SoSComponent.check_listing_options..F)r5 dictkeysany)rJ r5 rM )rJ rN check_listing_options s z"SoSComponent.check_listing_optionsc C s t dS )ziThis should be overridden by each subcommand to add its own unique
options to the parser
N)rT )clsr' rM rM rN add_parser_options s z SoSComponent.add_parser_optionsc
sZ t j| jj| j|jddd}|jdd}x$|j D ]\}}||jj ks:|dg dgkrbq:|dkrxFdD ]>}t |t t
||@ rpt || fd d
t
||D qpW |d kr8t
||}d d
|D }d
d
|D } x6t |t | @ D ]" dfdd
|D } qW t ||t t |t |B q:||j| kr:t ||| q:W |S )a. (Re-)apply options specified via the cmdline to an options instance
There are several cases where we may need to re-apply the options from
the cmdline over previously loaded options - for instance when an
option is specified in both a config file and cmdline, or a preset and
the cmdline, or all three.
Use this to re-apply cmdline option overrides to anything that may
change the default values of options
Positional arguments:
:param opts: SoSOptions object to update
F)Z
preset_filter)r Nr enable_plugins skip_plugins only_pluginsc s g | ]}| kr|qS rM rM )rc x)commonrM rN re s z;SoSComponent.apply_options_from_cmdline..Zplugoptsc S s g | ]}|j d d qS )=r )split)rc vrM rM rN re s c S s g | ]}|j d d qS )rt r )ru )rc rv rM rM rN re s rt c s g | ]}|j s|qS rM )rb )rc oopt)cstringrM rN re s )ro rp rq )ro rp rq )
r
Z from_argsr'
parse_argsr$ ri itemsr rj setrf setattrra )
rJ r5 ZcmdoptsZcodictrg valrw Z oplugoptsZvalnamesZ ovalnamesrM )rs rx rN apply_options_from_cmdline s.
$
z'SoSComponent.apply_options_from_cmdlinec C sr t | jd}x | jjD ]}|jtkrd|_qW |j| jj| jj d| j
ksVd| j
krf|j| jjd t j dkrt j
jtj d}t j
j|r|j|| jj | j|}d| _t|drn|j| jd kr| jj|j| _| jstjjd |j d
| jj | _d |_| js"| jj | _|j | jj d d | j|}t| jj d
rn| jj j dkrn| j | jj j |S )zxCompile arguments loaded from defaults, config files, and the
command line into a usable set of options
)r Nz--cleanz--maskcleanr z.config/sos/sos.confpresetzUnknown preset: 'z'
T)Z
prefer_newr ) r
r4 r' Z_actionsdefaultr Zupdate_from_confr( r Z componentr$ r= getuidr> rG r homeexistsr~ r hasattrr& Z find_presetr1 rB r3 Z probe_presetZ list_presetsmerger5 r set_loggers_verbosity)rJ r5 ZoptionZuserconfrM rM rN r9 s8
zSoSComponent.load_optionsc C sr y4| j r| j j | jr"| jj | jr2t| j W n8 tk
rl } z td| d| j W Y d d }~X nX d S )NzFailed to finish cleanup: z
Contents may remain in )r* cleanupr+ r r% r r0 r_ )rJ rK rM rM rN r 9 s
zSoSComponent.cleanupc C sb d}t jjdr&t jjd| j_d}n t jjdrFt jjd| j_d}| jj| | jj| d S )NzFNo encryption environment variables set, archive will not be encryptedZ
SOSENCRYPTKEYz+Encryption key set via environment variableZSOSENCRYPTPASSz2Encryption passphrase set via environment variable) r= environgetr5 r r sosloginforX )rJ rL rM rM rN _set_encrypt_from_env_varsG s z'SoSComponent._set_encrypt_from_env_varsc C s | j jsd }x|d
kr$tdj }qW |dkr| jj }tjj | j
|}| j j dkr| jj }||| j
| j| j j
|| j| j| _n"t|| j
| j| j j
|| j| j| _| jj| j jdk d S )N)r keyZpasswordr r[ )r5 r r r r r& Zget_archive_namer= r> rG r% r Zget_preferred_archiver r r, r* r Z set_debugr )rJ nameZenc_optsZ archive_nameZ auto_archiverM rM rN
setup_archivek s&
zSoSComponent.setup_archivec C sb | j j }xR| jD ]H}xBt|j|D ]0}tjj||}x dD ]}| j j||d q>W q&W qW d S )N(--upload-pass[\s=]+)\S+$(--upload-url[\s=]+\S+://.*:)([^@]*)!(--upload-s3-secret-key[\s=]+)\S+z
\1********)r r r ) r* Zget_archive_pathfiles_with_upload_passwdr Zglobr= r> relpathZ do_file_sub)rJ Z _arc_pathr> frerM rM rN _obfuscate_upload_passwords s
z(SoSComponent._obfuscate_upload_passwordsc C sJ t jtj}|jt jd |j| jjdkr2t j nt j
| j j | d S )Nz %(message)sr )
logging
StreamHandlerr1 r2 setFormatter FormattersetLevelr5 r DEBUGINFOrX
addHandler)rJ Z
ui_consolerM rM rN add_ui_log_to_stdout s
z!SoSComponent.add_ui_log_to_stdoutc C s\ t | dd r |r | jjtj t | dd rX|rJ| jjdkrJ| jjtj n| jjtj d S )Nflogconsoler ) rf r r r r r5 r r ZWARNING)rJ r rM rM rN r s z"SoSComponent.set_loggers_verbosityc C sh t jd| _| jjt j d| _| j sn| j | _t j | j| _| jj
t j d | jjt j | jj
| j | jjst j tj| _| jj
t j d | j| jj | jj
| j n4t j tj}|j
t j d |jt j | jj
| t jd| _| jj| jjdkrt jnt j | j sR| j | _t j | j}|j
t j d | jj
| | jjsd| j dS )zCreates the log handler that shall be used by all components and any
and all related bits to those components that need to log either to the
console or to the log file for that run of sos.
rS Nz&%(asctime)s %(levelname)s: %(message)sz %(message)sZsos_uir )r Z getLoggerr r r r rl
get_temp_fileZ sos_log_filer r r r r r5 r r1 r2 r r r rB ZERRORrX Zsos_ui_log_filer )rJ Z console_errZ ui_fhandlerrM rM rN rE s<
zSoSComponent._setup_loggingc C s
| j j S )N)r+ new)rJ rM rM rN r s zSoSComponent.get_temp_filec C s4 d}d}x&|j D ]}|t||dd d }qW |S )NP r F)Zreplace_whitespacer )
splitlinesr )rJ rL widthZ_fmtlinerM rM rN _fmt_msg s
zSoSComponent._fmt_msg)r N)r )!__name__
__module__ __qualname____doc__Zdescr r: r6 rQ Z
root_requiredr4 r rO r7 rU r/ rC r; rl classmethodrn r~ r9 r r r r r r r rE r r rM rM rM rN r
sX 8
<3
.r
c @ sV e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z g fddZ
dddZ dS )r< a8 This class is used to record metadata from a sos execution that will
then be stored as a JSON-formatted manifest within the final tarball.
It can be extended by adding further instances of SoSMetadata to represent
dict-like structures throughout the various sos bits that record to
metadata
c C s
i | _ d S )N)_values)rJ rM rM rN rO s zSoSMetadata.__init__c c s" x | j j D ]}|d V q W d S )Nr )r rz )rJ itemrM rM rN __iter__ s zSoSMetadata.__iter__c C s
| j | S )N)r )rJ r rM rM rN __getitem__ s zSoSMetadata.__getitem__c C s
| j | S )N)r )rJ attrrM rM rN __getattr__ s zSoSMetadata.__getattr__c C s || j |< dS )z@Add a key, value entry to the current metadata instance
N)r )rJ Z
field_namecontentrM rM rN rF s zSoSMetadata.add_fieldc C s t | j|< | j| S )zCAdds a new instance of SoSMetadata to the current instance
)r< r )rJ Z section_namerM rM rN rI s zSoSMetadata.add_sectionc C s t |tstd|| j|< dS )zAdd a named list element to the current instance. If content is not
supplied, then add an empty list that can alter be appended to
zcontent added must be listN)
isinstancera TypeErrorr )rJ Z list_namer rM rM rN add_list s
zSoSMetadata.add_listNc C s t j| dd |dS )zConvert contents of this SoSMetdata instance, and all other nested
instances (sections), into a json-formatted output.
Used to write manifest.json to the final archives.
c S s t | dt| S )Nr )rf str)rd rM rM rN s z&SoSMetadata.get_json..)r indent)jsondumps)rJ r rM rM rN get_json s zSoSMetadata.get_json)N) r r r r rO r r r rF rI r r rM rM rM rN r< s r< )r r r= rD r1 r` textwrapr argparser r r Zshutilr Zpathlibr rS r Z sos.archiver Z sos.optionsr
Z
sos.utilitiesr r r
r< rM rM rM rN s( D