From f02873090c2aea724c64c94c6542dab9cce75cf1 Mon Sep 17 00:00:00 2001
From: Ihar Hrachyshka <ihrachys@redhat.com>
Date: Mon, 2 Jun 2014 17:40:38 +0200
Subject: [PATCH] Port to oslo.messaging

Now that all preparations are done, actually port the code to use
oslo.messaging. This patch does as little as possible. Follow up patches
that refactor and cleanup the code and configuration files, will be
merged later. The reason for this is to make the patch as slim as
possible, to make review process more smooth and concentrated.

Details:
* neutron/common/rpc.py:
  - added init() and cleanup() to set global RPC layer state.
  - added utility functions: get_server(), get_client(), get_notifier()
    that wrap up oslo.messaging API a bit, enforcing eventlet executor
    and setting serializer, among other things.
  - removed PluginRpcDispatcher, instead introduced PluginRpcSerializer
    to use as a default serializer for API callbacks.

* neutron/common/rpc_compat.py:
  - emulated incubator RPC layer behaviour thru previously introduced
    stub classes (RpcCallback, RpcProxy, ...) using new oslo.messaging
    API.
  - switched to using new oslo.messaging exception types.

* neutron/service.py:
  - expect multiple RPC listeners that are of MessageHandlingServer
    type, not GreenThread.

* neutron/common/config.py:
  - initialize RPC layer in init()

* setup.cfg:
  - added entry points for old notifier drivers to retain backward
    compatibility.

* neutron/tests/...:
  - introduced fake_notifier to replace impl_fake.
  - faked out consume_in_thread() to avoid starting RPC listeners when
    running unit tests.
  - used 'fake' transport driver.
  - made sure neutron.test.* exceptions are caught.
  - initialize and clean up RPC layer for each test case.

* Ported all affected code from using neutron.openstack.common.notifier
  API to oslo.messaging.Notifier.

* rpc.set_defaults() was renamed to rpc.set_transport_defaults()

* other changes not worth mentioning here.

blueprint oslo-messaging

DocImpact

Change-Id: I5a91c34df6e300f2dc46217b1b16352fcc3039fc
---
 neutron/plugins/mlnx/agent/eswitch_neutron_agent.py | 3 +--
 requirements.txt                                    | 1 +
 setup.cfg                                           | 8 ++++++++
 3 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/neutron/plugins/mlnx/agent/eswitch_neutron_agent.py b/neutron/plugins/mlnx/agent/eswitch_neutron_agent.py
index 90a97ce..94fd2b8 100644
--- a/neutron/plugins/mlnx/agent/eswitch_neutron_agent.py
+++ b/neutron/plugins/mlnx/agent/eswitch_neutron_agent.py
@@ -35,7 +35,6 @@ from neutron.common import utils as q_utils
 from neutron import context
 from neutron.openstack.common import log as logging
 from neutron.openstack.common import loopingcall
-from neutron.openstack.common.rpc import dispatcher
 from neutron.plugins.common import constants as p_const
 from neutron.plugins.mlnx.agent import utils
 from neutron.plugins.mlnx.common import config  # noqa
@@ -218,7 +217,7 @@ class MlnxEswitchRpcCallbacks(rpc_compat.RpcCallback,
         or support more than one class as the target of rpc messages,
         override this method.
         """
-        return dispatcher.RpcDispatcher([self])
+        return [self]
 
 
 class MlnxEswitchPluginApi(agent_rpc.PluginApi,
diff --git a/requirements.txt b/requirements.txt
index 5ba04f2..f34177a 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -23,6 +23,7 @@ alembic>=0.4.1
 six>=1.7.0
 stevedore>=0.14
 oslo.config>=1.2.1
+oslo.messaging>=1.3.0
 oslo.rootwrap
 
 python-novaclient>=2.17.0
diff --git a/setup.cfg b/setup.cfg
index cc4db51..0eaaaed 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -169,6 +169,14 @@ neutron.ml2.mechanism_drivers =
     fslsdn = neutron.plugins.ml2.drivers.mechanism_fslsdn:FslsdnMechanismDriver
 neutron.openstack.common.cache.backends =
     memory = neutron.openstack.common.cache._backends.memory:MemoryBackend
+# These are for backwards compat with Icehouse notification_driver configuration values
+oslo.messaging.notify.drivers =
+    neutron.openstack.common.notifier.log_notifier = oslo.messaging.notify._impl_log:LogDriver
+    neutron.openstack.common.notifier.no_op_notifier = oslo.messaging.notify._impl_noop:NoOpDriver
+    neutron.openstack.common.notifier.rpc_notifier2 = oslo.messaging.notify._impl_messaging:MessagingV2Driver
+    neutron.openstack.common.notifier.rpc_notifier = oslo.messaging.notify._impl_messaging:MessagingDriver
+    neutron.openstack.common.notifier.test_notifier = oslo.messaging.notify._impl_test:TestDriver
+
 
 [build_sphinx]
 all_files = 1