add parameter ensure to objects endpoint and zone

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,
+    }
   }
+
 }

manifests/object/endpoint.pp

@@ -1,4 +1,40 @@
+# == Define: icinga2::object::endpoint
+#
+# Manage Icinga2 endpoint objects.
+#
+# === Parameters
+#
+# [*ensure*]
+#   Set to present enables the endpoint object, absent disabled it. Defaults to present.
+#
+# [*endpoint*]
+#   Set the Icinga2 name of the endpoint object. Defaults to title of the define resource.
+#
+# [*host*]
+#   Optional. The IP address of the remote Icinga 2 instance.
+#
+# [*port*]
+#   The service name/port of the remote Icinga 2 instance. Defaults to 5665.
+#
+# [*log_duration*]
+#   Duration for keeping replay logs on connection loss. Defaults to 1d (86400 seconds).
+#   Attribute is specified in seconds. If log_duration is set to 0, replaying logs is disabled.
+#   You could also specify the value in human readable format like 10m for 10 minutes
+#   or 1h for one hour.
+#
+# [*target*]
+#   Destination config file to store in this object. File will be declared the
+#   first time.
+#
+# [*order*]
+#   String to set the position in the target file, sorted alpha numeric. Defaults to 10.
+#
+# === Authors
+#
+# Icinga Development Team <[email protected]>
+#
 define icinga2::object::endpoint(
+  $ensure       = present,
   $endpoint     = $title,
   $host         = undef,
   $port         = undef,
@@ -12,6 +48,10 @@
   $conf_dir = $::icinga2::params::conf_dir
 
   # validation
+  validate_re($ensure, [ '^present$', '^absent$' ],
+    "${ensure} isn't supported. Valid values are 'present' and 'absent'.")
+  validate_integer($order)
+
   if $endpoint { validate_string($endpoint) }
   if $host { validate_ip_address($host) }
   if $port { validate_integer($port) }
@@ -23,8 +63,6 @@
   else {
     $_target = "${conf_dir}/zones.conf" }
 
-  validate_integer($order)
-
   # compose the attributes
   $attrs = {
     host         => $host,
@@ -34,6 +72,7 @@
 
   # create object
   icinga2::object { "icinga2::object::Endpoint::${title}":
+    ensure      => $ensure,
     object_name => $endpoint,
     object_type => 'Endpoint',
     attrs       => $attrs,

manifests/object/zone.pp

@@ -4,6 +4,9 @@
 #
 # === Parameters
 #
+# [*ensure*]
+#   Set to present enables the endpoint object, absent disabled it. Defaults to present.
+#
 # [*zone*]
 #   Set the Icinga2 name of the zone object. Defaults to title of the define resource.
 #
@@ -29,6 +32,7 @@
 # Icinga Development Team <[email protected]>
 #
 define icinga2::object::zone(
+  $ensure    = present,
   $zone      = $title,
   $endpoints = [],
   $parent    = undef,
@@ -42,6 +46,8 @@
   $conf_dir = $::icinga2::params::conf_dir
 
   # validation
+  validate_re($ensure, [ '^present$', '^absent$' ],
+    "${ensure} isn't supported. Valid values are 'present' and 'absent'.")
   validate_string($zone)
   validate_integer($order)
 
@@ -56,6 +62,8 @@
   else {
     $_target = "${conf_dir}/zones.conf" }
 
+  validate_string($order)
+
   # compose the attributes
   if $global {
     $attrs = {
@@ -70,6 +78,7 @@
 
   # create object
   icinga2::object { "icinga2::object::Zone::${title}":
+    ensure      => $ensure,
     object_name => $zone,
     object_type => 'Zone',
     attrs       => $attrs,

spec/defines/endpoint_spec.rb

@@ -23,6 +23,22 @@
     end
 
 
+    context "#{os} with ensure => absent" do
+      let(:params) { {:ensure => 'absent', :target => '/bar/baz'} }
+
+      it { is_expected.to contain_concat('/bar/baz') }
+
+      it { is_expected.not_to contain_concat__fragment('icinga2::object::Endpoint::bar') }
+    end
+
+
+    context "#{os} with ensure => foo (not a valid value)" do
+      let(:params) { {:ensure => 'foo', :target => '/bar/baz'} }
+
+      it { is_expected.to raise_error(Puppet::Error, /foo isn't supported/) }
+    end
+
+
     context "#{os} with target => bar/baz (not valid absolute path)" do
       let(:params) { {:target => 'bar/baz'} }
 
@@ -101,6 +117,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', :target => 'C:/bar/baz'} }
+
+    it { is_expected.to contain_concat('C:/bar/baz') }
+
+    it { is_expected.not_to contain_concat__fragment('icinga2::object::Endpoint::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', :target => 'C:/bar/baz'} }
+
+    it { is_expected.to raise_error(Puppet::Error, /foo isn't supported/) }
+  end
+
+
   context "Windows 2012 R2  with target => bar/baz (not valid absolute path)" do
     let(:facts) { {
       :kernel => 'Windows',

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',

spec/defines/zone_spec.rb

@@ -23,6 +23,22 @@
     end
 
 
+   context "#{os} with ensure => absent" do
+      let(:params) { {:ensure => 'absent', :target => '/bar/baz'} }
+
+      it { is_expected.to contain_concat('/bar/baz') }
+
+      it { is_expected.not_to contain_concat__fragment('icinga2::object::Zone::bar') }
+    end
+
+
+    context "#{os} with ensure => foo (not a valid value)" do
+      let(:params) { {:ensure => 'foo', :target => '/bar/baz'} }
+
+      it { is_expected.to raise_error(Puppet::Error, /foo isn't supported/) }
+    end
+
+
     context "#{os} with target => bar/baz (not valid absolute path)" do
       let(:params) { {:target => 'bar/baz'} }
 
@@ -101,6 +117,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', :target => 'C:/bar/baz'} }
+
+    it { is_expected.to contain_concat('C:/bar/baz') }
+
+    it { is_expected.not_to contain_concat__fragment('icinga2::object::Zone::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', :target => 'C:/bar/baz'} }
+
+    it { is_expected.to raise_error(Puppet::Error, /foo isn't supported/) }
+  end
+
+
   context "Windows 2012 R2 with target => bar/baz (not valid absolute path)" 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]) -%>
 }
-