From b7382d58d773e9be61dda3fac5b2e3cbddc22a22 Mon Sep 17 00:00:00 2001
From: Kenneth Giusti <kgiusti@gmail.com>
Date: Tue, 8 Aug 2017 09:50:16 -0400
Subject: [PATCH] Ensure RPC endpoint target attribute is correct
An endpoint can have an optional 'target' attribute which is used to
filter the callable endpoint by the target.version or .namespace
attributes. Therefore 'target' is reserved and attempting to use an
endpoint that overrides the target attribute (say with a function
call) should fail with a TypeError.
Change-Id: I0bbf9fca0ecbe71efa87c9613ffd32eb718f2c0e
Closes-Bug: #1709131
---
oslo_messaging/rpc/dispatcher.py | 9 +++
.../tests/functional/test_functional.py | 66 +++++++++++++++++++
2 files changed, 75 insertions(+)
diff --git a/oslo_messaging/rpc/dispatcher.py b/oslo_messaging/rpc/dispatcher.py
index 313298d3c..fe82f27e9 100644
--- a/oslo_messaging/rpc/dispatcher.py
+++ b/oslo_messaging/rpc/dispatcher.py
@@ -151,6 +151,15 @@ class RPCDispatcher(dispatcher.DispatcherBase):
:param serializer: optional message serializer
"""
+ for ep in endpoints:
+ target = getattr(ep, 'target', None)
+ if target and not isinstance(target, msg_target.Target):
+ errmsg = "'target' is a reserved Endpoint attribute used" + \
+ " for namespace and version filtering. It must" + \
+ " be of type oslo_messaging.Target. Do not" + \
+ " define an Endpoint method named 'target'"
+ raise TypeError("%s: endpoint=%s" % (errmsg, ep))
+
self.endpoints = endpoints
self.serializer = serializer or msg_serializer.NoOpSerializer()
self._default_target = msg_target.Target()
diff --git a/oslo_messaging/tests/functional/test_functional.py b/oslo_messaging/tests/functional/test_functional.py
index 91746291d..185534b6d 100644
--- a/oslo_messaging/tests/functional/test_functional.py
+++ b/oslo_messaging/tests/functional/test_functional.py
@@ -152,6 +152,72 @@ class CallTestCase(utils.SkipIfNoTransportURL):
self.assertEqual(10, server.endpoint.ival)
+ def test_endpoint_version_namespace(self):
+ # verify endpoint version and namespace are checked
+ target = oslo_messaging.Target(topic="topic_" + str(uuid.uuid4()),
+ server="server_" + str(uuid.uuid4()),
+ namespace="Name1",
+ version="7.5")
+
+ class _endpoint(object):
+ def __init__(self, target):
+ self.target = target()
+
+ def test(self, ctxt, echo):
+ return echo
+
+ transport = self.useFixture(
+ utils.TransportFixture(self.conf, self.url)
+ )
+ self.useFixture(
+ utils.RpcServerFixture(self.conf, self.url, target,
+ executor="threading",
+ endpoint=_endpoint(target)))
+ client1 = utils.ClientStub(transport.transport, target,
+ cast=False, timeout=5)
+ self.assertEqual("Hi there", client1.test(echo="Hi there"))
+
+ # unsupported version
+ target2 = target()
+ target2.version = "7.6"
+ client2 = utils.ClientStub(transport.transport,
+ target2,
+ cast=False, timeout=5)
+ self.assertRaises(oslo_messaging.rpc.client.RemoteError,
+ client2.test,
+ echo="Expect failure")
+
+ # no matching namespace
+ target3 = oslo_messaging.Target(topic=target.topic,
+ server=target.server,
+ version=target.version,
+ namespace="Name2")
+ client3 = utils.ClientStub(transport.transport,
+ target3,
+ cast=False, timeout=5)
+ self.assertRaises(oslo_messaging.rpc.client.RemoteError,
+ client3.test,
+ echo="Expect failure")
+
+ def test_bad_endpoint(self):
+ # 'target' attribute is reserved and should be of type Target
+
+ class _endpoint(object):
+ def target(self, ctxt, echo):
+ return echo
+
+ target = oslo_messaging.Target(topic="topic_" + str(uuid.uuid4()),
+ server="server_" + str(uuid.uuid4()))
+ transport = self.useFixture(
+ utils.TransportFixture(self.conf, self.url)
+ )
+ self.assertRaises(TypeError,
+ oslo_messaging.get_rpc_server,
+ transport=transport.transport,
+ target=target,
+ endpoints=[_endpoint()],
+ executor="threading")
+
class CastTestCase(utils.SkipIfNoTransportURL):
# Note: casts return immediately, so these tests utilise a special