Merge "Add base support for rpc API versioning."

3 files changed, 239 insertions, 4 deletions

diff --git a/nova/tests/rpc/common.py b/nova/tests/rpc/common.py
index 0c8c11487..c07ddfa1a 100644
--- a/nova/tests/rpc/common.py
+++ b/nova/tests/rpc/common.py
@@ -30,6 +30,7 @@ from nova import flags
 from nova import log as logging
 from nova.rpc import amqp as rpc_amqp
 from nova.rpc import common as rpc_common
+from nova.rpc import dispatcher as rpc_dispatcher
 from nova import test
 
 
@@ -44,8 +45,9 @@ class BaseRpcTestCase(test.TestCase):
         self.context = context.get_admin_context()
         if self.rpc:
             self.conn = self.rpc.create_connection(FLAGS, True)
-            self.receiver = TestReceiver()
-            self.conn.create_consumer('test', self.receiver, False)
+            receiver = TestReceiver()
+            self.dispatcher = rpc_dispatcher.RpcDispatcher([receiver])
+            self.conn.create_consumer('test', self.dispatcher, False)
             self.conn.consume_in_thread()
 
     def tearDown(self):
@@ -145,8 +147,9 @@ class BaseRpcTestCase(test.TestCase):
                 return value
 
         nested = Nested()
+        dispatcher = rpc_dispatcher.RpcDispatcher([nested])
         conn = self.rpc.create_connection(FLAGS, True)
-        conn.create_consumer('nested', nested, False)
+        conn.create_consumer('nested', dispatcher, False)
         conn.consume_in_thread()
         value = 42
         result = self.rpc.call(FLAGS, self.context,
@@ -228,7 +231,6 @@ class TestReceiver(object):
     Uses static methods because we aren't actually storing any state.
 
     """
-
     @staticmethod
     def echo(context, value):
         """Simply returns whatever value is sent in."""
diff --git a/nova/tests/rpc/test_dispatcher.py b/nova/tests/rpc/test_dispatcher.py
new file mode 100644
index 000000000..0c16c6a34
--- /dev/null
+++ b/nova/tests/rpc/test_dispatcher.py
@@ -0,0 +1,109 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2012, Red Hat, Inc.
+#
+#    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.
+
+"""
+Unit Tests for rpc.dispatcher
+"""
+
+from nova import context
+from nova.rpc import dispatcher
+from nova.rpc import common as rpc_common
+from nova import test
+
+
+class RpcDispatcherTestCase(test.TestCase):
+    class API1(object):
+        RPC_API_VERSION = '1.0'
+
+        def __init__(self):
+            self.test_method_ctxt = None
+            self.test_method_arg1 = None
+
+        def test_method(self, ctxt, arg1):
+            self.test_method_ctxt = ctxt
+            self.test_method_arg1 = arg1
+
+    class API2(object):
+        RPC_API_VERSION = '2.1'
+
+        def __init__(self):
+            self.test_method_ctxt = None
+            self.test_method_arg1 = None
+
+        def test_method(self, ctxt, arg1):
+            self.test_method_ctxt = ctxt
+            self.test_method_arg1 = arg1
+
+    class API3(object):
+        RPC_API_VERSION = '3.5'
+
+        def __init__(self):
+            self.test_method_ctxt = None
+            self.test_method_arg1 = None
+
+        def test_method(self, ctxt, arg1):
+            self.test_method_ctxt = ctxt
+            self.test_method_arg1 = arg1
+
+    def setUp(self):
+        self.ctxt = context.RequestContext('fake_user', 'fake_project')
+        super(RpcDispatcherTestCase, self).setUp()
+
+    def tearDown(self):
+        super(RpcDispatcherTestCase, self).tearDown()
+
+    def _test_dispatch(self, version, expectations):
+        v2 = self.API2()
+        v3 = self.API3()
+        disp = dispatcher.RpcDispatcher([v2, v3])
+
+        disp.dispatch(self.ctxt, version, 'test_method', arg1=1)
+
+        self.assertEqual(v2.test_method_ctxt, expectations[0])
+        self.assertEqual(v2.test_method_arg1, expectations[1])
+        self.assertEqual(v3.test_method_ctxt, expectations[2])
+        self.assertEqual(v3.test_method_arg1, expectations[3])
+
+    def test_dispatch(self):
+        self._test_dispatch('2.1', (self.ctxt, 1, None, None))
+        self._test_dispatch('3.5', (None, None, self.ctxt, 1))
+
+    def test_dispatch_lower_minor_version(self):
+        self._test_dispatch('2.0', (self.ctxt, 1, None, None))
+        self._test_dispatch('3.1', (None, None, self.ctxt, 1))
+
+    def test_dispatch_higher_minor_version(self):
+        self.assertRaises(rpc_common.UnsupportedRpcVersion,
+                self._test_dispatch, '2.6', (None, None, None, None))
+        self.assertRaises(rpc_common.UnsupportedRpcVersion,
+                self._test_dispatch, '3.6', (None, None, None, None))
+
+    def test_dispatch_lower_major_version(self):
+        self.assertRaises(rpc_common.UnsupportedRpcVersion,
+                self._test_dispatch, '1.0', (None, None, None, None))
+
+    def test_dispatch_higher_major_version(self):
+        self.assertRaises(rpc_common.UnsupportedRpcVersion,
+                self._test_dispatch, '4.0', (None, None, None, None))
+
+    def test_dispatch_no_version_uses_v1(self):
+        v1 = self.API1()
+        disp = dispatcher.RpcDispatcher([v1])
+
+        disp.dispatch(self.ctxt, None, 'test_method', arg1=1)
+
+        self.assertEqual(v1.test_method_ctxt, self.ctxt)
+        self.assertEqual(v1.test_method_arg1, 1)
diff --git a/nova/tests/rpc/test_proxy.py b/nova/tests/rpc/test_proxy.py
new file mode 100644
index 000000000..9ef504a0d
--- /dev/null
+++ b/nova/tests/rpc/test_proxy.py
@@ -0,0 +1,124 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2012, Red Hat, Inc.
+#
+#    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.
+
+"""
+Unit Tests for rpc.proxy
+"""
+
+import copy
+
+from nova import context
+from nova import rpc
+from nova.rpc import proxy
+from nova import test
+
+
+class RpcProxyTestCase(test.TestCase):
+
+    def setUp(self):
+        super(RpcProxyTestCase, self).setUp()
+
+    def tearDown(self):
+        super(RpcProxyTestCase, self).tearDown()
+
+    def _test_rpc_method(self, rpc_method, has_timeout=False, has_retval=False,
+            server_params=None, supports_topic_override=True):
+        topic = 'fake_topic'
+        timeout = 123
+        rpc_proxy = proxy.RpcProxy(topic, '1.0')
+        ctxt = context.RequestContext('fake_user', 'fake_project')
+        msg = {'method': 'fake_method', 'args': {'x': 'y'}}
+        expected_msg = {'method': 'fake_method', 'args': {'x': 'y'},
+                'version': '1.0'}
+
+        expected_retval = 'hi' if has_retval else None
+
+        self.fake_args = None
+        self.fake_kwargs = None
+
+        def _fake_rpc_method(*args, **kwargs):
+            self.fake_args = args
+            self.fake_kwargs = kwargs
+            if has_retval:
+                return expected_retval
+
+        self.stubs.Set(rpc, rpc_method, _fake_rpc_method)
+
+        args = [ctxt, msg]
+        if server_params:
+            args.insert(1, server_params)
+
+        # Base method usage
+        retval = getattr(rpc_proxy, rpc_method)(*args)
+        self.assertEqual(retval, expected_retval)
+        expected_args = [ctxt, topic, expected_msg]
+        if server_params:
+            expected_args.insert(1, server_params)
+        for arg, expected_arg in zip(self.fake_args, expected_args):
+            self.assertEqual(arg, expected_arg)
+
+        # overriding the version
+        retval = getattr(rpc_proxy, rpc_method)(*args, version='1.1')
+        self.assertEqual(retval, expected_retval)
+        new_msg = copy.deepcopy(expected_msg)
+        new_msg['version'] = '1.1'
+        expected_args = [ctxt, topic, new_msg]
+        if server_params:
+            expected_args.insert(1, server_params)
+        for arg, expected_arg in zip(self.fake_args, expected_args):
+            self.assertEqual(arg, expected_arg)
+
+        if has_timeout:
+            # set a timeout
+            retval = getattr(rpc_proxy, rpc_method)(ctxt, msg, timeout=timeout)
+            self.assertEqual(retval, expected_retval)
+            expected_args = [ctxt, topic, expected_msg, timeout]
+            for arg, expected_arg in zip(self.fake_args, expected_args):
+                self.assertEqual(arg, expected_arg)
+
+        if supports_topic_override:
+            # set a topic
+            new_topic = 'foo.bar'
+            retval = getattr(rpc_proxy, rpc_method)(*args, topic=new_topic)
+            self.assertEqual(retval, expected_retval)
+            expected_args = [ctxt, new_topic, expected_msg]
+            if server_params:
+                expected_args.insert(1, server_params)
+            for arg, expected_arg in zip(self.fake_args, expected_args):
+                self.assertEqual(arg, expected_arg)
+
+    def test_call(self):
+        self._test_rpc_method('call', has_timeout=True, has_retval=True)
+
+    def test_multicall(self):
+        self._test_rpc_method('multicall', has_timeout=True, has_retval=True)
+
+    def test_cast(self):
+        self._test_rpc_method('cast')
+
+    def test_fanout_cast(self):
+        self._test_rpc_method('fanout_cast', supports_topic_override=False)
+
+    def test_cast_to_server(self):
+        self._test_rpc_method('cast_to_server', server_params={'blah': 1})
+
+    def test_fanout_cast_to_server(self):
+        self._test_rpc_method('fanout_cast_to_server',
+                server_params={'blah': 1}, supports_topic_override=False)
+
+    def test_make_msg(self):
+        self.assertEqual(proxy.RpcProxy.make_msg('test_method', a=1, b=2),
+                         {'method': 'test_method', 'args': {'a': 1, 'b': 2}})