diff options
| -rw-r--r-- | openstack/common/plugin/__init__.py | 14 | ||||
| -rw-r--r-- | openstack/common/plugin/callbackplugin.py | 93 | ||||
| -rw-r--r-- | openstack/common/plugin/plugin.py | 87 | ||||
| -rw-r--r-- | openstack/common/plugin/pluginmanager.py | 86 | ||||
| -rw-r--r-- | tests/unit/plugin/__init__.py | 14 | ||||
| -rw-r--r-- | tests/unit/plugin/test_callback_plugin.py | 92 | ||||
| -rw-r--r-- | tests/unit/test_plugin.py | 145 |
7 files changed, 531 insertions, 0 deletions
diff --git a/openstack/common/plugin/__init__.py b/openstack/common/plugin/__init__.py new file mode 100644 index 0000000..63c3905 --- /dev/null +++ b/openstack/common/plugin/__init__.py @@ -0,0 +1,14 @@ +# Copyright 2012 OpenStack LLC. +# All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. diff --git a/openstack/common/plugin/callbackplugin.py b/openstack/common/plugin/callbackplugin.py new file mode 100644 index 0000000..bb56a40 --- /dev/null +++ b/openstack/common/plugin/callbackplugin.py @@ -0,0 +1,93 @@ +# Copyright 2012 OpenStack LLC. +# All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +from openstack.common.plugin import plugin +from openstack.common import log as logging + + +LOG = logging.getLogger(__name__) + + +class _CallbackNotifier(object): + """Manages plugin-defined notification callbacks. + + For each Plugin, a CallbackNotifier will be added to the + notification driver list. Calls to notify() with appropriate + messages will be hooked and prompt callbacks. + + A callback should look like this: + def callback(context, message, user_data) + """ + + def __init__(self): + self._callback_dict = {} + + def _add_callback(self, event_type, callback, user_data): + callback_list = self._callback_dict.get(event_type, []) + callback_list.append({'function': callback, + 'user_data': user_data}) + self._callback_dict[event_type] = callback_list + + def _remove_callback(self, callback): + for callback_list in self._callback_dict.values(): + for entry in callback_list: + if entry['function'] == callback: + callback_list.remove(entry) + + def notify(self, context, message): + if message.get('event_type') not in self._callback_dict: + return + + for entry in self._callback_dict[message.get('event_type')]: + entry['function'](context, message, entry.get('user_data')) + + def callbacks(self): + return self._callback_dict + + +class CallbackPlugin(plugin.Plugin): + """ Plugin with a simple callback interface. + + This class is provided as a convenience for producing a simple + plugin that only watches a couple of events. For example, here's + a subclass which prints a line the first time an instance is created. + + class HookInstanceCreation(CallbackPlugin): + + def __init__(self, _service_name): + super(HookInstanceCreation, self).__init__() + self._add_callback(self.magic, 'compute.instance.create.start') + + def magic(self): + print "An instance was created!" + self._remove_callback(self, self.magic) + """ + + def __init__(self, service_name): + super(CallbackPlugin, self).__init__(service_name) + self._callback_notifier = _CallbackNotifier() + self._add_notifier(self._callback_notifier) + + def _add_callback(self, callback, event_type, user_data=None): + """Add callback for a given event notification. + + Subclasses can call this as an alternative to implementing + a fullblown notify notifier. + """ + self._callback_notifier._add_callback(event_type, callback, user_data) + + def _remove_callback(self, callback): + """Remove all notification callbacks to specified function.""" + self._callback_notifier._remove_callback(callback) diff --git a/openstack/common/plugin/plugin.py b/openstack/common/plugin/plugin.py new file mode 100644 index 0000000..9f06342 --- /dev/null +++ b/openstack/common/plugin/plugin.py @@ -0,0 +1,87 @@ +# Copyright 2012 OpenStack LLC. +# All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +from openstack.common import log as logging +from openstack.common.notifier import list_notifier + + +LOG = logging.getLogger(__name__) + + +class Plugin(object): + """Defines an interface for adding functionality to an OpenStack service. + + A plugin interacts with a service via the following pathways: + + - An optional set of notifiers, managed by calling add_notifier() + or by overriding _notifiers() + + - A set of api extensions, managed via add_api_extension_descriptor() + + - Direct calls to service functions. + + - Whatever else the plugin wants to do on its own. + + This is the reference implementation. + """ + + # The following functions are provided as convenience methods + # for subclasses. Subclasses should call them but probably not + # override them. + def _add_api_extension_descriptor(self, descriptor): + """Subclass convenience method which adds an extension descriptor. + + Subclass constructors should call this method when + extending a project's REST interface. + + Note that once the api service has loaded, the + API extension set is more-or-less fixed, so + this should mainly be called by subclass constructors. + """ + self._api_extension_descriptors.append(descriptor) + + def _add_notifier(self, notifier): + """Subclass convenience method which adds a notifier. + + Notifier objects should implement the function notify(message). + Each notifier receives a notify() call whenever an openstack + service broadcasts a notification. + + Best to call this during construction. Notifiers are enumerated + and registered by the pluginmanager at plugin load time. + """ + self._notifiers.append(notifier) + + # The following methods are called by OpenStack services to query + # plugin features. Subclasses should probably not override these. + def _notifiers(self): + """Returns list of notifiers for this plugin.""" + return self._notifiers + + notifiers = property(_notifiers) + + def _api_extension_descriptors(self): + """Return a list of API extension descriptors. + + Called by a project API during its load sequence. + """ + return self._api_extension_descriptors + + api_extension_descriptors = property(_api_extension_descriptors) + + # Most plugins will override this: + def __init__(self, service_name): + self._notifiers = [] + self._api_extension_descriptors = [] diff --git a/openstack/common/plugin/pluginmanager.py b/openstack/common/plugin/pluginmanager.py new file mode 100644 index 0000000..0095135 --- /dev/null +++ b/openstack/common/plugin/pluginmanager.py @@ -0,0 +1,86 @@ +# Copyright 2012 OpenStack LLC. +# All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import imp +import os +import pkg_resources + +from openstack.common import cfg +from openstack.common import log as logging +from openstack.common.notifier import list_notifier + + +CONF = cfg.CONF +LOG = logging.getLogger(__name__) + + +class PluginManager(object): + """Manages plugin entrypoints and loading. + + For a service to implement this plugin interface for callback purposes: + + - Make use of the openstack-common notifier system + - Instantiate this manager in each process (passing in + project and service name) + + For an API service to extend itself using this plugin interface, + it needs to query the plugin_extension_factory provided by + the already-instantiated PluginManager. + """ + + def __init__(self, project_name, service_name): + """ Construct Plugin Manager; load and initialize plugins. + + project_name (e.g. 'nova' or 'glance') is used + to construct the entry point that identifies plugins. + + The service_name (e.g. 'compute') is passed on to + each plugin as a raw string for it to do what it will. + """ + self._project_name = project_name + self._service_name = service_name + self.plugins = [] + + # Make sure we're using the list_notifier. + if not hasattr(CONF, "list_notifier_drivers"): + CONF.list_notifier_drivers = [] + old_notifier = CONF.notification_driver + CONF.notification_driver = 'openstack.common.notifier.list_notifier' + if (old_notifier and + old_notifier != 'openstack.common.notifier.list_notifier'): + list_notifier.add_driver(old_notifier) + + def load_plugins(self): + self.plugins = [] + + for entrypoint in pkg_resources.iter_entry_points('%s.plugin' % + self._project_name): + try: + pluginclass = entrypoint.load() + plugin = pluginclass(self._service_name) + self.plugins.append(plugin) + except Exception, exc: + LOG.error(_("Failed to load plugin %(plug)s: %(exc)s") % + {'plug': entrypoint, 'exc': exc}) + + for plugin in self.plugins: + for notifier in plugin.notifiers: + list_notifier.add_driver(notifier) + + def plugin_extension_factory(self, ext_mgr): + for plugin in self.plugins: + descriptors = plugin.api_extension_descriptors + for descriptor in descriptors: + ext_mgr.load_extension(descriptor) diff --git a/tests/unit/plugin/__init__.py b/tests/unit/plugin/__init__.py new file mode 100644 index 0000000..63c3905 --- /dev/null +++ b/tests/unit/plugin/__init__.py @@ -0,0 +1,14 @@ +# Copyright 2012 OpenStack LLC. +# All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. diff --git a/tests/unit/plugin/test_callback_plugin.py b/tests/unit/plugin/test_callback_plugin.py new file mode 100644 index 0000000..a950392 --- /dev/null +++ b/tests/unit/plugin/test_callback_plugin.py @@ -0,0 +1,92 @@ +# Copyright 2012 OpenStack LLC. +# All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import pkg_resources + +from openstack.common.notifier import api as notifier_api +from openstack.common.plugin import callbackplugin +from openstack.common.plugin import pluginmanager +from tests import utils as test_utils + +userdatastring = "magic user data string" + + +class TestCBP(callbackplugin.CallbackPlugin): + + def callback1(self, context, message, userdata): + self.callback1count += 1 + + def callback2(self, context, message, userdata): + self.callback2count += 1 + + def callback3(self, context, message, userdata): + self.callback3count += 1 + self.userdata = userdata + + def __init__(self, service_name): + super(TestCBP, self).__init__(service_name) + self.callback1count = 0 + self.callback2count = 0 + self.callback3count = 0 + + self._add_callback(self.callback1, 'type1', None) + self._add_callback(self.callback2, 'type1', None) + self._add_callback(self.callback3, 'type2', 'magic user data string') + + +class CallbackTestCase(test_utils.BaseTestCase): + """Tests for the callback plugin convenience class""" + + def test_callback_plugin_subclass(self): + + class MockEntrypoint(pkg_resources.EntryPoint): + def load(self): + return TestCBP + + def mock_iter_entry_points(_t): + return [MockEntrypoint("fake", "fake", ["fake"])] + + self.stubs.Set(pkg_resources, 'iter_entry_points', + mock_iter_entry_points) + + plugmgr = pluginmanager.PluginManager("testproject", "testservice") + plugmgr.load_plugins() + self.assertEqual(len(plugmgr.plugins), 1) + plugin = plugmgr.plugins[0] + self.assertEqual(len(plugin.notifiers), 1) + + notifier_api.notify('contextarg', 'publisher_id', 'type1', + notifier_api.WARN, dict(a=3)) + + self.assertEqual(plugin.callback1count, 1) + self.assertEqual(plugin.callback2count, 1) + self.assertEqual(plugin.callback3count, 0) + + notifier_api.notify('contextarg', 'publisher_id', 'type2', + notifier_api.WARN, dict(a=3)) + + self.assertEqual(plugin.callback1count, 1) + self.assertEqual(plugin.callback2count, 1) + self.assertEqual(plugin.callback3count, 1) + self.assertEqual(plugin.userdata, userdatastring) + + plugin._remove_callback(plugin.callback1) + + notifier_api.notify('contextarg', 'publisher_id', 'type1', + notifier_api.WARN, dict(a=3)) + + self.assertEqual(plugin.callback1count, 1) + self.assertEqual(plugin.callback2count, 2) + self.assertEqual(plugin.callback3count, 1) diff --git a/tests/unit/test_plugin.py b/tests/unit/test_plugin.py new file mode 100644 index 0000000..cfbbb23 --- /dev/null +++ b/tests/unit/test_plugin.py @@ -0,0 +1,145 @@ +# Copyright 2012 OpenStack LLC. +# All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import pkg_resources +import unittest + +from openstack.common import notifier +from openstack.common.notifier import api as notifier_api +from openstack.common.notifier import no_op_notifier +from openstack.common.plugin import plugin +from openstack.common.plugin import pluginmanager +from tests import utils as test_utils + + +class SimpleNotifier(object): + def __init__(self): + self.message_list = [] + + def notify(self, context, message): + self.context = context + self.message_list.append(message) + + +class ManagerTestCase(test_utils.BaseTestCase): + def tearDown(self): + super(ManagerTestCase, self).tearDown() + + def test_constructs(self): + manager1 = pluginmanager.PluginManager("testproject", "testservice") + self.assertNotEqual(manager1, False) + + +class NotifyTestCase(test_utils.BaseTestCase): + """Test case for the plugin notification interface""" + def setUp(self): + super(NotifyTestCase, self).setUp() + + # Set up a 'normal' notifier to make sure the plugin logic + # doesn't mess anything up. + self.config( + notification_driver='openstack.common.notifier.no_op_notifier') + + def mock_notify(cls, *args): + self.no_op_notify_called = True + self.stubs.Set(no_op_notifier, 'notify', + mock_notify) + + def tearDown(self): + super(NotifyTestCase, self).tearDown() + + def test_add_notifier(self): + notifier1 = SimpleNotifier() + notifier2 = SimpleNotifier() + notifier3 = SimpleNotifier() + + testplugin = plugin.Plugin('service') + testplugin._add_notifier(notifier1) + testplugin._add_notifier(notifier2) + self.assertEqual(len(testplugin.notifiers), 2) + + testplugin._add_notifier(notifier3) + self.assertEqual(len(testplugin.notifiers), 3) + + def test_notifier_action(self): + def mock_iter_entry_points(_t): + return [MockEntrypoint("fake", "fake", ["fake"])] + + self.stubs.Set(pkg_resources, 'iter_entry_points', + mock_iter_entry_points) + + plugmgr = pluginmanager.PluginManager("testproject", "testservice") + plugmgr.load_plugins() + self.assertEqual(len(plugmgr.plugins), 1) + self.assertEqual(len(plugmgr.plugins[0].notifiers), 1) + notifier = plugmgr.plugins[0].notifiers[0] + + notifier_api.notify('contextarg', 'publisher_id', 'event_type', + notifier_api.WARN, dict(a=3)) + + self.assertEqual(len(notifier.message_list), 1) + self.assertTrue(self.no_op_notify_called) + + +class StubControllerExtension(object): + name = 'stubextension' + alias = 'stubby' + + +class TestPluginClass(plugin.Plugin): + + def __init__(self, service_name): + super(TestPluginClass, self).__init__(service_name) + self._add_api_extension_descriptor(StubControllerExtension) + notifier1 = SimpleNotifier() + self._add_notifier(notifier1) + + +class MockEntrypoint(pkg_resources.EntryPoint): + def load(self): + return TestPluginClass + + +class MockExtManager(): + def __init__(self): + self.descriptors = [] + + def load_extension(self, descriptor): + self.descriptors.append(descriptor) + + +class APITestCase(test_utils.BaseTestCase): + """Test case for the plugin api extension interface""" + def tearDown(self): + super(APITestCase, self).tearDown() + + def test_add_extension(self): + def mock_load(_s): + return TestPluginClass() + + def mock_iter_entry_points(_t): + return [MockEntrypoint("fake", "fake", ["fake"])] + + self.stubs.Set(pkg_resources, 'iter_entry_points', + mock_iter_entry_points) + + stubLoaded = False + + mgr = MockExtManager() + plugmgr = pluginmanager.PluginManager("testproject", "testservice") + plugmgr.load_plugins() + plugmgr.plugin_extension_factory(mgr) + + self.assertTrue(StubControllerExtension in mgr.descriptors) |