From aed86ee5d6289edf1baf9fe0b2a9e509031fdd25 Mon Sep 17 00:00:00 2001 From: Takashi NATSUME Date: Thu, 19 Sep 2019 15:57:44 +0900 Subject: [PATCH] objects: Update keypairs when saving an instance The keypair of a server is updated when rebuilding the server with a keypair. This function has been added since API microversion 2.54. However the 'keypairs' of the instance object is not saved when saving the instance object currently. Make the instance object update the 'keypairs' field when saving the instance object. Change-Id: I8a2726b39d0444de8c35480024078a97430f5d0c Closes-Bug: #1843708 Co-authored-by: Stephen Finucane (cherry picked from commit 086796021b189c3ac64805ed8f6bde833906d284) --- nova/objects/instance.py | 5 +- .../regressions/test_bug_1843708.py | 70 +++++++++++++++++++ nova/tests/unit/fake_instance.py | 3 +- nova/tests/unit/objects/test_instance.py | 25 +++++-- 4 files changed, 95 insertions(+), 8 deletions(-) create mode 100644 nova/tests/functional/regressions/test_bug_1843708.py diff --git a/nova/objects/instance.py b/nova/objects/instance.py index 324cab791154..8859dc00c185 100644 --- a/nova/objects/instance.py +++ b/nova/objects/instance.py @@ -741,8 +741,9 @@ class Instance(base.NovaPersistentObject, base.NovaObject, pass def _save_keypairs(self, context): - # NOTE(danms): Read-only so no need to save this. - pass + if 'keypairs' in self.obj_what_changed(): + self._save_extra_generic('keypairs') + self.obj_reset_changes(['keypairs'], recursive=True) def _save_extra_generic(self, field): if field in self.obj_what_changed(): diff --git a/nova/tests/functional/regressions/test_bug_1843708.py b/nova/tests/functional/regressions/test_bug_1843708.py new file mode 100644 index 000000000000..59d57ac531b1 --- /dev/null +++ b/nova/tests/functional/regressions/test_bug_1843708.py @@ -0,0 +1,70 @@ +# Copyright 2019 NTT Corporation +# +# 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. + +from nova import context +from nova import objects +from nova.tests.functional import integrated_helpers +from nova.tests.unit import fake_notifier +from nova.tests.unit.image import fake as fake_image + + +class RebuildWithKeypairTestCase(integrated_helpers._IntegratedTestBase): + """Regression test for bug 1843708. + + This tests a rebuild scenario with new key pairs. + """ + api_major_version = 'v2.1' + microversion = 'latest' + + def test_rebuild_with_keypair(self): + keypair_req = { + 'keypair': { + 'name': 'test-key1', + 'type': 'ssh', + }, + } + keypair1 = self.api.post_keypair(keypair_req) + keypair_req['keypair']['name'] = 'test-key2' + keypair2 = self.api.post_keypair(keypair_req) + + server = self._build_server(networks='none') + server.update({'key_name': 'test-key1'}) + + # Create a server with keypair 'test-key1' + server = self.api.post_server({'server': server}) + self._wait_for_state_change(server, 'ACTIVE') + + # Check keypairs + ctxt = context.get_admin_context() + instance = objects.Instance.get_by_uuid( + ctxt, server['id'], expected_attrs=['keypairs']) + self.assertEqual( + keypair1['public_key'], instance.keypairs[0].public_key) + + # Rebuild a server with keypair 'test-key2' + body = { + 'rebuild': { + 'imageRef': fake_image.get_valid_image_id(), + 'key_name': 'test-key2', + }, + } + self.api.api_post('servers/%s/action' % server['id'], body) + fake_notifier.wait_for_versioned_notifications('instance.rebuild.end') + self._wait_for_state_change(server, 'ACTIVE') + + # Check keypairs changed + instance = objects.Instance.get_by_uuid( + ctxt, server['id'], expected_attrs=['keypairs']) + self.assertEqual( + keypair2['public_key'], instance.keypairs[0].public_key) diff --git a/nova/tests/unit/fake_instance.py b/nova/tests/unit/fake_instance.py index 6de88819adde..20a9889fe242 100644 --- a/nova/tests/unit/fake_instance.py +++ b/nova/tests/unit/fake_instance.py @@ -119,7 +119,6 @@ def fake_instance_obj(context, obj_instance_class=None, **updates): is_public=True, extra_specs={}, projects=[]) - flavor.obj_reset_changes() inst = obj_instance_class._from_db_object(context, obj_instance_class(), fake_db_instance(**updates), expected_attrs=expected_attrs) @@ -141,7 +140,7 @@ def fake_instance_obj(context, obj_instance_class=None, **updates): inst.new_flavor = None inst.resources = None inst.migration_context = None - inst.obj_reset_changes() + inst.obj_reset_changes(recursive=True) return inst diff --git a/nova/tests/unit/objects/test_instance.py b/nova/tests/unit/objects/test_instance.py index 9c61fae18376..d5eb16d76eb1 100644 --- a/nova/tests/unit/objects/test_instance.py +++ b/nova/tests/unit/objects/test_instance.py @@ -683,15 +683,32 @@ class _TestInstanceObject(object): inst.numa_topology = None inst.migration_context = None inst.vcpu_model = test_vcpu_model.fake_vcpumodel - inst.save() + inst.keypairs = objects.KeyPairList( + objects=[objects.KeyPair(name='foo')]) + json_vcpu_model = jsonutils.dumps( test_vcpu_model.fake_vcpumodel.obj_to_primitive()) - expected_vals = {'numa_topology': None, - 'migration_context': None, - 'vcpu_model': json_vcpu_model} + json_keypairs = jsonutils.dumps(inst.keypairs.obj_to_primitive()) + + # Check changed fields in the instance object + self.assertIn('keypairs', inst.obj_what_changed()) + self.assertEqual({'objects'}, inst.keypairs.obj_what_changed()) + + inst.save() + + expected_vals = { + 'numa_topology': None, + 'migration_context': None, + 'vcpu_model': json_vcpu_model, + 'keypairs': json_keypairs, + } mock_update.assert_called_once_with(self.context, inst.uuid, expected_vals) + # Verify that the record of changed fields has been cleared + self.assertNotIn('keypairs', inst.obj_what_changed()) + self.assertEqual(set(), inst.keypairs.obj_what_changed()) + @mock.patch.object(db, 'instance_get_by_uuid') def test_get_deleted(self, mock_get): fake_inst = dict(self.fake_instance, id=123, deleted=123)