Deprecate rabbitmq connection parameters

The rabbitmq connection parameters have been deprecated in favor of the
transport_url setting.

Change-Id: I528e7db15803388f8799b6e188569354cf93fc8a
Related-Bug: #1625198

manifests/init.pp

@@ -64,31 +64,6 @@
 #   (optional) Driver or drivers to handle sending notifications.
 #   Defaults to 'messaging'
 #
-# [*rabbit_host*]
-#   (Optional) IP or hostname of the rabbit server.
-#   Defaults to $::os_service_default.
-#
-# [*rabbit_port*]
-#   (Optional) Port of the rabbit server.
-#   Defaults to $::os_service_default.
-#
-# [*rabbit_hosts*]
-#   (Optional) Array of host:port (used with HA queues).
-#   If defined, will remove rabbit_host & rabbit_port parameters from config
-#   Defaults to $::os_service_default.
-#
-# [*rabbit_userid*]
-#   (Optional) User to connect to the rabbit server.
-#   Defaults to $::os_service_default.
-#
-# [*rabbit_password*]
-#   (Optional) Password to connect to the rabbit_server.
-#   Defaults to $::os_service_default.
-#
-# [*rabbit_virtual_host*]
-#   (Optional) Virtual_host to use.
-#   Defaults to $::os_service_default.
-#
 # [*rabbit_ha_queues*]
 #   (optional) Use HA queues in RabbitMQ (x-ha-policy: all).
 #   Defaults to  $::os_service_default.
@@ -240,6 +215,33 @@
 #   in the manila config.
 #   Defaults to false.
 #
+# === DEPRECATED PARAMETERS
+#
+# [*rabbit_host*]
+#   (Optional) IP or hostname of the rabbit server.
+#   Defaults to $::os_service_default.
+#
+# [*rabbit_port*]
+#   (Optional) Port of the rabbit server.
+#   Defaults to $::os_service_default.
+#
+# [*rabbit_hosts*]
+#   (Optional) Array of host:port (used with HA queues).
+#   If defined, will remove rabbit_host & rabbit_port parameters from config
+#   Defaults to $::os_service_default.
+#
+# [*rabbit_userid*]
+#   (Optional) User to connect to the rabbit server.
+#   Defaults to $::os_service_default.
+#
+# [*rabbit_password*]
+#   (Optional) Password to connect to the rabbit_server.
+#   Defaults to $::os_service_default.
+#
+# [*rabbit_virtual_host*]
+#   (Optional) Virtual_host to use.
+#   Defaults to $::os_service_default.
+#
 class manila (
   $sql_connection              = undef,
   $sql_idle_timeout            = undef,
@@ -253,12 +255,6 @@ class manila (
   $control_exchange            = 'openstack',
   $notification_transport_url  = $::os_service_default,
   $notification_driver         = 'messaging',
-  $rabbit_host                 = $::os_service_default,
-  $rabbit_port                 = $::os_service_default,
-  $rabbit_hosts                = $::os_service_default,
-  $rabbit_virtual_host         = $::os_service_default,
-  $rabbit_userid               = $::os_service_default,
-  $rabbit_password             = $::os_service_default,
   $rabbit_ha_queues            = $::os_service_default,
   $rabbit_use_ssl              = $::os_service_default,
   $kombu_ssl_ca_certs          = $::os_service_default,
@@ -298,6 +294,13 @@ class manila (
   $amqp_username               = $::os_service_default,
   $amqp_password               = $::os_service_default,
   $purge_config                = false,
+  # DEPRECATED PARAMETERS
+  $rabbit_host                 = $::os_service_default,
+  $rabbit_port                 = $::os_service_default,
+  $rabbit_hosts                = $::os_service_default,
+  $rabbit_virtual_host         = $::os_service_default,
+  $rabbit_userid               = $::os_service_default,
+  $rabbit_password             = $::os_service_default,
 ) {
 
   include ::manila::deps
@@ -305,6 +308,17 @@ class manila (
   include ::manila::logging
   include ::manila::params
 
+  if !is_service_default($rabbit_host) or
+    !is_service_default($rabbit_hosts) or
+    !is_service_default($rabbit_password) or
+    !is_service_default($rabbit_port) or
+    !is_service_default($rabbit_userid) or
+    !is_service_default($rabbit_virtual_host) {
+    warning("manila::rabbit_host, manila::rabbit_hosts, manila::rabbit_password, \
+manila::rabbit_port, manila::rabbit_userid and manila::rabbit_virtual_host are \
+deprecated. Please use manila::default_transport_url instead.")
+  }
+
   if $use_ssl {
     if !$cert_file {
       fail('The cert_file parameter is required when use_ssl is set to true')

releasenotes/notes/rabbit-connection-params-deprecation-2a546f72e4fe090d.yaml

@@ -0,0 +1,6 @@
+---
+deprecations:
+  - manila::rabbit_host, manila::rabbit_hosts, manila::rabbit_password,
+    manila::rabbit_port, manila::rabbit_userid and
+    manila::rabbit_virtual_host are deprecated.
+    manila::default_transport_url should be used instead.

spec/acceptance/basic_manila_spec.rb

@@ -29,11 +29,9 @@ describe 'basic manila' do
 
       # Manila resources
       class { '::manila':
-        sql_connection      => 'mysql+pymysql://manila:a_big_secret@127.0.0.1/manila?charset=utf8',
+        default_transport_url => 'rabbit://manila:an_even_bigger_secret@127.0.0.1:5672/',
-        rabbit_userid       => 'manila',
+        sql_connection        => 'mysql+pymysql://manila:a_big_secret@127.0.0.1/manila?charset=utf8',
-        rabbit_password     => 'an_even_bigger_secret',
+        debug                 => true,
-        rabbit_host         => '127.0.0.1',
-        debug               => true,
       }
       class { '::manila::db::mysql':
         password => 'a_big_secret',