7d748bc8c6
This patch does a couple of things: 1) Remove the dependency of nova.rpc on nova.flags. This is a step toward decoupling nova.rpc from the rest of nova so that it can be moved to openstack-common. 2) Refactor nova.rpc so that a configuration object is passed around as needed instead of depending on nova.flags.FLAGS. This was done by avoiding changing the nova.rpc API as much as possible so that existing usage of nova.rpc would not have to be touched. So, instead, a config object gets registered, cached, and then passed into the rpc implementations as needed. Getting rid of this global config reference in nova.rpc will require changing the public API and I wanted to avoid doing that until there was a better reason than this. Change-Id: I9a7fa67bd12ced877c83e48e31f5ef7263be6815
350 lines
12 KiB
Python
350 lines
12 KiB
Python
# vim: tabstop=4 shiftwidth=4 softtabstop=4
|
|
|
|
# Copyright 2010 United States Government as represented by the
|
|
# Administrator of the National Aeronautics and Space Administration.
|
|
# All Rights Reserved.
|
|
#
|
|
# 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 remote procedure calls using kombu
|
|
"""
|
|
|
|
from nova import context
|
|
from nova import exception
|
|
from nova import flags
|
|
from nova import log as logging
|
|
from nova import test
|
|
from nova.rpc import amqp as rpc_amqp
|
|
from nova.rpc import impl_kombu
|
|
from nova.tests.rpc import common
|
|
|
|
FLAGS = flags.FLAGS
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class MyException(Exception):
|
|
pass
|
|
|
|
|
|
def _raise_exc_stub(stubs, times, obj, method, exc_msg,
|
|
exc_class=MyException):
|
|
info = {'called': 0}
|
|
orig_method = getattr(obj, method)
|
|
|
|
def _raise_stub(*args, **kwargs):
|
|
info['called'] += 1
|
|
if info['called'] <= times:
|
|
raise exc_class(exc_msg)
|
|
orig_method(*args, **kwargs)
|
|
stubs.Set(obj, method, _raise_stub)
|
|
return info
|
|
|
|
|
|
class RpcKombuTestCase(common.BaseRpcAMQPTestCase):
|
|
def setUp(self):
|
|
self.rpc = impl_kombu
|
|
impl_kombu.register_opts(FLAGS)
|
|
super(RpcKombuTestCase, self).setUp()
|
|
|
|
def tearDown(self):
|
|
impl_kombu.cleanup()
|
|
super(RpcKombuTestCase, self).tearDown()
|
|
|
|
def test_reusing_connection(self):
|
|
"""Test that reusing a connection returns same one."""
|
|
conn_context = self.rpc.create_connection(FLAGS, new=False)
|
|
conn1 = conn_context.connection
|
|
conn_context.close()
|
|
conn_context = self.rpc.create_connection(FLAGS, new=False)
|
|
conn2 = conn_context.connection
|
|
conn_context.close()
|
|
self.assertEqual(conn1, conn2)
|
|
|
|
def test_topic_send_receive(self):
|
|
"""Test sending to a topic exchange/queue"""
|
|
|
|
conn = self.rpc.create_connection(FLAGS)
|
|
message = 'topic test message'
|
|
|
|
self.received_message = None
|
|
|
|
def _callback(message):
|
|
self.received_message = message
|
|
|
|
conn.declare_topic_consumer('a_topic', _callback)
|
|
conn.topic_send('a_topic', message)
|
|
conn.consume(limit=1)
|
|
conn.close()
|
|
|
|
self.assertEqual(self.received_message, message)
|
|
|
|
def test_direct_send_receive(self):
|
|
"""Test sending to a direct exchange/queue"""
|
|
conn = self.rpc.create_connection(FLAGS)
|
|
message = 'direct test message'
|
|
|
|
self.received_message = None
|
|
|
|
def _callback(message):
|
|
self.received_message = message
|
|
|
|
conn.declare_direct_consumer('a_direct', _callback)
|
|
conn.direct_send('a_direct', message)
|
|
conn.consume(limit=1)
|
|
conn.close()
|
|
|
|
self.assertEqual(self.received_message, message)
|
|
|
|
def test_cast_interface_uses_default_options(self):
|
|
"""Test kombu rpc.cast"""
|
|
|
|
ctxt = context.RequestContext('fake_user', 'fake_project')
|
|
|
|
class MyConnection(impl_kombu.Connection):
|
|
def __init__(myself, *args, **kwargs):
|
|
super(MyConnection, myself).__init__(*args, **kwargs)
|
|
self.assertEqual(myself.params,
|
|
{'hostname': FLAGS.rabbit_host,
|
|
'userid': FLAGS.rabbit_userid,
|
|
'password': FLAGS.rabbit_password,
|
|
'port': FLAGS.rabbit_port,
|
|
'virtual_host': FLAGS.rabbit_virtual_host,
|
|
'transport': 'memory'})
|
|
|
|
def topic_send(_context, topic, msg):
|
|
pass
|
|
|
|
MyConnection.pool = rpc_amqp.Pool(FLAGS, MyConnection)
|
|
self.stubs.Set(impl_kombu, 'Connection', MyConnection)
|
|
|
|
impl_kombu.cast(FLAGS, ctxt, 'fake_topic', {'msg': 'fake'})
|
|
|
|
def test_cast_to_server_uses_server_params(self):
|
|
"""Test kombu rpc.cast"""
|
|
|
|
ctxt = context.RequestContext('fake_user', 'fake_project')
|
|
|
|
server_params = {'username': 'fake_username',
|
|
'password': 'fake_password',
|
|
'hostname': 'fake_hostname',
|
|
'port': 31337,
|
|
'virtual_host': 'fake_virtual_host'}
|
|
|
|
class MyConnection(impl_kombu.Connection):
|
|
def __init__(myself, *args, **kwargs):
|
|
super(MyConnection, myself).__init__(*args, **kwargs)
|
|
self.assertEqual(myself.params,
|
|
{'hostname': server_params['hostname'],
|
|
'userid': server_params['username'],
|
|
'password': server_params['password'],
|
|
'port': server_params['port'],
|
|
'virtual_host': server_params['virtual_host'],
|
|
'transport': 'memory'})
|
|
|
|
def topic_send(_context, topic, msg):
|
|
pass
|
|
|
|
MyConnection.pool = rpc_amqp.Pool(FLAGS, MyConnection)
|
|
self.stubs.Set(impl_kombu, 'Connection', MyConnection)
|
|
|
|
impl_kombu.cast_to_server(FLAGS, ctxt, server_params,
|
|
'fake_topic', {'msg': 'fake'})
|
|
|
|
@test.skip_test("kombu memory transport seems buggy with fanout queues "
|
|
"as this test passes when you use rabbit (fake_rabbit=False)")
|
|
def test_fanout_send_receive(self):
|
|
"""Test sending to a fanout exchange and consuming from 2 queues"""
|
|
|
|
conn = self.rpc.create_connection()
|
|
conn2 = self.rpc.create_connection()
|
|
message = 'fanout test message'
|
|
|
|
self.received_message = None
|
|
|
|
def _callback(message):
|
|
self.received_message = message
|
|
|
|
conn.declare_fanout_consumer('a_fanout', _callback)
|
|
conn2.declare_fanout_consumer('a_fanout', _callback)
|
|
conn.fanout_send('a_fanout', message)
|
|
|
|
conn.consume(limit=1)
|
|
conn.close()
|
|
self.assertEqual(self.received_message, message)
|
|
|
|
self.received_message = None
|
|
conn2.consume(limit=1)
|
|
conn2.close()
|
|
self.assertEqual(self.received_message, message)
|
|
|
|
def test_declare_consumer_errors_will_reconnect(self):
|
|
# Test that any exception with 'timeout' in it causes a
|
|
# reconnection
|
|
info = _raise_exc_stub(self.stubs, 2, self.rpc.DirectConsumer,
|
|
'__init__', 'foo timeout foo')
|
|
|
|
conn = self.rpc.Connection(FLAGS)
|
|
result = conn.declare_consumer(self.rpc.DirectConsumer,
|
|
'test_topic', None)
|
|
|
|
self.assertEqual(info['called'], 3)
|
|
self.assertTrue(isinstance(result, self.rpc.DirectConsumer))
|
|
|
|
# Test that any exception in transport.connection_errors causes
|
|
# a reconnection
|
|
self.stubs.UnsetAll()
|
|
|
|
info = _raise_exc_stub(self.stubs, 1, self.rpc.DirectConsumer,
|
|
'__init__', 'meow')
|
|
|
|
conn = self.rpc.Connection(FLAGS)
|
|
conn.connection_errors = (MyException, )
|
|
|
|
result = conn.declare_consumer(self.rpc.DirectConsumer,
|
|
'test_topic', None)
|
|
|
|
self.assertEqual(info['called'], 2)
|
|
self.assertTrue(isinstance(result, self.rpc.DirectConsumer))
|
|
|
|
def test_declare_consumer_ioerrors_will_reconnect(self):
|
|
"""Test that an IOError exception causes a reconnection"""
|
|
info = _raise_exc_stub(self.stubs, 2, self.rpc.DirectConsumer,
|
|
'__init__', 'Socket closed', exc_class=IOError)
|
|
|
|
conn = self.rpc.Connection(FLAGS)
|
|
result = conn.declare_consumer(self.rpc.DirectConsumer,
|
|
'test_topic', None)
|
|
|
|
self.assertEqual(info['called'], 3)
|
|
self.assertTrue(isinstance(result, self.rpc.DirectConsumer))
|
|
|
|
def test_publishing_errors_will_reconnect(self):
|
|
# Test that any exception with 'timeout' in it causes a
|
|
# reconnection when declaring the publisher class and when
|
|
# calling send()
|
|
info = _raise_exc_stub(self.stubs, 2, self.rpc.DirectPublisher,
|
|
'__init__', 'foo timeout foo')
|
|
|
|
conn = self.rpc.Connection(FLAGS)
|
|
conn.publisher_send(self.rpc.DirectPublisher, 'test_topic', 'msg')
|
|
|
|
self.assertEqual(info['called'], 3)
|
|
self.stubs.UnsetAll()
|
|
|
|
info = _raise_exc_stub(self.stubs, 2, self.rpc.DirectPublisher,
|
|
'send', 'foo timeout foo')
|
|
|
|
conn = self.rpc.Connection(FLAGS)
|
|
conn.publisher_send(self.rpc.DirectPublisher, 'test_topic', 'msg')
|
|
|
|
self.assertEqual(info['called'], 3)
|
|
|
|
# Test that any exception in transport.connection_errors causes
|
|
# a reconnection when declaring the publisher class and when
|
|
# calling send()
|
|
self.stubs.UnsetAll()
|
|
|
|
info = _raise_exc_stub(self.stubs, 1, self.rpc.DirectPublisher,
|
|
'__init__', 'meow')
|
|
|
|
conn = self.rpc.Connection(FLAGS)
|
|
conn.connection_errors = (MyException, )
|
|
|
|
conn.publisher_send(self.rpc.DirectPublisher, 'test_topic', 'msg')
|
|
|
|
self.assertEqual(info['called'], 2)
|
|
self.stubs.UnsetAll()
|
|
|
|
info = _raise_exc_stub(self.stubs, 1, self.rpc.DirectPublisher,
|
|
'send', 'meow')
|
|
|
|
conn = self.rpc.Connection(FLAGS)
|
|
conn.connection_errors = (MyException, )
|
|
|
|
conn.publisher_send(self.rpc.DirectPublisher, 'test_topic', 'msg')
|
|
|
|
self.assertEqual(info['called'], 2)
|
|
|
|
def test_iterconsume_errors_will_reconnect(self):
|
|
conn = self.rpc.Connection(FLAGS)
|
|
message = 'reconnect test message'
|
|
|
|
self.received_message = None
|
|
|
|
def _callback(message):
|
|
self.received_message = message
|
|
|
|
conn.declare_direct_consumer('a_direct', _callback)
|
|
conn.direct_send('a_direct', message)
|
|
|
|
info = _raise_exc_stub(self.stubs, 1, conn.connection,
|
|
'drain_events', 'foo timeout foo')
|
|
conn.consume(limit=1)
|
|
conn.close()
|
|
|
|
self.assertEqual(self.received_message, message)
|
|
# Only called once, because our stub goes away during reconnection
|
|
|
|
def test_call_exception(self):
|
|
"""Test that exception gets passed back properly.
|
|
|
|
rpc.call returns an Exception object. The value of the
|
|
exception is converted to a string.
|
|
|
|
"""
|
|
self.flags(allowed_rpc_exception_modules=['exceptions'])
|
|
value = "This is the exception message"
|
|
self.assertRaises(NotImplementedError,
|
|
self.rpc.call,
|
|
FLAGS,
|
|
self.context,
|
|
'test',
|
|
{"method": "fail",
|
|
"args": {"value": value}})
|
|
try:
|
|
self.rpc.call(FLAGS, self.context,
|
|
'test',
|
|
{"method": "fail",
|
|
"args": {"value": value}})
|
|
self.fail("should have thrown Exception")
|
|
except NotImplementedError as exc:
|
|
self.assertTrue(value in unicode(exc))
|
|
#Traceback should be included in exception message
|
|
self.assertTrue('raise NotImplementedError(value)' in unicode(exc))
|
|
|
|
def test_call_converted_exception(self):
|
|
"""Test that exception gets passed back properly.
|
|
|
|
rpc.call returns an Exception object. The value of the
|
|
exception is converted to a string.
|
|
|
|
"""
|
|
value = "This is the exception message"
|
|
self.assertRaises(exception.ConvertedException,
|
|
self.rpc.call,
|
|
FLAGS,
|
|
self.context,
|
|
'test',
|
|
{"method": "fail_converted",
|
|
"args": {"value": value}})
|
|
try:
|
|
self.rpc.call(FLAGS, self.context,
|
|
'test',
|
|
{"method": "fail_converted",
|
|
"args": {"value": value}})
|
|
self.fail("should have thrown Exception")
|
|
except exception.ConvertedException as exc:
|
|
self.assertTrue(value in unicode(exc))
|
|
#Traceback should be included in exception message
|
|
self.assertTrue('exception.ConvertedException' in unicode(exc))
|