add feature #12771 add parameter ensure to objects

Author: Lennart Betz

manifests/object.pp

@@ -4,6 +4,9 @@
 #
 # === Parameters
 #
+# [*ensure*]
+#   Set to present enables the object, absent disabled it. Defaults to present.
+#
 # [*object_name*]
 #   Set the icinga2 name of the object. Defaults to title of the define resource.
 #
@@ -32,6 +35,7 @@
 # Icinga Development Team <[email protected]>
 #
 define icinga2::object(
+  $ensure      = present,
   $object_name = $title,
   $template    = false,
   $import      = [],
@@ -47,9 +51,11 @@
 
   include ::icinga2::params
 
-  $user     = $::icinga2::params::user
-  $group    = $::icinga2::params::group
+  $user  = $::icinga2::params::user
+  $group = $::icinga2::params::group
 
+  validate_re($ensure, [ '^present$', '^absent$' ],
+    "${ensure} isn't supported. Valid values are 'present' and 'absent'.")
   validate_string($object_name)
   validate_bool($template)
   validate_array($import)
@@ -63,11 +69,15 @@
     owner  => $user,
     group  => $group,
     tag    => 'icinga2::config::file',
+    warn   => true,
   })
 
-  concat::fragment { "icinga2::object::${object_type}::${object_name}":
-    target  => $target,
-    content => template('icinga2/object.conf.erb'),
-    order   => $order,
+  if $ensure != 'absent' {
+    concat::fragment { "icinga2::object::${object_type}::${object_name}":
+      target  => $target,
+      content => template('icinga2/object.conf.erb'),
+      order   => $order,
+    }
   }
+
 }

spec/defines/object_spec.rb

@@ -23,6 +23,22 @@
     end
 
 
+    context "#{os} with ensure => absent" do
+      let(:params) { {:ensure => 'absent', :object_type => 'foo', :target => '/bar/baz', :order => '10'} }
+
+      it { is_expected.to contain_concat('/bar/baz') }
+
+      it { is_expected.not_to contain_concat__fragment('icinga2::object::foo::bar') }
+    end
+
+
+    context "#{os} with ensure => foo (not a valid value)" do
+      let(:params) { {:ensure => 'foo', :object_type => 'foo', :target => '/bar/baz', :order => '10'} }
+
+      it { is_expected.to raise_error(Puppet::Error, /foo isn't supported/) }
+    end
+
+
     context "#{os} with object_type => 4247 (not valid string)" do
       let(:params) { {:object_type => 4247, :target => '/bar/baz', :order => '10'} }
 
@@ -102,6 +118,36 @@
   end
 
 
+  context "Windows 2012 R2 with ensure => absent" do
+    let(:facts) { {
+      :kernel => 'Windows',
+      :architecture => 'x86_64',
+      :osfamily => 'Windows',
+      :operatingsystem => 'Windows',
+      :operatingsystemmajrelease => '2012 R2'
+    } }
+    let(:params) { {:ensure => 'absent', :object_type => 'foo', :target => 'C:/bar/baz', :order => '10'} }
+
+    it { is_expected.to contain_concat('C:/bar/baz') }
+
+    it { is_expected.not_to contain_concat__fragment('icinga2::object::foo::bar') }
+  end
+
+
+  context "Windows 2012 R2 with ensure => foo (not a valid value)" do
+    let(:facts) { {
+      :kernel => 'Windows',
+      :architecture => 'x86_64',
+      :osfamily => 'Windows',
+      :operatingsystem => 'Windows',
+      :operatingsystemmajrelease => '2012 R2'
+    } }
+    let(:params) { {:ensure => 'foo', :object_type => 'foo', :target => 'C:/bar/baz', :order => '10'} }
+
+    it { is_expected.to raise_error(Puppet::Error, /foo isn't supported/) }
+  end
+
+
   context "Windows 2012 R2 with object_type => 4247 (not valid string)" do
     let(:facts) { {
       :kernel => 'Windows',

templates/object.conf.erb

@@ -1,3 +1,4 @@
+
 <% if @template %>template<% else %>object<% end %> <%= @object_type -%>
 <% if scope.lookupvar('icinga2::_constants').include?(@object_name) -%>
  <%= @object_name -%>
@@ -9,4 +10,3 @@
 <% unless @import.empty? %><%= "\n" %><% end -%>
 <%= scope.function_icinga2_attributes([@attrs]) -%>
 }
-