Source code for plainbox.impl.job

# This file is part of Checkbox.
#
# Copyright 2012, 2013 Canonical Ltd.
# Written by:
#   Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
#
# 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
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# 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 <http://www.gnu.org/licenses/>.

"""
:mod:`plainbox.impl.job` -- job definition
==========================================

.. warning::

    THIS MODULE DOES NOT HAVE STABLE PUBLIC API
"""

import functools
import logging
import re

from plainbox.abc import IJobDefinition
from plainbox.abc import ITextSource
from plainbox.i18n import gettext as _
from plainbox.impl.resource import ResourceProgram
from plainbox.impl.secure.job import BaseJob
from plainbox.impl.secure.rfc822 import Origin
from plainbox.impl.symbol import SymbolDef


logger = logging.getLogger("plainbox.job")


[docs]class Problem(SymbolDef): """ Symbols for each possible problem that a field value may have """ missing = 'missing' wrong = 'wrong' useless = 'useless'
[docs]class ValidationError(ValueError): """ Exception raised by to report jobs with problematic definitions. """ def __init__(self, field, problem): self.field = field self.problem = problem def __str__(self): return _("Problem with field {}: {}").format(self.field, self.problem) def __repr__(self): return "ValidationError(field={!r}, problem={!r})".format( self.field, self.problem)
[docs]class CheckBoxJobValidator: """ Validator for CheckBox jobs. """ @staticmethod
[docs] def validate(job): """ Validate the specified job """ # Check if id is empty if job.id is None: raise ValidationError(job.fields.id, Problem.missing) # Check if summary is empty if job.summary is None: raise ValidationError(job.fields.summary, Problem.missing) # Check if plugin is empty if job.plugin is None: raise ValidationError(job.fields.plugin, Problem.missing) # Check if plugin has a good value if job.plugin not in JobDefinition.plugin.get_all_symbols(): raise ValidationError(job.fields.plugin, Problem.wrong) # Check if user is given without a command to run if job.user is not None and job.command is None: raise ValidationError(job.fields.user, Problem.useless) # Check if environ is given without a command to run if job.environ is not None and job.command is None: raise ValidationError(job.fields.environ, Problem.useless) # Verify that command is present on a job within the subset that should # really have them (shell, local, resource, attachment, user-verify and # user-interact) if job.plugin in {JobDefinition.plugin.shell, JobDefinition.plugin.local, JobDefinition.plugin.resource, JobDefinition.plugin.attachment, JobDefinition.plugin.user_verify, JobDefinition.plugin.user_interact, JobDefinition.plugin.user_interact_verify}: # Check if shell jobs have a command if job.command is None: raise ValidationError(job.fields.command, Problem.missing) # Check if user has a good value if job.user not in (None, "root"): raise ValidationError(job.fields.user, Problem.wrong) # Do some special checks for manual jobs as those should really be # fully interactive, non-automated jobs (otherwise they are either # user-interact or user-verify) if job.plugin == JobDefinition.plugin.manual: # Ensure that manual jobs have a description if job.description is None: raise ValidationError( job.fields.description, Problem.missing) # Ensure that manual jobs don't have command if job.command is not None: raise ValidationError(job.fields.command, Problem.useless)
[docs]class propertywithsymbols(property): """ A property that also keeps a group of symbols around """ def __init__(self, fget=None, fset=None, fdel=None, doc=None, symbols=None): """ Initializes the property with the specified values """ super(propertywithsymbols, self).__init__(fget, fset, fdel, doc) self.__doc__ = doc self.symbols = symbols def __getattr__(self, attr): """ Internal implementation detail. Exposes all of the attributes of the SymbolDef group as attributes of the property. The way __getattr__() works it can never hide any existing attributes so it is safe not to break the property. """ return getattr(self.symbols, attr) def __call__(self, fget): """ Internal implementation detail. Used to construct the decorator with fget defined to the decorated function. """ return propertywithsymbols( fget, self.fset, self.fdel, self.__doc__, symbols=self.symbols)
@functools.total_ordering
[docs]class JobOutputTextSource(ITextSource): """ A :class:`ITextSource` subclass indicating that text came from job output. This class is used by :meth:`SessionState._gen_rfc822_records_from_io_log()` to allow such (generated) jobs to be traced back to the job that generated them. :ivar job: :class:`plainbox.impl.job.JobDefinition` instance that generated the text """ def __init__(self, job): self.job = job def __str__(self): return str(self.job) def __repr__(self): return "<{} job:{!r}".format(self.__class__.__name__, self.job) def __eq__(self, other): if isinstance(other, JobOutputTextSource): return self.job == other.job return NotImplemented def __gt__(self, other): if isinstance(other, JobOutputTextSource): return self.job > other.job return NotImplemented
[docs]class JobDefinition(BaseJob, IJobDefinition): """ Job definition class. Thin wrapper around the RFC822 record that defines a checkbox job definition """
[docs] class fields(SymbolDef): """ Symbols for each field that a JobDefinition can have """ name = 'name' id = 'id' summary = 'summary' plugin = 'plugin' command = 'command' description = 'description' user = 'user' environ = 'environ' estimated_duration = 'estimated_duration' depends = 'depends' requires = 'requires'
class _PluginValues(SymbolDef): """ Symbols for each value of the JobDefinition.plugin field """ shell = 'shell' attachment = 'attachment' local = 'local' resource = 'resource' manual = 'manual' user_verify = "user-verify" user_interact = "user-interact" user_interact_verify = "user-interact-verify" @propertywithsymbols(symbols=_PluginValues)
[docs] def plugin(self): return self.get_record_value('plugin')
[docs] def get_record_value(self, name, default=None): """ Obtain the value of the specified record attribute """ value = super(JobDefinition, self).get_record_value("_{}".format(name)) if value is None: value = super(JobDefinition, self).get_record_value(name, default) return value
@property
[docs] def id(self): if self._provider: return "{}::{}".format(self._provider.namespace, self.partial_id) else: return self.partial_id
@property
[docs] def partial_id(self): """ Identifier of this job, without the provider name This field should not be used anymore, except for display """ return self.get_record_value('id', self.name)
@property
[docs] def summary(self): return self.get_record_value('summary', self.id)
[docs] def tr_summary(self): """ Get the translated version of :meth:`summary` """ return self.get_translated_data(self.summary)
@property
[docs] def name(self): return self.get_record_value('name')
@property
[docs] def requires(self): return self.get_record_value('requires')
@property
[docs] def description(self): return self.get_record_value('description')
[docs] def tr_description(self): """ Get the translated version of :meth:`description` """ return self.get_translated_data(self.description)
@property
[docs] def depends(self): return self.get_record_value('depends')
@property
[docs] def estimated_duration(self): """ estimated duration of this job in seconds. The value may be None, which indicates that the duration is basically unknown. Fractional numbers are allowed and indicate fractions of a second. """ value = self.get_record_value('estimated_duration') if value is None: return try: return float(value) except ValueError: # TRANSLATORS: keep "estimated_duratin" untranslated. logger.warning( _("Incorrect value of 'estimated_duration' in job" " %s read from %s"), self.id, self.origin)
@property
[docs] def automated(self): """ Whether the job is fully automated and runs without any intervention from the user """ return self.plugin in ['shell', 'resource', 'attachment', 'local']
@property
[docs] def startup_user_interaction_required(self): """ The job needs to be started explicitly by the test operator. This is intended for things that may be timing-sensitive or may require the tester to understand the necessary manipulations that he or she may have to perform ahead of time. The test operator may select to skip certain tests, in that case the outcome is skip. """ return self.plugin in ['manual', 'user-interact', 'user-interact-verify']
@property
[docs] def via(self): """ The checksum of the "parent" job when the current JobDefinition comes from a job output using the local plugin """ if hasattr(self.origin.source, 'job'): return self.origin.source.job.checksum
@property
[docs] def origin(self): """ The Origin object associated with this JobDefinition """ return self._origin
[docs] def update_origin(self, origin): """ Change the Origin object associated with this JobDefinition .. note:: This method is a unfortunate side effect of how via and local jobs that cat existing jobs are implemented. Ideally jobs would be trully immutable. Do not use this method lightly. """ self._origin = origin
@property
[docs] def provider(self): """ The provider object associated with this JobDefinition """ return self._provider
@property
[docs] def controller(self): """ The controller object associated with this JobDefinition """ return self._controller
def __init__(self, data, origin=None, provider=None, controller=None): super(JobDefinition, self).__init__(data) if origin is None: origin = Origin.get_caller_origin() if controller is None: # XXX: moved here because of cyclic imports from plainbox.impl.ctrl import checkbox_session_state_ctrl controller = checkbox_session_state_ctrl self._resource_program = None self._origin = origin self._provider = provider self._controller = controller def __str__(self): return self.summary def __repr__(self): return "<JobDefinition id:{!r} plugin:{!r}>".format( self.id, self.plugin) def __eq__(self, other): if not isinstance(other, JobDefinition): return False return self.checksum == other.checksum def __hash__(self): return hash(self.checksum) def __ne__(self, other): if not isinstance(other, JobDefinition): return True return self.checksum != other.checksum
[docs] def get_resource_program(self): """ Return a ResourceProgram based on the 'requires' expression. The program instance is cached in the JobDefinition and is not compiled or validated on subsequent calls. Returns ResourceProgram or None Raises ResourceProgramError or SyntaxError """ if self.requires is not None and self._resource_program is None: if self._provider is not None: implicit_namespace = self._provider.namespace else: implicit_namespace = None self._resource_program = ResourceProgram( self.requires, implicit_namespace) return self._resource_program
[docs] def get_direct_dependencies(self): """ Compute and return a set of direct dependencies To combat a simple mistake where the jobs are space-delimited any mixture of white-space (including newlines) and commas are allowed. """ def transform_id(some_id): if "::" not in some_id and self._provider is not None: return "{}::{}".format(self._provider.namespace, some_id) else: return some_id if self.depends: return { transform_id(maybe_partial_id) for maybe_partial_id in re.split('[\s,]+', self.depends) } else: return set()
[docs] def get_resource_dependencies(self): """ Compute and return a set of resource dependencies """ program = self.get_resource_program() if program: return program.required_resources else: return set()
@classmethod
[docs] def from_rfc822_record(cls, record): """ Create a JobDefinition instance from rfc822 record The record must be a RFC822Record instance. Only the 'id' and 'plugin' keys are required. All other data is stored as is and is entirely optional. """ if 'id' not in record.data and 'name' not in record.data: # TRANSLATORS: don't translate id or translate it as 'id field' raise ValueError(_("Cannot create job without an id")) return cls(record.data, record.origin)
[docs] def validate(self, validator_cls=CheckBoxJobValidator): """ Validate this job definition with the specified validator :raises ValidationError: If the job has any problems that make it unsuitable for execution. """ validator_cls.validate(self)
[docs] def create_child_job_from_record(self, record): """ Create a new JobDefinition from RFC822 record. This method should only be used to create additional jobs from local jobs (plugin local). This ensures that the child job shares the embedded provider reference. """ if not isinstance(record.origin.source, JobOutputTextSource): # TRANSLATORS: don't translate record.origin or JobOutputTextSource raise ValueError(_("record.origin must be a JobOutputTextSource")) if not record.origin.source.job is self: # TRANSLATORS: don't translate record.origin.source.job raise ValueError(_("record.origin.source.job must be this job")) job = self.from_rfc822_record(record) job._provider = self._provider return job
[docs] def get_translated_data(self, msgid): """ Get a localized piece of data :param msgid: data to translate :returns: translated data obtained from the provider if this job has one, msgid itself otherwise. """ if msgid and self._provider: return self._provider.get_translated_data(msgid) else: return msgid
[docs]class JobTreeNode: """ JobTreeNode class is used to store a tree structure. A tree consists of a collection of JobTreeNode instances connected in a hierarchical way where nodes are used as categories, jobs belonging to a category are listed in the node leaves. **Example:** :: / Job A Root-| | / Job B \--- Category X | \ Job C """ def __init__(self, name=None): self._name = name if name else 'Root' self._parent = None self._categories = [] self._jobs = [] @property
[docs] def name(self): """ node name """ return self._name
@property
[docs] def parent(self): """ parent node for this node """ return self._parent
@property
[docs] def categories(self): """ list of sub categories """ return self._categories
@property
[docs] def jobs(self): """ job(s) belonging to this node/category """ return self._jobs
@property
[docs] def depth(self): """ level of depth for this node """ return (self._parent.depth + 1) if self._parent else 0
def __str__(self): return self.name def __repr__(self): return "<JobTreeNode name:{!r}>".format(self.name)
[docs] def add_category(self, category): """ Adds a new category to this node. :argument category: the node instance to be added as a category. """ self._categories.append(category) # Always keep this list sorted to easily find a given child by index self._categories = sorted(self._categories, key=lambda cat: cat.name) category._parent = self
[docs] def add_job(self, job): """ Adds a new job to this node. :argument job: the job instance to be added to this node. """ self._jobs.append(job) # Always keep this list sorted to easily find a given leaf by index # Note bisect.insort(a, x) cannot be used here as JobDefinition are # not sortable self._jobs = sorted(self.jobs, key=lambda job: job.id)
[docs] def get_ancestors(self): """ Returns the list of all ancestor nodes from current node to the current tree root. """ ancestors = [] node = self while node.parent is not None: ancestors.append(node.parent) node = node.parent return ancestors
[docs] def get_descendants(self): """ Returns a list of all descendant category nodes. """ descendants = [] for category in self.categories: descendants.append(category) descendants.extend(category.get_descendants()) return descendants
@classmethod
[docs] def create_tree(cls, job_list, node=None, link=None, legacy_mode=False): """ Build a rooted JobTreeNode from a job list :argument job_list: list of jobs to consider for building the tree. :argument None node: parent node to start with. :argument None link: parent-child link used to create the descendants. :argument False legacy_mode: whether local jobs are used to build the tree or a new experimental job metadata (categories). """ if node is None: node = cls() if legacy_mode: # using local jobs for job in [j for j in job_list if j.via == link]: if job.plugin == 'local': category = cls(job.description) cls.create_tree(job_list, category, job.checksum, legacy_mode) node.add_category(category) else: node.add_job(job) else: # EXPERIMENTAL: Using a new Job property, categories for job in job_list: if job.categories: for category in job.categories: for d in node.get_descendants(): if d.name == category: d.add_job(job) break else: category = cls(category) category.add_job(job) node.add_category(category) else: node.add_job(job) return node