3
\me# @ s d Z ddlZddlZddlZddlmZ ddlmZm Z ddl
m Z dZ dZ
dZG d d
d
eZed ZG dd dZG dd deZd ddZejdfddZdd ZG dd dZdd ZdS ) z
events for reporting.
The events here are designed to be used with reporting.
They can be published to registered handlers with report_event.
N)List)available_handlers instantiated_handler_registry)ReportingHandlerZfinishstartZ cloudinitc @ s e Zd Zdd ZdS )_namesetc C s || kr |S t d| d S )Nz%s not a valid value)AttributeError)selfname r /usr/lib/python3.6/events.py __getattr__ s z_nameset.__getattr__N)__name__
__module__ __qualname__r
r r r r r s r SUCCESSWARNFAILc @ s. e Zd ZdZedfddZdd Zdd ZdS ) ReportingEventz"Encapsulation of event formatting.Nc C s2 || _ || _|| _|| _|d kr(tj }|| _d S )N)
event_typer
descriptionorigintime timestamp)r r r
r r r r r r __init__) s zReportingEvent.__init__c C s dj | j| j| jS )z"The event represented as a string.z
{0}: {1}: {2})formatr r
r )r r r r as_string9 s zReportingEvent.as_stringc C s | j | j| j| j| jdS )z&The event represented as a dictionary.)r
r r r r )r
r r r r )r r r r as_dict? s
zReportingEvent.as_dict)r r r __doc__DEFAULT_EVENT_ORIGINr r r r r r r r & s
r c s8 e Zd Zejdf fdd Zdd Z fddZ ZS )FinishReportingEventNc sD t t| jt|| || _|d kr&g }|| _|tkr@td| d S )NzInvalid result: %s)superr r FINISH_EVENT_TYPEresult
post_filesstatus
ValueError)r r
r r# r$ ) __class__r r r K s
z FinishReportingEvent.__init__c C s dj | j| j| j| jS )Nz{0}: {1}: {2}: {3})r r r
r# r )r r r r r X s z FinishReportingEvent.as_stringc s0 t t| j }| j|d< | jr,t| j|d< |S )z'The event represented as json friendly.r# files)r! r r r# r$ _collect_file_info)r data)r' r r r ] s
z FinishReportingEvent.as_dict) r r r r% r r r r
__classcell__r r )r' r r J s r c sX si fddt jj D }ttjj }x$|D ] }t||krFq4|j| q4W dS )a Report an event to all registered event handlers
except those whose type is in excluded_handler_types.
This should generally be called via one of the other functions in
the reporting module.
:param excluded_handler_types:
List of handlers types to exclude from reporting the event to.
:param event_type:
The type of the event; this should be a constant from the
reporting module.
c s h | ]\}}| kr|qS r r ).0Z hndl_typeZhndl_cls)excluded_handler_typesr r v s z report_event..N)r Zregistered_itemsitemslistr valuestypeZ
publish_event)eventr- Zexcluded_handler_classesZhandlersZhandlerr )r- r report_eventf s
r4 c C s t | |||d}t|S )zVReport a "finish" event.
See :py:func:`.report_event` for parameter details.
)r$ )r r4 )
event_nameevent_descriptionr# r$ r3 r r r report_finish_event s r7 c C s t t| |}t|S )a' Report a "start" event.
:param event_name:
The name of the event; this should be a topic which events would
share (e.g. it will be the same for start and finish events).
:param event_description:
A human-readable description of the event that has occurred.
)r START_EVENT_TYPEr4 )r5 r6 r3 r r r report_start_event s
r9 c @ s e Zd ZdZdddejdfddZdd Zdd Zd d
Z e
d d Z e j d
d Z e
dd Z
e
j dd Z
dd Zdd ZdS )ReportEventStackaK Context Manager for using :py:func:`report_event`
This enables calling :py:func:`report_start_event` and
:py:func:`report_finish_event` through a context manager.
:param name:
the name of the event
:param description:
the event's description, passed on to :py:func:`report_start_event`
:param message:
the description to use for the finish event. defaults to
:param:description.
:param parent:
:type parent: :py:class:ReportEventStack or None
The parent of this event. The parent is populated with
results of all its children. The name used in reporting
is /
:param reporting_enabled:
Indicates if reporting events should be generated.
If not provided, defaults to the parent's value, or True if no parent
is provided.
:param result_on_exception:
The result value to set if an exception is caught. default
value is FAIL.
:param post_files:
Can hold filepaths of files that are to get posted/created
regarding a given event. Something like success or failure information
in a given log file. For each filepath, if it's a valid regular file
it will get: read & encoded as base64 at the close of the event.
Default value, if None, is an empty list.
Nc C s || _ || _|| _|| _|| _tj| _|d kr2g }|| _|d krP|rL|j }nd}|| _ |rndj
|j |f| _ n| j| _ i | _ d S )NT/)
parentr
r messageresult_on_exceptionr% r r# r$ reporting_enabledjoinfullnamechildren)r r
r r= r< r? r> r$ r r r r s(
zReportEventStack.__init__c C s d| j | j| jf S )Nz.ReportEventStack(%s, %s, reporting_enabled=%s))r
r r? )r r r r __repr__ s zReportEventStack.__repr__c C s4 t j| _| jr t| j| j | jr0d| jj| j < | S )N)NN)
r% r r# r? r9 rA r r< rB r
)r r r r __enter__ s zReportEventStack.__enter__c C sP xBt jt jfD ]2}x,| jj D ] \}\}}||kr || jfS q W qW | j| jfS )N)r% r r rB r/ r= r# )r Z cand_result_namevalueZ_msgr r r _childrens_finish_info s
z'ReportEventStack._childrens_finish_infoc C s | j S )N)_result)r r r r r# s zReportEventStack.resultc C s |t krtd| || _d S )Nz'%s' not a valid result)r% r& rH )r rF r r r r# s c C s | j d k r| j S | jS )N)_messager )r r r r r= s
zReportEventStack.messagec C s
|| _ d S )N)rI )r rF r r r r= s c C s |r| j | jfS | j S )N)r> r= rG )r excr r r _finish_info s z ReportEventStack._finish_infoc C sD | j |\}}| jr&||f| jj| j< | jr@t| j||| jd d S )N)r$ )rK r< rB r
r? r7 rA r$ )r exc_type exc_value tracebackr# msgr r r __exit__ s zReportEventStack.__exit__)r r r r r% r r rC rD rG propertyr# setterr= rK rP r r r r r: s % r: c
C sj | sd S g }xX| D ]P}t jj|s(d }n(t|d}tj|j j }W d Q R X |j||dd qW |S )Nrbbase64)pathcontentencoding) osrU isfileopenrT Z b64encodereaddecodeappend)r( retZfnamerV fpr r r r) ( s
r) )r r r )N)r rT Zos.pathrX r Ztypingr Zcloudinit.reportingr r Z cloudinit.reporting.handlersr r" r8 r setr r% r r r4 r r7 r9 r: r) r r r r
s& $