# 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 mock import os import time from oslo_config import cfg from oslo_serialization import jsonutils from oslo_utils import fixture as utils_fixture from nova import test from nova.tests import fixtures as nova_fixtures from nova.tests.functional import fixtures as func_fixtures from nova.tests.functional import integrated_helpers from nova.tests import json_ref from nova.tests.unit.api.openstack.compute import test_services from nova.tests.unit import fake_crypto CONF = cfg.CONF class NotificationSampleTestBase(test.TestCase, integrated_helpers.InstanceHelperMixin): """Base class for notification sample testing. To add tests for a versioned notification you have to store a sample file under doc/notification_sample directory. In the test method in the subclass trigger a change in the system that expected to generate the notification then use the _verify_notification function to assert if the stored sample matches with the generated one. If the notification has different payload content depending on the state change you triggered then the replacements parameter of the _verify_notification function can be used to override values coming from the sample file. Check nova.functional.notification_sample_tests.test_service_update as an example. """ ANY = object() REQUIRES_LOCKING = True # NOTE(gibi): Notification payloads always reflect the data needed # for every supported API microversion so we can safe to use the latest # API version in the tests. This helps the test to use the new API # features too. This can be overridden by subclasses that need to cap # at a specific microversion for older APIs. MAX_MICROVERSION = 'latest' def setUp(self): super(NotificationSampleTestBase, self).setUp() api_fixture = self.useFixture(nova_fixtures.OSAPIFixture( api_version='v2.1')) self.api = api_fixture.api self.admin_api = api_fixture.admin_api max_version = self.MAX_MICROVERSION self.api.microversion = max_version self.admin_api.microversion = max_version self.notifier = self.useFixture( nova_fixtures.NotificationFixture(self)) self.useFixture(utils_fixture.TimeFixture(test_services.fake_utcnow())) self.useFixture(nova_fixtures.GlanceFixture(self)) self.useFixture(func_fixtures.PlacementFixture()) context_patcher = self.mock_gen_request_id = mock.patch( 'oslo_context.context.generate_request_id', return_value='req-5b6c791d-5709-4f36-8fbe-c3e02869e35d') self.mock_gen_request_id = context_patcher.start() self.addCleanup(context_patcher.stop) self.start_service('conductor') self.start_service('scheduler') self.compute = self.start_service('compute') # Reset the service create notifications self.notifier.reset() def _get_notification_sample(self, sample): sample_dir = os.path.dirname(os.path.abspath(__file__)) sample_dir = os.path.normpath(os.path.join( sample_dir, "../../../../doc/notification_samples")) return sample_dir + '/' + sample + '.json' def _apply_replacements(self, replacements, sample_obj, notification): replacements = replacements or {} for key, value in replacements.items(): obj = sample_obj['payload'] n_obj = notification['payload'] for sub_key in key.split('.')[:-1]: obj = obj['nova_object.data'][sub_key] n_obj = n_obj['nova_object.data'][sub_key] if value == NotificationSampleTestBase.ANY: del obj['nova_object.data'][key.split('.')[-1]] del n_obj['nova_object.data'][key.split('.')[-1]] else: obj['nova_object.data'][key.split('.')[-1]] = value def _verify_notification(self, sample_file_name, replacements=None, actual=None): """Assert if the generated notification matches with the stored sample :param sample_file_name: The name of the sample file to match relative to doc/notification_samples :param replacements: A dict of key value pairs that is used to update the payload field of the sample data before it is matched against the generated notification. The 'x.y':'new-value' key-value pair selects the ["payload"]["nova_object.data"]["x"] ["nova_object.data"]["y"] value from the sample data and overrides it with 'new-value'. There is a special value ANY that can be used to indicate that the actual field value shall be ignored during matching. :param actual: Defines the actual notification to compare with. If None then it defaults to the first versioned notification emitted during the test. """ if not actual: self.assertEqual(1, len(self.notifier.versioned_notifications), self.notifier.versioned_notifications) notification = self.notifier.versioned_notifications[0] else: notification = actual sample_file = self._get_notification_sample(sample_file_name) with open(sample_file) as sample: sample_data = sample.read() sample_obj = jsonutils.loads(sample_data) sample_base_dir = os.path.dirname(sample_file) sample_obj = json_ref.resolve_refs( sample_obj, base_path=sample_base_dir) self._apply_replacements(replacements, sample_obj, notification) self.assertJsonEqual(sample_obj, notification) def _pop_and_verify_dest_select_notification(self, server_id, replacements=None): replacements = replacements or {} replacements['instance_uuid'] = server_id replacements['pci_requests.instance_uuid'] = server_id replacements['flavor.extra_specs'] = self.ANY replacements['numa_topology'] = self.ANY scheduler_expected_notifications = [ 'scheduler-select_destinations-start', 'scheduler-select_destinations-end'] self.assertLessEqual(2, len(self.notifier.versioned_notifications)) for notification in scheduler_expected_notifications: self._verify_notification( notification, replacements=replacements, actual=self.notifier.versioned_notifications.pop(0)) def _boot_a_server(self, expected_status='ACTIVE', extra_params=None, scheduler_hints=None, additional_extra_specs=None): # We have to depend on a specific image and flavor to fix the content # of the notification that will be emitted flavor_body = {'flavor': {'name': 'test_flavor', 'ram': 512, 'vcpus': 1, 'disk': 1, 'id': 'a22d5517-147c-4147-a0d1-e698df5cd4e3' }} flavor_id = self.api.post_flavor(flavor_body)['id'] extra_specs = { "extra_specs": { "hw:watchdog_action": "disabled"}} if additional_extra_specs: extra_specs['extra_specs'].update(additional_extra_specs) self.admin_api.post_extra_spec(flavor_id, extra_specs) # Ignore the create flavor notification self.notifier.reset() keypair_req = { "keypair": { "name": "my-key", "public_key": fake_crypto.get_ssh_public_key() }} self.api.post_keypair(keypair_req) keypair_expected_notifications = [ 'keypair-import-start', 'keypair-import-end' ] self.assertLessEqual(2, len(self.notifier.versioned_notifications)) for notification in keypair_expected_notifications: self._verify_notification( notification, actual=self.notifier.versioned_notifications.pop(0)) server = self._build_server( name='some-server', image_uuid='155d900f-4e14-4e4c-a73d-069cbf4541e6', flavor_id=flavor_id) # NOTE(gibi): from microversion 2.19 the description is not set to the # instance name automatically but can be provided at boot. server['description'] = 'some-server' if extra_params: extra_params['return_reservation_id'] = True extra_params['key_name'] = 'my-key' server.update(extra_params) post = {'server': server} if scheduler_hints: post.update({"os:scheduler_hints": scheduler_hints}) created_server = self.api.post_server(post) reservation_id = created_server['reservation_id'] created_server = self.api.get_servers( detail=False, search_opts={'reservation_id': reservation_id})[0] self.assertTrue(created_server['id']) # Wait for it to finish being created found_server = self._wait_for_state_change(created_server, expected_status) found_server['reservation_id'] = reservation_id # Note(elod.illes): let's just pop and verify the dest_select # notifications if we don't have a special case if scheduler_hints is None and expected_status != 'ERROR': self._pop_and_verify_dest_select_notification(found_server['id']) if found_server['status'] == 'ACTIVE': self.api.put_server_tags(found_server['id'], ['tag1']) return found_server def _get_notifications(self, event_type): return [notification for notification in self.notifier.versioned_notifications if notification['event_type'] == event_type] def _wait_for_notification(self, event_type, timeout=10.0): # NOTE(mdbooth): wait_for_versioned_notifications raises an exception # if it times out since change I017d1a31. Consider removing this # method. self.notifier.wait_for_versioned_notifications( event_type, timeout=timeout) def _wait_for_notifications(self, event_type, expected_count, timeout=10.0): notifications = self.notifier.wait_for_versioned_notifications( event_type, n_events=expected_count, timeout=timeout) msg = ''.join('\n%s' % notif for notif in notifications) self.assertEqual(expected_count, len(notifications), 'Unexpected number of %s notifications ' 'within the given timeout. ' 'Expected %d, got %d: %s' % (event_type, expected_count, len(notifications), msg)) return notifications def _attach_volume_to_server(self, server, volume_id): self.api.post_server_volume( server['id'], {"volumeAttachment": {"volumeId": volume_id}}) self._wait_for_notification('instance.volume_attach.end') def _wait_and_get_migrations(self, server, max_retries=20): """Simple method to wait for the migrations Here we wait for the moment where active migration is in progress so we can get them and use them in the migration-related tests. :param server: server we'd like to use :param max_retries: maximum number of retries :returns: the migrations """ retries = 0 while retries < max_retries: retries += 1 migrations = self.admin_api.get_active_migrations(server['id']) if (len(migrations) > 0 and migrations[0]['status'] not in ['queued', 'preparing']): return migrations if retries == max_retries: self.fail('The migration table left empty.') time.sleep(0.5)