3
ܓizV @ s d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dlZd dl m
Z
d dl m Z d dl
mZmZmZmZmZmZmZ d dlmZ d dlmZmZmZmZ d dl m Z m Z d dl m Z d d l!m"Z# d
d Z$i ddd dd
fddZ%G dd dZ&dS ) N)getpwuid)fill) NO_PRESETGENERIC_PRESETS PRESETS_PATHPresetDefaultsDESCNOTEOPTS)PackageManager)ImporterHelper
import_moduleget_human_readablebold)IndependentPluginExperimentalPlugin)
SoSOptions)_sosc C s. d| }y
t |tS tk
r( d S X d S )Nzsos.policies.distros.)r
Policy ImportError)nameZ
policy_fqname r /usr/lib/python3.6/__init__.py
import_policy s
r T c
C s d| kr| j dS dd l}t|jj}xD|j D ]8}x2t|D ]&} | j|dr>| ||||d| d< P q>W q0W tj dkr~t
dd| kr|jjj | d< | d S )Npolicyr )remote)sysrootinit
probe_runtime remote_execlinuxz%SoS is not supported on this platform) getZsos.policies.distrosr ZpoliciesZdistrosZ get_modulesr checksysplatform ExceptionZGenericLinuxPolicy)
cacher r r r Z remote_checksoshelpermoduler r r r load s
r+ c @ sn e Zd ZdZedZdZdZdZdZ dJgZ
dZ dZ dZ
de iZeZd ZdKd d
ZedLddZedd Zedd Zdd Zdd Zdd Zdd Z d d Z d d Z d d! Z dMd"d#Z d$d% Z!d&d' Z"d(d) Z#d*d+ Z$d,d- Z%d.d/ Z&d0d1 Z'd2d3 Z(d4d5 Z)ed6d7 Z*dNd8d9Z+d:d; Z,dd?Z.d@dA Z/dBdC Z0dPdDdEZ1d
d
d
e2 fdFdGZ3dQdHdIZ4d
S )Rr a Policies represent distributions that sos supports, and define the way
in which sos behaves on those distributions. A policy should define at
minimum a way to identify the distribution, and a package manager to allow
for package based plugin enablement.
Policies also control preferred ContainerRuntime()'s, upload support to
default locations for distribution vendors, disclaimer text, and default
presets supported by that distribution or vendor's products.
Every Policy will also need at least one "tagging class" for plugins.
:param sysroot: Set the sysroot for the system, if not /
:type sysroot: ``str`` or ``None``
:param probe_runtime: Should the Policy try to load a ContainerRuntime
:type probe_runtime: ``bool``
:param remote_exec: If this policy is loaded for a remote node, use
this to facilitate executing commands via the
SoSTransport in use
:type remote_exec: ``SoSTranport.run_command()``
:cvar os_release_name: The name of the distribution as it appears in the
os-release (-esque) file for the NAME variable.
:vartype os_release_name: ``str``
:cvar os_release_id: The ID variable to match in a distribution's release
file.
:vartype os_release_id: ``str``
:cvar os_release_file: The filepath of the distribution's os-release file
:vartype os_release_file: ``str``
:cvar vendor: The name of the vendor producing the distribution
:vartype vendor: ``str``
:cvar vendor_urls: List of URLs for the vendor's website, or support portal
:vartype vendor_urls: ``list`` of ``tuples`` formatted
``(``description``, ``url``)``
:cvar vendor_text: Additional text to add to the banner message
:vartype vendor_text: ``str``
:cvar name_pattern: The naming pattern to be used for naming archives
generated by sos. Values of `legacy`, and `friendly`
are preset patterns. May also be set to an explicit
custom pattern, see `get_archive_name()`
:vartype name_pattern: ``str``
ay This command will collect system configuration and diagnostic information from this %(os_release_name)s system.
For more information on %(vendor)s visit:
%(vendor_urls)s
The generated archive may contain data considered sensitive and its content should be reviewed by the originating organization before being passed to any third party.
%(changes_text)s
%(vendor_text)s
ZUnknownr Example URLhttp://www.example.com/z s z*Policy.get_archive_name.. r. z
-%Y%m%d%H%M%Sz
sosreport-Zfriendly-z -%Y-%m-%d) Zget_local_namesplitr2 commonslabeljoinrange name_patternZsanitize_filenametimeZstrftime)r7 r ZcaserT ZdateZrandZnstrr r r get_archive_name s
zPolicy.get_archive_namec C s |S )Nr )r7 Zbinaryr r r _get_pkg_name_for_binary s z Policy._get_pkg_name_for_binaryc C s |s t j S |S )N)tempfileZ
gettempdir)r7 Z opt_tmp_dirr r r get_tmp_dir s zPolicy.get_tmp_dirc C s6 t |dkr.x |D ]}t|| jd r|S qW |d S )az Determine what subclass of a Plugin should be used based on the
tagging classes assigned to the Plugin
:param plugin_classes: The classes that the Plugin subclasses
:type plugin_classes: ``list``
:returns: The first tagging class that matches one of the Policy's
`valid_subclasses`
:rtype: ``PluginDistroTag``
r )len
issubclassr4 )r7 Zplugin_classespr r r match_plugin s
zPolicy.match_pluginc s0 t g| j }|r|tg7 }t fdd|D S )a#
Verifies that the plugin_class should execute under this policy
:param plugin_class: The tagging class being checked
:type plugin_class: ``PluginDistroTag``
:returns: ``True`` if the `plugin_class` is allowed by the policy
:rtype: ``bool``
c 3 s | ]}t |V qd S )N)r_ )rM Zclass_) plugin_classr r rO 9 s z)Policy.validate_plugin..)r r4 r any)r7 rb Z experimentalr4 r )rb r validate_plugin, s
zPolicy.validate_pluginc C s dS )z>
This function is called prior to collection.
Nr )r7 r r r pre_work< s zPolicy.pre_workc C s dS )zR
This function is called after the sos report has been generated.
Nr )r7 r r r post_workA s zPolicy.post_workc C s | j j|S )zWrapper to retrieve a package from the Policy's package manager
:param pkg: The name of the package
:type pkg: ``str``
:returns: The first package that matches `pkg`
:rtype: ``str``
)r3 pkg_by_name)r7 Zpkgr r r rg F s zPolicy.pkg_by_namec C sB t j \}}}}}}|| _|| _|| _|j d dk| _|| _d S )Nr] ZSMP)r% unamesystemZhostnamereleaserR Zsmpmachine)r7 ri Znoderj versionrk _r r r r1 Q s zPolicy._parse_unamec C s
|| _ dS )z9Set common host data for the Policy to reference
N)rS )r7 rS r r r set_commonsZ s zPolicy.set_commonsc C s |t jd< d S )NPATH)osenviron)r7 pathr r r _set_PATH_ s zPolicy._set_PATHc C s | j | j d S )N)rs ro )r7 r r r r5 b s zPolicy.set_exec_pathc C s t j dkS )zThis method should return true if the user calling the script is
considered to be a superuser
:returns: ``True`` if user is superuser, else ``False``
:rtype: ``bool``
r )rp getuid)r7 r r r is_roote s zPolicy.is_rootc C s dS )zRReturns the string name of the hashlib-supported checksum algorithm
to useZsha256r )r7 r r r get_preferred_hash_namen s z Policy.get_preferred_hash_namec C s |j d |jd |jdtd dtd d |jd d d
d d d
}|jd}|jd x4|j D ](\}}|jdd|d|ddd qjW d S )Nz SoS PolicieszPolicies help govern how SoS operates on across different distributions of Linux. They control aspects such as plugin enablement, $PATH determination, how/which package managers are queried, default upload specifications, and more.z0When SoS intializes most functions, for example z
sos reportz and z sos collecta , one of the first operations is to determine the correct policy to load for the local system. Policies will determine the proper package manager to use, any applicable container runtime(s), and init systems so that SoS and report plugins can properly function for collections. Generally speaking a single policy will map to a single distribution; for example there are separate policies for Debian, Ubuntu, RHEL, and Fedora.zRIt is currently not possible for users to directly control which policy is loaded.z*The Google Cloud-Optimized OS distributionzThe Debian distributionz=Red Hat family distributions, not necessarily including forksz Ubuntu/Canonical distributions)z policies.coszpolicies.debianzpolicies.redhatzpolicies.ubuntuzSee Alsoz9For more information on distribution policies, see below
z>8z<20z<30F)newline)Z set_titleZadd_textr Z add_sectionitems)r: ZsectionZpolsZseealsoZpolvaluer r r display_helps s
zPolicy.display_helpc C s | r| rdS |r*| j jtd| |r| j jtd| d | j jtdt|j | j jtdt|jj n| j jtd| d |r| j jd| j d | | j jtd
d S ) ah Display final information about a generated archive
:param archive: The name of the archive that was generated
:type archive: ``str``
:param directory: The build directory for sos if --build was used
:type directory: ``str``
:param checksum: The checksum of the archive
:type checksum: ``str``
:param archivestat: stat() information for the archive
:type archivestat: `os.stat_result`
:param map_file: If sos clean was invoked, the location of the mapping
file for this run
:type map_file: ``str``
Fz3
A mapping of obfuscated elements is available at
z3
Your sos report has been generated and saved in:
z Size z Owner z3Your sos report build tree has been generated in:
rw z7
Please send this file to your support representative.
N) r0 inform r st_sizer st_uidZpw_namerv )r7 archiveZ directoryZchecksumZ archivestatZmap_filer r r display_results s&
zPolicy.display_resultsc C sr | j d jrd}nd}d}| j| j| j| j | j| j d |d }d}x&|j D ]}|t||dd d
}qPW |S ) a_ This method is used to prepare the preamble text to display to
the user in non-batch mode. If your policy sets self.os_release_name,
that text will be substituted accordingly. You can also override this
method to do something more complicated.
:returns: Formatted banner message string
:rtype: ``str``
rJ z,Changes CAN be made to system configuration.z0No changes will be made to system configuration.H tmpdir)os_release_namevendor vendor_urls vendor_textr changes_textr F)Zreplace_whitespacer| ) rS Zallow_system_changesmsgr r _fmt_vendor_urlsr
splitlinesr )r7 r widthZ_msgZ_fmtliner r r get_msg s
zPolicy.get_msgc s. t dd | jD dj fdd| jD S )zFormats all items in the ``vendor_urls`` class attr into a usable
string for the banner message.
:returns: Formatted string of URLS
:rtype: ``str``
c s s | ]}t |d V qdS )r N)r^ )rM vr r r rO s z*Policy._fmt_vendor_urls..r| c 3 s. | ]&}d |d d d|d V qdS )r} r `` objects specifying the command
line defaults.
:param presets: dictionary of presets to add or replace
:param replace: replace presets rather than merge new presets.
N)presetsupdate)r7 r replacer r r r6 s zPolicy.register_presetsc C s( x"| j j D ]\}}||kr |S q W dS )zFind a preset profile matching the specified preset string.
:param preset: a string containing a preset profile name.
:returns: a matching PresetProfile.
N)r ry )r7 presetmatchrz r r r find_preset
s zPolicy.find_presetc C s
| j t S )zReturn a ``PresetDefaults`` object matching the runing host.
Stub method to be implemented by derived policy classes.
:returns: a ``PresetDefaults`` object.
)r r )r7 r r r probe_preset s zPolicy.probe_presetc C s |p| j }tjj|sdS xtj|D ]}tjj||}t|dd,}ytj|}W n t k
rj w&Y nX W dQ R X x|j
D ]}t |t d}|| }t
|kr|t
nd|_t|kr|t nd|_t|krx&|t D ]}t|j||t | qW d|_|| j|< qW q&W dS )zLoad presets from disk.
Read JSON formatted preset data from the specified path,
or the default location at ``/etc/sos/presets.d``.
:param presets_path: a directory containing JSON presets.
Nzutf-8)encoding)optsr F) presets_pathrp rr existslistdirrU openjsonr+
ValueErrorkeysr r r descr noter
setattrr builtinr ) r7 r Z preset_pathZpfZ preset_datar Zpddataargr r r load_presets# s(
zPolicy.load_presetsc C s\ | j }|std|| jkr,td| dt||||d}d|_|| j|j< |j| dS )zAdd a new on-disk preset and write it to the configured
presets path.
:param preset: the new PresetDefaults to add
zPreset name cannot be emptyzA preset with name 'z' already exists)r r r r FN)r r r r r r write)r7 r r r r r r r r r
add_presetC s
zPolicy.add_presetc C s^ | s|| j kr td| d| j | }|jrBtd|j d|j| j | j j| d S )NzUnknown profile: ''z Cannot delete built-in preset ')r r r r deleter pop)r7 r r r r r
del_presetV s
zPolicy.del_preset)r, r- )NTN)r )F)NN)F)N)r )5__name__
__module__ __qualname____doc__rm r r Zos_release_fileZ
os_release_idr r r ro rW r r r r rD r8 classmethodr# propertyrC r< rE rF rH rY rZ r\ ra rd re rf rg r1 rn rs r5 ru rv r{ r r r r6 r r r r r r r r r r r 8 s^ 1
5
*
8
r )'r/ rp r% rX r r[ rK rL r$ pwdr textwrapr Z sos.presetsr r r r r r r
Z sos.policies.package_managersr Z
sos.utilitiesr r
r r Zsos.report.pluginsr r Z sos.optionsr r( r rm r r+ r r r r r s( $