# This file is part of Checkbox.
#
# Copyright 2012-2015 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/>.
"""
Session State Handling.

:mod:`plainbox.impl.session.state` -- session state handling
============================================================
"""
import collections
import json
import logging
import re

from plainbox.abc import IJobResult
from plainbox.i18n import gettext as _
from plainbox.impl import deprecated
from plainbox.impl.depmgr import DependencyDuplicateError
from plainbox.impl.depmgr import DependencyError
from plainbox.impl.depmgr import DependencySolver
from plainbox.impl.secure.qualifiers import select_jobs
from plainbox.impl.session.jobs import JobState
from plainbox.impl.session.jobs import UndesiredJobReadinessInhibitor
from plainbox.impl.unit.job import JobDefinition
from plainbox.impl.unit.unit_with_id import UnitWithId
from plainbox.impl.unit.testplan import TestPlanUnitSupport
from plainbox.vendor import morris


logger = logging.getLogger("plainbox.session.state")


class SessionMetaData:

    """
    Class representing non-critical state of the session.

    The data held here allows applications to reason about sessions in general
    but is not relevant to the runner or the core in general
    """

    # Flag indicating that the testing session is not complete and additional
    # testing is expected. Applications are encouraged to add this flag
    # immediately after creating a new session. Applications are also
    # encouraged to remove this flag after the expected test plan is complete
    FLAG_INCOMPLETE = "incomplete"

    # Flag indicating that results of this testing session have been submitted
    # to some central results repository. Applications are encouraged to
    # set this flag after successfully sending the result somewhere.
    FLAG_SUBMITTED = "submitted"

    # Flag indicating that session was just established and requires some
    # additional actions before test can commence. Applications are encouraged
    # to set this flag after session is created and then add incomplete flag
    # once the testing begin
    FLAG_BOOTSTRAPPING = "bootstrapping"

    # Flag indicating that session is using hand-picked list of jobs
    # and is not following any test plan
    FLAG_TESTPLANLESS = "testplanless"

    def __init__(self, title=None, flags=None, running_job_name=None,
                 app_blob=b'', app_id=None, custom_joblist=False):
        """Initialize a new session state meta-data object."""
        if flags is None:
            flags = []
        self._title = title
        self._flags = set(flags)
        self._running_job_name = running_job_name
        self._app_blob = app_blob
        self._app_id = app_id
        self._custom_joblist = custom_joblist
        self._rejected_jobs = []
        self._last_job_start_time = None

    def __repr__(self):
        """Get the representation of the session state meta-data."""
        return "<{} title:{!r} flags:{!r} running_job_name:{!r}>".format(
            self.__class__.__name__, self.title, self.flags,
            self.running_job_name)

    @property
    def title(self):
        """
        the session title.

        Title is just an arbitrary string that can be used to distinguish
        between multiple sessions.

        The value can be changed at any time.
        """
        return self._title

    @title.setter
    def title(self, title):
        """set the session title to the given value."""
        self._title = title

    @property
    def flags(self):
        """
        a set of flags that are associated with this session.

        This set is persisted by persistent_save() and can be used to keep
        track of how the application wants to interpret this session state.

        Intended usage is to keep track of "testing finished" and
        "results submitted" flags. Some flags are added as constants to this
        class.
        """
        return self._flags

    @flags.setter
    def flags(self, flags):
        """set the session flags to the given set."""
        self._flags = flags

    @property
    def running_job_name(self):
        """
        id of the running job.

        .. note::
            This property has a confusing name. It actually refers to job ID,
            not name.

        This property should be updated to keep track of the name of the
        job that is being executed. When either plainbox or the machine it
        was running on crashes during the execution of a job this value
        should be preserved and can help the GUI to resume and provide an
        error message.

        The property MUST be set before starting the job itself.
        """
        return self._running_job_name

    @running_job_name.setter
    def running_job_name(self, running_job_name):
        """set the id of the running job."""
        self._running_job_name = running_job_name

    @property
    def app_blob(self):
        """
        Custom, application specific binary blob.

        The type and value of this property is irrelevant as it is not
        inspected by plainbox at all. Reasonable applications will not make use
        of this property for storing large amounts of data. If you are tempted
        to do that, please redesign your application or propose changes to
        plainbox.
        """
        return self._app_blob

    @app_blob.setter
    def app_blob(self, value):
        """set the application specific binary blob to the given value."""
        if value is not None and not isinstance(value, bytes):
            # TRANSLATORS: please don't translate app_blob, None and bytes
            raise TypeError(_("app_blob must be either None or bytes"))
        self._app_blob = value

    @property
    def app_id(self):
        """
        Application identifier.

        A string identifying the application that stored app_blob. It is
        recommended to use reverse domain names or UUIDs.
        """
        return self._app_id

    @app_id.setter
    def app_id(self, value):
        """Set the application identifier to the given value."""
        if value is not None and not isinstance(value, str):
            # TRANSLATORS: please don't translate app_blob, None and bytes
            raise TypeError(_("app_id must be either None or str"))
        self._app_id = value

    @property
    def custom_joblist(self):
        return self._custom_joblist

    @custom_joblist.setter
    def custom_joblist(self, value):
        self._custom_joblist = value

    @property
    def rejected_jobs(self):
        return self._rejected_jobs

    @rejected_jobs.setter
    def rejected_jobs(self, value):
        self._rejected_jobs = value

    @property
    def last_job_start_time(self):
        return self._last_job_start_time

    @last_job_start_time.setter
    def last_job_start_time(self, value):
        self._last_job_start_time = value


class SessionDeviceContext:

    """
    Session context specific to a given device.

    This class exposes access to a "world view" unique to a specific device.
    The view is composed of the following attributes:

    :attr _provider_list:
        A list of providers known by this device. All of those providers
        are compatible with the device.

    :attr _unit_list:
        A list of all the units known by this device. Initially it is identical
        to the union of all the units from ``_provider_list`` but it is in fact
        mutable and can be grown (or shrunk in some cases) when jobs are
        created at runtime.

    :attr _test_plan_list:
        A list of test plans that this device will be executing. This is stored
        so that all job changes can automatically apply field overrides to job
        state.

    :attr _device:
        Always None, this is a future extension point

    :attr _state:
        A :class:`SessionState` object that holds all of the job results
        and also exposes some legacy API for computing the run list and the
        desired job list
    """
    # Cache key that stores the map of field overrides
    _CACHE_OVERRIDE_MAP = 'override_map'

    def __init__(self, state=None):
        """
        Initialize a new SessionDeviceContext.

        :param state:
            An (optional) state to use

        Note that using an initial state will not cause any of the signals to
        fire for the initial list of units nor the list of providers (derived
        from the same list).
        """
        self._device = None
        # Setup an empty computation cache for this context
        self._shared_cache = {}
        if state is None:
            # If we don't have to work with an existing state object
            # (the preferred mode) then all life is easy as we control both
            # the unit list and the provider list
            self._unit_list = []
            self._provider_list = []
            self._state = SessionState(self._unit_list)
            self._unit_id_map = {}
            self._already_added_checksums = set()
        else:
            if not isinstance(state, SessionState):
                raise TypeError
            # If we do have an existing state object then our lists must be
            # obtained / derived from the state object's data
            self._unit_list = state.unit_list
            self._provider_list = list({
                unit.provider for unit in self._unit_list
            })
            self._state = state
            self._unit_id_map = {unit.id: unit for unit in state.unit_list if
                                 isinstance(unit, UnitWithId)}
            self._already_added_checksums = set(
                [unit.checksum for unit in self.unit_list])

        self._test_plan_list = []
        # Connect SessionState's signals to fire our signals. This
        # way all manipulation done through the SessionState object
        # can be observed through the SessionDeviceContext object
        # (and vice versa, as all the manipulation is forwarded to
        # the SessionState)
        self._state.on_unit_added.connect(self.on_unit_added)
        self._state.on_unit_removed.connect(self.on_unit_removed)

    @property
    def device(self):
        """
        The device associated with this context.

        .. warning::
            Currently this method will always return None. In the future it
            will return an object that describes the device.
        """
        return self._device

    @property
    def state(self):
        """
        The session state object associated with this context.

        .. note::
            You can use both the session state and the session device context
            to query and monitor the changes to all the participating units
        """
        return self._state

    @property
    def provider_list(self):
        """
        The list of providers currently available in this context.

        .. note::
            You must not modify the return value.

            This is not enforced but please use the :meth:`add_provider()`
            method if you want to add a provider. Currently you cannot
            remove providers or reorder the list of providers.
        """
        return self._provider_list

    @property
    def unit_list(self):
        """
        The list of units currently available in this context.

        .. note::
            You must not modify the return value.

            This is not enforced but please use the :meth:`add_unit()`
            or :meth:`remove_unit()` if you want to manipulate the list.
            Currently you cannot reorder the list of units.
        """
        return self._unit_list

    @property
    def override_map(self):
        """
        A list of execution controllers applicable in this context.

        :returns:
            A list of IExecutionController objects

        .. note::
            The return value is different whenever a provider is added to the
            context. If you have obtained this value in the past it may be
            no longer accurate.
        """
        return self.compute_shared(
            self._CACHE_OVERRIDE_MAP, self._compute_override_map)

    def set_test_plan_list(self, test_plan_list: "List[TestPlanUnit]"):
        """
        Compute all of the effective job state values.

        :param test_plan_list:
            The list of test plans to consider

        This method is intended to be called exactly once per session, after
        the application determines the set of test plans it intends to execute.

        The method will collect all of the override values exposed by all of
        the test plans and apply them in sequence. Note that correct
        applications must also perform micro-updates whenever a new test job is
        added to the system.
        """
        self._test_plan_list = test_plan_list
        self._invalidate_override_map()
        self._bulk_override_update()
        if test_plan_list:
            self._update_mandatory_job_list()

    def add_provider(self, provider, add_units=True):
        """
        Add a provider to the context.

        :param provider:
            The :class:`Provider1` to add
        :param add_units:
            An optional flag that controls if all of the units from that
            provider should be added. Defaults to True.
        :raises ValueError:
            If the provider is already in the context

        This method can be used to add a provider to the context. It also adds
        all of the units of that provider automatically.

        .. note::
            This method fires the :meth:`on_provider_added()` signal but
            it does so before any of the units from that provider are added.
        """
        if provider in self._provider_list:
            raise ValueError(
                _("attempting to add the same provider twice: %s"
                  % provider.name))
        self._provider_list.append(provider)
        self.on_provider_added(provider)
        if add_units:
            for unit in provider.unit_list:
                self.add_unit(unit, False)
        self.state._recompute_job_readiness()

    def add_unit(self, unit, recompute=True):
        """
        Add a unit to the context.

        :param unit:
            The :class:`Unit` to add.
        :raises ValueError:
            If the unit is already in the context

        This method can be used to register both the initially-known units
        as well as units generated at runtime.

        This method fires the :meth:`on_unit_added()` signal
        """
        if unit.checksum in self._already_added_checksums:
            raise ValueError(
                _("attempting to add the same unit twice: %s" % unit.id))
        self._already_added_checksums.add(unit.checksum)
        self.state.add_unit(unit, recompute)
        # NOTE: no need to fire the on_unit_added() signal because the state
        # object and we've connected it to will fire our version.

    def remove_unit(self, unit):
        """
        Remove an unit from the context.

        :param unit:
            The :class:`Unit` to remove.

        This method fires the :meth:`on_unit_removed()` signal
        """
        if unit not in self._unit_list:
            raise ValueError(
                _("attempting to remove unit not in this context"))
        self._already_added_checksums.remove(unit.checksum)
        self.state.remove_unit(unit)
        # NOTE: no need to fire the on_unit_removed() signal because the state
        # object and we've connected it to will fire our version.

    def get_unit(self, unit_id, kind_name=None):
        """
        Get an unit with a specific identifier.

        :param unit_id:
            The identifier of the unit to find
        :param kind_name:
            (optional) Name of the type of unit.  By default units of any type
            can be found. Unit kind is the value of the ``unit.Meta.name``
            attribute.  Using this argument allows the caller to quickly find
            only units of a particular type without having to do the filtering
            on their side.
        :raises KeyError:
            If the matching unit does not exists.
        """
        unit = self._unit_id_map[unit_id]
        if kind_name is not None and unit.Meta.name != kind_name:
            raise KeyError(unit_id)
        return unit

    @morris.signal
    def on_provider_added(self, provider):
        """Signal sent whenever a provider is added to the context."""
        logger.info(_("Provider %s added to context %s"), provider, self)

    @morris.signal
    def on_unit_added(self, unit):
        """Signal sent whenever a unit is added to the context."""
        logger.debug(_("Unit %s added to context %s"), unit, self)
        if unit.Meta.name == 'job':
            self.on_job_added(unit)
        if isinstance(unit, UnitWithId):
            self._unit_id_map[unit.id] = unit

    @morris.signal
    def on_job_added(self, job):
        """Signal sent whenever a new job unit is added to the context."""
        self._override_update(job)

    @morris.signal
    def on_unit_removed(self, unit):
        """Signal sent whenever a unit is removed from the context."""
        logger.debug(_("Unit %s removed from context %s"), unit, self)
        if isinstance(unit, UnitWithId):
            del self._unit_id_map[unit.id]

    def compute_shared(self, cache_key, func, *args, **kwargs):
        """
        Compute a shared helper.

        :param cache_key:
            Key to use to lookup the helper value
        :param func:
            Function that computes the helper value. The function is called
            with the context as the only argument
        :returns:
            Return value of func(self, *args, **kwargs) (possibly computed
            earlier).

        Compute something that can be shared by all users of the device context
        This allows certain expensive computations to be performed only once.

        .. note::
            The caller is responsible for ensuring that ``args`` and ``kwargs``
            match the `cache_key` each time this function is called.
        """
        if cache_key not in self._shared_cache:
            self._shared_cache[cache_key] = func(*args, **kwargs)
        return self._shared_cache[cache_key]

    def invalidate_shared(self, cache_key):
        """Invalidate a cached shared value."""
        if cache_key in self._shared_cache:
            del self._shared_cache[cache_key]

    def _compute_override_map(self):
        """Compute the map of field overrides."""
        override_map = collections.OrderedDict()
        for test_plan in self._test_plan_list:
            support = TestPlanUnitSupport(test_plan)
            for pattern, override_list in support.override_list:
                override_map.setdefault(pattern, []).extend(override_list)
        return override_map

    def _invalidate_override_map(self, *args, **kwargs):
        """Invalidate the cached field override map."""
        self.invalidate_shared(self._CACHE_OVERRIDE_MAP)

    def _bulk_override_update(self):
        # NOTE: there is an O(N) algorithm for that solves this but it is more
        # complicated than I was able to write without a hard-copy reference
        # that describes it. I will improve this method once I complete the
        # required research.
        for job_state in self.state.job_state_map.values():
            job = job_state.job
            for pattern, override_list in self.override_map.items():
                if re.match(pattern, job.id):
                    job_state.apply_overrides(override_list)

    def _override_update(self, job):
        job_state = self.state.job_state_map[job.id]
        for pattern, override_list in self.override_map.items():
            if re.match(pattern, job.id):
                job_state.apply_overrides(override_list)

    def _update_mandatory_job_list(self):
        qualifier_list = []
        for test_plan in self._test_plan_list:
            qualifier_list.append(test_plan.get_mandatory_qualifier())
        mandatory_job_list = select_jobs(
            self.state.job_list, qualifier_list)
        self.state.update_mandatory_job_list(mandatory_job_list)
        self.state.update_desired_job_list(self.state.desired_job_list)


class SessionState:

    """
    Class representing all state needed during a single program session.

    This is the central glue/entry-point for applications. It connects user
    intents to the rest of the system / plumbing and keeps all of the state in
    one place.

    The set of utility methods and properties allow applications to easily
    handle the lower levels of dependencies, resources and ready states.

    :class:`SessionState` has the following instance variables, all of which
    are currently exposed as properties.

    :ivar list job_list: A list of all known jobs

        Not all the jobs from this list are going to be executed (or selected
        for execution) by the user.

        This list cannot have any duplicates, if that is the case a
        :class:`DependencyDuplicateError` is raised. This has to be handled
        externally and is a sign that the job database is corrupted or has
        wrong data. As an exception if duplicates are perfectly identical this
        error is silently corrected.

    :ivar list unit_list: A list of all known units

        This list contains all the known units, including all the know job
        definitions (and in the future, all test plans).

        It may change at runtime because of template instantiations.

    :ivar dict job_state_map: mapping that tracks the state of each job

        Mapping from job id to :class:`JobState`. This basically has the test
        result and the inhibitor of each job. It also serves as a
        :attr:`plainbox.impl.job.JobDefinition.id`-> job lookup helper.

        Directly exposed with the intent to fuel part of the UI. This is a way
        to get at the readiness state, result and readiness inhibitors, if any.

        XXX: this can loose data job_list has jobs with the same id. It would
        be better to use job id as the keys here. A separate map could be used
        for the id->job lookup. This will be fixed when session controller
        branch lands in trunk as then jobs are dynamically added to the system
        one at a time and proper error conditions can be detected and reported.

    :ivar list desired_job_list: subset of jobs selected for execution

        This is used to compute :attr:`run_list`. It can only be changed by
        calling :meth:`update_desired_job_list()` which returns meaningful
        values so this is not a settable property.

    :ivar list run_list: sorted list of jobs to execute

        This is basically a superset of desired_job_list and a subset of
        job_list that is topologically sorted to allowing all desired jobs to
        run. This property is updated whenever desired_job_list is changed.

    :ivar dict resource_map: all known resources

        A mapping from resource id to a list of
        :class:`plainbox.impl.resource.Resource` objects. This encapsulates all
        "knowledge" about the system plainbox is running on.


        It is needed to compute job readiness (as it stores resource data
        needed by resource programs). It is also available to exporters.

        This is computed internally from the output of checkbox resource jobs,
        it can only be changed by calling :meth:`update_job_result()`

    :ivar dict metadata: instance of :class:`SessionMetaData`
    """

    @morris.signal
    def on_job_state_map_changed(self):
        """
        Signal fired after job_state_map is changed in any way.

        This signal is always fired before any more specialized signals
        such as :meth:`on_job_result_changed()` and :meth:`on_job_added()`.

        This signal is fired pretty often, each time a job result is
        presented to the session and each time a job is added. When
        both of those events happen at the same time only one notification
        is sent. The actual state is not sent as it is quite extensive
        and can be easily looked at by the application.
        """

    @morris.signal
    def on_job_result_changed(self, job, result):
        """
        Signal fired after a job get changed (set).

        This signal is fired each time a result is presented to the session.

        This signal is fired **after** :meth:`on_job_state_map_changed()`
        """
        logger.info(_("Job %s result changed to %r"), job, result)

    @morris.signal
    def on_job_added(self, job):
        """
        Signal sent whenever a job is added to the session.

        This signal is fired **after** :meth:`on_job_state_map_changed()`
        """

    @morris.signal
    def on_job_removed(self, job):
        """
        Signal sent whenever a job is removed from the session.

        This signal is fired **after** :meth:`on_job_state_map_changed()`
        """

    @morris.signal
    def on_unit_added(self, unit):
        """Signal sent whenever a unit is added to the session."""

    @morris.signal
    def on_unit_removed(self, unit):
        """Signal sent whenever a unit is removed from the session."""

    def __init__(self, unit_list):
        """
        Initialize a new SessionState with a given list of units.

        The units are all of the units (including jobs) that the
        session knows about.
        """
        # Start by making a copy of job_list as we may modify it below
        job_list = [unit for unit in unit_list
                    if isinstance(unit, JobDefinition)]
        while True:
            try:
                # Construct a solver with the job list as passed by the caller.
                # This will do a little bit of validation and might raise
                # DepdendencyDuplicateError if there are any duplicates at this
                # stage.
                #
                # There's a single case that is handled here though, if both
                # jobs are identical this problem is silently fixed. This
                # should not happen in normal circumstances but is non the less
                # harmless (as long as both jobs are perfectly identical)
                #
                # Since this problem can happen any number of times (many
                # duplicates) this is performed in a loop. The loop breaks when
                # we cannot solve the problem _OR_ when no error occurs.
                DependencySolver(job_list)
            except DependencyDuplicateError as exc:
                # If both jobs are identical then silently fix the problem by
                # removing one of the jobs (here the second one we've seen but
                # it's not relevant as they are possibly identical) and try
                # again
                if exc.job == exc.duplicate_job:
                    job_list.remove(exc.duplicate_job)
                    continue
                else:
                    # If the jobs differ report this back to the caller
                    raise
            else:
                # If there are no problems then break the loop
                break
        self._job_list = job_list
        self._unit_list = unit_list
        self._job_state_map = {job.id: JobState(job)
                               for job in self._job_list}
        self._desired_job_list = []
        self._mandatory_job_list = []
        self._run_list = []
        self._resource_map = {}
        self._fake_resources = False
        self._metadata = SessionMetaData()
        super(SessionState, self).__init__()

    def trim_job_list(self, qualifier):
        """
        Discard jobs that are selected by the given qualifier.

        :param qualifier:
            A qualifier that selects jobs to be removed
        :ptype qualifier:
            IJobQualifier

        :raises ValueError:
            If any of the jobs selected by the qualifier is on the desired job
            list (or the run list)

        This function correctly and safely discards certain jobs from the job
        list. It also removes the associated job state (and referenced job
        result) and results (for jobs that were resource jobs)
        """
        # Build a list for each of the jobs in job_list, that tells us if we
        # should remove that job. This way we only call the qualifier once per
        # job and can do efficient operations later.
        #
        # The whole function should be O(N), where N is len(job_list)
        remove_flags = [
            qualifier.designates(job) for job in self._job_list]
        # Build a list of (job, should_remove) flags, we'll be using this list
        # a few times below.
        job_and_flag_list = list(zip(self._job_list, remove_flags))
        # Build a set of ids of jobs that we'll be removing
        remove_job_id_set = frozenset([
            job.id for job, should_remove in job_and_flag_list
            if should_remove is True])
        # Build a set of ids of jobs that are on the run list
        run_list_id_set = frozenset([job.id for job in self.run_list])
        # Check if this is safe to do. None of the jobs may be in the run list
        # (or the desired job list which is always a subset of run list)
        unremovable_job_id_set = remove_job_id_set.intersection(
            run_list_id_set)
        if unremovable_job_id_set:
            raise ValueError(
                _("cannot remove jobs that are on the run list: {}").format(
                    ', '.join(sorted(unremovable_job_id_set))))
        # Remove job state and resources (if present) for all the jobs we're
        # about to remove. Note that while each job has a state object not all
        # jobs generated resources so that removal is conditional.
        for job, should_remove in job_and_flag_list:
            if should_remove:
                del self._job_state_map[job.id]
                if job.id in self._resource_map:
                    del self._resource_map[job.id]
        # Compute a list of jobs to retain
        retain_list = [
            job for job, should_remove in job_and_flag_list
            if should_remove is False]
        # And a list of jobs to remove
        remove_list = [
            job for job, should_remove in job_and_flag_list
            if should_remove is True]
        # Replace job list with the filtered list
        self._job_list = retain_list
        if remove_list:
            # Notify that the job state map has changed
            self.on_job_state_map_changed()
            # And that each removed job was actually removed
            for job in remove_list:
                self.on_job_removed(job)
                self.on_unit_removed(job)

    def update_mandatory_job_list(self, mandatory_job_list):
        """
        Update the set of mandatory jobs (that must run).

        This method simply stores the list of mandatory jobs inside the session
        state. The next time the set of desired jobs is altered via a call
        :meth:`update_desired_job_list()` the effective selection will also
        include mandatory jobs.
        """
        self._mandatory_job_list = mandatory_job_list

    def update_desired_job_list(self, desired_job_list,
                                include_mandatory=True):
        """
        Update the set of desired jobs (that ought to run).

        This method can be used by the UI to recompute the dependency graph.
        The argument 'desired_job_list' is a list of jobs that should run.
        Those jobs must be a sub-collection of the job_list argument that was
        passed to the constructor.

        It never fails although it may reduce the actual permitted
        desired_job_list to an empty list. It returns a list of problems (all
        instances of DependencyError class), one for each job that had to be
        removed.
        """
        # Remember a copy of original desired job list. We may modify this list
        # so let's not mess up data passed by the caller.
        self._desired_job_list = []
        if include_mandatory:
            self._desired_job_list += self._mandatory_job_list
        self._desired_job_list += list(desired_job_list)
        # Reset run list just in case desired_job_list is empty
        self._run_list = []
        # Try to solve the dependency graph. This is done in a loop as may need
        # to remove a problematic job and re-try. The loop provides a stop
        # condition as we will eventually run out of jobs.
        problems = []
        # Get a copy of all the jobs as we'll be removing elements from this
        # list to come to a stable set in the loop below.
        job_list = self._job_list[:]
        while self._desired_job_list:
            # XXX: it might be more efficient to incorporate this 'recovery
            # mode' right into the solver, this way we'd probably save some
            # resources or runtime complexity.
            try:
                self._run_list = DependencySolver.resolve_dependencies(
                    job_list, self._desired_job_list)
            except DependencyError as exc:
                # When a dependency error is detected remove the affected job
                # form _desired_job_list and try again.
                if exc.affected_job in self._desired_job_list:
                    # The job may have been removed by now:
                    # https://bugs.launchpad.net/plainbox/+bug/1444126
                    self._desired_job_list.remove(exc.affected_job)
                if exc.affected_job in job_list:
                    # If the affected job is in the job list, remove it from
                    # the job list we're going to consider in the next run.
                    # This is done so that if a job depends on a broken but
                    # existing job, it won't constantly re-add the same broken
                    # job over and over (so that the algorithm can stop).
                    job_list.remove(exc.affected_job)
                # Remember each problem, this can be presented by the UI
                problems.append(exc)
                continue
            else:
                # Don't iterate the loop if there was no exception
                break
        # Update all job readiness state
        self._recompute_job_readiness()
        # Return all dependency problems to the caller
        return problems

    def get_estimated_duration(self, manual_overhead=30.0):
        """
        Estimate the total duration of the session.

        Provide the estimated duration of the jobs that have been selected
        to run in this session (maintained by calling update_desired_job_list).

        Manual jobs have an arbitrary figure added to their runtime to allow
        for execution of the test steps and verification of the result.

        :returns: (estimate_automated, estimate_manual)

        where estimate_automated is the value for automated jobs only and
        estimate_manual is the value for manual jobs only. These can be
        easily combined. Either value can be None if the  value could not be
        calculated due to any job lacking the required estimated_duration
        field.
        """
        estimate_automated = 0.0
        estimate_manual = 0.0
        for job in self._run_list:
            if job.automated and estimate_automated is not None:
                if job.estimated_duration is not None:
                    estimate_automated += job.estimated_duration
                else:
                    estimate_automated = None
            elif not job.automated and estimate_manual is not None:
                # We add a fixed extra amount of seconds to the run time
                # for manual jobs to account for the time taken in reading
                # the description and performing any necessary steps
                estimate_manual += manual_overhead
                if job.estimated_duration is not None:
                    estimate_manual += job.estimated_duration
                elif job.command:
                    estimate_manual = None
        return (estimate_automated, estimate_manual)

    def update_job_result(self, job, result):
        """
        Notice the specified test result and update readiness state.

        This function updates the internal result collection with the data from
        the specified test result. Results can safely override older results.
        Results also change the ready map (jobs that can run) because of
        dependency relations.

        Some results have deeper meaning, those are results for resource jobs.
        They are discussed in detail below:

        Resource jobs produce resource records which are used as data to run
        requirement expressions against. Each time a result for a resource job
        is presented to the session it will be parsed as a collection of RFC822
        records. A new entry is created in the resource map (entirely replacing
        any old entries), with a list of the resources that were parsed from
        the IO log.
        """
        job.controller.observe_result(
            self, job, result, fake_resources=self._fake_resources)
        self._recompute_job_readiness()

    @deprecated('0.9', 'use the add_unit() method instead')
    def add_job(self, new_job, recompute=True):
        """
        Add a new job to the session.

        :param new_job:
            The job being added
        :param recompute:
            If True, recompute readiness inhibitors for all jobs.
            You should only set this to False if you're adding
            a number of jobs and will otherwise ensure that
            :meth:`_recompute_job_readiness()` gets called before
            session state users can see the state again.
        :returns:
            The job that was actually added or an existing, identical
            job if a perfect clash was silently ignored.

        :raises DependencyDuplicateError:
            if a duplicate, clashing job definition is detected

        The new_job gets added to all the state tracking objects of the
        session.  The job is initially not selected to run (it is not in the
        desired_job_list and has the undesired inhibitor).

        The new_job may clash with an existing job with the same id. Unless
        both jobs are identical this will cause DependencyDuplicateError to be
        raised. Identical jobs are silently discarded.

        .. note::

            This method recomputes job readiness for all jobs
        """
        return self.add_unit(new_job, recompute)

    def add_unit(self, new_unit, recompute=True, via=None):
        """
        Add a new unit to the session.

        :param new_unit:
            The unit being added
        :param recompute:
            If True, recompute readiness inhibitors for all jobs.
            You should only set this to False if you're adding
            a number of jobs and will otherwise ensure that
            :meth:`_recompute_job_readiness()` gets called before
            session state users can see the state again.
        :returns:
            The unit that was actually added or an existing, identical
            unit if a perfect clash was silently ignored.

        :raises DependencyDuplicateError:
            if a duplicate, clashing job definition is detected

        .. note::
            The following applies only to newly added job units:

            The new_unit  gets added to all the state tracking objects of the
            session. The job unit is initially not selected to run (it is not
            in the desired_job_list and has the undesired inhibitor).

            The new_unit job may clash with an existing job with the same id.
            Unless both jobs are identical this will cause
            DependencyDuplicateError to be raised. Identical jobs are silently
            discarded.

        .. note::
            This method recomputes job readiness for all jobs unless the
            recompute=False argument is used. Recomputing takes a while so if
            you want to add a lot of units consider setting that to False and
            only recompute at the last call.
        """
        if new_unit.Meta.name == 'job':
            return self._add_job_unit(new_unit, recompute, via)
        else:
            return self._add_other_unit(new_unit)

    def _add_other_unit(self, new_unit):
        self.unit_list.append(new_unit)
        self.on_unit_added(new_unit)
        return new_unit

    def _add_job_unit(self, new_job, recompute, via):
        # See if we have a job with the same id already
        try:
            existing_job = self.job_state_map[new_job.id].job
        except KeyError:
            # Register the new job in our state
            self.job_state_map[new_job.id] = JobState(new_job)
            self.job_list.append(new_job)
            self.unit_list.append(new_job)
            self.on_job_state_map_changed()
            self.on_unit_added(new_job)
            self.on_job_added(new_job)
            self._add_job_siblings_unit(new_job, recompute, via)
            return new_job
        else:
            # If there is a clash report DependencyDuplicateError only when the
            # hashes are different.
            if new_job != existing_job and not self._fake_resources:
                raise DependencyDuplicateError(existing_job, new_job)
            self._add_job_siblings_unit(new_job, recompute, via)
            return existing_job
        finally:
            # Update all job readiness state
            if recompute:
                self._recompute_job_readiness()

    def _add_job_siblings_unit(self, new_job, recompute, via):
        if new_job.siblings:
            for overrides in json.loads(new_job.tr_siblings()):
                data = {
                    key: value for key, value in new_job._data.items()
                    if not key.endswith('siblings')
                }
                data.update(overrides)
                self._add_job_unit(
                    JobDefinition(
                        data,
                        origin=new_job.origin,
                        provider=new_job.provider,
                        controller=new_job.controller,
                        parameters=new_job.parameters,
                        field_offset_map=new_job.field_offset_map),
                    recompute,
                    via)
        if 'also-after-suspend' in new_job.get_flag_set():
            data = {
                key: value for key, value in new_job._data.items()
                if not key.endswith('siblings')
            }
            data['flags'] = data['flags'].replace('also-after-suspend', '')
            data['flags'] = data['flags'].replace(
                'also-after-suspend-manual', '')
            data['id'] = "after-suspend-{}".format(new_job.partial_id)
            data['_summary'] = "{} after suspend (S3)".format(
                new_job.summary)
            provider_id = "com.canonical.certification"
            suspend_test_id = "suspend/suspend_advanced_auto"
            if new_job.depends:
                data['depends'] += " {}".format(new_job.id)
            else:
                data['depends'] = "{}".format(new_job.id)
            data['depends'] += " {}::{}".format(provider_id, suspend_test_id)
            self._add_job_unit(
                JobDefinition(
                    data,
                    origin=new_job.origin,
                    provider=new_job.provider,
                    controller=new_job.controller,
                    parameters=new_job.parameters,
                    field_offset_map=new_job.field_offset_map),
                recompute,
                via)
        if 'also-after-suspend-manual' in new_job.get_flag_set():
            data = {
                key: value for key, value in new_job._data.items()
                if not key.endswith('siblings')
            }
            data['flags'] = data['flags'].replace('also-after-suspend', '')
            data['flags'] = data['flags'].replace(
                'also-after-suspend-manual', '')
            data['id'] = "after-suspend-manual-{}".format(new_job.partial_id)
            data['_summary'] = "{} after suspend (S3)".format(
                new_job.summary)
            provider_id = "com.canonical.certification"
            suspend_test_id = "suspend/suspend_advanced"
            if new_job.depends:
                data['depends'] += " {}".format(new_job.id)
            else:
                data['depends'] = "{}".format(new_job.id)
            data['depends'] += " {}::{}".format(provider_id, suspend_test_id)
            self._add_job_unit(
                JobDefinition(
                    data,
                    origin=new_job.origin,
                    provider=new_job.provider,
                    controller=new_job.controller,
                    parameters=new_job.parameters,
                    field_offset_map=new_job.field_offset_map),
                recompute,
                via)

    def remove_unit(self, unit, *, recompute=True):
        """
        Remove an existing unit from the session.

        :param unit:
            The unit to remove
        :param recompute:
            If True, recompute readiness inhibitors for all jobs.
            You should only set this to False if you're adding
            a number of jobs and will otherwise ensure that
            :meth:`_recompute_job_readiness()` gets called before
            session state users can see the state again.

        .. note::
            This method recomputes job readiness for all jobs unless the
            recompute=False argument is used. Recomputing takes a while so if
            you want to add a lot of units consider setting that to False and
            only recompute at the last call.
        """
        self._unit_list.remove(unit)
        self.on_unit_removed(unit)
        if unit.Meta.name == 'job':
            self._job_list.remove(unit)
            del self._job_state_map[unit.id]
            try:
                del self._resource_map[unit.id]
            except KeyError:
                pass
            if recompute:
                self._recompute_job_readiness()
            self.on_job_removed(unit)
            self.on_job_state_map_changed()

    def set_resource_list(self, resource_id, resource_list):
        """
        Add or change a resource with the given id.

        Resources silently overwrite any old resources with the same id.
        """
        self._resource_map[resource_id] = resource_list

    @property
    def job_list(self):
        """
        List of all known jobs.

        Not necessarily all jobs from this list can be, or are desired to run.
        For API simplicity this variable is read-only, if you wish to alter the
        list of all jobs re-instantiate this class please.
        """
        return self._job_list

    @property
    def mandatory_job_list(self):
        """
        List of all mandatory jobs that must run.

        Testplan units can specify a list of jobs that have to be run and are
        not supposed to be deselected by the application user.
        """
        return self._mandatory_job_list

    @property
    def unit_list(self):
        """List of all known units."""
        return self._unit_list

    @property
    def desired_job_list(self):
        """
        List of jobs that are on the "desired to run" list.

        This is a list, not a set, because the dependency solver algorithm
        retains as much of the original ordering as possible. Having said that,
        the actual order can differ widely (for instance, be reversed)
        """
        return self._desired_job_list

    @property
    def run_list(self):
        """
        List of jobs that were intended to run, in the proper order.

        The order is a result of topological sorting of the desired_job_list.
        This value is recomputed when change_desired_run_list() is called. It
        may be shorter than desired_run_list due to dependency errors.
        """
        return self._run_list

    @property
    def job_state_map(self):
        """Map from job id to JobState associated with each job."""
        return self._job_state_map

    @property
    def resource_map(self):
        """Map from resource id to a list of resource records."""
        return self._resource_map

    def get_outcome_stats(self):
        """
        Process the JobState map to get stats about the job outcomes.

        :returns:
            a mapping of "outcome": "total" key/value pairs

        .. note::
            Only the outcomes seen during this session are reported, not all
            possible values (such as crash, not implemented, ...).
        """
        stats = collections.defaultdict(int)
        for job_id, job_state in self.job_state_map.items():
            if not job_state.result.outcome:
                continue
            stats[job_state.result.outcome] += 1
        return stats

    def get_test_outcome_stats(self):
        """
        Process the JobState map to get stats about the job outcomes
        excluding attachment and resource jobs.

        :returns:
            a mapping of "outcome": "total" key/value pairs

        .. note::
            Only the outcomes seen during this session are reported, not all
            possible values (such as crash, not implemented, ...).
        """
        stats = collections.defaultdict(int)
        for job_id, job_state in self.job_state_map.items():
            if (not job_state.result.outcome or
                    job_state.job.plugin in ("resource", "attachment")):
                continue
            stats[job_state.result.outcome] += 1
        return stats

    @property
    def category_map(self):
        """Map from category id to their corresponding translated names."""
        wanted_category_ids = frozenset({
            job_state.effective_category_id
            for job_state in self.job_state_map.values()
            if job_state.result.outcome != None
        })
        return {
            unit.id: unit.tr_name()
            for unit in self.unit_list
            if unit.Meta.name == 'category'
            and unit.id in wanted_category_ids
        }

    @property
    def category_map_lite(self):
        """
        Map from category id to their corresponding translated names but
        without taking into account resources and attachments jobs.

        Meant to be used to generate the HTML reports where resources and
        attachments are presented in different sections.
        """
        wanted_category_ids = frozenset({
            job_state.effective_category_id
            for job_state in self.job_state_map.values()
            if job_state.result.outcome != None and
            job_state.job.plugin not in ("resource", "attachment")
        })
        return {
            unit.id: unit.tr_name()
            for unit in self.unit_list
            if unit.Meta.name == 'category'
            and unit.id in wanted_category_ids
        }

    @property
    def category_outcome_map(self):
        """Map from category id to their corresponding global outcome."""
        wanted_category_ids = frozenset({
            job_state.effective_category_id
            for job_state in self.job_state_map.values()
            if job_state.result.outcome != None
        })
        tmp_result_map = {}
        for job_state in self.job_state_map.values():
            if job_state.job.plugin in ("resource", "attachment"):
                continue
            category = job_state.effective_category_id
            if category not in wanted_category_ids:
                continue
            # Generate categories status
            child_status = job_state.result.outcome
            if category not in tmp_result_map:
                tmp_result_map[category] = IJobResult.OUTCOME_SKIP
            if child_status in (
                IJobResult.OUTCOME_FAIL, IJobResult.OUTCOME_CRASH
            ):
                tmp_result_map[category] = IJobResult.OUTCOME_FAIL
            elif (
                child_status == IJobResult.OUTCOME_PASS and
                tmp_result_map[category] != IJobResult.OUTCOME_FAIL
            ):
                tmp_result_map[category] = IJobResult.OUTCOME_PASS
            elif (
                tmp_result_map[category] not in
                (IJobResult.OUTCOME_PASS, IJobResult.OUTCOME_FAIL)
            ):
                tmp_result_map[category] = IJobResult.OUTCOME_SKIP
        return tmp_result_map

    @property
    def resource_global_outcome(self):
        global_outcome = IJobResult.OUTCOME_SKIP
        for job_state in self.job_state_map.values():
            if (
                job_state.job.plugin != "resource" or
                not job_state.result.outcome
            ):
                continue
            # Generate categories status
            child_status = job_state.result.outcome
            if child_status in (
                IJobResult.OUTCOME_FAIL, IJobResult.OUTCOME_CRASH
            ):
                global_outcome = IJobResult.OUTCOME_FAIL
            elif (
                child_status == IJobResult.OUTCOME_PASS and
                global_outcome != IJobResult.OUTCOME_FAIL
            ):
                global_outcome = IJobResult.OUTCOME_PASS
            elif (
                global_outcome not in
                (IJobResult.OUTCOME_PASS, IJobResult.OUTCOME_FAIL)
            ):
                global_outcome = IJobResult.OUTCOME_SKIP
        return global_outcome

    @property
    def attachment_global_outcome(self):
        global_outcome = IJobResult.OUTCOME_SKIP
        for job_state in self.job_state_map.values():
            if (
                job_state.job.plugin != "attachment" or
                not job_state.result.outcome
            ):
                continue
            # Generate categories status
            child_status = job_state.result.outcome
            if child_status in (
                IJobResult.OUTCOME_FAIL, IJobResult.OUTCOME_CRASH
            ):
                global_outcome = IJobResult.OUTCOME_FAIL
            elif (
                child_status == IJobResult.OUTCOME_PASS and
                global_outcome != IJobResult.OUTCOME_FAIL
            ):
                global_outcome = IJobResult.OUTCOME_PASS
            elif (
                global_outcome not in
                (IJobResult.OUTCOME_PASS, IJobResult.OUTCOME_FAIL)
            ):
                global_outcome = IJobResult.OUTCOME_SKIP
        return global_outcome

    def get_certification_status_map(
            self, outcome_filter=(IJobResult.OUTCOME_FAIL,),
            certification_status_filter=('blocker',)
    ):
        """
        Get a map of jobs that have a specific certification blocker status.

        Filter the Job state map to only return items with given outcomes and
        certification statuses.

        :param outcome_filter:
            Only consider job results with those outcome values
        :param certification_status_filter:
            Only consider jobs with those certification status values
        :returns:
            a Job state map only containing job with a given outcome and
            certification status value.
        """
        return {
            job_id: job_state
            for job_id, job_state in self.job_state_map.items()
            if (job_state.result.outcome in outcome_filter and
                job_state.effective_certification_status in
                certification_status_filter)
        }

    @property
    def metadata(self):
        """meta-data object associated with this session state."""
        return self._metadata

    def _recompute_job_readiness(self):
        """
        Internal method of SessionState.

        Re-computes [job_state.ready
                     for job_state in _job_state_map.values()]
        """
        # Reset the state of all jobs to have the undesired inhibitor. Since
        # we maintain a state object for _all_ jobs (including ones not in the
        # _run_list this correctly updates all values in the _job_state_map
        # (the UI can safely use the readiness state of all jobs)
        for job_state in self._job_state_map.values():
            job_state.readiness_inhibitor_list = [
                UndesiredJobReadinessInhibitor]
        # Take advantage of the fact that run_list is topologically sorted and
        # do a single O(N) pass over _run_list. All "current/update" state is
        # computed before it needs to be observed (thanks to the ordering)
        for job in self._run_list:
            job_state = self._job_state_map[job.id]
            # Remove the undesired inhibitor as we want to run this job
            try:
                job_state.readiness_inhibitor_list.remove(
                    UndesiredJobReadinessInhibitor)
            except ValueError:
                pass
            # Ask the job controller about inhibitors affecting this job
            for inhibitor in job.controller.get_inhibitor_list(self, job):
                job_state.readiness_inhibitor_list.append(inhibitor)
