File: //lib/python3.9/site-packages/sos/report/__pycache__/__init__.cpython-39.pyc
a
G%@iQ@ � @ sV d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlmZ d dlZd dl m
Z
d dl m Z d dl
mZ d dlZd dlmZmZmZmZmZmZmZmZ d dlmZ d dlm Z d d l m Z d dl Zd d
l m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z* d d l+m,Z, d d l-m.Z. ej/ej0fZ1ddd�Z2dd� Z3g d�Z4h d�Z5G dd� de �Z6dS )� N)�datetime)�ThreadPoolExecutor)� TimeoutError)�rmtree)�ImporterHelper�SoSTimeoutError�bold�sos_get_command_output�TIMEOUT_DEFAULT�listdir�
is_executable�scrub_url_credential)�_sos)� __version__)� SoSComponent)
�Report�Section�Command�
CopiedFile� CreatedFile�Alert�Note�PlainTextReport�
JSONReport�
HTMLReport)�
SoSCleaner)� SoSUploadF�, c C s� g }| }|rt | �d }nd}|D ]:}t |�t |� t |� dkrP|�|� |}|| | }q"|t |� d � |kr�|d t |� � }|�|� |S )N� � �H )�len�append)Z
first_line�items�indent�sep�lines�line�newline�item� r* �7/usr/lib/python3.9/site-packages/sos/report/__init__.py� _format_list. s
r, c C s t �| d�d�S )z� This function will format --since arg to append 0s if enduser
didn't. It's used in the _get_parser.
This will also be a good place to add human readable and relative
date parsing (like '2 days ago') in the future z<014sz %Y%m%d%H%M%S)r �strptime)�dater* r* r+ �
_format_since@ s r/ )�auto�always�never> Z
HTTP_PROXYZ HTTPS_PROXYZNO_PROXYZ https_proxyZ
http_proxyZ ALL_PROXYc @ s� e Zd ZdZdZdZdddddddddg g g dddg dg dg ddddd dd
g g g ddddddg deeg dddg dddddddddddddddddd d �?Z� fd
d�Ze dd� �Z
e dd� �Z dd� Z dd� Z
dd� Zdd� Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd�d%d&�Zd'd(� Zd)d*� Zd+d,� Zd-d.� Zd/d0� Zd1d2� Zd3d4� Z d5d6� Z e d7d8� �Z d�d9d:�Z d;d<� Z!d=d>� Z"d?d@� Z#dAdB� Z$dCdD� Z%dEdF� Z&d�dHdI�Z'dJdK� Z(dLdM� Z)dNdO� Z*dPdQ� Z+dRdS� Z,dTdU� Z-dVdW� Z.dXdY� Z/dZd[� Z0d\d]� Z1d^d_� Z2d�d`da�Z3dbdc� Z4ddde� Z5dfdg� Z6dhdi� Z7djdk� Z8dldm� Z9dndo� Z:dpdq� Z;drds� Z<dtdu� Z=dvdw� Z>dxdy� Z?dzd{� Z@d|d}� ZAd~d� ZBd�d�� ZCd�d�� ZDd�d�� ZEd�d�� ZFd�d�� ZGd�d�� ZH� ZIS )�� SoSReportzaRun a set of commands and file collections and save them to a report for
future analysis
z.Collect files and command output in an archiveTFr r0 �d N� � /etc/sos/cleaner/default_mapping� obfuscate)?�
alloptions�all_logs�build�case_id�chroot�clean�container_runtime�keep_binary_files�desc�domains�disable_parsers�skip_cleaning_files�dry_run�
estimate_only� experimental�enable_plugins� journal_size�keywords� keyword_file�plugopts�label� list_plugins� list_presets�
list_profiles�log_sizeZ low_priority�map_file�
skip_commands�
skip_files� skip_plugins�
namespaces� no_report� no_env_vars� no_postproc� no_update�note� only_plugins�preset�plugin_timeout� cmd_timeout�profiles�since�verify�allow_system_changes� usernames�upload�
upload_urlZupload_directoryZ upload_userZ upload_passZ
upload_methodZupload_no_ssl_verifyZupload_protocol�upload_s3_endpointZupload_s3_regionZupload_s3_bucketZupload_s3_access_keyZupload_s3_secret_keyZupload_s3_object_prefixZ
upload_target�
add_preset�
del_preset�treat_certificatesc s t � �|||� g | _g | _g | _t| _|| _d| _i | _ | �
� | � � | j �
� | _| jj�d�| _| �� d}| j j| _| jjr�d}n| j �� r�| jtjkr�d}| j�d| j� d|� d�� | jjtvr�| j� d | jj� �� t � � | j � � | �!d
� | �"� | �#� | �$� d S ) N�/�report�default�cmdline�policyzset sysroot to 'z' (�)zinvalid chroot mode: � )%�super�__init__�loaded_plugins�skipped_plugins� all_options�default_env_vars�env_vars�_args�sysroot�estimated_plugsizes� print_header�
_set_debugrn Zis_rootZ_is_root�manifest�
components� add_section� report_md�_set_directories�optsZ in_container�osr% �soslog�debugr< � chroot_modes�error�logging�shutdown�
tempfile_utilr= �_exit�_check_container_runtime�_get_namespaces�_get_hardware_devices)�self�parser�argsrm �msg�� __class__r* r+ rr � s8
zSoSReport.__init__c
C s� |� dd�}|jddddddd � |jd
dd dd d � |jd
ddd tdd� |jdddddd � |jddddd� |jddddd d d � |jd d d d � |jd!d"tdd#d$d%� |jd&dd'd(� |jd)dd*d(� |jd+dd,dd-d � |jd.d/d0d1td2g d3� |jd4td5d6d7d8� |jd9d:d;d0d<td=g d3� |jd>d?dd@dAd� |jdBdCddDddEd � |jdFddGd(� |jdHddIddJd � |jdKddLtdMdNdO� |jdPdddQdR� |jdSd dTd � |jdUdVd0dWtdXg d3� |jdYddZdd[d � |jd\dd]dd^d � |jd_dd`ddadb� |jdctdd#ddd%� |jdedfd0dgtdhg d3� |jdidtdjd dk� |jdld dmd � |jdnd dod � |jdpdqdrd0dstg dtdO� |jdug d0dvdwdx� |jdyg d0dzd{dx� |jd|dd}dd~d � |jddd�dd�d � |jd�ddd�dR� |jd�d d�d � |jd�d d�d � |jd�d d�d � |jd�d d�d � |jd�d g d��d�d�� |jd�ddd�d�� |jd�d d�d � |jd�d d�d � |jd�d d�d � |jd�d d�d � |jd�d d�d � |jd�d d�d � |jd�d g d��d�d�� |�� }|jd�tdd�d�� |jd�tdd�d�� |� d�d��}|jd�d�d�d�ddd�d�� |jd�d�g d0d�d�� |jd�d0g d�d�d�� |jd�d�d0g d�d�d�� |jd�d0g d�d�d�� |jd�d d�d�d�� |jd�ddd�d�d�� |jd�d�d�d�dȍ |jd�ddd�d�dx� |jd�d�g d0d�d�� |jd�d�g dѢd�d�dԍ d S )�NzReport Optionsz.These options control how report collects dataz-az --alloptions�
store_truer8 Fz%enable all options for loaded plugins)�action�destrl �helpz
--all-logsr9 z-collect all available logs regardless of sizez--since�storer` zbEscapes archived files older than date. This will also affect --all-logs. Format: YYYYMMDD[HHMMSS])r� r� rl �typer� z--buildr: z;preserve the temporary directory and do not package resultsz --case-idr; zspecify case identifier)r� r� r� z-cz--chrootr< r0 zHchroot executed commands to SYSROOT [auto, always, never] (default=auto)z--container-runtimezLDefault container runtime to use for collections. 'auto' for policy control.)rl r� z--descz
--descriptionr z Description for a new preset)r� r� rl r� z --dry-runz#Run plugins but do not collect data)r� r� z--estimate-onlyzzApproximate disk space requirements for a real sos run; disables --clean and --collect, sets --threads=1 and --no-postprocz--experimentalrF zenable experimental pluginsz-ez--enable-plugins�extendrG zenable these plugins)r� r� r� r� rl z--journal-sizer4 rH z+limit the size of collected journals in MiB)r� rl r� r� z-kz--plugin-optionz
--plugoptsrK z7plugin options in plugname.option=value format (see -l)z--labelz--namerL z"specify an additional report labelz-lz--list-pluginsrM z)list plugins and available plugin optionsz--list-presetsz#display a list of available presetsz--list-profilesrO zBdisplay a list of available profiles and plugins that they includez
--log-sizerP r5 z6limit the size of collected logs (not journals) in MiB)r� r� r� rl r� z--low-priorityz(generate report with low system priority)r� rl r� z --namespaceszDlimit number of namespaces to collect output for - 0 means unlimitedz-nz--skip-pluginsrT zdisable these pluginsz --no-reportrV z disable plaintext/HTML reportingz
--no-env-varsrW z$Do not collect environment variablesz
--no-postprocrX zDisable all post-processing)rl r� r� r� z--notez Behaviour notes for new presetz-oz--only-pluginsr[ zenable these plugins onlyz--presetzA preset identifier)r� r� r� rl z--plugin-timeoutz set a timeout for all pluginsz
--cmd-timeoutz%set a command timeout for all pluginsz-pz --profilez
--profilesr_ z)enable plugins used by the given profilesz--skip-commandsrR z do not execute these commands)rl r� r� r� z --skip-filesrS zdo not collect these filesz--verifyra z+perform data verification during collectionz--allow-system-changesrb zJRun commands even if they can change the system (e.g. load kernel modules)z--uploadz+Upload archive to a policy-default locationz --upload-urlz&Upload the archive to specified serverz--upload-directoryz$Specify upload directory for archivez
--upload-userz'Username to authenticate to server withz
--upload-passz'Password to authenticate to server withz--upload-method)r0 ZputZpostz HTTP method to use for uploading)rl �choicesr� z--upload-no-ssl-verifyz'Disable SSL verification for upload url)rl r� r� z--upload-s3-endpointz#Endpoint to upload to for S3 bucketz--upload-s3-regionz!Region to upload to for S3 bucketz--upload-s3-bucketz"Name of the S3 bucket to upload toz--upload-s3-access-keyz Access key for the S3 bucketz--upload-s3-secret-keyz Secret key for the S3 bucketz--upload-s3-object-prefixz Prefix for the S3 object/keyz--upload-protocol)r0 �https�ftp�sftpZs3z$Manually specify the upload protocol� --add-presetz#Add a new named command line preset)r� r� r� z --del-presetz$Delete the named command line presetzCleaner/Masking Optionsz7These options control how data obfuscation is performedz--cleanz --cleanerz--maskr= z Obfuscate sensitive information)r� rl r� r� z --domainsrA z$Additional domain names to obfuscatez--disable-parsersrB zCDisable specific parsers, so that those elements are not obfuscated)r� rl r� r� z--skip-cleaning-filesz--skip-masking-filesrC zBList of files to skip/ignore during cleaning. Globs are supported.z
--keywordsrI z List of keywords to obfuscatez--keyword-filerJ z&Provide a file a keywords to obfuscate)rl r� r� z --no-updaterY z%Do not update the default cleaner mapz
--map-filerQ r6 z;Provide a previously generated mapping file for obfuscation)r� rl r� z--keep-binary-filesr? zGKeep unprocessable binary files in the archive instead of removing themz --usernamesrc z List of usernames to obfuscatez--treat-certificatesr7 )r7 �keep�removeri z�How to treat the certificate files [.csr .crt .pem]. Defaults to "obfuscate" after convert the file to text. "Key" certificate files are always removed.)rl r� r� r� )�add_argument_group� add_argumentr/ �str�int� add_mutually_exclusive_group)�clsr� Z
report_grpZ
preset_grpZ cleaner_grpr* r* r+ �add_parser_options� s� �
����
�
��
����
�
�
�
�
���
���
���� �
�
���
�
�
���
��������������
�
��
�
���
�����
��z SoSReport.add_parser_optionsc C s� |� d� |�d� |�d� |�d� |jdd�}|�d� |�d� |jd d�}|�d
td �� d td
�� �� |�dtd�� d�� dddd�}d}|�� D ]"\}}|jd|d�|� �dd� q�|�|� d S )NzSoS Report Detailed Helpz�The report command is the most common use case for SoS, and aims to collect relevant diagnostic and troubleshooting data to assist with issue analysis without actively performing that analysis on the system while it is in use.z�Additionally, sos report archives can be used for ongoing inspection for pre-emptive issue monitoring, such as that done by the Insights project.z�The typical result of an execution of 'sos report' is a tarball that contains troubleshooting command output, copies of config files, and copies of relevant sections of the host filesystem. Root privileges are required for collections.z How Collections Are Determined)�titlez�SoS report performs its collections by way of 'plugins' that individually specify what files to copy and what commands to run. Plugins typically map to specific components or software packages.aF Plugins may specify different collections on different distributions, and some plugins may only be for specific distributions. Distributions are represented within SoS by 'policies' and may influence how other SoS commands or options function. For example policies can alter where the --upload option defaults to or functions.zSee Alsoz5For information on available options for report, see zsos report --helpz and zman sos-reportzThe following zsos helpz sections may be of interest:
z'Information on the plugin design of sosz!Information on a specific $pluginz+How sos operates on different distributions)zreport.pluginszreport.plugins.$pluginZpoliciesr � z<36F)r( )Z set_title�add_textr r r# )r� �sectionZpsecZssec�
help_linesZhelplnZln�valuer* r* r+ � display_help� sD
��� �� ���� zSoSReport.display_helpc C s$ | j �dtdt� d��� d�� d S )N�
zsos report (version ro )�ui_log�info�_r �r� r* r* r+ r{ � s zSoSReport.print_headerc C s. | � � | �� d�| �� | �� | �� d�| _d S )N)�blockZfibre)Zstorage�networkZnamespaced_networkZfstype)�_get_block_devs�_get_fibre_devs�_get_network_devs� _get_network_namespace_devices�_get_devices_by_fstype�devicesr� r* r* r+ r� � s ��z SoSReport._get_hardware_devicesc C s� | j jdkr�| j j�� }|dv r6i | j_| j�d� n�| jjsXd|� d�}| j�|� nt|| jj�� vr�d� dd� | jj�� D ��}t
d |� d
|� ���n2| jj| | jjd < | j�d | jjd j � d
�� dS )a[ Check the loaded container runtimes, and the policy default runtime
(if set), against any requested --container-runtime value. This can be
useful for systems that have multiple runtimes, such as RHCOS, but do
not have a clearly defined 'default' (or one that is determined based
entirely on configuration).
r0 )Znone�offZdiabledz0Disabled all container runtimes per user option.zVWARNING: No container runtimes are active, ignoring option to set default runtime to '�'
r c s s | ]}|d kr|V qdS )rl Nr* ��.0�pr* r* r+ � <genexpr>� s �z5SoSReport._check_container_runtime.<locals>.<genexpr>z Cannot use container runtime 'z1': no such runtime detected. Available runtimes: rl z"Set default container runtime to '�'N) r� r> �lowerrn Zruntimesr� r� �warning�keys�join� Exception�name)r� Zcrunr� Zvalidr* r* r+ r� � s. ��
�
��z"SoSReport._check_container_runtimec
C s� zFg }g d�}|D ].}t j�d|� ��r|�t�d|� d��� q|W S ty� } z"| j�d|� �� g W Y d}~S d}~0 0 dS )z�Enumerate a list of fibrechannel devices on this system so that
plugins can iterate over them
These devices are used by add_device_cmd() in the Plugin class.
)Zfc_hostZ fc_transportZfc_remote_portsZ fc_vportsz /sys/class/z/*z!Could not get fibre device list: N)r� �path�isdirr� �globr� r� r� )r� ZdevsZdevdirsZdevdir�errr* r* r+ r� � s zSoSReport._get_fibre_devsc
s� z�dd� t �d�D �}td�}g � |d dkr^|d �� D ]"}|�� d �dd �}� �|� q:� fd
d�|D �}tt|�t|� �}|W S t y� } z"| j
� d |� �� g W Y d }~S d }~0 0 d S )
z�Enumerate a list of block devices on this system so that plugins
can iterate over them
These devices are used by add_device_cmd() in the Plugin class.
c S s g | ]}d |� ��qS )z/dev/r* )r� �dr* r* r+ �
<listcomp> � z-SoSReport._get_block_devs.<locals>.<listcomp>z
/sys/blockzlosetup --all --noheadings�statusr �output�:r c s" g | ]}|� d �r|� vr|�qS )Zloop��
startswith�r� �dev�Zreal_loop_devicesr* r+ r� " s
�z!Could not get block device list: N) r� r r �
splitlines�split�replacer" �list�setr� r� r� )r� Z device_listZ loop_devicesZloop_devZ loop_deviceZghost_loop_devsZdev_listr� r* r� r+ r� s zSoSReport._get_block_devsc C s d| � � i| _d S )Nr� )�_get_network_namespacesrU r� r* r* r+ r� + s �zSoSReport._get_namespacesc
C s� g g g g d�}zPt d| jjd�r.|�| �� � |d s\| j�d� |�| �� � | �� |d< W n6 t y� } z | j�
d|� �� W Y d}~n
d}~0 0 |S ) a Helper to encapsulate network devices probed by sos. Rather than
probing lists of distinct device types like we do for storage, we can
do some introspection of device enumeration where a single interface
may have multiple device types. E.G an 'ethernet' device could also be
a bond, and that is pertinent information for device iteration.
:returns: A collection of enumerated devices sorted by device type
:rtype: ``dict`` with keys being device types
)�ethernet�bridgeZteam�bondZnmcli)ry r� zZNetwork devices not enumerated by nmcli. Will attempt to manually compile list of devices.r� z%Could not enumerate network devices: N) r r� ry �update�_get_nmcli_devsr� r� �
_get_eth_devs�_get_bridge_devsr� r� )r� �_devsr� r* r* r+ r� 0 s" ��(zSoSReport._get_network_devsc C s* i }| j d D ]}d| �|�i||< q|S )zqEnumerate the network devices that exist within each network
namespace that exists on the system
r� r� )rU r� )r� Z_nmdevsZnmspr* r* r+ r� O s
�
z(SoSReport._get_network_namespace_devicesc
C s� i }z�t d�}|d dkrp|d �� dd� D ]@}|�� \}}||vrR|g||< n|| �|� |d �|� q.tt|d ��|d< W n6 ty� } z | j�d|� �� W Y d}~n
d}~0 0 |S ) z�Use nmcli, if available, to enumerate network devices. From this
output, manually grok together lists of devices.
z nmcli --fields DEVICE,TYPE devr� r r� rp Nr� z Could not parse nmcli devices: ) r r� r� r" r� r� r� r� r� )r� r� Z_ndevsr� ZdnameZdtyper� r* r* r+ r� Z s (zSoSReport._get_nmcli_devsc
s
dg� g }|sdz � fdd�t dd�D �}W q� ty` } z | j�d|� �� W Y d}~q�d}~0 0 n�zHd|� d�}t|�}|d d
kr�|d �� D ]}|� vr�|�|� q�W n< ty� } z$| j�d |� d
|� �� W Y d}~n
d}~0 0 |dd� |D �dd� |D �d�S )a8 Enumerate a list of ethernet network devices so that plugins can
reliably iterate over the same set of devices without doing piecemeal
discovery.
These devices are used by `add_device_cmd()` when `devices` includes
"ethernet" or "network".
:param namespace: Inspect this existing network namespace, if
provided
:type namespace: ``str``
:returns: All valid ethernet devices found, potentially within a
given namespace
:rtype: ``list``
Zbonding_mastersc s g | ]}|� vr|�qS r* r* r� �Z filt_devsr* r+ r� � s �z+SoSReport._get_eth_devs.<locals>.<listcomp>z/sys/class/netNz.Failed to manually determine network devices: zip netns exec z ls /sys/class/netr� r r� z'Could not determine network namespace 'z ' devices: c S s g | ]}|� d �r|�qS )r� r� )r� Zbdr* r* r+ r� � r� c S s g | ]}|� d �r|�qS )�tunr� )r� Ztdr* r* r+ r� � r� )r� r� r� )r r� r� r� r r� r" )r� � namespaceZ _eth_devsr� Z_nscmdZ_nsoutZ_nsethr* r� r+ r� n s8
�
� �� �zSoSReport._get_eth_devsc C s� g }zt ddd�}W n6 tyJ } z | j�d|� �� W Y d}~n
d}~0 0 |d dkr�|d �� d d� D ]X}z|�|�� d � W ql ty� } z$| j�d
|� d |� �� W Y d}~qld}~0 0 ql|S ) z�Enumerate a list of bridge devices so that plugins can reliably
iterate over the same set of bridges.
These devices are used by `add_device_cmd()` when `devices` includes
"bridge" or "network".
z
brctl show� ��timeoutz$Unable to enumerate bridge devices: Nr� r r� rp z"Could not parse device from line 'z': )r r� r� r� r� r" r� r� )r� Z_bridgesZ_boutr� Z_bliner* r* r+ r� � s ( � zSoSReport._get_bridge_devsc C s\ g }t d�}|d dkrX|d �� D ]2}|�� s$|dd� �� rBq$|�|�d�d � q$|S )z�Enumerate a list of network namespaces on this system so that
plugins can iterate over them
Note that stderr is not collected, so no handling of error lines.
zip netnsr� r r� Nrp r )r r� �isspacer" � partition)r� Zout_nsZip_netnsr' r* r* r+ r� � s z!SoSReport._get_network_namespacesc C s� i }t d�}|d dkr |S |d �� D ]b}|�� �� }t|�dkrP|�dd� d|d v rdd|d< |�|d g � ||d �|d � q(|S ) Nzlsblk -snrpo FSTYPE,NAMEr� r r� rp �unknown�extZext4)r r� �stripr� r! �insert�
setdefaultr" )r� Z _dev_fstypesr� r' �helperr* r* r+ r� � s z SoSReport._get_devices_by_fstypec C s4 | j | j| j| j| j| j| j| jj| j| j | j
d� S )N) �cmddir�logdir�rptdir�tmpdirr� rn ry � verbosityZ cmdlineoptsr� rU ) r� r� r� r� r� rn ry r� r� r� rU r� r* r* r+ � get_commons� s �zSoSReport.get_commonsc C s
| j �� S �N)r� �newr� r* r* r+ �
get_temp_file� s zSoSReport.get_temp_filec C s4 | j �| jd� | j �| jd� | j �| jd� d S )Ni� )�archive�makedirsr� r� r� r� r* r* r+ �_make_archive_paths� s z SoSReport._make_archive_pathsc C s d| _ d| _d| _d S )NZ sos_commands�sos_logs� sos_reports)r� r� r� r� r* r* r+ r� � s zSoSReport._set_directoriesc C s" | j jr| jt_d| _nd| _d S )NTF)r� r� �
_exception�sys�
excepthook�
raise_pluginsr� r* r* r+ r| � s zSoSReport._set_debugc C sL t td�stj�� s$t�| ||� n$tj| ||dtjd� t� t �
� dS )z* Wrap exception in debugger if not in tty Zps1� )�limit�fileN) �hasattrr �stderr�isatty�__excepthook__� traceback�print_exception�stdout�print�pdbZpm)�etypeZeval_Zetracer* r* r+ r � s �zSoSReport._exceptionc C sV | j s | jr>t�� \}}}tj|||tjd� t� t� |� |rR|rR| �
||� d S )N)r
) r Z exit_processr �exc_infor r r r r Z post_mortem�_log_plugin_exception)r� �plugname�funcr �val�tbr* r* r+ �handle_exception s
zSoSReport.handle_exceptionc C sT t | dd �r(| jj| jtj�dd�d� t | dd �rP| jj| jtj�dd�d� d S )N� sos_log_filer �sos.log�r� �sos_ui_log_file�ui.log)�getattrr� �add_filer r� r� r� r r� r* r* r+ �
_add_sos_logs s
�
�zSoSReport._add_sos_logsc sP � j j}� j jsdS t|d�s"dS |r8� �|�� �s8dS t� fdd�|jD ��S )NTr_ Fc 3 s | ]}|� j jv V qd S r� )r� r_ r� r� r* r+ r� ' r� z+SoSReport._is_in_profile.<locals>.<genexpr>)r� r[ r_ r �_is_not_specifiedr� �any)r� � plugin_classr[ r* r� r+ �_is_in_profile s
zSoSReport._is_in_profilec C s || j jv S r� )r� rT �r� � plugin_namer* r* r+ � _is_skipped) s zSoSReport._is_skippedc C s* || � � ��� o(|| jjvo(|| jjvS r� )r� Z
check_enabledr� rG r[ �r� r) Z pluginClassr* r* r+ � _is_inactive, s
�
�zSoSReport._is_inactivec C s* || � � ��� o(|| jjvo(|| jjvS r� )r� Zdefault_enabledr� rG r[ r+ r* r* r+ �_is_not_default1 s
�
�zSoSReport._is_not_defaultc C s | j jo|| j jvS r� )r� r[ r( r* r* r+ r$ 6 s
�zSoSReport._is_not_specifiedr� c C s" | j �|�� || �� �|f� d S r� )rt r" r� r� )r� r& �reasonr* r* r+ �_skip: s
�zSoSReport._skipc C s | j �|�� || �� �f� d S r� )rs r" r� r� )r� r& r* r* r+ �_loadA s
�zSoSReport._loadc C s� t jjj}tt jj�}|�� }g | _t� | _t | j
j�}| j j }g }| j
j
r\|�t jjj� t|| �}| j j}t| j
j�} |D �]�}
tj�|
�\} } �zz|| |�}
|
s�W q�| j �|
�}||| j
j
d��s| j�td|
� d��� | j
jdk�r| �|td�� W q�| j�| � | � |�}|�s4| �|td�� W q�| � | ��rT| �|td�� W q�| � | |��rv| �|td�� W q�| � | |��r�| �|td �� W q�t |d
��r�| j�!|j� | �o�|}| �"| ��r�|�r�| �|td �� W q�|jD ]}|| v �r�| �#|� �q�| �$|� W q� t%�y\ } z0| j�td|
� d |� ��� | �&� W Y d }~q�d }~0 0 q�t | �dk�r�| j�'td
d�(| �� ��� | �)� | �*d� d S )N)rF zplugin z does not validate, skippingr zdoes not validateZexcludedZskippedZinactiveZoptionalr_ z
not specifiedz does not install, skipping: z)Unknown or inactive profile(s) provided: r rp )+�sosrk �plugins�
import_pluginr Z get_modules� plugin_namesr� r_ r! r� rn Zvalid_subclassesrF r" ZExperimentalPlugin�tuple�validate_pluginr� r� r� �splitextZ match_pluginr� r� r� r� r/ r' r* r, r- r r� r$ r� r0 r� r r� r� rO r� )r� r3 r� r2 Zusing_profilesZpolicy_classesZ
extra_classesZvalid_plugin_classesr6 Zremaining_profiles�plugZplugbase�__Zplugin_classesr& Z
in_profileZdefault_profile�i�er* r* r+ � load_pluginsG s�
��
�
�
zSoSReport.load_pluginsc C s< | j jr8| jD ](\}}|j�� D ]}t|jv r d|_q qd S )NT)r� r8 rs �options�values�boolZval_typer� )r� r9 r8 �optr* r* r+ �_set_all_options� s
zSoSReport._set_all_optionsc C s | j j�ri }| j jD ]�}z|�d�\}}W n tyB d}Y n0 t|t�r�|�� }|dv rdd}n.|dv rrd}n z t|�}W n ty� Y n0 z|�d�\}}W n ty� |}d}Y n0 z || W n ty� i ||< Y n0 ||| |< q| j D ]�\}}||v r�|| D ]�}||j
v�rH| j � d|� d|� d �� | �
d
� z:|j
| �|| | � | j �d |� d |j
| � �� W n< t�y� } z"| j � |� | �
d
� W Y d }~n
d }~0 0 �q||= q�|D ]}| j � d
|� d�� �q�|�� �r| j � d� d S )N�=T)�on�enableZenabled�trueZyes)r� �disableZdisabledZfalse�noF�.zno such option "z" for plugin (ro rp zSet z plugin option to zCWARNING: unable to set option for disabled or non-existing plugin (z).r )r� rK r� �
ValueError�
isinstancer� r� r� �KeyErrorrs r= r� r� r� Z set_valuer� r� r� )r� r� r@ r �argr8 r r� r* r* r+ �
_set_tunables� sh
�
�� $�
zSoSReport._set_tunablesc C s� dd l }|�| jj| jj�D ]:}|�d�d }|| jvr | j�d|� d�� | � d� q | jj
D ]"}|| jvr`| j� d|� d�� q`d S )Nr rH za non-existing plugin (z$) was specified in the command line.rp z'Requested to skip non-existing plugin 'z'.) � itertools�chainr� r[ rG r� r4 r� �fatalr� rT r� )r� rN �pluginr) r* r* r+ �_check_for_unknown_plugins� s
�
�z$SoSReport._check_for_unknown_pluginsc C s2 | j D ]&\}}|jD ]}| j�|j| � qqd S r� )rs r= ru r" )r� r9 rQ r@ r* r* r+ �_set_plugin_options� s
z SoSReport._set_plugin_optionsc C s� d}g }| j jdkr2|d| j j� d�g7 }d| j _| j jsL|dg7 }d| j _| j jsf|dg7 }d| j _| j jr�|dg7 }d | j _| j jr�|d
g7 }d | j _|r�|d d �|� 7 }n|d
7 }|d7 }|S )Nz
Estimate-only mode enabledrp z
--threads=z overriden to 1z--build enabledTz--no-postproc enabledz--clean disabledFz--upload* options disabledz", which overrides some options:
z
rH z
)r� �threadsr: rX r= rd r� )r� r� Zext_msgr* r* r+ �_set_estimate_only� s,
z SoSReport._set_estimate_onlyc C sd | j �d� | jr:| j �dt| j�� dt| j�� d�� n| j �dt| j�� d�� | j �d� d S )Nr r z profiles, z pluginsz profiles)r� r� rs r! r_ r� r* r* r+ � _report_profiles_and_plugins s � z&SoSReport._report_profiles_and_pluginsc
C s� | j s | js | j�td�� d S | j rr| j�td�� | j�d� | j D ]&\}}| j�d|d�d|�� � �� qHn| j�td�� | j�d� | jr�| j�td�� | j�d� | jD ]0\}}}| j�d|d�d|d �d|�� � �� q�| j�d� | j�rn| j�td
�� | j d d � � }|D ]�}|| }|j
}|j
d
k�rx|dk�rZ| j j �pVt
}n |dk�rt| j j�ppt
}nt
}|jdk�r�| j j }| j�d|jd�d|d�d|j� �� �q"| j�d� | j�td�� | jD ]�}|jdv �r�|j
|jk�r��q�t|j
t��r"|j
du �r d} nd} n|j
} | d u �r6d } | j�d|j� d|j� �d�d| d�d|j� �� �q�n| j�td�� | j�d� t| j�}
|
�� td|
dd �} | D ]} | j�d| � �� �q�| �� d S ) Nzno valid plugins foundz,The following plugins are currently enabled:r r z<20zNo plugin enabled.z-The following plugins are currently disabled:z<30z<14z4The following options are available for ALL plugins:r rp ���r� � cmd-timeout�postprocz<25�<15z+The following plugin options are available:)r� rY rX TrC r� rH z<35z No plugin options available.z
Profiles: �r$ )rs rt r� rP r� r� r� Zget_descriptionru Zget_default_plugin_optsr� r� r] r
r^ r� rX r@ rl rJ r? rQ r� r_ �sortr, rV )
r� r r8 Z plugclassr. � _defaultsZ_optr@ r Ztmpoptr_ r& r' r* r* r+ rM sv " �
*
��
zSoSReport.list_pluginsc C s� | j s| j�td�� d S | j�td�� | j�d� dd� }t| j �}|�� |D ]b}g }| jD ]$\}}||�rb||j v rb|� |� qbt
|d�|dd�}|D ]}| j�d |� �� q�qT| � � d S )
Nzno valid profiles foundz%The following profiles are available:r c S s
t | d�S )Nr_ )r )�cr* r* r+ � _has_profa s z*SoSReport.list_profiles.<locals>._has_profrZ Tr[ r ) r_ r� rP r� r� r� r� r\ rs r" r, rV ) r� r_ r_ Zprofiler2 r� rQ r& r' r* r* r+ rO Z s"
zSoSReport.list_profilesc C s | j js | j�td�� d S | j�td�� | j�d� | j j�� D ]�}|sNqD| j �|�}| j�dd�d|j � �� | j�dd�d|j
� �� |j r�| j�dd�d|j � �� | j j
d kr�|j �� }d
d�d�}t||d dd �}|D ]}| j�|� q�| j�d� qDd S )
Nzno valid presets foundz$The following presets are available:r zname:z>14r z description:znote:r zoptions:T)r$ r% )rn Zpresetsr� rP r� r� r� r� � find_presetr� r@ rZ r� r� �to_argsr, )r� r\ r� Z options_strr& r' r* r* r+ rN p s(
zSoSReport.list_presetsc
C s� | j }|�|�r(| j�d|� d�� dS |p2| jj}|p>| jj}z|j|||| jd� W n8 ty� } z | j�d|� �� W Y d}~dS d}~0 0 | j �
d�}| j d|� | j |d d� }| j� d
|� d d � |�� d
�� dS )z�Add a new command line preset for the current options with the
specified name.
:param name: the name of the new preset
:returns: True on success or False otherwise
zA preset named 'z' already existsF)r� r@ rZ r� zCould not add preset: Nr� r r zAdded preset 'z' with options r r� T)
rn r` r� r� r� r@ rZ rg r� rm �indexr� r� )r� r� r@ rZ rn r; Z arg_indexr� r* r* r+ rg � s"
�zSoSReport.add_presetc
C s� | j }|�|�s(| j�d|� d�� dS z|j|d� W n< tyt } z$| j�t|�� d�� W Y d}~dS d}~0 0 | j�d|� d�� d S )
z�Delete a named command line preset.
:param name: the name of the preset to delete
:returns: True on success or False otherwise
zPreset 'z ' not foundF�r� r� NzDeleted preset 'r� T)rn r` r� r� rh r� r� r� )r� r� rn r; r* r* r+ rh � s
zSoSReport.del_presetc
C s� | j �� }| jjr || �� 7 }| jjr4| j�|� np|td�7 }z t |� W nV t
yt | j� d� | � d� Y n0 t
y� } z| � d|� W Y d }~n
d }~0 0 d S )Nz,Press ENTER to continue, or CTRL-C to quit.
zExiting on user cancel� rp )rn Zget_msgr� rE rU �batchr� r� r� �input�KeyboardInterruptr� r� r� )r� r� r; r* r* r+ re � s
zSoSReport.batchc C sr t �� }d}|� d�}tj�| j|�}| j�|� d|� d|� d�� | j�d|� �� | jj |� d�|dd � d S )
Nz!caught exception in plugin methodz-plugin-errors.txtz "rH z()"zwriting traceback to r� �a)�mode)
r �
format_excr� r� r� r� r� r� r� �
add_string)r� rQ �methodZtracer� Zplugin_err_logZlogpathr* r* r+ r � s
z SoSReport._log_plugin_exceptionc
C s� | j �� z&| j�td�� | �� | �� W d S ty� } zJ|jt v rnt
d� t
d|j � d�� t
d� nt
d|� �� � W Y d }~nXd }~0 t y� } z8| j�
d� | j�
d� t�� | j�
|� W Y d }~n
d }~0 0 | �d� d S )Nz Setting up archive ...r r z while setting up archivezError setting up archive: z) Unexpected exception setting up archive:rp )rn Zpre_workr� r� r� Z
setup_archiver �OSError�errno�fatal_fs_errorsr �strerrorr� r� r � print_excr� �r� r; r* r* r+ �prework� s&
"zSoSReport.preworkc C sj | j �td�� | jD �]L\}}z�| jj�|� |�t| jj|�� t �
� }|j � d|� | j
|_
|�� |�� | j�|j� | jjr�|�� t �
� }|j � d|� |j � d|| � W q ty� t�Y q t�yD } z\|jtv �r$| j �d� | j �d|j� d�� | j �d� | � d� | � |d � W Y d }~qd }~0 t �yb | � |d � Y q0 qd S )
Nz Setting up plugins ...Z setup_startZ setup_endZ
setup_timer r z while setting up pluginsrp �setup) r� r� r� rs r� r2 r Zset_plugin_manifestr! r �nowr} � add_fieldr� Zadd_default_collectionsrt rw r� Z _env_varsr� ra Z setup_verifyrg rm rn ro r� rp r� r r� �r� r r8 �start�endr; r* r* r+ rt � s> � �
zSoSReport.setupc C s. g }|� dt� �� | jjd�|�dd� dS )zWFetch version information from all plugins and store in the report
version filez sos report: r� z version.txt)Zcontentr� N)r" r r� rk r� )r� Zversionsr* r* r+ �version
s
�zSoSReport.versionc C s� | j �td�� | j �d� d}g | _g | _| jD ] }|d7 }| j�||d f� q2ztg }t| jj ��$}|�
| j t | j��}W d � n1 s�0 Y |D ]}|s�| j
�d|� �� q�| j �d� W n( ty� | j �d� t�d� Y n0 d S )Nz! Running plugins. Please wait ...r r rp z Unexpected plugin task result: z
Exiting on user cancel
)r� r� r� �pluglist�
running_plugsrs r" r r� rT �map�_collect_pluginr� r� r� rg r� r� r� )r� Z plugruncountr: �results�executor�resr* r* r+ �collect s*
�" zSoSReport.collectc C s� t d���}z|| j|d d d }|�| j|�}|jp:d}t�� }|j�d|� |j |d� t�� }|j�d|� |j�d|| � W n� t
�y d|d � d �}| j � d
|� d �� | j
�|� | j�|d � | j|d d d �� |jd d
� |j�� Y n0 W d � n1 �s$0 Y | jj�r�| j�� } z0td| � ��}
t|
d �� d �| j |d < W n" t �y� d| j |d < Y n0 t � | �D ]D} t j �!| | �} t j �"| ��r�t j �#| ��s�t$| � n
t �%| � �q�d S )zaWraps the collect_plugin() method so we can apply a timeout
against the plugin as a wholerp r NZ
start_timer� Zend_timeZrun_timezPlugin z
timed out�
r� T)�waitzdu -sB1 r� )&r rs Zsubmit�collect_pluginr� r ru r} rv �result�FuturesTimeoutErrorr� r� r� r� r| r� Zset_timeout_hitr� Z_threads�clearr� rE r� Z get_tmp_dirr r� r� rz r� r� r r� r� r� �islinkr �unlink) r� rQ ZpoolZ_plug�tr� rx ry r� r� Zdu�fr* r* r+ r~ , sB
0
�
zSoSReport._collect_pluginc
C s" z*|\}}| j |d d }| j�|� W n ty> Y dS 0 t| j �}d|� d|� �d�d|d�dd�d d
� | jD ��� d �}| �|� z�|�� z| j� |� W n& t
y� | j � d |� d
�� Y n0 z| j� |� W n( t
�y | j � d |� d�� Y n0 d}t| j�t
| jj�k�rR| j�rRddd�dd�dd
� | jD ��� d �}| j�sf| j�sfd}|�rv| �|� W n� t�y� Y n� t�y� } zZ|jtv �r�| j�d|j� d�� | j�d| j� d�� t�d� | �|d� W Y d }~n(d }~0 t�y | �|d� Y n0 d S )Nrp Fz Starting rj z<5r rZ z [Running: c s s | ]
}|V qd S r� r* r� r* r* r+ r� f r� z+SoSReport.collect_plugin.<locals>.<genexpr>�]zCould not remove z from plugin list, ignoring...z& from running plugin list, ignoring...r z Finishing plugins z<12c s s | ]
}|V qd S r� r* r� r* r* r+ r� r� z
Finished running pluginsr� z while collecting plugin dataz# Data collected still available at r� r� )rs r| r" r� r! r� � ui_progressr� r{ r� rI r� r� r� r� rT r rm rn ro r� r� rp r� r� r� r ) r� rQ �countr r8 Znumplugs� status_liner� r; r* r* r+ r� ] sf
�
�
�
�
� � �
zSoSReport.collect_pluginc C sR | j jdkr&| j js&d|�d�� �}n
|� d�}| j jsNtj�|� tj�� d S )Nr �
�Z r� ) r� r� re �ljust�quietr r �write�flush)r� r� r* r* r+ r� � s
zSoSReport.ui_progressc C s@ | j s
d S d�dd� dd� | j D �D ��d }| j�|d� d S )Nr� c S s" g | ]\}}|� d t |�� ��qS )rB )r
)r� r� r r* r* r+ r� � s z.SoSReport.collect_env_vars.<locals>.<listcomp>c S s. g | ]&}t j�|�d ur|t j�|�� f�qS r� )r� �environ�get)r� r� r* r* r+ r� � s �Z environment)rw r� r� rk )r� �envr* r* r+ �collect_env_vars� s
��zSoSReport.collect_env_varsc
C s� t � }| jD ]�\}}t|d�}|jD ]}|�t|�� q$|jrN|�t|j�� |jD ]"}|�t |d d|d d�� qT|j
D ]4}|�t |d dt j
�d| �� d |d �d
�� q~|jD ]&\}}}|�t|t j
�d|�d�� q�|�|� q td d ftd
dftddff} | D ]�\}
} } zT| �� }
|
|��� }|�dd��� }|
�|� |
�� | jj |
t j
�d| �d� W np t �y� } zV|j t v �r�| j �!d� | j �!d|j"� d| � d�� | j �!d� | �#d� W Y d }~n
d }~0 0 �qd S )Nrc Zsrcpathz..Zdstpath)r� �href�cmdr r� r
)r� Z return_coder� zsos.txt�textzsos.jsonZJSONzsos.htmlZHTML�utf-8r� r r r r z while writing z reportrp )$r rs r Zalerts�addr Z custom_textr Z copied_filesr Zexecuted_commandsr r� r� r� r� Z copy_stringsr r r r r� Zunicode�encode�decoder� r� r� r" rm rn ro r� r� rp r� )r� rk r r8 r� Zalertr� r� r9 Z
formatlist�class_�filename�type_�fdr� r; r* r* r+ �generate_reports� s\
�
��
�
�
� � zSoSReport.generate_reportsc C s | j D �]\}}zh|�d�rdt�� }|j�d|� |�� t�� }|j�d|� |j�d|| � n| j�d|� �� W q t y� } zZ|j
t v r�| j �
d� | j �
d|j� d�� | j �
d� | �d � | �|d� W Y d }~qd }~0 t�y | �|d� Y q0 qd S )
NrY Zpostproc_startZ postproc_endZ
postproc_timez Skipping postproc for plugin r r z" while post-processing plugin datarp )rs Z
get_optionr ru r} rv rY r� r� rm rn ro r� r� rp r� r r� rw r* r* r+ rY � s.
�
�
zSoSReport.postprocc C s� |sdS zXd}t �|�}t|d��,}|�|�}|s4q@|�|� q$W d � n1 sT0 Y W n tyz | �� Y n0 |�� S )NFi �rb)�hashlibr� �open�readr� r� r Z hexdigest)r� r� � hash_nameZ hash_sizeZdigestZ
archive_fpZhashdatar* r* r+ �_create_checksum� s
. zSoSReport._create_checksumc C sL t |d | ddd��"}|r*|�|d � W d � n1 s>0 Y d S )NrH �wr� )�encodingr� )r� r� )r� r� r� �checksum�fpr* r* r+ �_write_checksum s zSoSReport._write_checksumc
sR d }d }d }| � � d}| jjr�zJ| j| j| j| j| jd�}td|d�}|�| j �
� � |� � \}}d}W n6 t y� } z t
td|� ��� W Y d }~n
d }~0 0 | �� | jd ur�| j �| jj� | �� |�r(tj�| j| j j�} |�tj�| dd�� |�tj�| dd�� |�tj�| d d
�� | jj�r:| �� | jj�r"d d lm � d d
l m }
|
| j�} t dd� | � d�D ��| j!d< � t | j!�"� ��} | j#�$d| � �� t%| j!�&� dd� dd�d d� }
d�� fdd�|
D ��}| j#�$d|� �� | j#�$d� | j#�$d� | j#�$d � | j#�$d� | jj'�s*t�(d �}| jj�sLt
td �� z�z&|�rb| j �)|� | j �*| jj�}W n� t+�y� } zRt
d� t
td |j,� d | j �
� � ��� t
d� |j-t.v �r�| �/d!� W Y d }~n6d }~0 t �y | jj0�r�� Y W t�(|� dS 0 W t�(|� n t�(|� 0 n�| jj1�s>| jj2�rJ| j#�3d"� | j �
� }tj�4|�}|�rp|�5|�}z$tj�| j|�}t�6||� |}W n( t+�y� t
td#|� ��� Y dS 0 d }| jj'�s:|�s�t
d$� �qNz| j�7� }| �8||�}W n" t �y t
td%�� Y dS 0 z| �9|||� W n& t+�yT t
td&|� ��� Y n0 tj�4|�}|�rz|�5|�:d'd(��}tj�| j|�}t�;|�}|d) | }|d) | }zt�6||� |}W n( t+�y� t
td*|� ��� Y dS 0 zt�6||� W n& t+�y t
td+|� ��� Y n0 | jj<|||||d,� n| jj<||||d,� | jj=�sl| jj>�sl| jj?�r| jj'�szP| j| j| j| j| jd�}t@| jA| jB| jCd||d-�}|� � | j#�$td.�� W n8 t �y� } z | j#�Dd/|� �� W Y d }~n
d }~0 0 nd0}| j#�D|� tE�F� | jG�r,| jG�� | j�rNtj�H| j��rNtI| j� dS )1NF)rn r� �sys_tmpr= r} T)�in_place� hook_commonsz#ERROR: Unable to obfuscate report: r r r r z
manifest.jsonr ��get_human_readable)�Pathc s s | ]}|� � jV qd S r� )�lstat�st_size)r� r� r* r* r+ r� D s z'SoSReport.final_work.<locals>.<genexpr>z**/*Zsos_logs_reportszNEstimated disk space requirement for whole uncompressed sos report directory: c S s | d S )Nrp r* )�xr* r* r+ �<lambda>K r� z&SoSReport.final_work.<locals>.<lambda>)�key�reverse� z, c 3 s( | ] \}}|� d � |dd�� �V qdS )z: r )Z precisionNr* )r� r� �vr� r* r+ r� L s �zFive biggest plugins: r z>Please note the estimation is relevant to the current options.z�Be aware that the real disk space requirements might be different. A rule of thumb is to reserve at least double the estimation.�? z Creating compressed archive...r z while finalizing archive rp zQ
Unable to encrypt when using --build. Encryption is only available for archives.zError moving directory: z Creating archive tarball failed.z:Error generating archive checksum after archive creation.
z!Error writing checksum for file: z.tarz-obfuscated.tarrH zError moving archive file: z Error moving checksum file: )rQ )r� r� rm r� r� r� z Uploaded archive successfullyzUpload attempt failed: zEUnable to upload archive when using --build as no archive is created.)J� generate_manifest_tag_summaryr� r= rn r� r� r} r Zset_target_pathr� Zget_archive_path�executer� r r� r# Zadd_final_manifest_dataZcompression_typeZ_obfuscate_upload_passwordsr� r� r� �_nameZobfuscate_filer� Zadd_ui_log_to_stdoutrE �
sos.utilitiesr� �pathlibr� �sumr� rz r> r� r� �sortedr# r: �umaskZrename_archive_root�finalizerm rp rn ro r� r� Z encrypt_passZ encrypt_keyr� �basenameZobfuscate_string�renameZget_preferred_hash_namer� r� r� �statZdisplay_resultsrd re rf r r� r� rm r� r� r� r� r� r ) r� r� Z directoryrQ Zdo_cleanr� ZcleanerZ_pathsr� Z_dirr� Z tmpdir_pathZ_sumZ
bigpluginsZbp_outZ old_umaskr; Zdir_nameZ final_dirr� r� Z base_archive�
final_nameZ archivestatZ archive_hashZ
final_hashZuploaderr� r* r� r+ �
final_work
sF � (
�
��
���
��
�
�
� ��
��*
zSoSReport.final_workc C s | j s| j�td�� dS dS )Nz no valid plugins were enabledFT)rs r� r� r� r� r* r* r+ �verify_plugins� s zSoSReport.verify_pluginsc C s | j �d| j� | j �d| jr&| jjnd� | j �d| jj� d}td�r~t dt
� � � ��}|d d kr~|d
� � d �
d �}| j �d � | j j�d
|� | j j�dt
�d �� | j �d� | j�� D ]\}}| j j�||� q�| j �d| jj� | j �d| jj� | j �d� dS )zgAdd 'global' data to the manifest, that is any information that is
not plugin-specific
ry r\ Zunsetr_ r� Zionicez
ionice -p r� r r� r� �priorityZio_classZnicenessr� Zenabled_pluginsZdisabled_pluginsr2 N)r� rv ry r\ r� Zadd_listr� r_ r r r� �getpidr� r� r r� �nicer� r# rG rT )r� Z _io_class�_ior� r� r* r* r+ �add_manifest_data� s& � zSoSReport.add_manifest_datac s| d� fdd� }i � | j jD ]B}|jD ] }||� q$|jD ]}||d� q8|jD ] }||� qNq| j �dtt� �� ��� dS )ac Add a section to the manifest that contains a dict summarizing the
tags that were created and assigned during this report's creation.
This summary dict can be used for easier inspection of tagged items by
inspection/analyzer projects such as Red Hat Insights. The format of
this dict is `{tag_name: [file_list]}`.
�filepathc s~ | d D ]p}| | r|sqz � | }W n t y< g }Y n0 |�t| | t�rX| | n| | g� ttt|���� |< qd S )N�tags)rK r� rJ r� r� r� )Zentr� �tagr� �� tag_summaryr* r+ � compile_tags
s
�z=SoSReport.generate_manifest_tag_summary.<locals>.compile_tagsZ files_copiedr� N)r� ) r� r2 Zcommands�files� collectionsrv �dictr� r# )r� r� r8 r� Z_fileZ
collectionr* r� r+ r� s
�z'SoSReport.generate_manifest_tag_summaryc C s� | j �dt� dd�| j�� d�� | jj�� }dt� d| jj� dd�|�� d�}| j �|� | j �dt� dd�| j�� �� �� d S ) N�[z:setup] executing 'sos r r� z:setup] using 'z' preset defaults (ro z :setup] effective options now: ) r� r� �__name__r� rm r\ r� ra r� )r� Z preset_argsr� r* r* r+ �_merge_preset_options% s
�
� �z SoSReport._merge_preset_optionsc
C s� �z8| j �| �� � | �� | �� | �� | �� | �� | �� | j j
rX| �
� t �| j j rl| � � t �| j j
r�| �
� t �| j jr�| �| j j� t �| j jr�| �| j j� t �| �� s�t �| �� | �� | �� | �� | �� | j js�| �� | j j�s
| �� | j j�s | �� n | j � d� | � � | � � W S t �yt | j j!�rV� t"�#dd �dk�sp| �$� Y n| t%�y� | j �&d� | �$� | �'d� Y nL t �y� } z2t"�#dd �dk�s�| �$� t(�)|j*� W Y d }~n
d }~0 0 | �'d� dS )Nz)Skipping postprocessing of collected dataZ
SOS_TEST_LOGSr� z
Exiting on user cancelrd rp F)+rn Z set_commonsr� r< rA r� rM rR rS r� rM �
SystemExitrO rN rg rh r� re rs r� rt r� rW r� rV r� rX rY r� r� rz r� rm r� r� �getenvZcleanuprg r� r� r �exit�coderr r* r* r+ r� 4 sl
"
zSoSReport.execute)N)NN)r� )r r )Jr� �
__module__� __qualname__�__doc__r@ Z
root_requiredr
Z arg_defaultsrr � classmethodr� r� r{ r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r� r| � staticmethodr r r# r' r* r, r- r$ r/ r0 r< rA rM rR rS rU rV rM rO rN rg rh re r rs rt rz r� r~ r� r� r� r� rY r� r� r� r� r� r� r� r� �
__classcell__r* r* r� r+ r3 R s �B '
W
6
2
O;
I
17
7 Z r3 )Fr )7r r r� rn r� r� r r r� �concurrent.futuresr r r� �shutilr Zsos.report.pluginsr1 r� r r r r r
r r r
r r� r Z
sos.componentr Z sos.policiesZsos.report.reportingr r r r r r r r r r Z sos.cleanerr Z
sos.uploadr �ENOSPCZEROFSro r, r/ r� rv r3 r* r* r* r+ �<module>
s4 ( 0