o f#@sdZddlZddlZddlZddlmZddlmZm Z ddl m Z dZ dZ dZGd d d eZed ZGd d d ZGdddeZdddZejdfddZddZGdddZddZdS)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_handlersinstantiated_handler_registry)ReportingHandlerfinishstart cloudinitc@seZdZddZdS)_namesetcCs||vr|Std|)Nz%s not a valid value)AttributeError)selfnamer vs zreport_event..N)rregistered_itemsitemslistrvaluestype publish_event)eventr6excluded_handler_classeshandlershandlerr r5r report_eventfs   rBcCst||||d}t|S)zVReport a "finish" event. See :py:func:`.report_event` for parameter details. r))r%rB) event_nameevent_descriptionr(r)r>r r rreport_finish_eventsrFcCstt||}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. )rSTART_EVENT_TYPErB)rDrEr>r r rreport_start_events rHc@seZdZdZdddejdfddZddZddZd d Z e d d Z e j d d Z e ddZ e j ddZ ddZddZdS)ReportEventStackaKContext 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. NcCs||_||_||_||_||_tj|_|durg}||_|dur(|r&|j }nd}||_ |r7d |j |f|_ n|j|_ i|_ dS)NT/) parentr rmessageresult_on_exceptionr*rr(r)reporting_enabledjoinfullnamechildren)r r rrLrKrNrMr)r r rrs,  zReportEventStack.__init__cCsd|j|j|jfS)Nz.ReportEventStack(%s, %s, reporting_enabled=%s))r rrNrr r r__repr__s zReportEventStack.__repr__cCs4tj|_|jrt|j|j|jrd|jj|j <|S)N)NN) r*rr(rNrHrPrrKrQr rr r r __enter__s zReportEventStack.__enter__cCsPtjtjfD]}|jD]\}\}}||kr ||jfSq q|j|jfSr)r*rrrQr9rLr()r cand_result_namevalue_msgr r r_childrens_finish_infos z'ReportEventStack._childrens_finish_infocCs|jSr)_resultrr r rr(szReportEventStack.resultcCs|tvr td|||_dS)Nz'%s' not a valid result)r*r+rYr rVr r rr(s  cCs|jdur|jS|jSr)_messagerrr r rrLs zReportEventStack.messagecCs ||_dSr)r[rZr r rrLs cCs|r|j|jfS|Sr)rMrLrX)r excr r r _finish_infos zReportEventStack._finish_infocCsH||\}}|jr||f|jj|j<|jr"t|j|||jddSdS)NrC)r]rKrQr rNrFrPr))r exc_type exc_value tracebackr(msgr r r__exit__s  zReportEventStack.__exit__)rrrr#r*rrrRrSrXpropertyr(setterrLr]rbr r r rrIs** '     rIc Csz|sdSg}|D]2}tj|sd}nt|d}t|}Wdn1s,wY|||ddq|S)Nrbbase64)pathcontentencoding) osrgisfileopenrf b64encodereaddecodeappend)r.retfnamerhfpr r rr/(s  r/r)r#rfos.pathrjrtypingrcloudinit.reportingrrcloudinit.reporting.handlersrr'rGr$setr r*rr%rBrrFrHrIr/r r r rs*  $