/usr/lib/python3/dist-packages/sos/__pycache__
Edit: /usr/lib/python3/dist-packages/sos/__pycache__/component.cpython-310.pyc (16128B)
o
G%@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
g d Z d
d Z dd Z
dd Zdd Zd5ddZdd Zdd Zedd Zd d Zd d Zd!d" Zd#d$ Zd%d& Zd6d'd(Zd)d* Zd+d, Z d-d. Z d/d0 Z d1d2 Z d3d4 Z dS )7 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
unsetTFautoz/etc/sos/sos.confN r ) batchcompression_type config_filedebugencrypt encrypt_key encrypt_passquietthreadstmp_dirsysroot verbosity)zsos_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 | _zdd l}||j |
W n t yC } zt j
d| d W Y d }~nd }~ww t| jd| _| jrR| | j| j | | _| jr| }t | _tj |rvt |tj sd| d}|d7 }t j | | d || _!t"j#d
| j!d | _t$| j| _| % | jd ur| j&d t' | j&d
d(| j | j&dt)* | j&dd | j&dd | j&dd | j&d| j | j&d| j+ | j&d| j,j- | j.d d S d S )NFr z'Notice: Could not set SIGTERM handler:
arg_defaultsztemporary directory z"does not exist or is not writable
zsos.)prefixdirversioncmdline
start_timeend_timer run_time compressiontmpdirtmpdir_fs_typepolicy
components)/parserargsr& exit_processarchiver+
tempfile_utilmanifestsignalSIGTERMget_exit_handler Exceptionsysstdoutwriter
_arg_defaultsopts load_policyload_local_policyupdater load_optionsconfigure_loggingget_tmpdir_default SoSMetadataospathisdiraccessW_OKstderr_exitsys_tmptempfilemkdtempr _setup_logging add_fieldr joinr now tmpfstyper- os_release_name add_section)selfr/ parsed_args cmdline_argsr5 errr+ msg r[ //usr/lib/python3/dist-packages/sos/component.py__init__R s\
zSoSComponent.__init__c C s\ zdd l }|jj| jj| jd| _| jj| _W n ty% | d Y nw | j | _
d S )Nr )r
probe_runtime) sos.policiespoliciesloadr= r
load_prober- KeyboardInterruptrK is_root_is_root)rV sosr[ r[ r\ r? s z SoSComponent.load_local_policyc C t NNotImplementedErrorrV r[ r[ r\ execute s zSoSComponent.executec s fdd}|S )Nc s d _ d S )NT)r1 rK )signumframerk r[ r\ exit_handler s z3SoSComponent.get_exit_handler.
.exit_handlerr[ )rV ro r[ rk r\ r7 s z SoSComponent.get_exit_handlerc C s$ |r| j d | j | t|)Nr )ui_logerror
SystemExit)rV rq rZ r[ r[ r\ rK s zSoSComponent._exitc C sf | j jr
tj| j j}n tddp| jd}td| | _
| j
dkr1t d t
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
TMPDIRNz stat --file-system --format=%T tmpfszWARNING: 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. )r= r rE rF abspathgetenvr- get_tmp_dirr striprS printtimesleep)rV r+ r[ r[ r\ rC s
z SoSComponent.get_tmpdir_defaultc s6 dd j D }|rt fdd|D S dS )Nc S s g | ] }| d r|qS )list
startswith).0or[ r[ r\
z6SoSComponent.check_listing_options..c 3 s | ] }t j|V qd S rh )getattrr= )r optrk r[ r\ s z5SoSComponent.check_listing_options..F)r= dictkeysany)rV r= r[ rk r\ check_listing_options s z"SoSComponent.check_listing_optionsc C rg )ziThis should be overridden by each subcommand to add its own unique
options to the parser
ri )clsr/ r[ r[ r\ add_parser_options s z SoSComponent.add_parser_optionsc
sF t j| j| j|jddd}|jdd}| D ]\}}||j vs-|dg dfv r.q|dv rTdD ] }t |t t
||@ rSt || fddt
||D q4|d krt
||}d
d |D }d d |D } t |t | @ D ] d fd
d|D }qst ||t t |t |B q||j| krt ||| q|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)
preset_filterr Nr )enable_plugins skip_plugins only_pluginsc s g | ]}| vr|qS r[ r[ )r x)commonr[ r\ r s z;SoSComponent.apply_options_from_cmdline..plugoptsc S g | ] }| d d qS =r splitr vr[ r[ r\ r r c S r r r r r[ r[ r\ r r r c s g | ] }| s|qS r[ r~ )r oopt)cstringr[ r\ r s
)
r
from_argsr/
parse_argsr& r itemsr r setr setattrr} )
rV r= cmdoptscodictr valr oplugoptsvalnames ovalnamesr[ )r r r\ apply_options_from_cmdline s4
z'SoSComponent.apply_options_from_cmdlinec C sb t | jd}| jjD ]
}|jtkrd|_q
|| jj| jj d| j
v s)d| j
v r1|| jjd t dkrNt j
t d}t j
|rN||| jj | |}d| _t|dr|j| jd kr| j|j| _| jstjd |j d
| j | _d |_| js| j | _|j | jj d d | |}t| jj d
r| jj j dkr| | 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)
prefer_newr ) r
r< r/ _actionsdefaultr update_from_confr0 r componentr& rE getuidrF rQ r homeexistsr r hasattrr- find_presetr9 rJ r; probe_preset list_presetsmerger= r set_loggers_verbosity)rV r= optionuserconfr[ r[ r\ rA s:
zSoSComponent.load_optionsc
C sz z | j r | j | jr| j | jr t| j W d S W d S ty< } ztd| d| j W Y d }~d S d }~ww )NzFailed to finish cleanup: z
Contents may remain in )r2 cleanupr3 r r+ r r8 rz )rV rY r[ r[ r\ r 9 s
zSoSComponent.cleanupc C sb d}t jdrt jd| j_d}nt jdr#t jd| j_d}| j| | j| d S )NzFNo encryption environment variables set, archive will not be encrypted
SOSENCRYPTKEYz+Encryption key set via environment variableSOSENCRYPTPASSz2Encryption passphrase set via environment variable) rE environgetr= r r sosloginforp )rV rZ r[ r[ r\ _set_encrypt_from_env_varsG s z'SoSComponent._set_encrypt_from_env_varsc C s | j jsLd }|dvrtd }|dvs
|dkr td| j _d S |dkr,td| j _d S |dkr6| d S d | j _d | j _| j d | j
d d S | d S )
N)PKENzLSpecify encryption method [P]assphrase, [K]ey, [E]nv vars, [N]o encryption: r z Specify encryption passphrase: r zSpecify encryption key: r z@User specified --encrypt, but chose no encryption when prompted.z Archive will not be encrypted) r= r inputupperr r r r r r rp warning)rV _encr[ r[ r\ _get_encryption_methodS s( z#SoSComponent._get_encryption_methodc C s | j jr| | j jp| j j| j j| j jd}|s | j }tj | j
|}| j j dkrD| j }||| j
| j| j j
|| j| j| _nt|| j
| j| j j
|| j| j| _| j| j jdk d S )N)r keypasswordr ru )r= r r r r r- get_archive_namerE rF rQ r+ r get_preferred_archiver r r4 r2 r set_debugr )rV nameenc_opts archive_name auto_archiver[ r[ r\
setup_archivek s,
zSoSComponent.setup_archivec C sV | j }| jD ] }t||D ]}tj||}dD ]
}| j ||d q qqd S )N)z(--upload-pass[\s=]+)\S+z$(--upload-url[\s=]+\S+://.*:)([^@]*)z!(--upload-s3-secret-key[\s=]+)\S+z
\1********) r2 get_archive_pathfiles_with_upload_passwdr globrE rF relpath do_file_sub)rV _arc_pathrF frer[ r[ r\ _obfuscate_upload_passwords s
z(SoSComponent._obfuscate_upload_passwordsc C sJ t tj}|t d || jjdkrt j nt j
| j | d S )N %(message)sr" )
logging
StreamHandlerr9 r: setFormatter FormattersetLevelr= r DEBUGINFOrp
addHandler)rV
ui_consoler[ r[ r\ add_ui_log_to_stdout s z!SoSComponent.add_ui_log_to_stdoutc C sb t | dd r|r| jtj t | dd r/|r&| jjdkr&| jtj d S | jtj d S d S )Nflogconsoler" ) r r r r r r= r r WARNING)rV r r[ r[ r\ r s z"SoSComponent.set_loggers_verbosityc C sf t d| _| jt j d| _| s7| | _t | j| _| j
t d | jt j | j
| j | jjsZt tj| _| j
t d | | jj | j
| j nt tj}|
t d |t j | j
| t d| _| j| jjdkrt jnt j | s| | _t | j}|
t d | j
| | jjs| dS 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.
rf Nz&%(asctime)s %(levelname)s: %(message)sr sos_uir" )r getLoggerr r r r r
get_temp_file sos_log_filer r r r r r= r r9 r: r r r rJ ERRORrp sos_ui_log_filer )rV console_err ui_fhandlerr[ r[ r\ rO sD
zSoSComponent._setup_loggingc C s
| j S rh )r3 newrk r[ r[ r\ r
zSoSComponent.get_temp_filec C s0 d}d}| D ]
}|t||dd d }q|S )NP r F)replace_whitespacer )
splitlinesr )rV rZ width_fmtliner[ r[ r\ _fmt_msg s
zSoSComponent._fmt_msg)r N)r )!__name__
__module__ __qualname____doc__descr rB r> rb
root_requiredr< r r] r? rl r7 rK rC r classmethodr r rA r r r r r r r rO r r r[ r[ r[ r\ r
sV 8
<3
. r
c @ sV e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z g fddZ
dddZ dS )rD 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 rh _valuesrk r[ r[ r\ r] r zSoSMetadata.__init__c c s | j D ]}|d V qd S )Nr" )r r rV itemr[ r[ r\ __iter__ s zSoSMetadata.__iter__c C
| j | S rh r r r[ r[ r\ __getitem__ r zSoSMetadata.__getitem__c C r
rh r )rV attrr[ r[ r\ __getattr__ r zSoSMetadata.__getattr__c C s || j |< dS )z@Add a key, value entry to the current metadata instance
Nr )rV
field_namecontentr[ r[ r\ rP s zSoSMetadata.add_fieldc C s t | j|< | j| S )zCAdds a new instance of SoSMetadata to the current instance
)rD r )rV section_namer[ r[ r\ rU s
zSoSMetadata.add_sectionc C s t |ts td|| 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)
isinstancer} TypeErrorr )rV list_namer r[ r[ r\ 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 )r str)r r[ r[ r\ s z&SoSMetadata.get_json..)r indent)jsondumps)rV r r[ r[ r\ get_json s zSoSMetadata.get_jsonrh ) r r r r r] r r r
rP rU r r r[ r[ r[ r\ rD s rD )r r rE rM r9 r{ textwrapr argparser r r shutilr pathlibr rf r sos.archiver sos.optionsr
sos.utilitiesr r r
rD r[ r[ r[ r\ s* D