From 7317afd3201c4f9f21d3f37dab08423dae236b17 Mon Sep 17 00:00:00 2001
From: Sylvain Bauza <sbauza@redhat.com>
Date: Thu, 6 Jul 2017 17:17:31 +0200
Subject: [PATCH] Pass requested_destination in filter_properties

When we added the requested_destination field for the RequestSpec object
in Newton, we forgot to pass it to the legacy dictionary when wanting to
use scheduler methods not yet supporting the NovaObject.
As a consequence, when we were transforming the RequestSpec object into a
tuple of (request_spec, filter_props) dicts and then rehydrating a new
RequestSpec object using those dicts, the newly created object was not
keeping that requested_destination field from the original.

Change-Id: Iba0b88172e9a3bfd4f216dd364d70f7e01c60ee2
Closes-Bug: #1702454
---
 nova/objects/request_spec.py                 |  7 +++++++
 nova/tests/unit/objects/test_request_spec.py | 19 ++++++++++++++++---
 2 files changed, 23 insertions(+), 3 deletions(-)

diff --git a/nova/objects/request_spec.py b/nova/objects/request_spec.py
index 2296d4979fc4..6e0d93508947 100644
--- a/nova/objects/request_spec.py
+++ b/nova/objects/request_spec.py
@@ -264,6 +264,8 @@ class RequestSpec(base.NovaObject):
         spec._populate_group_info(filter_properties)
         scheduler_hints = filter_properties.get('scheduler_hints', {})
         spec._from_hints(scheduler_hints)
+        spec.requested_destination = filter_properties.get(
+            'requested_destination')
 
         # NOTE(sbauza): Default the other fields that are not part of the
         # original contract
@@ -372,6 +374,9 @@ class RequestSpec(base.NovaObject):
             # we had to hydrate the field by putting a single item into a list.
             filt_props['scheduler_hints'] = {hint: self.get_scheduler_hint(
                 hint) for hint in self.scheduler_hints}
+        if self.obj_attr_is_set('requested_destination'
+                                ) and self.requested_destination:
+            filt_props['requested_destination'] = self.requested_destination
         return filt_props
 
     @classmethod
@@ -417,6 +422,8 @@ class RequestSpec(base.NovaObject):
         spec_obj.availability_zone = availability_zone
         if security_groups is not None:
             spec_obj.security_groups = security_groups
+        spec_obj.requested_destination = filter_properties.get(
+            'requested_destination')
 
         # NOTE(sbauza): Default the other fields that are not part of the
         # original contract
diff --git a/nova/tests/unit/objects/test_request_spec.py b/nova/tests/unit/objects/test_request_spec.py
index efe887fb4d5b..484a7d985277 100644
--- a/nova/tests/unit/objects/test_request_spec.py
+++ b/nova/tests/unit/objects/test_request_spec.py
@@ -299,13 +299,22 @@ class _TestRequestSpecObject(object):
         # just making sure that the context is set by the method
         self.assertEqual(ctxt, spec._context)
 
+    def test_from_primitives_with_requested_destination(self):
+        destination = objects.Destination(host='foo')
+        spec_dict = {}
+        filt_props = {'requested_destination': destination}
+        ctxt = context.RequestContext('fake', 'fake')
+        spec = objects.RequestSpec.from_primitives(ctxt, spec_dict, filt_props)
+        self.assertEqual(destination, spec.requested_destination)
+
     def test_from_components(self):
         ctxt = context.RequestContext('fake-user', 'fake-project')
+        destination = objects.Destination(host='foo')
         instance = fake_instance.fake_instance_obj(ctxt)
         image = {'id': uuids.image_id, 'properties': {'mappings': []},
                  'status': 'fake-status', 'location': 'far-away'}
         flavor = fake_flavor.fake_flavor_obj(ctxt)
-        filter_properties = {}
+        filter_properties = {'requested_destination': destination}
         instance_group = None
 
         spec = objects.RequestSpec.from_components(ctxt, instance.uuid, image,
@@ -318,6 +327,7 @@ class _TestRequestSpecObject(object):
                             'Field: %s is not set' % field)
         # just making sure that the context is set by the method
         self.assertEqual(ctxt, spec._context)
+        self.assertEqual(destination, spec.requested_destination)
 
     @mock.patch('nova.objects.RequestSpec._populate_group_info')
     def test_from_components_with_instance_group(self, mock_pgi):
@@ -436,6 +446,7 @@ class _TestRequestSpecObject(object):
         fake_computes_obj = objects.ComputeNodeList(
             objects=[objects.ComputeNode(host='fake1',
                                          hypervisor_hostname='node1')])
+        fake_dest = objects.Destination(host='fakehost')
         spec = objects.RequestSpec(
             ignore_hosts=['ignoredhost'],
             force_hosts=['fakehost'],
@@ -449,7 +460,8 @@ class _TestRequestSpecObject(object):
             instance_group=objects.InstanceGroup(hosts=['fake1'],
                                                  policies=['affinity'],
                                                  members=['inst1', 'inst2']),
-            scheduler_hints={'foo': ['bar']})
+            scheduler_hints={'foo': ['bar']},
+            requested_destination=fake_dest)
         expected = {'ignore_hosts': ['ignoredhost'],
                     'force_hosts': ['fakehost'],
                     'force_nodes': ['fakenode'],
@@ -463,7 +475,8 @@ class _TestRequestSpecObject(object):
                     'group_hosts': set(['fake1']),
                     'group_policies': set(['affinity']),
                     'group_members': set(['inst1', 'inst2']),
-                    'scheduler_hints': {'foo': 'bar'}}
+                    'scheduler_hints': {'foo': 'bar'},
+                    'requested_destination': fake_dest}
         self.assertEqual(expected, spec.to_legacy_filter_properties_dict())
 
     def test_to_legacy_filter_properties_dict_with_nullable_values(self):