Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup how python modules are configured #821

Merged
merged 2 commits into from
Jun 25, 2018
Merged

Cleanup how python modules are configured #821

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eddb4f2
Cleanup how python modules are configured
traylenator Jun 18, 2018
c037602
fixup - epp extension
traylenator Jun 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1460,11 +1460,29 @@ Or define single module:
collectd::plugin::python::module {'zk-collectd':
script_source => 'puppet:///modules/myorg/zk-collectd.py',
config => [
{'Hosts' => "localhost:2181"}
{'Hosts' => "localhost:2181",
'Verbose' => true,
'Values' => ["abc","def"],
'Name' => 'My Name',
'Limit' => 4.5,
}
]
}
```

The resulting configuration would be

```apache
Import "zk-collectd"
<Module "zk-collectd">
Hosts "localhost:2181"
Verbose true
Values "abc" "def"
Limit 4.5
</Module>

```

Each plugin might use different `modulepath`, however make sure that all paths
are included in `collectd::plugin::python` variable `modulepaths`. If no
`modulepath` is specified, OS default will be used.
Expand Down Expand Up @@ -1530,7 +1548,7 @@ class { '::collectd::plugin::rabbitmq':
'Scheme' => 'https',
'Port' => '15671',
'Host' => $facts['fqdn'],
'Realm' => '"RabbitMQ Management"',
'Realm' => 'RabbitMQ Management',
},
}
```
Expand Down
2 changes: 1 addition & 1 deletion manifests/plugin/python.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@

concat::fragment { 'collectd_plugin_python_conf_header':
order => '00',
content => template('collectd/plugin/python/header.conf.erb'),
content => epp('collectd/plugin/python/header.conf'),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make the extension .epp

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's weird how it even works without. .epp added to that and other two places now.

target => $python_conf,
}

Expand Down
36 changes: 28 additions & 8 deletions manifests/plugin/python/module.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Single module definition
define collectd::plugin::python::module (
Array $config = [],
$ensure = 'present',
$module = $title,
$module_import = undef,
Array[Hash[String,Variant[String,Boolean,Numeric,Array[Variant[Boolean,String,Numeric]]]]] $config = [],
Enum['present','absent'] $ensure = 'present',
String $module = $title,
Optional[String] $module_import = undef,
Optional[Stdlib::Absolutepath] $modulepath = undef,
$script_source = undef,
Optional[String] $script_source = undef,
) {

include collectd
Expand Down Expand Up @@ -34,9 +34,29 @@
}
}

concat::fragment{ "collectd_plugin_python_conf_${module}":
order => '50', # somewhere between header and footer
# Exactly one per module.
ensure_resource('concat::fragment',"collectd_plugin_python_conf_${module}_header",
{
'order' => "50_${module}_00",
'target' => $collectd::plugin::python::python_conf,
'content' => epp('collectd/plugin/python/module.conf_header',
{
'module_import' => $_module_import,
},
),
}
)

# Possibly many per instance of a module configuration.
concat::fragment{ "collectd_plugin_python_conf_${title}_config":
order => "50_${module}_50",
target => $collectd::plugin::python::python_conf,
content => template('collectd/plugin/python/module.conf.erb'),
content => epp('collectd/plugin/python/module.conf_config',
{
'title' => $title,
'config' => $config,
'module' => $_module_import,
},
),
}
}
60 changes: 60 additions & 0 deletions spec/acceptance/class_plugin_python_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,64 @@
its(:stdout) { is_expected.to match %r{google.de} }
end
end

context 'two instances using same python module' do
it 'works idempotently with no errors' do
pp = <<-EOS
if $facts['os']['family'] == 'Debian' {
# for collectdctl command
package{['collectd-utils','python-dbus']:
ensure => present,
}
}
package{['git','python-pip']:
ensure => present,
before => Package['collectd-systemd'],
}
package{'collectd-systemd':
ensure => 'present',
provider => 'pip',
source => 'git+https://github.com/mbachry/collectd-systemd.git',
before => Service['collectd'],
}
class{'collectd':
typesdb => ['/usr/share/collectd/types.db'],
}
class{'collectd::plugin::python':
logtraces => true,
interactive => false,
modules => {
'instanceA' => {
module => 'collectd_systemd',
config => [{'Service' => 'collectd'}],
},
'instanceB' => {
module => 'collectd_systemd',
config => [{'Service' => 'sshd'}],
},
},
}
class{'collectd::plugin::unixsock':
socketfile => '/var/run/collectd-sock',
}
EOS

# Run it twice and test for idempotency
apply_manifest(pp, catch_failures: true)
apply_manifest(pp, catch_changes: true)
shell('sleep 10')
end
describe service('collectd') do
it { is_expected.to be_running }
end
# Check metric is really there.
describe command('collectdctl -s /var/run/collectd-sock listval') do
its(:exit_status) { is_expected.to eq 0 }
its(:stdout) { is_expected.to match %r{systemd-sshd} }
end
describe command('collectdctl -s /var/run/collectd-sock listval') do
its(:exit_status) { is_expected.to eq 0 }
its(:stdout) { is_expected.to match %r{systemd-collectd} }
end
end
end
4 changes: 2 additions & 2 deletions spec/classes/collectd_plugin_cuda_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
context 'package ensure' do
context ':ensure => present' do
it 'import collectd_cuda.collectd_plugin in python-config' do
is_expected.to contain_concat_fragment('collectd_plugin_python_conf_collectd_cuda.collectd_plugin').with_content(%r{Import "collectd_cuda.collectd_plugin"})
is_expected.to contain_concat_fragment('collectd_plugin_python_conf_collectd_cuda.collectd_plugin_header').with_content(%r{Import "collectd_cuda.collectd_plugin"})
end
end
end
Expand All @@ -21,7 +21,7 @@
end

it 'Will remove python-config' do
is_expected.not_to contain_concat__fragment('collectd_plugin_python_conf_collectd_cuda.collectd_plugin').with(ensure: 'present')
is_expected.not_to contain_concat__fragment('collectd_plugin_python_conf_collectd_cuda.collectd_plugin_header').with(ensure: 'present')
end
end

Expand Down
4 changes: 2 additions & 2 deletions spec/classes/collectd_plugin_iscdhcp_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
context 'package ensure' do
context ':ensure => present' do
it 'import collectd_cuda.collectd_plugin in python-config' do
is_expected.to contain_concat_fragment('collectd_plugin_python_conf_collectd_cuda.collectd_plugin').with_content(%r{Import "collectd_cuda.collectd_plugin"})
is_expected.to contain_concat_fragment('collectd_plugin_python_conf_collectd_cuda.collectd_plugin_header').with_content(%r{Import "collectd_cuda.collectd_plugin"})
end
end
end
Expand All @@ -21,7 +21,7 @@
end

it 'Will remove python-config' do
is_expected.not_to contain_concat__fragment('collectd_plugin_python_conf_collectd_cuda.collectd_plugin').with(ensure: 'present')
is_expected.not_to contain_concat__fragment('collectd_plugin_python_conf_collectd_cuda.collectd_plugin_header').with(ensure: 'present')
end
end

Expand Down
87 changes: 73 additions & 14 deletions spec/classes/collectd_plugin_python_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,28 +93,28 @@
end

it 'imports elasticsearch module' do
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_elasticsearch').with(
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_elasticsearch_header').with(
content: %r{Import "elasticsearch"},
target: "#{options[:plugin_conf_dir]}/python-config.conf"
)
end

it 'includes elasticsearch module configuration' do
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_elasticsearch').with(
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_elasticsearch_config').with(
content: %r{<Module "elasticsearch">},
target: "#{options[:plugin_conf_dir]}/python-config.conf"
)
end

it 'includes elasticsearch Cluster name' do
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_elasticsearch').with(
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_elasticsearch_config').with(
content: %r{Cluster "ES-clust"},
target: "#{options[:plugin_conf_dir]}/python-config.conf"
)
end

it 'includes second elasticsearch Cluster name' do
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_elasticsearch').with(
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_elasticsearch_config').with(
content: %r{Cluster "Another-ES-clust"},
target: "#{options[:plugin_conf_dir]}/python-config.conf"
)
Expand All @@ -129,31 +129,90 @@

# test foo module
it 'imports foo module' do
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_foo').with(
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_foo_header').with(
content: %r{Import "foo"},
target: "#{options[:plugin_conf_dir]}/python-config.conf"
)
end

it 'includes foo module configuration' do
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_foo').with(
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_foo_config').with(
content: %r{<Module "foo">},
target: "#{options[:plugin_conf_dir]}/python-config.conf"
)
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_foo').with(content: %r{Verbose true})
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_foo').with(content: %r{Bar "bar"})
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_foo_config').with(content: %r{Verbose true})
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_foo_config').with(content: %r{Bar ""bar""})
end

it 'includes alpha module configuration' do
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_alpha').with(
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_alpha_config').with(
content: %r{<Module "alpha">},
target: "#{options[:plugin_conf_dir]}/python-config.conf"
)
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_alpha').with(content: %r{Beta 4.2})
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_alpha').with(content: %r{Delta "a"})
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_alpha').with(content: %r{Delta 4})
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_alpha').with(content: %r{Delta 5})
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_alpha').with(content: %r{Gamma "b"})
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_alpha_config').with(content: %r{Beta 4.2})
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_alpha_config').with(content: %r{Delta "a" 4 5})
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_alpha_config').with(content: %r{Gamma "b"})
end
end

context 'two modules with same python module should not clash' do
let :params do
{
modules: {
'One' => {
'module' => 'funky',
'config' => [{ 'Verbose' => true }, { 'Junk' => 'help' }]
},
'Two' => {
'module' => 'funky',
'config' => [{ 'Junk' => 'morehelp' }]
}
}
}
end

it 'import funky module' do
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_funky_header').with(
content: %r{Import "funky"},
target: "#{options[:plugin_conf_dir]}/python-config.conf"
)
end
it 'open instance One of module' do
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_One_config').with(
content: %r{<Module "funky">},
target: "#{options[:plugin_conf_dir]}/python-config.conf"
)
end
it 'open instance Two of module' do
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_Two_config').with(
content: %r{<Module "funky">},
target: "#{options[:plugin_conf_dir]}/python-config.conf"
)
end

it 'configure instance One of module' do
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_One_config').with(
content: %r{Verbose true},
target: "#{options[:plugin_conf_dir]}/python-config.conf"
)
end
it 'configure instance Two of module' do
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_Two_config').with(
content: %r{Junk "morehelp"},
target: "#{options[:plugin_conf_dir]}/python-config.conf"
)
end
it 'close funky module instance One' do
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_One_config').with(
content: %r{</Module>},
target: "#{options[:plugin_conf_dir]}/python-config.conf"
)
end
it 'close funky module instance Two' do
is_expected.to contain_concat__fragment('collectd_plugin_python_conf_Two_config').with(
content: %r{</Module>},
target: "#{options[:plugin_conf_dir]}/python-config.conf"
)
end
end

Expand Down
Loading