Support enabling rabbitmq_management without rabbitmqadmin

Enabling the rabbitmq_managemnt interface and installing the rabbitmqadmin client was both controlled by the admin_enable parameter. Adds option enable_management (default: false). When this is set to true, and admin_enable is false the rabbitmq_management plugin is enabled, but the rabbitmqadmin client is not installed. For backward compatiblity the rabbitmq_management plugin is also enabled when admin_enable is set to true. Related voxpupuli#775
hjensas · Feb 13, 2019 · d062abe · d062abe
1 parent 5283ed8
commit d062abe
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 5 deletions.
diff --git a/manifests/config.pp b/manifests/config.pp
@@ -5,6 +5,7 @@
 class rabbitmq::config {
 
   $admin_enable                        = $rabbitmq::admin_enable
+  $management_enable                   = $rabbitmq::management_enable
   $cluster_node_type                   = $rabbitmq::cluster_node_type
   $cluster_nodes                       = $rabbitmq::cluster_nodes
   $config                              = $rabbitmq::config

diff --git a/manifests/init.pp b/manifests/init.pp
@@ -81,6 +81,10 @@
 #
 # @param admin_enable
 #   If enabled sets up the management interface/plugin for RabbitMQ.
+#   This also install the rabbitmqadmin command line tool.
+# @param management_enable
+#   If enabled sets up the management interface/plugin for RabbitMQ.
+#   NOTE: This does not install the rabbitmqadmin command line tool.
 # @param auth_backends
 #   An array specifying authorization/authentication backend to use. Single quotes should be placed around array entries,
 #   ex. `['{foo, baz}', 'baz']` Defaults to [rabbit_auth_backend_internal], and if using LDAP defaults to [rabbit_auth_backend_internal,
@@ -280,6 +284,7 @@
 #
 class rabbitmq(
   Boolean $admin_enable                                                                            = $rabbitmq::params::admin_enable,
+  Boolean $management_enable                                                                       = $rabbitmq::params::management_enable,
   Enum['ram', 'disk', 'disc'] $cluster_node_type                                                   = $rabbitmq::params::cluster_node_type,
   Array $cluster_nodes                                                                             = $rabbitmq::params::cluster_nodes,
   String $config                                                                                   = $rabbitmq::params::config,
@@ -408,14 +413,16 @@
   contain rabbitmq::service
   contain rabbitmq::management
 
-  if $admin_enable and $service_manage {
-    include 'rabbitmq::install::rabbitmqadmin'
-
+  if ($management_enable or $admin_enable) and $service_manage {
     rabbitmq_plugin { 'rabbitmq_management':
       ensure   => present,
       notify   => Class['rabbitmq::service'],
       provider => 'rabbitmqplugins',
     }
+  }
+
+  if $admin_enable and $service_manage {
+    include 'rabbitmq::install::rabbitmqadmin'
 
     Class['rabbitmq::service'] -> Class['rabbitmq::install::rabbitmqadmin']
     Class['rabbitmq::install::rabbitmqadmin'] -> Rabbitmq_exchange<| |>

diff --git a/manifests/params.pp b/manifests/params.pp
@@ -83,6 +83,7 @@
 
   #install
   $admin_enable                        = true
+  $management_enable                   = false
   $management_port                     = 15672
   $management_ssl                      = true
   $repos_ensure                        = false

diff --git a/spec/classes/rabbitmq_spec.rb b/spec/classes/rabbitmq_spec.rb
@@ -615,6 +615,50 @@
         end
       end
 
+      describe 'configure management plugin' do
+        let :params do
+          {
+            admin_enable: true,
+            management_enable: false
+          }
+        end
+
+        it { is_expected.to contain_rabbitmq_plugin('rabbitmq_management') }
+        it 'sets rabbitmq_managment opts to specified values' do
+          is_expected.to contain_file('rabbitmq.config').with_content(%r{rabbitmq_management, \[})
+          is_expected.to contain_file('rabbitmq.config').with_content(%r{listener, \[})
+          is_expected.to contain_file('rabbitmq.config').with_content(%r{port, 15672\}})
+        end
+
+        describe 'with admin_enable false' do
+          let :params do
+            {
+              admin_enable: false,
+              management_enable: false
+            }
+          end
+
+          it { is_expected.not_to contain_rabbitmq_plugin('rabbitmq_management') }
+        end
+
+        describe 'with admin_enable false and management_enable true' do
+          let :params do
+            {
+              admin_enable: false,
+              management_enable: true
+            }
+          end
+
+          it { is_expected.to contain_rabbitmq_plugin('rabbitmq_management') }
+          it 'sets rabbitmq_managment opts to specified values' do
+            is_expected.to contain_file('rabbitmq.config').with_content(%r{rabbitmq_management, \[})
+            is_expected.to contain_file('rabbitmq.config').with_content(%r{listener, \[})
+            is_expected.to contain_file('rabbitmq.config').with_content(%r{port, 15672\}})
+          end
+        end
+      end
+
+
       describe 'configuring shovel plugin' do
         let :params do
           {

diff --git a/templates/rabbitmq.config.erb b/templates/rabbitmq.config.erb
@@ -96,12 +96,12 @@
     <%= @config_kernel_variables.sort.map{|k,v| "{#{k}, #{v}}"}.join(",\n    ") %>
   ]}
 <%- end -%>
-<%- if @admin_enable or !@config_management_variables.empty? -%>,
+<%- if @admin_enable or @management_enable or !@config_management_variables.empty? -%>,
   {rabbitmq_management, [
     <%- if !@config_management_variables.empty? -%>
     <%= @config_management_variables.sort.map{|k,v| "{#{k}, #{v}}"}.join(",\n    ") %>
     <%- end -%>
-<%- if @admin_enable -%>
+<%- if @admin_enable or @management_enable -%>
 <%- if  !@config_management_variables.empty? -%>,<%-end-%>
     {listener, [
 <%- if @ssl && @management_ssl -%>