summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYanis Guenane <yguenane@clarityhs.com>2014-03-30 18:47:36 -0400
committerYanis Guenane <yguenane@clarityhs.com>2014-03-30 18:47:36 -0400
commitd9b5e912bbb6dffff01e03a0b040fd78888f2578 (patch)
treebcba7a998bd5f1177602a9317abee880ecc728f4
parent746a4cc67a57c23bbadbb8c3a11c648b3a9e7596 (diff)
(MODULES-603) Add defaults arguments to ensure_packages()
Without this patch one can not specify package resource specific parameters. All the ensure_packages() function does it makes sure the named packages are installed. This patch allows one to pass default as a second argument and allow greater flexibility on packages installations. Use case like the following are now possible : * ensure_packages(['r10k', 'serverspec'], {'provider' => 'gem'}) * ensure_packages(['ntp'], {'require' => 'Exec[foobar]'})
-rw-r--r--README.markdown2
-rw-r--r--lib/puppet/parser/functions/ensure_packages.rb16
-rw-r--r--spec/functions/ensure_packages_spec.rb13
3 files changed, 27 insertions, 4 deletions
diff --git a/README.markdown b/README.markdown
index 874655c..3723173 100644
--- a/README.markdown
+++ b/README.markdown
@@ -275,6 +275,8 @@ Returns true if the variable is empty.
ensure_packages
---------------
Takes a list of packages and only installs them if they don't already exist.
+It optionally takes a hash as a second parameter that will be passed as the
+third argument to the ensure_resource() function.
- *Type*: statement
diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb
index 1e0f225..f1da4aa 100644
--- a/lib/puppet/parser/functions/ensure_packages.rb
+++ b/lib/puppet/parser/functions/ensure_packages.rb
@@ -5,19 +5,29 @@
module Puppet::Parser::Functions
newfunction(:ensure_packages, :type => :statement, :doc => <<-EOS
Takes a list of packages and only installs them if they don't already exist.
+It optionally takes a hash as a second parameter that will be passed as the
+third argument to the ensure_resource() function.
EOS
) do |arguments|
- if arguments.size != 1
+ if arguments.size > 2 or arguments.size == 0
raise(Puppet::ParseError, "ensure_packages(): Wrong number of arguments " +
- "given (#{arguments.size} for 1)")
+ "given (#{arguments.size} for 1 or 2)")
+ elsif arguments.size == 2 and !arguments[1].is_a?(Hash)
+ raise(Puppet::ParseError, 'ensure_packages(): Requires second argument to be a Hash')
end
packages = Array(arguments[0])
+ if arguments[1]
+ defaults = { 'ensure' => 'present' }.merge(arguments[1])
+ else
+ defaults = { 'ensure' => 'present' }
+ end
+
Puppet::Parser::Functions.function(:ensure_resource)
packages.each { |package_name|
- function_ensure_resource(['package', package_name, {'ensure' => 'present' } ])
+ function_ensure_resource(['package', package_name, defaults ])
}
end
end
diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb
index bf62eff..436be10 100644
--- a/spec/functions/ensure_packages_spec.rb
+++ b/spec/functions/ensure_packages_spec.rb
@@ -32,7 +32,7 @@ describe 'ensure_packages' do
it 'fails with no arguments' do
expect {
scope.function_ensure_packages([])
- }.to raise_error(Puppet::ParseError, /0 for 1/)
+ }.to raise_error(Puppet::ParseError, /0 for 1 or 2/)
end
it 'accepts an array of values' do
@@ -67,4 +67,15 @@ describe 'ensure_packages' do
expect(catalog.resource(:package, 'facter')['ensure']).to eq('present')
end
end
+
+ context 'given a clean catalog and specified defaults' do
+ let :catalog do
+ compile_to_catalog('ensure_packages(["facter"], {"provider" => "gem"})')
+ end
+
+ it 'declares package resources with ensure => present' do
+ expect(catalog.resource(:package, 'facter')['ensure']).to eq('present')
+ expect(catalog.resource(:package, 'facter')['provider']).to eq('gem')
+ end
+ end
end