Source code for plainbox.impl.providers.v1
# This file is part of Checkbox.
#
# Copyright 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.providers.v1` -- Implementation of V1 provider
==================================================================
Most of the implementation is available in
:mod:`plainbox.impl.secure.providers.v1`
"""
__all__ = ['DummyProvider1', 'Provider1', 'InsecureProvider1PlugInCollection',
'all_providers', 'get_insecure_PROVIDERPATH_list', ]
import logging
import os
from plainbox.abc import IProvider1, IProviderBackend1
from plainbox.impl.secure.plugins import FsPlugInCollection
from plainbox.impl.secure.providers.v1 import Provider1
from plainbox.impl.secure.providers.v1 import Provider1PlugIn
from plainbox.impl.secure.providers.v1 import get_secure_PROVIDERPATH_list
logger = logging.getLogger("plainbox.providers.v1")
[docs]class DummyProvider1(IProvider1, IProviderBackend1):
"""
Dummy provider useful for creating isolated test cases
"""
def __init__(self, job_list=None, whitelist_list=None, **extras):
self._job_list = job_list or []
self._whitelist_list = whitelist_list or []
self._extras = extras
self._patch_provider_field()
def _patch_provider_field(self):
# NOTE: each v1 job needs a _provider attribute that points to the
# provider. Since many tests use make_job() which does not set it for
# obvious reasons it needs to be patched-in.
for job in self._job_list:
if job._provider is None:
job._provider = self
@property
[docs] def name(self):
return self._extras.get('name', "2013.com.canonical.plainbox:dummy")
@property
[docs] def namespace(self):
return self.name.split(':', 1)[0]
@property
[docs] def version(self):
return self._extras.get('version', '1.0')
@property
[docs] def description(self):
# XXX: how do we handle provider meta-data? Do we translate it it at
# display time or at access time?
return self._extras.get(
'description', "A dummy provider useful for testing")
@property
[docs] def gettext_domain(self):
return self._extras.get('gettext_domain', "")
@property
[docs] def CHECKBOX_SHARE(self):
return self._extras.get('CHECKBOX_SHARE', "")
@property
@property
[docs] def bin_dir(self):
return self._extras.get("bin_dir")
@property
[docs] def jobs_dir(self):
return self._extras.get("jobs_dir")
@property
[docs] def whitelists_dir(self):
return self._extras.get("whitelists_dir")
@property
[docs] def locale_dir(self):
return self._extras.get("locale_dir")
@property
[docs] def data_dir(self):
return self._extras.get("data_dir")
@property
[docs] def base_dir(self):
return self._extras.get("base_dir")
[docs] def secure(self):
return False
[docs] def get_builtin_whitelists(self):
return self._whitelist_list
[docs] def get_builtin_jobs(self):
return self._job_list
[docs] def load_all_jobs(self):
return self._job_list, []
[docs] def get_all_executables(self):
return self._extras.get("get_all_executables", [])
def get_user_PROVIDERPATH_entry():
"""
Computes the per-user component of PROVIDERPATH
:returns:
`$XDG_DATA_HOME/plainbox-providers-1`
"""
XDG_DATA_HOME = os.getenv(
'XDG_DATA_HOME', os.path.expanduser("~/.local/share/"))
return os.path.join(XDG_DATA_HOME, "plainbox-providers-1")
[docs]def get_insecure_PROVIDERPATH_list():
"""
Computes the insecure value of PROVIDERPATH.
This value is *not* used by `plainbox-trusted-launcher-1` executable since
it would involve reading files outside of the control by the local
administrator. This value is used for handing non-root jobs.
:returns:
A list of three strings:
* `/usr/local/share/plainbox-providers-1`
* `/usr/share/plainbox-providers-1`
* `$XDG_DATA_HOME/plainbox-providers-1`
"""
return get_secure_PROVIDERPATH_list() + [get_user_PROVIDERPATH_entry()]
[docs]class InsecureProvider1PlugInCollection(FsPlugInCollection):
"""
A collection of v1 provider plugins.
This FsPlugInCollection subclass carries proper, built-in defaults, that
make loading providers easier.
This particular class loads providers from both the system-wide managed
locations and per-user location. In addition the list of locations searched
can be changed by setting the ``PROVIDERPATH``, which behaves just like
PATH, but is used for looking up providers.
"""
def __init__(self):
PROVIDERPATH = os.getenv("PROVIDERPATH")
if PROVIDERPATH is None:
dir_list = get_insecure_PROVIDERPATH_list()
else:
dir_list = PROVIDERPATH.split(os.path.pathsep)
super().__init__(dir_list, '.provider', wrapper=Provider1PlugIn)
# Collection of all providers
all_providers = InsecureProvider1PlugInCollection()