File: //usr/lib/python3/dist-packages/sos/report/plugins/__pycache__/__init__.cpython-310.pyc
o
���b| � @ s� d Z ddlmZmZmZmZmZmZmZm Z m
Z
m Z m Z m
Z
mZmZmZmZ ddlmZ ddlZddlZddlZddlZddlmZ ddlZddlZddlZddl Z ddl m Z dd� Z d d
� Z d d � Z e�!d
ej"�Z#dZ$G dd� de%�Z&G dd� de%�Z'G dd� d�Z(G dd� d�Z)G dd� d�Z*G dd� de*�Z+G dd � d e*�Z,G d d � d e*�Z-G d d � d e*�Z.G d!d"� d"e*�Z/G d#d$� d$e*�Z0G d%d&� d&e*�Z1G d'd(� d(e*�Z2G d)d*� d*e+�Z3d-d+d,�Z4dS ).z; This exports methods available for use by plugins for sos � )�sos_get_command_output�
import_module�grep�fileobj�tail�
is_executable�TIMEOUT_DEFAULT� path_exists�
path_isdir� path_isfile� path_islink�listdir� path_join�bold�file_is_binary� recursive_dict_values_by_key)�P_FILEN)�time)�datetimec C s\ z"t |��}t�| |�� tj�W d � W S 1 sw Y W dS ty- g Y S w )z=Return a list of all non overlapping matches in the string(s)N)r �re�findall�read� MULTILINE�AttributeError)�regex�fname�f� r �=/usr/lib/python3/dist-packages/sos/report/plugins/__init__.py�
regex_findall! s
(� �r c C s@ t �dd| �}t �dd|�}t �dd|��d�}|d|� }|S ) Nz^/(usr/|)(bin|sbin)/� z [^\w\-\.\/]+�_�/�.z ._-r )r �sub�strip)�command�name_max� manglednamer r r �_mangle_command* s
r) c C sL t jdft jdft jdft jdfg}|D ]}|d | j�r#|d S qdS )z� return a string indicating the type of special node represented by
the stat buffer st (block, character, fifo, socket).
z block devicezcharacter devicez
named pipe�socketr � N)�stat�S_ISBLK�S_ISCHR�S_ISFIFO�S_ISSOCK�st_mode)�st�_types�tr r r �
_node_type2 s � ��r5 z-*BEGIN.*?-*ENDz
-----SCRUBBEDc @ s� e Zd ZdZdZdZg Zg Zg Zg Z g Z
d%dd�Z dd� Z d d
� Z
d d � Zd
d� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd � Zd d � Zd d � Zd!d"� Zdg g g g g i fd#d$�ZdS )&� SoSPredicatea� A class to implement collection predicates.
A predicate gates the collection of data by an sos plugin. For any
`add_cmd_output()`, `add_copy_spec()` or `add_journal()` call, the
passed predicate will be evaulated and collection will proceed if
the result is `True`, and not otherwise.
Predicates may be used to control conditional data collection
without the need for explicit conditional blocks in plugins.
:param owner: The ``Plugin`` object creating the predicate
:type owner: ``Plugin``
:param dry_run: Is sos running in dry_run mode?
:type dry_run: ``bool``
:param kmods: Kernel module name(s) to check presence of
:type kmods: ``list``, or ``str`` of single name
:param services: Service name(s) to check if running
:type services: ``list``, or ``str`` of single name
:param packages: Package name(s) to check presence of
:type packages: ``list``, or ``str`` of single name
:param cmd_outputs: Command to run, with output string to check
:type cmd_outputs: ``list`` of ``dict``s, or single ``dict`` taking form
{'cmd': <command to run>,
'output': <string that output should contain>}
:param arch: Architecture(s) that the local system is matched
against
:type arch: ``list``, or ``str`` of single architecture
:param required: For each parameter provided, should the checks
require all items, no items, or any items provided
:type required: ``dict``, with keys matching parameter names and values
being either 'any', 'all', or 'none. Default 'any'.
NFr c
s d� d| j }| j}|r� fdd�|D �n|}|dd�|� 7 }| j}|r.� fdd�|D �n|}|dd�|� 7 }| j}|rG� fd d�|D �n|}|d
d�|� 7 }� fd d�| jD �}|d d�|� 7 }| j} |rs� fd
d�| D �n| } |dd�| � 7 }|| | S )zxReturn a string representation of this SoSPredicate with
optional prefix, suffix and value quoting.
z"%s"z dry_run=%s, c � g | ]}� | �qS r r )�.0�k��quotesr r �
<listcomp>� � z&SoSPredicate.__str.<locals>.<listcomp>z kmods=[%s], �,c r7 r r �r8 �sr: r r r< � r= zservices=[%s], c r7 r r �r8 �pr: r r r< � r= zpackages=[%s], c s4 g | ]}d � d � |d � d � |d f �qS )z{ %s: %s, %s: %s }�cmd�outputr )r8 � cmdoutputr: r r r< � s �
��zcmdoutputs=[%s], c r7 r r )r8 �ar: r r r< � r= z arches=[%s])�dry_run�kmods�join�services�packages� cmd_outputs�arch)
�self�quote�prefix�suffix�pstrrH rJ �pkgs�
cmdoutputs�archesr r: r �__str� s&
� zSoSPredicate.__strc C � | � � S )z�Return a string representation of this SoSPredicate.
"dry_run=False, kmods=[], services=[], cmdoutputs=[]"
��_SoSPredicate__str�rN r r r �__str__� s zSoSPredicate.__str__c C s | j dddd�S )z�Return a machine readable string representation of this
SoSPredicate.
"SoSPredicate(dry_run=False, kmods=[], services=[], cmdoutputs=[])"
Tz
SoSPredicate(�))rO rP rQ rX rZ r r r �__repr__� s zSoSPredicate.__repr__c C s6 |dkrt |�S |dkrt|�S |dkrt |� S dS )z�Helper to simplify checking the state of the predicate's evaluations
against the setting of the required state of that evaluation
�any�all�noneN)r^ r_ )rN �items�requiredr r r �_check_required_state� s
�z"SoSPredicate._check_required_statec C s: | j | }|dkr| j| �|� dS | j| �|� dS )z�Helper to direct failed predicates to provide the proper messaging
based on the required check type
:param test: The type of check we're doing, e.g. kmods, arch
:param item: The string of what failed
r` N)rb �_failed�append�
_forbidden)rN �test�item�_reqr r r �_failed_or_forbidden� s
z!SoSPredicate._failed_or_forbiddenc C s^ | j r | j�d�r dS g }| j D ]}| j�|�}|�|� |s%| �d|� q| �|| jd �S )N�allow_system_changesTrH )rH �_owner�
get_option�is_module_loadedre rj rc rb )rN �_kmods�kmod�resr r r � _eval_kmods� s
�zSoSPredicate._eval_kmodsc C �R | j sdS g }| j D ]}| j�|�}|�|� |s | �d|� q
| �|| jd �S )NTrJ )rJ rl �is_service_runningre rj rc rb )rN �_svcs�svcrq r r r �_eval_services� �
�zSoSPredicate._eval_servicesc C rs )NTrK )rK rl � is_installedre rj rc rb )rN �_pkgs�pkgrq r r r �_eval_packages� rx zSoSPredicate._eval_packagesc C sX d|vsd|vr
dS t |d �}|d dkrdS |d �� D ] }|d |v r) dS q dS )z*Does 'cmd' output contain string 'output'?rC rD F�statusr T�r �
splitlines)rN �
cmd_output�result�liner r r �_eval_cmd_output� s �z SoSPredicate._eval_cmd_outputc C s` | j sdS g }| j D ] }| �|�}|�|� |s&| �dd|d |d f � q
| �|| jd �S )NTrL z%s: %srC rD )rL r� re rj rc rb )rN �_cmdsrC rq r r r �_eval_cmd_outputs� s
��z SoSPredicate._eval_cmd_outputsc C s| | j sdS | jj�� }dd�| j � }| jd dkr,t�||�r*| jd � |� dS dS t�||�r4dS | j
d � |� dS )NT�(?:%s)�|rM r` � architectureF) rM rl �policy�get_archrI rb r �matchrf re rd )rN �_archr r r r �
_eval_arch s zSoSPredicate._eval_archc C �N d}d}| j �� D ]\}}|sq t|�}|||d�dd� |D ��f 7 }q |S )z\Return a string informing user what caused the predicate to fail
evaluation
r zrequired %s missing: %s.�, c s � � | ]}|V qd S �Nr �r8 �vr r r � <genexpr>+ � � z.SoSPredicate._report_failed.<locals>.<genexpr>)rd ra �setrI �rN �msg�_substr�key�valr r r �_report_failed! � "zSoSPredicate._report_failedc C r� )zxReturn a string informing the user that a forbidden condition exists
which caused the predicate to fail
r zforbidden %s '%s' found.r� c s r� r� r r� r r r r� 8 r� z1SoSPredicate._report_forbidden.<locals>.<genexpr>)rf ra r� rI r� r r r �_report_forbidden. r� z SoSPredicate._report_forbiddenc C s* | � � | �� | jr dndg}d�|��� S )z}Used by `Plugin()` to obtain the error string based on if the reason
was a failed check or a forbidden check
z (dry run)r � )r� r� rG rI �lstrip�rN r� r r r �report_failure; s
�zSoSPredicate.report_failurec C sT t | j| j| j| j| j| jg�sdS | �� o)| �� o)| � � o)| �
� o)| � � o)| j S )z#Predicate evaluation hook.
T) r^ rH rJ rK rL rM rG rr rw r| r� r� rZ r r r �__bool__F s �����zSoSPredicate.__bool__c s� |�_ t|��_t|��_t|��_t|��_t|t�s |g}|�_|�j jd j B �_ dddddd��_
�j
� � �fdd�� � � D �� g g g g g d��_
g g g g g d��_dS )z-Initialise a new SoSPredicate object
� cmdlineoptsr^ )rH rJ rK rL rM c s( i | ]\}}� | �j | kr||�qS r )rb )r8 r9 r� �rb rN r r �
<dictcomp>c s ��z)SoSPredicate.__init__.<locals>.<dictcomp>)rH rJ rK rL r� N)rl �listrH rJ rK rM �
isinstancerL �commonsrG rb �updatera rd rf ) rN �ownerrG rH rJ rK rL rM rb r r� r �__init__T s*
��� �zSoSPredicate.__init__)Fr r )�__name__�
__module__� __qualname__�__doc__rl rG rH rJ rK rL rM rY r[ r] rc rj rr rw r| r� r� r� r� r� r� r� r� r r r r r6 E s6 (
"
�r6 c @ s e Zd ZdZdd� Zdd� ZdS )�
SoSCommanda� A class to represent a command to be collected.
A SoSCommand() object is instantiated for each command handed to an
_add_cmd_output() call, so that we no longer need to pass around a very
long tuple to handle the parameters.
Any option supported by _add_cmd_output() is passed to the SoSCommand
object and converted to an attribute. SoSCommand.__dict__ is then passed to
_get_command_output_now() for each command to be collected.
c K � | j �|� d S r� )�__dict__r� )rN �kwargsr r r r� ~ � zSoSCommand.__init__c C s d� dd� t| j�� �D ��S )zIReturn a human readable string representation of this SoSCommand
r� c s s � | ] \}}d ||f V qdS )z%s=%rNr )r8 �paramr� r r r r� � � � z%SoSCommand.__str__.<locals>.<genexpr>)rI �sortedr� ra rZ r r r r[ � s
�zSoSCommand.__str__N)r� r� r� r� r� r[ r r r r r� r s r� c @ sX e Zd ZdZdZdZdZdZdZdZ dgZ
dZ ddd�Z dd � Z
d
d � Zd d
� ZdS )� PluginOptaV This is used to define options available to plugins. Plugins will need
to define options alongside their distro-specific classes in order to add
support for user-controlled changes in Plugin behavior.
:param name: The name of the plugin option
:type name: ``str``
:param default: The default value of the option
:type default: Any
:param desc: A short description of the effect of the option
:type desc: ``str``
:param long_desc: A detailed description of the option. Will be used by
`sos info`
:type long_desc: ``str``
:param val_type: The type of object the option accepts for values. If
not provided, auto-detect from the type of ``default``
:type val_type: A single type or a ``list`` of types
r NF� undefinedc C sL || _ || _|| _|| _| j| _|d ur t|t�s |g}n|jg}|| _d S r� ) �name�default�desc� long_desc�valuer� r� � __class__�val_type)rN r� r� r� r� r� r r r r� � s
�
zPluginOpt.__init__c C s6 d| j d| j d| j d| j g}dd�|� d S )Nzname=%sz desc='%s'zvalue=%sz
default=%s�(r� r\ )r� r� r� r� rI )rN ra r r r r[ � s �zPluginOpt.__str__c C rW r� )r[ rZ r r r r] � s zPluginOpt.__repr__c s� t d�| jv rt� �| _d S t� fdd�| jD ��sYg }| jD ]'}|d u r&q |jdkr1|�d� q |jdkr<|�d� q |jdkrF|�d � q td
| j| j d �
|�t � �jf ��� | _d S ) Nr c s g | ]}t � �|k�qS r )�type)r8 �_t�r� r r r< � � z'PluginOpt.set_value.<locals>.<listcomp>�boolz boolean true/false (on/off, etc)�strzstring (no spaces)�intzinteger valuesz&Plugin option '%s.%s' takes %s, not %sr� ) r� r� r� r� r^ r� re � Exception�pluginr� rI )rN r� �validr4 r r� r � set_value� s,
���
zPluginOpt.set_value)r� Nr r N)r� r� r� r� r� r� �enabledr� r� r� r� r� r� r[ r] r� r r r r r� � s
� r� c @ s� e Zd ZdZdZdZdZdZdZdZ dZ
dZ dZ dZ
dZeZeZdZi Zi Zg ZdZdZdd� Zdd � Zd
d � Zd d
� Zdd� Z d�dd�Z dd� Z e dd� �Z e dd� �Z!dd� Z"dd� Z#e$d d � �Z%e$d d � �Z&e$d d!� �Z'e$d"d#� �Z(d$d%� Z)d&d'� Z*d(d)� Z+d*d+� Z,d,d-� Z-d.d/� Z.d0d1� Z/d2d3� Z0d4d5� Z1d6d7� Z2d8d9� Z3d:d;� Z4d<d=� Z5d>d?� Z6d@dA� Z7dBdC� Z8dDdE� Z9d�dFdG�Z:d�dHdI�Z;d�dJdK�Z<d�dMdN�Z=dOdP� Z>d�dQdR�Z?dSdT� Z@dUdV� ZAdWdX� ZBdYdZ� ZCd[d\� ZDd]d^� ZEd_d`� ZFdadb� ZGdcdd� ZHdedf� ZId�dgdh�ZJdidj� ZKdkdl� ZLd�dndo�ZMdpdq� ZNdrds� ZOdtdu� ZPdvdw� ZQdddxdg dfdydz�ZRdddxddddg g g d{df d|d}�ZSdddxddddg d{df
d~d�ZTd�d�� ZUddddxdxddddddddg d{dddfd�d��ZVd�d�� ZWd�d�� ZXd�d�d��ZYd�d�� ZZd�d�� Z[d�d�d��Z\d�d�� Z]ddg fd�d��Z^ddddxdxdddddddg d{dddfd�d��Z_ddddxdxddddddddg fd�d��Z` x d�d�d��Zad�d�� Zbd�d�� Zcd�d�d��Zdd�d�� Zed�d�d��Zfd�d�� Zgd�d�d��Zhd�d�d��Zid�d�d��Zjd�d�d��Zkd�d�d��Zld�d�� Zmd�d�� Znd�d�� Zod�d�� Zp {d�d�d��Zqd�d�� Zrd�d�� Zsd�d�� Ztd�d�� Zud�dÄ Zvd�dń Zwd�dDŽ Zxd�dɄ Zyd�d˄ Zzd�d̈́ Z{d�dτ Z|d�dф Z}d�dӄ Z~d�dՄ Zd�dׄ Z�d�dل Z�d�dۄ Z�d�d݄ Z�d�d߄ Z�d�d� Z�d�d� Z�d�d� Z�d�d� Z�d�d�d�Z�d�d�d�Z�dS )��Plugina\ This is the base class for sosreport plugins. Plugins should subclass
this and set the class variables where applicable.
:param commons: A set of information that is shared internally so that
plugins may access the same dataset. This is provided
automatically by sos
:type commons: ``dict``
Each `Plugin()` subclass should also subclass at least one tagging class,
e.g. ``RedHatPlugin``, to support that distribution. If different
distributions require different collections, each distribution should have
its own subclass of the Plugin that also subclasses the tagging class for
their respective distributions.
:cvar plugin_name: The name of the plugin, will be returned by `name()`
:vartype plugin_name: ``str``
:cvar packages: Package name(s) that, if installed, enable this plugin
:vartype packages: ``tuple``
:cvar files: File path(s) that, if present, enable this plugin
:vartype files: ``tuple``
:cvar commands: Executables that, if present, enable this plugin
:vartype commands: ``tuple``
:cvar kernel_mods: Kernel module(s) that, if loaded, enable this plugin
:vartype kernel_mods: ``tuple``
:cvar services: Service name(s) that, if running, enable this plugin
:vartype services: ``tuple``
:cvar architectures: Architecture(s) this plugin is enabled for. Defaults
to 'none' to enable on all arches.
:vartype architectures: ``tuple``, or ``None``
:cvar profiles: Name(s) of profile(s) this plugin belongs to
:vartype profiles: ``tuple``
:cvar plugin_timeout: Timeout in seconds for this plugin as a whole
:vartype plugin_timeout: ``int``
:cvar cmd_timeout: Timeout in seconds for individual commands
:vartype cmd_timeout: ``int``
Nr r" Fc C s g | _ g | _t� | _g | _d| _|| _g | _t� | _g | _ g | _
g | _ i | _ |d | _
|d | _|d | _d | _|d j| _|d j| _i | _d| jv rQ| jd nt�d�| _| j �| �� � | j D ]
}| �� | j | _qb| jD ]
}| �� |_|| j |j< qp| � t | �� d S )Nr �sysrootr� �devicesr� �soslog�sos) � copied_files�executed_commandsr� � _env_vars�alerts� custom_textr� �forbidden_paths�
copy_paths�container_copy_paths� copy_strings� collect_cmds�optionsr� r� r� �manifest�
skip_files�
skip_commands�default_environment�logging� getLoggerr� r� �get_default_plugin_optsr� r� � option_list�
set_predicater6 )rN r� �popt�optr r r r� s:
�
zPlugin.__init__c C s0 t ddtdd�t ddtdd�t ddtd d�d
�S ) N�timeout���z7Timeout in seconds for plugin to finish all collections)r� r� r� � cmd-timeoutz4Timeout in seconds for individual commands to finish�postprocTz(Enable post-processing of collected data)r� r� r� )r� r� r� rZ r r r r� D s ����z Plugin.get_default_plugin_optsc C s� || _ | j �dd� | j �dd� | j �dd� | j �dd� | j �dd� | j �dd� | j �d| j� | j �d d
� | j �d | j� | j �d g � | j �d
g � | j �di � | j �di � dS )z�Pass in a manifest object to the plugin to write to
:param manifest: The manifest that the plugin will add metadata to
:type manifest: ``SoSManifest``
�
start_timer �end_time�run_time� setup_start� setup_end�
setup_timer� � timeout_hitF�command_timeout�commands�files�strings�
containersN)r� � add_fieldr� �
cmdtimeout�add_list)rN r� r r r �set_plugin_manifestT s zPlugin.set_plugin_manifestc C s, t |t�s td��|| _| �d| j � dS )a
Specify a collection of environment variables that should always be
passed to commands being executed by this plugin.
:param env_vars: The environment variables and their values to set
:type env_vars: ``dict{ENV_VAR_NAME: ENV_VAR_VALUE}``
z:Environment variables for Plugin must be specified by dictz2Default environment for all commands now set to %sN)r� �dict� TypeErrorr� �
_log_debug�rN �env_varsr r r �set_default_cmd_environmentj s
�
�z"Plugin.set_default_cmd_environmentc C s0 t |t�s td��| �d| � | j�|� dS )a-
Add or modify a specific environment variable in the set of default
environment variables used by this Plugin.
:param env_vars: The environment variables to add to the current
set of env vars in use
:type env_vars: ``dict``
z,Environment variables must be added via dictz Adding %s to default environmentN)r� r� r� r r� r� r r r r �add_default_cmd_environmentz s
z"Plugin.add_default_cmd_environmentc C s8 |du r| j S t|t�std��| j �� }|�|� |S )z�
Get the merged set of environment variables for a command about to be
executed by this plugin.
:returns: The set of env vars to use for a command
:rtype: ``dict``
Nz'Command env vars must be passed as dict)r� r� r� r� �copyr� )rN �env�_envr r r �_get_cmd_environment� s
zPlugin._get_cmd_environmentc C s� d}z7| � |�}t| � |��}|du r|}n"|dur*|dkr*|tkr%|}nt|�}n|dur5|dkr5|}nW dS W n tyD | Y S w |durO|dkrO|S |S )a�
Get the timeout value for either the plugin or a command, as
determined by either the value provided via the
plugin.timeout or plugin.cmd-timeout option, the global timeout or
cmd-timeout options, or the default value set by the plugin or the
collection, in that order of precendence.
:param optname: The name of the cmdline option being checked, either
'plugin_timeout' or 'timeout'
:type optname: ``str``
:param plugoptname: The name of the plugin option name being checked,
either 'timeout' or 'cmd-timeout'
:type plugoptname: ``str``
:param default_timeout: The timeout to default to if determination is
inconclusive or hits an error
:type default_timeout: ``int``
:returns: The timeout value in seconds
:rtype: ``int``
Nr� )rm r� r �
ValueError)rN �optname� plugoptname�default_timeout�_timeout� opt_timeout� own_timeoutr r r �timeout_from_options� s(
� �zPlugin.timeout_from_optionsc C � | � dd| j�}|S )z�Returns either the default plugin timeout value, the value as
provided on the commandline via -k plugin.timeout=value, or the value
of the global --plugin-timeout option.
�plugin_timeoutr� )r r )rN r
r r r r� � � �zPlugin.timeoutc C r )z�Returns either the default command timeout value, the value as
provided on the commandline via -k plugin.cmd-timeout=value, or the
value of the global --cmd-timeout option.
� cmd_timeoutr� )r r )rN � _cmdtimeoutr r r r� � r zPlugin.cmdtimeoutc C s* d| _ | j�dt�� � | j�dd� d S )NTr� r� )� _timeout_hitr� r� r �nowrZ r r r �set_timeout_hit� s zPlugin.set_timeout_hitc C � | j S )ax
Checks to see if the plugin has hit its timeout.
This is set when the sos.collect_plugin() method hits a timeout and
terminates the thread. From there, a Popen() call can still continue to
run, and we need to manually terminate it. Thus, check_timeout() should
only be called in sos_get_command_output().
Since sos_get_command_output() is not plugin aware, this method is
handed to that call to use as a polling method, to avoid passing the
entire plugin object.
:returns: ``True`` if timeout has been hit, else ``False``
:rtype: ``bool``
)r rZ r r r �
check_timeout� s zPlugin.check_timeoutc C s | j r| j S | j�� S )zsGet the name of the plugin
:returns: The name of the plugin, in lowercase
:rtype: ``str``
)� plugin_namer� �lower)�clsr r r r� � s
z Plugin.namec C s& | j d u r | �|� d S | �|� d S r� )r �display_self_help�display_plugin_help)r �sectionr r r � display_help� s
zPlugin.display_helpc C s� ddl m} |�d| j�� | jf � d}zd}| jd }|tkr'|jr'|j}| jr/|| j7 }W n t y; d }Y nw |�
|rDd| n|� t | j | j
| j| j| j| jg�s]|�
d� n3d D ]}t| |d �rx|j
d
|d �t| |��f d d
� q_t| d�r�|j
dd �dd� | jD �� d d
� | jr�|j
dd �dd� | jD �� d d
� t| d�r�|j
dd �dd� | jD �� d d
� | jtjur�|�
d� | js�d S |�d�}|�
dtd| j � � |j
td�d d d d ��d d
� d }| jD ]P} | j }
|
d u s�|
dk�rd!}
t | j t ��r| j �rd"}
nd#}
d$�d | j |
| j �} |j
t!j"| ||d%�d d
� | j#�rA|d& } d'}
|j
t!j"| j#| |
|
d(�d d
� q�d S ))Nr )�TERMSIZEz%s Plugin Information - %sz8
Detailed information is not available for this plugin.
r r+ z
%sz)This plugin is always enabled by default.)rK r� r� � kernel_modsrJ zEnabled by %s: %sr� F��newliner� z-Enabled by containers with names matching: %sc s r� r� r �r8 �cr r r r� & r� z-Plugin.display_plugin_help.<locals>.<genexpr>z'Enabled with the following profiles: %sc s r� r� r rA r r r r� - r� �verify_packagesz+
Verfies packages (when using --verify): %sc s r� r� r �r8 r{ r r r r� 4 r� z�This plugin performs post-processing on potentially sensitive collections. Disabling post-processing may leave sensitive data in plaintext.zPlugin Optionsz2These options may be toggled or changed using '%s'z-k %s.option_name=$valuez
{:<4}{:<20}{:<30}{:<20}
r� z Option Name�Default� Descriptionz6 z
None/UnsetzTrue/Onz False/Offz{:<4}{:<20}{:<30}{:<20})�width�subsequent_indent�
z )r, �initial_indentr- )$�sos.helpr" � set_titler �title�
short_desc�__mro__r� r� r� �add_textr^ rK r� r� r# rJ r� �getattrrI �profiles�hasattrr( r� r� � add_sectionr �formatr� r� r� r� r� �textwrap�fillr� )r r r" �missing�_doc�_sc�trig�optsec�
opt_indentr� �_def�_ln�_size�spacer r r r s� �
� �� ���
����
�� �
�����
���
����zPlugin.display_plugin_helpc C s� |� d� |�dtd� � |�d�}|�d� |�dtd�td�f � |�d td
� � |�d �}|�d td
�td�f � |�d�}ddd�}|jdd�dd� |�� D �� dd� d S )NzSoS Plugin Detailed Helpa[ Plugins are what define what collections occur for a given %s execution. Plugins are generally representative of a single system component (e.g. kernel), package (e.g. podman), or similar construct. Plugins will typically specify multiple files or directories to copy, as well as commands to execute and collect the output of for further analysis.z
sos reportzPlugin Enablementz�Plugins will be automatically enabled based on one of several triggers - a certain package being installed, a command or file existing, a kernel module being loaded, etc...zXPlugins may also be enabled or disabled by name using the %s or %s options respectively.z-e $namez-n $namea( Certain plugins may only be available for specific distributions or may behave differently on different distributions based on how the component for that plugin is installed or how it operates. When using %s, help will be displayed for the version of the plugin appropriate for your distribution.z sos help report.plugins.$pluginzUsing Plugin OptionsaZ Many plugins support additional options to enable/disable or in some other way modify the collections it makes. Plugin options are set using the %s syntax. Options that are on/off toggles may exclude setting a value, which will be interpreted as enabling that option.
See specific plugin help sections or %s for more information on these optionsz#-k $plugin_name.$option_name=$valuez
sos report -lzSee AlsozHelp for a specific $pluginz$Information on distribution policies)zreport.plugins.$plugin�policieszLAdditional relevant information may be available in these help sections:
%s�
c s s" � | ] \}}d � d||�V qdS )z{:>8}{:<30}{:<30}r� N)r: )r8 �secr� r r r r� � s
� �
�z+Plugin.display_self_help.<locals>.<genexpr>Fr$ )r1 r5 r r9 rI ra )r r �subsecrA �seealso�_alsor r r r i sP
��
�����
���
�
��
�zPlugin.display_self_helpc C s d| � � |�dd��� f S )Nz[plugin:%s] %szutf-8�replace)r� �encode�decoder� r r r � _format_msg� s �zPlugin._format_msgc C � | j �| �|�� d S r� )r� �errorrP r� r r r �
_log_error� � zPlugin._log_errorc C rQ r� )r� �warningrP r� r r r � _log_warn� rT zPlugin._log_warnc C rQ r� )r� �inforP r� r r r � _log_info� rT zPlugin._log_infoc C rQ r� )r� �debugrP r� r r r r � rT zPlugin._log_debugc C s4 | � � s|S | jr|�| j�r|t| j�d� S |S )z�Remove the configured sysroot from a filesystem path
:param path: The filesystem path to strip sysroot from
:type path: ``str``
:returns: The stripped filesystem path
:rtype: ``str``
N)� use_sysrootr� �
startswith�len�rN �pathr r r �
strip_sysroot� s
zPlugin.strip_sysrootc C s | j tj�tj�kS )z�Determine if the configured sysroot needs to be used
:returns: ``True`` if sysroot is not `/`, else ``False``
:rtype: ``bool``
)r� �osr^ �abspath�seprZ r r r rZ � s zPlugin.use_sysrootc C s( | j pd}|| j�� g}tj�|�|kS )z�Check if sysroot is within the archive's temp directory
:returns: ``True`` if sysroot is in the archive's temp directory, else
``False``
:rtype: ``bool``
r" )r� �archive� get_tmp_dirr` r^ � commonprefix)rN �_sysroot�pathsr r r �tmp_in_sysroot� s
zPlugin.tmp_in_sysrootc C s t | jj�|��dkS )z�Is the package $package_name installed?
:param package_name: The name of the package to check
:type package_name: ``str``
:returns: ``True`` id the package is installed, else ``False``
:rtype: ``bool``
r )r\ r� �package_manager�all_pkgs_by_name)rN � package_namer r r ry � s
�zPlugin.is_installedc C � | j j�|�S )z�Does the service $name exist on the system?
:param name: The name of the service to check
:type name: ``str``
:returns: ``True`` if service is present on the system, else ``False``
:rtype: ``bool``
)r� � init_system�
is_service�rN r� r r r rn � � zPlugin.is_servicec C rl )z�Is the service $name enabled?
:param name: The name of the service to check
:type name: ``str``
:returns: ``True if service is enabled on the system, else ``False``
:rtype: ``bool``
)r� rm �
is_enabledro r r r �is_service_enabled� rp zPlugin.is_service_enabledc C rl )z�Is the service $name disabled?
:param name: The name of the service to check
:type name: ``str``
:returns: ``True`` if service is disabled on the system, else ``False``
:rtype: ``bool``
)r� rm � is_disabledro r r r �is_service_disabled� rp zPlugin.is_service_disabledc C rl )a Is the service $name currently running?
:param name: The name of the service to check
:type name: ``str``
:returns: ``True`` if the service is running on the system, else
``False``
:rtype: ``bool``
)r� rm �
is_runningro r r r rt s
zPlugin.is_service_runningc C s | j j�|�d S )z�Return the reported status for service $name
:param name: The name of the service to check
:type name: ``str``
:returns: The state of the service according to the init system
:rtype: ``str``
r} )r� rm �get_service_statusro r r r rv s zPlugin.get_service_statusc C rl )z�Get all service names matching regex
:param regex: A regex to match service names against
:type regex: ``str``
:returns: All service name(s) matching the given `regex`
:rtype: ``list``
)r� rm �get_service_names�rN r r r r rw rp zPlugin.get_service_namesc C �
|| _ dS )z�Set or clear the default predicate for this plugin.
:param pred: The predicate to use as the default for this plugin
:type pred: ``SoSPredicate``
N)� predicate�rN �predr r r r� ) s
zPlugin.set_predicatec C ry )aP Set or clear the default predicate for command collection for this
plugin. If set, this predecate takes precedence over the `Plugin`
default predicate for command and journal data collection.
:param pred: The predicate to use as the default command predicate
:type pred: ``SoSPredicate``
N)�
cmd_predicater{ r r r �set_cmd_predicate1 s
zPlugin.set_cmd_predicatec C s& |dur|S |r| j dur| j S | jS )a� Get the current default `Plugin` or command predicate.
:param cmd: If a command predicate is set, should it be used.
:type cmd: ``bool``
:param pred: An optional predicate to pass if no command or plugin
predicate is set
:type pred: ``SoSPredicate``
:returns: `pred` if neither a command predicate or plugin predicate
is set. The command predicate if one is set and `cmd` is
``True``, else the plugin default predicate (which may be
``None``).
:rtype: ``SoSPredicate`` or ``None``
N)r} rz �rN rC r| r r r �
get_predicate; s
zPlugin.get_predicatec C s" | j ||d�}|durt|�S dS )a� Test the current predicate and return its value.
:param cmd: ``True`` if the predicate is gating a command or
``False`` otherwise.
:param pred: An optional predicate to override the current
``Plugin`` or command predicate.
:returns: ``True`` or ``False`` based on predicate evaluation, or
``False`` if no predicate
:rtype: ``bool``
�rC r| NF)r� r� r r r r �test_predicateQ s zPlugin.test_predicatec C s: |du rt | �}d||�� f }|r|d7 }| �|� dS )a* Log that a command was skipped due to predicate evaluation.
Emit a warning message indicating that a command was skipped due
to predicate evaluation. If ``kmods`` or ``services`` are ``True``
then the list of expected kernel modules or services will be
included in the log message. If ``allow_changes`` is ``True`` a
message indicating that the missing data can be collected by using
the "--allow-system-changes" command line option will be included.
:param cmd: The command that was skipped
:type cmd: ``str``
:param pred: The predicate that caused the command to be skipped
:type pred: ``SoSPredicate``
:param changes: Is the `--allow-system-changes` enabled
:type changes: ``bool``
Nzskipped command '%s': %sz3 Use '--allow-system-changes' to enable collection.)r6 r� rV )rN rC r| �changesr� r r r �log_skipped_cmdb s zPlugin.log_skipped_cmdr c C s: | j sdS | �d| � |rdt|f nt}| �|t|�S )a� Remove certificate and key output archived by sos report.
Any matching instances are replaced with: '-----SCRUBBED' and this
function does not take a regexp or substituting string.
:param cmd: The name of the binary to scrub certificate output from
:type cmd: ``str``
:param desc: An identifier to add to the `SCRUBBED` header line
:type desc: ``str``
:returns: Number of replacements made
:rtype: ``int``
r z1Scrubbing certs and keys for commands matching %s�%s %s)r� r �
_cert_replace�do_cmd_output_sub�
_certmatch)rN rC r� rM r r r �do_cmd_private_sub~ s �zPlugin.do_cmd_private_subc
C s2 d| d }t |d�r|jn|}| �d|||f � | js dS d}zU| jD ]N}|d du r.q%|d dkr>| �d |d
� q%t�|d |�rstj�| j d |d �}| �d
| � | j
� |�} t �
||| �� �\}
}|rs| j
�|
|� q%W |S ty� } zd} | �| |d
| f � d}W Y d} ~ |S d} ~ ww )a
Apply a regexp substitution to command output archived by sosreport.
This is used to obfuscate sensitive information captured by command
output collection via plugins.
:param cmd: The command name/binary name for collected output that
needs to be obfuscated. Internally globbed with a leading
and trailing `*`
:type cmd: ``str``
:param regexp: A regex to match the contents of the command output
against
:type regexp: ``str`` or compile ``re`` object
:param subst: The substitution string used to replace matches from
`regexp`
:type subst: ``str``
:returns: Number of replacements made
:rtype: ``int``
�*�patternz4substituting '%s' for '%s' in commands matching '%s'r N�file�binary�yesz6Cannot apply regex substitution to binary output: '%s'�exerC �cmddirz applying substitution to '%s'�-regex substitution failed for '%s' with: '%s')r8 r� r r� rV �fnmatchr` r^ rI r� rc � open_filer �subnr �
add_stringr� rS )
rN rC �regexp�subst�globstrr� � replacements�calledr^ �readabler� �er� r r r r� � sH �
�
������zPlugin.do_cmd_output_subc sl | � d| � t�|�j� |rdt|f nt}� fdd�| jD �}|D ]}|d }|s,q#| �|t|� q#dS )a� Scrub certificate/key/etc information from files collected by sos.
Files matching the provided pathregex are searched for content that
resembles certificate, ssh keys, or similar information. Any matches
are replaced with "-----SCRUBBED $desc" where `desc` is a description
of the specific type of content being replaced, e.g.
"-----SCRUBBED RSA PRIVATE KEY" so that support representatives can
at least be informed of what type of content it was originally.
:param pathregex: A string or regex of a filename to match against
:type pathregex: ``str``
:param desc: A description of the replaced content
:type desc: ``str``
z.Scrubbing certs and keys for paths matching %sr� c � g | ]
}� |d �r|�qS ��srcpathr �r8 r �r� r r r< � � z.Plugin.do_file_private_sub.<locals>.<listcomp>�dstpathN)r r �compiler� r� r� � do_file_subr� )rN � pathregexr� rM � file_list�ir^ r r� r �do_file_private_sub� s � �zPlugin.do_file_private_subc
C s zT| � |�}t|d�r|jn|}| �d| � | �d|||f � |s&W dS | j�|�}|�� }t|t�s;|� dd�}t
� |||�\}} | rP| j� ||� W | S d} W | S t
tfy� }
z$|
jtjkrnd} | �| | � n d} | �| ||
f � d} W Y d }
~
| S d }
~
ww )
a� Apply a regexp substitution to a file archived by sosreport.
:param srcpath: Path in the archive where the file can be found
:type srcpath: ``str``
:param regexp: A regex to match the contents of the file
:type regexp: ``str`` or compiled ``re`` object
:param subst: The substitution string to be used to replace matches
within the file
:type subst: ``str``
:returns: Number of replacements made
:rtype: ``int``
r� zsubstituting scrpath '%s'z"substituting '%s' for '%s' in '%s'r �utf8�ignorez-file '%s' not collected, substitution skippedr� N)�_get_dest_for_srcpathr8 r� r rc r� r r� r� rO r r� r� �OSError�IOError�errno�ENOENTrS ) rN r� r� r� r^ r� r� �contentr� r� r� r� r r r r� � s:
�
� � ��zPlugin.do_file_subc sN t |d�s
t�|�}|j� � fdd�| jD �}|D ] }| �|d ||� qdS )a, Apply a regexp substituation to a set of files archived by
sos. The set of files to be substituted is generated by matching
collected file pathnames against `pathexp`.
:param pathexp: A regex to match filenames within the archive
:type pathexp: ``str`` or compiled ``re`` object
:param regexp: A regex to match against the contents of each file
:type regexp: ``str`` or compiled ``re`` object
:param subst: The substituion string to be used to replace matches
:type subst: ``str``
r� c r� r� r r� r� r r r< & r� z,Plugin.do_path_regex_sub.<locals>.<listcomp>r� N)r8 r r� r� r� r� )rN �pathexpr� r� r� r� r r� r �do_path_regex_sub s
�zPlugin.do_path_regex_subc C s
t ||�S r� )r )rN r r r r r �do_regex_find_all* s
zPlugin.do_regex_find_allc
C s� t �|�}t j�t j�|�|�}t j�|�}t j�|�rHt j�t j�|��}t jj||d�}| � � r>|t
t j t j �d � }| �
d||f � n|}| �
d||| �|�f � | �|�}| j�||� | �|�rq| �
d| � d S | j�||d|d�� zt �|� W n% ty� } z|jdkr�| �
d| � W Y d }~d S W Y d }~nd }~ww | �
d ||f � ||kr�| �|� d S | �
d
| � d S ) N)�startz&made link target '%s' relative as '%s'z0copying link '%s' pointing to '%s' with isdir=%sz%link '%s' is a directory, skipping...r� )r� r� �symlink�pointsto�( z;link '%s' is part of a file system loop, skipping target...z#normalized link target '%s' as '%s'z.link '%s' points to itself, skipping target...)r` �readlinkr^ rI �dirname�normpath�isabs�realpath�relpathrZ r\ rb �pardirr r
r_ rc �add_linkr� re r, r� r� �
_do_copy_path) rN r� �linkdest�dest�absdest�realdir�reldestr� r� r r r �
_copy_symlink- sX
��
�
� ����
�zPlugin._copy_symlinkc
C s� z | � |�D ]}| �d||f � tj�||�}| �|� qW d S ty` } z4|jtjks1tj rCd}| �
d||f � W Y d }~d S |jtj kr[d}| � d||f � W Y d }~d S � d }~ww )Nz!recursively adding '%s' from '%s'zPermission deniedz_copy_dir: '%s' %sz)Too many levels of symbolic links copyingz_copy_dir: %s '%s')
r
r r` r^ rI r� r� r� �EPERM�EACCESrV �ELOOPrS )rN r� r� r^ r� r� r r r � _copy_dirh s( � � ��zPlugin._copy_dirc C s: | � � r | �|�}| jD ]}||d kr|d S q d S )Nr� r� )rZ r r� )rN r� �copiedr r r r� z s
�z Plugin._get_dest_for_srcpathc s t � fdd�| jD ��S )Nc 3 s � | ] }t �|� �V qd S r� �r r� )r8 �forbid�r^ r r r� � s �
�z,Plugin._is_forbidden_path.<locals>.<genexpr>)r^ r� r] r r� r �_is_forbidden_path� s �zPlugin._is_forbidden_pathc s t � fdd�| jjD ��S )Nc s g | ]}t � � |��qS r )r� )r8 �fpr� r r r< � s �z4Plugin._is_policy_forbidden_path.<locals>.<listcomp>)r^ r� r� r] r r� r �_is_policy_forbidden_path� s �z Plugin._is_policy_forbidden_pathc C s" | j D ] }t�||�r dS qdS )a Check if the given path matches a user-provided specification to
ignore collection of via the ``--skip-files`` option
:param path: The filepath being collected
:type path: ``str``
:returns: ``True`` if file should be skipped, else ``False``
TF)r� r� )rN r^ �
_skip_pathr r r �_is_skipped_path� s
�zPlugin._is_skipped_pathc C s: t �|j�}t �|j�}|j}| j�||t �||�� d S r� )r` �major�st_rdev�minorr1 rc �add_node�makedev)rN r^ r2 �dev_maj�dev_min�moder r r �
_copy_node� s zPlugin._copy_nodec C sf | j rdS | �|�r| �d| � dS |s|}| �� r | �|�}zt�|�}W n ttfy: | � d| � Y dS w t
� |j �rH| �
|� dS t
�|j �rit�|tj�ri| �|�sb| j�|� dS | �|� dS t
�|j �s�t
�|j �s�t|�}| �d||f � | �||� dS | �d||f � |j d@ s�| j�d|� n| j�||� | j�||dd �� dS )
z�Copy file or directory to the destination tree. If a directory, then
everything below it is recursively copied. A list of copied files are
saved for use later in preparing a report.
N� skipping forbidden path '%s'r zfailed to stat '%s'z creating %s node at archive:'%s'z!copying path '%s' to archive:'%s'i$ �no)r� r� r� ) r r� r rZ r_ r` �lstatr� r� rX r, �S_ISLNKr1 r� �S_ISDIR�access�R_OKr
rc �add_dirr� �S_ISREGr5 r� r� �add_filer� re )rN r� r� r2 �ntyper r r r� � sP
�
�
�zPlugin._do_copy_pathc sd t |t�r|g}� �� r� fdd�|D �}|D ]}� �d| � d|v r)t�|�}� j�|� qdS )z�Specify a path, or list of paths, to not copy, even if it's part of
an ``add_copy_spec()`` call
:param forbidden: A filepath to forbid collection from
:type forbidden: ``str`` or a ``list`` of strings
c s g | ]}� � |��qS r )r r� rZ r r r< � s z-Plugin.add_forbidden_path.<locals>.<listcomp>zadding forbidden path '%s'r� N)r� r� rZ rX r� � translater� re )rN � forbiddenr� r rZ r �add_forbidden_path� s
�zPlugin.add_forbidden_pathc
C sJ || j v r#z | j | �|� W dS ty" } z| �|� � d}~ww dS )a` Set the named option to value. Ensure the original type of the
option value is preserved
:param optioname: The name of the option to set
:type optioname: ``str``
:param value: The value to set the option to
:returns: ``True`` if the option is successfully set, else ``False``
:rtype: ``bool``
TNF)r� r� r� rS )rN �
optionnamer� �errr r r �
set_option� s
��zPlugin.set_optionr c C sL d}||v rt | jd |�S || jv r$| j| }|r |jdur"|jS |S |S )am Retrieve the value of the requested option, searching in order:
parameters passed from the command line, set via `set_option()`, or the
global_plugin_options dict.
`optionname` may be iterable, in which case this function will return
the first match.
:param optionname: The name of the option to retrieve the value of
:type optionname: ``str``
:param default: Optionally provide a default value to return if no
option matching `optionname` is found. Default 0
:returns: The value of `optionname` if found, else `default`
)�all_logsrk r �log_sizer �since�verifyr� N)r6 r� r� r� )rN r� r� �global_optionsr� r r r rm s
zPlugin.get_optionc C r� r� )r� r� )rN r� r r r �_add_copy_paths' r� zPlugin._add_copy_pathsc C �6 |D ]}t || t�r|| g||< q| j�|� dS )a� Apply a tag to a file matching a given regex, for use when a file
is copied by a more generic copyspec.
:param tagdict: A dict containing the filepatterns to match and the
tag(s) to apply to those files
:type tagdict: ``dict``
`tagdict` takes the form `{file_pattern: tag}`, E.G. to match all bond
devices from /proc/net/bonding with the tag `bond`, use
`{'/proc/net/bonding/bond.*': ['bond']}`
N)r� r� �filetagsr� )rN �tagdictr r r r �
add_file_tags* s
�zPlugin.add_file_tagsc C �, | j �� D ]\}}t�||�r| S qg S )a Get the tags that should be associated with a file matching a given
regex
:param fname: A regex for filenames to be matched against
:type fname: ``str``
:returns: The tag(s) associated with `fname`
:rtype: ``list`` of strings
)r� ra r r� )rN r r� r� r r r �get_tags_for_file; s
�zPlugin.get_tags_for_filec C sj | j D ]/}|g | j | d�}g }| jD ]}t�||d �r$|�|d � q|r2||d< | jj�|� qdS )z�After file collections have completed, retroactively generate
manifest entries to apply tags to files copied by generic copyspecs
��
specification� files_copied�tagsr� r� r� N)r� r� r r� re r� r� )rN �
file_regex�
manifest_data�
matched_files�cfiler r r �generate_copyspec_tagsJ s
�
���z Plugin.generate_copyspec_tagsTc
s� d�| � d�r | � d��t�d��t�d| �d� �� | j|d�s0| �d|| j|d�f � dS |du r9| � d�}| � d �r@d}|rF|d
9 }|sJd S t|t�rR|g}t|t�rZ|g}d d
� }|D �]�} | rit | �sl d S |s�| �
� rw| �| �} | � | �}
t |
�dkr�q`n| g}
g } t |
�dkr�||
d � d�d �g} | �
|� tt| ��} |�rt|t�r�|g}|D ]_} | �| �s�q�d }
|r�d| }| j|| d�}|d dkr�zt|d �}||kr�d}
W n ty� | �d| | f � Y q�w | �d| | |d f � q�| j�| | ||
| f� | �d| | f � q�q`dd� �� ����fd d ����s(��r3tt�fd d �|
��}
|
j�dd � d}d }g }|
D ]�}|| jv �rS| �d!| � �qB| �|��rb| �d"| � �qB| �|��rq| �d#| � �qB| � |��r�| �d$| � �qB|�r�| �d%| � �qBz
t � |�t j }W n t �y� | �!|��r�d}n
| �d&| � Y �qBY nw ||7 }|�r*||k�r*d}|�r!t"|��s!| �d'| � |}|d t j#k�r�|�$t j#�}|�%t j&j#d(�d) }|| | }| �'t(||�|� t j&�)dt j&�*|��}t j&�+|d*| �,� |�}| j-�.||� |�|�$d�� �qB| �d%| � �qB|�|�$d�� | �/|g� |�o>||k}�qB|�sS| j0�rS| j0j1�| || d+�� q`dS ),a Add a file, directory, or regex matching filepaths to the archive
:param copyspecs: A file, directory, or regex matching filepaths
:type copyspecs: ``str`` or a ``list`` of strings
:param sizelimit: Limit the total size of collections from `copyspecs`
to this size in MB
:type sizelimit: ``int``
:param maxage: Collect files with `mtime` not older than this many
hours
:type maxage: ``int``
:param tailit: Should a file that exceeds `sizelimit` be tail'ed to fit
the remaining space to meet `sizelimit`
:type tailit: ``bool``
:param pred: A predicate to gate if `copyspecs` should be collected
:type pred: ``SoSPredicate``
:param tags: A tag or set of tags to add to the metadata information
for this collection
:type tags: ``str`` or a ``list`` of strings
:param container: Container(s) from which this file should be copied
:type container: ``str`` or a ``list`` of strings
`copyspecs` will be expanded and/or globbed as appropriate. Specifying
a directory here will cause the plugin to attempt to collect the entire
directory, recursively.
If `container` is specified, `copyspecs` may only be explicit paths,
not globs as currently container runtimes do not support glob expansion
as part of the copy operation.
Note that `sizelimit` is applied to each `copyspec`, not each file
individually. For example, a copyspec of
``['/etc/foo', '/etc/bar.conf']`` and a `sizelimit` of 25 means that
sos will collect up to 25MB worth of files within `/etc/foo`, and will
collect the last 25MB of `/etc/bar.conf`.
Nr� z".*((\.(zip|gz|bz2|xz))|[-.][\d]+)$z^%s/*�etc�r| z,skipped copy spec '%s' due to predicate (%s)r� r� i Fc S s0 | � dd�} | �d�r| � dd�S | �d�d S )z�Generate a tag to add for a single file copyspec
This tag will be set to the filename, minus any extensions
except '.conf' which will be converted to '_conf'
�-r! z.confr# r )rM �endswith�split)r r r r �get_filename_tag� s
z.Plugin.add_copy_spec.<locals>.get_filename_tagr r+ r" r� z stat -c %s )� containerr} rD TzHunable to determine size of '%s' in container '%s'. Skipping collection.z>stat of '%s' in container '%s' failed, skipping collection: %sz,added collection of '%s' from container '%s'c S s$ zt j�| �W S ty Y dS w )Nr )r` r^ �getmtimer� r� r r r r � s
�z&Plugin.add_copy_spec.<locals>.getmtimec sX �� | �du s� � | �durdS t��| ��}�r |�k s(�r*t� | �d k r*dS dS )zp When --since is passed, or maxage is coming from the
plugin, we need to filter out older files NTi F)�searchr �
fromtimestampr )r^ �filetime)�configfile_patternr �logarchive_pattern�maxager� r r � time_filter� s � ��z)Plugin.add_copy_spec.<locals>.time_filterc s � | �S r� r )r )r r r �<lambda> s z&Plugin.add_copy_spec.<locals>.<lambda>)r� �reversez skipping redundant file '%s'r� z#skipping policy forbidden path '%s'zskipping excluded path '%s'z skipping '%s' over size limitz failed to stat '%s', skippingz)collecting tail of '%s' due to size limitr# �.tailed� sos_stringsr� )2rm r r� r r� rX r� r� r� r\ rZ �_expand_copy_specr �extendr� r� �container_exists�exec_cmdr� r r r� re �filter�sortr� r� r� r� r` r, �ST_SIZEr� r r rb r� rM r^ �add_string_as_filer r� r� rI r� rc r� r� r� r� )rN � copyspecs� sizelimitr �tailitr| r� r
r �copyspecr� �
_spec_tags�con�_tailrC �ret�consize� current_size�
limit_reached�_manifest_files�_file� file_size� file_name�strfile�add_size�rel_path� link_pathr )r r r r r� r r �
add_copy_spec\ s& +
�
�
� ��� �� ��� � ��� �
� �� ��zPlugin.add_copy_specr. c s� g }t | t�r
| g} t |t�r|g}t| j|�}�r+t �t�r"�g��fdd�|D �}� r>t � t�r5� g� � fdd�|D �}|�| � | j||||||||| ||
|d� dS )a� Run a command or list of commands against devices discovered during
sos initialization.
Any commands specified by cmd will be iterated over the list of the
specified devices. Commands passed to this should include a '%(dev)s'
variable for substitution.
:param cmds: The command(s) to run against the list of devices
:type cmds: ``str`` or a ``list`` of strings
:param devices: The device paths to run `cmd` against. This should be
either a list of devices/device paths or a key in the
devices dict discovered by sos during initialization.
:type devices: ``str`` or a ``list`` of devices or device paths.
:param timeout: Timeout in seconds to allow each `cmd` to run
:type timeout: ``int``
:param sizelimit: Maximum amount of output to collect, in MB
:type sizelimit: ``int``
:param chroot: Should sos chroot the command(s) being run
:type chroot: ``bool``
:param runat: Set the filesystem location to execute the command from
:type runat: ``str``
:param env: Set environment variables for the command(s) being run
:type env: ``dict``
:param binary: Is the output collected going to be binary data
:type binary: ``bool``
:param prepend_path: The leading path for block device names
:type prepend_path: ``str`` or ``None``
:param whitelist: Limit the devices the `cmds` will be run against to
devices matching these item(s)
:type whitelist: ``list`` of ``str``
:param blacklist: Do not run `cmds` against devices matching these
item(s)
:type blacklist: ``list`` of ``str``
:param subdir: Write the command output to this subdir within the
Plugin directory
:type subdir: ``str``
c s& g | ]� t � fd d��D ��r� �qS )c 3 � � | ] }t �d | � �V qdS �z(.*)?%sNr� )r8 �wl��dr r r� � r� �3Plugin.add_device_cmd.<locals>.<listcomp>.<genexpr>�r^ �r8 )� whitelistr6 r r< � �
�z)Plugin.add_device_cmd.<locals>.<listcomp>c s& g | ]� t � fd d��D ��s� �qS )c 3 r3 r4 r� )r8 �blr6 r r r� � r� r8 r9 r: )� blacklistr6 r r< � r< )
r� r �chroot�runatr r� � prepend_pathr� �priority�subdirN)r� r� r r� r �_add_device_cmd)rN �cmdsr� r� r r? r@ r r� rA r; r> r� rB rC � _dev_tags�_devsr )r> r; r �add_device_cmdR s( 5
�zPlugin.add_device_cmdc
C s� t |t�r|g}t |t�r|g}|p| �d�}|D ],}
|D ]'}|g}|�|
� | r/| �| |�}|
d|i }| j||||||||| | d�
q qdS )zCRun a command against all specified devices on the system.
r� �dev)
rC r� r r? r@ r r� r� rB rC N)r� r� rm r r �_add_cmd_output)rN rE r� r� r r? r@ r r� rA r� rB rC rC �devicerF �_cmdr r r rD � s(
���zPlugin._add_device_cmdc K s� d|v r |� d�nt| �}d|vrd|d< d|vr d|d< | �d�s(|d dkr,d |d
< tdi |��}| �d |�� � | jD ]}t�|j|�rS| �d |j � d
S q?| j d |d�rk| j
� |� | � d|j � d
S | j
|j||jd� d
S )z?Internal helper to add a single command to the collection list.r| rB r. r� Fr� r r T�to_filezpacked command: z skipping excluded command '%s'Nr� zadded cmd output '%s'�r� r )�popr6 rm r� r r[ r� r� rC r� r� re rX r� r� )rN r� r| �soscmd� _skip_cmdr r r rJ � s$
� zPlugin._add_cmd_outputc C s t |t�r|g}t|�dkr|s|r| �d� |
du r | �d�}
| du r*| jdd�} |D ]]}d}|rJ|}||f}| �||�}|sJ| �d||f � q,| jdi d|�d |�d
|�d |�d |�d
|�d|�d|�d| �d|
�d| �d| �d|�d|
�d|�d|�d|�d|�d|�� q,dS ) a- Run a program or a list of programs and collect the output
Output will be limited to `sizelimit`, collecting the last X amount
of command output matching `sizelimit`. Unless `suggest_filename` is
set, the file that the output is saved to will match the command as
it was executed, and will be saved under `sos_commands/$plugin`
:param cmds: The command(s) to execute
:type cmds: ``str`` or a ``list`` of strings
:param suggest_filename: Override the name of the file output is saved
to within the archive
:type suggest_filename: ``str``
:param root_symlink: If set, create a symlink with this name in the
archive root
:type root_symlink: ``str``
:param timeout: Timeout in seconds to allow each `cmd` to run for
:type timeout: ``int``
:param stderr: Should stderr output be collected
:type stderr: ``bool``
:param chroot: Should sos chroot the `cmds` being run
:type chroot: ``bool``
:param runat: Run the `cmds` from this location in the filesystem
:type runat: ``str``
:param env: Set environment variables for the `cmds` being run
:type env: ``dict``
:param binary: Is the command expected to produce binary output
:type binary: ``bool``
:param sizelimit: Maximum amount of output in MB to save
:type sizelimit: ``int``
:param pred: A predicate to gate if `cmds` should be collected or not
:type pred: ``SoSPredicate``
:param subdir: Save output to this subdirectory, within the plugin's
directory under sos_commands
:type subdir: ``str``
:param changes: Do `cmds` have the potential to change system state
:type changes: ``int``
:param foreground: Should the `cmds` be run in the foreground, with an
attached TTY
:type foreground: ``bool``
:param tags: A tag or set of tags to add to the metadata entries for
the `cmds` being run
:type tags: ``str`` or a ``list`` of strings
:param priority: The priority with which this command should be run,
lower values will run before higher values
:type priority: ``int``
:param cmd_as_tag: Should the command string be automatically formatted
to a tag?
:type cmd_as_tag: ``bool``
:param container: Run the specified `cmds` inside a container with this
ID or name
:type container: ``str``
:param to_file: Should command output be written directly to a new
file rather than stored in memory?
:type to_file: ``bool``
r+ z.ambiguous filename or symlink for command listNr� T)rC zESkipping command '%s' as the requested container '%s' does not exist.rC �suggest_filename� root_symlinkr� �stderrr? r@ r r� r r| rC r� r� �
foregroundrB �
cmd_as_tagrM �
container_cmdr ) r� r� r\ rV rm r� �fmt_container_cmdr rJ )rN rE rR rS r� rT r? r@ r r� r r| rC r� rU r� rB rV r
rM rC rW �ocmdr r r �add_cmd_output� sn
P
�������������������zPlugin.add_cmd_outputc C r� )a� Retroactively add tags to any commands that have been run by this
plugin that match a given regex
:param tagdict: A dict containing the command regex and associated tags
:type tagdict: ``dict``
`tagdict` takes the form of {cmd_regex: tags}, for example to tag all
commands starting with `foo` with the tag `bar`, use
{'foo.*': ['bar']}
N)r� r� �cmdtagsr� )rN r� rC r r r � add_cmd_tags? s
�zPlugin.add_cmd_tagsc C r� )z�Get the tag(s) that should be associated with the given command
:param cmd: The command that tags should be applied to
:type cmd: ``str``
:returns: Any tags associated with the command
:rtype: ``list``
)r[ ra r r� )rN rC r� r� r r r �get_tags_for_cmdO s
�zPlugin.get_tags_for_cmdc C s> t j�| j�� d| �� �}|rt j�||�}|r t �|� |S )a� Get the path where this plugin will save command output
:param name: Optionally specify a filename to use as part of the
command output path
:type name: ``str`` or ``None``
:param make: Attempt to create the command output path
:type make: ``bool``
:returns: The path where the plugin will write command output data
within the archive
:rtype: ``str``
� sos_commands)r` r^ rI rc rd r� �makedirs)rN r� �make�cmd_output_pathr r r �get_cmd_output_path] s �
zPlugin.get_cmd_output_pathc G s t |g|�R � S )aM Grep through file(s) for a specific string or regex
:param regexp: The string or regex to search for
:type regexp: ``str``
:param fnames: Paths to grep through
:type fnames: ``str``, ``list`` of string, or open file objects
:returns: Lines matching `regexp`
:rtype: ``str``
)r )rN r� �fnamesr r r � file_grept s zPlugin.file_grepc C s | j �� }t||�S r� )rc r' r) )rN r� r' r r r r) � s
zPlugin._mangle_commandc
C s� | � � }|r |d| 7 }tj�| jd |�}| �|�}tj�tj�| j�� ||��rkd}| j� � } d| }|} |t
| �t
|� k rP| d|t
| � t
|� � } | | } tj�tj�| j�� || ��sf| }n|d7 }q2tj�||�S )z@The internal function to build up a filename based on a command.z/%sr� r+ Tz.%dN) r� r` r^ rI r� r) �existsrc rd r' r\ )
rN r� rC �
plugin_dir�outdir�outfn�incr' rQ �newfnr r r �_make_command_filename� s0
�
�� z Plugin._make_command_filenamec C s8 t |t�s|g}|D ]}| j�||�� |�� g� q
dS )a� Add an environment variable to the list of to-be-collected env vars.
Collected environment variables will be saved to an `environment` file
in the archive root, and any variable specified for collection will be
collected in lowercase, uppercase, and the form provided
:param name: The name of the environment variable to collect
:type name: ``str``
N)r� r� r� r� �upperr )rN r� r r r r � add_env_var� s
�zPlugin.add_env_varc C s| | j d|d�s| �d| j|d� � dS |rdnd}tj�|| �� |�}t|t�r,|g}| j �
|||f� | � d| � dS ) a� Add a string to the archive as a file
:param content: The string to write to the archive
:type content: ``str``
:param filename: The name of the file to write `content` to
:type filename: ``str``
:param pred: A predicate to gate if the string should be added to the
archive or not
:type pred: ``SoSPredicate``
:param plug_dir: Should the string be saved under the plugin's dir in
sos_commands/? If false, save to sos_strings/
:type plug_dir: ``bool``
:param tags: A tag or set of tags to add to the manifest entry for this
collection
:type tags: ``str`` or a ``list`` of strings
Fr� z$skipped string due to predicate (%s)r Nr^ r zadded string as '%s') r� rX r� r` r^ rI r� r� r� r� re r )rN r� �filenamer| �plug_dirr� �sos_dirr r r r � s
�
zPlugin.add_string_as_filec $
C s� | j rdS |du r | j}g }t|t�r|g}|�|� |�|�d�d � |�| �|�� |r9|�t� dd|�� t
t |��}| � |�}|sN| j
d jdkrR| j}nd}|r]| �|| �}n| �|| �}|t| j
d �d d� }|r�| �d
| � | j�|t� tj�| j�� |�}nd }t� }t||||||| |
| j |
|d � }t� }|| } |d
dkr�d||f } | � | � |r�d| } | �d| | f � |�d�d |�d�d d� ||r�|nd|d |d
|||| |d� } |d
dks�|d
dk�rB|�r'|dk�r'| j
d jdk�r'| � d|�� d |f � t||d ||| |
| j |d� }t� | } | �d| � |d
dv �rB| j �rB| j j �| � |S | �d|�� d | | f � |d �rj| � d |�� d � |} |�!d d �d }|�s�| �rz| j�"|d |� n | j�#|d |� |d �r�tj�| j�� |�}!tj�| j�� | �}"tj�$|!|"�}#|#�!d!d"d �}#| j�%|#| � |�r�| j�%||� | j&�||| �r�d#nd$d%�� |�r�tj�| j�� |�nd"|d&< | j �r�|| d'< | | d(< | j j �| � |�r�| �'| �(� |� |S ))a� Execute a command and save the output to a file for inclusion in the
report.
Positional Arguments:
:param cmd: The command to run
Keyword Arguments:
:param suggest_filename: Filename to use when writing to the
archive
:param root_symlink: Create a symlink in the archive root
:param timeout: Time in seconds to allow a cmd to run
:param stderr: Write stderr to stdout?
:param chroot: Perform chroot before running cmd?
:param runat: Run the command from this location,
overriding chroot
:param env: Dict of env vars to set for the cmd
:param binary: Is the output in binary?
:param sizelimit: Maximum size in MB of output to save
:param subdir: Subdir in plugin directory to save to
:param changes: Does this cmd potentially make a change
on the system?
:param foreground: Run the `cmd` in the foreground with a
TTY
:param tags: Add tags in the archive manifest
:param cmd_as_tag: Format command string to tag
:param to_file: Write output directly to file instead
of saving in memory
:returns: dict containing status, output, and filename in the
archive for the executed cmd
Nr� r z[^\w\.]+r! r� �alwaysr� r+ z'collecting '%s' output directly to diskF)
r� rT r? �chdirr r� r �pollerrU rM r} �| z command '%s' timed out after %dsz5 - output up until the timeout may be available at %sz%s%s� truncated) r& �
parameters�exec�filepathru � return_coderB r� r� r� r� �~ � r" z5command '%s' not found in %s - re-trying in host root)r� r? rr r r� r rs rM z%could not run '%s': command not found)rz r{ z+collected output of '%s' in %s (changes=%s)z&collected output of '%s' was truncatedr^ r r rD z../r r� r� )rC r� r� rn rx r� ))r r� r� r� r re r r] r r$ r� r� r r� r? r� rk r\ r rc �
check_pathr r` r^ rI �get_archive_pathr r r rV rX r� r� rM �
add_binaryr� r� r� r� � _add_container_cmd_to_manifestr )$rN rC rR rS r� rT r? r@ r r� r rC r� rU r� rB rV rM rW �_tagsr �rootrh � outfn_strip�out_filer� r� �endr� �warnr� � manifest_cmd�linkfn� _outfn_path�
_link_path�rpathr r r �_collect_cmd_output� s� '
��
�
���
�
�
��
�zPlugin._collect_cmd_outputc C sN | j d| d�s| j|| | d� dddd�S | j||||||||| |
|
||d�
S )a} Execute a command and save the output to a file for inclusion in the
report, then return the results for further use by the plugin
:param cmd: The command to run
:type cmd: ``str``
:param suggest_filename: Filename to use when writing to the
archive
:param suggest_filename: ``str``
:param root_symlink: Create a symlink in the archive root
:type root_symlink: ``bool``
:param timeout: Time in seconds to allow a cmd to run
:type timeout: ``int``
:param stderr: Write stderr to stdout?
:type stderr: ``bool``
:param chroot: Perform chroot before running cmd?
:type chroot: ``bool``
:param runat: Run the command from this location,
overriding chroot
:type runat: ``str``
:param env: Environment vars to set for the cmd
:type env: ``dict``
:param binary: Is the output in binary?
:type binary: ``bool``
:param sizelimit: Maximum size in MB of output to save
:type sizelimit: ``int``
:param subdir: Subdir in plugin directory to save to
:type subdir: ``str``
:param changes: Does this cmd potentially make a change
on the system?
:type changes: ``bool``
:param foreground: Run the `cmd` in the foreground with a TTY
:type foreground: ``bool``
:param tags: Add tags in the archive manifest
:type tags: ``str`` or a ``list`` of strings
:returns: `cmd` exit status, output, and the filepath within the
archive output was saved to
:rtype: ``dict``
Tr� rN Nr )r} rD rn ) rR rS r� rT r? r@ r r� r rU rC r� )r� r� r� )rN rC rR rS r� rT r? r@ r r� r r| r� rU rC r� r r r �collect_cmd_output� s :��zPlugin.collect_cmd_outputc
C s� ddd�} | j d|d�s| S |du r| j}|s | jd jdkr#| j}
nd}
| �|�}|
rS| �� du r=| �d||
f � | S | �|
�rJ| � |
|| �}n | �d ||
f � t
|||
|||| |d
�S ) a= Execute a command right now and return the output and status, but
do not save the output within the archive.
Use this method in a plugin's setup() if command output is needed to
build subsequent commands added to a report via add_cmd_output().
:param cmd: The command to run
:type cmd: ``str``
:param timeout: Time in seconds to allow a cmd to run
:type timeout: ``int``
:param stderr: Write stderr to stdout?
:type stderr: ``bool``
:param chroot: Perform chroot before running cmd?
:type chroot: ``bool``
:param runat: Run the command from this location,
overriding chroot
:type runat: ``str``
:param env: Environment vars to set for the cmd
:type env: ``dict``
:param binary: Is the output in binary?
:type binary: ``bool``
:param pred: A predicate to gate execution of the `cmd`
:type pred: ``SoSPredicate``
:param foreground: Run the `cmd` in the foreground with a TTY
:type foreground: ``bool``
:param container: Execute this command in a container with
this name
:type container: ``str``
:param quotecmd: Whether the cmd should be quoted.
:type quotecmd: ``bool``
:returns: Command exit status and output
:rtype: ``dict``
Nr )r} rD Tr� r� rq zACannot run cmd '%s' in container %s: no runtime detected on host.zBCannot run cmd '%s' in container %s: no such container is running.)r� r? rr r� r rU rT ) r� r� r� r? r� r �_get_container_runtimerX r rX r )rN rC r� rT r? r@ r r� r| rU r
�quotecmd�_defaultr� r r r r r � s0
/
�
��zPlugin.exec_cmdc C s@ || j jvrg g d�| j j|< | j j| d �|||d�� dS )a Adds a file collection to the manifest for a particular container
and file path.
:param container: The name of the container
:type container: ``str``
:param path: The filename from the container filesystem
:type path: ``str``
:param arcpath: Where in the archive the file is written to
:type arcpath: ``str``
:param tags: Metadata tags for this collection
:type tags: ``str`` or ``list`` of strings
�r� r� r� r� N)r� r� re )rN r
r^ �arcpathr� r r r � _add_container_file_to_manifest"
s �z&Plugin._add_container_file_to_manifestc C s� |\}}|| j jvrg g d�| j j|< ||d< |�d�d |d< |�d�dd� |d< d || �� f }d
|d }| �|�}d ||f }| j�|t� t� || j�
|�� ||d < | j j| d
� |� dS )a� Adds a command collection to the manifest for a particular container
and creates a symlink to that collection from the relevant
sos_containers/ location
:param manifest: The manifest entry for the command
:type manifest: ``dict``
:param contup: A tuple of (original_cmd, container_name)
:type contup: ``tuple``
r� rw r� r r& r+ Nrv z!sos_containers/%s/sos_commands/%sz../../../../%srx z%s/%sr� ) r� r� r r� r) rc r| r r` r� � dest_pathre ) rN r� �contuprC r
�_cdir�_outloc�cmdfn�conlnkr r r r :
s
z%Plugin._add_container_cmd_to_manifestc C sZ |du rd| j j�� v r| j jd S dS t| j j�� �D ]}||kr*| j j| S q dS )zjBased on policy and request by the plugin, return a usable
ContainerRuntime if one exists
Nr� )r� �runtimes�keysr� )rN �runtime� pol_runtimer r r r� X
s ��z Plugin._get_container_runtimec C s, | � � }|dur|�|�p|�|�duS dS )a6 If a container runtime is present, check to see if a container with
a given name is currently running
:param name: The name or ID of the container to check presence of
:type name: ``str``
:returns: ``True`` if `name` exists, else ``False``
:rtype: ``bool``
NF)r� r �get_container_by_name�rN r� �_runtimer r r r e
s
�zPlugin.container_existsc s2 | � � }|dur|j|d�}� fdd�|D �S g S )a� Get a list of all container names and ID matching a regex
:param regex: The regular expression to match
:type regex: ``str``
:param get_all: Return all containers found, even terminated ones
:type get_all: ``bool``
:returns: All container IDs and names matching ``regex``
:rtype: ``list`` of ``tuples`` as (id, name)
N��get_allc s g | ] }t �� |d �r|�qS )r+ r� r& �r r r r< �
s z6Plugin.get_all_containers_by_regex.<locals>.<listcomp>)r� �get_containers)rN r r� r� � _containersr r� r �get_all_containers_by_regexu
s
z"Plugin.get_all_containers_by_regexc C s | � � }|dur
|�|�S dS )z�Get the container ID for a specific container
:param name: The name of the container
:type name: ``str``
:returns: The ID of the container if it exists
:rtype: ``str`` or ``None``
N)r� r� r� r r r r� �
s
z Plugin.get_container_by_namec C s. | j |d�}|dur|r|jdd�S |jS g S )a\ Return a list of all container IDs from the ``Policy``
``ContainerRuntime``
If `runtime` is not provided, use the ``Policy`` default
:param runtime: The container runtime to use, if not the default
runtime detected and loaded by the ``Policy``
:type runtime: ``str``
:param get_all: Return all containers known to the `runtime`, even
those that have terminated
:type get_all: ``bool``
:returns: All container IDs found by the ``ContainerRuntime``
:rtype: ``list``
�r� NTr� )r� r� r� )rN r� r� r� r r r r� �
s zPlugin.get_containersc C � | j |d�}|dur
|jS g S )a� Return a list of all image names from the Policy's
ContainerRuntime
If `runtime` is not provided, use the Policy default. If the specified
`runtime` is not loaded, return empty.
:param runtime: The container runtime to use, if not using the
default runtime detected by the ``Policy``
:type runtime: ``str``
:returns: A list of container images known to the `runtime`
:rtype: ``list``
r� N)r� �images�rN r� r� r r r �get_container_images�
� zPlugin.get_container_imagesc C r� )a� Return a list of all volume names from the Policy's
ContainerRuntime
If `runtime` is not provided, use the Policy default. If the specified
`runtime` is not loaded, return empty.
:param runtime: The container runtime to use, if not using the
default runtime detected by the ``Policy``
:type runtime: ``str``
:returns: A list of container volumes known to the `runtime`
:rtype: ``list``
r� N)r� �volumesr� r r r �get_container_volumes�
r� z Plugin.get_container_volumesc K sh | � � }|dur0t|t�r|g}|D ] }| �||�}|D ]}|�|d �}| j|fi |�� q qdS dS )a� Helper to get the ``logs`` output for a given container or list
of container names and/or regexes.
Supports passthru of add_cmd_output() options
:param containers: The name of the container to retrieve logs from,
may be a single name or a regex
:type containers: ``str`` or ``list`` of strs
:param get_all: Should non-running containers also be queried?
Default: False
:type get_all: ``bool``
:param kwargs: Any kwargs supported by ``add_cmd_output()`` are
supported here
Nr+ )r� r� r� r� �get_logs_commandrZ ) rN r� r� r� r� r
�_cons�_conrC r r r �add_container_logs�
s
��zPlugin.add_container_logsc C s$ | � |�r| �� }|�|||�S dS )a@ Format a command to be executed by the loaded ``ContainerRuntime``
in a specified container
:param container: The name of the container to execute the `cmd` in
:type container: ``str``
:param cmd: The command to run within the container
:type cmd: ``str``
:param quotecmd: Whether the cmd should be quoted.
:type quotecmd: ``bool``
:returns: The command to execute so that the specified `cmd` will run
within the `container` and not on the host
:rtype: ``str``
r )r r� rX )rN r
rC r� r� r r r rX �
s
zPlugin.fmt_container_cmdc C s || j jv S )a Determine whether specified module is loaded or not
:param module_name: Name of kernel module to check for presence
:type module_name: ``str``
:returns: ``True`` if the module is loaded, else ``False``
:rtype: ``bool``
)r� r# )rN � module_namer r r rn s zPlugin.is_module_loadedc C s | j �|� dS )z�Add an alert to the collection of alerts for this plugin. These
will be displayed in the report
:param alertstring: The text to add as an alert
:type alertstring: ``str``
N)r� re )rN � alertstringr r r � add_alert s zPlugin.add_alertc C s | j |7 _ dS )z�Append text to the custom text that is included in the report. This
is freeform and can include html.
:param text: The text to include in the report
:type text: ``str``
N)r� )rN �textr r r �add_custom_text s zPlugin.add_custom_textc K sT t |t�r|g}| jjj}|s| �d� dS |D ]}| jd||f fi |�� qdS )aR Collect service status information based on the ``InitSystem`` used
:param services: Service name(s) to collect statuses for
:type services: ``str`` or a ``list`` of strings
:param kwargs: Optional arguments to pass to add_cmd_output
(timeout, predicate, suggest_filename,..)
zFCannot add service output, policy does not define an InitSystem to useNr� )r� r� r� rm � query_cmdr rZ )rN rJ r� �query�servicer r r �add_service_status# s
�zPlugin.add_service_statusc C sh d}d}d}d}d}d}d}d}d }d
}| � d �}| p | � d �}|s't||�nd
}| d
kr/d
}t|t�r7|g}t|
t�r@|
g}
n|
sDg }
|rX|D ]}||| 7 }|
�d| � qH| r`||| 7 }|
rf||7 }|rl|d7 }|r�|dkrtd}|dkrzd}||| 7 }|r�||| 7 }|r�||| 7 }|r�||| 7 }|r�||| 7 }| �d| � | j|||| |
|d� dS )a9 Collect journald logs from one of more units.
:param units: Which journald units to collect
:type units: ``str`` or a ``list`` of strings
:param boot: A boot index using the journalctl syntax. The special
values 'this' and 'last' are also accepted.
:type boot: ``str``
:param since: Start time for journal messages
:type since: ``str``
:param until: End time forjournal messages
:type until: ``str``
:param lines: The maximum number of lines to be collected
:type lines: ``int``
:param allfields: Include all journal fields regardless of size or
non-printable characters
:type allfields: ``bool``
:param output: Journalctl output control string, for example "verbose"
:type output: ``str``
:param timeout: An optional timeout in seconds
:type timeout: ``int``
:param identifier: An optional message identifier
:type identifier: ``str``
:param catalog: Augment lines with descriptions from the system catalog
:type catalog: ``bool``
:param sizelimit: Limit to the size of output returned in MB.
Defaults to the value of --log-size.
:type sizelimit: ``int``
zjournalctl --no-pager z
--unit %sz
--boot %sz
--since '%s'z --until %sz --lines %sz --output %sz --identifier %sz
--catalog�d r� r� r z
journal_%sz --all�thisr �lastz-1zcollecting journal: %s)rC r� r r| r� rB N)rm �maxr� r� re r rJ ) rN �units�bootr� �until�lines� allfieldsrD r� �
identifier�catalogr r| r� rB � journal_cmd�unit_opt�boot_opt� since_opt� until_opt� lines_opt�
output_opt�identifier_opt� catalog_opt� journal_sizer� r� �unitr r r � add_journal: sd *
�zPlugin.add_journalc s� � �fdd�� t �|t j�r ��|�r ��|�r ��|d�}tj|dd�}g }|D ]-}z ��|�rG��|�rG|�|� |�� t j �
|d��� W q) t yV |�|� Y q)w |�|� t t
|��S )Nc s� g }t � | �} | D ]8}z-��|�s��|�r |�|� n��|�r2��|�r2|�� ��|d��� n|�|� W q tyA Y q w t t
|��S )Nr� ) �globr r re r
r
r r �PermissionErrorr� r� )rg � found_pathsr^ ��_Plugin__expandrN r r �__expand� s
� � z*Plugin._expand_copy_spec.<locals>.__expandr� T)� recursive)r` r� r� r
r
r r� �remover r^ rI r� r� r� )rN r" �expanded�recursed_files�_pathr r� r r � s$ �
� �
zPlugin._expand_copy_specc C s8 t | jdd�D ]}| �d| � | �|� q| �� d S )NT)r zcollecting path '%s')r� r� rX r� r r] r r r �_collect_copy_specs� s zPlugin._collect_copy_specsc C s
| j sdS | �� }|s| �d� dS |�� s | �d� dS | j D ]b}|\}}}}}| �d||f � d||�d�f }| j�|t� | j�|�} |j ||| |rQ|ndd�}
| j
|
dd �} | d
d krv|rm| j� | d |� | � ||||� q | �d
||| d f � q dS )a? Copy any requested files from containers here. This is done
separately from normal file collection as this requires the use of
a container runtime.
This method will iterate over self.container_copy_paths which is a set
of 5-tuples as (container, path, sizelimit, stdout, tags).
NzDCannot collect container based files - no runtime is present/active.zYLoaded runtime '%s' does not support copying files from containers. Skipping collections.z#collecting '%s' from container '%s'zsos_containers/%s/%sr" )r r. )r� r} r rD z*error copying '%s' from container '%s': %s)
r� r� rX �check_can_copyr� rc r| r r� �get_copy_commandr r� r� ) rN �rtr� r$ r^ r r! r� �arcdestr� �cpcmd�cpretr r r � _collect_container_copy_specs� s6
� ��z$Plugin._collect_container_copy_specsc C sV | j jdd� d� | j D ] }| �d|�� � | �d|j � | jdi |j�� q d S )Nc S r r� )rB )�xr r r r s z&Plugin._collect_cmds.<locals>.<lambda>)r� zunpacked command: zcollecting output of '%s'r )r� r r r[ rX rC r� r� )rN rP r r r �
_collect_cmds s
�zPlugin._collect_cmdsc C s� | j D ]J\}}}| jr d S | �d| � z | j�||� |�d�d �dd�}||d�| jj|< W q t yM } z| �
d||f � W Y d }~qd }~ww d S )Nzcollecting string as '%s'r" r� r# r! )r^ r� z could not add string '%s': %s) r� r rX rc r� r rM r� r� r� r )rN �stringr- r� �_namer� r r r �_collect_strings s" �����zPlugin._collect_stringsc C sJ t � }| �� | �� | �� | �� | �� t � | f}| �d| � dS )z Collect the data for a plugin.zcollected plugin '%s' in %sN)r r� r� r� r� r� r )rN r� �fieldsr r r �collect s zPlugin.collectc C s z| j W S ty Y dS w )z8This function will return the description for the pluginz<no description available>)r3 r� rZ r r r �get_description! s
�zPlugin.get_descriptionc sl t | j| j| j| j| j| j| jg�r�t| jt �r | jg| _t| jt �r(| jg| _t| jt �r3| jg| _t| jt �r>| jg| _t| jt �rI| jg| _t| t
�r�g t | �_ | �
� D ];� � fdd�| jD �}� fdd�| jD �}� fdd�| jD �}� fdd�| jD �}| �||||d�r�t | �j �� � qWt | �j r�dS | �| j| j| j| j| j�S t| t
�r�| �
� t | �_ dS )a This method will be used to verify that a plugin should execute
given the condition of the underlying environment.
The default implementation will return True if none of class.files,
class.packages, nor class.commands is specified. If any of these is
specified the plugin will check for the existence of any of the
corresponding paths, packages or commands and return True if any
are present.
For SCLPlugin subclasses, it will check whether the plugin can be run
for any of installed SCLs. If so, it will store names of these SCLs
on the plugin class in addition to returning True.
For plugins with more complex enablement checks this method may be
overridden.
:returns: ``True`` if the plugin should be run for this system, else
``False``
:rtype: ``bool``
c � g | ]}|d � i �qS ��scl_namer r� ��sclr r r< S r� z(Plugin.check_enabled.<locals>.<listcomp>c r� r� r rA r� r r r< T r� c r� r� r r& r� r r r< U r� c r� r� r r? r� r r r< V r� r T)r^ r� rK r� r# rJ r� �
architecturesr� r� � SCLPluginr� �
_scls_matched� _get_scls�_check_plugin_triggersre )rN r� rK r� rJ r r� r �
check_enabled( sN �
��
�
zPlugin.check_enabledc s� t |||||g�s
� �� S t � fdd�|D ��sPt � fdd�|D ��sPt � fdd�|D ��sPt � fdd�� jD ��sPt � fdd�|D ��sPt � fdd�|D ��oS� �� S )Nc 3 � � | ]}� � |�V qd S r� )r )r8 r rZ r r r� t � � z0Plugin._check_plugin_triggers.<locals>.<genexpr>c 3 r� r� )ry r) rZ r r r� u r� c 3 s � | ] }t |� j�V qd S r� )r r� )r8 rC rZ r r r� v s � c 3 r� r� )rn )r8 �modrZ r r r� w r� c 3 r� r� )rn )r8 rv rZ r r r� x r� c 3 r� r� )r )r8 �cntrrZ r r r� y r� )r^ �check_is_architecturer# )rN r� rK r� rJ r� r rZ r r� m s ������z Plugin._check_plugin_triggersc C s0 | j du rdS dd�| j � }t�|| j�� �S )a? Checks whether or not the system is running on an architecture that
the plugin allows. If not architecture is set, assume plugin can run
on all arches.
:returns: ``True`` if the host's architecture allows the plugin to
run, else ``False``
:rtype: ``bool``
NTr� r� )r� rI r r� r� r� rx r r r r� | s
z Plugin.check_is_architecturec C � dS )zwThis decides whether a plugin should be automatically loaded or
only if manually specified in the command line.Tr rZ r r r �default_enabled� � zPlugin.default_enabledc C s. | j D ]}| �|�r| �|� | �|� qdS )z�Based on the class attrs defined for plugin enablement, add a
standardized set of collections before we call the plugin's own setup()
method.
N)rJ rn r� r� )rN r� r r r �add_default_collections� s
��z Plugin.add_default_collectionsc C s | � t| j�� dS )z�Collect the list of files declared by the plugin. This method
may be overridden to add further copy_specs, forbidden_paths, and
external programs if required.
N)r2 r� r� rZ r r r �setup� s z Plugin.setupc C sb t | d�r| js t | d�r| jrdd� | jD �| _nd S | jj}|�| j�}|r/| �|� d S d S )Nr( rK c S s g | ]}|d �qS )�$r rA r r r r< � r= z'Plugin.setup_verify.<locals>.<listcomp>)r8 r( rK r� ri �build_verify_commandrZ )rN �pm�
verify_cmdr r r � setup_verify� s �zPlugin.setup_verifyc C � t || j�S )a\ Helper to call the sos.utilities wrapper that allows the
corresponding `os` call to account for sysroot
:param path: The canonical path for a specific file/directory
:type path: ``str``
:returns: True if the path exists in sysroot, else False
:rtype: ``bool``
)r r� r] r r r r � � zPlugin.path_existsc C r )aS Helper to call the sos.utilities wrapper that allows the
corresponding `os` call to account for sysroot
:param path: The canonical path for a specific file/directory
:type path: ``str``
:returns: True if the path is a dir, else False
:rtype: ``bool``
)r
r� r] r r r r
� r zPlugin.path_isdirc C r )aT Helper to call the sos.utilities wrapper that allows the
corresponding `os` call to account for sysroot
:param path: The canonical path for a specific file/directory
:type path: ``str``
:returns: True if the path is a file, else False
:rtype: ``bool``
)r r� r] r r r r � r zPlugin.path_isfilec C r )aT Helper to call the sos.utilities wrapper that allows the
corresponding `os` call to account for sysroot
:param path: The canonical path for a specific file/directory
:type path: ``str``
:returns: True if the path is a link, else False
:rtype: ``bool``
)r r� r] r r r r � r zPlugin.path_islinkc C r )aT Helper to call the sos.utilities wrapper that allows the
corresponding `os` call to account for sysroot
:param path: The canonical path for a specific file/directory
:type path: ``str``
:returns: Contents of path, if it is a directory
:rtype: ``list``
)r
r� r] r r r r
� r zPlugin.listdirc G s t |g|�R d| ji�S )a� Helper to call the sos.utilities wrapper that allows the
corresponding `os` call to account for sysroot
:param path: The leading path passed to os.path.join()
:type path: ``str``
:param p: Following path section(s) to be joined with ``path``,
an empty parameter will result in a path that ends with
a separator
:type p: ``str``
r� )r r� )rN r^ rB r r r r � s zPlugin.path_joinc C r� )zLPerform any postprocessing. To be replaced by a plugin if required.
Nr rZ r r r r� � r� zPlugin.postprocc C s` d}d}z!t � |�}|D ]}t| �|�d�}|�� �� }||v r"d}q W |S ty/ Y dS w )z�Checks if a named process is found in /proc/[0-9]*/cmdline.
:param process: The name of the process
:type process: ``str``
:returns: ``True`` if the process exists, else ``False``
:rtype: ``bool``
F�/proc/[0-9]*/cmdline�rT)r� �openr r r% r� )rN �processr} �
cmd_line_glob�cmd_line_pathsr^ r �cmd_liner r r �check_process_by_name
s
�� ��z Plugin.check_process_by_namec C s� g }d}t � |�}|D ]6}z+t|d�� }|�� �� }||v r(|�|�d�d � W d � n1 s2w Y W q tyA Y q w |S )z�Get a list of all PIDs that match a specified name
:param process: The name of the process the get PIDs for
:type process: ``str``
:returns: A list of PIDs
:rtype: ``list``
r r
r" � N)r� r r r% re r r� )rN r �pidsr
r r^ r r r r r �get_process_pids
s
� �� �zPlugin.get_process_pidsc C s8 |d u r| j d jr| j d j}| �| j d d ||�S )Nr� �
namespaces�network)r� r �filter_namespaces)rN �
ns_pattern�ns_maxr r r �get_network_namespaces/
s
�z Plugin.get_network_namespacesc C st g }|rdd� |�� ��dd� }|D ]$}|r tt�||��s q|�|� |r7t|�|kr7| �d| � |S q|S )z�Filter a list of namespaces by regex pattern or max number of
namespaces (options originally present in the networking plugin.)
z(?:%s$)z$|r� z.*z9Limiting namespace iteration to first %s namespaces found) rI r rM r� r r� re r\ rV )rN �ns_listr r �out_nsr� �nsr r r r 5
s" �
�� zPlugin.filter_namespacesr� )FN)F)r )r )NT)
NTTNNFNFFF)NF)NNNNNFNNNNNNNr. )NN)�r� r� r� r� r rK r� r� r# rJ r� r� rc r7 r� r r r r r[ r� r� rz r} r� r� r� r r r r �propertyr� r� r r � classmethodr� r! r r rP rS rV rX r r_ rZ rh ry rn rr rt rt rv rw r� r~ r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� rm r� r� r� r r2 rH rD rJ rZ r\ r] rb rd r) rk rm r r� r� r r� r r� r r� r� r� r� r� r� rX rn r� r� r� r� r r� r� r� r� r� r� r� r� r� r� r r r r r
r r r
r r� r r r r r r r r r� � sh .$
,
f
:
7-;
<
� w
�Q
�
�l
�%
� 5
�I
�L
�j,*
E
r� c @ � e Zd ZdZdS )�PluginDistroTagz�The base tagging class for distro-specific classes used to signify that
a Plugin is written for that distro.
Use IndependentPlugin for plugins that are distribution agnostic
N�r� r� r� r� r r r r r S
s r c @ r )� RedHatPluginz/Tagging class for Red Hat's Linux distributionsNr! r r r r r" \
� r" c @ r )� UbuntuPluginz Tagging class for Ubuntu LinuxNr! r r r r r$ a
r# r$ c @ r )� DebianPluginz Tagging class for Debian LinuxNr! r r r r r% f
r# r% c @ r )�
SuSEPluginz*Tagging class for SuSE Linux distributionsNr! r r r r r& k
r# r& c @ r )�OpenEulerPluginz/Tagging class for openEuler linux distributionsNr! r r r r r' p
r# r' c @ r )� CosPluginz(Tagging class for Container-Optimized OSNr! r r r r r( u
r# r( c @ r )�IndependentPluginz6Tagging class for plugins that can run on any platformNr! r r r r r) z
r# r) c @ r )�ExperimentalPluginz=Tagging class that indicates that this plugin is experimentalNr! r r r r r*
r# r* c @ sD e Zd ZdZedd� �Zdd� Zdd� Zdd � Zd
d � Z d d
� Z
dS )r� a� Superclass for plugins operating on Software Collections (SCLs).
Subclasses of this plugin class can specify class.files and class.packages
using "%(scl_name)s" interpolation. The plugin invoking mechanism will try
to match these against all found SCLs on the system. SCLs that do match
class.files or class.packages are then accessible via self.scls_matched
when the plugin is invoked.
Additionally, this plugin class provides "add_cmd_output_scl" (run
a command in context of given SCL), and "add_copy_spec_scl" and
"add_copy_spec_limit_scl" (copy package from file system of given SCL).
For example, you can implement a plugin that will list all global npm
packages in every SCL that contains "npm" package:
class SCLNpmPlugin(Plugin, SCLPlugin):
packages = ("%(scl_name)s-npm",)
def setup(self):
for scl in self.scls_matched:
self.add_cmd_output_scl(scl, "npm ls -g --json")
c C s" t t| �d�s g t| �_t| �jS )Nr� )r8 r� r� rZ r r r � scls_matched�
s
zSCLPlugin.scls_matchedc C s t d�d }dd� |�� D �S )Nzscl -lrD c S s g | ]}|� � �qS r )r% )r8 r� r r r r< �
r= z'SCLPlugin._get_scls.<locals>.<listcomp>r~ )rN rD r r r r� �
s zSCLPlugin._get_sclsc C s d||f }|S )z.wrapping command in "scl enable" call
zscl enable %s "%s"r )rN r� rC �scl_cmdr r r �convert_cmd_scl�
s zSCLPlugin.convert_cmd_sclc K sT || j vrdS t|t�r|g}g }|D ] }|�| �||�� q| j|fi |�� dS )zpSame as add_cmd_output, except that it wraps command in
"scl enable" call and sets proper PATH.
N)r+ r� r� re r- rZ )rN r� rE r� �scl_cmdsrC r r r �add_cmd_output_scl�
s
z SCLPlugin.add_cmd_output_sclc C sD | j �� }dD ]}t�d| �}tj�|�d|||f |��}q|S )N)r �varz^/%s/z
/%s/%s/%s/)r� �get_default_scl_prefixr r� r` r^ ra r$ )rN r� r" �
scl_prefix�rootdirrB r r r �convert_copyspec_scl�
s
��z SCLPlugin.convert_copyspec_sclc C sL || j vrdS t|t�r|g}g }|D ] }|�| �||�� q| �|� dS )z`Same as add_copy_spec, except that it prepends path to SCL root
to "copyspecs".
N)r+ r� r� re r4 r2 )rN r� r �
scl_copyspecsr" r r r �add_copy_spec_scl�
s
zSCLPlugin.add_copy_spec_sclN) r� r� r� r� r r+ r� r- r/ r4 r6 r r r r r� �
s
r� c C s d| }|s t f}t||�S )z�Import name as a module and return a list of all classes defined in that
module. superclasses should be a tuple of valid superclasses to import,
this defaults to (Plugin,).
zsos.report.plugins.%s)r� r )r� � superclasses�
plugin_fqnamer r r �
import_plugin�
s
r9 r� )5r� �
sos.utilitiesr r r r r r r r r
r r r
r r r r � sos.archiver r` r� r r, r r� r� r� r; r r r) r5 r� �DOTALLr� r� �objectr6 r� r� r� r r" r$ r% r& r' r( r) r* r� r9 r r r r �<module> st
H /S P