File: //lib/python3/dist-packages/sos/report/__pycache__/__init__.cpython-310.pyc
o
���b�( � @ s6 d dl Z d dlZd dlZd dlZd dlZd dlmZ d dlZd dlZd dl m
Z
m Z m Z m
Z
mZmZmZ d dlmZ d dlZd dlmZmZ d dlZd dlmZ d dlmZ d dlm 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* ej+ej,fZ-dd
d�Z.dd� Z/g d�Z0G dd� de �Z1dS )� N)�datetime)�ImporterHelper�SoSTimeoutError�bold�sos_get_command_output�TIMEOUT_DEFAULT�listdir�
is_executable)�rmtree)�ThreadPoolExecutor� TimeoutError)�_sos)� __version__)� SoSComponent)
�Report�Section�Command�
CopiedFile� CreatedFile�Alert�Note�PlainTextReport�
JSONReport�
HTMLReport)�
SoSCleanerF�, c C s� g }| }|r
t | �d }nd}|D ] }t |�t |� t |� dkr(|�|� |}|| | }q|t |� d � |krC|d t |� � }|�|� |S )N� � �H )�len�append)�
first_line�items�indent�sep�lines�line�newline�item� r) �5/usr/lib/python3/dist-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{:<014s}z %Y%m%d%H%M%S)r �strptime�format)�dater) r) r* �
_format_since; s r/ )�auto�always�neverc sb e Zd ZdZdZdZi dd�dd�dd�dd �d
d �d d�d
d �dd�dd �dg �dg �dd�dd�dd�dg �dg �dd�i dg �dd �dd�d d�d d�d d �d d!�d"g �d#g �d$g �d%d�d&d�d'd�d(d�d)d�d*d �d+g ��i d,d �d-e�d.e�d/g �d0d�d1d�d2d�d3g �d4d�d5d�d6d�d7d�d8d�d9d �d:d�d;d �d<d ��d=d i�Z� fd>d?�Ze d@dA� �Z
e dBdC� �Z dDdE� Z dFdG� Z
dHdI� ZdJdK� ZdLdM� ZdNdO� ZdPdQ� ZdRdS� ZdTdU� Zd�dVdW�ZdXdY� ZdZd[� Zd\d]� Zd^d_� Zd`da� Zdbdc� Zddde� Z e dfdg� �Z d�dhdi�Z djdk� Z dldm� Z!dndo� Z"dpdq� Z#drds� Z$dtdu� Z%d�dwdx�Z&dydz� Z'd{d|� Z(d}d~� Z)dd�� Z*d�d�� Z+d�d�� Z,d�d�� Z-d�d�� Z.d�d�� Z/d�d�� Z0d�d�� Z1d�d�d��Z2d�d�� Z3d�d�� Z4d�d�� Z5d�d�� Z6d�d�� Z7d�d�� Z8d�d�� Z9d�d�� Z:d�d�� Z;d�d�� Z<d�d�� Z=d�d�� Z>d�d�� Z?d�d�� Z@d�d�� ZAd�d�� ZBd�d�� ZCd�d�� ZDd�d�� ZEd�d�� ZF� ZGS )�� 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 archiveT�
alloptionsF�all_logs�build�case_idr �chrootr0 �clean�container_runtime�keep_binary_files�desc�domains�disable_parsers�dry_run�
estimate_only� experimental�enable_plugins�keywords� keyword_fileN�plugopts�label� list_plugins� list_presets�
list_profiles�log_size� �map_file� /etc/sos/cleaner/default_mapping�
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_url�upload_directory� upload_user� upload_pass�
upload_method�upload_no_ssl_verify�upload_protocol�
add_preset�
del_presetc s� t t| ��|||� g | _g | _g | _t� | _d | _|| _ d| _
d | _ i | _ | �
� | �� | j�� | _| jj�d�| _| jj | jd kre| j�| jj �| _ | j setj�d| jj � | j� � | _ d| j_ | j sn| j� � | _ | j� | j j� | � | j�| _t | j jd�r�| j jj!dkr�t"d� | �#� | �$� d }| jj
| _
| jj
r�d
}n
| j�%� r�| j
t&j'kr�d }| j(�)d | j
|f � | jj*t+vr�| j(�,d
| jj* � t-�.� | j/�0� | �1d� | �2� | �3� | �4� d S )N�/�reportrX zUnknown preset: '%s'
T� verbosityr z~
WARNING: It is not recommended to set verbosity via the preset as it might have
unforseen consequences for your report logs.
�default�cmdline�policyzset sysroot to '%s' (%s)zinvalid chroot mode: %s� )5�superr3 �__init__�loaded_plugins�skipped_plugins� all_options�set�env_vars�archive�_args�sysrootrX �estimated_plugsizes� print_header�
_set_debugro �is_root�_is_root�manifest�
components� add_section� report_md�opts� arg_defaults� find_preset�sys�stderr�write� probe_presetrH �merge�apply_options_from_cmdline�hasattrrl �print�_setup_logging�_set_directories� in_container�osr$ �soslog�debugr8 � chroot_modes�error�logging�shutdown�
tempfile_utilr9 �_exit�_check_container_runtime�_get_namespaces�_get_hardware_devices)�self�parser�argsrn �msg�� __class__r) r* rr � sZ �
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� |jd4d5d6d0d7td8g d3� |jd9d:dd;d<d� |jd=d>dd?dd@d � |jdAddBd(� |jdCddDddEd � |jdFddGtdHdIdJ� |jdKd dLd � |jdMdNd0dOtdPg d3� |jdQddRddSd � |jdTddUddVd � |jdWddXddYdZ� |jd[tdd#d\d%� |jd]d^d0d_td`g d3� |jdadtdbd dc� |jddd ded � |jdfd dgd � |jdhdidjd0dktg dldJ� |jdmg d0dndodp� |jdqg d0drdsdp� |jdtdduddvd � |jdwddxddyd � |jdzddd{d|� |jd}d d~d � |jdd d�d � |jd�d d�d � |jd�d d�d � |jd�d g d��d�d�� |jd�ddd�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�d0g d�d�d�� |jd�d d�d�d�� |jd�ddd�d�d�� |jd�d�d�d�d�� |jd�ddd�d�dp� |jd�d�g d0d�d�� d S )�NzReport Optionsz.These options control how report collects dataz-az --alloptions�
store_truer4 Fz%enable all options for loaded plugins)�action�destrm �helpz
--all-logsr5 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� rm �typer� z--buildr6 z;preserve the temporary directory and do not package resultsz --case-idr7 zspecify case identifier)r� r� r� z-cz--chrootr8 r0 zHchroot executed commands to SYSROOT [auto, always, never] (default=auto)z--container-runtimezLDefault container runtime to use for collections. 'auto' for policy control.)rm r� z--descz
--descriptionr z Description for a new preset)r� r� rm 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--experimentalrA zenable experimental pluginsz-ez--enable-plugins�extendrB zenable these plugins)r� r� r� r� rm z-kz--plugin-optionz
--plugoptsrE z7plugin options in plugname.option=value format (see -l)z--labelz--namerF z"specify an additional report labelz-lz--list-pluginsrG z)list plugins and available plugin optionsz--list-presetsz#display a list of available presetsz--list-profilesrI zBdisplay a list of available profiles and plugins that they includez
--log-sizerJ rK z)limit the size of collected logs (in MiB))r� r� r� rm r� z --namespaceszDlimit number of namespaces to collect output for - 0 means unlimitedz-nz--skip-pluginsrP zdisable these pluginsz --no-reportrR z disable plaintext/HTML reportingz
--no-env-varsrS z$Do not collect environment variablesz
--no-postprocrT zDisable all post-processing)rm r� r� r� z--notez Behaviour notes for new presetz-oz--only-pluginsrW zenable these plugins onlyz--presetzA preset identifier)r� r� r� rm 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-commandsrN z do not execute these commands)rm r� r� r� z --skip-filesrO zdo not collect these filesz--verifyr] z+perform data verification during collectionz--allow-system-changesr^ zJRun commands even if they can change the system (e.g. load kernel modules)z--uploadz+Upload archive to a policy-default location)r� rm r� z --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 �put�postz HTTP method to use for uploading)rm �choicesr� z--upload-no-ssl-verifyz'Disable SSL verification for upload url)rm r� r� z--upload-protocol)r0 �https�ftp�sftpz$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--maskr9 z Obfuscate sensitive information)r� rm r� r� z --domainsr= z$Additional domain names to obfuscatez--disable-parsersr> zCDisable specific parsers, so that those elements are not obfuscated)r� rm r� r� z
--keywordsrC z List of keywords to obfuscatez--keyword-filerD z&Provide a file a keywords to obfuscate)rm r� r� z --no-updaterU z%Do not update the default cleaner mapz
--map-filerL rM z;Provide a previously generated mapping file for obfuscation)r� rm r� z--keep-binary-filesr; zGKeep unprocessable binary files in the archive instead of removing themz --usernamesr_ z List of usernames to obfuscate)�add_argument_group� add_argumentr/ �str�int� add_mutually_exclusive_group)�clsr� �
report_grp�
preset_grp� 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 �td �f � |�d
td� � dddd�}d}|D ]}|jd�||| �dd� qJ|�|� 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 it's 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.aE 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 examplepolicies can alter where the --upload option defaults to or functions.zSee Alsoz>For information on available options for report, see %s and %szsos report --helpzman sos-reportz.The following %s sections may be of interest:
zsos helpz'Information on the plugin design of sosz!Information on a specific $pluginz+How sos operates on different distributions)zreport.pluginszreport.plugins.$plugin�policiesr z {:<36}{}F)r' )� set_title�add_textr� r r- )r� �section�psec�ssec�
help_lines�helpln�lnr) r) r* � display_helpy sH
��� �� �����zSoSReport.display_helpc C s t dtdtf � � d S )Nz
%s
zsosreport (version %s))r� �_r �r� r) r) r* r| � s zSoSReport.print_headerc C s( | � � | �� d�| �� | �� d�| _d S )N)�block�fibre)�storage�network�namespaced_network)�_get_block_devs�_get_fibre_devs�_get_network_devs� _get_network_namespace_devices�devicesr� r) r) r* r� � s � �z SoSReport._get_hardware_devicesc C s� | j jdkrc| j j�� }|dv r i | j_| j�d� d S | jjs,d| }| j�|� d S || jj�� vrJd� dd� | jj�� D ��}t
d||f ��| jj| | jjd < | j�d
| jjd j � d S d S ) 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 )�none�off�diabledz0Disabled all container runtimes per user option.zZWARNING: No container runtimes are active, ignoring option to set default runtime to '%s'
r c s s � | ] }|d kr|V qdS )rm Nr) ��.0�pr) r) r* � <genexpr>� s � �z5SoSReport._check_container_runtime.<locals>.<genexpr>zSCannot use container runtime '%s': no such runtime detected. Available runtimes: %srm z%Set default container runtime to '%s'N) r� r: �lowerro �runtimesr� �info�warn�keys�join� Exception�name)r� �crunr� �validr) r) r* r� � s0 �� � ���z"SoSReport._check_container_runtimec
C sz z g }g d�}|D ]}t j�d| �r |�t�d| �� q |W S ty< } z| j�d| � g W Y d}~S d}~ww )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.
)�fc_host� fc_transport�fc_remote_ports� fc_vportsz
/sys/class/%sz/sys/class/%s/*z#Could not get fibre device list: %sN)r� �path�isdirr� �globr� r� r� )r� �devs�devdirs�devdir�errr) r) r* r� � s ���zSoSReport._get_fibre_devsc
s� zDdd� 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 }~ww )
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/%sr) )r� �dr) r) r* �
<listcomp>� s z-SoSReport._get_block_devs.<locals>.<listcomp>z
/sys/blockzlosetup --all --noheadings�statusr �output�:r c s" g | ]
}|� d �r|� vr|�qS )�loop��
startswith�r� �dev��real_loop_devicesr) r* r� s
�
�z#Could not get block device list: %sN) r� r r �
splitlines�split�replacer �listrv r� r� r� )r� � device_list� loop_devices�loop_dev� loop_device�ghost_loop_devs�dev_listr� r) r� r* r� � s ��zSoSReport._get_block_devsc C s d| � � i| _d S )Nr� )�_get_network_namespacesrQ r� r) r) r* r�
s
�zSoSReport._get_namespacesc
C s� g g g g d�}z,t d| jjd�r|�| �� � |d s1| j�d� |�| �� � | �� |d< W |S W |S t yN } z| j�
d| � W Y d}~|S d}~ww ) 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�bridge�team�bond�nmcli)rz r zZNetwork devices not enumerated by nmcli. Will attempt to manually compile list of devices.r z'Could not enumerate network devices: %sN) r r� rz �update�_get_nmcli_devsr� r� �
_get_eth_devs�_get_bridge_devsr� r� )r� �_devsr� r) r) r* r� 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 )rQ r
)r� �_nmdevs�nmspr) r) r* r� . s
�z(SoSReport._get_network_namespace_devicesc
C s� i }zBt d�}|d dkr8|d �� dd� D ] }|�� \}}||vr)|g||< n|| �|� |d �|� qtt|d ��|d< W |S ty_ } z| j�d| � W Y d}~|S d}~ww ) 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: %s) r r� r� r r� rv r� r� r� )r� r �_ndevsr� �dname�dtyper� r) r) r* r 9 s" ���zSoSReport._get_nmcli_devsc
s� dg� g }|s� fdd�t d| jj�D �}n?z"d| }t|�}|d dkr7|d �� D ] }|� vr6|�|� q+W n tyT } z| j�d ||f � W Y d
}~nd
}~ww |d d� |D �d d� |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``
�bonding_mastersc s g | ]}|� vr|�qS r) r) r� �� filt_devsr) r* r� ` s ��z+SoSReport._get_eth_devs.<locals>.<listcomp>z/sys/class/netz"ip netns exec %s ls /sys/class/netr� r r� z6Could not determine network namespace '%s' devices: %sNc S � g | ] }|� d �r|�qS )r r� )r� �bdr) r) r* r� s � c S r )�tunr� )r� �tdr) r) r* r� t r )r r r ) r r� rz r r� r r� r� r� )r� � namespace� _eth_devs�_nscmd�_nsout�_nsethr� r) r r* r
M s4
�
����� �zSoSReport._get_eth_devsc C s� g }zt ddd�}W n ty$ } z| j�d| � W Y d}~nd}~ww |d dkr_|d �� d d� D ])}z |�|�� d � W q5 ty^ } z| j�d
||f � W Y d}~q5d}~ww |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: %sNr� r r� rp z)Could not parse device from line '%s': %s)r r� r� r� r� r r� r� )r� �_bridges�_boutr� �_bliner) r) r* r w s( �� ����zSoSReport._get_bridge_devsc C s\ g }t d�}|d dkr,|d �� D ]}|�� s |dd� �� r!q|�|�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� �out_ns�ip_netnsr& r) r) r* r � s z!SoSReport._get_network_namespacesc C s4 | j | j| j| j| j| j| j| jj| j| j | j
d� S )N) �cmddir�logdir�rptdir�tmpdirr� ro rz rl � cmdlineoptsr� rQ ) r, r- r. r/ r� ro rz r� rl r� rQ r� r) r) r* � get_commons� s �zSoSReport.get_commonsc C s
| j �� S �N)r� �newr� r) r) r* �
get_temp_file� �
zSoSReport.get_temp_filec C s4 | j �| jd� | j �| jd� | j �| jd� d S )Ni� )rx �makedirsr, r- r. r� r) r) r* �_make_archive_paths� s z SoSReport._make_archive_pathsc C s d| _ d| _d| _d S )N� sos_commands�sos_logs� sos_reports)r, r- r. r� r) r) r* r� � s
zSoSReport._set_directoriesc C s$ | j jr
| jt_d| _d S d| _d S )NTF)r� r� �
_exceptionr� �
excepthook�
raise_pluginsr� r) r) r* r} � s
zSoSReport._set_debugc C sN t td�s
tj�� st�| ||� dS tj| ||dtjd� t� t �
� dS )z* Wrap exception in debugger if not in tty �ps1� )�limit�fileN) r� r� r� �isatty�__excepthook__� traceback�print_exception�stdoutr� �pdb�pm)�etype�eval_�etracer) r) r* r; � s � zSoSReport._exceptionc C s^ | j s| jr t�� \}}}tj|||tjd� t� t� |� |r+|r-| �
||� d S d S d S )N)rA ) r= � exit_processr� �exc_inforD rE rF r� rG � post_mortem�_log_plugin_exception)r� �plugname�funcrI �val�tbr) r) r* �handle_exception� s
�zSoSReport.handle_exceptionc C sX t | dd �r| jj| jtj�dd�d� t | dd �r*| jj| jtj�dd�d� d S d S )N� sos_log_filer9 �sos.log�r� �sos_ui_log_file�ui.log)�getattrrx �add_filerU r� r� r� rX r� r) r) r* �
_add_sos_logs� s
�
��zSoSReport._add_sos_logsc sT � j j}t� j j�s dS t|d�sdS |r � �|�� �s dS t� fdd�|jD ��S )NTr[ Fc s g | ]}|� j jv �qS r) )r� r[ r� r� r) r* r� � s z,SoSReport._is_in_profile.<locals>.<listcomp>)r� rW r r[ r� �_is_not_specifiedr� �any)r� � plugin_classrW r) r� r* �_is_in_profile� s
zSoSReport._is_in_profilec C s || j jv S r2 )r� rP �r� � plugin_namer) r) r* � _is_skipped� s zSoSReport._is_skippedc C �* || � � ��� o|| jjvo|| jjvS r2 )r1 �
check_enabledr� rB rW �r� rb � pluginClassr) r) r* � _is_inactive� �
�
�zSoSReport._is_inactivec C rd r2 )r1 �default_enabledr� rB rW rf r) r) r* �_is_not_default� ri zSoSReport._is_not_defaultc C s | j jo || j jvS r2 )r� rW ra r) r) r* r] � s
�zSoSReport._is_not_specified�unknownc C s" | j �|�� || �� �|f� d S r2 )rt r r� r1 )r� r_ �reasonr) r) r* �_skip s
�zSoSReport._skipc C s | j �|�� || �� �f� d S r2 )rs r r� r1 )r� r_ r) r) r* �_load
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�|
�\} } z�|| |�}
t |
�sVW q@| j �|
�}||| j
j
d�s~| j�td�|
� | j
jdkr~| �|td�� W q@| j�| � | � |�}|s�| �|td�� W q@| � | �r�| �|td�� W q@| � | |�r�| �|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 } z| j�td �|
|f � | �&� W Y d }~q@d }~ww t | �dk�r>| j�'td �d
�(| � � | �)� | �*d� d S d S )N)rA z%plugin %s does not validate, skippingr zdoes not validate�excluded�skipped�inactive�optionalr[ z
not specifiedz(plugin %s does not install, skipping: %sz+Unknown or inactive profile(s) provided: %sr rp )+�sosrk �plugins�
import_pluginr � get_modules� plugin_namesrv r[ r r� ro �valid_subclassesrA r �ExperimentalPlugin�tuple�validate_pluginr� r� r� �splitext� match_pluginr� �warningr� rl rn r` rc rh rk r� r r] �removero r� rT r� r� rI r� )r� rv �helperru �using_profiles�policy_classes�
extra_classes�valid_plugin_classesr| �remaining_profiles�plug�plugbase�ext�plugin_classesr_ �
in_profile�default_profile�i�er) r) r* � load_plugins s�
�
�
� ��� ��zSoSReport.load_pluginsc C s@ | j jr | jD ]\}}|j�� D ]
}t|jv rd|_qqd S d S )NT)r� r4 rs �options�values�bool�val_type�value)r� rP r� �optr) r) r* �_set_all_options_ s
���zSoSReport._set_all_optionsc C s� | j jr�i }| j jD ]o}z |�d�\}}W n ty d}Y nw t|t�rH|�� }|dv r1d}n|dv r8d}nzt|�}W n tyG Y nw z |�d�\}}W n
ty^ |}d}Y nw z|| W n
tyr i ||< Y nw ||| |< q
| j D ]^\}}||v r�|| D ]N}||j
vr�| j � d||f � | �
d� z|j
| �|| | � | j �d ||j
| f � W q� ty� } z| j � |� | �
d� W Y d }~q�d }~ww ||= q}|�� D ]
}| j � d
| � q�|�� r�| j � d � d S d S d S ) N�=T)�on�enable�enabled�true�yes)r� �disable�disabled�false�noF�.z#no such option "%s" for plugin (%s)rp zSet %s plugin option to %szGWARNING: unable to set option for disabled or non-existing plugin (%s).r )r� rE r� �
ValueError�
isinstancer� r� r� �KeyErrorrs r� r� r� r� � set_valuer� r� r� )r� r� r� rR r� rP r� r) r) r* �
_set_tunablesf sz �
� � �
�
�� ��� ��7zSoSReport._set_tunablesc C s� dd l }|�| jj| jj�D ]}|�d�d }|| jvr)| j�d| � | � d� q| jj
D ]}|| jvr=| j� d| � q.d S )Nr r� z=a non-existing plugin (%s) was specified in the command line.rp z+Requested to skip non-existing plugin '%s'.) � itertools�chainr� rW rB r� rx r� �fatalr� rP r )r� r� �pluginrb r) r) r* �_check_for_unknown_plugins� s$
�
�
�
���z$SoSReport._check_for_unknown_pluginsc C s2 | j D ]\}}|jD ] }| j�|j| � q
qd S r2 )rs r� ru r )r� rb r� r� r) r) r* �_set_plugin_options� s
��z SoSReport._set_plugin_optionsc C s� d}g }| j jdkr|d| j j g7 }d| j _| j js$|dg7 }d| j _| j js1|dg7 }d| j _| j jr>|dg7 }d| j _| j jrK|d g7 }d| j _|rW|d
d �|� 7 }n|d 7 }|d
7 }|S )Nz
Estimate-only mode enabledrp z--threads=%s overriden to 1z--build enabledTz--no-postproc enabledz--clean disabledFz--upload* options disabledz", which overrides some options:
z
r� z
)r� �threadsr6 rT r9 r` r� )r� r� �ext_msgr) r) r* �_set_estimate_only� s,
z SoSReport._set_estimate_onlyc C s^ | j �d� t| j�r | j �dt| j�t| j�f � n | j �dt| j� � | j �d� d S )Nr z %d profiles, %d pluginsz %d profiles)�ui_logr� r rs 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 r6| j�td�� | j�d� | j D ]\}}| j�d||�� f � q$n| j�td�� | j�d� | jrk| j�td�� | j�d� | jD ]\}}}| j�d|||�� f � qX| j�d� | j�r| j�td�� | j d d
� � }|D ]=}|| }|j
}|j
d kr�|d kr�| j j p�t
}n
|d
kr�| j jp�t
}nt
}|jdkr�| j j }| j�d|j||jf � q�| j�d� | j�td�� | jD ]:}|jdv r�|j
|jkr�q�t|j
t�r�|j
du r�d} nd} n|j
} | d u r�d } | j�d|jd |j | |jf � q�n| j�td�� | j�d� t| j�}
|
�� td|
dd�} | D ] } | j�d| � �q3| �� d S )Nzno valid plugins foundz,The following plugins are currently enabled:r z %-20s %szNo plugin enabled.z-The following plugins are currently disabled:z %-20s %-14s %sz4The following options are available for ALL plugins:r rp ���r$ � cmd-timeout�postprocz %-25s %-15s %sz+The following plugin options are available:)r$ r� r� Tr� r� r� z No plugin options available.z
Profiles: �r# � %s)rs rt r� r� r� r� r� �get_descriptionru �get_default_plugin_optsr� r� rY r rZ r� rT r< rm r� r� r� r� r[ �sortr+ r� )
r� rP r� � plugclassrm � _defaults�_optr� rR �tmpoptr[ r% r& r) r) r* rG � s~
��
�
��
zSoSReport.list_pluginsc C s� | j s
| j�td�� d S | j�td�� | j�d� dd� }t| j �}|�� |D ]0}g }| jD ]\}}||�rC||j v rC|� |� q1t
d| |dd�}|D ]
}| j�d | � qOq*| � � d S )
Nzno valid profiles foundz%The following profiles are available:r c S s
t | d�S )Nr[ )r� )�cr) r) r* � _has_prof, r5 z*SoSReport.list_profiles.<locals>._has_profz%-15s Tr� r� ) r[ r� r� r� r� r� r� r� rs r r+ r� ) r� r� r[ �profileru r� r� r% r& r) r) r* rI % s&
�� zSoSReport.list_profilesc C s� | j js| j�td�� d S | j�td�� | j�d� | j j�� D ]W}|s'q"| j �|�}| j�dd|j f � | j�dd|j
f � |j rQ| j�dd|j f � | j j
dkrs|j �� }d d
}t||d d d
�}|D ]}| j�|� qj| j�d� q"d S )Nzno valid presets foundz$The following presets are available:r z%14s %szname:z description:znote:r z%14s zoptions:Tr )r# r$ )ro �presetsr� r� r� r� r� r� r� r� r< rV r� rl �to_argsr+ )r� rX r� � options_strr% r& r) r) r* rH ; s*
�zSoSReport.list_presetsc
C s� | j }|�|�r| j�d| � dS |p| jj}|p | jj}z |j|||| jd� W n tyE } z| j�d| � W Y d}~dS d}~ww | j �
d�}| j d|� | j |d d� }| j� d |d
� |�f � d S ) 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
z"A preset named '%s' already existsF)r� r< rV r� zCould not add preset: %sNr� r r? z"Added preset '%s' with options %s
r T)
ro r� r� r� r� r< rV rh r� rn �indexr� r� )r� r� r< rV ro r� � arg_indexr� r) r) r* rh S s&
�� �zSoSReport.add_presetc
C s� | j }|�|�s| j�d| � dS z|j|d� W n ty7 } z| j�t|�d � W Y d}~dS d}~ww | j�d| � dS )z�Delete a named command line preset.
:param name: the name of the preset to delete
:returns: True on success or False otherwise
zPreset '%s' not foundF�r� �
NzDeleted preset '%s'
T)ro r� r� r� ri r� r� r� )r� r� ro r� r) r) r* ri p s
��zSoSReport.del_presetc
C s� | j �� }| jjr|| �� 7 }| jjr| j�|� d S |td�7 }zt |� W d S t
y= | j� d� | � d� Y d S t
yU } z
| � d|� W Y d }~d S d }~ww )Nz,Press ENTER to continue, or CTRL-C to quit.
zExiting on user cancel� rp )ro �get_msgr� r@ r� �batchr� r� r� �input�KeyboardInterruptr� r� r� )r� r� r� r) r) r* r� � s
��zSoSReport.batchc C sd t �� }d}d| }tj�| j|�}| j�d|||f � | j�d| � | jj d| |dd� d S )Nz!caught exception in plugin methodz%s-plugin-errors.txtz %s "%s.%s()"zwriting traceback to %s�%s
�a)�mode)
rD �
format_excr� r� r� r- r� r� rx �
add_string)r� r� �method�tracer� �plugin_err_log�logpathr) r) r* rO � s z SoSReport._log_plugin_exceptionc
C s� | j �� z| j�td�� | �� | �� W d S ttfyH } z"|j t
v r7t d� t d|j � t d� nt d| � � W Y d }~n,d }~w t
yo } z | j�d� | j�d� t�� | j�|� W Y d }~nd }~ww | �d� d S )Nz Setting up archive ...r z %s while setting up archivez Error setting up archive: %sz) Unexpected exception setting up archive:rp )ro �pre_workr� r� r� �
setup_archiver7 �OSError�IOError�errno�fatal_fs_errorsr� �strerrorr� r� rD � print_excr� �r� r� r) r) r* �prework� s.
�� ��zSoSReport.preworkc C sZ | j �td�� | jD ]�\}}zM| jj�|� |�t| jj|�� t �
� }|j � d|� | j
|_
|�� |�� | j�|j� | jjrG|�� t �
� }|j � d|� |j � d|| � W q tyd � ttfy� } z+|jtv r�| j �d� | j �d|j � | j �d� | � d� | � |d� W Y d }~q d }~w t y� | � |d� Y q w d S ) Nz Setting up plugins ...� setup_start� setup_end�
setup_timer z %s while setting up pluginsrp �setup) r� r� r� rs r� ru r� �set_plugin_manifestrZ r �nowr� � add_fieldrx �add_default_collectionsr� rw r � _env_varsr� r] � setup_verifyr� r� r� r� r� r� r� r� rT r� )r� rP r� �start�endr� r) r) r* r� � sD �
�
� ��zSoSReport.setupc C s, g }|� dt � | jjd�|�dd� dS )zWFetch version information from all plugins and store in the report
version filez
sosreport: %sr� z version.txt)�contentr� N)r r rx r� r� )r� �versionsr) r) r* �version� s
�zSoSReport.versionc C s� | j �td�� | j �d� d}g | _g | _| jD ]}|d7 }| j�||d f� qz:g }t| jj ��}|�
| j t | j��}W d � n1 sHw Y |D ] }|s[| j
�d| � qO| j �d� W d S tyy | j �d� t�d� Y d S w )Nz! Running plugins. Please wait ...r r rp z!Unexpected plugin task result: %sz
Exiting on user cancel
)r� r� r� �pluglist�
running_plugsrs r r r� r� �map�_collect_pluginr� r� r� r� r� r� r� )r� � plugruncountr� �results�executor�resr) r) r* �collect� s4
� ��� �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 }| j � d | � | j
�|� | j�|d � | j|d d d �� |jd
d � |j�� Y nw W d � n1 s�w Y | jjr�dd lm} | | j�� �}
td
d� |
� d�D ��| j |d < t � | j�� �D ]"} t j �!| j�� | �} t j �"| �r�t j �#| �s�t$| � q�t �%| � q�d
S )zaWraps the collect_plugin() method so we can apply a timeout
against the plugin as a wholerp r N�
start_timer# �end_time�run_timezPlugin %s timed outz
%s
T)�wait��Pathc S � g | ]}|� � j�qS r) ��lstat�st_size�r� �fr) r) r* r� � z-SoSReport._collect_plugin.<locals>.<listcomp>�**/*)&r rs �submit�collect_pluginr$ r r� r� r� �resultr r� r� r� r� r� r� �set_timeout_hitr� �_threads�clearr� r@ �pathlibr� rx � get_tmp_dir�sumr� r{ r� r r� r� r� �islinkr
�unlink) r� r� �pool�_plug�tr$ r� r� r� r� � tmpdir_pathr r) r) r* r� � sD
�� � �
zSoSReport._collect_pluginc
C s� z|\}}| j |d d }| j�|� W n
ty Y dS w t| j �}dd||f |dd�dd� | jD �� f }| �|� z^|�� z| j� |� W n t
yV Y nw z| j� |� W n t
yh Y nw d }t| j�t | j j
�kr�| jr�d
ddd�d d� | jD �� f }| js�| js�d }|r�| �|� W d S W d S ty� Y d S ttfy� } z)|jtv r�| j�d
|j � | j�d| j � t�d� | �|d� W Y d }~d S d }~w ty� | �|d� Y d S w )Nrp Fz Starting %-5s %-15s %sz%d/%dz
[Running: %s]r c s � � | ]}|V qd S r2 r) r� r) r) r* r� / � � z+SoSReport.collect_plugin.<locals>.<genexpr>r z Finishing plugins %-12s %sc s r r2 r) r� r) r) r* r� D r z
Finished running pluginsz!
%s while collecting plugin dataz& Data collected still available at %s
r� )rs r� r r� r r� � ui_progressr� r� r� r� r� r� r� r r� r� r� r� r� r� r� r/ r� r� rT ) r� r� �countrP r� �numplugs� status_liner� r� r) r) r* r $ sn �
�
� ��� �
��
� �zSoSReport.collect_pluginc C sR | j jdkr| j jsd|�d� }nd| }| j js'tj�|� tj�� d S d S )Nr z
%s�Z r� ) r� rl r� �ljust�quietr� rF r� �flush)r� r r) r) r* r Y s �zSoSReport.ui_progressc C s@ | j sd S d�dd� dd� | j D �D ��d }| j�|d� d S )Nr� c S s g | ]
\}}d ||f �qS )z%s=%sr) )r� r� rR r) r) r* r� e s �z.SoSReport.collect_env_vars.<locals>.<listcomp>c S s0 g | ]}t j�|�d ur|dt j�|� f�qS )Nz%s)r� �environ�get)r� r� r) r) r* r� g s �� environment)rw r� rx r� )r� �envr) r) r* �collect_env_varsb s
��zSoSReport.collect_env_varsc
C s� t � }| jD ]p\}}t|d�}|jD ] }|�t|�� q|jr'|�t|j�� |jD ]}|�t |d d|d d�� q*|j
D ]}|�t |d dt j
�d| �� d |d �d
�� q?|jD ]\}}} |�t|t j
�d|�d�� q]|�|� qtd d ftd
dftddff}
|
D ]d\} } }
z*| �� }| |��� }|�dd��� }|�|� |�� | jj |t j
�d| �d� W q� t t fy� } z'|j t v r�| j!�"d� | j!�"d|j#|
f � | j!�"d� | �$d� W Y d }~q�d }~ww d S )Nr� �srcpathz..�dstpath)r� �href�cmdr r, rA )r� � return_coder& zsos.txt�textzsos.json�JSONzsos.html�HTMLzutf-8r� r: rW r z %s while writing %s reportrp )%r rs r �alerts�addr � custom_textr � copied_filesr �executed_commandsr r� r� r� r1 � copy_stringsr r r r r4 �unicode�encode�decoder� r rx r[ r� r� r� r� r� r� r� r� )r� rk rP r� r� �alertr r' r� �tags�
formatlist�class_�filename�type_�fdr� r� r) r) r* �generate_reportsl sb
�
�
�
� �
�
�
���zSoSReport.generate_reportsc C s� | j D ]_\}}z|�d�r|�� n| j�d| � W q ttfyT } z+|jtv rD| j �
d� | j �
d|j � | j �
d� | � d� | �
|d� W Y d }~qd }~w tyb | �
|d� Y qw d S )Nr� z Skipping postproc for plugin %sr z% %s while post-processing plugin datarp )rs �
get_optionr� r� r� r� r� r� r� r� r� r� r� rT r� )r� rP r� r� r) r) r* r� � s,
��
�
� ��zSoSReport.postprocc C sr |sdS z$d}t |d�}t�|�} |�|�}|sn|�|� q|�� W |�� S ty8 | �� Y |�� S w )NFi �rb) �open�hashlibr3 �readr �closer� rT � hexdigest)r� rx � hash_name� hash_size�
archive_fp�digest�hashdatar) r) r* �_create_checksum� s$
�
�
�zSoSReport._create_checksumc C s0 t |d | d�}|r|�|d � |�� d S )Nr� �wr� )r? r� rB )r� rx rD �checksum�fpr) r) r* �_write_checksum� s zSoSReport._write_checksumc
s d }d }d }d}| j jrLz%| j| j| j| j | jd�}td|d�}|�| j� � � |�
� \}}d}W n t yK } zt t
d| �� W Y d }~nd }~ww | �� | jd ur]| j�| j j� |r�tj�| j| jj�} |jtj�| dd�dd� |jtj�| dd �d d� |jtj�| d
d �d d� | j j�rd d
lm� d dlm}
|
| j�} tdd� | � 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 � | j j#�s�t�$d �}| j j%�st t
d �� zgz|�r"| j�&|� | j�'| j j�}W nL t(t)f�ya } z't d � t t
d!|j*| j� � f �� t d � |j+t,v �rW| �-d"� W Y d }~nd }~w t �yw | j j.�rn� Y W t�$|� dS w W t�$|� nQt�$|� w | j j/�s�| j j0�r�| j �1d#� | j� � }tj�2|�}ztj�| j|�}|�r�|�3|�}t�4||� |}W n t(t)f�y� t t
d$| �� Y dS w d }| j j#�s�|�s�t d%� n�z
| j�5� }| �6||�}W n t �y� t t
d&�� Y dS w z | �7|||� W n t(t)f�y t t
d'| �� Y nw tj�| jtj�2|��}|�r4|�3|�8d(d)��}t�9|�}|d* | }|d* | }z
t�4||� |}W n t(t)f�yd t t
d+| �� Y dS w zt�4||� W n t(t)f�y� t t
d,| �� Y nw | j j#�s�| jj:|||||d-� n
| jj:||||d-� | j j;�s�| j j<�r�| j j#�s�z| j�=|� | j � t
d.�� W n# t �y� } z| j �>d/| � W Y d }~n
d }~ww d0}| j �>|� t?�@� | jA�r�| jA�� | j�r�tj�B| j��r�tC| j� dS )1NF)ro r/ �sys_tmpr� r� T)�in_place� hook_commonsz%ERROR: Unable to obfuscate report: %sr9 rV )�
short_namerY r: z
manifest.jsonr ��get_human_readabler� c S r� r) r� r r) r) r* r� r z(SoSReport.final_work.<locals>.<listcomp>r �sos_logs_reportszPEstimated disk space requirement for whole uncompressed sos report directory: %sc S s | d S )Nrp r) )�xr) r) r* �<lambda> s z&SoSReport.final_work.<locals>.<lambda>)�key�reverse� z, c 3 s( � | ]\}}d |� |dd�f V qdS )z%s: %sr )� precisionNr) )r� r� �vrR r) r* r� s � � �z'SoSReport.final_work.<locals>.<genexpr>zFive biggest plugins: %sr 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...z %s while finalizing archive %srp zQ
Unable to encrypt when using --build. Encryption is only available for archives.zError moving directory: %sz Creating archive tarball failed.z:Error generating archive checksum after archive creation.
z#Error writing checksum for file: %sz.tarz-obfuscated.tarr� z Error moving archive file: %sz Error moving checksum file: %s)rL z Uploaded archive successfullyzUpload attempt failed: %szEUnable to upload archive when using --build as no archive is created.)Dr� r9 ro r/ rN r� r �set_target_pathrx �get_archive_path�executer� r� r� r\ �add_final_manifest_data�compression_typer� r� r� �_name�obfuscate_filer@ �
sos.utilitiesrS r r� r r� r{ r� r� r� �sortedr" r6 �umaskr �rename_archive_root�finalizer� r� r� r� r� r� r� � encrypt_pass� encrypt_keyr� �basename�obfuscate_string�rename�get_preferred_hash_namerI rM r� �stat�display_resultsr` ra �upload_archiver� r� r� r� r� r
)r� rx � directoryrL �do_cleanrP �cleaner�_pathsr� �_dirr� r �_sum�
bigplugins�bp_out� old_umaskr� �dir_name� final_dirrK rD �
final_name� archivestat� archive_hash�
final_hashr� r) rR r* �
final_work� sD � ��
���
��
���
��
�
��
�
��
�
�
��
� �
��
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� | j �d� | j �
� D ] \}}| j j �||� q*| j �d| jj � | j �d| jj � | j �d� d S )
zgAdd 'global' data to the manifest, that is any information that is
not plugin-specific
rz rX �unsetr[ r� �enabled_plugins�disabled_pluginsru N)
r� r� rz rX r� �add_listr� r[ r� r� r" rB rP )r� rW r� r) r) r* �add_manifest_data� s � zSoSReport.add_manifest_datac C sz d}| j �|tdd�| j�f � | jj�� }dtd| jjd�|�f }| j �|� | j �dtdd�| j�� �f � d S )Nz[%s:%s] executing 'sos %s'r� r z'[%s:%s] using '%s' preset defaults (%s)z![%s:%s] effective options now: %s) r� r� �__name__r� rn rX r� r� r� )r� r� � preset_argsr) r) r* �_merge_preset_options� s �
�z SoSReport._merge_preset_optionsc
C s� z�| j �| �� � | �� | �� | �� | �� | �� | �� | j j
r+| �
� t �| j j r5| � � t �| j j
r?| �
� t �| j jrK| �| j j�W S | j jrW| �| j j�W S | �� s^W dS | �� | �� | �� | �� | �� | j jsz| �� | j js�| �� | j js�| �� n| j � d� | � � | � � W S t y� | j j!r�� t"�#dd �dks�| �$� Y n; t%y� | j �&d� | �$� | �'d� Y n$ t y� } zt"�#dd �dks�| �$� t(�)|j*� W Y d }~nd }~ww | �'d� d S )NFz)Skipping postprocessing of collected data�
SOS_TEST_LOGS�keepz
Exiting on user cancelr� rp )+ro � set_commonsr1 r� r� r� r� r� r� r� rG �
SystemExitrI rH rh ri r� r� r� r� r� r� rS r# rR r< rT r� r� r� r� r� r� r� r� �getenv�cleanupr� r� r� r� �exit�coder� r) r) r* r_ � sl
� ��zSoSReport.executer2 )NN)rl )r r )Hr� �
__module__� __qualname__�__doc__r< �
root_requiredr r� rr � classmethodr� r� r| r� r� r� r� r� r� r� r r
r r r1 r4 r7 r� r} � staticmethodr; rT r\ r` rc rh rk r] rn ro r� r� r� r� r� r� r� rG rI rH rh ri r� rO r� r� r� r� r� r r r# r< r� rI rM r� r� r� r� r_ �
__classcell__r) r) r� r* r3 G s^ �������� �
� � �
��������������� � � � � �!�"�#�$�%�&�'�(�)�*�+�,�-�.�/�0�1�2�3�4� 7?
4
7
*
O;
K
,5
7 Gr3 )Fr )2r� rD r� r� r� r r� �sos.report.pluginsrt rd r r r r r r r �shutilr
r@ �concurrent.futuresr r rG r
r� r �
sos.componentr � sos.policies�sos.report.reportingr r r r r r r r r r � sos.cleanerr �ENOSPC�EROFSr� r+ r/ r� r3 r) r) r) r* �<module> s0
$ 0