3
ܓik+ @ s d dl Z d dlZd dlZd dlZd dlmZ d dlmZ d dlm Z d dl
m Z d dl m
Z
d dlmZmZ yeej jdZW n ek
r dZY nX G d d
d
e ZG d d d ZdS )
N) OrderedDict)fill) SoSComponent)
import_policy)Plugin)boldImporterHelperx c s e Zd ZdZdZdZdZdZddiZ fddZ e
dd Z d
d Z d d
Z
dd Zdd Zdd Zdd Zdd Zdd Z ZS ) SoSHelperzProvide better, more in-depth help for specific parts of sos than is
provided in either standard --help output or in manpages.
zDetailed help infomationFtopic c s t j||| | jj| _d S )N)super__init__optsr )selfparserargsZcmdline) __class__ /usr/lib/python3.6/__init__.pyr + s zSoSHelper.__init__c C s* d|_ |jdd}|jdddddd d S )
Nzsos help TOPIC [options]zHelp Information Optionsz| j jj||| | j _d S )N.r cleaner collector)cleanmaskcollect)r r splitreplace)r Z_com_replacer r r sanitize_topic_component: s z"SoSHelper.sanitize_topic_componentc C s | j js| j tjd | j y | j }W nD tk
rr } z(td| j j d| tjd W Y d d }~X nX |ry t }|j
| |j W q tk
r } ztd| W Y d d }~X qX ntd| j j d d S )Nr zCould not load help for 'z': zError loading help: zNo help section found for '') r r display_self_helpsysexitr( get_obj_for_topic Exceptionprint HelpSectionZ display_helpdisplay)r klasserrZhtr r r executeD s"
"zSoSHelper.executec C s ddddddddd }d
}| j j|krLtjd | j j }t||| j j }nB| j| j| j| jd }x*|j D ] \}}| j jj
|rl| }P qlW |S )
zBased on the help topic we're after, try to smartly decide which
object we need to manipulate in order to get help information.
Z SoSReportr Z
SoSCleaner SoSCollectorZRemoteTransportZClusterZPolicyZ SoSUpload)reportzreport.pluginsr r! zcollector.transportszcollector.clusterspoliciesuploadNzsos.)zreport.plugins.z policies.zcollector.transports.zcollector.clusters.) r r importlib
import_modulegetattr_get_plugin_variant_get_policy_by_name_get_collect_transport_get_collect_clusteritems
startswith)r Z
static_mapr modZ_helpZ_secvaluer r r r. \ s*
zSoSHelper.get_obj_for_topicc C s2 ddl m} | jjjdd }||kr.|| S d S )Nr )
TRANSPORTSr r) )Zsos.collector.sosnoderE r r r% )r rE Z
_transportr r r r? } s
z SoSHelper._get_collect_transportc C sX ddl m} dd l}|j|jjd}x.|D ]&}|d | jjjdd kr*|d S q*W d S )Nr )r6 clustersr r) rF ) Z
sos.collectorr6 Zsos.collector.clustersZ
_load_modulesr! rG r r r% )r r6 sosrG Zclusterr r r r@ s
z SoSHelper._get_collect_clusterc C sd t jd| jj }| j tj|tj}dd |D }x(|D ] }|j r<| j j
|j }|S q s z1SoSHelper._get_plugin_variant..) r: r; r r Zload_local_policyinspectZ
getmembersZisclass__subclasses__policyZ match_plugin)r rC ZmemsZpluginsZpluginr r r r r= s
z SoSHelper._get_plugin_variantc C sl | j jjdd }dd l}t|jj}x@|j D ]4}x.t|D ]"}|j j
j dd}||kr>|S q>W q0W d S )Nr r) r rO r rF ) r r r% Zsos.policies.distrosr r8 ZdistrosZ get_modulesr __name__lowerr& )r Z_topicrH Z_helperrC rO Z_pr r r r> s z SoSHelper._get_policy_by_namec C s t dd}|jdtd d |jd}td}|jd| d td
}|jd | d |jd
}|jd dddddddd}x2|j D ]&\}}|jdt|d| dd qW |j dS ) zhDisplays the help information for this component directly, that is
help for `sos help`.
zDetailed help for sos helpzThe 'help' sub-command is used to provide more detailed information on different sub-commands available to sos as well as different components at play within those sub-commands.zSoS - officially pronounced "ess-oh-ess" - is a diagnostic and supportability utility used by several Linux distributions as an easy-to-use tool for standardized data collection. The most known component of which is z
sos reportz (formerly sosreport) which is used to collect troubleshooting information into an archive for review by sysadmins or technical support teams.z How to search using sos helpz$component.$topic.$subtopicz8To get more information on a given topic, use the form 'z'.z sos help report.plugins.kernelz
For example 'zM' will provide more information on the kernel plugin for the report function.zAvailable Help SectionszThe following help sections are available. Additional help topics and subtopics may be displayed within their respective help section.
z#Detailed help on the report commandz'Information on the plugin design of sosz!Information on a specific $pluginz"Detailed help on the clean commandz$Detailed help on the collect commandz#Detailed help on the upload commandz+How sos operates on different distributions)r7 zreport.pluginszreport.plugins.$pluginr" r$ r9 r8 z<36F)newlineN)r1 add_textr add_sectionrA r2 ) r Z self_helpZsubsectr Zrep_exZ
avail_helpsectionsZsectrD r r r r+ s0
"zSoSHelper.display_self_help)rP
__module__ __qualname____doc__ZdescZconfigure_loggingZ load_policyZ
load_probeZ arg_defaultsr classmethodr r( r5 r. r? r@ r= r> r+
__classcell__r r )r r r
s
!
r
c @ sH e Zd ZdZdddZdd Zddd Zdd
d Zdd d
Zdd Z dS )r1 zThis class is used to build the output displayed by `sos help` in a
standard fashion that provides easy formatting controls.
r c C s || _ || _|| _t | _dS )a
:param title: The title of the output section, will be prominently
displayed
:type title: ``str``
:param content: The text content to be displayed with this section
:type content: ``str``
:param indent: If the section should be nested, set this to a multiple
of 4.
:type indent: ``int``
N)titlecontentindentr rV )r r\ r] r^ r r r r s
zHelpSection.__init__c C s
|| _ dS )zSet or override the title for this help section
:param title: The name to set for this help section
:type title: ``str``
N)r\ )r r\ r r r set_title s zHelpSection.set_titleTc C s, | j r|rdnd}|| }| j |7 _ dS )zAdd body text to this section. If content for this section already
exists, append the new ``content`` after a newline.
:param content: The text to add to the section
:type content: ``str``
z
N)r] )r r] rS lnr r r rT s zHelpSection.add_textc C s | j ||| | j| S )ac Add a section of text to the help section that will be displayed
when the HelpSection object is printed.
Sections will be printed *in the order added*.
This will return a subsection object with which block(s) of text may be
added to the subsection associated with ``title``.
:param title: The title of the subsection being added
:type title: ``str``
:param content: The text the new section should contain
:type content: ``str``
:returns: The newly created subsection for ``title``
:rtype: ``HelpSection``
) _add_sectionrV )r r\ r] r^ r r r rU s zHelpSection.add_sectionc C s( || j krtdt|||| j |< dS )zInternal method used to add a new subsection to this help output
:param title: The title of the subsection being added
:type title: ``str`
z(A section with that title already existsN)rV r/ r1 )r r\ r] r^ r r r rb s
zHelpSection._add_sectionc C sl t tt| jt| jd x&| jj D ]}t t|t| jd q&W x$| jD ]}t d | j| j qJW dS )zWPrint the HelpSection contents, including any subsections, to
console.
)widthZinitial_indentr N)
r0 r r r\ TERMSIZEr^ r]
splitlinesrV r2 )r ra Zsectionr r r r2 & s zHelpSection.displayN)r r r )T)r r )r r )
rP rW rX rY r r_ rT rU rb r2 r r r r r1 s
r1 )rM r: r, os collectionsr textwrapr Z
sos.componentr Z sos.policiesr Zsos.report.pluginsr Z
sos.utilitiesr r minget_terminal_sizecolumnsrd r/ r
r1 r r r r s
@