Source code for plainbox.impl.exporter

# This file is part of Checkbox.
# Copyright 2012 Canonical Ltd.
# Written by:
#   Zygmunt Krynicki <>
# Checkbox is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3,
# as published by the Free Software Foundation.

# Checkbox is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with Checkbox.  If not, see <>.

:mod:`plainbox.impl.exporter` -- shared code for session state exporters

.. warning::


from collections import OrderedDict
from io import RawIOBase
from logging import getLogger
import base64

from plainbox.i18n import gettext as _
from import ISessionStateExporter

logger = getLogger("plainbox.exporter")

[docs]class classproperty: """ Class property. """ # I wish it was in the standard library or that the composition worked def __init__(self, func): self.func = func def __get__(self, instance, owner): # If we were being pedantic we could throw a TypeError if instance is # None but this is not really something we care about in the code below return self.func(owner)
[docs]class SessionStateExporterBase(ISessionStateExporter): """ Base class for "exporter" that write out the state of the session after all jobs have finished running, in a user-selected format. The intent is not to preserve everything that the session may hold but instead to present it to the user in the best format possible. Each exporter can support a set of options that can alter the way it operates. Options can either be set boolean-like, or they can be assigned a value (a string). If an option contains a "=", the part of the string on the right of the equal sign will be assigned as the option's value; otherwise they operate in a boolean fashion. It's best to keep the list of exporter options under control to keep the user interface from becoming annoying. """ OPTION_WITH_IO_LOG = 'with-io-log' OPTION_SQUASH_IO_LOG = 'squash-io-log' OPTION_FLATTEN_IO_LOG = 'flatten-io-log' OPTION_WITH_RUN_LIST = 'with-run-list' OPTION_WITH_JOB_LIST = 'with-job-list' OPTION_WITH_DESIRED_JOB_LIST = 'with-job-list' OPTION_WITH_RESOURCE_MAP = 'with-resource-map' OPTION_WITH_JOB_DEFS = 'with-job-defs' OPTION_WITH_ATTACHMENTS = 'with-attachments' OPTION_WITH_COMMENTS = 'with-comments' OPTION_WITH_JOB_HASH = 'with-job-hash' OPTION_WITH_CATEGORY_MAP = 'with-category-map' OPTION_WITH_CERTIFICATION_STATUS = 'with-certification-status' SUPPORTED_OPTION_LIST = ( OPTION_WITH_IO_LOG, OPTION_SQUASH_IO_LOG, OPTION_FLATTEN_IO_LOG, OPTION_WITH_RUN_LIST, OPTION_WITH_JOB_LIST, OPTION_WITH_RESOURCE_MAP, OPTION_WITH_JOB_DEFS, OPTION_WITH_ATTACHMENTS, OPTION_WITH_COMMENTS, OPTION_WITH_JOB_HASH, OPTION_WITH_CATEGORY_MAP, OPTION_WITH_CERTIFICATION_STATUS, ) def __init__(self, option_list=None, exporter_unit=None): if option_list is None: option_list = [] self._option_dict = {} self._unit = exporter_unit for option_string in option_list: # An option can look like "foo" or like "foo=bar". In the first # case we assign "True" to that key in the dict, in the second we # assign "bar". key_value = option_string.split("=", 1) option = key_value[0] if option not in self.supported_option_list: raise ValueError("Unsupported option: {}".format(option)) if len(key_value) == 2: value = key_value[1] else: value = True self._option_dict[option] = value if exporter_unit: for option_string in exporter_unit.option_list: # An option can look like "foo" or like "foo=bar". In the first # case we assign "True" to that key in the dict, in the second # we assign "bar". key_value = option_string.split("=", 1) option = key_value[0] if option not in self.supported_option_list: raise ValueError("Unsupported option: {}".format(option)) if len(key_value) == 2: value = key_value[1] else: value = True self._option_dict[option] = value @property def unit(self): """ Exporter unit this exporter was created with. The exporter unit holds additional information that may be of use to applications, such as typical file name extension. """ return self._unit @property def _option_list(self): """ Returns a list of set options. Users who only are about whether an option is set, regardless of the value assigned to it, can use this API. """ return sorted([ option for option in self._option_dict.keys() if self._option_dict[option]]) @_option_list.setter def _option_list(self, value): """ Sets the option list to exactly what is sent as the parameter. Note that this will obliterate any prior settings in the list. """ self._option_dict = {} for key in value: self._option_dict[key] = True
[docs] def get_option_value(self, option): """ Returns the value assigned to an option. """ return self._option_dict.get(option, False)
[docs] def set_option_value(self, option, value=True): """ assigns a value to an option. If no value is given, it just "sets" the option to True """ self._option_dict[option] = value
@classproperty def supported_option_list(cls): """ Return the list of supported options """ return cls.SUPPORTED_OPTION_LIST
[docs] def dump_from_session_manager(self, session_manager, stream): """ Dump session information pulled from session manager to stream. This method takes session manager instance, extracts session information from it, and dumps it to a stream. """ self.dump(self.get_session_data_subset(session_manager), stream)
[docs] def get_session_data_subset(self, session_manager): """ Compute a subset of session data. The subset of the data that should be saved may depend on a particular saver class and options selected by the user. Must return a collection that can be handled by :meth:`dump()`. Special care must be taken when processing io_log (and in the future, attachments) as those can be arbitrarily large. """ data = { 'result_map': {} } session = session_manager.state if self.OPTION_WITH_JOB_LIST in self._option_list: data['job_list'] = [ for job in session.job_list] if self.OPTION_WITH_RUN_LIST in self._option_list: data['run_list'] = [ for job in session.run_list] if self.OPTION_WITH_DESIRED_JOB_LIST in self._option_list: data['desired_job_list'] = [ for job in session.desired_job_list] if self.OPTION_WITH_RESOURCE_MAP in self._option_list: data['resource_map'] = { # TODO: there is no method to get all data from a Resource # instance and there probably should be. Or just let there be # a way to promote _data to a less hidden-but-non-conflicting # property. resource_name: [ object.__getattribute__(resource, "_data") for resource in resource_list] # TODO: turn session._resource_map to a public property for resource_name, resource_list in session._resource_map.items() } if self.OPTION_WITH_ATTACHMENTS in self._option_list: data['attachment_map'] = {} if self.OPTION_WITH_CATEGORY_MAP in self._option_list: wanted_category_ids = frozenset({ job_state.effective_category_id for job_state in session.job_state_map.values() }) data['category_map'] = { unit.tr_name() for unit in session.unit_list if == 'category' and in wanted_category_ids } # Inject the special, built-in 'uncategorized' category, if any # job needs it UNCATEGORISED = 'com.canonical.plainbox::uncategorised' if UNCATEGORISED in wanted_category_ids: data['category_map'][UNCATEGORISED] = _("Uncategorised") for job_id, job_state in session.job_state_map.items(): if job_state.result.outcome is None: continue data['result_map'][job_id] = OrderedDict() data['result_map'][job_id]['summary'] = job_state.job.tr_summary() data['result_map'][job_id]['category_id'] = \ job_state.effective_category_id data['result_map'][job_id]['outcome'] = job_state.result.outcome if job_state.result.execution_duration: data['result_map'][job_id]['execution_duration'] = \ job_state.result.execution_duration if self.OPTION_WITH_COMMENTS in self._option_list: data['result_map'][job_id]['comments'] = \ job_state.result.comments # Add Job hash if requested if self.OPTION_WITH_JOB_HASH in self._option_list: data['result_map'][job_id]['hash'] = job_state.job.checksum # Add Job definitions if requested if self.OPTION_WITH_JOB_DEFS in self._option_list: for prop in ('plugin', 'requires', 'depends', 'command', 'description', ): if not getattr(job_state.job, prop): continue data['result_map'][job_id][prop] = getattr( job_state.job, prop) # Add Attachments if requested if job_state.job.plugin == 'attachment': if self.OPTION_WITH_ATTACHMENTS in self._option_list: self._build_attachment_map(data, job_id, job_state) continue # Don't add attachments IO logs to the result_map # Add IO log if requested if self.OPTION_WITH_IO_LOG in self._option_list: # If requested, squash the IO log so that only textual data is # saved, discarding stream name and the relative timestamp. if self.OPTION_SQUASH_IO_LOG in self._option_list: io_log_data = self._squash_io_log( job_state.result.get_io_log()) elif self.OPTION_FLATTEN_IO_LOG in self._option_list: io_log_data = self._flatten_io_log( job_state.result.get_io_log()) else: io_log_data = self._io_log(job_state.result.get_io_log()) data['result_map'][job_id]['io_log'] = io_log_data # Add certification status if requested if self.OPTION_WITH_CERTIFICATION_STATUS in self._option_list: data['result_map'][job_id]['certification_status'] = ( job_state.effective_certification_status) return data
def _build_attachment_map(self, data, job_id, job_state): raw_bytes = b''.join( (record[2] for record in job_state.result.get_io_log() if record[1] == 'stdout')) data['attachment_map'][job_id] = \ base64.standard_b64encode(raw_bytes).decode('ASCII') @classmethod def _squash_io_log(cls, io_log): # Squash the IO log by discarding everything except for the 'data' # portion. The actual data is escaped with base64. return [ base64.standard_b64encode('ASCII') for record in io_log] @classmethod def _flatten_io_log(cls, io_log): # Similar to squash but also coalesce all records into one big base64 # string (there are no arrays / lists anymore) return base64.standard_b64encode( b''.join([ for record in io_log]) ).decode('ASCII') @classmethod def _io_log(cls, io_log): # Return the raw io log, but escape the data portion with base64 return [(record.delay, record.stream_name, base64.standard_b64encode('ASCII')) for record in io_log]
[docs]class ByteStringStreamTranslator(RawIOBase): """ This is a sort of "impedance matcher" that bridges the gap between something that expects to write strings to a stream and a stream that expects to receive bytes. Instead of using, for instance, an intermediate in-memory IO object, this decodes on the fly and has the same interface as a writable stream, so it can be initialized with the destination string stream and then passed to something (usually a dump-style function) that writes bytes. """ def __init__(self, dest_stream, encoding): """ Create a stream that will take bytes, decode them into strings according to the specified encoding, and then write them as bytes into the destination stream. :param dest_stream: the destination string stream. :param encoding: Encoding with which bytes data is encoded. It will be decoded using the same encoding to obtain the string to be written. """ self.dest_stream = dest_stream self.encoding = encoding
[docs] def write(self, data): """ Writes to the stream, takes bytes and decodes them per the object's specified encoding prior to writing. :param data: the chunk of data to write. """ if (self.dest_stream.encoding and self.dest_stream.encoding.lower() != self.encoding.lower()): logger.warning( _("Incorrect stream encoding. Got %s, expected %s. " " some characters won't be printed"), self.dest_stream.encoding, self.encoding) # fall back to ASCII encoding return self.dest_stream.write(data.decode( 'ascii', errors='ignore')) return self.dest_stream.write(data.decode(self.encoding))
comments powered by Disqus