(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]'})

diff --git a/README.markdown b/README.markdown
index 874655c74870a4c42c251863742628318bf9f403..37231735cb8af28d4bf45809ef69a4b7405bcab4 100644 (file)
--- 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 1e0f225eb97ef60d9feb570ec45cebdb5309fa94..f1da4aaaafe8f41013b83a7137c9366923377051 100644 (file)
--- 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 bf62eff424f5cdeb3ce1d69df74b69c7871993eb..436be10bc4e83a5dc807b36a04a035fbb3068873 100644 (file)
--- 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