Merge pull request redhat-openstack#217 from bogus-py/filecount

filecount: support all options

Author: blkperl

README.md

@@ -268,6 +268,31 @@ collectd::plugin::exec {
 
 ####Class: `collectd::plugin::filecount`
 
+```puppet
+collectd::plugin::filecount::directory {'foodir':
+  path          => '/path/to/dir',
+  pattern       => '*.conf',
+  mtime         => '-5m',
+  recursive     => true,
+  includehidden => false
+}
+
+```
+You can also configure this plugin with a parameterized class:
+```puppet
+class { 'collectd::plugin::filecount':
+  directories => {
+    'foodir' => {
+      'path'          => '/path/to/dir',
+      'pattern'       => '*.conf',
+      'mtime'         => '-5m',
+      'recursive'     => true,
+      'includehidden' => false
+      },
+  },
+}
+```
+For backwards compatibility:
 ```puppet
 class { 'collectd::plugin::filecount':
   directories => {

manifests/plugin/filecount.pp

@@ -4,9 +4,22 @@
   $directories = {},
   $interval    = undef,
 ) {
+  validate_hash($directories)
+
+  # We support two formats for directories:
+  #  - new: hash for create_resources collectd::plugin::filecount::directory
+  #  - old: backward compatibility, simple instance => path hash
+  $values = values($directories)
+  if size($values) > 0 and is_hash($values[0]) {
+    $content = undef
+    create_resources(collectd::plugin::filecount::directory, $directories, {ensure => $ensure})
+  } else {
+    $content = template('collectd/plugin/filecount.conf.erb')
+  }
+
   collectd::plugin {'filecount':
     ensure   => $ensure,
-    content  => template('collectd/plugin/filecount.conf.erb'),
+    content  => $content,
     interval => $interval,
   }
 }

manifests/plugin/filecount/directory.pp

@@ -0,0 +1,27 @@
+# https://collectd.org/wiki/index.php/Plugin:FileCount
+define collectd::plugin::filecount::directory (
+  $ensure       = present,
+  $instance     = $name,
+  $path         = undef,
+  $pattern      = undef,
+  $mtime        = undef,
+  $size         = undef,
+  $recursive     = undef,
+  $includehidden = undef
+) {
+  include collectd::params
+  include collectd::plugin::filecount
+
+  $conf_dir = $collectd::params::plugin_conf_dir
+
+  validate_string($path)
+
+  file { "${conf_dir}/15-filecount-${name}.conf":
+    ensure  => $ensure,
+    mode    => '0640',
+    owner   => 'root',
+    group   => $collectd::params::root_group,
+    content => template('collectd/plugin/filecount-directory.conf.erb'),
+    notify  => Service['collectd'],
+  }
+}

spec/classes/collectd_plugin_filecount_spec.rb

@@ -18,6 +18,28 @@
     end
   end
 
+  context 'new :directories format' do
+    let :params do
+      {:directories => { 'foodir' => {
+          'path'          => '/path/to/dir',
+          'pattern'       => '*.conf',
+          'mtime'         => '-5m',
+          'recursive'     => true,
+          'includehidden' => false,
+      }}}
+    end
+    it 'Will create foodir collectd::plugin::filecount::directory resource' do
+      should contain_collectd__plugin__filecount__directory('foodir').with({
+        :ensure        => 'present',
+        :path          => '/path/to/dir',
+        :pattern       => '*.conf',
+        :mtime         => '-5m',
+        :recursive     => true,
+        :includehidden => false,
+      })
+    end
+  end
+
   context ':ensure => absent' do
     let :params do
       {:directories => { 'active' => '/var/spool/postfix/active' }, :ensure => 'absent'}

spec/defines/collectd_plugin_filecount_directory_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe 'collectd::plugin::filecount::directory', :type => :define do
+  let :facts do
+    {:osfamily => 'Debian'}
+  end
+
+  context 'simple case' do
+    let(:title) { 'test' }
+    let :params do
+      {
+        :path => '/var/tmp/test',
+      }
+    end
+    it 'Will create /etc/collectd/conf.d/15-filecount-test.conf' do
+      should contain_file('/etc/collectd/conf.d/15-filecount-test.conf').with_content("<Plugin \"filecount\">\n  <Directory \"/var/tmp/test\">\n    Instance \"test\"\n  </Directory>\n</Plugin>\n")
+    end
+  end
+
+  context 'advanced case' do
+    let(:title) { 'test' }
+    let :params do
+      {
+        :path          => '/path/to/dir',
+        :pattern       => '*.conf',
+        :mtime         => '-5m',
+        :recursive     => true,
+        :includehidden => false,
+      }
+    end
+    it 'Will create /etc/collectd/conf.d/15-filecount-test.conf' do
+      should contain_file('/etc/collectd/conf.d/15-filecount-test.conf').with_content("<Plugin \"filecount\">\n  <Directory \"/path/to/dir\">\n    Instance \"test\"\n    Name \"*.conf\"\n    MTime \"-5m\"\n    Recursive true\n    IncludeHidden false\n  </Directory>\n</Plugin>\n")
+    end
+  end
+
+  context 'recursive and includehidden false' do
+    let(:title) { 'test' }
+    let :params do
+      {
+        :path          => '/var/tmp/test',
+        :recursive     => false,
+        :includehidden => false,
+      }
+    end
+    it 'Will create /etc/collectd/conf.d/15-filecount-test.conf' do
+      should contain_file('/etc/collectd/conf.d/15-filecount-test.conf').with_content("<Plugin \"filecount\">\n  <Directory \"/var/tmp/test\">\n    Instance \"test\"\n    Recursive false\n    IncludeHidden false\n  </Directory>\n</Plugin>\n")
+    end
+  end
+
+  context 'ensure => absent' do
+    let(:title) { 'test' }
+    let :params do
+      {
+        :ensure => 'absent',
+        :path   => '/var/tmp/test',
+      }
+    end
+    it 'Will create /etc/collectd/conf.d/15-filecount-test.conf' do
+      should contain_file('/etc/collectd/conf.d/15-filecount-test.conf').with({
+          :ensure => 'absent',
+          :path   => '/etc/collectd/conf.d/15-filecount-test.conf',
+      })
+    end
+  end
+end

templates/plugin/filecount-directory.conf.erb

@@ -0,0 +1,20 @@
+<Plugin "filecount">
+  <Directory "<%= @path -%>">
+    Instance "<%= @instance %>"
+<% if @pattern -%>
+    Name "<%= @pattern %>"
+<% end -%>
+<% if @mtime -%>
+    MTime "<%= @mtime %>"
+<% end -%>
+<% if @size -%>
+    Size "<%= @size %>"
+<% end -%>
+<% unless @recursive.nil? -%>
+    Recursive <%= @recursive %>
+<% end -%>
+<% unless @includehidden.nil? -%>
+    IncludeHidden <%= @includehidden %>
+<% end -%>
+  </Directory>
+</Plugin>

tests/plugins/filecount.pp

@@ -6,3 +6,15 @@
     'incoming' => '/var/spool/postfix/incoming'
   },
 }
+
+collectd::plugin::filecount::directory {'foodir':
+  path => '/path/to/dir'
+}
+
+collectd::plugin::filecount::directory {'aborted-uploads':
+  path          => '/var/spool/foo/upload',
+  pattern       => '.part.*',
+  mtime         => '5m',
+  recursive     => true,
+  includehidden => true
+}