Skip to content

Commit

Permalink
Adding amqps as a valid broker scheme
Browse files Browse the repository at this point in the history
Issue here: mher#1369

Flower does not take into account the `BROKER_API` config setting right
now if the scheme is set to `amqps`. It errors.

This seems like it should not be the case, as there is no change
required for the RabbitMQ API to work, regardless of amqp or amqps.
  • Loading branch information
the-witch-king committed Apr 26, 2024
1 parent 58136bf commit 0df45d6
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 11 deletions.
2 changes: 1 addition & 1 deletion flower/api/tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ async def get(self):
app = self.application

http_api = None
if app.transport == 'amqp' and app.options.broker_api:
if (app.transport == 'amqp' or app.transport == 'amqps') and app.options.broker_api:
http_api = app.options.broker_api

broker = Broker(app.capp.connection().as_uri(include_password=True),
Expand Down
2 changes: 2 additions & 0 deletions flower/utils/broker.py
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,8 @@ def __new__(cls, broker_url, *args, **kwargs):
scheme = urlparse(broker_url).scheme
if scheme == 'amqp':
return RabbitMQ(broker_url, *args, **kwargs)
if scheme == 'amqps':
return RabbitMQ(broker_url, *args, **kwargs)
if scheme == 'redis':
return Redis(broker_url, *args, **kwargs)
if scheme == 'rediss':
Expand Down
2 changes: 1 addition & 1 deletion flower/views/broker.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ async def get(self):
app = self.application

http_api = None
if app.transport == 'amqp' and app.options.broker_api:
if (app.transport == 'amqp' or app.transport == 'amqps') and app.options.broker_api:
http_api = app.options.broker_api

try:
Expand Down
46 changes: 37 additions & 9 deletions tests/unit/utils/test_broker.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
broker.redis = MagicMock()


class TestRabbitMQ(unittest.TestCase):
class TestRabbitMQwithAMQP(unittest.TestCase):
def test_init(self):
b = Broker('amqp://', '')
self.assertTrue(isinstance(b, RabbitMQ))
Expand Down Expand Up @@ -40,18 +40,46 @@ def test_url_defaults_rabbitmq(self):
self.assertEqual('guest', b.username)
self.assertEqual('guest', b.password)

def test_url_defaults_redis(self):
for url in ['redis://', 'redis://localhost', 'redis://localhost/0']:
b = Redis(url, '')
def test_invalid_http_api(self):
with self.assertLogs('', level='ERROR') as cm:
RabbitMQ('amqp://user:pass@host:10000/vhost', http_api='ftp://')
self.assertEqual(['ERROR:flower.utils.broker:Invalid broker api url: ftp://'], cm.output)


class TestRabbitMQwithAMQPS(unittest.TestCase):
def test_init(self):
b = Broker('amqps://', '')
self.assertTrue(isinstance(b, RabbitMQ))
self.assertFalse(isinstance(b, Redis))

def test_url(self):
b = RabbitMQ('amqps://user:pass@host:10000/vhost', '')
self.assertEqual('host', b.host)
self.assertEqual(10000, b.port)
self.assertEqual('vhost', b.vhost)
self.assertEqual('user', b.username)
self.assertEqual('pass', b.password)

def test_url_vhost_slash(self):
b = RabbitMQ('amqps://user:pass@host:10000//', '')
self.assertEqual('host', b.host)
self.assertEqual(10000, b.port)
self.assertEqual('/', b.vhost)
self.assertEqual('user', b.username)
self.assertEqual('pass', b.password)

def test_url_defaults_rabbitmq(self):
for url in ['amqps://', 'amqp://localhost']:
b = RabbitMQ(url, '')
self.assertEqual('localhost', b.host)
self.assertEqual(6379, b.port)
self.assertEqual(0, b.vhost)
self.assertEqual(None, b.username)
self.assertEqual(None, b.password)
self.assertEqual(15672, b.port)
self.assertEqual('/', b.vhost)
self.assertEqual('guest', b.username)
self.assertEqual('guest', b.password)

def test_invalid_http_api(self):
with self.assertLogs('', level='ERROR') as cm:
RabbitMQ('amqp://user:pass@host:10000/vhost', http_api='ftp://')
RabbitMQ('amqps://user:pass@host:10000/vhost', http_api='ftp://')
self.assertEqual(['ERROR:flower.utils.broker:Invalid broker api url: ftp://'], cm.output)


Expand Down

0 comments on commit 0df45d6

Please sign in to comment.