Use Adapter global_request_id kwarg

Release 3.15.0 of keystoneauth1 introduced the ability to pass
X-Openstack-Request-Id to request methods (get/put/etc) via a
global_request_id kwarg rather than having to put it in a headers dict.

This commit bumps the minimum ksa level to 3.15.0 and takes advantage of
the new kwarg to replace explicit header construction in
SchedulerReportClient (Placement) and neutronv2/api methods.

Also normalizes the way param lists were being passed from
SchedulerReportClient's REST primitives (get/put/post/delete) into the
Adapter equivalents. There was no reason for them to be different.

Change-Id: I2f6eb50f4cb428179ec788de8b7bd6ef9bbeeaf9

Author: Eric Fried

lower-constraints.txt

@@ -44,7 +44,7 @@ jsonpath-rw==1.4.0
 jsonpath-rw-ext==1.1.3
 jsonpointer==2.0
 jsonschema==2.6.0
-keystoneauth1==3.9.0
+keystoneauth1==3.15.0
 keystonemiddleware==4.20.0
 kombu==4.1.0
 linecache2==1.0.0

nova/network/neutronv2/api.py

@@ -22,7 +22,6 @@
 from neutronclient.common import exceptions as neutron_client_exc
 from neutronclient.v2_0 import client as clientv20
 from oslo_log import log as logging
-from oslo_middleware import request_id
 from oslo_utils import excutils
 from oslo_utils import strutils
 from oslo_utils import uuidutils
@@ -1328,7 +1327,7 @@ def _create_port_binding(context, client, port_id, data):
         """
         return client.post(
             '/v2.0/ports/%s/bindings' % port_id, json=data, raise_exc=False,
-            headers={request_id.INBOUND_HEADER: context.global_id})
+            global_request_id=context.global_id)
 
     def delete_port_binding(self, context, port_id, host):
         """Delete the port binding for the given port ID and host
@@ -1371,7 +1370,7 @@ def _delete_port_binding(context, client, port_id, host):
         """
         return client.delete(
             '/v2.0/ports/%s/bindings/%s' % (port_id, host), raise_exc=False,
-            headers={request_id.INBOUND_HEADER: context.global_id})
+            global_request_id=context.global_id)
 
     def activate_port_binding(self, context, port_id, host):
         """Activates an inactive port binding.
@@ -1393,7 +1392,7 @@ def activate_port_binding(self, context, port_id, host):
         resp = client.put(
             '/v2.0/ports/%s/bindings/%s/activate' % (port_id, host),
             raise_exc=False,
-            headers={request_id.INBOUND_HEADER: context.global_id})
+            global_request_id=context.global_id)
         if resp:
             LOG.debug('Activated binding for port %s and host %s.',
                       port_id, host)
@@ -2701,8 +2700,7 @@ def migrate_instance_start(self, context, instance, migration):
             # port and destination host.
             resp = client.get(
                 '/v2.0/ports/%s/bindings/%s' % (vif['id'], dest_host),
-                raise_exc=False,
-                headers={request_id.INBOUND_HEADER: context.global_id})
+                raise_exc=False, global_request_id=context.global_id)
             if resp:
                 if resp.json()['binding']['status'] != 'ACTIVE':
                     self.activate_port_binding(context, vif['id'], dest_host)

nova/scheduler/client/report.py

@@ -247,36 +247,28 @@ def _create_client(self):
         return client
 
     def get(self, url, version=None, global_request_id=None):
-        headers = ({request_id.INBOUND_HEADER: global_request_id}
-                   if global_request_id else {})
-        return self._client.get(url, microversion=version, headers=headers)
+        return self._client.get(url, microversion=version,
+                                global_request_id=global_request_id)
 
     def post(self, url, data, version=None, global_request_id=None):
-        headers = ({request_id.INBOUND_HEADER: global_request_id}
-                   if global_request_id else {})
         # NOTE(sdague): using json= instead of data= sets the
         # media type to application/json for us. Placement API is
         # more sensitive to this than other APIs in the OpenStack
         # ecosystem.
         return self._client.post(url, json=data, microversion=version,
-                                 headers=headers)
+                                 global_request_id=global_request_id)
 
     def put(self, url, data, version=None, global_request_id=None):
         # NOTE(sdague): using json= instead of data= sets the
         # media type to application/json for us. Placement API is
         # more sensitive to this than other APIs in the OpenStack
         # ecosystem.
-        kwargs = {'microversion': version,
-                  'headers': {request_id.INBOUND_HEADER:
-                              global_request_id} if global_request_id else {}}
-        if data is not None:
-            kwargs['json'] = data
-        return self._client.put(url, **kwargs)
+        return self._client.put(url, json=data, microversion=version,
+                                global_request_id=global_request_id)
 
     def delete(self, url, version=None, global_request_id=None):
-        headers = ({request_id.INBOUND_HEADER: global_request_id}
-                   if global_request_id else {})
-        return self._client.delete(url, microversion=version, headers=headers)
+        return self._client.delete(url, microversion=version,
+                                   global_request_id=global_request_id)
 
     @safe_connect
     def get_allocation_candidates(self, context, resources):

nova/tests/unit/network/test_neutronv2.py

@@ -5715,7 +5715,7 @@ def test_migrate_instance_start_activate(self, get_client_mock):
         activate.assert_called_once_with(self.context, uuids.port_id, 'dest')
         get_client_mock.return_value.get.assert_called_once_with(
             '/v2.0/ports/%s/bindings/dest' % uuids.port_id, raise_exc=False,
-            headers={'X-Openstack-Request-Id': self.context.global_id})
+            global_request_id=self.context.global_id)
 
     @mock.patch('nova.network.neutronv2.api._get_ksa_client')
     def test_migrate_instance_start_already_active(self, get_client_mock):
@@ -5738,7 +5738,7 @@ def test_migrate_instance_start_already_active(self, get_client_mock):
                     self.context, instance, migration)
         get_client_mock.return_value.get.assert_called_once_with(
             '/v2.0/ports/%s/bindings/dest' % uuids.port_id, raise_exc=False,
-            headers={'X-Openstack-Request-Id': self.context.global_id})
+            global_request_id=self.context.global_id)
 
     @mock.patch('nova.network.neutronv2.api._get_ksa_client')
     def test_migrate_instance_start_no_bindings(self, get_client_mock):
@@ -5763,7 +5763,7 @@ def test_migrate_instance_start_no_bindings(self, get_client_mock):
                     self.context, instance, migration)
         get_client_mock.return_value.get.assert_called_once_with(
             '/v2.0/ports/%s/bindings/dest' % uuids.port1, raise_exc=False,
-            headers={'X-Openstack-Request-Id': self.context.global_id})
+            global_request_id=self.context.global_id)
 
     @mock.patch('nova.network.neutronv2.api._get_ksa_client')
     def test_migrate_instance_start_get_error(self, get_client_mock):
@@ -5788,11 +5788,11 @@ def test_migrate_instance_start_get_error(self, get_client_mock):
             mock.call(
                 '/v2.0/ports/%s/bindings/dest' % uuids.port1,
                 raise_exc=False,
-                headers={'X-Openstack-Request-Id': self.context.global_id}),
+                global_request_id=self.context.global_id),
             mock.call(
                 '/v2.0/ports/%s/bindings/dest' % uuids.port2,
                 raise_exc=False,
-                headers={'X-Openstack-Request-Id': self.context.global_id})])
+                global_request_id=self.context.global_id)])
 
 
 class TestNeutronv2ModuleMethods(test.NoDBTestCase):
@@ -6294,7 +6294,7 @@ def test_activate_port_binding(self, mock_client):
         mock_client.return_value.put.assert_called_once_with(
             '/v2.0/ports/%s/bindings/fake-host/activate' % uuids.port_id,
             raise_exc=False,
-            headers={'X-Openstack-Request-Id': self.context.global_id})
+            global_request_id=self.context.global_id)
 
     @mock.patch('nova.network.neutronv2.api._get_ksa_client')
     @mock.patch('nova.network.neutronv2.api.LOG.warning')
@@ -6307,7 +6307,7 @@ def test_activate_port_binding_already_active(
         mock_client.return_value.put.assert_called_once_with(
             '/v2.0/ports/%s/bindings/fake-host/activate' % uuids.port_id,
             raise_exc=False,
-            headers={'X-Openstack-Request-Id': self.context.global_id})
+            global_request_id=self.context.global_id)
         self.assertEqual(1, mock_log_warning.call_count)
         self.assertIn('is already active', mock_log_warning.call_args[0][0])
 
@@ -6321,7 +6321,7 @@ def test_activate_port_binding_fails(self, mock_client):
         mock_client.return_value.put.assert_called_once_with(
             '/v2.0/ports/%s/bindings/fake-host/activate' % uuids.port_id,
             raise_exc=False,
-            headers={'X-Openstack-Request-Id': self.context.global_id})
+            global_request_id=self.context.global_id)
 
 
 class TestAllocateForInstance(test.NoDBTestCase):