openstack/nova
Code Issues Proposed changes

Moved everything into notifier/api

Browse Source
This commit is contained in:
Cerberus
2011-05-11 13:10:40 -05:00
parent d4c42ca05b
commit 96f59724ea
3 changed files with 87 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
nova/notifier/__init__.py
View File

@@ -12,64 +12,3 @@
# 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 datetime
import uuid
from nova import flags
from nova import utils
FLAGS = flags.FLAGS
flags.DEFINE_string('default_notification_level', 'INFO',
'Default notification level for outgoing notifications')
WARN = 'WARN'
INFO = 'INFO'
ERROR = 'ERROR'
CRITICAL = 'CRITICAL'
DEBUG = 'DEBUG'
log_levels = (DEBUG, WARN, INFO, ERROR, CRITICAL)
class BadPriorityException(Exception):
pass
def notify(event_name, publisher_id, event_type, priority, payload):
"""
Sends a notification using the specified driver
Message format is as follows:
message_id - a UUID representing the id for this notification
publisher_id - the source worker_type.host of the message
timestamp - the GMT timestamp the notification was sent at
event_type - the literal type of event (ex. Instance Creation)
priority - patterned after the enumeration of Python logging levels in
the set (DEBUG, WARN, INFO, ERROR, CRITICAL)
payload - A python dictionary of attributes
The message body will be constructed as a dictionary of the above
attributes, and converted into a JSON dump, which will then be sent
via the transport mechanism defined by the driver.
Message example:
{'message_id': str(uuid.uuid4()),
'publisher_id': 'compute.host1',
'timestamp': datetime.datetime.utcnow(),
'priority': 'WARN',
'event_type': 'compute.create_instance',
'payload': {'instance_id': 12, ... }}
"""
if priority not in log_levels:
raise BadPriorityException('%s not in valid priorities' % priority)
driver = utils.import_class(FLAGS.notification_driver)()
message = dict(message_id=str(uuid.uuid4()),
publisher_id=publisher_id,
event_type=event_type,
priority=priority,
payload=payload,
time=str(datetime.datetime.utcnow()))
driver.notify(message)

75
nova/notifier/api.py Normal file
View File

@@ -0,0 +1,75 @@
# Copyright 2011 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 datetime
import datetime
import uuid
from nova import flags
from nova import utils
FLAGS = flags.FLAGS
flags.DEFINE_string('default_notification_level', 'INFO',
'Default notification level for outgoing notifications')
WARN = 'WARN'
INFO = 'INFO'
ERROR = 'ERROR'
CRITICAL = 'CRITICAL'
DEBUG = 'DEBUG'
log_levels = (DEBUG, WARN, INFO, ERROR, CRITICAL)
class BadPriorityException(Exception):
pass
def notify(event_name, publisher_id, event_type, priority, payload):
"""
Sends a notification using the specified driver
Message format is as follows:
message_id - a UUID representing the id for this notification
publisher_id - the source worker_type.host of the message
timestamp - the GMT timestamp the notification was sent at
event_type - the literal type of event (ex. Instance Creation)
priority - patterned after the enumeration of Python logging levels in
the set (DEBUG, WARN, INFO, ERROR, CRITICAL)
payload - A python dictionary of attributes
The message body will be constructed as a dictionary of the above
attributes, and converted into a JSON dump, which will then be sent
via the transport mechanism defined by the driver.
Message example:
{'message_id': str(uuid.uuid4()),
'publisher_id': 'compute.host1',
'timestamp': datetime.datetime.utcnow(),
'priority': 'WARN',
'event_type': 'compute.create_instance',
'payload': {'instance_id': 12, ... }}
"""
if priority not in log_levels:
raise BadPriorityException('%s not in valid priorities' % priority)
driver = utils.import_class(FLAGS.notification_driver)()
message = dict(message_id=str(uuid.uuid4()),
publisher_id=publisher_id,
event_type=event_type,
priority=priority,
payload=payload,
timestamp=str(datetime.datetime.utcnow()))
driver.notify(message)

22
nova/tests/test_notifier.py
View File

@@ -18,7 +18,8 @@ import nova
from nova import context
from nova import flags
from nova import rpc
from nova import notifier
import nova.notifier.api
from nova.notifier.api import notify
from nova.notifier import no_op_notifier
from nova.notifier import rabbit_notifier
from nova import test
@@ -45,8 +46,8 @@ class NotifierTestCase(test.TestCase):
class Mock(object):
pass
nova.notifier.notify('event_name', 'publisher_id', 'event_type',
nova.notifier.WARN, dict(a=3))
notify('event_name', 'publisher_id', 'event_type',
nova.notifier.api.WARN, dict(a=3))
self.assertEqual(self.notify_called, True)
def test_verify_message_format(self):
@@ -60,11 +61,12 @@ class NotifierTestCase(test.TestCase):
for k, v in fields:
self.assertEqual(message[k], v)
self.assertTrue(len(message['message_id']) > 0)
self.assertTrue(len(message['timestamp']) > 0)
self.stubs.Set(nova.notifier.no_op_notifier.NoopNotifier, 'notify',
message_assert)
nova.notifier.notify('event_name', 'publisher_id', 'event_type',
nova.notifier.WARN, dict(a=3))
notify('event_name', 'publisher_id', 'event_type',
nova.notifier.api.WARN, dict(a=3))
def test_send_rabbit_notification(self):
self.stubs.Set(nova.flags.FLAGS, 'notification_driver',
@@ -76,8 +78,8 @@ class NotifierTestCase(test.TestCase):
class Mock(object):
pass
self.stubs.Set(nova.rpc, 'cast', mock_cast)
nova.notifier.notify('event_name', 'publisher_id', 'event_type',
nova.notifier.WARN, dict(a=3))
notify('event_name', 'publisher_id', 'event_type',
nova.notifier.api.WARN, dict(a=3))
self.assertEqual(self.mock_cast, True)
@@ -89,8 +91,8 @@ class NotifierTestCase(test.TestCase):
pass
self.stubs.Set(nova.rpc, 'cast', mock_cast)
self.assertRaises(nova.notifier.BadPriorityException,
nova.notifier.notify, 'event_name', 'publisher_id',
self.assertRaises(nova.notifier.api.BadPriorityException,
notify, 'event_name', 'publisher_id',
'event_type', 'not a priority', dict(a=3))
def test_rabbit_priority_queue(self):
@@ -105,7 +107,7 @@ class NotifierTestCase(test.TestCase):
self.test_topic = topic
self.stubs.Set(nova.rpc, 'cast', mock_cast)
nova.notifier.notify('event_name', 'publisher_id',
notify('event_name', 'publisher_id',
'event_type', 'DEBUG', dict(a=3))
self.assertEqual(self.test_topic, 'testnotify.debug')