Merge pull request #297 from jonathanio/extension-type

Added support for loading and configuring extensions.

README.md

@@ -13,7 +13,7 @@ Installs and manages the open source monitoring framework [Sensu](http://sensuap
 
 ## Sensu version supported
 
-The module currently supports Sensu version 0.12 and later. If not explictly stated it should always 
+The module currently supports Sensu version 0.12 and later. If not explictly stated it should always
 support the latest Sensu release. Please log an issue if you identify any incompatibilties.
 
 ## Upgrade note
@@ -54,7 +54,7 @@ Debian & Ubuntu:
 
 ## Quick start
 
-Before this puppet module can be used, the following items must be configured on the server. 
+Before this puppet module can be used, the following items must be configured on the server.
 
 - Install redis
 - Install rabbitmq
@@ -66,7 +66,7 @@ To quickly try out sensu, spin up a test VM with Vagrant that already has these
     vagrant up
     vagrant status
     vagrant ssh sensu-server
-    
+
 You can then access the api
 
     curl http://admin:secret@localhost:4567/info
@@ -76,12 +76,12 @@ Navigate to `192.168.56.10:3000` to use the uchiwa dashboard
 
     username => uchiwa
     password => uchiwa
-    
+
 Navigate to `192.168.56.10:15672` to manage rabbitmq
 
     username => sensu
     password => correct-horse-battery-staple
-    
+
 See the [tests directory](https://github.com/sensu/sensu-puppet/tree/vagrant/tests) and [Vagrantfile](https://github.com/sensu/sensu-puppet/blob/vagrant/Vagrantfile) for examples on setting up the prerequisites.
 
 
@@ -290,6 +290,25 @@ This will create the following handler definition for Sensu (server):
        }
      }
 
+## Extension configuration
+
+    sensu::extension {
+      'an_extension':
+        source  => 'puppet://somewhere/an_extension.rb',
+        config  => {
+          'foobar_setting' => 'value',
+      }
+    }
+
+This will save the extension under /etc/sensu/extensions and create
+the following configuration definition for Sensu:
+
+     {
+       "an_extension": {
+         "foobar_setting": "value"
+       },
+     }
+
 ### Disable Service Management
 
 If you'd prefer to use an external service management tool such as

lib/puppet/provider/sensu_extension/json.rb

@@ -0,0 +1,45 @@
+require 'rubygems' if RUBY_VERSION < '1.9.0' && Puppet.version < '3'
+require 'json' if Puppet.features.json?
+
+Puppet::Type.type(:sensu_extension).provide(:json) do
+  confine :feature => :json
+
+  def conf
+    begin
+      @conf ||= JSON.parse(File.read(config_file))
+    rescue
+      @conf ||= {}
+    end
+  end
+
+  def flush
+    File.open(config_file, 'w') do |f|
+      f.puts JSON.pretty_generate(conf)
+    end
+  end
+
+  def create
+    conf[resource[:name]] = {}
+    self.config = resource[:config]
+  end
+
+  def config_file
+    "#{resource[:base_path]}/#{resource[:name]}.json"
+  end
+
+  def destroy
+    conf.delete resource[:name]
+  end
+
+  def exists?
+    conf.has_key? resource[:name]
+  end
+
+  def config
+    conf[resource[:name]]
+  end
+
+  def config=(value)
+    conf[resource[:name]] = value
+  end
+end

lib/puppet/type/sensu_extension.rb

@@ -0,0 +1,42 @@
+Puppet::Type.newtype(:sensu_extension) do
+  @doc = ""
+
+  def initialize(*args)
+    super
+
+    self[:notify] = [
+      "Service[sensu-api]",
+      "Service[sensu-server]",
+    ].select { |ref| catalog.resource(ref) }
+  end
+
+  ensurable do
+    newvalue(:present) do
+      provider.create
+    end
+
+    newvalue(:absent) do
+      provider.destroy
+    end
+
+    defaultto :present
+  end
+
+  newparam(:name) do
+    desc "This value has no effect, set it to what ever you want."
+  end
+
+  newparam(:base_path) do
+    desc "The base path to the client config file"
+    defaultto '/etc/sensu/conf.d/extensions/'
+  end
+
+  newproperty(:config) do
+    desc "The configuration for this extension"
+    defaultto {}
+  end
+
+  autorequire(:package) do
+    ['sensu']
+  end
+end

manifests/extension.pp

@@ -0,0 +1,74 @@
+# = Define: sensu::extension
+#
+# Defines Sensu extensions
+#
+# == Parameters
+#
+# [*ensure*]
+#   String. Whether the check should be present or not
+#   Default: present
+#   Valid values: present, absent
+#
+# [*source*]
+#   String.  Source of the puppet extension
+#   Default: undef
+#
+# [*install_path*]
+#   String.  Path to install the extension
+#   Default: /etc/sensu/extensions
+#
+# [*config*]
+#   Hash.  Extension specific config
+#   Default: undef
+#
+#
+define sensu::extension(
+  $ensure       = 'present',
+  # Used to install the handler
+  $source       = undef,
+  $install_path = '/etc/sensu/extensions',
+  # Handler specific config
+  $config       = {},
+) {
+
+  validate_re($ensure, ['^present$', '^absent$'] )
+  validate_re($source, ['^puppet://'] )
+
+  if $sensu::client {
+    $notify_services = Class['sensu::client::service']
+  } else {
+    $notify_services = []
+  }
+
+  $filename = inline_template('<%= scope.lookupvar(\'source\').split(\'/\').last %>')
+  $handler = "${install_path}/${filename}"
+
+  $file_ensure = $ensure ? {
+    'absent'  => 'absent',
+    default   => 'file'
+  }
+
+  file { $handler:
+    ensure => $file_ensure,
+    owner  => 'sensu',
+    group  => 'sensu',
+    mode   => '0555',
+    source => $source,
+  }
+
+  file { "/etc/sensu/conf.d/extensions/${name}.json":
+    ensure => $ensure,
+    owner  => 'sensu',
+    group  => 'sensu',
+    mode   => '0444',
+    before => Sensu_extension[$name],
+  }
+
+  sensu_extension { $name:
+    ensure  => $ensure,
+    config  => $config,
+    notify  => $notify_services,
+    require => File['/etc/sensu/conf.d/extensions'],
+  }
+
+}

manifests/package.pp

@@ -59,7 +59,7 @@
     require => Package['sensu'],
   }
 
-  file { [ '/etc/sensu/conf.d', '/etc/sensu/conf.d/handlers', '/etc/sensu/conf.d/checks', '/etc/sensu/conf.d/filters' ]:
+  file { [ '/etc/sensu/conf.d', '/etc/sensu/conf.d/handlers', '/etc/sensu/conf.d/checks', '/etc/sensu/conf.d/filters', '/etc/sensu/conf.d/extensions' ]:
     ensure  => directory,
     owner   => 'sensu',
     group   => 'sensu',

spec/defines/sensu_extension_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe 'sensu::extension', :type => :define do
+  let(:title) { 'myextension' }
+
+  context 'default (present)' do
+    let(:params) { {
+      :source => 'puppet:///somewhere/mycommand.rb'
+    } }
+    it { should contain_file('/etc/sensu/extensions/mycommand.rb').with_source('puppet:///somewhere/mycommand.rb')}
+    it { should contain_file('/etc/sensu/conf.d/extensions/myextension.json') }
+    it { should contain_sensu_extension('myextension').with(
+      :ensure => 'present',
+      :config => {}
+    ) }
+  end
+
+  context 'absent' do
+    let(:facts) { { 'Class[sensu::service::server]' => true } }
+    let(:params) { {
+      :ensure => 'absent',
+      :source => 'puppet:///somewhere/mycommand.rb'
+    } }
+    it { should contain_sensu_extension('myextension').with_ensure('absent') }
+    it { should contain_file('/etc/sensu/conf.d/extensions/myextension.json').with_ensure('absent') }
+  end
+
+  context 'install path' do
+    let(:params) { {
+      :install_path => '/etc',
+      :source       => 'puppet:///mycommand.rb'
+    } }
+    it { should contain_file('/etc/mycommand.rb') }
+  end
+
+  context 'source' do
+    let(:params) { {
+      :source => 'puppet:///sensu/extension/script.rb'
+    } }
+    it { should contain_file('/etc/sensu/extensions/script.rb').with(
+      :ensure => 'file',
+      :source => 'puppet:///sensu/extension/script.rb'
+    ) }
+  end
+
+  context 'source and config' do
+    let(:params) { {
+      :source => 'puppet:///sensu/extension/script.rb',
+      :config => {'param' => 'value'}
+    } }
+    it { should contain_file('/etc/sensu/extensions/script.rb').with(
+      :ensure => 'file',
+      :source => 'puppet:///sensu/extension/script.rb'
+    ) }
+    it { should contain_sensu_extension('myextension').with_config( {'param' => 'value'} ) }
+  end
+
+end