c846cf35b8
Nova's cells/rpc_driver.py has some code which allows user of the REST
API to update elements of a cell's transport URL (say, the host name of
the message broker) stored in the database. To achieve this, it has
a parse_transport_url() method which breaks the URL into its constituent
parts and an unparse_transport_url() which re-forms it again after
updating some of its parts.
This is all fine and, since it's fairly specialized, it wouldn't be a
big deal to leave this code in Nova for now ... except the unparse
method looks at CONF.rpc_backend to know what scheme to use in the
returned URL if now backend was specified.
oslo.messaging registers the rpc_backend option, but the ability to
reference any option registered by the library should not be relied upon
by users of the library. Imagine, for instance, if we renamed the option
in future (with backwards compat for old configurations), then this
would mean API breakage.
So, long story short - an API along these lines makes some sense, but
especially since not having it would mean we'd need to add some way to
query the name of the transport driver.
In this commit, we add a simple new TransportURL class:
>>> url = messaging.TransportURL.parse(cfg.CONF, 'foo:///')
>>> str(url), url
('foo:///', <TransportURL transport='foo'>)
>>> url.hosts.append(messaging.TransportHost(hostname='localhost'))
>>> str(url), url
('foo://localhost/', <TransportURL transport='foo', hosts=[<TransportHost hostname='localhost'>]>)
>>> url.transport = None
>>> str(url), url
('kombu://localhost/', <TransportURL transport='kombu', hosts=[<TransportHost hostname='localhost'>]>)
>>> cfg.CONF.set_override('rpc_backend', 'bar')
>>> str(url), url
('bar://localhost/', <TransportURL transport='bar', hosts=[<TransportHost hostname='localhost'>]>)
The TransportURL.parse() method equates to parse_transport_url() and
TransportURL.__str__() equates to unparse_transport().
The transport drivers are also updated to take a TransportURL as a
required argument, which simplifies the handling of transport URLs in
the drivers.
Change-Id: Ic04173476329858e4a2c2d2707e9d4aeb212d127
191 lines
6.8 KiB
Python
191 lines
6.8 KiB
Python
|
|
# Copyright 2013 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.
|
|
|
|
from oslo.config import cfg
|
|
import testscenarios
|
|
|
|
from oslo import messaging
|
|
from oslo.messaging import transport
|
|
from tests import utils as test_utils
|
|
|
|
load_tests = testscenarios.load_tests_apply_scenarios
|
|
|
|
|
|
class TestParseURL(test_utils.BaseTestCase):
|
|
|
|
scenarios = [
|
|
('transport',
|
|
dict(url='foo:',
|
|
expect=dict(transport='foo'))),
|
|
('virtual_host_slash',
|
|
dict(url='foo:////',
|
|
expect=dict(transport='foo', virtual_host='/'))),
|
|
('virtual_host',
|
|
dict(url='foo:///bar',
|
|
expect=dict(transport='foo', virtual_host='bar'))),
|
|
('host',
|
|
dict(url='foo://host/bar',
|
|
expect=dict(transport='foo',
|
|
virtual_host='bar',
|
|
hosts=[
|
|
dict(host='host'),
|
|
]))),
|
|
('port',
|
|
dict(url='foo://host:1234/bar',
|
|
expect=dict(transport='foo',
|
|
virtual_host='bar',
|
|
hosts=[
|
|
dict(host='host', port=1234),
|
|
]))),
|
|
('username',
|
|
dict(url='foo://u@host:1234/bar',
|
|
expect=dict(transport='foo',
|
|
virtual_host='bar',
|
|
hosts=[
|
|
dict(host='host', port=1234, username='u'),
|
|
]))),
|
|
('password',
|
|
dict(url='foo://u:p@host:1234/bar',
|
|
expect=dict(transport='foo',
|
|
virtual_host='bar',
|
|
hosts=[
|
|
dict(host='host', port=1234,
|
|
username='u', password='p'),
|
|
]))),
|
|
('multi_host',
|
|
dict(url='foo://u:p@host1:1234,host2:4321/bar',
|
|
expect=dict(transport='foo',
|
|
virtual_host='bar',
|
|
hosts=[
|
|
dict(host='host1', port=1234,
|
|
username='u', password='p'),
|
|
dict(host='host2', port=4321),
|
|
]))),
|
|
('multi_creds',
|
|
dict(url='foo://u1:p1@host1:1234,u2:p2@host2:4321/bar',
|
|
expect=dict(transport='foo',
|
|
virtual_host='bar',
|
|
hosts=[
|
|
dict(host='host1', port=1234,
|
|
username='u1', password='p1'),
|
|
dict(host='host2', port=4321,
|
|
username='u2', password='p2'),
|
|
]))),
|
|
]
|
|
|
|
def setUp(self):
|
|
super(TestParseURL, self).setUp(conf=cfg.ConfigOpts())
|
|
self.conf.register_opts(transport._transport_opts)
|
|
|
|
def test_parse_url(self):
|
|
self.config(rpc_backend=None)
|
|
|
|
url = messaging.TransportURL.parse(self.conf, self.url)
|
|
|
|
hosts = []
|
|
for host in self.expect.get('hosts', []):
|
|
hosts.append(messaging.TransportHost(host.get('host'),
|
|
host.get('port'),
|
|
host.get('username'),
|
|
host.get('password')))
|
|
expected = messaging.TransportURL(self.conf,
|
|
self.expect.get('transport'),
|
|
self.expect.get('virtual_host'),
|
|
hosts)
|
|
|
|
self.assertEqual(url, expected)
|
|
|
|
|
|
class TestFormatURL(test_utils.BaseTestCase):
|
|
|
|
scenarios = [
|
|
('rpc_backend',
|
|
dict(rpc_backend='testbackend',
|
|
transport=None,
|
|
virtual_host=None,
|
|
hosts=[],
|
|
expected='testbackend:///')),
|
|
('transport',
|
|
dict(rpc_backend=None,
|
|
transport='testtransport',
|
|
virtual_host=None,
|
|
hosts=[],
|
|
expected='testtransport:///')),
|
|
('virtual_host',
|
|
dict(rpc_backend=None,
|
|
transport='testtransport',
|
|
virtual_host='/vhost',
|
|
hosts=[],
|
|
expected='testtransport:////vhost')),
|
|
('host',
|
|
dict(rpc_backend=None,
|
|
transport='testtransport',
|
|
virtual_host='/',
|
|
hosts=[
|
|
dict(hostname='host',
|
|
port=10,
|
|
username='bob',
|
|
password='secret'),
|
|
],
|
|
expected='testtransport://bob:secret@host:10//')),
|
|
('multi_host',
|
|
dict(rpc_backend=None,
|
|
transport='testtransport',
|
|
virtual_host='',
|
|
hosts=[
|
|
dict(hostname='h1',
|
|
port=1000,
|
|
username='b1',
|
|
password='s1'),
|
|
dict(hostname='h2',
|
|
port=2000,
|
|
username='b2',
|
|
password='s2'),
|
|
],
|
|
expected='testtransport://b1:s1@h1:1000,b2:s2@h2:2000/')),
|
|
('quoting',
|
|
dict(rpc_backend=None,
|
|
transport='testtransport',
|
|
virtual_host='/$',
|
|
hosts=[
|
|
dict(hostname='host',
|
|
port=10,
|
|
username='b$',
|
|
password='s&'),
|
|
],
|
|
expected='testtransport://b%24:s%26@host:10//%24')),
|
|
]
|
|
|
|
def setUp(self):
|
|
super(TestFormatURL, self).setUp(conf=cfg.ConfigOpts())
|
|
self.conf.register_opts(transport._transport_opts)
|
|
|
|
def test_parse_url(self):
|
|
self.config(rpc_backend=self.rpc_backend)
|
|
|
|
hosts = []
|
|
for host in self.hosts:
|
|
hosts.append(messaging.TransportHost(host.get('hostname'),
|
|
host.get('port'),
|
|
host.get('username'),
|
|
host.get('password')))
|
|
|
|
url = messaging.TransportURL(self.conf,
|
|
self.transport,
|
|
self.virtual_host,
|
|
hosts)
|
|
|
|
self.assertEqual(str(url), self.expected)
|