Merge lp:~zyga/checkbox/misc into lp:checkbox

[Zygmunt Krynicki]

A few small support patches for the hwcollect branch. I wanted to have them separate so that it's easier to iterate.

[Maciej Kisielewski (kissiel)]

all good! +1

review: Approve

=== modified file 'plainbox/plainbox/impl/runner.py'
--- plainbox/plainbox/impl/runner.py	2015-05-28 09:37:32 +0000
+++ plainbox/plainbox/impl/runner.py	2015-08-03 09:26:20 +0000
@@ -207,7 +207,7 @@
         Initialize the JobRunnerUIDelegate.
 
         :param ui:
-            (optional) an instnace of IJobRunnerUI to delegate events to
+            (optional) an instance of IJobRunnerUI to delegate events to
         """
         self.ui = ui
 

=== modified file 'plainbox/plainbox/impl/secure/providers/test_v1.py'
--- plainbox/plainbox/impl/secure/providers/test_v1.py	2015-07-14 08:20:55 +0000
+++ plainbox/plainbox/impl/secure/providers/test_v1.py	2015-08-03 09:26:20 +0000
@@ -809,12 +809,22 @@
         fake_content = [
             PlugIn(self.JOBS_DIR + "/path/to/jobs1.txt", (
                 "id: a2\n"
+                "plugin: shell\n"
+                "command: true\n"
                 "\n"
-                "id: a1\n")),
+                "id: a1\n"
+                "plugin: shell\n"
+                "command: true\n"
+            )),
             PlugIn(self.JOBS_DIR + "/path/to/jobs2.txt", (
                 "id: a3\n"
+                "plugin: shell\n"
+                "command: true\n"
                 "\n"
-                "id: a4\n"))]
+                "id: a4\n"
+                "plugin: shell\n"
+                "command: true\n"
+            ))]
         fake_problems = [IOError("first problem"), OSError("second problem")]
         with self.provider.fake(fake_content, fake_problems):
             job_list = self.provider.job_list

=== modified file 'plainbox/plainbox/impl/secure/providers/v1.py'
--- plainbox/plainbox/impl/secure/providers/v1.py	2015-07-14 08:20:55 +0000
+++ plainbox/plainbox/impl/secure/providers/v1.py	2015-08-03 09:26:20 +0000
@@ -73,8 +73,8 @@
     """
 
     def __init__(self, filename, text, load_time, provider, *,
-                 validate=True, validation_kwargs=None,
-                 check=False, context=None):
+                 validate=False, validation_kwargs=None,
+                 check=True, context=None):
         start_time = now()
         try:
             # Inspect the file
@@ -207,8 +207,8 @@
     # NOTE: This version of __init__() exists solely so that provider can
     # default to None. This is still used in some places and must be supported.
     def __init__(self, filename, text, load_time, provider=None, *,
-                 validate=True, validation_kwargs=None,
-                 check=False, context=None):
+                 validate=False, validation_kwargs=None,
+                 check=True, context=None):
         super().__init__(
             filename, text, load_time, provider, validate=validate,
             validation_kwargs=validation_kwargs, check=check, context=context)
@@ -731,8 +731,8 @@
 
     def __init__(self, name, namespace, version, description, secure,
                  gettext_domain, units_dir, jobs_dir, whitelists_dir, data_dir,
-                 bin_dir, locale_dir, base_dir, *, validate=True,
-                 validation_kwargs=None, check=False, context=None):
+                 bin_dir, locale_dir, base_dir, *, validate=False,
+                 validation_kwargs=None, check=True, context=None):
         """
         Initialize a provider with a set of meta-data and directories.
 
@@ -844,7 +844,7 @@
 
     @classmethod
     def from_definition(cls, definition, secure, *,
-                        validate=True, validation_kwargs=None, check=False,
+                        validate=False, validation_kwargs=None, check=True,
                         context=None):
         """
         Initialize a provider from Provider1Definition object

=== modified file 'plainbox/plainbox/impl/session/state.py'
--- plainbox/plainbox/impl/session/state.py	2015-04-16 20:49:41 +0000
+++ plainbox/plainbox/impl/session/state.py	2015-08-03 09:26:20 +0000
@@ -34,6 +34,7 @@
 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
 
@@ -260,6 +261,7 @@
         # the SessionState)
         self._state.on_unit_added.connect(self.on_unit_added)
         self._state.on_unit_removed.connect(self.on_unit_removed)
+        self._unit_id_map = {}
 
     @property
     def device(self):
@@ -425,6 +427,26 @@
         # 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
+
     def get_ctrl_for_job(self, job):
         """
         Get the execution controller most applicable to run this job.
@@ -472,6 +494,8 @@
         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):
@@ -482,6 +506,8 @@
     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):
         """

=== modified file 'plainbox/plainbox/impl/transport.py'
--- plainbox/plainbox/impl/transport.py	2014-09-13 11:37:17 +0000
+++ plainbox/plainbox/impl/transport.py	2015-08-03 09:26:20 +0000
@@ -18,6 +18,8 @@
 # along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
 
 """
+Shared code for test data transports..
+
 :mod:`plainbox.impl.transport` -- shared code for test data transports
 ======================================================================
 
@@ -28,24 +30,32 @@
 
 from collections import OrderedDict
 from logging import getLogger
-
 import pkg_resources
+import re
 
 from plainbox.abc import ISessionStateTransport
 from plainbox.i18n import gettext as _
+from plainbox.impl.secure.config import Unset
+
+import requests
 
 
 logger = getLogger("plainbox.transport")
 
 
 class TransportError(Exception):
+
     """
-    Base class for problems encountered by the any ISessionStateTransport
-    during execution.
+    Base class for any problems related to transports.
+
+    This class acts the base exception for any and all problems encountered by
+    the any ISessionStateTransport during execution. Typically this is raised
+    from .send() that failed in some way.
     """
 
 
 class TransportBase(ISessionStateTransport):
+
     """
     Base class for transports that send test data somewhere.
 
@@ -62,6 +72,18 @@
     """
 
     def __init__(self, where, option_string):
+        """
+        Initialize the transport base class.
+
+        :param where:
+            A generalized form of "destination". This can be a file name, an
+            URL or anything appropriate for the given transport.
+        :param option_string:
+            Additional options appropriate for the transport, encoded as a
+            comma-separated list of key=value pairs.
+        :raises ValueError:
+            If the option string is malformed.
+        """
         self.url = where
         # parse option string only if there's at least one k=v pair
         self.options = {}