491 lines
20 KiB
Python
491 lines
20 KiB
Python
# 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 collections
|
|
|
|
import mock
|
|
from oslo_utils.fixture import uuidsentinel as uuids
|
|
from oslo_utils import timeutils
|
|
from oslo_versionedobjects import fixture
|
|
|
|
from nova import exception
|
|
from nova.notifications.objects import base as notification
|
|
from nova import objects
|
|
from nova.objects import base
|
|
from nova.objects import fields
|
|
from nova import test
|
|
from nova.tests.unit.objects import test_objects
|
|
|
|
|
|
class TestNotificationBase(test.NoDBTestCase):
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class TestObject(base.NovaObject):
|
|
VERSION = '1.0'
|
|
fields = {
|
|
'field_1': fields.StringField(),
|
|
'field_2': fields.IntegerField(),
|
|
'not_important_field': fields.IntegerField(),
|
|
'lazy_field': fields.IntegerField()
|
|
}
|
|
|
|
def obj_load_attr(self, attrname):
|
|
if attrname == 'lazy_field':
|
|
self.lazy_field = 42
|
|
else:
|
|
raise exception.ObjectActionError(
|
|
action='obj_load_attr',
|
|
reason='attribute %s not lazy-loadable' % attrname)
|
|
|
|
def __init__(self, not_important_field):
|
|
super(TestNotificationBase.TestObject, self).__init__()
|
|
# field1 and field_2 simulates that some fields are initialized
|
|
# outside of the object's ctor
|
|
self.not_important_field = not_important_field
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class TestNotificationPayload(notification.NotificationPayloadBase):
|
|
VERSION = '1.0'
|
|
|
|
SCHEMA = {
|
|
'field_1': ('source_field', 'field_1'),
|
|
'field_2': ('source_field', 'field_2'),
|
|
'lazy_field': ('source_field', 'lazy_field')
|
|
}
|
|
|
|
fields = {
|
|
'extra_field': fields.StringField(), # filled by ctor
|
|
# filled by the schema
|
|
'field_1': fields.StringField(nullable=True),
|
|
'field_2': fields.IntegerField(), # filled by the schema
|
|
'lazy_field': fields.IntegerField() # filled by the schema
|
|
}
|
|
|
|
def __init__(self, extra_field, source_field):
|
|
super(TestNotificationBase.TestNotificationPayload,
|
|
self).__init__()
|
|
self.extra_field = extra_field
|
|
self.populate_schema(source_field=source_field)
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class TestNotificationPayloadEmptySchema(
|
|
notification.NotificationPayloadBase):
|
|
VERSION = '1.0'
|
|
|
|
fields = {
|
|
'extra_field': fields.StringField(), # filled by ctor
|
|
}
|
|
|
|
def __init__(self, extra_field):
|
|
super(TestNotificationBase.TestNotificationPayloadEmptySchema,
|
|
self).__init__()
|
|
self.extra_field = extra_field
|
|
|
|
@notification.notification_sample('test-update-1.json')
|
|
@notification.notification_sample('test-update-2.json')
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class TestNotification(notification.NotificationBase):
|
|
VERSION = '1.0'
|
|
fields = {
|
|
'payload': fields.ObjectField('TestNotificationPayload')
|
|
}
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class TestNotificationEmptySchema(notification.NotificationBase):
|
|
VERSION = '1.0'
|
|
fields = {
|
|
'payload': fields.ObjectField('TestNotificationPayloadEmptySchema')
|
|
}
|
|
|
|
fake_service = {
|
|
'created_at': timeutils.utcnow().replace(microsecond=0),
|
|
'updated_at': None,
|
|
'deleted_at': None,
|
|
'deleted': False,
|
|
'id': 123,
|
|
'uuid': uuids.service,
|
|
'host': 'fake-host',
|
|
'binary': 'nova-compute',
|
|
'topic': 'fake-service-topic',
|
|
'report_count': 1,
|
|
'forced_down': False,
|
|
'disabled': False,
|
|
'disabled_reason': None,
|
|
'last_seen_up': None,
|
|
'version': 1}
|
|
|
|
expected_payload = {
|
|
'nova_object.name': 'TestNotificationPayload',
|
|
'nova_object.data': {
|
|
'extra_field': 'test string',
|
|
'field_1': 'test1',
|
|
'field_2': 15,
|
|
'lazy_field': 42},
|
|
'nova_object.version': '1.0',
|
|
'nova_object.namespace': 'nova'}
|
|
|
|
def setUp(self):
|
|
super(TestNotificationBase, self).setUp()
|
|
with mock.patch(
|
|
'nova.db.api.service_update') as mock_db_service_update:
|
|
self.service_obj = objects.Service(context=mock.sentinel.context,
|
|
id=self.fake_service['id'])
|
|
self.service_obj.obj_reset_changes(['version'])
|
|
mock_db_service_update.return_value = self.fake_service
|
|
self.service_obj.save()
|
|
|
|
self.my_obj = self.TestObject(not_important_field=13)
|
|
self.my_obj.field_1 = 'test1'
|
|
self.my_obj.field_2 = 15
|
|
|
|
self.payload = self.TestNotificationPayload(
|
|
extra_field='test string', source_field=self.my_obj)
|
|
|
|
self.notification = self.TestNotification(
|
|
event_type=notification.EventType(
|
|
object='test_object',
|
|
action=fields.NotificationAction.UPDATE,
|
|
phase=fields.NotificationPhase.START),
|
|
publisher=notification.NotificationPublisher.from_service_obj(
|
|
self.service_obj),
|
|
priority=fields.NotificationPriority.INFO,
|
|
payload=self.payload)
|
|
|
|
def _verify_notification(self, mock_notifier, mock_context,
|
|
expected_event_type,
|
|
expected_payload):
|
|
mock_notifier.prepare.assert_called_once_with(
|
|
publisher_id='nova-compute:fake-host')
|
|
mock_notify = mock_notifier.prepare.return_value.info
|
|
self.assertTrue(mock_notify.called)
|
|
self.assertEqual(mock_notify.call_args[0][0], mock_context)
|
|
self.assertEqual(mock_notify.call_args[1]['event_type'],
|
|
expected_event_type)
|
|
actual_payload = mock_notify.call_args[1]['payload']
|
|
self.assertJsonEqual(expected_payload, actual_payload)
|
|
|
|
@mock.patch('nova.rpc.LEGACY_NOTIFIER')
|
|
@mock.patch('nova.rpc.NOTIFIER')
|
|
def test_emit_notification(self, mock_notifier, mock_legacy):
|
|
|
|
mock_context = mock.Mock()
|
|
mock_context.to_dict.return_value = {}
|
|
self.notification.emit(mock_context)
|
|
|
|
self._verify_notification(
|
|
mock_notifier,
|
|
mock_context,
|
|
expected_event_type='test_object.update.start',
|
|
expected_payload=self.expected_payload)
|
|
self.assertFalse(mock_legacy.called)
|
|
|
|
@mock.patch('nova.rpc.NOTIFIER')
|
|
def test_emit_with_host_and_binary_as_publisher(self, mock_notifier):
|
|
noti = self.TestNotification(
|
|
event_type=notification.EventType(
|
|
object='test_object',
|
|
action=fields.NotificationAction.UPDATE),
|
|
publisher=notification.NotificationPublisher(
|
|
host='fake-host',
|
|
source='nova-compute'),
|
|
priority=fields.NotificationPriority.INFO,
|
|
payload=self.payload)
|
|
|
|
mock_context = mock.Mock()
|
|
mock_context.to_dict.return_value = {}
|
|
noti.emit(mock_context)
|
|
|
|
self._verify_notification(
|
|
mock_notifier,
|
|
mock_context,
|
|
expected_event_type='test_object.update',
|
|
expected_payload=self.expected_payload)
|
|
|
|
@mock.patch('nova.rpc.LEGACY_NOTIFIER')
|
|
@mock.patch('nova.rpc.NOTIFIER')
|
|
def test_emit_event_type_without_phase(self, mock_notifier, mock_legacy):
|
|
noti = self.TestNotification(
|
|
event_type=notification.EventType(
|
|
object='test_object',
|
|
action=fields.NotificationAction.UPDATE),
|
|
publisher=notification.NotificationPublisher.from_service_obj(
|
|
self.service_obj),
|
|
priority=fields.NotificationPriority.INFO,
|
|
payload=self.payload)
|
|
|
|
mock_context = mock.Mock()
|
|
mock_context.to_dict.return_value = {}
|
|
noti.emit(mock_context)
|
|
|
|
self._verify_notification(
|
|
mock_notifier,
|
|
mock_context,
|
|
expected_event_type='test_object.update',
|
|
expected_payload=self.expected_payload)
|
|
self.assertFalse(mock_legacy.called)
|
|
|
|
@mock.patch('nova.rpc.NOTIFIER')
|
|
def test_not_possible_to_emit_if_not_populated(self, mock_notifier):
|
|
payload = self.TestNotificationPayload(
|
|
extra_field='test string', source_field=self.my_obj)
|
|
payload.populated = False
|
|
|
|
noti = self.TestNotification(
|
|
event_type=notification.EventType(
|
|
object='test_object',
|
|
action=fields.NotificationAction.UPDATE),
|
|
publisher=notification.NotificationPublisher.from_service_obj(
|
|
self.service_obj),
|
|
priority=fields.NotificationPriority.INFO,
|
|
payload=payload)
|
|
|
|
mock_context = mock.Mock()
|
|
self.assertRaises(AssertionError, noti.emit, mock_context)
|
|
self.assertFalse(mock_notifier.called)
|
|
|
|
def test_lazy_load_source_field(self):
|
|
my_obj = self.TestObject(not_important_field=13)
|
|
my_obj.field_1 = 'test1'
|
|
my_obj.field_2 = 15
|
|
|
|
payload = self.TestNotificationPayload(extra_field='test string',
|
|
source_field=my_obj)
|
|
|
|
self.assertEqual(42, payload.lazy_field)
|
|
|
|
def test_uninited_source_field_defaulted_to_none(self):
|
|
my_obj = self.TestObject(not_important_field=13)
|
|
# intentionally not initializing field_1 to simulate an uninited but
|
|
# nullable field
|
|
my_obj.field_2 = 15
|
|
|
|
payload = self.TestNotificationPayload(extra_field='test string',
|
|
source_field=my_obj)
|
|
|
|
self.assertIsNone(payload.field_1)
|
|
|
|
def test_uninited_source_field_not_nullable_payload_field_fails(self):
|
|
my_obj = self.TestObject(not_important_field=13)
|
|
# intentionally not initializing field_2 to simulate an uninited no
|
|
# nullable field
|
|
my_obj.field_1 = 'test1'
|
|
|
|
self.assertRaises(ValueError, self.TestNotificationPayload,
|
|
extra_field='test string', source_field=my_obj)
|
|
|
|
@mock.patch('nova.rpc.NOTIFIER')
|
|
def test_empty_schema(self, mock_notifier):
|
|
non_populated_payload = self.TestNotificationPayloadEmptySchema(
|
|
extra_field='test string')
|
|
noti = self.TestNotificationEmptySchema(
|
|
event_type=notification.EventType(
|
|
object='test_object',
|
|
action=fields.NotificationAction.UPDATE),
|
|
publisher=notification.NotificationPublisher.from_service_obj(
|
|
self.service_obj),
|
|
priority=fields.NotificationPriority.INFO,
|
|
payload=non_populated_payload)
|
|
|
|
mock_context = mock.Mock()
|
|
mock_context.to_dict.return_value = {}
|
|
noti.emit(mock_context)
|
|
|
|
self._verify_notification(
|
|
mock_notifier,
|
|
mock_context,
|
|
expected_event_type='test_object.update',
|
|
expected_payload=
|
|
{'nova_object.name': 'TestNotificationPayloadEmptySchema',
|
|
'nova_object.data': {'extra_field': u'test string'},
|
|
'nova_object.version': '1.0',
|
|
'nova_object.namespace': 'nova'})
|
|
|
|
def test_sample_decorator(self):
|
|
self.assertEqual(2, len(self.TestNotification.samples))
|
|
self.assertIn('test-update-1.json', self.TestNotification.samples)
|
|
self.assertIn('test-update-2.json', self.TestNotification.samples)
|
|
|
|
@mock.patch('nova.notifications.objects.base.NotificationBase._emit')
|
|
@mock.patch('nova.rpc.NOTIFIER')
|
|
def test_payload_is_not_generated_if_notifier_is_not_enabled(
|
|
self, mock_notifier, mock_emit):
|
|
mock_notifier.is_enabled.return_value = False
|
|
|
|
payload = self.TestNotificationPayload(
|
|
extra_field='test string',
|
|
source_field=self.my_obj)
|
|
noti = self.TestNotification(
|
|
event_type=notification.EventType(
|
|
object='test_object',
|
|
action=fields.NotificationAction.UPDATE),
|
|
publisher=notification.NotificationPublisher.from_service_obj(
|
|
self.service_obj),
|
|
priority=fields.NotificationPriority.INFO,
|
|
payload=payload)
|
|
|
|
mock_context = mock.Mock()
|
|
|
|
noti.emit(mock_context)
|
|
|
|
self.assertFalse(payload.populated)
|
|
self.assertFalse(mock_emit.called)
|
|
|
|
@mock.patch('nova.notifications.objects.base.NotificationBase._emit')
|
|
def test_payload_is_not_generated_if_notification_format_is_unversioned(
|
|
self, mock_emit):
|
|
self.flags(notification_format='unversioned', group='notifications')
|
|
|
|
payload = self.TestNotificationPayload(
|
|
extra_field='test string',
|
|
source_field=self.my_obj)
|
|
noti = self.TestNotification(
|
|
event_type=notification.EventType(
|
|
object='test_object',
|
|
action=fields.NotificationAction.UPDATE),
|
|
publisher=notification.NotificationPublisher.from_service_obj(
|
|
self.service_obj),
|
|
priority=fields.NotificationPriority.INFO,
|
|
payload=payload)
|
|
|
|
mock_context = mock.Mock()
|
|
|
|
noti.emit(mock_context)
|
|
|
|
self.assertFalse(payload.populated)
|
|
self.assertFalse(mock_emit.called)
|
|
|
|
notification_object_data = {
|
|
'AggregateNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'AggregatePayload': '1.1-1eb9adcc4440d8627de6ec37c6398746',
|
|
'AuditPeriodPayload': '1.0-2b429dd307b8374636703b843fa3f9cb',
|
|
'BandwidthPayload': '1.0-ee2616a7690ab78406842a2b68e34130',
|
|
'BlockDevicePayload': '1.0-29751e1b6d41b1454e36768a1e764df8',
|
|
'CellMappingPayload': '2.0-8acd412eb4edff1cd2ecb9867feeb243',
|
|
'ComputeTaskNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'ComputeTaskPayload': '1.0-e3d34762c14d131c98337b72e8c600e1',
|
|
'DestinationPayload': '1.0-4ccf26318dd18c4377dada2b1e74ec2e',
|
|
'EventType': '1.19-000a76e83b06a9de11d365465a755a5e',
|
|
'ExceptionNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'ExceptionPayload': '1.1-6c43008bd81885a63bc7f7c629f0793b',
|
|
'FlavorNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'FlavorPayload': '1.4-2e7011b8b4e59167fe8b7a0a81f0d452',
|
|
'ImageMetaPayload': '1.0-0e65beeacb3393beed564a57bc2bc989',
|
|
'ImageMetaPropsPayload': '1.0-0665065e198b4ab1b03aa80f442d2302',
|
|
'InstanceActionNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'InstanceActionPayload': '1.7-8c77f0c85a83d325fded152376ca809a',
|
|
'InstanceActionRebuildNotification':
|
|
'1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'InstanceActionRebuildPayload': '1.8-ab76ecbf73b82bc010ab82bdc2792e1d',
|
|
'InstanceActionRescueNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'InstanceActionRescuePayload': '1.2-b82aa24a966713dce26de3126716e8ef',
|
|
'InstanceActionResizePrepNotification':
|
|
'1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'InstanceActionResizePrepPayload': '1.2-1b41bec00f2b679e77a906b1df0c1d5a',
|
|
'InstanceActionVolumeNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'InstanceActionVolumePayload': '1.5-3027aae42ee85155b2c378fad1f3b678',
|
|
'InstanceActionVolumeSwapNotification':
|
|
'1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'InstanceActionVolumeSwapPayload': '1.7-d3252403a9437bcdc80f1075214f8b45',
|
|
'InstanceCreateNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'InstanceCreatePayload': '1.11-7513127966bc8f270946634d099e71c0',
|
|
'InstancePayload': '1.7-78354572f699b9a6ad9996b199d03375',
|
|
'InstanceActionSnapshotNotification':
|
|
'1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'InstanceActionSnapshotPayload': '1.8-6a3a66f823b56268ea4b759c83e38c31',
|
|
'InstanceExistsNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'InstanceExistsPayload': '1.1-b7095abb18f5b75f39dc1aa59942535d',
|
|
'InstanceNUMACellPayload': '1.0-2f13614648bc46f2e29578a206561ef6',
|
|
'InstanceNUMATopologyPayload': '1.0-247361b152047c18ae9ad1da2544a3c9',
|
|
'InstancePCIRequestPayload': '1.0-12d0d61baf183daaafd93cbeeed2956f',
|
|
'InstancePCIRequestsPayload': '1.0-6751cffe0c0fabd212aad624f672429a',
|
|
'InstanceStateUpdatePayload': '1.0-07e111c0fa0f6db0f79b0726d593e3da',
|
|
'InstanceUpdateNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'InstanceUpdatePayload': '1.8-375131acb12e612a460f68211a2b3a35',
|
|
'IpPayload': '1.0-8ecf567a99e516d4af094439a7632d34',
|
|
'KeypairNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'KeypairPayload': '1.0-6daebbbde0e1bf35c1556b1ecd9385c1',
|
|
'LibvirtErrorNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'LibvirtErrorPayload': '1.0-9e7a8f0b895dd15531d5a6f3aa95d58e',
|
|
'MetricPayload': '1.0-bcdbe85048f335132e4c82a1b8fa3da8',
|
|
'MetricsNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'MetricsPayload': '1.0-65c69b15b4de5a8c01971cb5bb9ab650',
|
|
'NotificationPublisher': '2.2-b6ad48126247e10b46b6b0240e52e614',
|
|
'RequestSpecPayload': '1.1-64d30723a2e381d0cd6a16a877002c64',
|
|
'SchedulerRetriesPayload': '1.0-03a07d09575ef52cced5b1b24301d0b4',
|
|
'SelectDestinationsNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'ServerGroupNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'ServerGroupPayload': '1.1-4ded2997ea1b07038f7af33ef5c45f7f',
|
|
'ServiceStatusNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'ServiceStatusPayload': '1.1-7b6856bd879db7f3ecbcd0ca9f35f92f',
|
|
'VirtCPUTopologyPayload': '1.0-1b1600fe55465209682d96bbe3209f27',
|
|
'VolumeUsageNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
|
|
'VolumeUsagePayload': '1.0-5f99d8b978a32040eecac0975e5a53e9',
|
|
}
|
|
|
|
|
|
class TestNotificationObjectVersions(test.NoDBTestCase):
|
|
def setUp(self):
|
|
super(TestNotificationObjectVersions, self).setUp()
|
|
base.NovaObjectRegistry.register_notification_objects()
|
|
|
|
def test_versions(self):
|
|
checker = fixture.ObjectVersionChecker(
|
|
test_objects.get_nova_objects())
|
|
notification_object_data.update(test_objects.object_data)
|
|
expected, actual = checker.test_hashes(notification_object_data,
|
|
extra_data_func=get_extra_data)
|
|
self.assertEqual(expected, actual,
|
|
'Some notification objects have changed; please make '
|
|
'sure the versions have been bumped, and then update '
|
|
'their hashes here.')
|
|
|
|
def test_notification_payload_version_depends_on_the_schema(self):
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class TestNotificationPayload(notification.NotificationPayloadBase):
|
|
VERSION = '1.0'
|
|
|
|
SCHEMA = {
|
|
'field_1': ('source_field', 'field_1'),
|
|
'field_2': ('source_field', 'field_2'),
|
|
}
|
|
|
|
fields = {
|
|
'extra_field': fields.StringField(), # filled by ctor
|
|
'field_1': fields.StringField(), # filled by the schema
|
|
'field_2': fields.IntegerField(), # filled by the schema
|
|
}
|
|
|
|
checker = fixture.ObjectVersionChecker(
|
|
{'TestNotificationPayload': (TestNotificationPayload,)})
|
|
|
|
old_hash = checker.get_hashes(extra_data_func=get_extra_data)
|
|
TestNotificationPayload.SCHEMA['field_3'] = ('source_field',
|
|
'field_3')
|
|
new_hash = checker.get_hashes(extra_data_func=get_extra_data)
|
|
|
|
self.assertNotEqual(old_hash, new_hash)
|
|
|
|
|
|
def get_extra_data(obj_class):
|
|
extra_data = tuple()
|
|
|
|
# Get the SCHEMA items to add to the fingerprint
|
|
# if we are looking at a notification
|
|
if issubclass(obj_class, notification.NotificationPayloadBase):
|
|
schema_data = collections.OrderedDict(
|
|
sorted(obj_class.SCHEMA.items()))
|
|
|
|
extra_data += (schema_data,)
|
|
|
|
return extra_data
|