summaryrefslogtreecommitdiffstats
path: root/tests/unit/test_plugin.py
blob: 31f2e7a7b833b2ced583b5770ee0d6f5d1738c2f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# 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 cfg
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 SimplerNotifier(object):
    def notify(self, context, message):
        global simpler_notify_called
        simpler_notify_called = True


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.stubs.Set(cfg.CONF, 'notification_driver',
                       SimplerNotifier())
        global simpler_notify_called
        simpler_notify_called = False

    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)

        # Verify that the original baseline notifier is still
        # installed and working.
        global simpler_notify_called
        self.assertTrue(simpler_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)