Feature/koning/vhost no leading slash

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to Merlin will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+- The broker name can now be amqps (with ssl) or amqp (without ssl). 
+
+### Changed
+- The default rabbitmq vhost is now <user> instead of /<user>.
+
 ## [1.5.3]
 
 ### Fixed

docs/source/merlin_config.rst

@@ -30,16 +30,20 @@ app.yaml file, then the user's ``~/.merlin`` directory is checked.
 using a socket. 
 
 
-Broker: ``rabbitmq``
---------------------
+Broker: ``rabbitmq``, ``amqps``, ``amqp``
+-----------------------------------------
 Merlin constructs the following connection string from the relevant options in the 
 ``broker`` section of the app.yaml file. If the ``port`` argument is not defined,
 the default rabbitmq TLS port, 5671,  will be used. See the :ref:`broker_rabbitmq_ssl`
-section for more info about security with this broker.
+section for more info about security with this broker. When the ``broker``
+is ``amqp``, the default port will be 5672.
 
 
 | The prototype url for this configuration is:
-| ``amqps://{username}:{password}@{server}:{port}//{vhost}``
+| ``{conn}://{username}:{password}@{server}:{port}/{vhost}``
+
+Here ``conn`` is ``amqps`` (with ssl) when ``name`` is ``rabbitmq`` or ``amqps`` and
+``amqp`` (without ssl) when name is ``amqp``.
 
 ::
 

merlin/config/broker.py

@@ -50,9 +50,9 @@
 
 LOG = logging.getLogger(__name__)
 
-BROKERS = ["rabbitmq", "redis", "rediss", "redis+socket"]
+BROKERS = ["rabbitmq", "redis", "rediss", "redis+socket", "amqps", "amqp"]
 
-RABBITMQ_CONNECTION = "amqps://{username}:{password}@{server}:{port}//{vhost}"
+RABBITMQ_CONNECTION = "{conn}://{username}:{password}@{server}:{port}/{vhost}"
 REDISSOCK_CONNECTION = "redis+socket://{path}?virtual_host={db_num}"
 USER = getpass.getuser()
 
@@ -64,14 +64,16 @@ def read_file(filepath):
         return quote(line, safe="")
 
 
-def get_rabbit_connection(config_path, include_password):
+def get_rabbit_connection(config_path, include_password, conn="amqps"):
     """
     Given the path to the directory where the broker configurations are stored
     setup and return the RabbitMQ connection string.
 
     :param config_path : The path for ssl certificates and passwords
     :param include_password : Format the connection for ouput by setting this True
     """
+    LOG.debug(f"Broker: connection = {conn}")
+
     vhost = CONFIG.broker.vhost
     LOG.debug(f"Broker: vhost = {vhost}")
 
@@ -99,11 +101,15 @@ def get_rabbit_connection(config_path, include_password):
         port = CONFIG.broker.port
         LOG.debug(f"Broker: RabbitMQ port = {port}")
     except (AttributeError, KeyError):
-        port = 5671
+        if conn == "amqp":
+            port = 5672
+        else:
+            port = 5671
         LOG.debug(f"Broker: RabbitMQ using default port = {port}")
 
     # Test configurations.
     rabbitmq_config = {
+        "conn": conn,
         "vhost": vhost,
         "username": username,
         "password": "******",
@@ -213,16 +219,19 @@ def get_connection_string(include_password=True):
     if broker not in BROKERS:
         raise ValueError(f"Error: {broker} is not a supported broker.")
 
-    if broker == "rabbitmq":
+    if broker == "rabbitmq" or broker == "amqps":
         return get_rabbit_connection(config_path, include_password)
 
-    if broker == "redis+socket":
+    elif broker == "amqp":
+        return get_rabbit_connection(config_path, include_password, conn="amqp")
+
+    elif broker == "redis+socket":
         return get_redissock_connection(config_path, include_password)
 
-    if broker == "redis":
+    elif broker == "redis":
         return get_redis_connection(config_path, include_password)
 
-    if broker == "rediss":
+    elif broker == "rediss":
         return get_redis_connection(config_path, include_password, ssl=True)
 
     return None
@@ -257,7 +266,7 @@ def get_ssl_config():
     if not broker_ssl:
         broker_ssl = True
 
-    if broker == "rabbitmq" or broker == "rediss":
+    if broker == "rabbitmq" or broker == "rediss" or broker == "amqps":
         return broker_ssl
 
     return False