Allow hiding of prom config file

voxpupuli · May 21, 2020 · 4d0c546 · 4d0c546
1 parent 612b0db
commit 4d0c546
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 11 deletions.
diff --git a/data/defaults.yaml b/data/defaults.yaml
@@ -67,6 +67,7 @@ prometheus::alertmanager::version: '0.18.0'
 prometheus::alerts: {}
 prometheus::config_dir: '/etc/prometheus'
 prometheus::config_mode: '0640'
+prometheus::config_show_diff: true
 prometheus::config_template: 'prometheus/prometheus.yaml.erb'
 prometheus::consul_exporter::consul_health_summary: true
 prometheus::consul_exporter::consul_server: 'localhost:8500'

diff --git a/manifests/config.pp b/manifests/config.pp
@@ -269,6 +269,7 @@
       group        => $prometheus::server::group,
       mode         => $prometheus::server::config_mode,
       notify       => Class['prometheus::service_reload'],
+      show_diff    => $prometheus::config_show_diff,
       content      => template($prometheus::server::config_template),
       validate_cmd => "${prometheus::server::bin_dir}/promtool ${cfg_verify_cmd} %",
     }

diff --git a/manifests/init.pp b/manifests/init.pp
@@ -209,6 +209,8 @@
 # @param log_format
 #  --log.format=logfmt
 #  Output format of log messages. One of: [logfmt, json]
+# @param config_show_diff
+#  Whether to show prometheus configuration file diff in the Puppet logs.
 class prometheus (
   String $user,
   String $group,
@@ -291,6 +293,7 @@
   Boolean $manage_group                                                         = true,
   Boolean $purge_config_dir                                                     = true,
   Boolean $manage_user                                                          = true,
+  Boolean $config_show_diff                                                     = true,
 ) {
 
   case $arch {

diff --git a/spec/classes/prometheus_spec.rb b/spec/classes/prometheus_spec.rb
@@ -170,12 +170,13 @@
 
           it {
             is_expected.to contain_file('prometheus.yaml').with(
-              'ensure'  => 'file',
-              'path'    => configpath,
-              'owner'   => 'root',
-              'group'   => 'prometheus',
-              'mode'    => '0640',
-              'content' => File.read(fixtures('files', "prometheus#{prom_major}.yaml"))
+              'ensure'    => 'file',
+              'path'      => configpath,
+              'owner'     => 'root',
+              'group'     => 'prometheus',
+              'mode'      => '0640',
+              'show_diff' => true,
+              'content'   => File.read(fixtures('files', "prometheus#{prom_major}.yaml"))
             ).that_notifies('Class[prometheus::service_reload]')
           }
 
@@ -300,11 +301,12 @@
             it { is_expected.to compile.with_all_deps }
             it {
               is_expected.to contain_file('prometheus.yaml').with(
-                'ensure'  => 'file',
-                'path'    => configpath,
-                'owner'   => 'root',
-                'group'   => 'prometheus',
-                'content' => %r{http://domain.tld/path}
+                'ensure'    => 'file',
+                'path'      => configpath,
+                'owner'     => 'root',
+                'group'     => 'prometheus',
+                'show_diff' => true,
+                'content'   => %r{http://domain.tld/path}
               )
             }
           end
@@ -333,6 +335,36 @@
           end
         end
       end
+
+      context 'with config_show_diff set' do
+        [
+          {
+            manage_prometheus_server: true,
+            config_show_diff: true
+          },
+          {
+            manage_prometheus_server: true,
+            config_show_diff: false
+          }
+        ].each do |parameters|
+          context "to #{parameters[:config_show_diff]}" do
+            let(:params) do
+              parameters
+            end
+
+            it { is_expected.to compile.with_all_deps }
+            it {
+              is_expected.to contain_file('prometheus.yaml').with(
+                'ensure'    => 'file',
+                'path'      => configpath,
+                'owner'     => 'root',
+                'group'     => 'prometheus',
+                'show_diff' => parameters[:config_show_diff]
+              )
+            }
+          end
+        end
+      end
       context 'command-line flags' do
         context 'prometheus v2' do
           version = '2.13.0'