CasperSecurity
o
쑛h$ � @ s� d Z ddlZddlZddlZddlZddlmZ ddlm Z ddl
m Z m Z ddl
mZ dZdZd Ze�e�ZG d
d � d e�Zed �ZG d
d� d�ZG dd� de�Zddd�Zejdfdd�Z dd� Z G dd� d�Z dd� Z dS ) 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)� performance)�available_handlers� instantiated_handler_registry)�ReportingHandler�finish�start� cloudinitc @ s e Zd Zdd� ZdS )�_namesetc C s || v r|S t d| ��)Nz%s not a valid value)�AttributeError)�self�name� r �</usr/lib/python3/dist-packages/cloudinit/reporting/events.py� __getattr__ s z_nameset.__getattr__N)�__name__�
__module__� __qualname__r r r r r r
s r
)�SUCCESS�WARN�FAILc @ s. e Zd ZdZedfdd�Zdd� Zdd� ZdS ) �ReportingEventz"Encapsulation of event formatting.Nc C s2 || _ || _|| _|| _|d u rt�� }|| _d S �N)�
event_typer
� description�origin�time� timestamp)r r r
r r r r r r �__init__, s
zReportingEvent.__init__c C s d� | j| j| j�S )z"The event represented as a string.z
{0}: {1}: {2})�formatr r
r �r r r r � as_string< s �zReportingEvent.as_stringc C s | j | j| j| j| jd�S )z&The event represented as a dictionary.�r
r r r r r" r r r r �as_dictB 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� fdd�Z� ZS )�FinishReportingEventNc sD t t| ��t||� || _|d u rg }|| _|tvr td| ��d S )NzInvalid result: %s)�superr& r �FINISH_EVENT_TYPE�result�
post_files�status�
ValueError)r r
r r) r* �� __class__r r r N s
� �z FinishReportingEvent.__init__c C s d� | j| j| j| j�S )Nz{0}: {1}: {2}: {3})r r r
r) r r r r r r! [ s �z FinishReportingEvent.as_stringc s0 t t| ��� }| j|d< | jrt| j�|d< |S )z'The event represented as json friendly.r) �files)r' r& r# r) r* �_collect_file_info)r �datar- r r r# ` s
z FinishReportingEvent.as_dict) r r r r+ r r r! r# �
__classcell__r r r- r r& M s
�
r& c sT � si � � fdd�t j�� D �}ttj�� �}|D ]}t|�|v r"q|�| � qdS )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 | ]
\}}|� v r|�qS r r )�.0� hndl_type�hndl_cls��excluded_handler_typesr r � <setcomp>y s
�z report_event.<locals>.<setcomp>N)r �registered_items�items�listr �values�type�
publish_event)�eventr7 �excluded_handler_classes�handlers�handlerr r6 r � report_eventi s
�� �rC c C s t | |||d�}t|�S )zVReport a "finish" event.
See :py:func:`.report_event` for parameter details.
�r* )r& rC )�
event_name�event_descriptionr) r* r? r r r �report_finish_event� s �rG 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_TYPErC )rE rF r? r r r �report_start_event� s
rI c @ s� e Zd ZdZdddejdfdd�Zdd� 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 <parent.name>/<name>
: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 u rg }|| _|d u r(|r&|j }nd}|| _ |r7d�
|j |f�| _ n| j| _ i | _ d S )NT�/)
�parentr
r �message�result_on_exceptionr+ r r) r* �reporting_enabled�join�fullname�children)r r
r rM rL rO rN 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 rO r r r r �__repr__� s
�zReportEventStack.__repr__c C s4 t j| _| jrt| j| j� | jrd| jj| j < | S )N)NN)
r+ r r) rO rI rQ r rL rR r
r r r r � __enter__� s zReportEventStack.__enter__c C sP t jt jfD ]}| j�� D ]\}\}}||kr || jf S q
q| j| jfS r )r+ r r rR r: rM r) )r � cand_result�_name�value�_msgr r r �_childrens_finish_info s �� z'ReportEventStack._childrens_finish_infoc C s | j S r )�_resultr r r r r) s zReportEventStack.resultc C s |t vr
td| ��|| _d S )Nz'%s' not a valid result)r+ r, rZ �r rW r r r r) s
c C s | j d ur| j S | jS r )�_messager r r r r rM s
zReportEventStack.messagec C s
|| _ d S r )r\ r[ r r r rM s
c C s |r| j | jfS | �� S r )rN rM rY )r �excr r r � _finish_info s z ReportEventStack._finish_infoc C sH | � |�\}}| jr||f| jj| j< | jr"t| j||| jd� d S d S )NrD )r^ rL rR r
rO rG rQ r* )r �exc_type� exc_value� tracebackr) �msgr r r �__exit__! s
��zReportEventStack.__exit__)r r r r$ r+ r r rS rT rY �propertyr) �setterrM r^ rc r r r r rJ � s* *
�'
rJ c
C s� | sd S g }| D ]J}t j�|�sd }n6t�d|� ���& t|d��}t�|�� �� � }W d � n1 s5w Y W d � n1 sDw Y |�
||dd�� q|S )NzReading �rb�base64)�path�content�encoding) �osrh �isfiler �Timed�openrg � b64encode�read�decode�append)r/ �ret�fnameri �fpr r r r0 + s � �� r0 r ) r$ rg �logging�os.pathrk r �typingr r r �cloudinit.reportingr r � cloudinit.reporting.handlersr r( rH r% � getLoggerr �LOG�setr
r+ r r& rC r rG rI rJ r0 r r r r �<module> s0
$
�