Google
Edit File: component.cpython-39.pyc
a G%@i�R � @ 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� d�ZdS )� 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� Zd5dd�Zdd� 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 ZunsetTF�autoz/etc/sos/sos.confN� � r ) �batch�compression_type� config_file�debug�encrypt� encrypt_key� encrypt_pass�quiet�threads�tmp_dir�sysroot� 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 | _z dd l}|�|j | � � � W n8 t y� } z t j �d|� d�� W Y d }~n d }~0 0 t| jd�| _| jr�| �� | j�| j� | �� | _| j�rF| �� }t� | _tj� |�r�t� |tj ��sd|� d�}|d7 }t j �|� | � d � || _!t"j#d | j!d �| _t$| j�| _| �%� | jd u�r�| 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 )NFr z'Notice: Could not set SIGTERM handler: � �� arg_defaultsztemporary directory � z"does not exist or is not writable � zsos.)�prefix�dir�version�cmdlineZ start_timeZend_timer Zrun_time� compression�tmpdirZtmpdir_fs_type�policy� components)/�parser�argsr% � exit_process�archiver' � tempfile_util�manifest�signal�SIGTERM�get_exit_handler� Exception�sys�stdout�writer � _arg_defaults�opts� load_policy�load_local_policy�updater � load_options�configure_logging�get_tmpdir_default� SoSMetadata�os�path�isdir�access�W_OK�stderr�_exitZsys_tmp�tempfileZmkdtempr �_setup_logging� add_fieldr �joinr Znow� tmpfstyper( Zos_release_name� add_section)�selfr* Z parsed_argsZ cmdline_argsr0 �errr' �msg� rP �1/usr/lib/python3.9/site-packages/sos/component.py�__init__R sV * � zSoSComponent.__init__c C s\ z.dd l }|jj| jj| jd�| _| jj| _W n tyJ | �d� Y n0 | j� � | _ d S )Nr )r Z probe_runtime) Z sos.policiesZpolicies�loadr8 r � load_prober( �KeyboardInterruptrF Zis_rootZ_is_root)rM �sosrP rP rQ r: � s � z SoSComponent.load_local_policyc C s t �d S �N��NotImplementedError�rM rP rP rQ �execute� s zSoSComponent.executec s � fdd�}|S )Nc s d� _ � �� d S )NT)r, rF )Zsignum�framerZ rP rQ � exit_handler� s z3SoSComponent.get_exit_handler.<locals>.exit_handlerrP )rM r] rP rZ rQ r2 � s z SoSComponent.get_exit_handlerc C s( |r | j �d� | j �|� t|��d S )Nr )�ui_log�error� SystemExit)rM r_ rO rP rP rQ rF � s zSoSComponent._exitc C sf | j jrtj�| j j�}nt�dd�p0| j�d�}td|� ��� � | _ | j dkrbt d� t � d� |S )z�If --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 Ztmpfsz�WARNING: 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.� )r8 r r@ rA �abspath�getenvr( Z get_tmp_dirr �striprK �print�time�sleep)rM r' rP rP rQ r> � s � z SoSComponent.get_tmpdir_defaultc s6 dd� � j �� �� D �}|r2t� fdd�|D ��S dS )Nc S s g | ]}|� d �r|�qS )�list�� startswith)�.0�orP rP rQ � <listcomp>� � z6SoSComponent.check_listing_options.<locals>.<listcomp>c 3 s | ]}t � j|�V qd S rW )�getattrr8 )rk �optrZ rP rQ � <genexpr>� rn z5SoSComponent.check_listing_options.<locals>.<genexpr>F)r8 �dict�keys�any)rM r8 rP rZ rQ �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 NrX )�clsr* rP rP rQ �add_parser_options� s z SoSComponent.add_parser_optionsc sJ t � j| j�| j�|jdd�d�}|jdd�}|�� D �] \}}||j�� vs6|dg dfv r^q6|dv r�dD ]>}t |�t t ||��@ � � rjt ||� fdd�t ||�D �� qj|d k�r*t ||�}d d� |D �}d d� |D �} t |�t | �@ D ] � � � d ���fd d�|D �}q�t ||t t |�t |�B �� q6||j| kr6t |||� q6|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_filterr Nr )Zenable_pluginsZ skip_pluginsZ only_pluginsc s g | ]}|� vr|�qS rP rP )rk �x)�commonrP rQ rm � s �z;SoSComponent.apply_options_from_cmdline.<locals>.<listcomp>Zplugoptsc S s g | ]}|� d �d �qS ��=r ��split�rk �vrP rP rQ rm � rn c S s g | ]}|� d �d �qS rz r| r~ rP rP rQ rm � rn r{ c s g | ]}|� � �s|�qS rP ri )rk �oopt)�cstringrP rQ rm � s �) r Z from_argsr* � parse_argsr% rr �itemsr rs �setro �setattrrh ) rM r8 ZcmdoptsZcodictrp �valr� Z oplugoptsZvalnamesZ ovalnamesrP )ry r� rQ �apply_options_from_cmdline� s0 � " z'SoSComponent.apply_options_from_cmdlinec C sn t | jd�}| jjD ]}|jtkrd|_q|�| jj| jj � d| j v sRd| j v rb|�| jjd� t � � dkr�t j �t�� d�}t j �|�r�|�|| jj � | �|�}d| _t|d��rj|j| jd k�r | j�|j�| _| j�s tj�d |j� d �� | j�� | _d |_| j�s | j�� | _|j | jj d d � | �|�}t| jj d ��rj| jj j dk�rj| � | jj j � |S )zxCompile arguments loaded from defaults, config files, and the command line into a usable set of options r Nz--cleanz--mask�cleanr z.config/sos/sos.conf�presetzUnknown preset: 'z' T)Z prefer_newr ) r r7 r* �_actions�defaultr Zupdate_from_confr+ r Z componentr% r@ �getuidrA rJ r �home�existsr� r� �hasattrr( Z find_presetr4 rE r6 Z probe_presetZ list_presets�merger8 r �set_loggers_verbosity)rM r8 �optionZuserconfrP rP rQ r< s: �zSoSComponent.load_optionsc C st z4| j r| j �� | jr"| j�� | jr2t| j� W n: tyn } z"td|� d| j� �� W Y d }~n d }~0 0 d S )NzFailed to finish cleanup: z Contents may remain in )r- �cleanupr. r� r' r r3 re )rM rN rP rP rQ r� 9 s �zSoSComponent.cleanupc C sb d}t j�d�r&t j�d�| j_d}n t j�d�rFt j�d�| j_d}| j�|� | j�|� 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@ �environ�getr8 r r �soslog�infor^ )rM rO rP rP rQ �_set_encrypt_from_env_varsG s z'SoSComponent._set_encrypt_from_env_varsc C s� | j js�d }|dvr"td��� }q |dkr8td�| j _q�|dkrNtd�| j _q�|dkr`| �� q�d | j _d | j _| j� d� | j � d � n| �� d S ) N)�P�K�E�NzLSpecify 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) r8 r �input�upperr r r r� r� r� r^ Zwarning)rM Z_encrP rP rQ �_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 dkr�| j� � }||| j | j| j j || j| j�| _n"t|| j | j| j j || j| j�| _| j�| j jdk� d S )N)r �key�passwordr ra )r8 r r� r r r( Zget_archive_namer@ rA rJ r' r Zget_preferred_archiver r r/ r- r Z set_debugr )rM �nameZenc_opts� archive_nameZ auto_archiverP rP rQ � setup_archivek s, � � �zSoSComponent.setup_archivec C sV | j �� }| jD ]@}t|��|�D ],}tj�||�}dD ]}| j �||d� q8q"qd S )N)z(--upload-pass[\s=]+)\S+z$(--upload-url[\s=]+\S+://.*:)([^@]*)z!(--upload-s3-secret-key[\s=]+)\S+z \1********) r- Zget_archive_path�files_with_upload_passwdr �globr@ rA �relpathZ do_file_sub)rM Z _arc_pathrA �f�rerP rP rQ �_obfuscate_upload_passwords� s z(SoSComponent._obfuscate_upload_passwordsc C sJ t �tj�}|�t �d�� |�| jjdkr2t j nt j � | j � |� d S )N� %(message)sr! ) �logging� StreamHandlerr4 r5 � setFormatter� Formatter�setLevelr8 r �DEBUG�INFOr^ � addHandler)rM Z ui_consolerP rP rQ �add_ui_log_to_stdout� s �z!SoSComponent.add_ui_log_to_stdoutc C s\ t | dd �r |r | j�tj� t | dd �rX|rJ| jjdkrJ| j�tj� n| j�tj� d S )N�flog�consoler! ) ro r� r� r� r� r8 r r� ZWARNING)rM r rP rP rQ r� � s z"SoSComponent.set_loggers_verbosityc C sh t �d�| _| j�t j� d| _| �� sn| �� | _t � | j�| _| j� t � d�� | j�t j � | j� | j� | jjs�t � tj�| _| j� t � d�� | �| jj� | j� | j� n4t � tj�}|� t � d�� |�t j� | j� |� t �d�| _| j�| jjdk�rt jnt j � | �� �sR| �� | _t � | j�}|� t � d�� | j� |� | jj�sd| �� dS )z�Creates 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. rV Nz&%(asctime)s %(levelname)s: %(message)sr� Zsos_uir! )r� Z getLoggerr� r� r� r� ru � get_temp_fileZ sos_log_filer� r� r� r� r� r8 r r4 r5 r� r� r rE ZERRORr^ Zsos_ui_log_filer� )rM Z console_errZ ui_fhandlerrP rP rQ rH � sB � � � zSoSComponent._setup_loggingc C s | j �� S rW )r. �newrZ rP rP rQ r� � s zSoSComponent.get_temp_filec C s0 d}d}|� � D ]}|t||dd� d }q|S )N�P r F)Zreplace_whitespacer )� splitlinesr )rM rO �widthZ_fmt�linerP rP rQ �_fmt_msg� s zSoSComponent._fmt_msg)r N)r )!�__name__� __module__� __qualname__�__doc__Zdescr r= r9 rT Z root_requiredr7 r� rR r: r[ r2 rF r> ru � classmethodrw r� r< r� r� r� r� r� r� r� rH r� r� rP rP rP rQ r sT �8 <3 .r c @ sV e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z g fdd�Z ddd�Z 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 rW ��_valuesrZ rP rP rQ rR � s zSoSMetadata.__init__c c s | j �� D ]}|d V q d S )Nr! )r� r� �rM �itemrP rP rQ �__iter__� s zSoSMetadata.__iter__c C s | j | S rW r� r� rP rP rQ � __getitem__� s zSoSMetadata.__getitem__c C s | j | S rW r� )rM �attrrP rP rQ � __getattr__� s zSoSMetadata.__getattr__c C s || j |< dS )z@Add a key, value entry to the current metadata instance Nr� )rM � field_name�contentrP rP rQ rI � s zSoSMetadata.add_fieldc C s t � | j|< | j| S )zCAdds a new instance of SoSMetadata to the current instance )r? r� )rM Z section_namerP rP rQ rL � s zSoSMetadata.add_sectionc C s t |t�std��|| j|< dS )z�Add 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)� isinstancerh � TypeErrorr� )rM Z list_namer� rP rP rQ �add_list s zSoSMetadata.add_listNc C s t j| dd� |d�S )z�Convert 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� )ro �str)rl rP rP rQ �<lambda> rn z&SoSMetadata.get_json.<locals>.<lambda>)r� �indent)�json�dumps)rM r� rP rP rQ �get_json s �zSoSMetadata.get_json)N) r� r� r� r� rR r� r� r� rI rL r� r� rP rP rP rQ r? � s r? )r� r� r@ rG r4 rf �textwrapr �argparser r r �shutilr �pathlibr rV r Z sos.archiver Z sos.optionsr Z sos.utilitiesr r r r? rP rP rP rQ �<module> s( D