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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
|
# Copyright 2011 OpenStack Foundation.
# 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 socket
from oslo.config import cfg
from openstack.common import context
from openstack.common import log
from openstack.common.notifier import api as notifier_api
from openstack.common.notifier import log_notifier
from openstack.common.notifier import no_op_notifier
from openstack.common import rpc
from tests import utils as test_utils
ctxt = context.get_admin_context()
ctxt2 = context.get_admin_context()
class NotifierTestCase(test_utils.BaseTestCase):
"""Test case for notifications."""
def setUp(self):
super(NotifierTestCase, self).setUp()
notification_driver = [
'openstack.common.notifier.no_op_notifier'
]
self.config(notification_driver=notification_driver)
self.config(default_publisher_id='publisher')
self.addCleanup(notifier_api._reset_drivers)
def test_send_notification(self):
self.notify_called = False
def mock_notify(cls, *args):
self.notify_called = True
self.stubs.Set(no_op_notifier, 'notify',
mock_notify)
notifier_api.notify(ctxt, 'publisher_id', 'event_type',
notifier_api.WARN, dict(a=3))
self.assertEqual(self.notify_called, True)
def test_verify_message_format(self):
"""A test to ensure changing the message format is prohibitively
annoying.
"""
def message_assert(context, message):
fields = [('publisher_id', 'publisher_id'),
('event_type', 'event_type'),
('priority', 'WARN'),
('payload', dict(a=3))]
for k, v in fields:
self.assertEqual(message[k], v)
self.assertTrue(len(message['message_id']) > 0)
self.assertTrue(len(message['timestamp']) > 0)
self.assertEqual(context, ctxt)
self.stubs.Set(no_op_notifier, 'notify',
message_assert)
notifier_api.notify(ctxt, 'publisher_id', 'event_type',
notifier_api.WARN, dict(a=3))
def _test_rpc_notify(self, driver, envelope=False):
self.stubs.Set(cfg.CONF, 'notification_driver', [driver])
self.mock_notify = False
self.envelope = False
def mock_notify(cls, *args, **kwargs):
self.mock_notify = True
self.envelope = kwargs.get('envelope', False)
self.stubs.Set(rpc, 'notify', mock_notify)
notifier_api.notify(ctxt, 'publisher_id', 'event_type',
notifier_api.WARN, dict(a=3))
self.assertEqual(self.mock_notify, True)
self.assertEqual(self.envelope, envelope)
def test_rpc_notifier(self):
self._test_rpc_notify('openstack.common.notifier.rpc_notifier')
def test_rpc_notifier2(self):
self._test_rpc_notify('openstack.common.notifier.rpc_notifier2', True)
def test_invalid_priority(self):
self.assertRaises(notifier_api.BadPriorityException,
notifier_api.notify, ctxt, 'publisher_id',
'event_type', 'not a priority', dict(a=3))
def test_rpc_priority_queue(self):
self.stubs.Set(cfg.CONF, 'notification_driver',
['openstack.common.notifier.rpc_notifier'])
self.stubs.Set(cfg.CONF, 'notification_topics',
['testnotify', ])
self.test_topic = None
def mock_notify(context, topic, msg):
self.test_topic = topic
self.stubs.Set(rpc, 'notify', mock_notify)
notifier_api.notify(ctxt, 'publisher_id',
'event_type', 'DEBUG', dict(a=3))
self.assertEqual(self.test_topic, 'testnotify.debug')
def test_error_notification(self):
self.config(publish_errors=True,
use_stderr=False)
def mock_notify(context, message):
msgs.append(message)
msgs = []
self.stubs.Set(no_op_notifier, 'notify', mock_notify)
LOG = log.getLogger('test_error_notification.common')
log.setup('test_error_notification')
LOG.error('foo')
self.assertEqual(1, len(msgs))
msg = msgs[0]
self.assertEqual(msg['event_type'], 'error_notification')
self.assertEqual(msg['priority'], 'ERROR')
self.assertEqual(msg['payload']['error'], 'foo')
def test_send_notification_by_decorator(self):
self.notify_called = False
def example_api(arg1, arg2):
return arg1 + arg2
example_api = notifier_api.notify_decorator(
'example_api',
example_api)
def mock_notify(cls, *args):
self.notify_called = True
self.stubs.Set(no_op_notifier, 'notify',
mock_notify)
self.assertEqual(3, example_api(1, 2))
self.assertEqual(self.notify_called, True)
def test_decorator_context(self):
"""Verify that the notify decorator can extract the 'context' arg."""
self.notify_called = False
self.context_arg = None
def example_api(arg1, arg2, context):
return arg1 + arg2
def example_api2(arg1, arg2, **kw):
return arg1 + arg2
example_api = notifier_api.notify_decorator(
'example_api',
example_api)
example_api2 = notifier_api.notify_decorator(
'example_api2',
example_api2)
def mock_notify(context, cls, _type, _priority, _payload):
self.notify_called = True
self.context_arg = context
self.stubs.Set(notifier_api, 'notify',
mock_notify)
# Test positional context
self.assertEqual(3, example_api(1, 2, ctxt))
self.assertEqual(self.notify_called, True)
self.assertEqual(self.context_arg, ctxt)
self.notify_called = False
self.context_arg = None
# Test named context
self.assertEqual(3, example_api2(1, 2, context=ctxt2))
self.assertEqual(self.notify_called, True)
self.assertEqual(self.context_arg, ctxt2)
# Test missing context
self.assertEqual(3, example_api2(1, 2, bananas="delicious"))
self.assertEqual(self.notify_called, True)
self.assertEqual(self.context_arg, None)
class SimpleNotifier(object):
def __init__(self):
self.notified = False
def notify(self, *args):
self.notified = True
class MultiNotifierTestCase(test_utils.BaseTestCase):
"""Test case for notifications."""
def setUp(self):
super(MultiNotifierTestCase, self).setUp()
# Mock log to add one to exception_count when log.exception is called
def mock_exception(cls, *args):
self.exception_count += 1
self.exception_count = 0
notifier_log = log.getLogger(
'openstack.common.notifier.api')
self.stubs.Set(notifier_log, "exception", mock_exception)
# Mock no_op notifier to add one to notify_count when called.
def mock_notify(cls, *args):
self.notify_count += 1
self.notify_count = 0
self.stubs.Set(no_op_notifier, 'notify', mock_notify)
# Mock log_notifier to raise RuntimeError when called.
def mock_notify2(cls, *args):
raise RuntimeError("Bad notifier.")
self.stubs.Set(log_notifier, 'notify', mock_notify2)
self.addCleanup(notifier_api._reset_drivers)
def test_send_notifications_successfully(self):
notification_driver = [
'openstack.common.notifier.no_op_notifier'
]
self.config(notification_driver=notification_driver)
notifier_api.notify('contextarg',
'publisher_id',
'event_type',
notifier_api.WARN,
dict(a=3))
self.assertEqual(self.notify_count, 1)
self.assertEqual(self.exception_count, 0)
def test_send_notifications_with_errors(self):
notification_driver = [
'openstack.common.notifier.no_op_notifier',
'openstack.common.notifier.log_notifier'
]
self.config(notification_driver=notification_driver)
notifier_api.notify('contextarg',
'publisher_id',
'event_type',
notifier_api.WARN,
dict(a=3))
self.assertEqual(self.notify_count, 1)
self.assertEqual(self.exception_count, 1)
def test_when_driver_fails_to_import(self):
notification_driver = [
'openstack.common.notifier.no_op_notifier',
'openstack.common.notifier.logo_notifier',
'fdsjgsdfhjkhgsfkj'
]
self.config(notification_driver=notification_driver)
notifier_api.notify('contextarg',
'publisher_id',
'event_type',
notifier_api.WARN,
dict(a=3))
self.assertEqual(self.exception_count, 2)
self.assertEqual(self.notify_count, 1)
def test_adding_and_removing_notifier_object(self):
self.notifier_object = SimpleNotifier()
notification_driver = [
'openstack.common.notifier.no_op_notifier'
]
self.config(notification_driver=notification_driver)
notifier_api.add_driver(self.notifier_object)
notifier_api.notify(None,
'publisher_id',
'event_type',
notifier_api.WARN,
dict(a=3))
self.assertEqual(self.notify_count, 1)
self.assertTrue(self.notifier_object.notified)
self.notifier_object.notified = False
def test_adding_and_removing_notifier_module(self):
self.config(notification_driver=[])
notifier_api.add_driver('openstack.common.notifier.no_op_notifier')
notifier_api.notify(None,
'publisher_id',
'event_type',
notifier_api.WARN,
dict(a=3))
self.assertEqual(self.notify_count, 1)
def test_publisher_id(self):
self.assertEqual(notifier_api.publisher_id('foobar'),
'foobar.' + socket.gethostname())
self.assertEqual(notifier_api.publisher_id('foobar', 'baz'),
'foobar.baz')
|
