(#463) Ensure sensu::plugins are managed before checks

Without this patch plugins may be managed after the checks which use them.  This
patch addresses the problem by adding a well known inert resource named
`Anchor[plugins_before_checks]`.  The sensu::check and sensu_check_config type
are managed after this anchor.  The sensu::plugin defined type is managed
before this anchor.  The anchor approach has been implemented over collections
to avoid realizing resources which the end user may be using.

Resolves #463

lib/puppet/type/sensu_check_config.rb

@@ -11,6 +11,11 @@ def initialize(*args)
         'Service[sensu-enterprise]',
         'Service[sensu-api]',
       ].select { |ref| c.resource(ref) }
+      # (#463) All plugins must come before all checks.  Collections are not used to
+      # avoid realizing any resources.
+      self[:subscribe] = [
+        'Anchor[plugins_before_checks]',
+      ].select { |ref| c.resource(ref) }
     end
   end
 

manifests/check.pp

@@ -155,7 +155,6 @@
   $subdue              = undef,
   $proxy_requests      = undef,
 ) {
-
   validate_re($ensure, ['^present$', '^absent$'] )
 
   if $ensure == 'present' and !$command {
@@ -251,6 +250,11 @@
     }
   }
 
+  # (#463) All plugins must come before all checks.  Collections are not used to
+  # avoid realizing any resources.
+  Anchor['plugins_before_checks']
+  ~> Sensu::Check[$name]
+
   file { "${conf_dir}/checks/${check_name}.json":
     ensure => $ensure,
     owner  => $user,

manifests/init.pp

@@ -563,9 +563,7 @@
   $filter_defaults             = {},
   $mutators                    = {},
   ### END Hiera Lookups ###
-
 ){
-
   validate_absolute_path($log_dir)
   if $path != '$PATH' {
     validate_absolute_path($path)
@@ -666,6 +664,10 @@
     $_purge_mutators   = $full_purge_hash['mutators']
   }
 
+  # (#463) This well-known anchor serves as a reference point so all checks are
+  # managed after all plugins.  It must always exist in the catalog.
+  anchor { 'plugins_before_checks': }
+
   # Create resources from hiera lookups
   create_resources('::sensu::extension', $extensions)
   create_resources('::sensu::handler', $handlers, $handler_defaults)

manifests/plugin.pp

@@ -63,14 +63,18 @@
   $nocheckcertificate  = false,
   $gem_install_options = $::sensu::gem_install_options,
 ) {
-
   File {
     owner => 'sensu',
     group => 'sensu',
   }
 
   Sensu::Plugin[$name]
-  -> Class['sensu::client::service']
+  ~> Service['sensu-client']
+
+  # (#463) All plugins must come before all checks.  Collections are not used to
+  # avoid realizing any resources.
+  Sensu::Plugin[$name]
+  -> Anchor['plugins_before_checks']
 
   validate_bool($purge, $recurse, $force, $nocheckcertificate)
   validate_re($pkg_version, ['^absent$', '^installed$', '^latest$', '^present$', '^[\d\.\-]+$'], "Invalid package version: ${pkg_version}")

spec/classes/sensu_init_spec.rb

@@ -13,6 +13,7 @@
   it { should contain_file('/etc/default/sensu').without_content(%r{^CLIENT_DEREGISTER_ON_STOP=true\nCLIENT_DEREGISTER_HANDLER=.*$}) }
   it { should contain_file('/etc/default/sensu').with_content(%r{^SERVICE_MAX_WAIT="10"$}) }
   it { should contain_file('/etc/default/sensu').with_content(%r{^PATH=\$PATH$}) }
+  it { should contain_anchor('plugins_before_checks') }
   it { should_not contain_file('C:/opt/sensu/bin/sensu-client.xml') }
 
   describe 'osfamily windows' do
@@ -409,5 +410,4 @@
       end # var[:name].each
     end # validations.sort.each
   end # describe 'variable type and content validations'
-
 end

spec/defines/sensu_check_spec.rb

@@ -299,4 +299,9 @@
       it { is_expected.to contain_sensu_check('mycheck').with(interval: 'absent') }
     end
   end
+
+  describe 'relationships (#463)' do
+    let(:expected) { { notify: ["Sensu::Check[#{title}]"] } }
+    it { is_expected.to contain_anchor('plugins_before_checks').with(expected)}
+  end
 end

spec/defines/sensu_plugin_spec.rb

@@ -13,7 +13,6 @@ class { '::sensu':
     let(:title) { 'puppet:///data/plug1' }
 
     context 'defaults' do
-
       it { should contain_file('/etc/sensu/plugins/plug1').with(
         :source => 'puppet:///data/plug1'
       ) }
@@ -28,7 +27,7 @@ class { '::sensu':
         :source => 'puppet:///data/plug1'
       ) }
     end
-  end #file
+  end
 
   context 'url' do
     let(:title) { 'https://raw.githubusercontent.com/sensu/sensu-community-plugins/master/plugins/system/check-mem.sh' }
@@ -44,7 +43,6 @@ class { '::sensu':
         :path     => '/etc/sensu/plugins/check-mem.sh',
         :checksum => '1d58b78e9785f893889458f8e9fe8627'
       ) }
-
     end
 
     context 'setting params' do
@@ -59,7 +57,6 @@ class { '::sensu':
         :path     => '/var/sensu/plugins/check-mem.sh',
         :checksum => '1d58b78e9785f893889458f8e9fe8627'
       ) }
-
     end
 
     context 'new plugin should provide source' do
@@ -74,10 +71,8 @@ class { '::sensu':
         :path     => '/var/sensu/plugins/check-puppet-last-run.rb',
         :source   => 'https://raw.githubusercontent.com/sensu-plugins/sensu-plugins-puppet/master/bin/check-puppet-last-run.rb'
       ) }
-
     end
-
-  end #url
+  end
 
   context 'directory' do
     let(:title) { 'puppet:///data/sensu/plugins' }
@@ -115,7 +110,7 @@ class { '::sensu':
         'group'   => 'sensu'
       ) }
     end
-  end #directory
+  end
 
   context 'package' do
     let(:title) { 'sensu-plugins' }
@@ -162,12 +157,34 @@ class { '::sensu':
       let(:params) { { :type => 'package', :gem_install_options => [{ '-p' => 'http://user:[email protected]:8080' }], :pkg_provider => 'gem' } }
       it { should contain_package('sensu-plugins').with_install_options([{ '-p' => 'http://user:[email protected]:8080' }]) }
     end
-
-  end #package
+  end
 
   context 'default' do
     let(:params) { { :type => 'unknown' } }
     it { expect { should raise_error(Puppet::Error) } }
-  end #default
+  end
 
+  describe 'ordering (#463)' do
+  let(:pre_condition) do
+    <<-'ENDofPUPPETcode'
+    class { '::sensu':
+      manage_plugins_dir => false,
+    }
+    sensu::check { 'ntp':
+      command     => 'check_ntp_time -H pool.ntp.org -w 30 -c 60',
+      handlers    => 'default',
+      subscribers => 'sensu-test',
+    }
+    ENDofPUPPETcode
+  end
+    let(:title) { 'puppet:///data/plug1' }
+    describe 'notifies the sensu-client service' do
+      let(:expected) { { notify: ['Service[sensu-client]'] } }
+      it { is_expected.to contain_sensu__plugin(title).with(expected)}
+    end
+    describe 'comes before sensu checks via Anchor[plugins_before_checks]' do
+      let(:expected) { { before: ['Anchor[plugins_before_checks]'] } }
+      it { is_expected.to contain_sensu__plugin(title).with(expected)}
+    end
+  end
 end

spec/spec_helper.rb

@@ -27,4 +27,9 @@
     :kernel      => 'Linux',
     :osfamily    => 'RedHat',
   }
+  config.backtrace_exclusion_patterns = [
+    %r{/\.bundle/},
+    %r{/\.rbenv/},
+    %r{/.rvm/},
+  ]
 end

spec/unit/sensu_check_config_spec.rb

@@ -40,4 +40,24 @@
       end
     end
   end
+
+  describe 'relationships' do
+    let(:resource_hash) do
+      c = Puppet::Resource::Catalog.new
+      r = Puppet::Type.type(:anchor).new(name: 'plugins_before_checks')
+      c.add_resource(r)
+      {
+        :title => 'foo.example.com',
+        :catalog => c
+      }
+    end
+    let(:resource) do
+    end
+    context 'plugins before checks (#463)' do
+      subject { described_class.new(resource_hash)[:subscribe].map(&:ref) }
+      it 'subscribes to Anchor[plugins_before_checks]' do
+        is_expected.to eq ['Anchor[plugins_before_checks]']
+      end
+    end
+  end
 end